_ Git - ldk-c-bindings/blob - c-bindings-gen/src/main.rs

   1 // This file is Copyright its original authors, visible in version control
   2 // history.
   3 //
   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
   7 // licenses.
   8
   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.
  17 //!
  18 //! It also generates relevant memory-management functions and free-standing functions with
  19 //! parameters mapped.
  20
  21 use std::collections::{HashMap, hash_map};
  22 use std::env;
  23 use std::fs::File;
  24 use std::io::{Read, Write};
  25 use std::process;
  26
  27 use proc_macro2::Span;
  28 use quote::format_ident;
  29 use syn::parse_quote;
  30
  31 mod types;
  32 mod blocks;
  33 use types::*;
  34 use blocks::*;
  35
  36 const DEFAULT_IMPORTS: &'static str = "\nuse std::str::FromStr;\nuse std::ffi::c_void;\nuse bitcoin::hashes::Hash;\nuse crate::c_types::*;\n";
  37
  38 // *************************************
  39 // *** Manually-expanded conversions ***
  40 // *************************************
  41
  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)) {
  45                 let for_obj;
  46                 let full_obj_path;
  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)));
  53                         } else { return; }
  54                 } else {
  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();
  62                 }
  63
  64                 match &t as &str {
  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();
  69
  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)));
  72
  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();
  78
  79                                 writeln!(w, "}}").unwrap();
  80                                 if has_inner {
  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();
  85                                 }
  86                         },
  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>);
  90
  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();
  94
  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);
 105
 106                                                         assert!(!types.write_from_c_conversion_new_var(&mut arg_conv, &format_ident!("arg"), &args_ty, Some(generics)));
 107
 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!(); }
 114                                 }
 115                                 write!(w, ") -> ").unwrap();
 116                                 types.write_c_type(w, &res_ty, Some(generics), false);
 117                                 writeln!(w, " {{").unwrap();
 118
 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();
 125                                 } else {
 126                                         writeln!(w, "\tlet res = crate::c_types::deserialize_obj(ser);").unwrap();
 127                                 }
 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();
 131                                 }
 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();
 136                         },
 137                         _ => {},
 138                 }
 139         }
 140 }
 141
 142 /// Convert "TraitA : TraitB" to a single function name and return type.
 143 ///
 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) {
 147         match trait_path {
 148                 "lightning::util::ser::Writeable" => ("Serialize the object into a byte array", "write".to_owned(), "crate::c_types::derived::CVec_u8Z"),
 149                 _ => unimplemented!(),
 150         }
 151 }
 152
 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) {
 156         match trait_path {
 157                 "lightning::util::ser::Writeable" => {
 158                         writeln!(w, "\t\twrite: {}_write_void,", for_obj).unwrap();
 159                 },
 160                 _ => unimplemented!(),
 161         }
 162 }
 163
 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) {
 166         match trait_path {
 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();
 173                 },
 174                 _ => panic!(),
 175         }
 176 }
 177
 178 // *******************************
 179 // *** Per-Type Printing Logic ***
 180 // *******************************
 181
 182 macro_rules! walk_supertraits { ($t: expr, $types: expr, ($( $($pat: pat)|* => $e: expr),*) ) => { {
 183         if $t.colon_token.is_some() {
 184                 for st in $t.supertraits.iter() {
 185                         match st {
 186                                 syn::TypeParamBound::Trait(supertrait) => {
 187                                         if supertrait.paren_token.is_some() || supertrait.lifetimes.is_some() {
 188                                                 unimplemented!();
 189                                         }
 190                                         // First try to resolve path to find in-crate traits, but if that doesn't work
 191                                         // assume its a prelude trait (eg Clone, etc) and just use the single ident.
 192                                         let types_opt: Option<&TypeResolver> = $types;
 193                                         if let Some(types) = types_opt {
 194                                                 if let Some(path) = types.maybe_resolve_path(&supertrait.path, None) {
 195                                                         match (&path as &str, &supertrait.path.segments.iter().last().unwrap().ident) {
 196                                                                 $( $($pat)|* => $e, )*
 197                                                         }
 198                                                         continue;
 199                                                 }
 200                                         }
 201                                         if let Some(ident) = supertrait.path.get_ident() {
 202                                                 match (&format!("{}", ident) as &str, &ident) {
 203                                                         $( $($pat)|* => $e, )*
 204                                                 }
 205                                         } else if types_opt.is_some() {
 206                                                 panic!("Supertrait unresolvable and not single-ident");
 207                                         }
 208                                 },
 209                                 syn::TypeParamBound::Lifetime(_) => unimplemented!(),
 210                         }
 211                 }
 212         }
 213 } } }
 214
 215 /// Prints a C-mapped trait object containing a void pointer and a jump table for each function in
 216 /// the original trait.
 217 /// Implements the native Rust trait and relevant parent traits for the new C-mapped trait.
 218 ///
 219 /// Finally, implements Deref<MappedTrait> for MappedTrait which allows its use in types which need
 220 /// a concrete Deref to the Rust trait.
 221 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) {
 222         let trait_name = format!("{}", t.ident);
 223         let implementable;
 224         match export_status(&t.attrs) {
 225                 ExportStatus::Export => { implementable = true; }
 226                 ExportStatus::NotImplementable => { implementable = false; },
 227                 ExportStatus::NoExport|ExportStatus::TestOnly => return,
 228         }
 229         writeln_docs(w, &t.attrs, "");
 230
 231         let mut gen_types = GenericTypes::new(None);
 232         assert!(gen_types.learn_generics(&t.generics, types));
 233         gen_types.learn_associated_types(&t, types);
 234
 235         writeln!(w, "#[repr(C)]\npub struct {} {{", trait_name).unwrap();
 236         writeln!(w, "\t/// An opaque pointer which is passed to your function implementations as an argument.").unwrap();
 237         writeln!(w, "\t/// This has no meaning in the LDK, and can be NULL or any other value.").unwrap();
 238         writeln!(w, "\tpub this_arg: *mut c_void,").unwrap();
 239         // We store every field's (name, Option<clone_fn>, docs) except this_arg, used in Clone generation
 240         // docs is only set if its a function which should be callable on the object itself in C++
 241         let mut generated_fields = Vec::new();
 242         for item in t.items.iter() {
 243                 match item {
 244                         &syn::TraitItem::Method(ref m) => {
 245                                 match export_status(&m.attrs) {
 246                                         ExportStatus::NoExport => {
 247                                                 // NoExport in this context means we'll hit an unimplemented!() at runtime,
 248                                                 // so bail out.
 249                                                 unimplemented!();
 250                                         },
 251                                         ExportStatus::Export => {},
 252                                         ExportStatus::TestOnly => continue,
 253                                         ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
 254                                 }
 255                                 if m.default.is_some() { unimplemented!(); }
 256
 257                                 let mut meth_gen_types = gen_types.push_ctx();
 258                                 assert!(meth_gen_types.learn_generics(&m.sig.generics, types));
 259
 260                                 writeln_fn_docs(w, &m.attrs, "\t", types, Some(&meth_gen_types), m.sig.inputs.iter(), &m.sig.output);
 261
 262                                 if let syn::ReturnType::Type(_, rtype) = &m.sig.output {
 263                                         if let syn::Type::Reference(r) = &**rtype {
 264                                                 // We have to do quite a dance for trait functions which return references
 265                                                 // - they ultimately require us to have a native Rust object stored inside
 266                                                 // our concrete trait to return a reference to. However, users may wish to
 267                                                 // update the value to be returned each time the function is called (or, to
 268                                                 // make C copies of Rust impls equivalent, we have to be able to).
 269                                                 //
 270                                                 // Thus, we store a copy of the C-mapped type (which is just a pointer to
 271                                                 // the Rust type and a flag to indicate whether deallocation needs to
 272                                                 // happen) as well as provide an Option<>al function pointer which is
 273                                                 // called when the trait method is called which allows updating on the fly.
 274                                                 write!(w, "\tpub {}: ", m.sig.ident).unwrap();
 275                                                 generated_fields.push((format!("{}", m.sig.ident), None, None));
 276                                                 types.write_c_type(w, &*r.elem, Some(&meth_gen_types), false);
 277                                                 writeln!(w, ",").unwrap();
 278                                                 writeln!(w, "\t/// Fill in the {} field as a reference to it will be given to Rust after this returns", m.sig.ident).unwrap();
 279                                                 writeln!(w, "\t/// Note that this takes a pointer to this object, not the this_ptr like other methods do").unwrap();
 280                                                 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();
 281                                                 writeln!(w, "\tpub set_{}: Option<extern \"C\" fn(&{})>,", m.sig.ident, trait_name).unwrap();
 282                                                 generated_fields.push((format!("set_{}", m.sig.ident), None, None));
 283                                                 // Note that cbindgen will now generate
 284                                                 // typedef struct Thing {..., set_thing: (const struct Thing*), ...} Thing;
 285                                                 // which does not compile since Thing is not defined before it is used.
 286                                                 writeln!(extra_headers, "struct LDK{};", trait_name).unwrap();
 287                                                 continue;
 288                                         }
 289                                         // Sadly, this currently doesn't do what we want, but it should be easy to get
 290                                         // cbindgen to support it. See https://github.com/eqrion/cbindgen/issues/531
 291                                         writeln!(w, "\t#[must_use]").unwrap();
 292                                 }
 293
 294                                 let mut cpp_docs = Vec::new();
 295                                 writeln_fn_docs(&mut cpp_docs, &m.attrs, "\t * ", types, Some(&meth_gen_types), m.sig.inputs.iter(), &m.sig.output);
 296                                 let docs_string = "\t/**\n".to_owned() + &String::from_utf8(cpp_docs).unwrap().replace("///", "") + "\t */\n";
 297
 298                                 write!(w, "\tpub {}: extern \"C\" fn (", m.sig.ident).unwrap();
 299                                 generated_fields.push((format!("{}", m.sig.ident), None, Some(docs_string)));
 300                                 write_method_params(w, &m.sig, "c_void", types, Some(&meth_gen_types), true, false);
 301                                 writeln!(w, ",").unwrap();
 302                         },
 303                         &syn::TraitItem::Type(_) => {},
 304                         _ => unimplemented!(),
 305                 }
 306         }
 307         // Add functions which may be required for supertrait implementations.
 308         walk_supertraits!(t, Some(&types), (
 309                 ("Clone", _) => {
 310                         writeln!(w, "\t/// Called, if set, after this {} has been cloned into a duplicate object.", trait_name).unwrap();
 311                         writeln!(w, "\t/// The new {} is provided, and should be mutated as needed to perform a", trait_name).unwrap();
 312                         writeln!(w, "\t/// deep copy of the object pointed to by this_arg or avoid any double-freeing.").unwrap();
 313                         writeln!(w, "\tpub cloned: Option<extern \"C\" fn (new_{}: &mut {})>,", trait_name, trait_name).unwrap();
 314                         generated_fields.push(("cloned".to_owned(), None, None));
 315                 },
 316                 ("std::cmp::Eq", _)|("core::cmp::Eq", _) => {
 317                         let eq_docs = "Checks if two objects are equal given this object's this_arg pointer and another object.";
 318                         writeln!(w, "\t/// {}", eq_docs).unwrap();
 319                         writeln!(w, "\tpub eq: extern \"C\" fn (this_arg: *const c_void, other_arg: &{}) -> bool,", trait_name).unwrap();
 320                         generated_fields.push(("eq".to_owned(), None, Some(format!("\t/** {} */\n", eq_docs))));
 321                 },
 322                 ("std::hash::Hash", _)|("core::hash::Hash", _) => {
 323                         let hash_docs_a = "Calculate a succinct non-cryptographic hash for an object given its this_arg pointer.";
 324                         let hash_docs_b = "This is used, for example, for inclusion of this object in a hash map.";
 325                         writeln!(w, "\t/// {}", hash_docs_a).unwrap();
 326                         writeln!(w, "\t/// {}", hash_docs_b).unwrap();
 327                         writeln!(w, "\tpub hash: extern \"C\" fn (this_arg: *const c_void) -> u64,").unwrap();
 328                         generated_fields.push(("hash".to_owned(), None,
 329                                 Some(format!("\t/**\n\t * {}\n\t * {}\n\t */\n", hash_docs_a, hash_docs_b))));
 330                 },
 331                 ("Send", _) => {}, ("Sync", _) => {},
 332                 (s, i) => {
 333                         // TODO: Both of the below should expose supertrait methods in C++, but doing so is
 334                         // nontrivial.
 335                         generated_fields.push(if types.crate_types.traits.get(s).is_none() {
 336                                 let (docs, name, ret) = convert_trait_impl_field(s);
 337                                 writeln!(w, "\t/// {}", docs).unwrap();
 338                                 writeln!(w, "\tpub {}: extern \"C\" fn (this_arg: *const c_void) -> {},", name, ret).unwrap();
 339                                 (name, None, None) // Assume clonable
 340                         } else {
 341                                 // For in-crate supertraits, just store a C-mapped copy of the supertrait as a member.
 342                                 writeln!(w, "\t/// Implementation of {} for this object.", i).unwrap();
 343                                 let is_clonable = types.is_clonable(s);
 344                                 writeln!(w, "\tpub {}: crate::{},", i, s).unwrap();
 345                                 (format!("{}", i), if !is_clonable {
 346                                         Some(format!("crate::{}_clone_fields", s))
 347                                 } else { None }, None)
 348                         });
 349                 }
 350         ) );
 351         writeln!(w, "\t/// Frees any resources associated with this object given its this_arg pointer.").unwrap();
 352         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();
 353         writeln!(w, "\tpub free: Option<extern \"C\" fn(this_arg: *mut c_void)>,").unwrap();
 354         generated_fields.push(("free".to_owned(), None, None));
 355         writeln!(w, "}}").unwrap();
 356
 357         macro_rules! impl_trait_for_c {
 358                 ($t: expr, $impl_accessor: expr, $type_resolver: expr) => {
 359                         for item in $t.items.iter() {
 360                                 match item {
 361                                         syn::TraitItem::Method(m) => {
 362                                                 if let ExportStatus::TestOnly = export_status(&m.attrs) { continue; }
 363                                                 if m.default.is_some() { unimplemented!(); }
 364                                                 if m.sig.constness.is_some() || m.sig.asyncness.is_some() || m.sig.unsafety.is_some() ||
 365                                                                 m.sig.abi.is_some() || m.sig.variadic.is_some() {
 366                                                         unimplemented!();
 367                                                 }
 368                                                 let mut meth_gen_types = gen_types.push_ctx();
 369                                                 assert!(meth_gen_types.learn_generics(&m.sig.generics, $type_resolver));
 370                                                 write!(w, "\tfn {}", m.sig.ident).unwrap();
 371                                                 $type_resolver.write_rust_generic_param(w, Some(&meth_gen_types), m.sig.generics.params.iter());
 372                                                 write!(w, "(").unwrap();
 373                                                 for inp in m.sig.inputs.iter() {
 374                                                         match inp {
 375                                                                 syn::FnArg::Receiver(recv) => {
 376                                                                         if !recv.attrs.is_empty() || recv.reference.is_none() { unimplemented!(); }
 377                                                                         write!(w, "&").unwrap();
 378                                                                         if let Some(lft) = &recv.reference.as_ref().unwrap().1 {
 379                                                                                 write!(w, "'{} ", lft.ident).unwrap();
 380                                                                         }
 381                                                                         if recv.mutability.is_some() {
 382                                                                                 write!(w, "mut self").unwrap();
 383                                                                         } else {
 384                                                                                 write!(w, "self").unwrap();
 385                                                                         }
 386                                                                 },
 387                                                                 syn::FnArg::Typed(arg) => {
 388                                                                         if !arg.attrs.is_empty() { unimplemented!(); }
 389                                                                         match &*arg.pat {
 390                                                                                 syn::Pat::Ident(ident) => {
 391                                                                                         if !ident.attrs.is_empty() || ident.by_ref.is_some() ||
 392                                                                                                         ident.mutability.is_some() || ident.subpat.is_some() {
 393                                                                                                 unimplemented!();
 394                                                                                         }
 395                                                                                         write!(w, ", mut {}{}: ", if $type_resolver.skip_arg(&*arg.ty, Some(&meth_gen_types)) { "_" } else { "" }, ident.ident).unwrap();
 396                                                                                 }
 397                                                                                 _ => unimplemented!(),
 398                                                                         }
 399                                                                         $type_resolver.write_rust_type(w, Some(&meth_gen_types), &*arg.ty);
 400                                                                 }
 401                                                         }
 402                                                 }
 403                                                 write!(w, ")").unwrap();
 404                                                 match &m.sig.output {
 405                                                         syn::ReturnType::Type(_, rtype) => {
 406                                                                 write!(w, " -> ").unwrap();
 407                                                                 $type_resolver.write_rust_type(w, Some(&meth_gen_types), &*rtype)
 408                                                         },
 409                                                         _ => {},
 410                                                 }
 411                                                 write!(w, " {{\n\t\t").unwrap();
 412                                                 match export_status(&m.attrs) {
 413                                                         ExportStatus::NoExport => {
 414                                                                 unimplemented!();
 415                                                         },
 416                                                         _ => {},
 417                                                 }
 418                                                 if let syn::ReturnType::Type(_, rtype) = &m.sig.output {
 419                                                         if let syn::Type::Reference(r) = &**rtype {
 420                                                                 assert_eq!(m.sig.inputs.len(), 1); // Must only take self!
 421                                                                 writeln!(w, "if let Some(f) = self{}.set_{} {{", $impl_accessor, m.sig.ident).unwrap();
 422                                                                 writeln!(w, "\t\t\t(f)(&self{});", $impl_accessor).unwrap();
 423                                                                 write!(w, "\t\t}}\n\t\t").unwrap();
 424                                                                 $type_resolver.write_from_c_conversion_to_ref_prefix(w, &*r.elem, Some(&meth_gen_types));
 425                                                                 write!(w, "self{}.{}", $impl_accessor, m.sig.ident).unwrap();
 426                                                                 $type_resolver.write_from_c_conversion_to_ref_suffix(w, &*r.elem, Some(&meth_gen_types));
 427                                                                 writeln!(w, "\n\t}}").unwrap();
 428                                                                 continue;
 429                                                         }
 430                                                 }
 431                                                 write_method_var_decl_body(w, &m.sig, "\t", $type_resolver, Some(&meth_gen_types), true);
 432                                                 write!(w, "(self{}.{})(", $impl_accessor, m.sig.ident).unwrap();
 433                                                 let mut args = Vec::new();
 434                                                 write_method_call_params(&mut args, &m.sig, "\t", $type_resolver, Some(&meth_gen_types), "", true);
 435                                                 w.write_all(String::from_utf8(args).unwrap().replace("self", &format!("self{}", $impl_accessor)).as_bytes()).unwrap();
 436
 437                                                 writeln!(w, "\n\t}}").unwrap();
 438                                         },
 439                                         &syn::TraitItem::Type(ref t) => {
 440                                                 if t.default.is_some() || t.generics.lt_token.is_some() { unimplemented!(); }
 441                                                 let mut bounds_iter = t.bounds.iter();
 442                                                 match bounds_iter.next().unwrap() {
 443                                                         syn::TypeParamBound::Trait(tr) => {
 444                                                                 writeln!(w, "\ttype {} = crate::{};", t.ident, $type_resolver.resolve_path(&tr.path, Some(&gen_types))).unwrap();
 445                                                         },
 446                                                         _ => unimplemented!(),
 447                                                 }
 448                                                 if bounds_iter.next().is_some() { unimplemented!(); }
 449                                         },
 450                                         _ => unimplemented!(),
 451                                 }
 452                         }
 453                 }
 454         }
 455
 456         writeln!(w, "unsafe impl Send for {} {{}}", trait_name).unwrap();
 457         writeln!(w, "unsafe impl Sync for {} {{}}", trait_name).unwrap();
 458
 459         writeln!(w, "#[no_mangle]").unwrap();
 460         writeln!(w, "pub(crate) extern \"C\" fn {}_clone_fields(orig: &{}) -> {} {{", trait_name, trait_name, trait_name).unwrap();
 461         writeln!(w, "\t{} {{", trait_name).unwrap();
 462         writeln!(w, "\t\tthis_arg: orig.this_arg,").unwrap();
 463         for (field, clone_fn, _) in generated_fields.iter() {
 464                 if let Some(f) = clone_fn {
 465                         // If the field isn't clonable, blindly assume its a trait and hope for the best.
 466                         writeln!(w, "\t\t{}: {}(&orig.{}),", field, f, field).unwrap();
 467                 } else {
 468                         writeln!(w, "\t\t{}: Clone::clone(&orig.{}),", field, field).unwrap();
 469                 }
 470         }
 471         writeln!(w, "\t}}\n}}").unwrap();
 472
 473         // Implement supertraits for the C-mapped struct.
 474         walk_supertraits!(t, Some(&types), (
 475                 ("std::cmp::Eq", _)|("core::cmp::Eq", _) => {
 476                         writeln!(w, "impl std::cmp::Eq for {} {{}}", trait_name).unwrap();
 477                         writeln!(w, "impl std::cmp::PartialEq for {} {{", trait_name).unwrap();
 478                         writeln!(w, "\tfn eq(&self, o: &Self) -> bool {{ (self.eq)(self.this_arg, o) }}\n}}").unwrap();
 479                 },
 480                 ("std::hash::Hash", _)|("core::hash::Hash", _) => {
 481                         writeln!(w, "impl std::hash::Hash for {} {{", trait_name).unwrap();
 482                         writeln!(w, "\tfn hash<H: std::hash::Hasher>(&self, hasher: &mut H) {{ hasher.write_u64((self.hash)(self.this_arg)) }}\n}}").unwrap();
 483                 },
 484                 ("Send", _) => {}, ("Sync", _) => {},
 485                 ("Clone", _) => {
 486                         writeln!(w, "#[no_mangle]").unwrap();
 487                         writeln!(w, "/// Creates a copy of a {}", trait_name).unwrap();
 488                         writeln!(w, "pub extern \"C\" fn {}_clone(orig: &{}) -> {} {{", trait_name, trait_name, trait_name).unwrap();
 489                         writeln!(w, "\tlet mut res = {}_clone_fields(orig);", trait_name).unwrap();
 490                         writeln!(w, "\tif let Some(f) = orig.cloned {{ (f)(&mut res) }};").unwrap();
 491                         writeln!(w, "\tres\n}}").unwrap();
 492                         writeln!(w, "impl Clone for {} {{", trait_name).unwrap();
 493                         writeln!(w, "\tfn clone(&self) -> Self {{").unwrap();
 494                         writeln!(w, "\t\t{}_clone(self)", trait_name).unwrap();
 495                         writeln!(w, "\t}}\n}}").unwrap();
 496                 },
 497                 (s, i) => {
 498                         if let Some(supertrait) = types.crate_types.traits.get(s) {
 499                                 let mut module_iter = s.rsplitn(2, "::");
 500                                 module_iter.next().unwrap();
 501                                 let supertrait_module = module_iter.next().unwrap();
 502                                 let imports = ImportResolver::new(supertrait_module.splitn(2, "::").next().unwrap(), &types.crate_types.lib_ast.dependencies,
 503                                         supertrait_module, &types.crate_types.lib_ast.modules.get(supertrait_module).unwrap().items);
 504                                 let resolver = TypeResolver::new(&supertrait_module, imports, types.crate_types);
 505                                 writeln!(w, "impl {} for {} {{", s, trait_name).unwrap();
 506                                 impl_trait_for_c!(supertrait, format!(".{}", i), &resolver);
 507                                 writeln!(w, "}}").unwrap();
 508                         } else {
 509                                 do_write_impl_trait(w, s, i, &trait_name);
 510                         }
 511                 }
 512         ) );
 513
 514         // Finally, implement the original Rust trait for the newly created mapped trait.
 515         writeln!(w, "\nuse {}::{} as rust{};", types.module_path, t.ident, trait_name).unwrap();
 516         if implementable {
 517                 write!(w, "impl rust{}", t.ident).unwrap();
 518                 maybe_write_generics(w, &t.generics, types, false);
 519                 writeln!(w, " for {} {{", trait_name).unwrap();
 520                 impl_trait_for_c!(t, "", types);
 521                 writeln!(w, "}}\n").unwrap();
 522                 writeln!(w, "// We're essentially a pointer already, or at least a set of pointers, so allow us to be used").unwrap();
 523                 writeln!(w, "// directly as a Deref trait in higher-level structs:").unwrap();
 524                 writeln!(w, "impl std::ops::Deref for {} {{\n\ttype Target = Self;", trait_name).unwrap();
 525                 writeln!(w, "\tfn deref(&self) -> &Self {{\n\t\tself\n\t}}\n}}").unwrap();
 526         }
 527
 528         writeln!(w, "/// Calls the free function if one is set").unwrap();
 529         writeln!(w, "#[no_mangle]\npub extern \"C\" fn {}_free(this_ptr: {}) {{ }}", trait_name, trait_name).unwrap();
 530         writeln!(w, "impl Drop for {} {{", trait_name).unwrap();
 531         writeln!(w, "\tfn drop(&mut self) {{").unwrap();
 532         writeln!(w, "\t\tif let Some(f) = self.free {{").unwrap();
 533         writeln!(w, "\t\t\tf(self.this_arg);").unwrap();
 534         writeln!(w, "\t\t}}\n\t}}\n}}").unwrap();
 535
 536         write_cpp_wrapper(cpp_headers, &trait_name, true, Some(generated_fields.drain(..)
 537                 .filter_map(|(name, _, docs)| if let Some(docs) = docs { Some((name, docs)) } else { None }).collect()));
 538 }
 539
 540 /// Write out a simple "opaque" type (eg structs) which contain a pointer to the native Rust type
 541 /// and a flag to indicate whether Drop'ing the mapped struct drops the underlying Rust type.
 542 ///
 543 /// Also writes out a _free function and a C++ wrapper which handles calling _free.
 544 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) {
 545         // If we directly read the original type by its original name, cbindgen hits
 546         // https://github.com/eqrion/cbindgen/issues/286 Thus, instead, we import it as a temporary
 547         // name and then reference it by that name, which works around the issue.
 548         write!(w, "\nuse {}::{} as native{}Import;\ntype native{} = native{}Import", types.module_path, ident, ident, ident, ident).unwrap();
 549         maybe_write_generics(w, &generics, &types, true);
 550         writeln!(w, ";\n").unwrap();
 551         writeln!(extra_headers, "struct native{}Opaque;\ntypedef struct native{}Opaque LDKnative{};", ident, ident, ident).unwrap();
 552         writeln_docs(w, &attrs, "");
 553         writeln!(w, "#[must_use]\n#[repr(C)]\npub struct {} {{", struct_name).unwrap();
 554         writeln!(w, "\t/// A pointer to the opaque Rust object.\n").unwrap();
 555         writeln!(w, "\t/// Nearly everywhere, inner must be non-null, however in places where").unwrap();
 556         writeln!(w, "\t/// the Rust equivalent takes an Option, it may be set to null to indicate None.").unwrap();
 557         writeln!(w, "\tpub inner: *mut native{},", ident).unwrap();
 558         writeln!(w, "\t/// Indicates that this is the only struct which contains the same pointer.\n").unwrap();
 559         writeln!(w, "\t/// Rust functions which take ownership of an object provided via an argument require").unwrap();
 560         writeln!(w, "\t/// this to be true and invalidate the object pointed to by inner.").unwrap();
 561         writeln!(w, "\tpub is_owned: bool,").unwrap();
 562         writeln!(w, "}}\n").unwrap();
 563         writeln!(w, "impl Drop for {} {{\n\tfn drop(&mut self) {{", struct_name).unwrap();
 564         writeln!(w, "\t\tif self.is_owned && !<*mut native{}>::is_null(self.inner) {{", ident).unwrap();
 565         writeln!(w, "\t\t\tlet _ = unsafe {{ Box::from_raw(ObjOps::untweak_ptr(self.inner)) }};\n\t\t}}\n\t}}\n}}").unwrap();
 566         writeln!(w, "/// Frees any resources used by the {}, if is_owned is set and inner is non-NULL.", struct_name).unwrap();
 567         writeln!(w, "#[no_mangle]\npub extern \"C\" fn {}_free(this_obj: {}) {{ }}", struct_name, struct_name).unwrap();
 568         writeln!(w, "#[allow(unused)]").unwrap();
 569         writeln!(w, "/// Used only if an object of this type is returned as a trait impl by a method").unwrap();
 570         writeln!(w, "extern \"C\" fn {}_free_void(this_ptr: *mut c_void) {{", struct_name).unwrap();
 571         writeln!(w, "\tunsafe {{ let _ = Box::from_raw(this_ptr as *mut native{}); }}\n}}", struct_name).unwrap();
 572         writeln!(w, "#[allow(unused)]").unwrap();
 573         writeln!(w, "impl {} {{", struct_name).unwrap();
 574         writeln!(w, "\tpub(crate) fn get_native_ref(&self) -> &'static native{} {{", struct_name).unwrap();
 575         writeln!(w, "\t\tunsafe {{ &*ObjOps::untweak_ptr(self.inner) }}").unwrap();
 576         writeln!(w, "\t}}").unwrap();
 577         writeln!(w, "\tpub(crate) fn get_native_mut_ref(&self) -> &'static mut native{} {{", struct_name).unwrap();
 578         writeln!(w, "\t\tunsafe {{ &mut *ObjOps::untweak_ptr(self.inner) }}").unwrap();
 579         writeln!(w, "\t}}").unwrap();
 580         writeln!(w, "\t/// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy").unwrap();
 581         writeln!(w, "\tpub(crate) fn take_inner(mut self) -> *mut native{} {{", struct_name).unwrap();
 582         writeln!(w, "\t\tassert!(self.is_owned);").unwrap();
 583         writeln!(w, "\t\tlet ret = ObjOps::untweak_ptr(self.inner);").unwrap();
 584         writeln!(w, "\t\tself.inner = std::ptr::null_mut();").unwrap();
 585         writeln!(w, "\t\tret").unwrap();
 586         writeln!(w, "\t}}\n}}").unwrap();
 587
 588         write_cpp_wrapper(cpp_headers, &format!("{}", ident), true, None);
 589 }
 590
 591 /// Writes out all the relevant mappings for a Rust struct, deferring to writeln_opaque to generate
 592 /// the struct itself, and then writing getters and setters for public, understood-type fields and
 593 /// a constructor if every field is public.
 594 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) {
 595         if export_status(&s.attrs) != ExportStatus::Export { return; }
 596
 597         let struct_name = &format!("{}", s.ident);
 598         writeln_opaque(w, &s.ident, struct_name, &s.generics, &s.attrs, types, extra_headers, cpp_headers);
 599
 600         if let syn::Fields::Named(fields) = &s.fields {
 601                 let mut self_path_segs = syn::punctuated::Punctuated::new();
 602                 self_path_segs.push(s.ident.clone().into());
 603                 let self_path = syn::Path { leading_colon: None, segments: self_path_segs};
 604                 let mut gen_types = GenericTypes::new(Some((types.resolve_path(&self_path, None), &self_path)));
 605                 assert!(gen_types.learn_generics(&s.generics, types));
 606
 607                 let mut all_fields_settable = true;
 608                 for field in fields.named.iter() {
 609                         if let syn::Visibility::Public(_) = field.vis {
 610                                 let export = export_status(&field.attrs);
 611                                 match export {
 612                                         ExportStatus::Export => {},
 613                                         ExportStatus::NoExport|ExportStatus::TestOnly => {
 614                                                 all_fields_settable = false;
 615                                                 continue
 616                                         },
 617                                         ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
 618                                 }
 619
 620                                 if let Some(ident) = &field.ident {
 621                                         if let Some(ref_type) = types.create_ownable_reference(&field.ty, Some(&gen_types)) {
 622                                                 if types.understood_c_type(&ref_type, Some(&gen_types)) {
 623                                                         writeln_arg_docs(w, &field.attrs, "", types, Some(&gen_types), vec![].drain(..), Some(&ref_type));
 624                                                         write!(w, "#[no_mangle]\npub extern \"C\" fn {}_get_{}(this_ptr: &{}) -> ", struct_name, ident, struct_name).unwrap();
 625                                                         types.write_c_type(w, &ref_type, Some(&gen_types), true);
 626                                                         write!(w, " {{\n\tlet mut inner_val = &mut this_ptr.get_native_mut_ref().{};\n\t", ident).unwrap();
 627                                                         let local_var = types.write_to_c_conversion_new_var(w, &format_ident!("inner_val"), &ref_type, Some(&gen_types), true);
 628                                                         if local_var { write!(w, "\n\t").unwrap(); }
 629                                                         types.write_to_c_conversion_inline_prefix(w, &ref_type, Some(&gen_types), true);
 630                                                         write!(w, "inner_val").unwrap();
 631                                                         types.write_to_c_conversion_inline_suffix(w, &ref_type, Some(&gen_types), true);
 632                                                         writeln!(w, "\n}}").unwrap();
 633                                                 }
 634                                         }
 635
 636                                         if types.understood_c_type(&field.ty, Some(&gen_types)) {
 637                                                 writeln_arg_docs(w, &field.attrs, "", types, Some(&gen_types), vec![("val".to_owned(), &field.ty)].drain(..), None);
 638                                                 write!(w, "#[no_mangle]\npub extern \"C\" fn {}_set_{}(this_ptr: &mut {}, mut val: ", struct_name, ident, struct_name).unwrap();
 639                                                 types.write_c_type(w, &field.ty, Some(&gen_types), false);
 640                                                 write!(w, ") {{\n\t").unwrap();
 641                                                 let local_var = types.write_from_c_conversion_new_var(w, &format_ident!("val"), &field.ty, Some(&gen_types));
 642                                                 if local_var { write!(w, "\n\t").unwrap(); }
 643                                                 write!(w, "unsafe {{ &mut *ObjOps::untweak_ptr(this_ptr.inner) }}.{} = ", ident).unwrap();
 644                                                 types.write_from_c_conversion_prefix(w, &field.ty, Some(&gen_types));
 645                                                 write!(w, "val").unwrap();
 646                                                 types.write_from_c_conversion_suffix(w, &field.ty, Some(&gen_types));
 647                                                 writeln!(w, ";\n}}").unwrap();
 648                                         } else { all_fields_settable = false; }
 649                                 } else { all_fields_settable = false; }
 650                         } else { all_fields_settable = false; }
 651                 }
 652
 653                 if all_fields_settable {
 654                         // Build a constructor!
 655                         writeln!(w, "/// Constructs a new {} given each field", struct_name).unwrap();
 656                         write!(w, "#[must_use]\n#[no_mangle]\npub extern \"C\" fn {}_new(", struct_name).unwrap();
 657                         for (idx, field) in fields.named.iter().enumerate() {
 658                                 if idx != 0 { write!(w, ", ").unwrap(); }
 659                                 write!(w, "mut {}_arg: ", field.ident.as_ref().unwrap()).unwrap();
 660                                 types.write_c_type(w, &field.ty, Some(&gen_types), false);
 661                         }
 662                         write!(w, ") -> {} {{\n\t", struct_name).unwrap();
 663                         for field in fields.named.iter() {
 664                                 let field_ident = format_ident!("{}_arg", field.ident.as_ref().unwrap());
 665                                 if types.write_from_c_conversion_new_var(w, &field_ident, &field.ty, Some(&gen_types)) {
 666                                         write!(w, "\n\t").unwrap();
 667                                 }
 668                         }
 669                         writeln!(w, "{} {{ inner: ObjOps::heap_alloc(native{} {{", struct_name, s.ident).unwrap();
 670                         for field in fields.named.iter() {
 671                                 write!(w, "\t\t{}: ", field.ident.as_ref().unwrap()).unwrap();
 672                                 types.write_from_c_conversion_prefix(w, &field.ty, Some(&gen_types));
 673                                 write!(w, "{}_arg", field.ident.as_ref().unwrap()).unwrap();
 674                                 types.write_from_c_conversion_suffix(w, &field.ty, Some(&gen_types));
 675                                 writeln!(w, ",").unwrap();
 676                         }
 677                         writeln!(w, "\t}}), is_owned: true }}\n}}").unwrap();
 678                 }
 679         }
 680 }
 681
 682 /// Prints a relevant conversion for impl *
 683 ///
 684 /// For simple impl Struct {}s, this just outputs the wrapper functions as Struct_fn_name() { .. }.
 685 ///
 686 /// For impl Trait for Struct{}s, this non-exported generates wrapper functions as
 687 /// Trait_Struct_fn_name and a Struct_as_Trait(&struct) -> Trait function which returns a populated
 688 /// Trait struct containing a pointer to the passed struct's inner field and the wrapper functions.
 689 ///
 690 /// A few non-crate Traits are hard-coded including Default.
 691 fn writeln_impl<W: std::io::Write>(w: &mut W, i: &syn::ItemImpl, types: &mut TypeResolver) {
 692         match export_status(&i.attrs) {
 693                 ExportStatus::Export => {},
 694                 ExportStatus::NoExport|ExportStatus::TestOnly => return,
 695                 ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
 696         }
 697
 698         if let syn::Type::Tuple(_) = &*i.self_ty {
 699                 if types.understood_c_type(&*i.self_ty, None) {
 700                         let mut gen_types = GenericTypes::new(None);
 701                         if !gen_types.learn_generics(&i.generics, types) {
 702                                 eprintln!("Not implementing anything for `impl (..)` due to not understood generics");
 703                                 return;
 704                         }
 705
 706                         if i.defaultness.is_some() || i.unsafety.is_some() { unimplemented!(); }
 707                         if let Some(trait_path) = i.trait_.as_ref() {
 708                                 if trait_path.0.is_some() { unimplemented!(); }
 709                                 if types.understood_c_path(&trait_path.1) {
 710                                         eprintln!("Not implementing anything for `impl Trait for (..)` - we only support manual defines");
 711                                         return;
 712                                 } else {
 713                                         // Just do a manual implementation:
 714                                         maybe_convert_trait_impl(w, &trait_path.1, &*i.self_ty, types, &gen_types);
 715                                 }
 716                         } else {
 717                                 eprintln!("Not implementing anything for plain `impl (..)` block - we only support `impl Trait for (..)` blocks");
 718                                 return;
 719                         }
 720                 }
 721                 return;
 722         }
 723         if let &syn::Type::Path(ref p) = &*i.self_ty {
 724                 if p.qself.is_some() { unimplemented!(); }
 725                 if let Some(ident) = single_ident_generic_path_to_ident(&p.path) {
 726                         if let Some(resolved_path) = types.maybe_resolve_non_ignored_ident(&ident) {
 727                                 let mut gen_types = GenericTypes::new(Some((resolved_path.clone(), &p.path)));
 728                                 if !gen_types.learn_generics(&i.generics, types) {
 729                                         eprintln!("Not implementing anything for impl {} due to not understood generics", ident);
 730                                         return;
 731                                 }
 732
 733                                 if i.defaultness.is_some() || i.unsafety.is_some() { unimplemented!(); }
 734                                 if let Some(trait_path) = i.trait_.as_ref() {
 735                                         if trait_path.0.is_some() { unimplemented!(); }
 736                                         if types.understood_c_path(&trait_path.1) {
 737                                                 let full_trait_path = types.resolve_path(&trait_path.1, None);
 738                                                 let trait_obj = *types.crate_types.traits.get(&full_trait_path).unwrap();
 739                                                 // We learn the associated types maping from the original trait object.
 740                                                 // That's great, except that they are unresolved idents, so if we learn
 741                                                 // mappings from a trai defined in a different file, we may mis-resolve or
 742                                                 // fail to resolve the mapped types.
 743                                                 gen_types.learn_associated_types(trait_obj, types);
 744                                                 let mut impl_associated_types = HashMap::new();
 745                                                 for item in i.items.iter() {
 746                                                         match item {
 747                                                                 syn::ImplItem::Type(t) => {
 748                                                                         if let syn::Type::Path(p) = &t.ty {
 749                                                                                 if let Some(id) = single_ident_generic_path_to_ident(&p.path) {
 750                                                                                         impl_associated_types.insert(&t.ident, id);
 751                                                                                 }
 752                                                                         }
 753                                                                 },
 754                                                                 _ => {},
 755                                                         }
 756                                                 }
 757
 758                                                 let export = export_status(&trait_obj.attrs);
 759                                                 match export {
 760                                                         ExportStatus::Export|ExportStatus::NotImplementable => {},
 761                                                         ExportStatus::NoExport|ExportStatus::TestOnly => return,
 762                                                 }
 763
 764                                                 // For cases where we have a concrete native object which implements a
 765                                                 // trait and need to return the C-mapped version of the trait, provide a
 766                                                 // From<> implementation which does all the work to ensure free is handled
 767                                                 // properly. This way we can call this method from deep in the
 768                                                 // type-conversion logic without actually knowing the concrete native type.
 769                                                 writeln!(w, "impl From<native{}> for crate::{} {{", ident, full_trait_path).unwrap();
 770                                                 writeln!(w, "\tfn from(obj: native{}) -> Self {{", ident).unwrap();
 771                                                 writeln!(w, "\t\tlet mut rust_obj = {} {{ inner: ObjOps::heap_alloc(obj), is_owned: true }};", ident).unwrap();
 772                                                 writeln!(w, "\t\tlet mut ret = {}_as_{}(&rust_obj);", ident, trait_obj.ident).unwrap();
 773                                                 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();
 774                                                 writeln!(w, "\t\trust_obj.inner = std::ptr::null_mut();").unwrap();
 775                                                 writeln!(w, "\t\tret.free = Some({}_free_void);", ident).unwrap();
 776                                                 writeln!(w, "\t\tret\n\t}}\n}}").unwrap();
 777
 778                                                 writeln!(w, "/// Constructs a new {} which calls the relevant methods on this_arg.", trait_obj.ident).unwrap();
 779                                                 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();
 780                                                 write!(w, "#[no_mangle]\npub extern \"C\" fn {}_as_{}(this_arg: &{}) -> crate::{} {{\n", ident, trait_obj.ident, ident, full_trait_path).unwrap();
 781                                                 writeln!(w, "\tcrate::{} {{", full_trait_path).unwrap();
 782                                                 writeln!(w, "\t\tthis_arg: unsafe {{ ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void }},").unwrap();
 783                                                 writeln!(w, "\t\tfree: None,").unwrap();
 784
 785                                                 macro_rules! write_meth {
 786                                                         ($m: expr, $trait: expr, $indent: expr) => {
 787                                                                 let trait_method = $trait.items.iter().filter_map(|item| {
 788                                                                         if let syn::TraitItem::Method(t_m) = item { Some(t_m) } else { None }
 789                                                                 }).find(|trait_meth| trait_meth.sig.ident == $m.sig.ident).unwrap();
 790                                                                 match export_status(&trait_method.attrs) {
 791                                                                         ExportStatus::Export => {},
 792                                                                         ExportStatus::NoExport => {
 793                                                                                 write!(w, "{}\t\t//XXX: Need to export {}\n", $indent, $m.sig.ident).unwrap();
 794                                                                                 continue;
 795                                                                         },
 796                                                                         ExportStatus::TestOnly => continue,
 797                                                                         ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
 798                                                                 }
 799
 800                                                                 let mut printed = false;
 801                                                                 if let syn::ReturnType::Type(_, rtype) = &$m.sig.output {
 802                                                                         if let syn::Type::Reference(r) = &**rtype {
 803                                                                                 write!(w, "\n\t\t{}{}: ", $indent, $m.sig.ident).unwrap();
 804                                                                                 types.write_empty_rust_val(Some(&gen_types), w, &*r.elem);
 805                                                                                 writeln!(w, ",\n{}\t\tset_{}: Some({}_{}_set_{}),", $indent, $m.sig.ident, ident, $trait.ident, $m.sig.ident).unwrap();
 806                                                                                 printed = true;
 807                                                                         }
 808                                                                 }
 809                                                                 if !printed {
 810                                                                         write!(w, "{}\t\t{}: {}_{}_{},\n", $indent, $m.sig.ident, ident, $trait.ident, $m.sig.ident).unwrap();
 811                                                                 }
 812                                                         }
 813                                                 }
 814                                                 for item in trait_obj.items.iter() {
 815                                                         match item {
 816                                                                 syn::TraitItem::Method(m) => {
 817                                                                         write_meth!(m, trait_obj, "");
 818                                                                 },
 819                                                                 _ => {},
 820                                                         }
 821                                                 }
 822                                                 let mut requires_clone = false;
 823                                                 walk_supertraits!(trait_obj, Some(&types), (
 824                                                         ("Clone", _) => {
 825                                                                 requires_clone = true;
 826                                                                 writeln!(w, "\t\tcloned: Some({}_{}_cloned),", trait_obj.ident, ident).unwrap();
 827                                                         },
 828                                                         ("Sync", _) => {}, ("Send", _) => {},
 829                                                         ("std::marker::Sync", _) => {}, ("std::marker::Send", _) => {},
 830                                                         (s, t) => {
 831                                                                 if let Some(supertrait_obj) = types.crate_types.traits.get(s) {
 832                                                                         writeln!(w, "\t\t{}: crate::{} {{", t, s).unwrap();
 833                                                                         writeln!(w, "\t\t\tthis_arg: unsafe {{ ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void }},").unwrap();
 834                                                                         writeln!(w, "\t\t\tfree: None,").unwrap();
 835                                                                         for item in supertrait_obj.items.iter() {
 836                                                                                 match item {
 837                                                                                         syn::TraitItem::Method(m) => {
 838                                                                                                 write_meth!(m, supertrait_obj, "\t");
 839                                                                                         },
 840                                                                                         _ => {},
 841                                                                                 }
 842                                                                         }
 843                                                                         write!(w, "\t\t}},\n").unwrap();
 844                                                                 } else {
 845                                                                         write_trait_impl_field_assign(w, s, ident);
 846                                                                 }
 847                                                         }
 848                                                 ) );
 849                                                 writeln!(w, "\t}}\n}}\n").unwrap();
 850
 851                                                 macro_rules! impl_meth {
 852                                                         ($m: expr, $trait_path: expr, $trait: expr, $indent: expr) => {
 853                                                                 let trait_method = $trait.items.iter().filter_map(|item| {
 854                                                                         if let syn::TraitItem::Method(t_m) = item { Some(t_m) } else { None }
 855                                                                 }).find(|trait_meth| trait_meth.sig.ident == $m.sig.ident).unwrap();
 856                                                                 match export_status(&trait_method.attrs) {
 857                                                                         ExportStatus::Export => {},
 858                                                                         ExportStatus::NoExport|ExportStatus::TestOnly => continue,
 859                                                                         ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
 860                                                                 }
 861
 862                                                                 if let syn::ReturnType::Type(_, _) = &$m.sig.output {
 863                                                                         writeln!(w, "#[must_use]").unwrap();
 864                                                                 }
 865                                                                 write!(w, "extern \"C\" fn {}_{}_{}(", ident, $trait.ident, $m.sig.ident).unwrap();
 866                                                                 let mut meth_gen_types = gen_types.push_ctx();
 867                                                                 assert!(meth_gen_types.learn_generics(&$m.sig.generics, types));
 868                                                                 write_method_params(w, &$m.sig, "c_void", types, Some(&meth_gen_types), true, true);
 869                                                                 write!(w, " {{\n\t").unwrap();
 870                                                                 write_method_var_decl_body(w, &$m.sig, "", types, Some(&meth_gen_types), false);
 871                                                                 let mut takes_self = false;
 872                                                                 for inp in $m.sig.inputs.iter() {
 873                                                                         if let syn::FnArg::Receiver(_) = inp {
 874                                                                                 takes_self = true;
 875                                                                         }
 876                                                                 }
 877
 878                                                                 let mut t_gen_args = String::new();
 879                                                                 for (idx, _) in $trait.generics.params.iter().enumerate() {
 880                                                                         if idx != 0 { t_gen_args += ", " };
 881                                                                         t_gen_args += "_"
 882                                                                 }
 883                                                                 if takes_self {
 884                                                                         write!(w, "<native{} as {}<{}>>::{}(unsafe {{ &mut *(this_arg as *mut native{}) }}, ", ident, $trait_path, t_gen_args, $m.sig.ident, ident).unwrap();
 885                                                                 } else {
 886                                                                         write!(w, "<native{} as {}<{}>>::{}(", ident, $trait_path, t_gen_args, $m.sig.ident).unwrap();
 887                                                                 }
 888
 889                                                                 let mut real_type = "".to_string();
 890                                                                 match &$m.sig.output {
 891                                                                         syn::ReturnType::Type(_, rtype) => {
 892                                                                                 if let Some(mut remaining_path) = first_seg_self(&*rtype) {
 893                                                                                         if let Some(associated_seg) = get_single_remaining_path_seg(&mut remaining_path) {
 894                                                                                                 real_type = format!("{}", impl_associated_types.get(associated_seg).unwrap());
 895                                                                                         }
 896                                                                                 }
 897                                                                         },
 898                                                                         _ => {},
 899                                                                 }
 900                                                                 write_method_call_params(w, &$m.sig, "", types, Some(&meth_gen_types), &real_type, false);
 901                                                                 write!(w, "\n}}\n").unwrap();
 902                                                                 if let syn::ReturnType::Type(_, rtype) = &$m.sig.output {
 903                                                                         if let syn::Type::Reference(r) = &**rtype {
 904                                                                                 assert_eq!($m.sig.inputs.len(), 1); // Must only take self
 905                                                                                 writeln!(w, "extern \"C\" fn {}_{}_set_{}(trait_self_arg: &{}) {{", ident, $trait.ident, $m.sig.ident, $trait.ident).unwrap();
 906                                                                                 writeln!(w, "\t// This is a bit race-y in the general case, but for our specific use-cases today, we're safe").unwrap();
 907                                                                                 writeln!(w, "\t// Specifically, we must ensure that the first time we're called it can never be in parallel").unwrap();
 908                                                                                 write!(w, "\tif ").unwrap();
 909                                                                                 types.write_empty_rust_val_check(Some(&meth_gen_types), w, &*r.elem, &format!("trait_self_arg.{}", $m.sig.ident));
 910                                                                                 writeln!(w, " {{").unwrap();
 911                                                                                 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();
 912                                                                                 writeln!(w, "\t}}").unwrap();
 913                                                                                 writeln!(w, "}}").unwrap();
 914                                                                         }
 915                                                                 }
 916                                                         }
 917                                                 }
 918
 919                                                 for item in i.items.iter() {
 920                                                         match item {
 921                                                                 syn::ImplItem::Method(m) => {
 922                                                                         impl_meth!(m, full_trait_path, trait_obj, "");
 923                                                                 },
 924                                                                 syn::ImplItem::Type(_) => {},
 925                                                                 _ => unimplemented!(),
 926                                                         }
 927                                                 }
 928                                                 if requires_clone {
 929                                                         writeln!(w, "extern \"C\" fn {}_{}_cloned(new_obj: &mut crate::{}) {{", trait_obj.ident, ident, full_trait_path).unwrap();
 930                                                         writeln!(w, "\tnew_obj.this_arg = {}_clone_void(new_obj.this_arg);", ident).unwrap();
 931                                                         writeln!(w, "\tnew_obj.free = Some({}_free_void);", ident).unwrap();
 932                                                         walk_supertraits!(trait_obj, Some(&types), (
 933                                                                 (s, t) => {
 934                                                                         if types.crate_types.traits.get(s).is_some() {
 935                                                                                 assert!(!types.is_clonable(s)); // We don't currently support cloning with a clonable supertrait
 936                                                                                 writeln!(w, "\tnew_obj.{}.this_arg = new_obj.this_arg;", t).unwrap();
 937                                                                                 writeln!(w, "\tnew_obj.{}.free = None;", t).unwrap();
 938                                                                         }
 939                                                                 }
 940                                                         ) );
 941                                                         writeln!(w, "}}").unwrap();
 942                                                 }
 943                                                 write!(w, "\n").unwrap();
 944                                         } else if path_matches_nongeneric(&trait_path.1, &["From"]) {
 945                                         } else if path_matches_nongeneric(&trait_path.1, &["Default"]) {
 946                                                 writeln!(w, "/// Creates a \"default\" {}. See struct and individual field documentaiton for details on which values are used.", ident).unwrap();
 947                                                 write!(w, "#[must_use]\n#[no_mangle]\npub extern \"C\" fn {}_default() -> {} {{\n", ident, ident).unwrap();
 948                                                 write!(w, "\t{} {{ inner: ObjOps::heap_alloc(Default::default()), is_owned: true }}\n", ident).unwrap();
 949                                                 write!(w, "}}\n").unwrap();
 950                                         } else if path_matches_nongeneric(&trait_path.1, &["core", "cmp", "PartialEq"]) {
 951                                         } else if path_matches_nongeneric(&trait_path.1, &["core", "cmp", "Eq"]) {
 952                                                 writeln!(w, "/// Checks if two {}s contain equal inner contents.", ident).unwrap();
 953                                                 writeln!(w, "/// This ignores pointers and is_owned flags and looks at the values in fields.").unwrap();
 954                                                 if types.c_type_has_inner_from_path(&resolved_path) {
 955                                                         writeln!(w, "/// Two objects with NULL inner values will be considered \"equal\" here.").unwrap();
 956                                                 }
 957                                                 write!(w, "#[no_mangle]\npub extern \"C\" fn {}_eq(a: &{}, b: &{}) -> bool {{\n", ident, ident, ident).unwrap();
 958                                                 if types.c_type_has_inner_from_path(&resolved_path) {
 959                                                         write!(w, "\tif a.inner == b.inner {{ return true; }}\n").unwrap();
 960                                                         write!(w, "\tif a.inner.is_null() || b.inner.is_null() {{ return false; }}\n").unwrap();
 961                                                 }
 962
 963                                                 let path = &p.path;
 964                                                 let ref_type: syn::Type = syn::parse_quote!(&#path);
 965                                                 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");
 966
 967                                                 write!(w, "\tif ").unwrap();
 968                                                 types.write_from_c_conversion_prefix(w, &ref_type, Some(&gen_types));
 969                                                 write!(w, "a").unwrap();
 970                                                 types.write_from_c_conversion_suffix(w, &ref_type, Some(&gen_types));
 971                                                 write!(w, " == ").unwrap();
 972                                                 types.write_from_c_conversion_prefix(w, &ref_type, Some(&gen_types));
 973                                                 write!(w, "b").unwrap();
 974                                                 types.write_from_c_conversion_suffix(w, &ref_type, Some(&gen_types));
 975
 976                                                 writeln!(w, " {{ true }} else {{ false }}\n}}").unwrap();
 977                                         } else if path_matches_nongeneric(&trait_path.1, &["core", "hash", "Hash"]) {
 978                                                 writeln!(w, "/// Checks if two {}s contain equal inner contents.", ident).unwrap();
 979                                                 write!(w, "#[no_mangle]\npub extern \"C\" fn {}_hash(o: &{}) -> u64 {{\n", ident, ident).unwrap();
 980                                                 if types.c_type_has_inner_from_path(&resolved_path) {
 981                                                         write!(w, "\tif o.inner.is_null() {{ return 0; }}\n").unwrap();
 982                                                 }
 983
 984                                                 let path = &p.path;
 985                                                 let ref_type: syn::Type = syn::parse_quote!(&#path);
 986                                                 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");
 987
 988                                                 writeln!(w, "\t// Note that we'd love to use std::collections::hash_map::DefaultHasher but it's not in core").unwrap();
 989                                                 writeln!(w, "\t#[allow(deprecated)]").unwrap();
 990                                                 writeln!(w, "\tlet mut hasher = core::hash::SipHasher::new();").unwrap();
 991                                                 write!(w, "\tstd::hash::Hash::hash(").unwrap();
 992                                                 types.write_from_c_conversion_prefix(w, &ref_type, Some(&gen_types));
 993                                                 write!(w, "o").unwrap();
 994                                                 types.write_from_c_conversion_suffix(w, &ref_type, Some(&gen_types));
 995                                                 writeln!(w, ", &mut hasher);").unwrap();
 996                                                 writeln!(w, "\tstd::hash::Hasher::finish(&hasher)\n}}").unwrap();
 997                                         } else if (path_matches_nongeneric(&trait_path.1, &["core", "clone", "Clone"]) || path_matches_nongeneric(&trait_path.1, &["Clone"])) &&
 998                                                         types.c_type_has_inner_from_path(&resolved_path) {
 999                                                 writeln!(w, "impl Clone for {} {{", ident).unwrap();
1000                                                 writeln!(w, "\tfn clone(&self) -> Self {{").unwrap();
1001                                                 writeln!(w, "\t\tSelf {{").unwrap();
1002                                                 writeln!(w, "\t\t\tinner: if <*mut native{}>::is_null(self.inner) {{ std::ptr::null_mut() }} else {{", ident).unwrap();
1003                                                 writeln!(w, "\t\t\t\tObjOps::heap_alloc(unsafe {{ &*ObjOps::untweak_ptr(self.inner) }}.clone()) }},").unwrap();
1004                                                 writeln!(w, "\t\t\tis_owned: true,").unwrap();
1005                                                 writeln!(w, "\t\t}}\n\t}}\n}}").unwrap();
1006                                                 writeln!(w, "#[allow(unused)]").unwrap();
1007                                                 writeln!(w, "/// Used only if an object of this type is returned as a trait impl by a method").unwrap();
1008                                                 writeln!(w, "pub(crate) extern \"C\" fn {}_clone_void(this_ptr: *const c_void) -> *mut c_void {{", ident).unwrap();
1009                                                 writeln!(w, "\tBox::into_raw(Box::new(unsafe {{ (*(this_ptr as *mut native{})).clone() }})) as *mut c_void", ident).unwrap();
1010                                                 writeln!(w, "}}").unwrap();
1011                                                 writeln!(w, "#[no_mangle]").unwrap();
1012                                                 writeln!(w, "/// Creates a copy of the {}", ident).unwrap();
1013                                                 writeln!(w, "pub extern \"C\" fn {}_clone(orig: &{}) -> {} {{", ident, ident, ident).unwrap();
1014                                                 writeln!(w, "\torig.clone()").unwrap();
1015                                                 writeln!(w, "}}").unwrap();
1016                                         } else if path_matches_nongeneric(&trait_path.1, &["FromStr"]) {
1017                                                 if let Some(container) = types.get_c_mangled_container_type(
1018                                                                 vec![&*i.self_ty, &syn::Type::Tuple(syn::TypeTuple { paren_token: Default::default(), elems: syn::punctuated::Punctuated::new() })],
1019                                                                 Some(&gen_types), "Result") {
1020                                                         writeln!(w, "#[no_mangle]").unwrap();
1021                                                         writeln!(w, "/// Read a {} object from a string", ident).unwrap();
1022                                                         writeln!(w, "pub extern \"C\" fn {}_from_str(s: crate::c_types::Str) -> {} {{", ident, container).unwrap();
1023                                                         writeln!(w, "\tmatch {}::from_str(s.into_str()) {{", resolved_path).unwrap();
1024                                                         writeln!(w, "\t\tOk(r) => {{").unwrap();
1025                                                         let new_var = types.write_to_c_conversion_new_var(w, &format_ident!("r"), &*i.self_ty, Some(&gen_types), false);
1026                                                         write!(w, "\t\t\tcrate::c_types::CResultTempl::ok(\n\t\t\t\t").unwrap();
1027                                                         types.write_to_c_conversion_inline_prefix(w, &*i.self_ty, Some(&gen_types), false);
1028                                                         write!(w, "{}r", if new_var { "local_" } else { "" }).unwrap();
1029                                                         types.write_to_c_conversion_inline_suffix(w, &*i.self_ty, Some(&gen_types), false);
1030                                                         writeln!(w, "\n\t\t\t)\n\t\t}},").unwrap();
1031                                                         writeln!(w, "\t\tErr(e) => crate::c_types::CResultTempl::err(()),").unwrap();
1032                                                         writeln!(w, "\t}}.into()\n}}").unwrap();
1033                                                 }
1034                                         } else if path_matches_nongeneric(&trait_path.1, &["Display"]) {
1035                                                 writeln!(w, "#[no_mangle]").unwrap();
1036                                                 writeln!(w, "/// Get the string representation of a {} object", ident).unwrap();
1037                                                 writeln!(w, "pub extern \"C\" fn {}_to_str(o: &crate::{}) -> Str {{", ident, resolved_path).unwrap();
1038
1039                                                 let self_ty = &i.self_ty;
1040                                                 let ref_type: syn::Type = syn::parse_quote!(&#self_ty);
1041                                                 let new_var = types.write_from_c_conversion_new_var(w, &format_ident!("o"), &ref_type, Some(&gen_types));
1042                                                 write!(w, "\tformat!(\"{{}}\", ").unwrap();
1043                                                 types.write_from_c_conversion_prefix(w, &ref_type, Some(&gen_types));
1044                                                 write!(w, "{}o", if new_var { "local_" } else { "" }).unwrap();
1045                                                 types.write_from_c_conversion_suffix(w, &ref_type, Some(&gen_types));
1046                                                 writeln!(w, ").into()").unwrap();
1047
1048                                                 writeln!(w, "}}").unwrap();
1049                                         } else {
1050                                                 //XXX: implement for other things like ToString
1051                                                 // If we have no generics, try a manual implementation:
1052                                                 maybe_convert_trait_impl(w, &trait_path.1, &*i.self_ty, types, &gen_types);
1053                                         }
1054                                 } else {
1055                                         let declared_type = (*types.get_declared_type(&ident).unwrap()).clone();
1056                                         for item in i.items.iter() {
1057                                                 match item {
1058                                                         syn::ImplItem::Method(m) => {
1059                                                                 if let syn::Visibility::Public(_) = m.vis {
1060                                                                         match export_status(&m.attrs) {
1061                                                                                 ExportStatus::Export => {},
1062                                                                                 ExportStatus::NoExport|ExportStatus::TestOnly => continue,
1063                                                                                 ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
1064                                                                         }
1065                                                                         let mut meth_gen_types = gen_types.push_ctx();
1066                                                                         assert!(meth_gen_types.learn_generics(&m.sig.generics, types));
1067                                                                         if m.defaultness.is_some() { unimplemented!(); }
1068                                                                         writeln_fn_docs(w, &m.attrs, "", types, Some(&meth_gen_types), m.sig.inputs.iter(), &m.sig.output);
1069                                                                         if let syn::ReturnType::Type(_, _) = &m.sig.output {
1070                                                                                 writeln!(w, "#[must_use]").unwrap();
1071                                                                         }
1072                                                                         write!(w, "#[no_mangle]\npub extern \"C\" fn {}_{}(", ident, m.sig.ident).unwrap();
1073                                                                         let ret_type = match &declared_type {
1074                                                                                 DeclType::MirroredEnum => format!("{}", ident),
1075                                                                                 DeclType::StructImported => format!("{}", ident),
1076                                                                                 _ => unimplemented!(),
1077                                                                         };
1078                                                                         write_method_params(w, &m.sig, &ret_type, types, Some(&meth_gen_types), false, true);
1079                                                                         write!(w, " {{\n\t").unwrap();
1080                                                                         write_method_var_decl_body(w, &m.sig, "", types, Some(&meth_gen_types), false);
1081                                                                         let mut takes_self = false;
1082                                                                         let mut takes_mut_self = false;
1083                                                                         let mut takes_owned_self = false;
1084                                                                         for inp in m.sig.inputs.iter() {
1085                                                                                 if let syn::FnArg::Receiver(r) = inp {
1086                                                                                         takes_self = true;
1087                                                                                         if r.mutability.is_some() { takes_mut_self = true; }
1088                                                                                         if r.reference.is_none() { takes_owned_self = true; }
1089                                                                                 }
1090                                                                         }
1091                                                                         if !takes_mut_self && !takes_self {
1092                                                                                 write!(w, "{}::{}(", resolved_path, m.sig.ident).unwrap();
1093                                                                         } else {
1094                                                                                 match &declared_type {
1095                                                                                         DeclType::MirroredEnum => write!(w, "this_arg.to_native().{}(", m.sig.ident).unwrap(),
1096                                                                                         DeclType::StructImported => {
1097                                                                                                 if takes_owned_self {
1098                                                                                                         write!(w, "(*unsafe {{ Box::from_raw(this_arg.take_inner()) }}).{}(", m.sig.ident).unwrap();
1099                                                                                                 } else if takes_mut_self {
1100                                                                                                         write!(w, "unsafe {{ &mut (*ObjOps::untweak_ptr(this_arg.inner as *mut native{})) }}.{}(", ident, m.sig.ident).unwrap();
1101                                                                                                 } else {
1102                                                                                                         write!(w, "unsafe {{ &*ObjOps::untweak_ptr(this_arg.inner) }}.{}(", m.sig.ident).unwrap();
1103                                                                                                 }
1104                                                                                         },
1105                                                                                         _ => unimplemented!(),
1106                                                                                 }
1107                                                                         }
1108                                                                         write_method_call_params(w, &m.sig, "", types, Some(&meth_gen_types), &ret_type, false);
1109                                                                         writeln!(w, "\n}}\n").unwrap();
1110                                                                 }
1111                                                         },
1112                                                         _ => {},
1113                                                 }
1114                                         }
1115                                 }
1116                         } else if let Some(resolved_path) = types.maybe_resolve_ident(&ident) {
1117                                 if let Some(aliases) = types.crate_types.reverse_alias_map.get(&resolved_path).cloned() {
1118                                         'alias_impls: for (alias, arguments) in aliases {
1119                                                 let alias_resolved = types.resolve_path(&alias, None);
1120                                                 for (idx, gen) in i.generics.params.iter().enumerate() {
1121                                                         match gen {
1122                                                                 syn::GenericParam::Type(type_param) => {
1123                                                                         'bounds_check: for bound in type_param.bounds.iter() {
1124                                                                                 if let syn::TypeParamBound::Trait(trait_bound) = bound {
1125                                                                                         if let syn::PathArguments::AngleBracketed(ref t) = &arguments {
1126                                                                                                 assert!(idx < t.args.len());
1127                                                                                                 if let syn::GenericArgument::Type(syn::Type::Path(p)) = &t.args[idx] {
1128                                                                                                         let generic_arg = types.resolve_path(&p.path, None);
1129                                                                                                         let generic_bound = types.resolve_path(&trait_bound.path, None);
1130                                                                                                         if let Some(traits_impld) = types.crate_types.trait_impls.get(&generic_arg) {
1131                                                                                                                 for trait_impld in traits_impld {
1132                                                                                                                         if *trait_impld == generic_bound { continue 'bounds_check; }
1133                                                                                                                 }
1134                                                                                                                 eprintln!("struct {}'s generic arg {} didn't match bound {}", alias_resolved, generic_arg, generic_bound);
1135                                                                                                                 continue 'alias_impls;
1136                                                                                                         } else {
1137                                                                                                                 eprintln!("struct {}'s generic arg {} didn't match bound {}", alias_resolved, generic_arg, generic_bound);
1138                                                                                                                 continue 'alias_impls;
1139                                                                                                         }
1140                                                                                                 } else { unimplemented!(); }
1141                                                                                         } else { unimplemented!(); }
1142                                                                                 } else { unimplemented!(); }
1143                                                                         }
1144                                                                 },
1145                                                                 syn::GenericParam::Lifetime(_) => {},
1146                                                                 syn::GenericParam::Const(_) => unimplemented!(),
1147                                                         }
1148                                                 }
1149                                                 let aliased_impl = syn::ItemImpl {
1150                                                         attrs: i.attrs.clone(),
1151                                                         brace_token: syn::token::Brace(Span::call_site()),
1152                                                         defaultness: None,
1153                                                         generics: syn::Generics {
1154                                                                 lt_token: None,
1155                                                                 params: syn::punctuated::Punctuated::new(),
1156                                                                 gt_token: None,
1157                                                                 where_clause: None,
1158                                                         },
1159                                                         impl_token: syn::Token![impl](Span::call_site()),
1160                                                         items: i.items.clone(),
1161                                                         self_ty: Box::new(syn::Type::Path(syn::TypePath { qself: None, path: alias.clone() })),
1162                                                         trait_: i.trait_.clone(),
1163                                                         unsafety: None,
1164                                                 };
1165                                                 writeln_impl(w, &aliased_impl, types);
1166                                         }
1167                                 } else {
1168                                         eprintln!("Not implementing anything for {} due to it being marked not exported", ident);
1169                                 }
1170                         } else {
1171                                 eprintln!("Not implementing anything for {} due to no-resolve (probably the type isn't pub)", ident);
1172                         }
1173                 }
1174         }
1175 }
1176
1177 /// Replaces upper case charachters with underscore followed by lower case except the first
1178 /// charachter and repeated upper case characthers (which are only made lower case).
1179 fn camel_to_snake_case(camel: &str) -> String {
1180         let mut res = "".to_string();
1181         let mut last_upper = -1;
1182         for (idx, c) in camel.chars().enumerate() {
1183                 if c.is_uppercase() {
1184                         if last_upper != idx as isize - 1 { res.push('_'); }
1185                         res.push(c.to_lowercase().next().unwrap());
1186                         last_upper = idx as isize;
1187                 } else {
1188                         res.push(c);
1189                 }
1190         }
1191         res
1192 }
1193
1194
1195 /// Print a mapping of an enum. If all of the enum's fields are C-mapped in some form (or the enum
1196 /// is unitary), we generate an equivalent enum with all types replaced with their C mapped
1197 /// versions followed by conversion functions which map between the Rust version and the C mapped
1198 /// version.
1199 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) {
1200         match export_status(&e.attrs) {
1201                 ExportStatus::Export => {},
1202                 ExportStatus::NoExport|ExportStatus::TestOnly => return,
1203                 ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
1204         }
1205
1206         if is_enum_opaque(e) {
1207                 eprintln!("Skipping enum {} as it contains non-unit fields", e.ident);
1208                 writeln_opaque(w, &e.ident, &format!("{}", e.ident), &e.generics, &e.attrs, types, extra_headers, cpp_headers);
1209                 return;
1210         }
1211         writeln_docs(w, &e.attrs, "");
1212
1213         let mut gen_types = GenericTypes::new(None);
1214         assert!(gen_types.learn_generics(&e.generics, types));
1215
1216         let mut needs_free = false;
1217         let mut constr = Vec::new();
1218
1219         writeln!(w, "#[must_use]\n#[derive(Clone)]\n#[repr(C)]\npub enum {} {{", e.ident).unwrap();
1220         for var in e.variants.iter() {
1221                 assert_eq!(export_status(&var.attrs), ExportStatus::Export); // We can't partially-export a mirrored enum
1222                 writeln_docs(w, &var.attrs, "\t");
1223                 write!(w, "\t{}", var.ident).unwrap();
1224                 writeln!(&mut constr, "#[no_mangle]\n/// Utility method to constructs a new {}-variant {}", var.ident, e.ident).unwrap();
1225                 let constr_name = camel_to_snake_case(&format!("{}", var.ident));
1226                 write!(&mut constr, "pub extern \"C\" fn {}_{}(", e.ident, constr_name).unwrap();
1227                 let mut empty_tuple_variant = false;
1228                 if let syn::Fields::Named(fields) = &var.fields {
1229                         needs_free = true;
1230                         writeln!(w, " {{").unwrap();
1231                         for (idx, field) in fields.named.iter().enumerate() {
1232                                 if export_status(&field.attrs) == ExportStatus::TestOnly { continue; }
1233                                 writeln_field_docs(w, &field.attrs, "\t\t", types, Some(&gen_types), &field.ty);
1234                                 write!(w, "\t\t{}: ", field.ident.as_ref().unwrap()).unwrap();
1235                                 write!(&mut constr, "{}{}: ", if idx != 0 { ", " } else { "" }, field.ident.as_ref().unwrap()).unwrap();
1236                                 types.write_c_type(w, &field.ty, Some(&gen_types), false);
1237                                 types.write_c_type(&mut constr, &field.ty, Some(&gen_types), false);
1238                                 writeln!(w, ",").unwrap();
1239                         }
1240                         write!(w, "\t}}").unwrap();
1241                 } else if let syn::Fields::Unnamed(fields) = &var.fields {
1242                         if fields.unnamed.len() == 1 {
1243                                 let mut empty_check = Vec::new();
1244                                 types.write_c_type(&mut empty_check, &fields.unnamed[0].ty, Some(&gen_types), false);
1245                                 if empty_check.is_empty() {
1246                                         empty_tuple_variant = true;
1247                                 }
1248                         }
1249                         if !empty_tuple_variant {
1250                                 needs_free = true;
1251                                 write!(w, "(").unwrap();
1252                                 for (idx, field) in fields.unnamed.iter().enumerate() {
1253                                         if export_status(&field.attrs) == ExportStatus::TestOnly { continue; }
1254                                         write!(&mut constr, "{}: ", ('a' as u8 + idx as u8) as char).unwrap();
1255                                         types.write_c_type(w, &field.ty, Some(&gen_types), false);
1256                                         types.write_c_type(&mut constr, &field.ty, Some(&gen_types), false);
1257                                         if idx != fields.unnamed.len() - 1 {
1258                                                 write!(w, ",").unwrap();
1259                                                 write!(&mut constr, ",").unwrap();
1260                                         }
1261                                 }
1262                                 write!(w, ")").unwrap();
1263                         }
1264                 }
1265                 if var.discriminant.is_some() { unimplemented!(); }
1266                 write!(&mut constr, ") -> {} {{\n\t{}::{}", e.ident, e.ident, var.ident).unwrap();
1267                 if let syn::Fields::Named(fields) = &var.fields {
1268                         writeln!(&mut constr, " {{").unwrap();
1269                         for field in fields.named.iter() {
1270                                 writeln!(&mut constr, "\t\t{},", field.ident.as_ref().unwrap()).unwrap();
1271                         }
1272                         writeln!(&mut constr, "\t}}").unwrap();
1273                 } else if let syn::Fields::Unnamed(fields) = &var.fields {
1274                         if !empty_tuple_variant {
1275                                 write!(&mut constr, "(").unwrap();
1276                                 for idx in 0..fields.unnamed.len() {
1277                                         write!(&mut constr, "{}, ", ('a' as u8 + idx as u8) as char).unwrap();
1278                                 }
1279                                 writeln!(&mut constr, ")").unwrap();
1280                         } else {
1281                                 writeln!(&mut constr, "").unwrap();
1282                         }
1283                 }
1284                 writeln!(&mut constr, "}}").unwrap();
1285                 writeln!(w, ",").unwrap();
1286         }
1287         writeln!(w, "}}\nuse {}::{} as native{};\nimpl {} {{", types.module_path, e.ident, e.ident, e.ident).unwrap();
1288
1289         macro_rules! write_conv {
1290                 ($fn_sig: expr, $to_c: expr, $ref: expr) => {
1291                         writeln!(w, "\t#[allow(unused)]\n\tpub(crate) fn {} {{\n\t\tmatch {} {{", $fn_sig, if $to_c { "native" } else { "self" }).unwrap();
1292                         for var in e.variants.iter() {
1293                                 write!(w, "\t\t\t{}{}::{} ", if $to_c { "native" } else { "" }, e.ident, var.ident).unwrap();
1294                                 let mut empty_tuple_variant = false;
1295                                 if let syn::Fields::Named(fields) = &var.fields {
1296                                         write!(w, "{{").unwrap();
1297                                         for field in fields.named.iter() {
1298                                                 if export_status(&field.attrs) == ExportStatus::TestOnly { continue; }
1299                                                 write!(w, "{}{}, ", if $ref { "ref " } else { "mut " }, field.ident.as_ref().unwrap()).unwrap();
1300                                         }
1301                                         write!(w, "}} ").unwrap();
1302                                 } else if let syn::Fields::Unnamed(fields) = &var.fields {
1303                                         if fields.unnamed.len() == 1 {
1304                                                 let mut empty_check = Vec::new();
1305                                                 types.write_c_type(&mut empty_check, &fields.unnamed[0].ty, Some(&gen_types), false);
1306                                                 if empty_check.is_empty() {
1307                                                         empty_tuple_variant = true;
1308                                                 }
1309                                         }
1310                                         if !empty_tuple_variant || $to_c {
1311                                                 write!(w, "(").unwrap();
1312                                                 for (idx, field) in fields.unnamed.iter().enumerate() {
1313                                                         if export_status(&field.attrs) == ExportStatus::TestOnly { continue; }
1314                                                         write!(w, "{}{}, ", if $ref { "ref " } else { "mut " }, ('a' as u8 + idx as u8) as char).unwrap();
1315                                                 }
1316                                                 write!(w, ") ").unwrap();
1317                                         }
1318                                 }
1319                                 write!(w, "=>").unwrap();
1320
1321                                 macro_rules! handle_field_a {
1322                                         ($field: expr, $field_ident: expr) => { {
1323                                                 if export_status(&$field.attrs) == ExportStatus::TestOnly { continue; }
1324                                                 let mut sink = ::std::io::sink();
1325                                                 let mut out: &mut dyn std::io::Write = if $ref { &mut sink } else { w };
1326                                                 let new_var = if $to_c {
1327                                                         types.write_to_c_conversion_new_var(&mut out, $field_ident, &$field.ty, Some(&gen_types), false)
1328                                                 } else {
1329                                                         types.write_from_c_conversion_new_var(&mut out, $field_ident, &$field.ty, Some(&gen_types))
1330                                                 };
1331                                                 if $ref || new_var {
1332                                                         if $ref {
1333                                                                 write!(w, "let mut {}_nonref = (*{}).clone();\n\t\t\t\t", $field_ident, $field_ident).unwrap();
1334                                                                 if new_var {
1335                                                                         let nonref_ident = format_ident!("{}_nonref", $field_ident);
1336                                                                         if $to_c {
1337                                                                                 types.write_to_c_conversion_new_var(w, &nonref_ident, &$field.ty, Some(&gen_types), false);
1338                                                                         } else {
1339                                                                                 types.write_from_c_conversion_new_var(w, &nonref_ident, &$field.ty, Some(&gen_types));
1340                                                                         }
1341                                                                         write!(w, "\n\t\t\t\t").unwrap();
1342                                                                 }
1343                                                         } else {
1344                                                                 write!(w, "\n\t\t\t\t").unwrap();
1345                                                         }
1346                                                 }
1347                                         } }
1348                                 }
1349                                 if let syn::Fields::Named(fields) = &var.fields {
1350                                         write!(w, " {{\n\t\t\t\t").unwrap();
1351                                         for field in fields.named.iter() {
1352                                                 handle_field_a!(field, field.ident.as_ref().unwrap());
1353                                         }
1354                                 } else if let syn::Fields::Unnamed(fields) = &var.fields {
1355                                         write!(w, " {{\n\t\t\t\t").unwrap();
1356                                         for (idx, field) in fields.unnamed.iter().enumerate() {
1357                                                 if !empty_tuple_variant {
1358                                                         handle_field_a!(field, &format_ident!("{}", ('a' as u8 + idx as u8) as char));
1359                                                 }
1360                                         }
1361                                 } else { write!(w, " ").unwrap(); }
1362
1363                                 write!(w, "{}{}::{}", if $to_c { "" } else { "native" }, e.ident, var.ident).unwrap();
1364
1365                                 macro_rules! handle_field_b {
1366                                         ($field: expr, $field_ident: expr) => { {
1367                                                 if export_status(&$field.attrs) == ExportStatus::TestOnly { continue; }
1368                                                 if $to_c {
1369                                                         types.write_to_c_conversion_inline_prefix(w, &$field.ty, Some(&gen_types), false);
1370                                                 } else {
1371                                                         types.write_from_c_conversion_prefix(w, &$field.ty, Some(&gen_types));
1372                                                 }
1373                                                 write!(w, "{}{}", $field_ident,
1374                                                         if $ref { "_nonref" } else { "" }).unwrap();
1375                                                 if $to_c {
1376                                                         types.write_to_c_conversion_inline_suffix(w, &$field.ty, Some(&gen_types), false);
1377                                                 } else {
1378                                                         types.write_from_c_conversion_suffix(w, &$field.ty, Some(&gen_types));
1379                                                 }
1380                                                 write!(w, ",").unwrap();
1381                                         } }
1382                                 }
1383
1384                                 if let syn::Fields::Named(fields) = &var.fields {
1385                                         write!(w, " {{").unwrap();
1386                                         for field in fields.named.iter() {
1387                                                 if export_status(&field.attrs) == ExportStatus::TestOnly { continue; }
1388                                                 write!(w, "\n\t\t\t\t\t{}: ", field.ident.as_ref().unwrap()).unwrap();
1389                                                 handle_field_b!(field, field.ident.as_ref().unwrap());
1390                                         }
1391                                         writeln!(w, "\n\t\t\t\t}}").unwrap();
1392                                         write!(w, "\t\t\t}}").unwrap();
1393                                 } else if let syn::Fields::Unnamed(fields) = &var.fields {
1394                                         if !empty_tuple_variant || !$to_c {
1395                                                 write!(w, " (").unwrap();
1396                                                 for (idx, field) in fields.unnamed.iter().enumerate() {
1397                                                         write!(w, "\n\t\t\t\t\t").unwrap();
1398                                                         handle_field_b!(field, &format_ident!("{}", ('a' as u8 + idx as u8) as char));
1399                                                 }
1400                                                 writeln!(w, "\n\t\t\t\t)").unwrap();
1401                                         }
1402                                         write!(w, "\t\t\t}}").unwrap();
1403                                 }
1404                                 writeln!(w, ",").unwrap();
1405                         }
1406                         writeln!(w, "\t\t}}\n\t}}").unwrap();
1407                 }
1408         }
1409
1410         write_conv!(format!("to_native(&self) -> native{}", e.ident), false, true);
1411         write_conv!(format!("into_native(self) -> native{}", e.ident), false, false);
1412         write_conv!(format!("from_native(native: &native{}) -> Self", e.ident), true, true);
1413         write_conv!(format!("native_into(native: native{}) -> Self", e.ident), true, false);
1414         writeln!(w, "}}").unwrap();
1415
1416         if needs_free {
1417                 writeln!(w, "/// Frees any resources used by the {}", e.ident).unwrap();
1418                 writeln!(w, "#[no_mangle]\npub extern \"C\" fn {}_free(this_ptr: {}) {{ }}", e.ident, e.ident).unwrap();
1419         }
1420         writeln!(w, "/// Creates a copy of the {}", e.ident).unwrap();
1421         writeln!(w, "#[no_mangle]").unwrap();
1422         writeln!(w, "pub extern \"C\" fn {}_clone(orig: &{}) -> {} {{", e.ident, e.ident, e.ident).unwrap();
1423         writeln!(w, "\torig.clone()").unwrap();
1424         writeln!(w, "}}").unwrap();
1425         w.write_all(&constr).unwrap();
1426         write_cpp_wrapper(cpp_headers, &format!("{}", e.ident), needs_free, None);
1427 }
1428
1429 fn writeln_fn<'a, 'b, W: std::io::Write>(w: &mut W, f: &'a syn::ItemFn, types: &mut TypeResolver<'b, 'a>) {
1430         match export_status(&f.attrs) {
1431                 ExportStatus::Export => {},
1432                 ExportStatus::NoExport|ExportStatus::TestOnly => return,
1433                 ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
1434         }
1435         let mut gen_types = GenericTypes::new(None);
1436         if !gen_types.learn_generics(&f.sig.generics, types) { return; }
1437
1438         writeln_fn_docs(w, &f.attrs, "", types, Some(&gen_types), f.sig.inputs.iter(), &f.sig.output);
1439
1440         write!(w, "#[no_mangle]\npub extern \"C\" fn {}(", f.sig.ident).unwrap();
1441         write_method_params(w, &f.sig, "", types, Some(&gen_types), false, true);
1442         write!(w, " {{\n\t").unwrap();
1443         write_method_var_decl_body(w, &f.sig, "", types, Some(&gen_types), false);
1444         write!(w, "{}::{}(", types.module_path, f.sig.ident).unwrap();
1445         write_method_call_params(w, &f.sig, "", types, Some(&gen_types), "", false);
1446         writeln!(w, "\n}}\n").unwrap();
1447 }
1448
1449 // ********************************
1450 // *** File/Crate Walking Logic ***
1451 // ********************************
1452
1453 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) {
1454         // We want to ignore all items declared in this module (as they are not pub), but we still need
1455         // to give the ImportResolver any use statements, so we copy them here.
1456         let mut use_items = Vec::new();
1457         for item in module.content.as_ref().unwrap().1.iter() {
1458                 if let syn::Item::Use(_) = item {
1459                         use_items.push(item);
1460                 }
1461         }
1462         let import_resolver = ImportResolver::from_borrowed_items(mod_path.splitn(2, "::").next().unwrap(), &libast.dependencies, mod_path, &use_items);
1463         let mut types = TypeResolver::new(mod_path, import_resolver, crate_types);
1464
1465         writeln!(w, "mod {} {{\n{}", module.ident, DEFAULT_IMPORTS).unwrap();
1466         for item in module.content.as_ref().unwrap().1.iter() {
1467                 match item {
1468                         syn::Item::Mod(m) => convert_priv_mod(w, libast, crate_types, out_dir, &format!("{}::{}", mod_path, module.ident), m),
1469                         syn::Item::Impl(i) => {
1470                                 if let &syn::Type::Path(ref p) = &*i.self_ty {
1471                                         if p.path.get_ident().is_some() {
1472                                                 writeln_impl(w, i, &mut types);
1473                                         }
1474                                 }
1475                         },
1476                         _ => {},
1477                 }
1478         }
1479         writeln!(w, "}}").unwrap();
1480 }
1481
1482 /// Do the Real Work of mapping an original file to C-callable wrappers. Creates a new file at
1483 /// `out_path` and fills it with wrapper structs/functions to allow calling the things in the AST
1484 /// at `module` from C.
1485 fn convert_file<'a, 'b>(libast: &'a FullLibraryAST, crate_types: &CrateTypes<'a>, out_dir: &str, header_file: &mut File, cpp_header_file: &mut File) {
1486         for (module, astmod) in libast.modules.iter() {
1487                 let orig_crate = module.splitn(2, "::").next().unwrap();
1488                 let ASTModule { ref attrs, ref items, ref submods } = astmod;
1489                 assert_eq!(export_status(&attrs), ExportStatus::Export);
1490
1491                 let new_file_path = if submods.is_empty() {
1492                         format!("{}/{}.rs", out_dir, module.replace("::", "/"))
1493                 } else if module != "" {
1494                         format!("{}/{}/mod.rs", out_dir, module.replace("::", "/"))
1495                 } else {
1496                         format!("{}/lib.rs", out_dir)
1497                 };
1498                 let _ = std::fs::create_dir((&new_file_path.as_ref() as &std::path::Path).parent().unwrap());
1499                 let mut out = std::fs::OpenOptions::new().write(true).create(true).truncate(true)
1500                         .open(new_file_path).expect("Unable to open new src file");
1501
1502                 writeln!(out, "// This file is Copyright its original authors, visible in version control").unwrap();
1503                 writeln!(out, "// history and in the source files from which this was generated.").unwrap();
1504                 writeln!(out, "//").unwrap();
1505                 writeln!(out, "// This file is licensed under the license available in the LICENSE or LICENSE.md").unwrap();
1506                 writeln!(out, "// file in the root of this repository or, if no such file exists, the same").unwrap();
1507                 writeln!(out, "// license as that which applies to the original source files from which this").unwrap();
1508                 writeln!(out, "// source was automatically generated.").unwrap();
1509                 writeln!(out, "").unwrap();
1510
1511                 writeln_docs(&mut out, &attrs, "");
1512
1513                 if module == "" {
1514                         // Special-case the top-level lib.rs with various lint allows and a pointer to the c_types
1515                         // and bitcoin hand-written modules.
1516                         writeln!(out, "//! C Bindings").unwrap();
1517                         writeln!(out, "#![allow(unknown_lints)]").unwrap();
1518                         writeln!(out, "#![allow(non_camel_case_types)]").unwrap();
1519                         writeln!(out, "#![allow(non_snake_case)]").unwrap();
1520                         writeln!(out, "#![allow(unused_imports)]").unwrap();
1521                         writeln!(out, "#![allow(unused_variables)]").unwrap();
1522                         writeln!(out, "#![allow(unused_mut)]").unwrap();
1523                         writeln!(out, "#![allow(unused_parens)]").unwrap();
1524                         writeln!(out, "#![allow(unused_unsafe)]").unwrap();
1525                         writeln!(out, "#![allow(unused_braces)]").unwrap();
1526                         // TODO: We need to map deny(missing_docs) in the source crate(s)
1527                         //writeln!(out, "#![deny(missing_docs)]").unwrap();
1528                         writeln!(out, "pub mod version;").unwrap();
1529                         writeln!(out, "pub mod c_types;").unwrap();
1530                         writeln!(out, "pub mod bitcoin;").unwrap();
1531                 } else {
1532                         writeln!(out, "{}", DEFAULT_IMPORTS).unwrap();
1533                 }
1534
1535                 for m in submods {
1536                         writeln!(out, "pub mod {};", m).unwrap();
1537                 }
1538
1539                 eprintln!("Converting {} entries...", module);
1540
1541                 let import_resolver = ImportResolver::new(orig_crate, &libast.dependencies, module, items);
1542                 let mut type_resolver = TypeResolver::new(module, import_resolver, crate_types);
1543
1544                 for item in items.iter() {
1545                         match item {
1546                                 syn::Item::Use(_) => {}, // Handled above
1547                                 syn::Item::Static(_) => {},
1548                                 syn::Item::Enum(e) => {
1549                                         if let syn::Visibility::Public(_) = e.vis {
1550                                                 writeln_enum(&mut out, &e, &mut type_resolver, header_file, cpp_header_file);
1551                                         }
1552                                 },
1553                                 syn::Item::Impl(i) => {
1554                                         writeln_impl(&mut out, &i, &mut type_resolver);
1555                                 },
1556                                 syn::Item::Struct(s) => {
1557                                         if let syn::Visibility::Public(_) = s.vis {
1558                                                 writeln_struct(&mut out, &s, &mut type_resolver, header_file, cpp_header_file);
1559                                         }
1560                                 },
1561                                 syn::Item::Trait(t) => {
1562                                         if let syn::Visibility::Public(_) = t.vis {
1563                                                 writeln_trait(&mut out, &t, &mut type_resolver, header_file, cpp_header_file);
1564                                         }
1565                                 },
1566                                 syn::Item::Mod(m) => {
1567                                         convert_priv_mod(&mut out, libast, crate_types, out_dir, &format!("{}::{}", module, m.ident), m);
1568                                 },
1569                                 syn::Item::Const(c) => {
1570                                         // Re-export any primitive-type constants.
1571                                         if let syn::Visibility::Public(_) = c.vis {
1572                                                 if let syn::Type::Path(p) = &*c.ty {
1573                                                         let resolved_path = type_resolver.resolve_path(&p.path, None);
1574                                                         if type_resolver.is_primitive(&resolved_path) {
1575                                                                 writeln_field_docs(&mut out, &c.attrs, "", &mut type_resolver, None, &*c.ty);
1576                                                                 writeln!(out, "\n#[no_mangle]").unwrap();
1577                                                                 writeln!(out, "pub static {}: {} = {}::{};", c.ident, resolved_path, module, c.ident).unwrap();
1578                                                         }
1579                                                 }
1580                                         }
1581                                 },
1582                                 syn::Item::Type(t) => {
1583                                         if let syn::Visibility::Public(_) = t.vis {
1584                                                 match export_status(&t.attrs) {
1585                                                         ExportStatus::Export => {},
1586                                                         ExportStatus::NoExport|ExportStatus::TestOnly => continue,
1587                                                         ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
1588                                                 }
1589
1590                                                 let mut process_alias = true;
1591                                                 for tok in t.generics.params.iter() {
1592                                                         if let syn::GenericParam::Lifetime(_) = tok {}
1593                                                         else { process_alias = false; }
1594                                                 }
1595                                                 if process_alias {
1596                                                         match &*t.ty {
1597                                                                 syn::Type::Path(_) =>
1598                                                                         writeln_opaque(&mut out, &t.ident, &format!("{}", t.ident), &t.generics, &t.attrs, &type_resolver, header_file, cpp_header_file),
1599                                                                 _ => {}
1600                                                         }
1601                                                 }
1602                                         }
1603                                 },
1604                                 syn::Item::Fn(f) => {
1605                                         if let syn::Visibility::Public(_) = f.vis {
1606                                                 writeln_fn(&mut out, &f, &mut type_resolver);
1607                                         }
1608                                 },
1609                                 syn::Item::Macro(_) => {},
1610                                 syn::Item::Verbatim(_) => {},
1611                                 syn::Item::ExternCrate(_) => {},
1612                                 _ => unimplemented!(),
1613                         }
1614                 }
1615
1616                 out.flush().unwrap();
1617         }
1618 }
1619
1620 fn walk_private_mod<'a>(ast_storage: &'a FullLibraryAST, orig_crate: &str, module: String, items: &'a syn::ItemMod, crate_types: &mut CrateTypes<'a>) {
1621         let import_resolver = ImportResolver::new(orig_crate, &ast_storage.dependencies, &module, &items.content.as_ref().unwrap().1);
1622         for item in items.content.as_ref().unwrap().1.iter() {
1623                 match item {
1624                         syn::Item::Mod(m) => walk_private_mod(ast_storage, orig_crate, format!("{}::{}", module, m.ident), m, crate_types),
1625                         syn::Item::Impl(i) => {
1626                                 if let &syn::Type::Path(ref p) = &*i.self_ty {
1627                                         if let Some(trait_path) = i.trait_.as_ref() {
1628                                                 if let Some(tp) = import_resolver.maybe_resolve_path(&trait_path.1, None) {
1629                                                         if let Some(sp) = import_resolver.maybe_resolve_path(&p.path, None) {
1630                                                                 match crate_types.trait_impls.entry(sp) {
1631                                                                         hash_map::Entry::Occupied(mut e) => { e.get_mut().push(tp); },
1632                                                                         hash_map::Entry::Vacant(e) => { e.insert(vec![tp]); },
1633                                                                 }
1634                                                         }
1635                                                 }
1636                                         }
1637                                 }
1638                         },
1639                         _ => {},
1640                 }
1641         }
1642 }
1643
1644 /// Walk the FullLibraryAST, deciding how things will be mapped and adding tracking to CrateTypes.
1645 fn walk_ast<'a>(ast_storage: &'a FullLibraryAST, crate_types: &mut CrateTypes<'a>) {
1646         for (module, astmod) in ast_storage.modules.iter() {
1647                 let ASTModule { ref attrs, ref items, submods: _ } = astmod;
1648                 assert_eq!(export_status(&attrs), ExportStatus::Export);
1649                 let orig_crate = module.splitn(2, "::").next().unwrap();
1650                 let import_resolver = ImportResolver::new(orig_crate, &ast_storage.dependencies, module, items);
1651
1652                 for item in items.iter() {
1653                         match item {
1654                                 syn::Item::Struct(s) => {
1655                                         if let syn::Visibility::Public(_) = s.vis {
1656                                                 match export_status(&s.attrs) {
1657                                                         ExportStatus::Export => {},
1658                                                         ExportStatus::NoExport|ExportStatus::TestOnly => continue,
1659                                                         ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
1660                                                 }
1661                                                 let struct_path = format!("{}::{}", module, s.ident);
1662                                                 crate_types.opaques.insert(struct_path, &s.ident);
1663                                         }
1664                                 },
1665                                 syn::Item::Trait(t) => {
1666                                         if let syn::Visibility::Public(_) = t.vis {
1667                                                 match export_status(&t.attrs) {
1668                                                         ExportStatus::Export|ExportStatus::NotImplementable => {},
1669                                                         ExportStatus::NoExport|ExportStatus::TestOnly => continue,
1670                                                 }
1671                                                 let trait_path = format!("{}::{}", module, t.ident);
1672                                                 walk_supertraits!(t, None, (
1673                                                         ("Clone", _) => {
1674                                                                 crate_types.set_clonable("crate::".to_owned() + &trait_path);
1675                                                         },
1676                                                         (_, _) => {}
1677                                                 ) );
1678                                                 crate_types.traits.insert(trait_path, &t);
1679                                         }
1680                                 },
1681                                 syn::Item::Type(t) => {
1682                                         if let syn::Visibility::Public(_) = t.vis {
1683                                                 match export_status(&t.attrs) {
1684                                                         ExportStatus::Export => {},
1685                                                         ExportStatus::NoExport|ExportStatus::TestOnly => continue,
1686                                                         ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
1687                                                 }
1688                                                 let type_path = format!("{}::{}", module, t.ident);
1689                                                 let mut process_alias = true;
1690                                                 for tok in t.generics.params.iter() {
1691                                                         if let syn::GenericParam::Lifetime(_) = tok {}
1692                                                         else { process_alias = false; }
1693                                                 }
1694                                                 if process_alias {
1695                                                         match &*t.ty {
1696                                                                 syn::Type::Path(p) => {
1697                                                                         let t_ident = &t.ident;
1698
1699                                                                         // If its a path with no generics, assume we don't map the aliased type and map it opaque
1700                                                                         let path_obj = parse_quote!(#t_ident);
1701                                                                         let args_obj = p.path.segments.last().unwrap().arguments.clone();
1702                                                                         match crate_types.reverse_alias_map.entry(import_resolver.maybe_resolve_path(&p.path, None).unwrap()) {
1703                                                                                 hash_map::Entry::Occupied(mut e) => { e.get_mut().push((path_obj, args_obj)); },
1704                                                                                 hash_map::Entry::Vacant(e) => { e.insert(vec![(path_obj, args_obj)]); },
1705                                                                         }
1706
1707                                                                         crate_types.opaques.insert(type_path, t_ident);
1708                                                                 },
1709                                                                 _ => {
1710                                                                         crate_types.type_aliases.insert(type_path, import_resolver.resolve_imported_refs((*t.ty).clone()));
1711                                                                 }
1712                                                         }
1713                                                 }
1714                                         }
1715                                 },
1716                                 syn::Item::Enum(e) if is_enum_opaque(e) => {
1717                                         if let syn::Visibility::Public(_) = e.vis {
1718                                                 match export_status(&e.attrs) {
1719                                                         ExportStatus::Export => {},
1720                                                         ExportStatus::NoExport|ExportStatus::TestOnly => continue,
1721                                                         ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
1722                                                 }
1723                                                 let enum_path = format!("{}::{}", module, e.ident);
1724                                                 crate_types.opaques.insert(enum_path, &e.ident);
1725                                         }
1726                                 },
1727                                 syn::Item::Enum(e) => {
1728                                         if let syn::Visibility::Public(_) = e.vis {
1729                                                 match export_status(&e.attrs) {
1730                                                         ExportStatus::Export => {},
1731                                                         ExportStatus::NoExport|ExportStatus::TestOnly => continue,
1732                                                         ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
1733                                                 }
1734                                                 let enum_path = format!("{}::{}", module, e.ident);
1735                                                 crate_types.mirrored_enums.insert(enum_path, &e);
1736                                         }
1737                                 },
1738                                 syn::Item::Impl(i) => {
1739                                         if let &syn::Type::Path(ref p) = &*i.self_ty {
1740                                                 if let Some(trait_path) = i.trait_.as_ref() {
1741                                                         if path_matches_nongeneric(&trait_path.1, &["core", "clone", "Clone"]) {
1742                                                                 if let Some(full_path) = import_resolver.maybe_resolve_path(&p.path, None) {
1743                                                                         crate_types.set_clonable("crate::".to_owned() + &full_path);
1744                                                                 }
1745                                                         }
1746                                                         if let Some(tp) = import_resolver.maybe_resolve_path(&trait_path.1, None) {
1747                                                                 if let Some(sp) = import_resolver.maybe_resolve_path(&p.path, None) {
1748                                                                         match crate_types.trait_impls.entry(sp) {
1749                                                                                 hash_map::Entry::Occupied(mut e) => { e.get_mut().push(tp); },
1750                                                                                 hash_map::Entry::Vacant(e) => { e.insert(vec![tp]); },
1751                                                                         }
1752                                                                 }
1753                                                         }
1754                                                 }
1755                                         }
1756                                 },
1757                                 syn::Item::Mod(m) => walk_private_mod(ast_storage, orig_crate, format!("{}::{}", module, m.ident), m, crate_types),
1758                                 _ => {},
1759                         }
1760                 }
1761         }
1762 }
1763
1764 fn main() {
1765         let args: Vec<String> = env::args().collect();
1766         if args.len() != 5 {
1767                 eprintln!("Usage: target/dir derived_templates.rs extra/includes.h extra/cpp/includes.hpp");
1768                 process::exit(1);
1769         }
1770
1771         let mut derived_templates = std::fs::OpenOptions::new().write(true).create(true).truncate(true)
1772                 .open(&args[2]).expect("Unable to open new header file");
1773         let mut header_file = std::fs::OpenOptions::new().write(true).create(true).truncate(true)
1774                 .open(&args[3]).expect("Unable to open new header file");
1775         let mut cpp_header_file = std::fs::OpenOptions::new().write(true).create(true).truncate(true)
1776                 .open(&args[4]).expect("Unable to open new header file");
1777
1778         writeln!(header_file, "#if defined(__GNUC__)").unwrap();
1779         writeln!(header_file, "#define MUST_USE_STRUCT __attribute__((warn_unused))").unwrap();
1780         writeln!(header_file, "#define MUST_USE_RES __attribute__((warn_unused_result))").unwrap();
1781         writeln!(header_file, "#else").unwrap();
1782         writeln!(header_file, "#define MUST_USE_STRUCT").unwrap();
1783         writeln!(header_file, "#define MUST_USE_RES").unwrap();
1784         writeln!(header_file, "#endif").unwrap();
1785         writeln!(header_file, "#if defined(__clang__)").unwrap();
1786         writeln!(header_file, "#define NONNULL_PTR _Nonnull").unwrap();
1787         writeln!(header_file, "#else").unwrap();
1788         writeln!(header_file, "#define NONNULL_PTR").unwrap();
1789         writeln!(header_file, "#endif").unwrap();
1790         writeln!(cpp_header_file, "#include <string.h>\nnamespace LDK {{").unwrap();
1791
1792         // First parse the full crate's ASTs, caching them so that we can hold references to the AST
1793         // objects in other datastructures:
1794         let mut lib_src = String::new();
1795         std::io::stdin().lock().read_to_string(&mut lib_src).unwrap();
1796         let lib_syntax = syn::parse_file(&lib_src).expect("Unable to parse file");
1797         let libast = FullLibraryAST::load_lib(lib_syntax);
1798
1799         // ...then walk the ASTs tracking what types we will map, and how, so that we can resolve them
1800         // when parsing other file ASTs...
1801         let mut libtypes = CrateTypes::new(&mut derived_templates, &libast);
1802         walk_ast(&libast, &mut libtypes);
1803
1804         // ... finally, do the actual file conversion/mapping, writing out types as we go.
1805         convert_file(&libast, &libtypes, &args[1], &mut header_file, &mut cpp_header_file);
1806
1807         // For container templates which we created while walking the crate, make sure we add C++
1808         // mapped types so that C++ users can utilize the auto-destructors available.
1809         for (ty, has_destructor) in libtypes.templates_defined.borrow().iter() {
1810                 write_cpp_wrapper(&mut cpp_header_file, ty, *has_destructor, None);
1811         }
1812         writeln!(cpp_header_file, "}}").unwrap();
1813
1814         header_file.flush().unwrap();
1815         cpp_header_file.flush().unwrap();
1816         derived_templates.flush().unwrap();
1817 }