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};
24 use std::io::{Read, Write};
27 use proc_macro2::Span;
28 use quote::format_ident;
36 const DEFAULT_IMPORTS: &'static str = "\nuse std::str::FromStr;\nuse std::ffi::c_void;\nuse core::convert::Infallible;\nuse bitcoin::hashes::Hash;\nuse crate::c_types::*;\n";
38 // *************************************
39 // *** Manually-expanded conversions ***
40 // *************************************
42 /// Convert "impl trait_path for for_ty { .. }" for manually-mapped types (ie (de)serialization)
43 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) {
44 if let Some(t) = types.maybe_resolve_path(&trait_path, Some(generics)) {
47 let mut has_inner = false;
48 if let syn::Type::Path(ref p) = for_ty {
49 if let Some(ident) = single_ident_generic_path_to_ident(&p.path) {
50 for_obj = format!("{}", ident);
51 full_obj_path = for_obj.clone();
52 has_inner = types.c_type_has_inner_from_path(&types.resolve_path(&p.path, Some(generics)));
55 // We assume that anything that isn't a Path is somehow a generic that ends up in our
56 // derived-types module.
57 let mut for_obj_vec = Vec::new();
58 types.write_c_type(&mut for_obj_vec, for_ty, Some(generics), false);
59 full_obj_path = String::from_utf8(for_obj_vec).unwrap();
60 assert!(full_obj_path.starts_with(TypeResolver::generated_container_path()));
61 for_obj = full_obj_path[TypeResolver::generated_container_path().len() + 2..].into();
65 "lightning::util::ser::Writeable" => {
66 writeln!(w, "#[no_mangle]").unwrap();
67 writeln!(w, "/// Serialize the {} object into a byte array which can be read by {}_read", for_obj, for_obj).unwrap();
68 writeln!(w, "pub extern \"C\" fn {}_write(obj: &{}) -> crate::c_types::derived::CVec_u8Z {{", for_obj, full_obj_path).unwrap();
70 let ref_type: syn::Type = syn::parse_quote!(&#for_ty);
71 assert!(!types.write_from_c_conversion_new_var(w, &format_ident!("obj"), &ref_type, Some(generics)));
73 write!(w, "\tcrate::c_types::serialize_obj(").unwrap();
74 types.write_from_c_conversion_prefix(w, &ref_type, Some(generics));
75 write!(w, "unsafe {{ &*obj }}").unwrap();
76 types.write_from_c_conversion_suffix(w, &ref_type, Some(generics));
77 writeln!(w, ")").unwrap();
79 writeln!(w, "}}").unwrap();
81 writeln!(w, "#[no_mangle]").unwrap();
82 writeln!(w, "pub(crate) extern \"C\" fn {}_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {{", for_obj).unwrap();
83 writeln!(w, "\tcrate::c_types::serialize_obj(unsafe {{ &*(obj as *const native{}) }})", for_obj).unwrap();
84 writeln!(w, "}}").unwrap();
87 "lightning::util::ser::Readable"|"lightning::util::ser::ReadableArgs" => {
88 // Create the Result<Object, DecodeError> syn::Type
89 let res_ty: syn::Type = parse_quote!(Result<#for_ty, ::ln::msgs::DecodeError>);
91 writeln!(w, "#[no_mangle]").unwrap();
92 writeln!(w, "/// Read a {} from a byte array, created by {}_write", for_obj, for_obj).unwrap();
93 write!(w, "pub extern \"C\" fn {}_read(ser: crate::c_types::u8slice", for_obj).unwrap();
95 let mut arg_conv = Vec::new();
96 if t == "lightning::util::ser::ReadableArgs" {
97 write!(w, ", arg: ").unwrap();
98 assert!(trait_path.leading_colon.is_none());
99 let args_seg = trait_path.segments.iter().last().unwrap();
100 assert_eq!(format!("{}", args_seg.ident), "ReadableArgs");
101 if let syn::PathArguments::AngleBracketed(args) = &args_seg.arguments {
102 assert_eq!(args.args.len(), 1);
103 if let syn::GenericArgument::Type(args_ty) = args.args.iter().next().unwrap() {
104 types.write_c_type(w, args_ty, Some(generics), false);
106 assert!(!types.write_from_c_conversion_new_var(&mut arg_conv, &format_ident!("arg"), &args_ty, Some(generics)));
108 write!(&mut arg_conv, "\tlet arg_conv = ").unwrap();
109 types.write_from_c_conversion_prefix(&mut arg_conv, &args_ty, Some(generics));
110 write!(&mut arg_conv, "arg").unwrap();
111 types.write_from_c_conversion_suffix(&mut arg_conv, &args_ty, Some(generics));
112 } else { unreachable!(); }
113 } else { unreachable!(); }
115 write!(w, ") -> ").unwrap();
116 types.write_c_type(w, &res_ty, Some(generics), false);
117 writeln!(w, " {{").unwrap();
119 if t == "lightning::util::ser::ReadableArgs" {
120 w.write(&arg_conv).unwrap();
121 write!(w, ";\n\tlet res: ").unwrap();
122 // At least in one case we need type annotations here, so provide them.
123 types.write_rust_type(w, Some(generics), &res_ty);
124 writeln!(w, " = crate::c_types::deserialize_obj_arg(ser, arg_conv);").unwrap();
126 writeln!(w, "\tlet res = crate::c_types::deserialize_obj(ser);").unwrap();
128 write!(w, "\t").unwrap();
129 if types.write_to_c_conversion_new_var(w, &format_ident!("res"), &res_ty, Some(generics), false) {
130 write!(w, "\n\t").unwrap();
132 types.write_to_c_conversion_inline_prefix(w, &res_ty, Some(generics), false);
133 write!(w, "res").unwrap();
134 types.write_to_c_conversion_inline_suffix(w, &res_ty, Some(generics), false);
135 writeln!(w, "\n}}").unwrap();
142 /// Convert "TraitA : TraitB" to a single function name and return type.
144 /// This is (obviously) somewhat over-specialized and only useful for TraitB's that only require a
145 /// single function (eg for serialization).
146 fn convert_trait_impl_field(trait_path: &str) -> (&'static str, String, &'static str) {
148 "lightning::util::ser::Writeable" => ("Serialize the object into a byte array", "write".to_owned(), "crate::c_types::derived::CVec_u8Z"),
149 _ => unimplemented!(),
153 /// Companion to convert_trait_impl_field, write an assignment for the function defined by it for
154 /// `for_obj` which implements the the trait at `trait_path`.
155 fn write_trait_impl_field_assign<W: std::io::Write>(w: &mut W, trait_path: &str, for_obj: &syn::Ident) {
157 "lightning::util::ser::Writeable" => {
158 writeln!(w, "\t\twrite: {}_write_void,", for_obj).unwrap();
160 _ => unimplemented!(),
164 /// Write out the impl block for a defined trait struct which has a supertrait
165 fn do_write_impl_trait<W: std::io::Write>(w: &mut W, trait_path: &str, _trait_name: &syn::Ident, for_obj: &str) {
167 "lightning::util::ser::Writeable" => {
168 writeln!(w, "impl {} for {} {{", trait_path, for_obj).unwrap();
169 writeln!(w, "\tfn write<W: lightning::util::ser::Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {{").unwrap();
170 writeln!(w, "\t\tlet vec = (self.write)(self.this_arg);").unwrap();
171 writeln!(w, "\t\tw.write_all(vec.as_slice())").unwrap();
172 writeln!(w, "\t}}\n}}").unwrap();
178 /// Returns true if an instance of the given type must never exist
179 fn is_type_unconstructable(path: &str) -> bool {
180 path == "core::convert::Infallible" || path == "crate::c_types::NotConstructable"
183 // *******************************
184 // *** Per-Type Printing Logic ***
185 // *******************************
187 macro_rules! walk_supertraits { ($t: expr, $types: expr, ($( $($pat: pat)|* => $e: expr),*) ) => { {
188 if $t.colon_token.is_some() {
189 for st in $t.supertraits.iter() {
191 syn::TypeParamBound::Trait(supertrait) => {
192 if supertrait.paren_token.is_some() || supertrait.lifetimes.is_some() {
195 // First try to resolve path to find in-crate traits, but if that doesn't work
196 // assume its a prelude trait (eg Clone, etc) and just use the single ident.
197 let types_opt: Option<&TypeResolver> = $types;
198 if let Some(types) = types_opt {
199 if let Some(path) = types.maybe_resolve_path(&supertrait.path, None) {
200 match (&path as &str, &supertrait.path.segments.iter().last().unwrap().ident) {
201 $( $($pat)|* => $e, )*
206 if let Some(ident) = supertrait.path.get_ident() {
207 match (&format!("{}", ident) as &str, &ident) {
208 $( $($pat)|* => $e, )*
210 } else if types_opt.is_some() {
211 panic!("Supertrait unresolvable and not single-ident");
214 syn::TypeParamBound::Lifetime(_) => unimplemented!(),
220 macro_rules! get_module_type_resolver {
221 ($module: expr, $crate_libs: expr, $crate_types: expr) => { {
222 let module: &str = &$module;
223 let mut module_iter = module.rsplitn(2, "::");
224 module_iter.next().unwrap();
225 let module = module_iter.next().unwrap();
226 let imports = ImportResolver::new(module.splitn(2, "::").next().unwrap(), &$crate_types.lib_ast.dependencies,
227 module, &$crate_types.lib_ast.modules.get(module).unwrap().items);
228 TypeResolver::new(module, imports, $crate_types)
232 /// Prints a C-mapped trait object containing a void pointer and a jump table for each function in
233 /// the original trait.
234 /// Implements the native Rust trait and relevant parent traits for the new C-mapped trait.
236 /// Finally, implements Deref<MappedTrait> for MappedTrait which allows its use in types which need
237 /// a concrete Deref to the Rust trait.
238 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) {
239 let trait_name = format!("{}", t.ident);
241 match export_status(&t.attrs) {
242 ExportStatus::Export => { implementable = true; }
243 ExportStatus::NotImplementable => { implementable = false; },
244 ExportStatus::NoExport|ExportStatus::TestOnly => return,
246 writeln_docs(w, &t.attrs, "");
248 let mut gen_types = GenericTypes::new(None);
250 // Add functions which may be required for supertrait implementations.
251 // Due to borrow checker limitations, we only support one in-crate supertrait here.
253 let supertrait_resolver;
254 walk_supertraits!(t, Some(&types), (
256 if let Some(supertrait) = types.crate_types.traits.get(s) {
257 supertrait_name = s.to_string();
258 supertrait_resolver = get_module_type_resolver!(supertrait_name, types.crate_libs, types.crate_types);
259 gen_types.learn_associated_types(&supertrait, &supertrait_resolver);
265 assert!(gen_types.learn_generics(&t.generics, types));
266 gen_types.learn_associated_types(&t, types);
268 writeln!(w, "#[repr(C)]\npub struct {} {{", trait_name).unwrap();
269 writeln!(w, "\t/// An opaque pointer which is passed to your function implementations as an argument.").unwrap();
270 writeln!(w, "\t/// This has no meaning in the LDK, and can be NULL or any other value.").unwrap();
271 writeln!(w, "\tpub this_arg: *mut c_void,").unwrap();
272 // We store every field's (name, Option<clone_fn>, docs) except this_arg, used in Clone generation
273 // docs is only set if its a function which should be callable on the object itself in C++
274 let mut generated_fields = Vec::new();
275 for item in t.items.iter() {
277 &syn::TraitItem::Method(ref m) => {
278 match export_status(&m.attrs) {
279 ExportStatus::NoExport => {
280 // NoExport in this context means we'll hit an unimplemented!() at runtime,
284 ExportStatus::Export => {},
285 ExportStatus::TestOnly => continue,
286 ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
288 if m.default.is_some() { unimplemented!(); }
290 let mut meth_gen_types = gen_types.push_ctx();
291 assert!(meth_gen_types.learn_generics(&m.sig.generics, types));
293 writeln_fn_docs(w, &m.attrs, "\t", types, Some(&meth_gen_types), m.sig.inputs.iter(), &m.sig.output);
295 if let syn::ReturnType::Type(_, rtype) = &m.sig.output {
296 if let syn::Type::Reference(r) = &**rtype {
297 // We have to do quite a dance for trait functions which return references
298 // - they ultimately require us to have a native Rust object stored inside
299 // our concrete trait to return a reference to. However, users may wish to
300 // update the value to be returned each time the function is called (or, to
301 // make C copies of Rust impls equivalent, we have to be able to).
303 // Thus, we store a copy of the C-mapped type (which is just a pointer to
304 // the Rust type and a flag to indicate whether deallocation needs to
305 // happen) as well as provide an Option<>al function pointer which is
306 // called when the trait method is called which allows updating on the fly.
307 write!(w, "\tpub {}: ", m.sig.ident).unwrap();
308 generated_fields.push((format!("{}", m.sig.ident), None, None));
309 types.write_c_type(w, &*r.elem, Some(&meth_gen_types), false);
310 writeln!(w, ",").unwrap();
311 writeln!(w, "\t/// Fill in the {} field as a reference to it will be given to Rust after this returns", m.sig.ident).unwrap();
312 writeln!(w, "\t/// Note that this takes a pointer to this object, not the this_ptr like other methods do").unwrap();
313 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();
314 writeln!(w, "\tpub set_{}: Option<extern \"C\" fn(&{})>,", m.sig.ident, trait_name).unwrap();
315 generated_fields.push((format!("set_{}", m.sig.ident), None, None));
316 // Note that cbindgen will now generate
317 // typedef struct Thing {..., set_thing: (const struct Thing*), ...} Thing;
318 // which does not compile since Thing is not defined before it is used.
319 writeln!(extra_headers, "struct LDK{};", trait_name).unwrap();
322 // Sadly, this currently doesn't do what we want, but it should be easy to get
323 // cbindgen to support it. See https://github.com/eqrion/cbindgen/issues/531
324 writeln!(w, "\t#[must_use]").unwrap();
327 let mut cpp_docs = Vec::new();
328 writeln_fn_docs(&mut cpp_docs, &m.attrs, "\t * ", types, Some(&meth_gen_types), m.sig.inputs.iter(), &m.sig.output);
329 let docs_string = "\t/**\n".to_owned() + &String::from_utf8(cpp_docs).unwrap().replace("///", "") + "\t */\n";
331 write!(w, "\tpub {}: extern \"C\" fn (", m.sig.ident).unwrap();
332 generated_fields.push((format!("{}", m.sig.ident), None, Some(docs_string)));
333 write_method_params(w, &m.sig, "c_void", types, Some(&meth_gen_types), true, false);
334 writeln!(w, ",").unwrap();
336 &syn::TraitItem::Type(_) => {},
337 _ => unimplemented!(),
340 // Add functions which may be required for supertrait implementations.
341 walk_supertraits!(t, Some(&types), (
343 writeln!(w, "\t/// Called, if set, after this {} has been cloned into a duplicate object.", trait_name).unwrap();
344 writeln!(w, "\t/// The new {} is provided, and should be mutated as needed to perform a", trait_name).unwrap();
345 writeln!(w, "\t/// deep copy of the object pointed to by this_arg or avoid any double-freeing.").unwrap();
346 writeln!(w, "\tpub cloned: Option<extern \"C\" fn (new_{}: &mut {})>,", trait_name, trait_name).unwrap();
347 generated_fields.push(("cloned".to_owned(), None, None));
349 ("std::cmp::Eq", _)|("core::cmp::Eq", _) => {
350 let eq_docs = "Checks if two objects are equal given this object's this_arg pointer and another object.";
351 writeln!(w, "\t/// {}", eq_docs).unwrap();
352 writeln!(w, "\tpub eq: extern \"C\" fn (this_arg: *const c_void, other_arg: &{}) -> bool,", trait_name).unwrap();
353 generated_fields.push(("eq".to_owned(), None, Some(format!("\t/** {} */\n", eq_docs))));
355 ("std::hash::Hash", _)|("core::hash::Hash", _) => {
356 let hash_docs_a = "Calculate a succinct non-cryptographic hash for an object given its this_arg pointer.";
357 let hash_docs_b = "This is used, for example, for inclusion of this object in a hash map.";
358 writeln!(w, "\t/// {}", hash_docs_a).unwrap();
359 writeln!(w, "\t/// {}", hash_docs_b).unwrap();
360 writeln!(w, "\tpub hash: extern \"C\" fn (this_arg: *const c_void) -> u64,").unwrap();
361 generated_fields.push(("hash".to_owned(), None,
362 Some(format!("\t/**\n\t * {}\n\t * {}\n\t */\n", hash_docs_a, hash_docs_b))));
364 ("Send", _) => {}, ("Sync", _) => {},
365 ("std::fmt::Debug", _)|("core::fmt::Debug", _) => {
366 let debug_docs = "Return a human-readable \"debug\" string describing this object";
367 writeln!(w, "\t/// {}", debug_docs).unwrap();
368 writeln!(w, "\tpub debug_str: extern \"C\" fn (this_arg: *const c_void) -> crate::c_types::Str,").unwrap();
369 generated_fields.push(("debug_str".to_owned(), None,
370 Some(format!("\t/**\n\t * {}\n\t */\n", debug_docs))));
373 // TODO: Both of the below should expose supertrait methods in C++, but doing so is
375 generated_fields.push(if types.crate_types.traits.get(s).is_none() {
376 let (docs, name, ret) = convert_trait_impl_field(s);
377 writeln!(w, "\t/// {}", docs).unwrap();
378 writeln!(w, "\tpub {}: extern \"C\" fn (this_arg: *const c_void) -> {},", name, ret).unwrap();
379 (name, None, None) // Assume clonable
381 // For in-crate supertraits, just store a C-mapped copy of the supertrait as a member.
382 writeln!(w, "\t/// Implementation of {} for this object.", i).unwrap();
383 let is_clonable = types.is_clonable(s);
384 writeln!(w, "\tpub {}: crate::{},", i, s).unwrap();
385 (format!("{}", i), if !is_clonable {
386 Some(format!("crate::{}_clone_fields", s))
387 } else { None }, None)
391 writeln!(w, "\t/// Frees any resources associated with this object given its this_arg pointer.").unwrap();
392 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();
393 writeln!(w, "\tpub free: Option<extern \"C\" fn(this_arg: *mut c_void)>,").unwrap();
394 generated_fields.push(("free".to_owned(), None, None));
395 writeln!(w, "}}").unwrap();
397 macro_rules! impl_trait_for_c {
398 ($t: expr, $impl_accessor: expr, $type_resolver: expr) => {
399 for item in $t.items.iter() {
401 syn::TraitItem::Method(m) => {
402 if let ExportStatus::TestOnly = export_status(&m.attrs) { continue; }
403 if m.default.is_some() { unimplemented!(); }
404 if m.sig.constness.is_some() || m.sig.asyncness.is_some() || m.sig.unsafety.is_some() ||
405 m.sig.abi.is_some() || m.sig.variadic.is_some() {
408 let mut meth_gen_types = gen_types.push_ctx();
409 assert!(meth_gen_types.learn_generics(&m.sig.generics, $type_resolver));
410 // Note that we do *not* use the method generics when printing "native"
411 // rust parts - if the method is generic, we need to print a generic
413 write!(w, "\tfn {}", m.sig.ident).unwrap();
414 $type_resolver.write_rust_generic_param(w, Some(&gen_types), m.sig.generics.params.iter());
415 write!(w, "(").unwrap();
416 for inp in m.sig.inputs.iter() {
418 syn::FnArg::Receiver(recv) => {
419 if !recv.attrs.is_empty() || recv.reference.is_none() { unimplemented!(); }
420 write!(w, "&").unwrap();
421 if let Some(lft) = &recv.reference.as_ref().unwrap().1 {
422 write!(w, "'{} ", lft.ident).unwrap();
424 if recv.mutability.is_some() {
425 write!(w, "mut self").unwrap();
427 write!(w, "self").unwrap();
430 syn::FnArg::Typed(arg) => {
431 if !arg.attrs.is_empty() { unimplemented!(); }
433 syn::Pat::Ident(ident) => {
434 if !ident.attrs.is_empty() || ident.by_ref.is_some() ||
435 ident.mutability.is_some() || ident.subpat.is_some() {
438 write!(w, ", mut {}{}: ", if $type_resolver.skip_arg(&*arg.ty, Some(&meth_gen_types)) { "_" } else { "" }, ident.ident).unwrap();
440 _ => unimplemented!(),
442 $type_resolver.write_rust_type(w, Some(&gen_types), &*arg.ty);
446 write!(w, ")").unwrap();
447 match &m.sig.output {
448 syn::ReturnType::Type(_, rtype) => {
449 write!(w, " -> ").unwrap();
450 $type_resolver.write_rust_type(w, Some(&gen_types), &*rtype)
454 write!(w, " {{\n\t\t").unwrap();
455 match export_status(&m.attrs) {
456 ExportStatus::NoExport => {
461 if let syn::ReturnType::Type(_, rtype) = &m.sig.output {
462 if let syn::Type::Reference(r) = &**rtype {
463 assert_eq!(m.sig.inputs.len(), 1); // Must only take self!
464 writeln!(w, "if let Some(f) = self{}.set_{} {{", $impl_accessor, m.sig.ident).unwrap();
465 writeln!(w, "\t\t\t(f)(&self{});", $impl_accessor).unwrap();
466 write!(w, "\t\t}}\n\t\t").unwrap();
467 $type_resolver.write_from_c_conversion_to_ref_prefix(w, &*r.elem, Some(&meth_gen_types));
468 write!(w, "self{}.{}", $impl_accessor, m.sig.ident).unwrap();
469 $type_resolver.write_from_c_conversion_to_ref_suffix(w, &*r.elem, Some(&meth_gen_types));
470 writeln!(w, "\n\t}}").unwrap();
474 write_method_var_decl_body(w, &m.sig, "\t", $type_resolver, Some(&meth_gen_types), true);
475 write!(w, "(self{}.{})(", $impl_accessor, m.sig.ident).unwrap();
476 let mut args = Vec::new();
477 write_method_call_params(&mut args, &m.sig, "\t", $type_resolver, Some(&meth_gen_types), "", true);
478 w.write_all(String::from_utf8(args).unwrap().replace("self", &format!("self{}", $impl_accessor)).as_bytes()).unwrap();
480 writeln!(w, "\n\t}}").unwrap();
482 &syn::TraitItem::Type(ref t) => {
483 if t.default.is_some() || t.generics.lt_token.is_some() { unimplemented!(); }
484 let mut bounds_iter = t.bounds.iter();
486 match bounds_iter.next().unwrap() {
487 syn::TypeParamBound::Trait(tr) => {
488 writeln!(w, "\ttype {} = crate::{};", t.ident, $type_resolver.resolve_path(&tr.path, Some(&gen_types))).unwrap();
489 for bound in bounds_iter {
490 if let syn::TypeParamBound::Trait(_) = bound { unimplemented!(); }
494 syn::TypeParamBound::Lifetime(_) => {},
498 _ => unimplemented!(),
504 writeln!(w, "unsafe impl Send for {} {{}}", trait_name).unwrap();
505 writeln!(w, "unsafe impl Sync for {} {{}}", trait_name).unwrap();
507 writeln!(w, "#[no_mangle]").unwrap();
508 writeln!(w, "pub(crate) extern \"C\" fn {}_clone_fields(orig: &{}) -> {} {{", trait_name, trait_name, trait_name).unwrap();
509 writeln!(w, "\t{} {{", trait_name).unwrap();
510 writeln!(w, "\t\tthis_arg: orig.this_arg,").unwrap();
511 for (field, clone_fn, _) in generated_fields.iter() {
512 if let Some(f) = clone_fn {
513 // If the field isn't clonable, blindly assume its a trait and hope for the best.
514 writeln!(w, "\t\t{}: {}(&orig.{}),", field, f, field).unwrap();
516 writeln!(w, "\t\t{}: Clone::clone(&orig.{}),", field, field).unwrap();
519 writeln!(w, "\t}}\n}}").unwrap();
521 // Implement supertraits for the C-mapped struct.
522 walk_supertraits!(t, Some(&types), (
523 ("std::cmp::Eq", _)|("core::cmp::Eq", _) => {
524 writeln!(w, "impl std::cmp::Eq for {} {{}}", trait_name).unwrap();
525 writeln!(w, "impl std::cmp::PartialEq for {} {{", trait_name).unwrap();
526 writeln!(w, "\tfn eq(&self, o: &Self) -> bool {{ (self.eq)(self.this_arg, o) }}\n}}").unwrap();
528 ("std::hash::Hash", _)|("core::hash::Hash", _) => {
529 writeln!(w, "impl std::hash::Hash for {} {{", trait_name).unwrap();
530 writeln!(w, "\tfn hash<H: std::hash::Hasher>(&self, hasher: &mut H) {{ hasher.write_u64((self.hash)(self.this_arg)) }}\n}}").unwrap();
532 ("Send", _) => {}, ("Sync", _) => {},
534 writeln!(w, "#[no_mangle]").unwrap();
535 writeln!(w, "/// Creates a copy of a {}", trait_name).unwrap();
536 writeln!(w, "pub extern \"C\" fn {}_clone(orig: &{}) -> {} {{", trait_name, trait_name, trait_name).unwrap();
537 writeln!(w, "\tlet mut res = {}_clone_fields(orig);", trait_name).unwrap();
538 writeln!(w, "\tif let Some(f) = orig.cloned {{ (f)(&mut res) }};").unwrap();
539 writeln!(w, "\tres\n}}").unwrap();
540 writeln!(w, "impl Clone for {} {{", trait_name).unwrap();
541 writeln!(w, "\tfn clone(&self) -> Self {{").unwrap();
542 writeln!(w, "\t\t{}_clone(self)", trait_name).unwrap();
543 writeln!(w, "\t}}\n}}").unwrap();
545 ("std::fmt::Debug", _)|("core::fmt::Debug", _) => {
546 writeln!(w, "impl core::fmt::Debug for {} {{", trait_name).unwrap();
547 writeln!(w, "\tfn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {{").unwrap();
548 writeln!(w, "\t\tf.write_str((self.debug_str)(self.this_arg).into_str())").unwrap();
549 writeln!(w, "\t}}").unwrap();
550 writeln!(w, "}}").unwrap();
553 if let Some(supertrait) = types.crate_types.traits.get(s) {
554 let resolver = get_module_type_resolver!(s, types.crate_libs, types.crate_types);
555 writeln!(w, "impl {} for {} {{", s, trait_name).unwrap();
556 impl_trait_for_c!(supertrait, format!(".{}", i), &resolver);
557 writeln!(w, "}}").unwrap();
559 do_write_impl_trait(w, s, i, &trait_name);
564 // Finally, implement the original Rust trait for the newly created mapped trait.
565 writeln!(w, "\nuse {}::{} as rust{};", types.module_path, t.ident, trait_name).unwrap();
567 write!(w, "impl").unwrap();
568 maybe_write_lifetime_generics(w, &t.generics, types);
569 write!(w, " rust{}", t.ident).unwrap();
570 maybe_write_generics(w, &t.generics, types, false);
571 writeln!(w, " for {} {{", trait_name).unwrap();
572 impl_trait_for_c!(t, "", types);
573 writeln!(w, "}}\n").unwrap();
574 writeln!(w, "// We're essentially a pointer already, or at least a set of pointers, so allow us to be used").unwrap();
575 writeln!(w, "// directly as a Deref trait in higher-level structs:").unwrap();
576 writeln!(w, "impl std::ops::Deref for {} {{\n\ttype Target = Self;", trait_name).unwrap();
577 writeln!(w, "\tfn deref(&self) -> &Self {{\n\t\tself\n\t}}\n}}").unwrap();
580 writeln!(w, "/// Calls the free function if one is set").unwrap();
581 writeln!(w, "#[no_mangle]\npub extern \"C\" fn {}_free(this_ptr: {}) {{ }}", trait_name, trait_name).unwrap();
582 writeln!(w, "impl Drop for {} {{", trait_name).unwrap();
583 writeln!(w, "\tfn drop(&mut self) {{").unwrap();
584 writeln!(w, "\t\tif let Some(f) = self.free {{").unwrap();
585 writeln!(w, "\t\t\tf(self.this_arg);").unwrap();
586 writeln!(w, "\t\t}}\n\t}}\n}}").unwrap();
588 write_cpp_wrapper(cpp_headers, &trait_name, true, Some(generated_fields.drain(..)
589 .filter_map(|(name, _, docs)| if let Some(docs) = docs { Some((name, docs)) } else { None }).collect()));
592 /// Write out a simple "opaque" type (eg structs) which contain a pointer to the native Rust type
593 /// and a flag to indicate whether Drop'ing the mapped struct drops the underlying Rust type.
595 /// Also writes out a _free function and a C++ wrapper which handles calling _free.
596 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) {
597 // If we directly read the original type by its original name, cbindgen hits
598 // https://github.com/eqrion/cbindgen/issues/286 Thus, instead, we import it as a temporary
599 // name and then reference it by that name, which works around the issue.
600 write!(w, "\nuse {}::{} as native{}Import;\npub(crate) type native{} = native{}Import", types.module_path, ident, ident, ident, ident).unwrap();
601 maybe_write_generics(w, &generics, &types, true);
602 writeln!(w, ";\n").unwrap();
603 writeln!(extra_headers, "struct native{}Opaque;\ntypedef struct native{}Opaque LDKnative{};", ident, ident, ident).unwrap();
604 writeln_docs(w, &attrs, "");
605 writeln!(w, "#[must_use]\n#[repr(C)]\npub struct {} {{", struct_name).unwrap();
606 writeln!(w, "\t/// A pointer to the opaque Rust object.\n").unwrap();
607 writeln!(w, "\t/// Nearly everywhere, inner must be non-null, however in places where").unwrap();
608 writeln!(w, "\t/// the Rust equivalent takes an Option, it may be set to null to indicate None.").unwrap();
609 writeln!(w, "\tpub inner: *mut native{},", ident).unwrap();
610 writeln!(w, "\t/// Indicates that this is the only struct which contains the same pointer.\n").unwrap();
611 writeln!(w, "\t/// Rust functions which take ownership of an object provided via an argument require").unwrap();
612 writeln!(w, "\t/// this to be true and invalidate the object pointed to by inner.").unwrap();
613 writeln!(w, "\tpub is_owned: bool,").unwrap();
614 writeln!(w, "}}\n").unwrap();
615 writeln!(w, "impl Drop for {} {{\n\tfn drop(&mut self) {{", struct_name).unwrap();
616 writeln!(w, "\t\tif self.is_owned && !<*mut native{}>::is_null(self.inner) {{", ident).unwrap();
617 writeln!(w, "\t\t\tlet _ = unsafe {{ Box::from_raw(ObjOps::untweak_ptr(self.inner)) }};\n\t\t}}\n\t}}\n}}").unwrap();
618 writeln!(w, "/// Frees any resources used by the {}, if is_owned is set and inner is non-NULL.", struct_name).unwrap();
619 writeln!(w, "#[no_mangle]\npub extern \"C\" fn {}_free(this_obj: {}) {{ }}", struct_name, struct_name).unwrap();
620 writeln!(w, "#[allow(unused)]").unwrap();
621 writeln!(w, "/// Used only if an object of this type is returned as a trait impl by a method").unwrap();
622 writeln!(w, "pub(crate) extern \"C\" fn {}_free_void(this_ptr: *mut c_void) {{", struct_name).unwrap();
623 writeln!(w, "\tunsafe {{ let _ = Box::from_raw(this_ptr as *mut native{}); }}\n}}", struct_name).unwrap();
624 writeln!(w, "#[allow(unused)]").unwrap();
625 writeln!(w, "impl {} {{", struct_name).unwrap();
626 writeln!(w, "\tpub(crate) fn get_native_ref(&self) -> &'static native{} {{", struct_name).unwrap();
627 writeln!(w, "\t\tunsafe {{ &*ObjOps::untweak_ptr(self.inner) }}").unwrap();
628 writeln!(w, "\t}}").unwrap();
629 writeln!(w, "\tpub(crate) fn get_native_mut_ref(&self) -> &'static mut native{} {{", struct_name).unwrap();
630 writeln!(w, "\t\tunsafe {{ &mut *ObjOps::untweak_ptr(self.inner) }}").unwrap();
631 writeln!(w, "\t}}").unwrap();
632 writeln!(w, "\t/// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy").unwrap();
633 writeln!(w, "\tpub(crate) fn take_inner(mut self) -> *mut native{} {{", struct_name).unwrap();
634 writeln!(w, "\t\tassert!(self.is_owned);").unwrap();
635 writeln!(w, "\t\tlet ret = ObjOps::untweak_ptr(self.inner);").unwrap();
636 writeln!(w, "\t\tself.inner = std::ptr::null_mut();").unwrap();
637 writeln!(w, "\t\tret").unwrap();
638 writeln!(w, "\t}}\n}}").unwrap();
640 write_cpp_wrapper(cpp_headers, &format!("{}", ident), true, None);
643 /// Writes out all the relevant mappings for a Rust struct, deferring to writeln_opaque to generate
644 /// the struct itself, and then writing getters and setters for public, understood-type fields and
645 /// a constructor if every field is public.
646 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) {
647 if export_status(&s.attrs) != ExportStatus::Export { return; }
649 let struct_name = &format!("{}", s.ident);
650 writeln_opaque(w, &s.ident, struct_name, &s.generics, &s.attrs, types, extra_headers, cpp_headers);
652 let mut self_path_segs = syn::punctuated::Punctuated::new();
653 self_path_segs.push(s.ident.clone().into());
654 let self_path = syn::Path { leading_colon: None, segments: self_path_segs};
655 let mut gen_types = GenericTypes::new(Some(types.resolve_path(&self_path, None)));
656 assert!(gen_types.learn_generics(&s.generics, types));
658 let mut all_fields_settable = true;
659 macro_rules! define_field {
660 ($new_name: expr, $real_name: expr, $field: expr) => {
661 if let syn::Visibility::Public(_) = $field.vis {
662 let export = export_status(&$field.attrs);
664 ExportStatus::Export => {},
665 ExportStatus::NoExport|ExportStatus::TestOnly => {
666 all_fields_settable = false;
669 ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
672 if let Some(ref_type) = types.create_ownable_reference(&$field.ty, Some(&gen_types)) {
673 if types.understood_c_type(&ref_type, Some(&gen_types)) {
674 writeln_arg_docs(w, &$field.attrs, "", types, Some(&gen_types), vec![].drain(..), Some(&ref_type));
675 write!(w, "#[no_mangle]\npub extern \"C\" fn {}_get_{}(this_ptr: &{}) -> ", struct_name, $new_name, struct_name).unwrap();
676 types.write_c_type(w, &ref_type, Some(&gen_types), true);
677 write!(w, " {{\n\tlet mut inner_val = &mut this_ptr.get_native_mut_ref().{};\n\t", $real_name).unwrap();
678 let local_var = types.write_to_c_conversion_from_ownable_ref_new_var(w, &format_ident!("inner_val"), &ref_type, Some(&gen_types));
679 if local_var { write!(w, "\n\t").unwrap(); }
680 types.write_to_c_conversion_inline_prefix(w, &ref_type, Some(&gen_types), true);
681 write!(w, "inner_val").unwrap();
682 types.write_to_c_conversion_inline_suffix(w, &ref_type, Some(&gen_types), true);
683 writeln!(w, "\n}}").unwrap();
687 if types.understood_c_type(&$field.ty, Some(&gen_types)) {
688 writeln_arg_docs(w, &$field.attrs, "", types, Some(&gen_types), vec![("val".to_owned(), &$field.ty)].drain(..), None);
689 write!(w, "#[no_mangle]\npub extern \"C\" fn {}_set_{}(this_ptr: &mut {}, mut val: ", struct_name, $new_name, struct_name).unwrap();
690 types.write_c_type(w, &$field.ty, Some(&gen_types), false);
691 write!(w, ") {{\n\t").unwrap();
692 let local_var = types.write_from_c_conversion_new_var(w, &format_ident!("val"), &$field.ty, Some(&gen_types));
693 if local_var { write!(w, "\n\t").unwrap(); }
694 write!(w, "unsafe {{ &mut *ObjOps::untweak_ptr(this_ptr.inner) }}.{} = ", $real_name).unwrap();
695 types.write_from_c_conversion_prefix(w, &$field.ty, Some(&gen_types));
696 write!(w, "val").unwrap();
697 types.write_from_c_conversion_suffix(w, &$field.ty, Some(&gen_types));
698 writeln!(w, ";\n}}").unwrap();
699 } else { all_fields_settable = false; }
700 } else { all_fields_settable = false; }
705 syn::Fields::Named(fields) => {
706 for field in fields.named.iter() {
707 if let Some(ident) = &field.ident {
708 define_field!(ident, ident, field);
709 } else { all_fields_settable = false; }
712 syn::Fields::Unnamed(fields) => {
713 for (idx, field) in fields.unnamed.iter().enumerate() {
714 define_field!(('a' as u8 + idx as u8) as char, ('0' as u8 + idx as u8) as char, field);
717 _ => unimplemented!()
720 if all_fields_settable {
721 // Build a constructor!
722 writeln!(w, "/// Constructs a new {} given each field", struct_name).unwrap();
723 write!(w, "#[must_use]\n#[no_mangle]\npub extern \"C\" fn {}_new(", struct_name).unwrap();
726 syn::Fields::Named(fields) => {
727 for (idx, field) in fields.named.iter().enumerate() {
728 if idx != 0 { write!(w, ", ").unwrap(); }
729 write!(w, "mut {}_arg: ", field.ident.as_ref().unwrap()).unwrap();
730 types.write_c_type(w, &field.ty, Some(&gen_types), false);
733 syn::Fields::Unnamed(fields) => {
734 for (idx, field) in fields.unnamed.iter().enumerate() {
735 if idx != 0 { write!(w, ", ").unwrap(); }
736 write!(w, "mut {}_arg: ", ('a' as u8 + idx as u8) as char).unwrap();
737 types.write_c_type(w, &field.ty, Some(&gen_types), false);
742 write!(w, ") -> {} {{\n\t", struct_name).unwrap();
744 syn::Fields::Named(fields) => {
745 for field in fields.named.iter() {
746 let field_ident = format_ident!("{}_arg", field.ident.as_ref().unwrap());
747 if types.write_from_c_conversion_new_var(w, &field_ident, &field.ty, Some(&gen_types)) {
748 write!(w, "\n\t").unwrap();
752 syn::Fields::Unnamed(fields) => {
753 for (idx, field) in fields.unnamed.iter().enumerate() {
754 let field_ident = format_ident!("{}_arg", ('a' as u8 + idx as u8) as char);
755 if types.write_from_c_conversion_new_var(w, &field_ident, &field.ty, Some(&gen_types)) {
756 write!(w, "\n\t").unwrap();
762 write!(w, "{} {{ inner: ObjOps::heap_alloc(", struct_name).unwrap();
764 syn::Fields::Named(fields) => {
765 writeln!(w, "native{} {{", s.ident).unwrap();
766 for field in fields.named.iter() {
767 write!(w, "\t\t{}: ", field.ident.as_ref().unwrap()).unwrap();
768 types.write_from_c_conversion_prefix(w, &field.ty, Some(&gen_types));
769 write!(w, "{}_arg", field.ident.as_ref().unwrap()).unwrap();
770 types.write_from_c_conversion_suffix(w, &field.ty, Some(&gen_types));
771 writeln!(w, ",").unwrap();
773 write!(w, "\t}}").unwrap();
775 syn::Fields::Unnamed(fields) => {
776 assert!(s.generics.lt_token.is_none());
777 writeln!(w, "{} (", types.maybe_resolve_ident(&s.ident).unwrap()).unwrap();
778 for (idx, field) in fields.unnamed.iter().enumerate() {
779 write!(w, "\t\t").unwrap();
780 types.write_from_c_conversion_prefix(w, &field.ty, Some(&gen_types));
781 write!(w, "{}_arg", ('a' as u8 + idx as u8) as char).unwrap();
782 types.write_from_c_conversion_suffix(w, &field.ty, Some(&gen_types));
783 writeln!(w, ",").unwrap();
785 write!(w, "\t)").unwrap();
789 writeln!(w, "), is_owned: true }}\n}}").unwrap();
793 /// Prints a relevant conversion for impl *
795 /// For simple impl Struct {}s, this just outputs the wrapper functions as Struct_fn_name() { .. }.
797 /// For impl Trait for Struct{}s, this non-exported generates wrapper functions as
798 /// Trait_Struct_fn_name and a Struct_as_Trait(&struct) -> Trait function which returns a populated
799 /// Trait struct containing a pointer to the passed struct's inner field and the wrapper functions.
801 /// A few non-crate Traits are hard-coded including Default.
802 fn writeln_impl<W: std::io::Write>(w: &mut W, i: &syn::ItemImpl, types: &mut TypeResolver) {
803 match export_status(&i.attrs) {
804 ExportStatus::Export => {},
805 ExportStatus::NoExport|ExportStatus::TestOnly => return,
806 ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
809 if let syn::Type::Tuple(_) = &*i.self_ty {
810 if types.understood_c_type(&*i.self_ty, None) {
811 let mut gen_types = GenericTypes::new(None);
812 if !gen_types.learn_generics(&i.generics, types) {
813 eprintln!("Not implementing anything for `impl (..)` due to not understood generics");
817 if i.defaultness.is_some() || i.unsafety.is_some() { unimplemented!(); }
818 if let Some(trait_path) = i.trait_.as_ref() {
819 if trait_path.0.is_some() { unimplemented!(); }
820 if types.understood_c_path(&trait_path.1) {
821 eprintln!("Not implementing anything for `impl Trait for (..)` - we only support manual defines");
824 // Just do a manual implementation:
825 maybe_convert_trait_impl(w, &trait_path.1, &*i.self_ty, types, &gen_types);
828 eprintln!("Not implementing anything for plain `impl (..)` block - we only support `impl Trait for (..)` blocks");
834 if let &syn::Type::Path(ref p) = &*i.self_ty {
835 if p.qself.is_some() { unimplemented!(); }
836 if let Some(ident) = single_ident_generic_path_to_ident(&p.path) {
837 if let Some(resolved_path) = types.maybe_resolve_non_ignored_ident(&ident) {
838 if !types.understood_c_path(&p.path) {
839 eprintln!("Not implementing anything for impl {} as the type is not understood (probably C-not exported)", ident);
843 let mut gen_types = GenericTypes::new(Some(resolved_path.clone()));
844 if !gen_types.learn_generics(&i.generics, types) {
845 eprintln!("Not implementing anything for impl {} due to not understood generics", ident);
849 if i.defaultness.is_some() || i.unsafety.is_some() { unimplemented!(); }
850 if let Some(trait_path) = i.trait_.as_ref() {
851 if trait_path.0.is_some() { unimplemented!(); }
852 if types.understood_c_path(&trait_path.1) {
853 let full_trait_path = types.resolve_path(&trait_path.1, None);
854 let trait_obj = *types.crate_types.traits.get(&full_trait_path).unwrap();
857 let supertrait_resolver;
858 walk_supertraits!(trait_obj, Some(&types), (
860 if let Some(supertrait) = types.crate_types.traits.get(s) {
861 supertrait_name = s.to_string();
862 supertrait_resolver = get_module_type_resolver!(supertrait_name, types.crate_libs, types.crate_types);
863 gen_types.learn_associated_types(&supertrait, &supertrait_resolver);
868 // We learn the associated types maping from the original trait object.
869 // That's great, except that they are unresolved idents, so if we learn
870 // mappings from a trai defined in a different file, we may mis-resolve or
871 // fail to resolve the mapped types. Thus, we have to construct a new
872 // resolver for the module that the trait was defined in here first.
873 let trait_resolver = get_module_type_resolver!(full_trait_path, types.crate_libs, types.crate_types);
874 gen_types.learn_associated_types(trait_obj, &trait_resolver);
875 let mut impl_associated_types = HashMap::new();
876 for item in i.items.iter() {
878 syn::ImplItem::Type(t) => {
879 if let syn::Type::Path(p) = &t.ty {
880 if let Some(id) = single_ident_generic_path_to_ident(&p.path) {
881 impl_associated_types.insert(&t.ident, id);
889 let export = export_status(&trait_obj.attrs);
891 ExportStatus::Export|ExportStatus::NotImplementable => {},
892 ExportStatus::NoExport|ExportStatus::TestOnly => return,
895 // For cases where we have a concrete native object which implements a
896 // trait and need to return the C-mapped version of the trait, provide a
897 // From<> implementation which does all the work to ensure free is handled
898 // properly. This way we can call this method from deep in the
899 // type-conversion logic without actually knowing the concrete native type.
900 if !resolved_path.starts_with(types.module_path) {
901 if !first_seg_is_stdlib(resolved_path.split("::").next().unwrap()) {
902 writeln!(w, "use crate::{}::native{} as native{};", resolved_path.rsplitn(2, "::").skip(1).next().unwrap(), ident, ident).unwrap();
903 writeln!(w, "use crate::{};", resolved_path).unwrap();
904 writeln!(w, "use crate::{}_free_void;", resolved_path).unwrap();
906 writeln!(w, "use {} as native{};", resolved_path, ident).unwrap();
909 writeln!(w, "impl From<native{}> for crate::{} {{", ident, full_trait_path).unwrap();
910 writeln!(w, "\tfn from(obj: native{}) -> Self {{", ident).unwrap();
911 if is_type_unconstructable(&resolved_path) {
912 writeln!(w, "\t\tunreachable!();").unwrap();
914 writeln!(w, "\t\tlet mut rust_obj = {} {{ inner: ObjOps::heap_alloc(obj), is_owned: true }};", ident).unwrap();
915 writeln!(w, "\t\tlet mut ret = {}_as_{}(&rust_obj);", ident, trait_obj.ident).unwrap();
916 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();
917 writeln!(w, "\t\trust_obj.inner = std::ptr::null_mut();").unwrap();
918 writeln!(w, "\t\tret.free = Some({}_free_void);", ident).unwrap();
919 writeln!(w, "\t\tret").unwrap();
921 writeln!(w, "\t}}\n}}").unwrap();
922 if is_type_unconstructable(&resolved_path) {
923 // We don't bother with Struct_as_Trait conversion for types which must
924 // never be instantiated, so just return early.
928 writeln!(w, "/// Constructs a new {} which calls the relevant methods on this_arg.", trait_obj.ident).unwrap();
929 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();
930 write!(w, "#[no_mangle]\npub extern \"C\" fn {}_as_{}(this_arg: &{}) -> crate::{} {{\n", ident, trait_obj.ident, ident, full_trait_path).unwrap();
931 writeln!(w, "\tcrate::{} {{", full_trait_path).unwrap();
932 writeln!(w, "\t\tthis_arg: unsafe {{ ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void }},").unwrap();
933 writeln!(w, "\t\tfree: None,").unwrap();
935 macro_rules! write_meth {
936 ($m: expr, $trait: expr, $indent: expr) => {
937 let trait_method = $trait.items.iter().filter_map(|item| {
938 if let syn::TraitItem::Method(t_m) = item { Some(t_m) } else { None }
939 }).find(|trait_meth| trait_meth.sig.ident == $m.sig.ident).unwrap();
940 match export_status(&trait_method.attrs) {
941 ExportStatus::Export => {},
942 ExportStatus::NoExport => {
943 write!(w, "{}\t\t//XXX: Need to export {}\n", $indent, $m.sig.ident).unwrap();
946 ExportStatus::TestOnly => continue,
947 ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
950 let mut printed = false;
951 if let syn::ReturnType::Type(_, rtype) = &$m.sig.output {
952 if let syn::Type::Reference(r) = &**rtype {
953 write!(w, "\n\t\t{}{}: ", $indent, $m.sig.ident).unwrap();
954 types.write_empty_rust_val(Some(&gen_types), w, &*r.elem);
955 writeln!(w, ",\n{}\t\tset_{}: Some({}_{}_set_{}),", $indent, $m.sig.ident, ident, $trait.ident, $m.sig.ident).unwrap();
960 write!(w, "{}\t\t{}: {}_{}_{},\n", $indent, $m.sig.ident, ident, $trait.ident, $m.sig.ident).unwrap();
964 for item in trait_obj.items.iter() {
966 syn::TraitItem::Method(m) => {
967 write_meth!(m, trait_obj, "");
972 let mut requires_clone = false;
973 walk_supertraits!(trait_obj, Some(&types), (
975 requires_clone = true;
976 writeln!(w, "\t\tcloned: Some({}_{}_cloned),", trait_obj.ident, ident).unwrap();
978 ("Sync", _) => {}, ("Send", _) => {},
979 ("std::marker::Sync", _) => {}, ("std::marker::Send", _) => {},
980 ("core::fmt::Debug", _) => {},
982 if let Some(supertrait_obj) = types.crate_types.traits.get(s) {
983 writeln!(w, "\t\t{}: crate::{} {{", t, s).unwrap();
984 writeln!(w, "\t\t\tthis_arg: unsafe {{ ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void }},").unwrap();
985 writeln!(w, "\t\t\tfree: None,").unwrap();
986 for item in supertrait_obj.items.iter() {
988 syn::TraitItem::Method(m) => {
989 write_meth!(m, supertrait_obj, "\t");
994 write!(w, "\t\t}},\n").unwrap();
996 write_trait_impl_field_assign(w, s, ident);
1000 writeln!(w, "\t}}\n}}\n").unwrap();
1002 macro_rules! impl_meth {
1003 ($m: expr, $trait_meth: expr, $trait_path: expr, $trait: expr, $indent: expr) => {
1004 let trait_method = $trait.items.iter().filter_map(|item| {
1005 if let syn::TraitItem::Method(t_m) = item { Some(t_m) } else { None }
1006 }).find(|trait_meth| trait_meth.sig.ident == $m.sig.ident).unwrap();
1007 match export_status(&trait_method.attrs) {
1008 ExportStatus::Export => {},
1009 ExportStatus::NoExport|ExportStatus::TestOnly => continue,
1010 ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
1013 if let syn::ReturnType::Type(_, _) = &$m.sig.output {
1014 writeln!(w, "#[must_use]").unwrap();
1016 write!(w, "extern \"C\" fn {}_{}_{}(", ident, $trait.ident, $m.sig.ident).unwrap();
1017 let mut meth_gen_types = gen_types.push_ctx();
1018 assert!(meth_gen_types.learn_generics(&$m.sig.generics, types));
1019 let mut uncallable_function = false;
1020 for inp in $m.sig.inputs.iter() {
1022 syn::FnArg::Typed(arg) => {
1023 if types.skip_arg(&*arg.ty, Some(&meth_gen_types)) { continue; }
1024 let mut c_type = Vec::new();
1025 types.write_c_type(&mut c_type, &*arg.ty, Some(&meth_gen_types), false);
1026 if is_type_unconstructable(&String::from_utf8(c_type).unwrap()) {
1027 uncallable_function = true;
1033 if uncallable_function {
1034 let mut trait_resolver = get_module_type_resolver!(full_trait_path, types.crate_libs, types.crate_types);
1035 write_method_params(w, &$trait_meth.sig, "c_void", &mut trait_resolver, Some(&meth_gen_types), true, true);
1037 write_method_params(w, &$m.sig, "c_void", types, Some(&meth_gen_types), true, true);
1039 write!(w, " {{\n\t").unwrap();
1040 if uncallable_function {
1041 write!(w, "unreachable!();").unwrap();
1043 write_method_var_decl_body(w, &$m.sig, "", types, Some(&meth_gen_types), false);
1044 let mut takes_self = false;
1045 for inp in $m.sig.inputs.iter() {
1046 if let syn::FnArg::Receiver(_) = inp {
1051 let mut t_gen_args = String::new();
1052 for (idx, _) in $trait.generics.params.iter().enumerate() {
1053 if idx != 0 { t_gen_args += ", " };
1057 write!(w, "<native{} as {}<{}>>::{}(unsafe {{ &mut *(this_arg as *mut native{}) }}, ", ident, $trait_path, t_gen_args, $m.sig.ident, ident).unwrap();
1059 write!(w, "<native{} as {}<{}>>::{}(", ident, $trait_path, t_gen_args, $m.sig.ident).unwrap();
1062 let mut real_type = "".to_string();
1063 match &$m.sig.output {
1064 syn::ReturnType::Type(_, rtype) => {
1065 if let Some(mut remaining_path) = first_seg_self(&*rtype) {
1066 if let Some(associated_seg) = get_single_remaining_path_seg(&mut remaining_path) {
1067 real_type = format!("{}", impl_associated_types.get(associated_seg).unwrap());
1073 write_method_call_params(w, &$m.sig, "", types, Some(&meth_gen_types), &real_type, false);
1075 write!(w, "\n}}\n").unwrap();
1076 if let syn::ReturnType::Type(_, rtype) = &$m.sig.output {
1077 if let syn::Type::Reference(r) = &**rtype {
1078 assert_eq!($m.sig.inputs.len(), 1); // Must only take self
1079 writeln!(w, "extern \"C\" fn {}_{}_set_{}(trait_self_arg: &{}) {{", ident, $trait.ident, $m.sig.ident, $trait.ident).unwrap();
1080 writeln!(w, "\t// This is a bit race-y in the general case, but for our specific use-cases today, we're safe").unwrap();
1081 writeln!(w, "\t// Specifically, we must ensure that the first time we're called it can never be in parallel").unwrap();
1082 write!(w, "\tif ").unwrap();
1083 types.write_empty_rust_val_check(Some(&meth_gen_types), w, &*r.elem, &format!("trait_self_arg.{}", $m.sig.ident));
1084 writeln!(w, " {{").unwrap();
1085 writeln!(w, "\t\tunsafe {{ &mut *(trait_self_arg as *const {} as *mut {}) }}.{} = {}_{}_{}(trait_self_arg.this_arg);", $trait.ident, $trait.ident, $m.sig.ident, ident, $trait.ident, $m.sig.ident).unwrap();
1086 writeln!(w, "\t}}").unwrap();
1087 writeln!(w, "}}").unwrap();
1093 'impl_item_loop: for item in i.items.iter() {
1095 syn::ImplItem::Method(m) => {
1096 for trait_item in trait_obj.items.iter() {
1098 syn::TraitItem::Method(meth) => {
1099 if meth.sig.ident == m.sig.ident {
1100 impl_meth!(m, meth, full_trait_path, trait_obj, "");
1101 continue 'impl_item_loop;
1109 syn::ImplItem::Type(_) => {},
1110 _ => unimplemented!(),
1114 writeln!(w, "extern \"C\" fn {}_{}_cloned(new_obj: &mut crate::{}) {{", trait_obj.ident, ident, full_trait_path).unwrap();
1115 writeln!(w, "\tnew_obj.this_arg = {}_clone_void(new_obj.this_arg);", ident).unwrap();
1116 writeln!(w, "\tnew_obj.free = Some({}_free_void);", ident).unwrap();
1117 walk_supertraits!(trait_obj, Some(&types), (
1119 if types.crate_types.traits.get(s).is_some() {
1120 assert!(!types.is_clonable(s)); // We don't currently support cloning with a clonable supertrait
1121 writeln!(w, "\tnew_obj.{}.this_arg = new_obj.this_arg;", t).unwrap();
1122 writeln!(w, "\tnew_obj.{}.free = None;", t).unwrap();
1126 writeln!(w, "}}").unwrap();
1128 write!(w, "\n").unwrap();
1131 if is_type_unconstructable(&resolved_path) {
1132 // Don't bother exposing trait implementations for objects which cannot be
1136 if path_matches_nongeneric(&trait_path.1, &["From"]) {
1137 } else if path_matches_nongeneric(&trait_path.1, &["Default"]) {
1138 writeln!(w, "/// Creates a \"default\" {}. See struct and individual field documentaiton for details on which values are used.", ident).unwrap();
1139 write!(w, "#[must_use]\n#[no_mangle]\npub extern \"C\" fn {}_default() -> {} {{\n", ident, ident).unwrap();
1140 write!(w, "\t{} {{ inner: ObjOps::heap_alloc(Default::default()), is_owned: true }}\n", ident).unwrap();
1141 write!(w, "}}\n").unwrap();
1142 } else if path_matches_nongeneric(&trait_path.1, &["core", "cmp", "PartialEq"]) {
1143 } else if path_matches_nongeneric(&trait_path.1, &["core", "cmp", "Eq"]) {
1144 writeln!(w, "/// Checks if two {}s contain equal inner contents.", ident).unwrap();
1145 writeln!(w, "/// This ignores pointers and is_owned flags and looks at the values in fields.").unwrap();
1146 if types.c_type_has_inner_from_path(&resolved_path) {
1147 writeln!(w, "/// Two objects with NULL inner values will be considered \"equal\" here.").unwrap();
1149 write!(w, "#[no_mangle]\npub extern \"C\" fn {}_eq(a: &{}, b: &{}) -> bool {{\n", ident, ident, ident).unwrap();
1150 if types.c_type_has_inner_from_path(&resolved_path) {
1151 write!(w, "\tif a.inner == b.inner {{ return true; }}\n").unwrap();
1152 write!(w, "\tif a.inner.is_null() || b.inner.is_null() {{ return false; }}\n").unwrap();
1156 let ref_type: syn::Type = syn::parse_quote!(&#path);
1157 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");
1159 write!(w, "\tif ").unwrap();
1160 types.write_from_c_conversion_prefix(w, &ref_type, Some(&gen_types));
1161 write!(w, "a").unwrap();
1162 types.write_from_c_conversion_suffix(w, &ref_type, Some(&gen_types));
1163 write!(w, " == ").unwrap();
1164 types.write_from_c_conversion_prefix(w, &ref_type, Some(&gen_types));
1165 write!(w, "b").unwrap();
1166 types.write_from_c_conversion_suffix(w, &ref_type, Some(&gen_types));
1168 writeln!(w, " {{ true }} else {{ false }}\n}}").unwrap();
1169 } else if path_matches_nongeneric(&trait_path.1, &["core", "hash", "Hash"]) {
1170 writeln!(w, "/// Checks if two {}s contain equal inner contents.", ident).unwrap();
1171 write!(w, "#[no_mangle]\npub extern \"C\" fn {}_hash(o: &{}) -> u64 {{\n", ident, ident).unwrap();
1172 if types.c_type_has_inner_from_path(&resolved_path) {
1173 write!(w, "\tif o.inner.is_null() {{ return 0; }}\n").unwrap();
1177 let ref_type: syn::Type = syn::parse_quote!(&#path);
1178 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");
1180 writeln!(w, "\t// Note that we'd love to use std::collections::hash_map::DefaultHasher but it's not in core").unwrap();
1181 writeln!(w, "\t#[allow(deprecated)]").unwrap();
1182 writeln!(w, "\tlet mut hasher = core::hash::SipHasher::new();").unwrap();
1183 write!(w, "\tstd::hash::Hash::hash(").unwrap();
1184 types.write_from_c_conversion_prefix(w, &ref_type, Some(&gen_types));
1185 write!(w, "o").unwrap();
1186 types.write_from_c_conversion_suffix(w, &ref_type, Some(&gen_types));
1187 writeln!(w, ", &mut hasher);").unwrap();
1188 writeln!(w, "\tstd::hash::Hasher::finish(&hasher)\n}}").unwrap();
1189 } else if (path_matches_nongeneric(&trait_path.1, &["core", "clone", "Clone"]) || path_matches_nongeneric(&trait_path.1, &["Clone"])) &&
1190 types.c_type_has_inner_from_path(&resolved_path) {
1191 writeln!(w, "impl Clone for {} {{", ident).unwrap();
1192 writeln!(w, "\tfn clone(&self) -> Self {{").unwrap();
1193 writeln!(w, "\t\tSelf {{").unwrap();
1194 writeln!(w, "\t\t\tinner: if <*mut native{}>::is_null(self.inner) {{ std::ptr::null_mut() }} else {{", ident).unwrap();
1195 writeln!(w, "\t\t\t\tObjOps::heap_alloc(unsafe {{ &*ObjOps::untweak_ptr(self.inner) }}.clone()) }},").unwrap();
1196 writeln!(w, "\t\t\tis_owned: true,").unwrap();
1197 writeln!(w, "\t\t}}\n\t}}\n}}").unwrap();
1198 writeln!(w, "#[allow(unused)]").unwrap();
1199 writeln!(w, "/// Used only if an object of this type is returned as a trait impl by a method").unwrap();
1200 writeln!(w, "pub(crate) extern \"C\" fn {}_clone_void(this_ptr: *const c_void) -> *mut c_void {{", ident).unwrap();
1201 writeln!(w, "\tBox::into_raw(Box::new(unsafe {{ (*(this_ptr as *mut native{})).clone() }})) as *mut c_void", ident).unwrap();
1202 writeln!(w, "}}").unwrap();
1203 writeln!(w, "#[no_mangle]").unwrap();
1204 writeln!(w, "/// Creates a copy of the {}", ident).unwrap();
1205 writeln!(w, "pub extern \"C\" fn {}_clone(orig: &{}) -> {} {{", ident, ident, ident).unwrap();
1206 writeln!(w, "\torig.clone()").unwrap();
1207 writeln!(w, "}}").unwrap();
1208 } else if path_matches_nongeneric(&trait_path.1, &["FromStr"]) {
1209 if let Some(container) = types.get_c_mangled_container_type(
1210 vec![&*i.self_ty, &syn::Type::Tuple(syn::TypeTuple { paren_token: Default::default(), elems: syn::punctuated::Punctuated::new() })],
1211 Some(&gen_types), "Result") {
1212 writeln!(w, "#[no_mangle]").unwrap();
1213 writeln!(w, "/// Read a {} object from a string", ident).unwrap();
1214 writeln!(w, "pub extern \"C\" fn {}_from_str(s: crate::c_types::Str) -> {} {{", ident, container).unwrap();
1215 writeln!(w, "\tmatch {}::from_str(s.into_str()) {{", resolved_path).unwrap();
1216 writeln!(w, "\t\tOk(r) => {{").unwrap();
1217 let new_var = types.write_to_c_conversion_new_var(w, &format_ident!("r"), &*i.self_ty, Some(&gen_types), false);
1218 write!(w, "\t\t\tcrate::c_types::CResultTempl::ok(\n\t\t\t\t").unwrap();
1219 types.write_to_c_conversion_inline_prefix(w, &*i.self_ty, Some(&gen_types), false);
1220 write!(w, "{}r", if new_var { "local_" } else { "" }).unwrap();
1221 types.write_to_c_conversion_inline_suffix(w, &*i.self_ty, Some(&gen_types), false);
1222 writeln!(w, "\n\t\t\t)\n\t\t}},").unwrap();
1223 writeln!(w, "\t\tErr(e) => crate::c_types::CResultTempl::err(()),").unwrap();
1224 writeln!(w, "\t}}.into()\n}}").unwrap();
1226 } else if path_matches_nongeneric(&trait_path.1, &["Display"]) {
1227 writeln!(w, "#[no_mangle]").unwrap();
1228 writeln!(w, "/// Get the string representation of a {} object", ident).unwrap();
1229 writeln!(w, "pub extern \"C\" fn {}_to_str(o: &crate::{}) -> Str {{", ident, resolved_path).unwrap();
1231 let self_ty = &i.self_ty;
1232 let ref_type: syn::Type = syn::parse_quote!(&#self_ty);
1233 let new_var = types.write_from_c_conversion_new_var(w, &format_ident!("o"), &ref_type, Some(&gen_types));
1234 write!(w, "\tformat!(\"{{}}\", ").unwrap();
1235 types.write_from_c_conversion_prefix(w, &ref_type, Some(&gen_types));
1236 write!(w, "{}o", if new_var { "local_" } else { "" }).unwrap();
1237 types.write_from_c_conversion_suffix(w, &ref_type, Some(&gen_types));
1238 writeln!(w, ").into()").unwrap();
1240 writeln!(w, "}}").unwrap();
1242 //XXX: implement for other things like ToString
1243 // If we have no generics, try a manual implementation:
1244 maybe_convert_trait_impl(w, &trait_path.1, &*i.self_ty, types, &gen_types);
1247 let declared_type = (*types.get_declared_type(&ident).unwrap()).clone();
1248 for item in i.items.iter() {
1250 syn::ImplItem::Method(m) => {
1251 if let syn::Visibility::Public(_) = m.vis {
1252 match export_status(&m.attrs) {
1253 ExportStatus::Export => {},
1254 ExportStatus::NoExport|ExportStatus::TestOnly => continue,
1255 ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
1257 let mut meth_gen_types = gen_types.push_ctx();
1258 assert!(meth_gen_types.learn_generics(&m.sig.generics, types));
1259 if m.defaultness.is_some() { unimplemented!(); }
1260 writeln_fn_docs(w, &m.attrs, "", types, Some(&meth_gen_types), m.sig.inputs.iter(), &m.sig.output);
1261 if let syn::ReturnType::Type(_, _) = &m.sig.output {
1262 writeln!(w, "#[must_use]").unwrap();
1264 write!(w, "#[no_mangle]\npub extern \"C\" fn {}_{}(", ident, m.sig.ident).unwrap();
1265 let ret_type = match &declared_type {
1266 DeclType::MirroredEnum => format!("{}", ident),
1267 DeclType::StructImported {..} => format!("{}", ident),
1268 _ => unimplemented!(),
1270 write_method_params(w, &m.sig, &ret_type, types, Some(&meth_gen_types), false, true);
1271 write!(w, " {{\n\t").unwrap();
1272 write_method_var_decl_body(w, &m.sig, "", types, Some(&meth_gen_types), false);
1273 let mut takes_self = false;
1274 let mut takes_mut_self = false;
1275 let mut takes_owned_self = false;
1276 for inp in m.sig.inputs.iter() {
1277 if let syn::FnArg::Receiver(r) = inp {
1279 if r.mutability.is_some() { takes_mut_self = true; }
1280 if r.reference.is_none() { takes_owned_self = true; }
1283 if !takes_mut_self && !takes_self {
1284 write!(w, "{}::{}(", resolved_path, m.sig.ident).unwrap();
1286 match &declared_type {
1287 DeclType::MirroredEnum => write!(w, "this_arg.to_native().{}(", m.sig.ident).unwrap(),
1288 DeclType::StructImported {..} => {
1289 if takes_owned_self {
1290 write!(w, "(*unsafe {{ Box::from_raw(this_arg.take_inner()) }}).{}(", m.sig.ident).unwrap();
1291 } else if takes_mut_self {
1292 write!(w, "unsafe {{ &mut (*ObjOps::untweak_ptr(this_arg.inner as *mut native{})) }}.{}(", ident, m.sig.ident).unwrap();
1294 write!(w, "unsafe {{ &*ObjOps::untweak_ptr(this_arg.inner) }}.{}(", m.sig.ident).unwrap();
1297 _ => unimplemented!(),
1300 write_method_call_params(w, &m.sig, "", types, Some(&meth_gen_types), &ret_type, false);
1301 writeln!(w, "\n}}\n").unwrap();
1308 } else if let Some(resolved_path) = types.maybe_resolve_ident(&ident) {
1309 if let Some(aliases) = types.crate_types.reverse_alias_map.get(&resolved_path).cloned() {
1310 'alias_impls: for (alias, arguments) in aliases {
1311 let alias_resolved = types.resolve_path(&alias, None);
1312 for (idx, gen) in i.generics.params.iter().enumerate() {
1314 syn::GenericParam::Type(type_param) => {
1315 'bounds_check: for bound in type_param.bounds.iter() {
1316 if let syn::TypeParamBound::Trait(trait_bound) = bound {
1317 if let syn::PathArguments::AngleBracketed(ref t) = &arguments {
1318 assert!(idx < t.args.len());
1319 if let syn::GenericArgument::Type(syn::Type::Path(p)) = &t.args[idx] {
1320 let generic_arg = types.resolve_path(&p.path, None);
1321 let generic_bound = types.resolve_path(&trait_bound.path, None);
1322 if let Some(traits_impld) = types.crate_types.trait_impls.get(&generic_arg) {
1323 for trait_impld in traits_impld {
1324 if *trait_impld == generic_bound { continue 'bounds_check; }
1326 eprintln!("struct {}'s generic arg {} didn't match bound {}", alias_resolved, generic_arg, generic_bound);
1327 continue 'alias_impls;
1329 eprintln!("struct {}'s generic arg {} didn't match bound {}", alias_resolved, generic_arg, generic_bound);
1330 continue 'alias_impls;
1332 } else { unimplemented!(); }
1333 } else { unimplemented!(); }
1334 } else { unimplemented!(); }
1337 syn::GenericParam::Lifetime(_) => {},
1338 syn::GenericParam::Const(_) => unimplemented!(),
1341 let aliased_impl = syn::ItemImpl {
1342 attrs: i.attrs.clone(),
1343 brace_token: syn::token::Brace(Span::call_site()),
1345 generics: syn::Generics {
1347 params: syn::punctuated::Punctuated::new(),
1351 impl_token: syn::Token![impl](Span::call_site()),
1352 items: i.items.clone(),
1353 self_ty: Box::new(syn::Type::Path(syn::TypePath { qself: None, path: alias.clone() })),
1354 trait_: i.trait_.clone(),
1357 writeln_impl(w, &aliased_impl, types);
1360 eprintln!("Not implementing anything for {} due to it being marked not exported", ident);
1363 eprintln!("Not implementing anything for {} due to no-resolve (probably the type isn't pub)", ident);
1369 /// Replaces upper case charachters with underscore followed by lower case except the first
1370 /// charachter and repeated upper case characthers (which are only made lower case).
1371 fn camel_to_snake_case(camel: &str) -> String {
1372 let mut res = "".to_string();
1373 let mut last_upper = -1;
1374 for (idx, c) in camel.chars().enumerate() {
1375 if c.is_uppercase() {
1376 if last_upper != idx as isize - 1 { res.push('_'); }
1377 res.push(c.to_lowercase().next().unwrap());
1378 last_upper = idx as isize;
1387 /// Print a mapping of an enum. If all of the enum's fields are C-mapped in some form (or the enum
1388 /// is unitary), we generate an equivalent enum with all types replaced with their C mapped
1389 /// versions followed by conversion functions which map between the Rust version and the C mapped
1391 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) {
1392 match export_status(&e.attrs) {
1393 ExportStatus::Export => {},
1394 ExportStatus::NoExport|ExportStatus::TestOnly => return,
1395 ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
1398 if is_enum_opaque(e) {
1399 eprintln!("Skipping enum {} as it contains non-unit fields", e.ident);
1400 writeln_opaque(w, &e.ident, &format!("{}", e.ident), &e.generics, &e.attrs, types, extra_headers, cpp_headers);
1403 writeln_docs(w, &e.attrs, "");
1405 let mut gen_types = GenericTypes::new(None);
1406 assert!(gen_types.learn_generics(&e.generics, types));
1408 let mut needs_free = false;
1409 let mut constr = Vec::new();
1411 writeln!(w, "#[must_use]\n#[derive(Clone)]\n#[repr(C)]\npub enum {} {{", e.ident).unwrap();
1412 for var in e.variants.iter() {
1413 assert_eq!(export_status(&var.attrs), ExportStatus::Export); // We can't partially-export a mirrored enum
1414 writeln_docs(w, &var.attrs, "\t");
1415 write!(w, "\t{}", var.ident).unwrap();
1416 writeln!(&mut constr, "#[no_mangle]\n/// Utility method to constructs a new {}-variant {}", var.ident, e.ident).unwrap();
1417 let constr_name = camel_to_snake_case(&format!("{}", var.ident));
1418 write!(&mut constr, "pub extern \"C\" fn {}_{}(", e.ident, constr_name).unwrap();
1419 let mut empty_tuple_variant = false;
1420 if let syn::Fields::Named(fields) = &var.fields {
1422 writeln!(w, " {{").unwrap();
1423 for (idx, field) in fields.named.iter().enumerate() {
1424 if export_status(&field.attrs) == ExportStatus::TestOnly { continue; }
1425 writeln_field_docs(w, &field.attrs, "\t\t", types, Some(&gen_types), &field.ty);
1426 write!(w, "\t\t{}: ", field.ident.as_ref().unwrap()).unwrap();
1427 write!(&mut constr, "{}{}: ", if idx != 0 { ", " } else { "" }, field.ident.as_ref().unwrap()).unwrap();
1428 types.write_c_type(w, &field.ty, Some(&gen_types), false);
1429 types.write_c_type(&mut constr, &field.ty, Some(&gen_types), false);
1430 writeln!(w, ",").unwrap();
1432 write!(w, "\t}}").unwrap();
1433 } else if let syn::Fields::Unnamed(fields) = &var.fields {
1434 if fields.unnamed.len() == 1 {
1435 let mut empty_check = Vec::new();
1436 types.write_c_type(&mut empty_check, &fields.unnamed[0].ty, Some(&gen_types), false);
1437 if empty_check.is_empty() {
1438 empty_tuple_variant = true;
1441 if !empty_tuple_variant {
1443 write!(w, "(").unwrap();
1444 for (idx, field) in fields.unnamed.iter().enumerate() {
1445 if export_status(&field.attrs) == ExportStatus::TestOnly { continue; }
1446 write!(&mut constr, "{}: ", ('a' as u8 + idx as u8) as char).unwrap();
1447 types.write_c_type(w, &field.ty, Some(&gen_types), false);
1448 types.write_c_type(&mut constr, &field.ty, Some(&gen_types), false);
1449 if idx != fields.unnamed.len() - 1 {
1450 write!(w, ",").unwrap();
1451 write!(&mut constr, ",").unwrap();
1454 write!(w, ")").unwrap();
1457 if var.discriminant.is_some() { unimplemented!(); }
1458 write!(&mut constr, ") -> {} {{\n\t{}::{}", e.ident, e.ident, var.ident).unwrap();
1459 if let syn::Fields::Named(fields) = &var.fields {
1460 writeln!(&mut constr, " {{").unwrap();
1461 for field in fields.named.iter() {
1462 writeln!(&mut constr, "\t\t{},", field.ident.as_ref().unwrap()).unwrap();
1464 writeln!(&mut constr, "\t}}").unwrap();
1465 } else if let syn::Fields::Unnamed(fields) = &var.fields {
1466 if !empty_tuple_variant {
1467 write!(&mut constr, "(").unwrap();
1468 for idx in 0..fields.unnamed.len() {
1469 write!(&mut constr, "{}, ", ('a' as u8 + idx as u8) as char).unwrap();
1471 writeln!(&mut constr, ")").unwrap();
1473 writeln!(&mut constr, "").unwrap();
1476 writeln!(&mut constr, "}}").unwrap();
1477 writeln!(w, ",").unwrap();
1479 writeln!(w, "}}\nuse {}::{} as native{};\nimpl {} {{", types.module_path, e.ident, e.ident, e.ident).unwrap();
1481 macro_rules! write_conv {
1482 ($fn_sig: expr, $to_c: expr, $ref: expr) => {
1483 writeln!(w, "\t#[allow(unused)]\n\tpub(crate) fn {} {{\n\t\tmatch {} {{", $fn_sig, if $to_c { "native" } else { "self" }).unwrap();
1484 for var in e.variants.iter() {
1485 write!(w, "\t\t\t{}{}::{} ", if $to_c { "native" } else { "" }, e.ident, var.ident).unwrap();
1486 let mut empty_tuple_variant = false;
1487 if let syn::Fields::Named(fields) = &var.fields {
1488 write!(w, "{{").unwrap();
1489 for field in fields.named.iter() {
1490 if export_status(&field.attrs) == ExportStatus::TestOnly { continue; }
1491 write!(w, "{}{}, ", if $ref { "ref " } else { "mut " }, field.ident.as_ref().unwrap()).unwrap();
1493 write!(w, "}} ").unwrap();
1494 } else if let syn::Fields::Unnamed(fields) = &var.fields {
1495 if fields.unnamed.len() == 1 {
1496 let mut empty_check = Vec::new();
1497 types.write_c_type(&mut empty_check, &fields.unnamed[0].ty, Some(&gen_types), false);
1498 if empty_check.is_empty() {
1499 empty_tuple_variant = true;
1502 if !empty_tuple_variant || $to_c {
1503 write!(w, "(").unwrap();
1504 for (idx, field) in fields.unnamed.iter().enumerate() {
1505 if export_status(&field.attrs) == ExportStatus::TestOnly { continue; }
1506 write!(w, "{}{}, ", if $ref { "ref " } else { "mut " }, ('a' as u8 + idx as u8) as char).unwrap();
1508 write!(w, ") ").unwrap();
1511 write!(w, "=>").unwrap();
1513 macro_rules! handle_field_a {
1514 ($field: expr, $field_ident: expr) => { {
1515 if export_status(&$field.attrs) == ExportStatus::TestOnly { continue; }
1516 let mut sink = ::std::io::sink();
1517 let mut out: &mut dyn std::io::Write = if $ref { &mut sink } else { w };
1518 let new_var = if $to_c {
1519 types.write_to_c_conversion_new_var(&mut out, $field_ident, &$field.ty, Some(&gen_types), false)
1521 types.write_from_c_conversion_new_var(&mut out, $field_ident, &$field.ty, Some(&gen_types))
1523 if $ref || new_var {
1525 write!(w, "let mut {}_nonref = (*{}).clone();\n\t\t\t\t", $field_ident, $field_ident).unwrap();
1527 let nonref_ident = format_ident!("{}_nonref", $field_ident);
1529 types.write_to_c_conversion_new_var(w, &nonref_ident, &$field.ty, Some(&gen_types), false);
1531 types.write_from_c_conversion_new_var(w, &nonref_ident, &$field.ty, Some(&gen_types));
1533 write!(w, "\n\t\t\t\t").unwrap();
1536 write!(w, "\n\t\t\t\t").unwrap();
1541 if let syn::Fields::Named(fields) = &var.fields {
1542 write!(w, " {{\n\t\t\t\t").unwrap();
1543 for field in fields.named.iter() {
1544 handle_field_a!(field, field.ident.as_ref().unwrap());
1546 } else if let syn::Fields::Unnamed(fields) = &var.fields {
1547 write!(w, " {{\n\t\t\t\t").unwrap();
1548 for (idx, field) in fields.unnamed.iter().enumerate() {
1549 if !empty_tuple_variant {
1550 handle_field_a!(field, &format_ident!("{}", ('a' as u8 + idx as u8) as char));
1553 } else { write!(w, " ").unwrap(); }
1555 write!(w, "{}{}::{}", if $to_c { "" } else { "native" }, e.ident, var.ident).unwrap();
1557 macro_rules! handle_field_b {
1558 ($field: expr, $field_ident: expr) => { {
1559 if export_status(&$field.attrs) == ExportStatus::TestOnly { continue; }
1561 types.write_to_c_conversion_inline_prefix(w, &$field.ty, Some(&gen_types), false);
1563 types.write_from_c_conversion_prefix(w, &$field.ty, Some(&gen_types));
1565 write!(w, "{}{}", $field_ident,
1566 if $ref { "_nonref" } else { "" }).unwrap();
1568 types.write_to_c_conversion_inline_suffix(w, &$field.ty, Some(&gen_types), false);
1570 types.write_from_c_conversion_suffix(w, &$field.ty, Some(&gen_types));
1572 write!(w, ",").unwrap();
1576 if let syn::Fields::Named(fields) = &var.fields {
1577 write!(w, " {{").unwrap();
1578 for field in fields.named.iter() {
1579 if export_status(&field.attrs) == ExportStatus::TestOnly { continue; }
1580 write!(w, "\n\t\t\t\t\t{}: ", field.ident.as_ref().unwrap()).unwrap();
1581 handle_field_b!(field, field.ident.as_ref().unwrap());
1583 writeln!(w, "\n\t\t\t\t}}").unwrap();
1584 write!(w, "\t\t\t}}").unwrap();
1585 } else if let syn::Fields::Unnamed(fields) = &var.fields {
1586 if !empty_tuple_variant || !$to_c {
1587 write!(w, " (").unwrap();
1588 for (idx, field) in fields.unnamed.iter().enumerate() {
1589 write!(w, "\n\t\t\t\t\t").unwrap();
1590 handle_field_b!(field, &format_ident!("{}", ('a' as u8 + idx as u8) as char));
1592 writeln!(w, "\n\t\t\t\t)").unwrap();
1594 write!(w, "\t\t\t}}").unwrap();
1596 writeln!(w, ",").unwrap();
1598 writeln!(w, "\t\t}}\n\t}}").unwrap();
1602 write_conv!(format!("to_native(&self) -> native{}", e.ident), false, true);
1603 write_conv!(format!("into_native(self) -> native{}", e.ident), false, false);
1604 write_conv!(format!("from_native(native: &native{}) -> Self", e.ident), true, true);
1605 write_conv!(format!("native_into(native: native{}) -> Self", e.ident), true, false);
1606 writeln!(w, "}}").unwrap();
1609 writeln!(w, "/// Frees any resources used by the {}", e.ident).unwrap();
1610 writeln!(w, "#[no_mangle]\npub extern \"C\" fn {}_free(this_ptr: {}) {{ }}", e.ident, e.ident).unwrap();
1612 writeln!(w, "/// Creates a copy of the {}", e.ident).unwrap();
1613 writeln!(w, "#[no_mangle]").unwrap();
1614 writeln!(w, "pub extern \"C\" fn {}_clone(orig: &{}) -> {} {{", e.ident, e.ident, e.ident).unwrap();
1615 writeln!(w, "\torig.clone()").unwrap();
1616 writeln!(w, "}}").unwrap();
1617 w.write_all(&constr).unwrap();
1618 write_cpp_wrapper(cpp_headers, &format!("{}", e.ident), needs_free, None);
1621 fn writeln_fn<'a, 'b, W: std::io::Write>(w: &mut W, f: &'a syn::ItemFn, types: &mut TypeResolver<'b, 'a>) {
1622 match export_status(&f.attrs) {
1623 ExportStatus::Export => {},
1624 ExportStatus::NoExport|ExportStatus::TestOnly => return,
1625 ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
1627 let mut gen_types = GenericTypes::new(None);
1628 if !gen_types.learn_generics(&f.sig.generics, types) { return; }
1630 writeln_fn_docs(w, &f.attrs, "", types, Some(&gen_types), f.sig.inputs.iter(), &f.sig.output);
1632 write!(w, "#[no_mangle]\npub extern \"C\" fn {}(", f.sig.ident).unwrap();
1633 write_method_params(w, &f.sig, "", types, Some(&gen_types), false, true);
1634 write!(w, " {{\n\t").unwrap();
1635 write_method_var_decl_body(w, &f.sig, "", types, Some(&gen_types), false);
1636 write!(w, "{}::{}(", types.module_path, f.sig.ident).unwrap();
1637 write_method_call_params(w, &f.sig, "", types, Some(&gen_types), "", false);
1638 writeln!(w, "\n}}\n").unwrap();
1641 // ********************************
1642 // *** File/Crate Walking Logic ***
1643 // ********************************
1645 fn convert_priv_mod<'a, 'b: 'a, W: std::io::Write>(w: &mut W, libast: &'b FullLibraryAST, crate_types: &CrateTypes<'b>, out_dir: &str, mod_path: &str, module: &'b syn::ItemMod) {
1646 // We want to ignore all items declared in this module (as they are not pub), but we still need
1647 // to give the ImportResolver any use statements, so we copy them here.
1648 let mut use_items = Vec::new();
1649 for item in module.content.as_ref().unwrap().1.iter() {
1650 if let syn::Item::Use(_) = item {
1651 use_items.push(item);
1654 let import_resolver = ImportResolver::from_borrowed_items(mod_path.splitn(2, "::").next().unwrap(), &libast.dependencies, mod_path, &use_items);
1655 let mut types = TypeResolver::new(mod_path, import_resolver, crate_types);
1657 writeln!(w, "mod {} {{\n{}", module.ident, DEFAULT_IMPORTS).unwrap();
1658 for item in module.content.as_ref().unwrap().1.iter() {
1660 syn::Item::Mod(m) => convert_priv_mod(w, libast, crate_types, out_dir, &format!("{}::{}", mod_path, module.ident), m),
1661 syn::Item::Impl(i) => {
1662 if let &syn::Type::Path(ref p) = &*i.self_ty {
1663 if p.path.get_ident().is_some() {
1664 writeln_impl(w, i, &mut types);
1671 writeln!(w, "}}").unwrap();
1674 /// Do the Real Work of mapping an original file to C-callable wrappers. Creates a new file at
1675 /// `out_path` and fills it with wrapper structs/functions to allow calling the things in the AST
1676 /// at `module` from C.
1677 fn convert_file<'a, 'b>(libast: &'a FullLibraryAST, crate_types: &CrateTypes<'a>, out_dir: &str, header_file: &mut File, cpp_header_file: &mut File) {
1678 for (module, astmod) in libast.modules.iter() {
1679 let orig_crate = module.splitn(2, "::").next().unwrap();
1680 let ASTModule { ref attrs, ref items, ref submods } = astmod;
1681 assert_eq!(export_status(&attrs), ExportStatus::Export);
1683 let new_file_path = if submods.is_empty() {
1684 format!("{}/{}.rs", out_dir, module.replace("::", "/"))
1685 } else if module != "" {
1686 format!("{}/{}/mod.rs", out_dir, module.replace("::", "/"))
1688 format!("{}/lib.rs", out_dir)
1690 let _ = std::fs::create_dir((&new_file_path.as_ref() as &std::path::Path).parent().unwrap());
1691 let mut out = std::fs::OpenOptions::new().write(true).create(true).truncate(true)
1692 .open(new_file_path).expect("Unable to open new src file");
1694 writeln!(out, "// This file is Copyright its original authors, visible in version control").unwrap();
1695 writeln!(out, "// history and in the source files from which this was generated.").unwrap();
1696 writeln!(out, "//").unwrap();
1697 writeln!(out, "// This file is licensed under the license available in the LICENSE or LICENSE.md").unwrap();
1698 writeln!(out, "// file in the root of this repository or, if no such file exists, the same").unwrap();
1699 writeln!(out, "// license as that which applies to the original source files from which this").unwrap();
1700 writeln!(out, "// source was automatically generated.").unwrap();
1701 writeln!(out, "").unwrap();
1703 writeln_docs(&mut out, &attrs, "");
1706 // Special-case the top-level lib.rs with various lint allows and a pointer to the c_types
1707 // and bitcoin hand-written modules.
1708 writeln!(out, "//! C Bindings").unwrap();
1709 writeln!(out, "#![allow(unknown_lints)]").unwrap();
1710 writeln!(out, "#![allow(non_camel_case_types)]").unwrap();
1711 writeln!(out, "#![allow(non_snake_case)]").unwrap();
1712 writeln!(out, "#![allow(unused_imports)]").unwrap();
1713 writeln!(out, "#![allow(unused_variables)]").unwrap();
1714 writeln!(out, "#![allow(unused_mut)]").unwrap();
1715 writeln!(out, "#![allow(unused_parens)]").unwrap();
1716 writeln!(out, "#![allow(unused_unsafe)]").unwrap();
1717 writeln!(out, "#![allow(unused_braces)]").unwrap();
1718 // TODO: We need to map deny(missing_docs) in the source crate(s)
1719 //writeln!(out, "#![deny(missing_docs)]").unwrap();
1720 writeln!(out, "pub mod version;").unwrap();
1721 writeln!(out, "pub mod c_types;").unwrap();
1722 writeln!(out, "pub mod bitcoin;").unwrap();
1724 writeln!(out, "{}", DEFAULT_IMPORTS).unwrap();
1728 writeln!(out, "pub mod {};", m).unwrap();
1731 eprintln!("Converting {} entries...", module);
1733 let import_resolver = ImportResolver::new(orig_crate, &libast.dependencies, module, items);
1734 let mut type_resolver = TypeResolver::new(module, import_resolver, crate_types);
1736 for item in items.iter() {
1738 syn::Item::Use(_) => {}, // Handled above
1739 syn::Item::Static(_) => {},
1740 syn::Item::Enum(e) => {
1741 if let syn::Visibility::Public(_) = e.vis {
1742 writeln_enum(&mut out, &e, &mut type_resolver, header_file, cpp_header_file);
1745 syn::Item::Impl(i) => {
1746 writeln_impl(&mut out, &i, &mut type_resolver);
1748 syn::Item::Struct(s) => {
1749 if let syn::Visibility::Public(_) = s.vis {
1750 writeln_struct(&mut out, &s, &mut type_resolver, header_file, cpp_header_file);
1753 syn::Item::Trait(t) => {
1754 if let syn::Visibility::Public(_) = t.vis {
1755 writeln_trait(&mut out, &t, &mut type_resolver, header_file, cpp_header_file);
1758 syn::Item::Mod(m) => {
1759 convert_priv_mod(&mut out, libast, crate_types, out_dir, &format!("{}::{}", module, m.ident), m);
1761 syn::Item::Const(c) => {
1762 // Re-export any primitive-type constants.
1763 if let syn::Visibility::Public(_) = c.vis {
1764 if let syn::Type::Path(p) = &*c.ty {
1765 let resolved_path = type_resolver.resolve_path(&p.path, None);
1766 if type_resolver.is_primitive(&resolved_path) {
1767 writeln_field_docs(&mut out, &c.attrs, "", &mut type_resolver, None, &*c.ty);
1768 writeln!(out, "\n#[no_mangle]").unwrap();
1769 writeln!(out, "pub static {}: {} = {}::{};", c.ident, resolved_path, module, c.ident).unwrap();
1774 syn::Item::Type(t) => {
1775 if let syn::Visibility::Public(_) = t.vis {
1776 match export_status(&t.attrs) {
1777 ExportStatus::Export => {},
1778 ExportStatus::NoExport|ExportStatus::TestOnly => continue,
1779 ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
1782 let mut process_alias = true;
1783 for tok in t.generics.params.iter() {
1784 if let syn::GenericParam::Lifetime(_) = tok {}
1785 else { process_alias = false; }
1789 syn::Type::Path(_) =>
1790 writeln_opaque(&mut out, &t.ident, &format!("{}", t.ident), &t.generics, &t.attrs, &type_resolver, header_file, cpp_header_file),
1796 syn::Item::Fn(f) => {
1797 if let syn::Visibility::Public(_) = f.vis {
1798 writeln_fn(&mut out, &f, &mut type_resolver);
1801 syn::Item::Macro(_) => {},
1802 syn::Item::Verbatim(_) => {},
1803 syn::Item::ExternCrate(_) => {},
1804 _ => unimplemented!(),
1808 out.flush().unwrap();
1812 fn walk_private_mod<'a>(ast_storage: &'a FullLibraryAST, orig_crate: &str, module: String, items: &'a syn::ItemMod, crate_types: &mut CrateTypes<'a>) {
1813 let import_resolver = ImportResolver::new(orig_crate, &ast_storage.dependencies, &module, &items.content.as_ref().unwrap().1);
1814 for item in items.content.as_ref().unwrap().1.iter() {
1816 syn::Item::Mod(m) => walk_private_mod(ast_storage, orig_crate, format!("{}::{}", module, m.ident), m, crate_types),
1817 syn::Item::Impl(i) => {
1818 if let &syn::Type::Path(ref p) = &*i.self_ty {
1819 if let Some(trait_path) = i.trait_.as_ref() {
1820 if let Some(tp) = import_resolver.maybe_resolve_path(&trait_path.1, None) {
1821 if let Some(sp) = import_resolver.maybe_resolve_path(&p.path, None) {
1822 match crate_types.trait_impls.entry(sp) {
1823 hash_map::Entry::Occupied(mut e) => { e.get_mut().push(tp); },
1824 hash_map::Entry::Vacant(e) => { e.insert(vec![tp]); },
1836 /// Walk the FullLibraryAST, deciding how things will be mapped and adding tracking to CrateTypes.
1837 fn walk_ast<'a>(ast_storage: &'a FullLibraryAST, crate_types: &mut CrateTypes<'a>) {
1838 for (module, astmod) in ast_storage.modules.iter() {
1839 let ASTModule { ref attrs, ref items, submods: _ } = astmod;
1840 assert_eq!(export_status(&attrs), ExportStatus::Export);
1841 let orig_crate = module.splitn(2, "::").next().unwrap();
1842 let import_resolver = ImportResolver::new(orig_crate, &ast_storage.dependencies, module, items);
1844 for item in items.iter() {
1846 syn::Item::Struct(s) => {
1847 if let syn::Visibility::Public(_) = s.vis {
1848 match export_status(&s.attrs) {
1849 ExportStatus::Export => {},
1850 ExportStatus::NoExport|ExportStatus::TestOnly => continue,
1851 ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
1853 let struct_path = format!("{}::{}", module, s.ident);
1854 crate_types.opaques.insert(struct_path, (&s.ident, &s.generics));
1857 syn::Item::Trait(t) => {
1858 if let syn::Visibility::Public(_) = t.vis {
1859 match export_status(&t.attrs) {
1860 ExportStatus::Export|ExportStatus::NotImplementable => {},
1861 ExportStatus::NoExport|ExportStatus::TestOnly => continue,
1863 let trait_path = format!("{}::{}", module, t.ident);
1864 walk_supertraits!(t, None, (
1866 crate_types.set_clonable("crate::".to_owned() + &trait_path);
1870 crate_types.traits.insert(trait_path, &t);
1873 syn::Item::Type(t) => {
1874 if let syn::Visibility::Public(_) = t.vis {
1875 match export_status(&t.attrs) {
1876 ExportStatus::Export => {},
1877 ExportStatus::NoExport|ExportStatus::TestOnly => continue,
1878 ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
1880 let type_path = format!("{}::{}", module, t.ident);
1881 let mut process_alias = true;
1882 for tok in t.generics.params.iter() {
1883 if let syn::GenericParam::Lifetime(_) = tok {}
1884 else { process_alias = false; }
1888 syn::Type::Path(p) => {
1889 let t_ident = &t.ident;
1891 // If its a path with no generics, assume we don't map the aliased type and map it opaque
1892 let path_obj = parse_quote!(#t_ident);
1893 let args_obj = p.path.segments.last().unwrap().arguments.clone();
1894 match crate_types.reverse_alias_map.entry(import_resolver.maybe_resolve_path(&p.path, None).unwrap()) {
1895 hash_map::Entry::Occupied(mut e) => { e.get_mut().push((path_obj, args_obj)); },
1896 hash_map::Entry::Vacant(e) => { e.insert(vec![(path_obj, args_obj)]); },
1899 crate_types.opaques.insert(type_path, (t_ident, &t.generics));
1902 crate_types.type_aliases.insert(type_path, import_resolver.resolve_imported_refs((*t.ty).clone()));
1908 syn::Item::Enum(e) if is_enum_opaque(e) => {
1909 if let syn::Visibility::Public(_) = e.vis {
1910 match export_status(&e.attrs) {
1911 ExportStatus::Export => {},
1912 ExportStatus::NoExport|ExportStatus::TestOnly => continue,
1913 ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
1915 let enum_path = format!("{}::{}", module, e.ident);
1916 crate_types.opaques.insert(enum_path, (&e.ident, &e.generics));
1919 syn::Item::Enum(e) => {
1920 if let syn::Visibility::Public(_) = e.vis {
1921 match export_status(&e.attrs) {
1922 ExportStatus::Export => {},
1923 ExportStatus::NoExport|ExportStatus::TestOnly => continue,
1924 ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
1926 let enum_path = format!("{}::{}", module, e.ident);
1927 crate_types.mirrored_enums.insert(enum_path, &e);
1930 syn::Item::Impl(i) => {
1931 if let &syn::Type::Path(ref p) = &*i.self_ty {
1932 if let Some(trait_path) = i.trait_.as_ref() {
1933 if path_matches_nongeneric(&trait_path.1, &["core", "clone", "Clone"]) ||
1934 path_matches_nongeneric(&trait_path.1, &["Clone"]) {
1935 if let Some(full_path) = import_resolver.maybe_resolve_path(&p.path, None) {
1936 crate_types.set_clonable("crate::".to_owned() + &full_path);
1939 if let Some(tp) = import_resolver.maybe_resolve_path(&trait_path.1, None) {
1940 if let Some(sp) = import_resolver.maybe_resolve_path(&p.path, None) {
1941 match crate_types.trait_impls.entry(sp) {
1942 hash_map::Entry::Occupied(mut e) => { e.get_mut().push(tp); },
1943 hash_map::Entry::Vacant(e) => { e.insert(vec![tp]); },
1950 syn::Item::Mod(m) => walk_private_mod(ast_storage, orig_crate, format!("{}::{}", module, m.ident), m, crate_types),
1958 let args: Vec<String> = env::args().collect();
1959 if args.len() != 5 {
1960 eprintln!("Usage: target/dir derived_templates.rs extra/includes.h extra/cpp/includes.hpp");
1964 let mut derived_templates = std::fs::OpenOptions::new().write(true).create(true).truncate(true)
1965 .open(&args[2]).expect("Unable to open new header file");
1966 let mut header_file = std::fs::OpenOptions::new().write(true).create(true).truncate(true)
1967 .open(&args[3]).expect("Unable to open new header file");
1968 let mut cpp_header_file = std::fs::OpenOptions::new().write(true).create(true).truncate(true)
1969 .open(&args[4]).expect("Unable to open new header file");
1971 writeln!(header_file, "#if defined(__GNUC__)").unwrap();
1972 writeln!(header_file, "#define MUST_USE_STRUCT __attribute__((warn_unused))").unwrap();
1973 writeln!(header_file, "#define MUST_USE_RES __attribute__((warn_unused_result))").unwrap();
1974 writeln!(header_file, "#else").unwrap();
1975 writeln!(header_file, "#define MUST_USE_STRUCT").unwrap();
1976 writeln!(header_file, "#define MUST_USE_RES").unwrap();
1977 writeln!(header_file, "#endif").unwrap();
1978 writeln!(header_file, "#if defined(__clang__)").unwrap();
1979 writeln!(header_file, "#define NONNULL_PTR _Nonnull").unwrap();
1980 writeln!(header_file, "#else").unwrap();
1981 writeln!(header_file, "#define NONNULL_PTR").unwrap();
1982 writeln!(header_file, "#endif").unwrap();
1983 writeln!(cpp_header_file, "#include <string.h>\nnamespace LDK {{").unwrap();
1985 // Write a few manually-defined types into the C++ header file
1986 write_cpp_wrapper(&mut cpp_header_file, "Str", true, None);
1988 // First parse the full crate's ASTs, caching them so that we can hold references to the AST
1989 // objects in other datastructures:
1990 let mut lib_src = String::new();
1991 std::io::stdin().lock().read_to_string(&mut lib_src).unwrap();
1992 let lib_syntax = syn::parse_file(&lib_src).expect("Unable to parse file");
1993 let libast = FullLibraryAST::load_lib(lib_syntax);
1995 // ...then walk the ASTs tracking what types we will map, and how, so that we can resolve them
1996 // when parsing other file ASTs...
1997 let mut libtypes = CrateTypes::new(&mut derived_templates, &libast);
1998 walk_ast(&libast, &mut libtypes);
2000 // ... finally, do the actual file conversion/mapping, writing out types as we go.
2001 convert_file(&libast, &libtypes, &args[1], &mut header_file, &mut cpp_header_file);
2003 // For container templates which we created while walking the crate, make sure we add C++
2004 // mapped types so that C++ users can utilize the auto-destructors available.
2005 for (ty, has_destructor) in libtypes.templates_defined.borrow().iter() {
2006 write_cpp_wrapper(&mut cpp_header_file, ty, *has_destructor, None);
2008 writeln!(cpp_header_file, "}}").unwrap();
2010 header_file.flush().unwrap();
2011 cpp_header_file.flush().unwrap();
2012 derived_templates.flush().unwrap();