_ 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::iter::FromIterator;
  26 use std::process;
  27
  28 use proc_macro2::Span;
  29 use quote::format_ident;
  30 use syn::parse_quote;
  31
  32 mod types;
  33 mod blocks;
  34 use types::*;
  35 use blocks::*;
  36
  37 const DEFAULT_IMPORTS: &'static str = "
  38 use alloc::str::FromStr;
  39 use core::ffi::c_void;
  40 use core::convert::Infallible;
  41 use bitcoin::hashes::Hash;
  42 use crate::c_types::*;
  43 #[cfg(feature=\"no-std\")]
  44 use alloc::{vec::Vec, boxed::Box};
  45 ";
  46
  47
  48 /// str.rsplit_once but with an older MSRV
  49 fn rsplit_once<'a>(inp: &'a str, pattern: &str) -> Option<(&'a str, &'a str)> {
  50         let mut iter = inp.rsplitn(2, pattern);
  51         let second_entry = iter.next().unwrap();
  52         Some((iter.next().unwrap(), second_entry))
  53 }
  54
  55 // *************************************
  56 // *** Manually-expanded conversions ***
  57 // *************************************
  58
  59 /// Convert "impl trait_path for for_ty { .. }" for manually-mapped types (ie (de)serialization)
  60 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) {
  61         if let Some(t) = types.maybe_resolve_path(&trait_path, Some(generics)) {
  62                 let for_obj;
  63                 let full_obj_path;
  64                 let mut has_inner = false;
  65                 if let syn::Type::Path(ref p) = for_ty {
  66                         let resolved_path = types.resolve_path(&p.path, Some(generics));
  67                         for_obj = format!("{}", p.path.segments.last().unwrap().ident);
  68                         full_obj_path = format!("crate::{}", resolved_path);
  69                         has_inner = types.c_type_has_inner_from_path(&resolved_path);
  70                 } else {
  71                         // We assume that anything that isn't a Path is somehow a generic that ends up in our
  72                         // derived-types module.
  73                         let mut for_obj_vec = Vec::new();
  74                         types.write_c_type(&mut for_obj_vec, for_ty, Some(generics), false);
  75                         full_obj_path = String::from_utf8(for_obj_vec).unwrap();
  76                         assert!(full_obj_path.starts_with(TypeResolver::generated_container_path()));
  77                         for_obj = full_obj_path[TypeResolver::generated_container_path().len() + 2..].into();
  78                 }
  79
  80                 match &t as &str {
  81                         "lightning::util::ser::Writeable" => {
  82                                 writeln!(w, "#[no_mangle]").unwrap();
  83                                 writeln!(w, "/// Serialize the {} object into a byte array which can be read by {}_read", for_obj, for_obj).unwrap();
  84                                 writeln!(w, "pub extern \"C\" fn {}_write(obj: &{}) -> crate::c_types::derived::CVec_u8Z {{", for_obj, full_obj_path).unwrap();
  85
  86                                 let ref_type: syn::Type = syn::parse_quote!(&#for_ty);
  87                                 assert!(!types.write_from_c_conversion_new_var(w, &format_ident!("obj"), &ref_type, Some(generics)));
  88
  89                                 write!(w, "\tcrate::c_types::serialize_obj(").unwrap();
  90                                 types.write_from_c_conversion_prefix(w, &ref_type, Some(generics));
  91                                 write!(w, "unsafe {{ &*obj }}").unwrap();
  92                                 types.write_from_c_conversion_suffix(w, &ref_type, Some(generics));
  93                                 writeln!(w, ")").unwrap();
  94
  95                                 writeln!(w, "}}").unwrap();
  96                                 if has_inner {
  97                                         writeln!(w, "#[no_mangle]").unwrap();
  98                                         writeln!(w, "pub(crate) extern \"C\" fn {}_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {{", for_obj).unwrap();
  99                                         writeln!(w, "\tcrate::c_types::serialize_obj(unsafe {{ &*(obj as *const native{}) }})", for_obj).unwrap();
 100                                         writeln!(w, "}}").unwrap();
 101                                 }
 102                         },
 103                         "lightning::util::ser::Readable"|"lightning::util::ser::ReadableArgs"|"lightning::util::ser::MaybeReadable" => {
 104                                 // Create the Result<Object, DecodeError> syn::Type
 105                                 let mut res_ty: syn::Type = parse_quote!(Result<#for_ty, ::ln::msgs::DecodeError>);
 106
 107                                 writeln!(w, "#[no_mangle]").unwrap();
 108                                 writeln!(w, "/// Read a {} from a byte array, created by {}_write", for_obj, for_obj).unwrap();
 109                                 write!(w, "pub extern \"C\" fn {}_read(ser: crate::c_types::u8slice", for_obj).unwrap();
 110
 111                                 let mut arg_conv = Vec::new();
 112                                 if t == "lightning::util::ser::ReadableArgs" {
 113                                         assert!(trait_path.leading_colon.is_none());
 114                                         let args_seg = trait_path.segments.iter().last().unwrap();
 115                                         assert_eq!(format!("{}", args_seg.ident), "ReadableArgs");
 116                                         if let syn::PathArguments::AngleBracketed(args) = &args_seg.arguments {
 117                                                 assert_eq!(args.args.len(), 1);
 118                                                 if let syn::GenericArgument::Type(args_ty) = args.args.iter().next().unwrap() {
 119                                                         macro_rules! write_arg_conv {
 120                                                                 ($ty: expr, $arg_name: expr) => {
 121                                                                         write!(w, ", {}: ", $arg_name).unwrap();
 122                                                                         types.write_c_type(w, $ty, Some(generics), false);
 123
 124                                                                         write!(&mut arg_conv, "\t").unwrap();
 125                                                                         if types.write_from_c_conversion_new_var(&mut arg_conv, &format_ident!("{}", $arg_name), &$ty, Some(generics)) {
 126                                                                                 write!(&mut arg_conv, "\n\t").unwrap();
 127                                                                         }
 128
 129                                                                         write!(&mut arg_conv, "let {}_conv = ", $arg_name).unwrap();
 130                                                                         types.write_from_c_conversion_prefix(&mut arg_conv, &$ty, Some(generics));
 131                                                                         write!(&mut arg_conv, "{}", $arg_name).unwrap();
 132                                                                         types.write_from_c_conversion_suffix(&mut arg_conv, &$ty, Some(generics));
 133                                                                         write!(&mut arg_conv, ";\n").unwrap();
 134                                                                 }
 135                                                         }
 136
 137                                                         if let syn::Type::Tuple(tup) = args_ty {
 138                                                                 // Crack open tuples and make them separate arguments instead of
 139                                                                 // converting the full tuple. This makes it substantially easier to
 140                                                                 // reason about things like references in the tuple fields.
 141                                                                 let mut arg_conv_res = Vec::new();
 142                                                                 for (idx, elem) in tup.elems.iter().enumerate() {
 143                                                                         let arg_name = format!("arg_{}", ('a' as u8 + idx as u8) as char);
 144                                                                         write_arg_conv!(elem, arg_name);
 145                                                                         write!(&mut arg_conv_res, "{}_conv{}", arg_name, if idx != tup.elems.len() - 1 { ", " } else { "" }).unwrap();
 146                                                                 }
 147                                                                 writeln!(&mut arg_conv, "\tlet arg_conv = ({});", String::from_utf8(arg_conv_res).unwrap()).unwrap();
 148                                                         } else {
 149                                                                 write_arg_conv!(args_ty, "arg");
 150                                                         }
 151                                                 } else { unreachable!(); }
 152                                         } else { unreachable!(); }
 153                                 } else if t == "lightning::util::ser::MaybeReadable" {
 154                                         res_ty = parse_quote!(Result<Option<#for_ty>, ::ln::msgs::DecodeError>);
 155                                 }
 156                                 write!(w, ") -> ").unwrap();
 157                                 types.write_c_type(w, &res_ty, Some(generics), false);
 158                                 writeln!(w, " {{").unwrap();
 159
 160                                 if t == "lightning::util::ser::ReadableArgs" {
 161                                         w.write(&arg_conv).unwrap();
 162                                 }
 163
 164                                 write!(w, "\tlet res: ").unwrap();
 165                                 // At least in one case we need type annotations here, so provide them.
 166                                 types.write_rust_type(w, Some(generics), &res_ty);
 167
 168                                 if t == "lightning::util::ser::ReadableArgs" {
 169                                         writeln!(w, " = crate::c_types::deserialize_obj_arg(ser, arg_conv);").unwrap();
 170                                 } else if t == "lightning::util::ser::MaybeReadable" {
 171                                         writeln!(w, " = crate::c_types::maybe_deserialize_obj(ser);").unwrap();
 172                                 } else {
 173                                         writeln!(w, " = crate::c_types::deserialize_obj(ser);").unwrap();
 174                                 }
 175                                 write!(w, "\t").unwrap();
 176                                 if types.write_to_c_conversion_new_var(w, &format_ident!("res"), &res_ty, Some(generics), false) {
 177                                         write!(w, "\n\t").unwrap();
 178                                 }
 179                                 types.write_to_c_conversion_inline_prefix(w, &res_ty, Some(generics), false);
 180                                 write!(w, "res").unwrap();
 181                                 types.write_to_c_conversion_inline_suffix(w, &res_ty, Some(generics), false);
 182                                 writeln!(w, "\n}}").unwrap();
 183                         },
 184                         _ => {},
 185                 }
 186         }
 187 }
 188
 189 /// Convert "TraitA : TraitB" to a single function name and return type.
 190 ///
 191 /// This is (obviously) somewhat over-specialized and only useful for TraitB's that only require a
 192 /// single function (eg for serialization).
 193 fn convert_trait_impl_field(trait_path: &str) -> (&'static str, String, &'static str) {
 194         match trait_path {
 195                 "lightning::util::ser::Writeable" => ("Serialize the object into a byte array", "write".to_owned(), "crate::c_types::derived::CVec_u8Z"),
 196                 _ => unimplemented!(),
 197         }
 198 }
 199
 200 /// Companion to convert_trait_impl_field, write an assignment for the function defined by it for
 201 /// `for_obj` which implements the the trait at `trait_path`.
 202 fn write_trait_impl_field_assign<W: std::io::Write>(w: &mut W, trait_path: &str, for_obj: &syn::Ident) {
 203         match trait_path {
 204                 "lightning::util::ser::Writeable" => {
 205                         writeln!(w, "\t\twrite: {}_write_void,", for_obj).unwrap();
 206                 },
 207                 _ => unimplemented!(),
 208         }
 209 }
 210
 211 /// Write out the impl block for a defined trait struct which has a supertrait
 212 fn do_write_impl_trait<W: std::io::Write>(w: &mut W, trait_path: &str, _trait_name: &syn::Ident, for_obj: &str) {
 213         match trait_path {
 214                 "lightning::util::ser::Writeable" => {
 215                         writeln!(w, "impl {} for {} {{", trait_path, for_obj).unwrap();
 216                         writeln!(w, "\tfn write<W: lightning::util::ser::Writer>(&self, w: &mut W) -> Result<(), crate::c_types::io::Error> {{").unwrap();
 217                         writeln!(w, "\t\tlet vec = (self.write)(self.this_arg);").unwrap();
 218                         writeln!(w, "\t\tw.write_all(vec.as_slice())").unwrap();
 219                         writeln!(w, "\t}}\n}}").unwrap();
 220                 },
 221                 _ => panic!(),
 222         }
 223 }
 224
 225 /// Returns true if an instance of the given type must never exist
 226 fn is_type_unconstructable(path: &str) -> bool {
 227         path == "core::convert::Infallible" || path == "crate::c_types::NotConstructable"
 228 }
 229
 230 // *******************************
 231 // *** Per-Type Printing Logic ***
 232 // *******************************
 233
 234 macro_rules! walk_supertraits { ($t: expr, $types: expr, ($( $($pat: pat)|* => $e: expr),*) ) => { {
 235         if $t.colon_token.is_some() {
 236                 for st in $t.supertraits.iter() {
 237                         match st {
 238                                 syn::TypeParamBound::Trait(supertrait) => {
 239                                         if supertrait.paren_token.is_some() || supertrait.lifetimes.is_some() {
 240                                                 unimplemented!();
 241                                         }
 242                                         // First try to resolve path to find in-crate traits, but if that doesn't work
 243                                         // assume its a prelude trait (eg Clone, etc) and just use the single ident.
 244                                         let types_opt: Option<&TypeResolver> = $types;
 245                                         if let Some(types) = types_opt {
 246                                                 if let Some(path) = types.maybe_resolve_path(&supertrait.path, None) {
 247                                                         match (&path as &str, &supertrait.path.segments.iter().last().unwrap().ident) {
 248                                                                 $( $($pat)|* => $e, )*
 249                                                         }
 250                                                         continue;
 251                                                 }
 252                                         }
 253                                         if let Some(ident) = supertrait.path.get_ident() {
 254                                                 match (&format!("{}", ident) as &str, &ident) {
 255                                                         $( $($pat)|* => $e, )*
 256                                                 }
 257                                         } else if types_opt.is_some() {
 258                                                 panic!("Supertrait unresolvable and not single-ident");
 259                                         }
 260                                 },
 261                                 syn::TypeParamBound::Lifetime(_) => unimplemented!(),
 262                         }
 263                 }
 264         }
 265 } } }
 266
 267 macro_rules! get_module_type_resolver {
 268         ($module: expr, $crate_libs: expr, $crate_types: expr) => { {
 269                 let module: &str = &$module;
 270                 let mut module_iter = module.rsplitn(2, "::");
 271                 module_iter.next().unwrap();
 272                 let module = module_iter.next().unwrap();
 273                 let imports = ImportResolver::new(module.splitn(2, "::").next().unwrap(), &$crate_types.lib_ast.dependencies,
 274                                 module, &$crate_types.lib_ast.modules.get(module).unwrap().items);
 275                 TypeResolver::new(module, imports, $crate_types)
 276         } }
 277 }
 278
 279 /// Prints a C-mapped trait object containing a void pointer and a jump table for each function in
 280 /// the original trait.
 281 /// Implements the native Rust trait and relevant parent traits for the new C-mapped trait.
 282 ///
 283 /// Finally, implements Deref<MappedTrait> for MappedTrait which allows its use in types which need
 284 /// a concrete Deref to the Rust trait.
 285 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) {
 286         let trait_name = format!("{}", t.ident);
 287         let implementable;
 288         match export_status(&t.attrs) {
 289                 ExportStatus::Export => { implementable = true; }
 290                 ExportStatus::NotImplementable => { implementable = false; },
 291                 ExportStatus::NoExport|ExportStatus::TestOnly => return,
 292         }
 293         writeln_docs(w, &t.attrs, "");
 294
 295         let mut gen_types = GenericTypes::new(None);
 296
 297         // Add functions which may be required for supertrait implementations.
 298         // Due to borrow checker limitations, we only support one in-crate supertrait here.
 299         let supertrait_name;
 300         let supertrait_resolver;
 301         walk_supertraits!(t, Some(&types), (
 302                 (s, _i) => {
 303                         if let Some(supertrait) = types.crate_types.traits.get(s) {
 304                                 supertrait_name = s.to_string();
 305                                 supertrait_resolver = get_module_type_resolver!(supertrait_name, types.crate_libs, types.crate_types);
 306                                 gen_types.learn_associated_types(&supertrait, &supertrait_resolver);
 307                                 break;
 308                         }
 309                 }
 310         ) );
 311
 312         assert!(gen_types.learn_generics(&t.generics, types));
 313         gen_types.learn_associated_types(&t, types);
 314
 315         writeln!(w, "#[repr(C)]\npub struct {} {{", trait_name).unwrap();
 316         writeln!(w, "\t/// An opaque pointer which is passed to your function implementations as an argument.").unwrap();
 317         writeln!(w, "\t/// This has no meaning in the LDK, and can be NULL or any other value.").unwrap();
 318         writeln!(w, "\tpub this_arg: *mut c_void,").unwrap();
 319         // We store every field's (name, Option<clone_fn>, docs) except this_arg, used in Clone generation
 320         // docs is only set if its a function which should be callable on the object itself in C++
 321         let mut generated_fields = Vec::new();
 322         for item in t.items.iter() {
 323                 match item {
 324                         &syn::TraitItem::Method(ref m) => {
 325                                 match export_status(&m.attrs) {
 326                                         ExportStatus::NoExport => {
 327                                                 // NoExport in this context means we'll hit an unimplemented!() at runtime,
 328                                                 // so bail out.
 329                                                 unimplemented!();
 330                                         },
 331                                         ExportStatus::Export => {},
 332                                         ExportStatus::TestOnly => continue,
 333                                         ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
 334                                 }
 335
 336                                 let mut meth_gen_types = gen_types.push_ctx();
 337                                 assert!(meth_gen_types.learn_generics(&m.sig.generics, types));
 338
 339                                 writeln_fn_docs(w, &m.attrs, "\t", types, Some(&meth_gen_types), m.sig.inputs.iter(), &m.sig.output);
 340
 341                                 if let syn::ReturnType::Type(_, rtype) = &m.sig.output {
 342                                         if let syn::Type::Reference(r) = &**rtype {
 343                                                 // We have to do quite a dance for trait functions which return references
 344                                                 // - they ultimately require us to have a native Rust object stored inside
 345                                                 // our concrete trait to return a reference to. However, users may wish to
 346                                                 // update the value to be returned each time the function is called (or, to
 347                                                 // make C copies of Rust impls equivalent, we have to be able to).
 348                                                 //
 349                                                 // Thus, we store a copy of the C-mapped type (which is just a pointer to
 350                                                 // the Rust type and a flag to indicate whether deallocation needs to
 351                                                 // happen) as well as provide an Option<>al function pointer which is
 352                                                 // called when the trait method is called which allows updating on the fly.
 353                                                 write!(w, "\tpub {}: ", m.sig.ident).unwrap();
 354                                                 generated_fields.push((format!("{}", m.sig.ident), None, None));
 355                                                 types.write_c_type(w, &*r.elem, Some(&meth_gen_types), false);
 356                                                 writeln!(w, ",").unwrap();
 357                                                 writeln!(w, "\t/// Fill in the {} field as a reference to it will be given to Rust after this returns", m.sig.ident).unwrap();
 358                                                 writeln!(w, "\t/// Note that this takes a pointer to this object, not the this_ptr like other methods do").unwrap();
 359                                                 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();
 360                                                 writeln!(w, "\tpub set_{}: Option<extern \"C\" fn(&{})>,", m.sig.ident, trait_name).unwrap();
 361                                                 generated_fields.push((format!("set_{}", m.sig.ident), None, None));
 362                                                 // Note that cbindgen will now generate
 363                                                 // typedef struct Thing {..., set_thing: (const struct Thing*), ...} Thing;
 364                                                 // which does not compile since Thing is not defined before it is used.
 365                                                 writeln!(extra_headers, "struct LDK{};", trait_name).unwrap();
 366                                                 continue;
 367                                         }
 368                                         // Sadly, this currently doesn't do what we want, but it should be easy to get
 369                                         // cbindgen to support it. See https://github.com/eqrion/cbindgen/issues/531
 370                                         writeln!(w, "\t#[must_use]").unwrap();
 371                                 }
 372
 373                                 let mut cpp_docs = Vec::new();
 374                                 writeln_fn_docs(&mut cpp_docs, &m.attrs, "\t * ", types, Some(&meth_gen_types), m.sig.inputs.iter(), &m.sig.output);
 375                                 let docs_string = "\t/**\n".to_owned() + &String::from_utf8(cpp_docs).unwrap().replace("///", "") + "\t */\n";
 376
 377                                 write!(w, "\tpub {}: extern \"C\" fn (", m.sig.ident).unwrap();
 378                                 generated_fields.push((format!("{}", m.sig.ident), None, Some(docs_string)));
 379                                 write_method_params(w, &m.sig, "c_void", types, Some(&meth_gen_types), true, false);
 380                                 writeln!(w, ",").unwrap();
 381                         },
 382                         &syn::TraitItem::Type(_) => {},
 383                         _ => unimplemented!(),
 384                 }
 385         }
 386         // Add functions which may be required for supertrait implementations.
 387         walk_supertraits!(t, Some(&types), (
 388                 ("Clone", _) => {
 389                         writeln!(w, "\t/// Called, if set, after this {} has been cloned into a duplicate object.", trait_name).unwrap();
 390                         writeln!(w, "\t/// The new {} is provided, and should be mutated as needed to perform a", trait_name).unwrap();
 391                         writeln!(w, "\t/// deep copy of the object pointed to by this_arg or avoid any double-freeing.").unwrap();
 392                         writeln!(w, "\tpub cloned: Option<extern \"C\" fn (new_{}: &mut {})>,", trait_name, trait_name).unwrap();
 393                         generated_fields.push(("cloned".to_owned(), None, None));
 394                 },
 395                 ("std::cmp::Eq", _)|("core::cmp::Eq", _) => {
 396                         let eq_docs = "Checks if two objects are equal given this object's this_arg pointer and another object.";
 397                         writeln!(w, "\t/// {}", eq_docs).unwrap();
 398                         writeln!(w, "\tpub eq: extern \"C\" fn (this_arg: *const c_void, other_arg: &{}) -> bool,", trait_name).unwrap();
 399                         generated_fields.push(("eq".to_owned(), None, Some(format!("\t/** {} */\n", eq_docs))));
 400                 },
 401                 ("std::hash::Hash", _)|("core::hash::Hash", _) => {
 402                         let hash_docs_a = "Calculate a succinct non-cryptographic hash for an object given its this_arg pointer.";
 403                         let hash_docs_b = "This is used, for example, for inclusion of this object in a hash map.";
 404                         writeln!(w, "\t/// {}", hash_docs_a).unwrap();
 405                         writeln!(w, "\t/// {}", hash_docs_b).unwrap();
 406                         writeln!(w, "\tpub hash: extern \"C\" fn (this_arg: *const c_void) -> u64,").unwrap();
 407                         generated_fields.push(("hash".to_owned(), None,
 408                                 Some(format!("\t/**\n\t * {}\n\t * {}\n\t */\n", hash_docs_a, hash_docs_b))));
 409                 },
 410                 ("Send", _) => {}, ("Sync", _) => {},
 411                 ("std::fmt::Debug", _)|("core::fmt::Debug", _) => {
 412                         let debug_docs = "Return a human-readable \"debug\" string describing this object";
 413                         writeln!(w, "\t/// {}", debug_docs).unwrap();
 414                         writeln!(w, "\tpub debug_str: extern \"C\" fn (this_arg: *const c_void) -> crate::c_types::Str,").unwrap();
 415                         generated_fields.push(("debug_str".to_owned(), None,
 416                                 Some(format!("\t/**\n\t * {}\n\t */\n", debug_docs))));
 417                 },
 418                 (s, i) => {
 419                         // TODO: Both of the below should expose supertrait methods in C++, but doing so is
 420                         // nontrivial.
 421                         generated_fields.push(if types.crate_types.traits.get(s).is_none() {
 422                                 let (docs, name, ret) = convert_trait_impl_field(s);
 423                                 writeln!(w, "\t/// {}", docs).unwrap();
 424                                 writeln!(w, "\tpub {}: extern \"C\" fn (this_arg: *const c_void) -> {},", name, ret).unwrap();
 425                                 (name, None, None) // Assume clonable
 426                         } else {
 427                                 // For in-crate supertraits, just store a C-mapped copy of the supertrait as a member.
 428                                 writeln!(w, "\t/// Implementation of {} for this object.", i).unwrap();
 429                                 let is_clonable = types.is_clonable(s);
 430                                 writeln!(w, "\tpub {}: crate::{},", i, s).unwrap();
 431                                 (format!("{}", i), if !is_clonable {
 432                                         Some(format!("crate::{}_clone_fields", s))
 433                                 } else { None }, None)
 434                         });
 435                 }
 436         ) );
 437         writeln!(w, "\t/// Frees any resources associated with this object given its this_arg pointer.").unwrap();
 438         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();
 439         writeln!(w, "\tpub free: Option<extern \"C\" fn(this_arg: *mut c_void)>,").unwrap();
 440         generated_fields.push(("free".to_owned(), None, None));
 441         writeln!(w, "}}").unwrap();
 442
 443         macro_rules! impl_trait_for_c {
 444                 ($t: expr, $impl_accessor: expr, $type_resolver: expr) => {
 445                         for item in $t.items.iter() {
 446                                 match item {
 447                                         syn::TraitItem::Method(m) => {
 448                                                 if let ExportStatus::TestOnly = export_status(&m.attrs) { continue; }
 449                                                 if m.sig.constness.is_some() || m.sig.asyncness.is_some() || m.sig.unsafety.is_some() ||
 450                                                                 m.sig.abi.is_some() || m.sig.variadic.is_some() {
 451                                                         panic!("1");
 452                                                 }
 453                                                 let mut meth_gen_types = gen_types.push_ctx();
 454                                                 assert!(meth_gen_types.learn_generics(&m.sig.generics, $type_resolver));
 455                                                 // Note that we do *not* use the method generics when printing "native"
 456                                                 // rust parts - if the method is generic, we need to print a generic
 457                                                 // method.
 458                                                 write!(w, "\tfn {}", m.sig.ident).unwrap();
 459                                                 $type_resolver.write_rust_generic_param(w, Some(&gen_types), m.sig.generics.params.iter());
 460                                                 write!(w, "(").unwrap();
 461                                                 for inp in m.sig.inputs.iter() {
 462                                                         match inp {
 463                                                                 syn::FnArg::Receiver(recv) => {
 464                                                                         if !recv.attrs.is_empty() || recv.reference.is_none() { panic!("2"); }
 465                                                                         write!(w, "&").unwrap();
 466                                                                         if let Some(lft) = &recv.reference.as_ref().unwrap().1 {
 467                                                                                 write!(w, "'{} ", lft.ident).unwrap();
 468                                                                         }
 469                                                                         if recv.mutability.is_some() {
 470                                                                                 write!(w, "mut self").unwrap();
 471                                                                         } else {
 472                                                                                 write!(w, "self").unwrap();
 473                                                                         }
 474                                                                 },
 475                                                                 syn::FnArg::Typed(arg) => {
 476                                                                         if !arg.attrs.is_empty() { panic!("3"); }
 477                                                                         match &*arg.pat {
 478                                                                                 syn::Pat::Ident(ident) => {
 479                                                                                         if !ident.attrs.is_empty() || ident.by_ref.is_some() ||
 480                                                                                                         ident.mutability.is_some() || ident.subpat.is_some() {
 481                                                                                                 panic!("4");
 482                                                                                         }
 483                                                                                         write!(w, ", mut {}{}: ", if $type_resolver.skip_arg(&*arg.ty, Some(&meth_gen_types)) { "_" } else { "" }, ident.ident).unwrap();
 484                                                                                 }
 485                                                                                 _ => panic!("5"),
 486                                                                         }
 487                                                                         $type_resolver.write_rust_type(w, Some(&gen_types), &*arg.ty);
 488                                                                 }
 489                                                         }
 490                                                 }
 491                                                 write!(w, ")").unwrap();
 492                                                 match &m.sig.output {
 493                                                         syn::ReturnType::Type(_, rtype) => {
 494                                                                 write!(w, " -> ").unwrap();
 495                                                                 $type_resolver.write_rust_type(w, Some(&gen_types), &*rtype)
 496                                                         },
 497                                                         _ => {},
 498                                                 }
 499                                                 write!(w, " {{\n\t\t").unwrap();
 500                                                 match export_status(&m.attrs) {
 501                                                         ExportStatus::NoExport => {
 502                                                                 panic!("6");
 503                                                         },
 504                                                         _ => {},
 505                                                 }
 506                                                 if let syn::ReturnType::Type(_, rtype) = &m.sig.output {
 507                                                         if let syn::Type::Reference(r) = &**rtype {
 508                                                                 assert_eq!(m.sig.inputs.len(), 1); // Must only take self!
 509                                                                 writeln!(w, "if let Some(f) = self{}.set_{} {{", $impl_accessor, m.sig.ident).unwrap();
 510                                                                 writeln!(w, "\t\t\t(f)(&self{});", $impl_accessor).unwrap();
 511                                                                 write!(w, "\t\t}}\n\t\t").unwrap();
 512                                                                 $type_resolver.write_from_c_conversion_to_ref_prefix(w, &*r.elem, Some(&meth_gen_types));
 513                                                                 write!(w, "self{}.{}", $impl_accessor, m.sig.ident).unwrap();
 514                                                                 $type_resolver.write_from_c_conversion_to_ref_suffix(w, &*r.elem, Some(&meth_gen_types));
 515                                                                 writeln!(w, "\n\t}}").unwrap();
 516                                                                 continue;
 517                                                         }
 518                                                 }
 519                                                 write_method_var_decl_body(w, &m.sig, "\t", $type_resolver, Some(&meth_gen_types), true);
 520                                                 write!(w, "(self{}.{})(", $impl_accessor, m.sig.ident).unwrap();
 521                                                 let mut args = Vec::new();
 522                                                 write_method_call_params(&mut args, &m.sig, "\t", $type_resolver, Some(&meth_gen_types), "", true);
 523                                                 w.write_all(String::from_utf8(args).unwrap().replace("self", &format!("self{}", $impl_accessor)).as_bytes()).unwrap();
 524
 525                                                 writeln!(w, "\n\t}}").unwrap();
 526                                         },
 527                                         &syn::TraitItem::Type(ref t) => {
 528                                                 if t.default.is_some() || t.generics.lt_token.is_some() { panic!("10"); }
 529                                                 let mut bounds_iter = t.bounds.iter();
 530                                                 loop {
 531                                                         match bounds_iter.next().unwrap() {
 532                                                                 syn::TypeParamBound::Trait(tr) => {
 533                                                                         writeln!(w, "\ttype {} = crate::{};", t.ident, $type_resolver.resolve_path(&tr.path, Some(&gen_types))).unwrap();
 534                                                                         for bound in bounds_iter {
 535                                                                                 if let syn::TypeParamBound::Trait(_) = bound { panic!("11"); }
 536                                                                         }
 537                                                                         break;
 538                                                                 },
 539                                                                 syn::TypeParamBound::Lifetime(_) => {},
 540                                                         }
 541                                                 }
 542                                         },
 543                                         _ => panic!("12"),
 544                                 }
 545                         }
 546                 }
 547         }
 548
 549         writeln!(w, "unsafe impl Send for {} {{}}", trait_name).unwrap();
 550         writeln!(w, "unsafe impl Sync for {} {{}}", trait_name).unwrap();
 551
 552         writeln!(w, "#[no_mangle]").unwrap();
 553         writeln!(w, "pub(crate) extern \"C\" fn {}_clone_fields(orig: &{}) -> {} {{", trait_name, trait_name, trait_name).unwrap();
 554         writeln!(w, "\t{} {{", trait_name).unwrap();
 555         writeln!(w, "\t\tthis_arg: orig.this_arg,").unwrap();
 556         for (field, clone_fn, _) in generated_fields.iter() {
 557                 if let Some(f) = clone_fn {
 558                         // If the field isn't clonable, blindly assume its a trait and hope for the best.
 559                         writeln!(w, "\t\t{}: {}(&orig.{}),", field, f, field).unwrap();
 560                 } else {
 561                         writeln!(w, "\t\t{}: Clone::clone(&orig.{}),", field, field).unwrap();
 562                 }
 563         }
 564         writeln!(w, "\t}}\n}}").unwrap();
 565
 566         // Implement supertraits for the C-mapped struct.
 567         walk_supertraits!(t, Some(&types), (
 568                 ("std::cmp::Eq", _)|("core::cmp::Eq", _) => {
 569                         writeln!(w, "impl core::cmp::Eq for {} {{}}", trait_name).unwrap();
 570                         writeln!(w, "impl core::cmp::PartialEq for {} {{", trait_name).unwrap();
 571                         writeln!(w, "\tfn eq(&self, o: &Self) -> bool {{ (self.eq)(self.this_arg, o) }}\n}}").unwrap();
 572                 },
 573                 ("std::hash::Hash", _)|("core::hash::Hash", _) => {
 574                         writeln!(w, "impl core::hash::Hash for {} {{", trait_name).unwrap();
 575                         writeln!(w, "\tfn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {{ hasher.write_u64((self.hash)(self.this_arg)) }}\n}}").unwrap();
 576                 },
 577                 ("Send", _) => {}, ("Sync", _) => {},
 578                 ("Clone", _) => {
 579                         writeln!(w, "#[no_mangle]").unwrap();
 580                         writeln!(w, "/// Creates a copy of a {}", trait_name).unwrap();
 581                         writeln!(w, "pub extern \"C\" fn {}_clone(orig: &{}) -> {} {{", trait_name, trait_name, trait_name).unwrap();
 582                         writeln!(w, "\tlet mut res = {}_clone_fields(orig);", trait_name).unwrap();
 583                         writeln!(w, "\tif let Some(f) = orig.cloned {{ (f)(&mut res) }};").unwrap();
 584                         writeln!(w, "\tres\n}}").unwrap();
 585                         writeln!(w, "impl Clone for {} {{", trait_name).unwrap();
 586                         writeln!(w, "\tfn clone(&self) -> Self {{").unwrap();
 587                         writeln!(w, "\t\t{}_clone(self)", trait_name).unwrap();
 588                         writeln!(w, "\t}}\n}}").unwrap();
 589                 },
 590                 ("std::fmt::Debug", _)|("core::fmt::Debug", _) => {
 591                         writeln!(w, "impl core::fmt::Debug for {} {{", trait_name).unwrap();
 592                         writeln!(w, "\tfn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {{").unwrap();
 593                         writeln!(w, "\t\tf.write_str((self.debug_str)(self.this_arg).into_str())").unwrap();
 594                         writeln!(w, "\t}}").unwrap();
 595                         writeln!(w, "}}").unwrap();
 596                 },
 597                 (s, i) => {
 598                         if let Some(supertrait) = types.crate_types.traits.get(s) {
 599                                 let resolver = get_module_type_resolver!(s, types.crate_libs, types.crate_types);
 600
 601                                 // Blindly assume that the same imports where `supertrait` is defined are also
 602                                 // imported here. This will almost certainly break at some point, but it should be
 603                                 // a compilation failure when it does so.
 604                                 write!(w, "impl").unwrap();
 605                                 maybe_write_lifetime_generics(w, &supertrait.generics, types);
 606                                 write!(w, " {}", s).unwrap();
 607                                 maybe_write_generics(w, &supertrait.generics, types, false);
 608                                 writeln!(w, " for {} {{", trait_name).unwrap();
 609
 610                                 impl_trait_for_c!(supertrait, format!(".{}", i), &resolver);
 611                                 writeln!(w, "}}").unwrap();
 612                         } else {
 613                                 do_write_impl_trait(w, s, i, &trait_name);
 614                         }
 615                 }
 616         ) );
 617
 618         // Finally, implement the original Rust trait for the newly created mapped trait.
 619         writeln!(w, "\nuse {}::{} as rust{};", types.module_path, t.ident, trait_name).unwrap();
 620         if implementable {
 621                 write!(w, "impl").unwrap();
 622                 maybe_write_lifetime_generics(w, &t.generics, types);
 623                 write!(w, " rust{}", t.ident).unwrap();
 624                 maybe_write_generics(w, &t.generics, types, false);
 625                 writeln!(w, " for {} {{", trait_name).unwrap();
 626                 impl_trait_for_c!(t, "", types);
 627                 writeln!(w, "}}\n").unwrap();
 628                 writeln!(w, "// We're essentially a pointer already, or at least a set of pointers, so allow us to be used").unwrap();
 629                 writeln!(w, "// directly as a Deref trait in higher-level structs:").unwrap();
 630                 writeln!(w, "impl core::ops::Deref for {} {{\n\ttype Target = Self;", trait_name).unwrap();
 631                 writeln!(w, "\tfn deref(&self) -> &Self {{\n\t\tself\n\t}}\n}}").unwrap();
 632         }
 633
 634         writeln!(w, "/// Calls the free function if one is set").unwrap();
 635         writeln!(w, "#[no_mangle]\npub extern \"C\" fn {}_free(this_ptr: {}) {{ }}", trait_name, trait_name).unwrap();
 636         writeln!(w, "impl Drop for {} {{", trait_name).unwrap();
 637         writeln!(w, "\tfn drop(&mut self) {{").unwrap();
 638         writeln!(w, "\t\tif let Some(f) = self.free {{").unwrap();
 639         writeln!(w, "\t\t\tf(self.this_arg);").unwrap();
 640         writeln!(w, "\t\t}}\n\t}}\n}}").unwrap();
 641
 642         write_cpp_wrapper(cpp_headers, &trait_name, true, Some(generated_fields.drain(..)
 643                 .filter_map(|(name, _, docs)| if let Some(docs) = docs { Some((name, docs)) } else { None }).collect()));
 644 }
 645
 646 /// Write out a simple "opaque" type (eg structs) which contain a pointer to the native Rust type
 647 /// and a flag to indicate whether Drop'ing the mapped struct drops the underlying Rust type.
 648 ///
 649 /// Also writes out a _free function and a C++ wrapper which handles calling _free.
 650 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) {
 651         // If we directly read the original type by its original name, cbindgen hits
 652         // https://github.com/eqrion/cbindgen/issues/286 Thus, instead, we import it as a temporary
 653         // name and then reference it by that name, which works around the issue.
 654         write!(w, "\nuse {}::{} as native{}Import;\npub(crate) type native{} = native{}Import", types.module_path, ident, ident, ident, ident).unwrap();
 655         maybe_write_generics(w, &generics, &types, true);
 656         writeln!(w, ";\n").unwrap();
 657         writeln!(extra_headers, "struct native{}Opaque;\ntypedef struct native{}Opaque LDKnative{};", ident, ident, ident).unwrap();
 658         writeln_docs(w, &attrs, "");
 659         writeln!(w, "#[must_use]\n#[repr(C)]\npub struct {} {{", struct_name).unwrap();
 660         writeln!(w, "\t/// A pointer to the opaque Rust object.\n").unwrap();
 661         writeln!(w, "\t/// Nearly everywhere, inner must be non-null, however in places where").unwrap();
 662         writeln!(w, "\t/// the Rust equivalent takes an Option, it may be set to null to indicate None.").unwrap();
 663         writeln!(w, "\tpub inner: *mut native{},", ident).unwrap();
 664         writeln!(w, "\t/// Indicates that this is the only struct which contains the same pointer.\n").unwrap();
 665         writeln!(w, "\t/// Rust functions which take ownership of an object provided via an argument require").unwrap();
 666         writeln!(w, "\t/// this to be true and invalidate the object pointed to by inner.").unwrap();
 667         writeln!(w, "\tpub is_owned: bool,").unwrap();
 668         writeln!(w, "}}\n").unwrap();
 669         writeln!(w, "impl Drop for {} {{\n\tfn drop(&mut self) {{", struct_name).unwrap();
 670         writeln!(w, "\t\tif self.is_owned && !<*mut native{}>::is_null(self.inner) {{", ident).unwrap();
 671         writeln!(w, "\t\t\tlet _ = unsafe {{ Box::from_raw(ObjOps::untweak_ptr(self.inner)) }};\n\t\t}}\n\t}}\n}}").unwrap();
 672         writeln!(w, "/// Frees any resources used by the {}, if is_owned is set and inner is non-NULL.", struct_name).unwrap();
 673         writeln!(w, "#[no_mangle]\npub extern \"C\" fn {}_free(this_obj: {}) {{ }}", struct_name, struct_name).unwrap();
 674         writeln!(w, "#[allow(unused)]").unwrap();
 675         writeln!(w, "/// Used only if an object of this type is returned as a trait impl by a method").unwrap();
 676         writeln!(w, "pub(crate) extern \"C\" fn {}_free_void(this_ptr: *mut c_void) {{", struct_name).unwrap();
 677         writeln!(w, "\tunsafe {{ let _ = Box::from_raw(this_ptr as *mut native{}); }}\n}}", struct_name).unwrap();
 678         writeln!(w, "#[allow(unused)]").unwrap();
 679         writeln!(w, "impl {} {{", struct_name).unwrap();
 680         writeln!(w, "\tpub(crate) fn get_native_ref(&self) -> &'static native{} {{", struct_name).unwrap();
 681         writeln!(w, "\t\tunsafe {{ &*ObjOps::untweak_ptr(self.inner) }}").unwrap();
 682         writeln!(w, "\t}}").unwrap();
 683         writeln!(w, "\tpub(crate) fn get_native_mut_ref(&self) -> &'static mut native{} {{", struct_name).unwrap();
 684         writeln!(w, "\t\tunsafe {{ &mut *ObjOps::untweak_ptr(self.inner) }}").unwrap();
 685         writeln!(w, "\t}}").unwrap();
 686         writeln!(w, "\t/// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy").unwrap();
 687         writeln!(w, "\tpub(crate) fn take_inner(mut self) -> *mut native{} {{", struct_name).unwrap();
 688         writeln!(w, "\t\tassert!(self.is_owned);").unwrap();
 689         writeln!(w, "\t\tlet ret = ObjOps::untweak_ptr(self.inner);").unwrap();
 690         writeln!(w, "\t\tself.inner = core::ptr::null_mut();").unwrap();
 691         writeln!(w, "\t\tret").unwrap();
 692         writeln!(w, "\t}}\n}}").unwrap();
 693
 694         write_cpp_wrapper(cpp_headers, &format!("{}", ident), true, None);
 695 }
 696
 697 /// Writes out all the relevant mappings for a Rust struct, deferring to writeln_opaque to generate
 698 /// the struct itself, and then writing getters and setters for public, understood-type fields and
 699 /// a constructor if every field is public.
 700 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) {
 701         if export_status(&s.attrs) != ExportStatus::Export { return; }
 702
 703         let struct_name = &format!("{}", s.ident);
 704         writeln_opaque(w, &s.ident, struct_name, &s.generics, &s.attrs, types, extra_headers, cpp_headers);
 705
 706         let mut self_path_segs = syn::punctuated::Punctuated::new();
 707         self_path_segs.push(s.ident.clone().into());
 708         let self_path = syn::Path { leading_colon: None, segments: self_path_segs};
 709         let mut gen_types = GenericTypes::new(Some(types.resolve_path(&self_path, None)));
 710         assert!(gen_types.learn_generics(&s.generics, types));
 711
 712         let mut all_fields_settable = true;
 713         macro_rules! define_field {
 714                 ($new_name: expr, $real_name: expr, $field: expr) => {
 715                         if let syn::Visibility::Public(_) = $field.vis {
 716                                 let export = export_status(&$field.attrs);
 717                                 match export {
 718                                         ExportStatus::Export => {},
 719                                         ExportStatus::NoExport|ExportStatus::TestOnly => {
 720                                                 all_fields_settable = false;
 721                                                 continue
 722                                         },
 723                                         ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
 724                                 }
 725
 726                                 if let Some(ref_type) = types.create_ownable_reference(&$field.ty, Some(&gen_types)) {
 727                                         if types.understood_c_type(&ref_type, Some(&gen_types)) {
 728                                                 writeln_arg_docs(w, &$field.attrs, "", types, Some(&gen_types), vec![].drain(..), Some(&ref_type));
 729                                                 write!(w, "#[no_mangle]\npub extern \"C\" fn {}_get_{}(this_ptr: &{}) -> ", struct_name, $new_name, struct_name).unwrap();
 730                                                 types.write_c_type(w, &ref_type, Some(&gen_types), true);
 731                                                 write!(w, " {{\n\tlet mut inner_val = &mut this_ptr.get_native_mut_ref().{};\n\t", $real_name).unwrap();
 732                                                 let local_var = types.write_to_c_conversion_from_ownable_ref_new_var(w, &format_ident!("inner_val"), &ref_type, Some(&gen_types));
 733                                                 if local_var { write!(w, "\n\t").unwrap(); }
 734                                                 types.write_to_c_conversion_inline_prefix(w, &ref_type, Some(&gen_types), true);
 735                                                 write!(w, "inner_val").unwrap();
 736                                                 types.write_to_c_conversion_inline_suffix(w, &ref_type, Some(&gen_types), true);
 737                                                 writeln!(w, "\n}}").unwrap();
 738                                         }
 739                                 }
 740
 741                                 if types.understood_c_type(&$field.ty, Some(&gen_types)) {
 742                                         writeln_arg_docs(w, &$field.attrs, "", types, Some(&gen_types), vec![("val".to_owned(), &$field.ty)].drain(..), None);
 743                                         write!(w, "#[no_mangle]\npub extern \"C\" fn {}_set_{}(this_ptr: &mut {}, mut val: ", struct_name, $new_name, struct_name).unwrap();
 744                                         types.write_c_type(w, &$field.ty, Some(&gen_types), false);
 745                                         write!(w, ") {{\n\t").unwrap();
 746                                         let local_var = types.write_from_c_conversion_new_var(w, &format_ident!("val"), &$field.ty, Some(&gen_types));
 747                                         if local_var { write!(w, "\n\t").unwrap(); }
 748                                         write!(w, "unsafe {{ &mut *ObjOps::untweak_ptr(this_ptr.inner) }}.{} = ", $real_name).unwrap();
 749                                         types.write_from_c_conversion_prefix(w, &$field.ty, Some(&gen_types));
 750                                         write!(w, "val").unwrap();
 751                                         types.write_from_c_conversion_suffix(w, &$field.ty, Some(&gen_types));
 752                                         writeln!(w, ";\n}}").unwrap();
 753                                 } else { all_fields_settable = false; }
 754                         } else { all_fields_settable = false; }
 755                 }
 756         }
 757
 758         match &s.fields {
 759                 syn::Fields::Named(fields) => {
 760                         for field in fields.named.iter() {
 761                                 if let Some(ident) = &field.ident {
 762                                         define_field!(ident, ident, field);
 763                                 } else { all_fields_settable = false; }
 764                         }
 765                 }
 766                 syn::Fields::Unnamed(fields) => {
 767                         for (idx, field) in fields.unnamed.iter().enumerate() {
 768                                 define_field!(('a' as u8 + idx as u8) as char, ('0' as u8 + idx as u8) as char, field);
 769                         }
 770                 }
 771                 _ => unimplemented!()
 772         }
 773
 774         if all_fields_settable {
 775                 // Build a constructor!
 776                 writeln!(w, "/// Constructs a new {} given each field", struct_name).unwrap();
 777                 write!(w, "#[must_use]\n#[no_mangle]\npub extern \"C\" fn {}_new(", struct_name).unwrap();
 778
 779                 match &s.fields {
 780                         syn::Fields::Named(fields) => {
 781                                 for (idx, field) in fields.named.iter().enumerate() {
 782                                         if idx != 0 { write!(w, ", ").unwrap(); }
 783                                         write!(w, "mut {}_arg: ", field.ident.as_ref().unwrap()).unwrap();
 784                                         types.write_c_type(w, &field.ty, Some(&gen_types), false);
 785                                 }
 786                         }
 787                         syn::Fields::Unnamed(fields) => {
 788                                 for (idx, field) in fields.unnamed.iter().enumerate() {
 789                                         if idx != 0 { write!(w, ", ").unwrap(); }
 790                                         write!(w, "mut {}_arg: ", ('a' as u8 + idx as u8) as char).unwrap();
 791                                         types.write_c_type(w, &field.ty, Some(&gen_types), false);
 792                                 }
 793                         }
 794                         _ => unreachable!()
 795                 }
 796                 write!(w, ") -> {} {{\n\t", struct_name).unwrap();
 797                 match &s.fields {
 798                         syn::Fields::Named(fields) => {
 799                                 for field in fields.named.iter() {
 800                                         let field_ident = format_ident!("{}_arg", field.ident.as_ref().unwrap());
 801                                         if types.write_from_c_conversion_new_var(w, &field_ident, &field.ty, Some(&gen_types)) {
 802                                                 write!(w, "\n\t").unwrap();
 803                                         }
 804                                 }
 805                         },
 806                         syn::Fields::Unnamed(fields) => {
 807                                 for (idx, field) in fields.unnamed.iter().enumerate() {
 808                                         let field_ident = format_ident!("{}_arg", ('a' as u8 + idx as u8) as char);
 809                                         if types.write_from_c_conversion_new_var(w, &field_ident, &field.ty, Some(&gen_types)) {
 810                                                 write!(w, "\n\t").unwrap();
 811                                         }
 812                                 }
 813                         },
 814                         _ => unreachable!()
 815                 }
 816                 write!(w, "{} {{ inner: ObjOps::heap_alloc(", struct_name).unwrap();
 817                 match &s.fields {
 818                         syn::Fields::Named(fields) => {
 819                                 writeln!(w, "native{} {{", s.ident).unwrap();
 820                                 for field in fields.named.iter() {
 821                                         write!(w, "\t\t{}: ", field.ident.as_ref().unwrap()).unwrap();
 822                                         types.write_from_c_conversion_prefix(w, &field.ty, Some(&gen_types));
 823                                         write!(w, "{}_arg", field.ident.as_ref().unwrap()).unwrap();
 824                                         types.write_from_c_conversion_suffix(w, &field.ty, Some(&gen_types));
 825                                         writeln!(w, ",").unwrap();
 826                                 }
 827                                 write!(w, "\t}}").unwrap();
 828                         },
 829                         syn::Fields::Unnamed(fields) => {
 830                                 assert!(s.generics.lt_token.is_none());
 831                                 writeln!(w, "{} (", types.maybe_resolve_ident(&s.ident).unwrap()).unwrap();
 832                                 for (idx, field) in fields.unnamed.iter().enumerate() {
 833                                         write!(w, "\t\t").unwrap();
 834                                         types.write_from_c_conversion_prefix(w, &field.ty, Some(&gen_types));
 835                                         write!(w, "{}_arg", ('a' as u8 + idx as u8) as char).unwrap();
 836                                         types.write_from_c_conversion_suffix(w, &field.ty, Some(&gen_types));
 837                                         writeln!(w, ",").unwrap();
 838                                 }
 839                                 write!(w, "\t)").unwrap();
 840                         },
 841                         _ => unreachable!()
 842                 }
 843                 writeln!(w, "), is_owned: true }}\n}}").unwrap();
 844         }
 845 }
 846
 847 /// Prints a relevant conversion for impl *
 848 ///
 849 /// For simple impl Struct {}s, this just outputs the wrapper functions as Struct_fn_name() { .. }.
 850 ///
 851 /// For impl Trait for Struct{}s, this non-exported generates wrapper functions as
 852 /// Trait_Struct_fn_name and a Struct_as_Trait(&struct) -> Trait function which returns a populated
 853 /// Trait struct containing a pointer to the passed struct's inner field and the wrapper functions.
 854 ///
 855 /// A few non-crate Traits are hard-coded including Default.
 856 fn writeln_impl<W: std::io::Write>(w: &mut W, i: &syn::ItemImpl, types: &mut TypeResolver) {
 857         match export_status(&i.attrs) {
 858                 ExportStatus::Export => {},
 859                 ExportStatus::NoExport|ExportStatus::TestOnly => return,
 860                 ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
 861         }
 862
 863         if let syn::Type::Tuple(_) = &*i.self_ty {
 864                 if types.understood_c_type(&*i.self_ty, None) {
 865                         let mut gen_types = GenericTypes::new(None);
 866                         if !gen_types.learn_generics(&i.generics, types) {
 867                                 eprintln!("Not implementing anything for `impl (..)` due to not understood generics");
 868                                 return;
 869                         }
 870
 871                         if i.defaultness.is_some() || i.unsafety.is_some() { unimplemented!(); }
 872                         if let Some(trait_path) = i.trait_.as_ref() {
 873                                 if trait_path.0.is_some() { unimplemented!(); }
 874                                 if types.understood_c_path(&trait_path.1) {
 875                                         eprintln!("Not implementing anything for `impl Trait for (..)` - we only support manual defines");
 876                                         return;
 877                                 } else {
 878                                         // Just do a manual implementation:
 879                                         maybe_convert_trait_impl(w, &trait_path.1, &*i.self_ty, types, &gen_types);
 880                                 }
 881                         } else {
 882                                 eprintln!("Not implementing anything for plain `impl (..)` block - we only support `impl Trait for (..)` blocks");
 883                                 return;
 884                         }
 885                 }
 886                 return;
 887         }
 888         if let &syn::Type::Path(ref p) = &*i.self_ty {
 889                 if p.qself.is_some() { unimplemented!(); }
 890                 let ident = &p.path.segments.last().unwrap().ident;
 891                 if let Some(resolved_path) = types.maybe_resolve_path(&p.path, None) {
 892                         if types.crate_types.opaques.contains_key(&resolved_path) || types.crate_types.mirrored_enums.contains_key(&resolved_path) ||
 893                                 // At least for core::infallible::Infallible we need to support mapping an
 894                                 // out-of-crate trait implementation.
 895                                 (types.understood_c_path(&p.path) && first_seg_is_stdlib(resolved_path.split("::").next().unwrap())) {
 896                                 if !types.understood_c_path(&p.path) {
 897                                         eprintln!("Not implementing anything for impl {} as the type is not understood (probably C-not exported)", ident);
 898                                         return;
 899                                 }
 900
 901                                 let mut gen_types = GenericTypes::new(Some(resolved_path.clone()));
 902                                 if !gen_types.learn_generics(&i.generics, types) {
 903                                         eprintln!("Not implementing anything for impl {} due to not understood generics", ident);
 904                                         return;
 905                                 }
 906
 907                                 if i.defaultness.is_some() || i.unsafety.is_some() { unimplemented!(); }
 908                                 if let Some(trait_path) = i.trait_.as_ref() {
 909                                         if trait_path.0.is_some() { unimplemented!(); }
 910                                         if types.understood_c_path(&trait_path.1) {
 911                                                 let full_trait_path = types.resolve_path(&trait_path.1, None);
 912                                                 let trait_obj = *types.crate_types.traits.get(&full_trait_path).unwrap();
 913
 914                                                 let supertrait_name;
 915                                                 let supertrait_resolver;
 916                                                 walk_supertraits!(trait_obj, Some(&types), (
 917                                                         (s, _i) => {
 918                                                                 if let Some(supertrait) = types.crate_types.traits.get(s) {
 919                                                                         supertrait_name = s.to_string();
 920                                                                         supertrait_resolver = get_module_type_resolver!(supertrait_name, types.crate_libs, types.crate_types);
 921                                                                         gen_types.learn_associated_types(&supertrait, &supertrait_resolver);
 922                                                                         break;
 923                                                                 }
 924                                                         }
 925                                                 ) );
 926                                                 // We learn the associated types maping from the original trait object.
 927                                                 // That's great, except that they are unresolved idents, so if we learn
 928                                                 // mappings from a trai defined in a different file, we may mis-resolve or
 929                                                 // fail to resolve the mapped types. Thus, we have to construct a new
 930                                                 // resolver for the module that the trait was defined in here first.
 931                                                 let trait_resolver = get_module_type_resolver!(full_trait_path, types.crate_libs, types.crate_types);
 932                                                 gen_types.learn_associated_types(trait_obj, &trait_resolver);
 933                                                 let mut impl_associated_types = HashMap::new();
 934                                                 for item in i.items.iter() {
 935                                                         match item {
 936                                                                 syn::ImplItem::Type(t) => {
 937                                                                         if let syn::Type::Path(p) = &t.ty {
 938                                                                                 if let Some(id) = single_ident_generic_path_to_ident(&p.path) {
 939                                                                                         impl_associated_types.insert(&t.ident, id);
 940                                                                                 }
 941                                                                         }
 942                                                                 },
 943                                                                 _ => {},
 944                                                         }
 945                                                 }
 946
 947                                                 let export = export_status(&trait_obj.attrs);
 948                                                 match export {
 949                                                         ExportStatus::Export|ExportStatus::NotImplementable => {},
 950                                                         ExportStatus::NoExport|ExportStatus::TestOnly => return,
 951                                                 }
 952
 953                                                 // For cases where we have a concrete native object which implements a
 954                                                 // trait and need to return the C-mapped version of the trait, provide a
 955                                                 // From<> implementation which does all the work to ensure free is handled
 956                                                 // properly. This way we can call this method from deep in the
 957                                                 // type-conversion logic without actually knowing the concrete native type.
 958                                                 if !resolved_path.starts_with(types.module_path) {
 959                                                         if !first_seg_is_stdlib(resolved_path.split("::").next().unwrap()) {
 960                                                                 writeln!(w, "use crate::{}::native{} as native{};", resolved_path.rsplitn(2, "::").skip(1).next().unwrap(), ident, ident).unwrap();
 961                                                                 writeln!(w, "use crate::{};", resolved_path).unwrap();
 962                                                                 writeln!(w, "use crate::{}_free_void;", resolved_path).unwrap();
 963                                                         } else {
 964                                                                 writeln!(w, "use {} as native{};", resolved_path, ident).unwrap();
 965                                                         }
 966                                                 }
 967                                                 writeln!(w, "impl From<native{}> for crate::{} {{", ident, full_trait_path).unwrap();
 968                                                 writeln!(w, "\tfn from(obj: native{}) -> Self {{", ident).unwrap();
 969                                                 if is_type_unconstructable(&resolved_path) {
 970                                                         writeln!(w, "\t\tunreachable!();").unwrap();
 971                                                 } else {
 972                                                         writeln!(w, "\t\tlet mut rust_obj = {} {{ inner: ObjOps::heap_alloc(obj), is_owned: true }};", ident).unwrap();
 973                                                         writeln!(w, "\t\tlet mut ret = {}_as_{}(&rust_obj);", ident, trait_obj.ident).unwrap();
 974                                                         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();
 975                                                         writeln!(w, "\t\trust_obj.inner = core::ptr::null_mut();").unwrap();
 976                                                         writeln!(w, "\t\tret.free = Some({}_free_void);", ident).unwrap();
 977                                                         writeln!(w, "\t\tret").unwrap();
 978                                                 }
 979                                                 writeln!(w, "\t}}\n}}").unwrap();
 980                                                 if is_type_unconstructable(&resolved_path) {
 981                                                         // We don't bother with Struct_as_Trait conversion for types which must
 982                                                         // never be instantiated, so just return early.
 983                                                         return;
 984                                                 }
 985
 986                                                 writeln!(w, "/// Constructs a new {} which calls the relevant methods on this_arg.", trait_obj.ident).unwrap();
 987                                                 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();
 988                                                 write!(w, "#[no_mangle]\npub extern \"C\" fn {}_as_{}(this_arg: &{}) -> crate::{} {{\n", ident, trait_obj.ident, ident, full_trait_path).unwrap();
 989                                                 writeln!(w, "\tcrate::{} {{", full_trait_path).unwrap();
 990                                                 writeln!(w, "\t\tthis_arg: unsafe {{ ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void }},").unwrap();
 991                                                 writeln!(w, "\t\tfree: None,").unwrap();
 992
 993                                                 macro_rules! write_meth {
 994                                                         ($m: expr, $trait: expr, $indent: expr) => {
 995                                                                 let trait_method = $trait.items.iter().filter_map(|item| {
 996                                                                         if let syn::TraitItem::Method(t_m) = item { Some(t_m) } else { None }
 997                                                                 }).find(|trait_meth| trait_meth.sig.ident == $m.sig.ident).unwrap();
 998                                                                 match export_status(&trait_method.attrs) {
 999                                                                         ExportStatus::Export => {},
1000                                                                         ExportStatus::NoExport => {
1001                                                                                 write!(w, "{}\t\t//XXX: Need to export {}\n", $indent, $m.sig.ident).unwrap();
1002                                                                                 continue;
1003                                                                         },
1004                                                                         ExportStatus::TestOnly => continue,
1005                                                                         ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
1006                                                                 }
1007
1008                                                                 let mut printed = false;
1009                                                                 if let syn::ReturnType::Type(_, rtype) = &$m.sig.output {
1010                                                                         if let syn::Type::Reference(r) = &**rtype {
1011                                                                                 write!(w, "\n\t\t{}{}: ", $indent, $m.sig.ident).unwrap();
1012                                                                                 types.write_empty_rust_val(Some(&gen_types), w, &*r.elem);
1013                                                                                 writeln!(w, ",\n{}\t\tset_{}: Some({}_{}_set_{}),", $indent, $m.sig.ident, ident, $trait.ident, $m.sig.ident).unwrap();
1014                                                                                 printed = true;
1015                                                                         }
1016                                                                 }
1017                                                                 if !printed {
1018                                                                         write!(w, "{}\t\t{}: {}_{}_{},\n", $indent, $m.sig.ident, ident, $trait.ident, $m.sig.ident).unwrap();
1019                                                                 }
1020                                                         }
1021                                                 }
1022                                                 for item in trait_obj.items.iter() {
1023                                                         match item {
1024                                                                 syn::TraitItem::Method(m) => {
1025                                                                         write_meth!(m, trait_obj, "");
1026                                                                 },
1027                                                                 _ => {},
1028                                                         }
1029                                                 }
1030                                                 let mut requires_clone = false;
1031                                                 walk_supertraits!(trait_obj, Some(&types), (
1032                                                         ("Clone", _) => {
1033                                                                 requires_clone = true;
1034                                                                 writeln!(w, "\t\tcloned: Some({}_{}_cloned),", trait_obj.ident, ident).unwrap();
1035                                                         },
1036                                                         ("Sync", _) => {}, ("Send", _) => {},
1037                                                         ("std::marker::Sync", _) => {}, ("std::marker::Send", _) => {},
1038                                                         ("core::fmt::Debug", _) => {},
1039                                                         (s, t) => {
1040                                                                 if let Some(supertrait_obj) = types.crate_types.traits.get(s) {
1041                                                                         writeln!(w, "\t\t{}: crate::{} {{", t, s).unwrap();
1042                                                                         writeln!(w, "\t\t\tthis_arg: unsafe {{ ObjOps::untweak_ptr((*this_arg).inner) as *mut c_void }},").unwrap();
1043                                                                         writeln!(w, "\t\t\tfree: None,").unwrap();
1044                                                                         for item in supertrait_obj.items.iter() {
1045                                                                                 match item {
1046                                                                                         syn::TraitItem::Method(m) => {
1047                                                                                                 write_meth!(m, supertrait_obj, "\t");
1048                                                                                         },
1049                                                                                         _ => {},
1050                                                                                 }
1051                                                                         }
1052                                                                         write!(w, "\t\t}},\n").unwrap();
1053                                                                 } else {
1054                                                                         write_trait_impl_field_assign(w, s, ident);
1055                                                                 }
1056                                                         }
1057                                                 ) );
1058                                                 writeln!(w, "\t}}\n}}\n").unwrap();
1059
1060                                                 macro_rules! impl_meth {
1061                                                         ($m: expr, $trait_meth: expr, $trait_path: expr, $trait: expr, $indent: expr, $types: expr) => {
1062                                                                 let trait_method = $trait.items.iter().filter_map(|item| {
1063                                                                         if let syn::TraitItem::Method(t_m) = item { Some(t_m) } else { None }
1064                                                                 }).find(|trait_meth| trait_meth.sig.ident == $m.sig.ident).unwrap();
1065                                                                 match export_status(&trait_method.attrs) {
1066                                                                         ExportStatus::Export => {},
1067                                                                         ExportStatus::NoExport|ExportStatus::TestOnly => continue,
1068                                                                         ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
1069                                                                 }
1070
1071                                                                 if let syn::ReturnType::Type(_, _) = &$m.sig.output {
1072                                                                         writeln!(w, "#[must_use]").unwrap();
1073                                                                 }
1074                                                                 write!(w, "extern \"C\" fn {}_{}_{}(", ident, $trait.ident, $m.sig.ident).unwrap();
1075                                                                 let mut meth_gen_types = gen_types.push_ctx();
1076                                                                 assert!(meth_gen_types.learn_generics(&$m.sig.generics, $types));
1077                                                                 let mut uncallable_function = false;
1078                                                                 for inp in $m.sig.inputs.iter() {
1079                                                                         match inp {
1080                                                                                 syn::FnArg::Typed(arg) => {
1081                                                                                         if $types.skip_arg(&*arg.ty, Some(&meth_gen_types)) { continue; }
1082                                                                                         let mut c_type = Vec::new();
1083                                                                                         $types.write_c_type(&mut c_type, &*arg.ty, Some(&meth_gen_types), false);
1084                                                                                         if is_type_unconstructable(&String::from_utf8(c_type).unwrap()) {
1085                                                                                                 uncallable_function = true;
1086                                                                                         }
1087                                                                                 }
1088                                                                                 _ => {}
1089                                                                         }
1090                                                                 }
1091                                                                 if uncallable_function {
1092                                                                         let mut trait_resolver = get_module_type_resolver!(full_trait_path, $types.crate_libs, $types.crate_types);
1093                                                                         write_method_params(w, &$trait_meth.sig, "c_void", &mut trait_resolver, Some(&meth_gen_types), true, true);
1094                                                                 } else {
1095                                                                         write_method_params(w, &$m.sig, "c_void", $types, Some(&meth_gen_types), true, true);
1096                                                                 }
1097                                                                 write!(w, " {{\n\t").unwrap();
1098                                                                 if uncallable_function {
1099                                                                         write!(w, "unreachable!();").unwrap();
1100                                                                 } else {
1101                                                                         write_method_var_decl_body(w, &$m.sig, "", $types, Some(&meth_gen_types), false);
1102                                                                         let mut takes_self = false;
1103                                                                         for inp in $m.sig.inputs.iter() {
1104                                                                                 if let syn::FnArg::Receiver(_) = inp {
1105                                                                                         takes_self = true;
1106                                                                                 }
1107                                                                         }
1108
1109                                                                         let mut t_gen_args = String::new();
1110                                                                         for (idx, _) in $trait.generics.params.iter().enumerate() {
1111                                                                                 if idx != 0 { t_gen_args += ", " };
1112                                                                                 t_gen_args += "_"
1113                                                                         }
1114                                                                         if takes_self {
1115                                                                                 write!(w, "<native{} as {}<{}>>::{}(unsafe {{ &mut *(this_arg as *mut native{}) }}, ", ident, $trait_path, t_gen_args, $m.sig.ident, ident).unwrap();
1116                                                                         } else {
1117                                                                                 write!(w, "<native{} as {}<{}>>::{}(", ident, $trait_path, t_gen_args, $m.sig.ident).unwrap();
1118                                                                         }
1119
1120                                                                         let mut real_type = "".to_string();
1121                                                                         match &$m.sig.output {
1122                                                                                 syn::ReturnType::Type(_, rtype) => {
1123                                                                                         if let Some(mut remaining_path) = first_seg_self(&*rtype) {
1124                                                                                                 if let Some(associated_seg) = get_single_remaining_path_seg(&mut remaining_path) {
1125                                                                                                         real_type = format!("{}", impl_associated_types.get(associated_seg).unwrap());
1126                                                                                                 }
1127                                                                                         }
1128                                                                                 },
1129                                                                                 _ => {},
1130                                                                         }
1131                                                                         write_method_call_params(w, &$m.sig, "", $types, Some(&meth_gen_types), &real_type, false);
1132                                                                 }
1133                                                                 write!(w, "\n}}\n").unwrap();
1134                                                                 if let syn::ReturnType::Type(_, rtype) = &$m.sig.output {
1135                                                                         if let syn::Type::Reference(r) = &**rtype {
1136                                                                                 assert_eq!($m.sig.inputs.len(), 1); // Must only take self
1137                                                                                 writeln!(w, "extern \"C\" fn {}_{}_set_{}(trait_self_arg: &{}) {{", ident, $trait.ident, $m.sig.ident, $trait.ident).unwrap();
1138                                                                                 writeln!(w, "\t// This is a bit race-y in the general case, but for our specific use-cases today, we're safe").unwrap();
1139                                                                                 writeln!(w, "\t// Specifically, we must ensure that the first time we're called it can never be in parallel").unwrap();
1140                                                                                 write!(w, "\tif ").unwrap();
1141                                                                                 $types.write_empty_rust_val_check(Some(&meth_gen_types), w, &*r.elem, &format!("trait_self_arg.{}", $m.sig.ident));
1142                                                                                 writeln!(w, " {{").unwrap();
1143                                                                                 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();
1144                                                                                 writeln!(w, "\t}}").unwrap();
1145                                                                                 writeln!(w, "}}").unwrap();
1146                                                                         }
1147                                                                 }
1148                                                         }
1149                                                 }
1150
1151                                                 'impl_item_loop: for trait_item in trait_obj.items.iter() {
1152                                                         match trait_item {
1153                                                                 syn::TraitItem::Method(meth) => {
1154                                                                         for item in i.items.iter() {
1155                                                                                 match item {
1156                                                                                         syn::ImplItem::Method(m) => {
1157                                                                                                 if meth.sig.ident == m.sig.ident {
1158                                                                                                         impl_meth!(m, meth, full_trait_path, trait_obj, "", types);
1159                                                                                                         continue 'impl_item_loop;
1160                                                                                                 }
1161                                                                                         },
1162                                                                                         syn::ImplItem::Type(_) => {},
1163                                                                                         _ => unimplemented!(),
1164                                                                                 }
1165                                                                         }
1166                                                                         assert!(meth.default.is_some());
1167                                                                         let old_gen_types = gen_types;
1168                                                                         gen_types = GenericTypes::new(Some(resolved_path.clone()));
1169                                                                         let mut trait_resolver = get_module_type_resolver!(full_trait_path, types.crate_libs, types.crate_types);
1170                                                                         impl_meth!(meth, meth, full_trait_path, trait_obj, "", &mut trait_resolver);
1171                                                                         gen_types = old_gen_types;
1172                                                                 },
1173                                                                 _ => {},
1174                                                         }
1175                                                 }
1176                                                 if requires_clone {
1177                                                         writeln!(w, "extern \"C\" fn {}_{}_cloned(new_obj: &mut crate::{}) {{", trait_obj.ident, ident, full_trait_path).unwrap();
1178                                                         writeln!(w, "\tnew_obj.this_arg = {}_clone_void(new_obj.this_arg);", ident).unwrap();
1179                                                         writeln!(w, "\tnew_obj.free = Some({}_free_void);", ident).unwrap();
1180                                                         walk_supertraits!(trait_obj, Some(&types), (
1181                                                                 (s, t) => {
1182                                                                         if types.crate_types.traits.get(s).is_some() {
1183                                                                                 assert!(!types.is_clonable(s)); // We don't currently support cloning with a clonable supertrait
1184                                                                                 writeln!(w, "\tnew_obj.{}.this_arg = new_obj.this_arg;", t).unwrap();
1185                                                                                 writeln!(w, "\tnew_obj.{}.free = None;", t).unwrap();
1186                                                                         }
1187                                                                 }
1188                                                         ) );
1189                                                         writeln!(w, "}}").unwrap();
1190                                                 }
1191                                                 write!(w, "\n").unwrap();
1192                                                 return;
1193                                         }
1194                                         if is_type_unconstructable(&resolved_path) {
1195                                                 // Don't bother exposing trait implementations for objects which cannot be
1196                                                 // instantiated.
1197                                                 return;
1198                                         }
1199                                         if path_matches_nongeneric(&trait_path.1, &["From"]) {
1200                                         } else if path_matches_nongeneric(&trait_path.1, &["Default"]) {
1201                                                 writeln!(w, "/// Creates a \"default\" {}. See struct and individual field documentaiton for details on which values are used.", ident).unwrap();
1202                                                 write!(w, "#[must_use]\n#[no_mangle]\npub extern \"C\" fn {}_default() -> {} {{\n", ident, ident).unwrap();
1203                                                 write!(w, "\t{} {{ inner: ObjOps::heap_alloc(Default::default()), is_owned: true }}\n", ident).unwrap();
1204                                                 write!(w, "}}\n").unwrap();
1205                                         } else if path_matches_nongeneric(&trait_path.1, &["core", "cmp", "PartialEq"]) {
1206                                         } else if path_matches_nongeneric(&trait_path.1, &["core", "cmp", "Eq"]) {
1207                                                 writeln!(w, "/// Checks if two {}s contain equal inner contents.", ident).unwrap();
1208                                                 writeln!(w, "/// This ignores pointers and is_owned flags and looks at the values in fields.").unwrap();
1209                                                 if types.c_type_has_inner_from_path(&resolved_path) {
1210                                                         writeln!(w, "/// Two objects with NULL inner values will be considered \"equal\" here.").unwrap();
1211                                                 }
1212                                                 write!(w, "#[no_mangle]\npub extern \"C\" fn {}_eq(a: &{}, b: &{}) -> bool {{\n", ident, ident, ident).unwrap();
1213                                                 if types.c_type_has_inner_from_path(&resolved_path) {
1214                                                         write!(w, "\tif a.inner == b.inner {{ return true; }}\n").unwrap();
1215                                                         write!(w, "\tif a.inner.is_null() || b.inner.is_null() {{ return false; }}\n").unwrap();
1216                                                 }
1217
1218                                                 let path = &p.path;
1219                                                 let ref_type: syn::Type = syn::parse_quote!(&#path);
1220                                                 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");
1221
1222                                                 write!(w, "\tif ").unwrap();
1223                                                 types.write_from_c_conversion_prefix(w, &ref_type, Some(&gen_types));
1224                                                 write!(w, "a").unwrap();
1225                                                 types.write_from_c_conversion_suffix(w, &ref_type, Some(&gen_types));
1226                                                 write!(w, " == ").unwrap();
1227                                                 types.write_from_c_conversion_prefix(w, &ref_type, Some(&gen_types));
1228                                                 write!(w, "b").unwrap();
1229                                                 types.write_from_c_conversion_suffix(w, &ref_type, Some(&gen_types));
1230
1231                                                 writeln!(w, " {{ true }} else {{ false }}\n}}").unwrap();
1232                                         } else if path_matches_nongeneric(&trait_path.1, &["core", "hash", "Hash"]) {
1233                                                 writeln!(w, "/// Checks if two {}s contain equal inner contents.", ident).unwrap();
1234                                                 write!(w, "#[no_mangle]\npub extern \"C\" fn {}_hash(o: &{}) -> u64 {{\n", ident, ident).unwrap();
1235                                                 if types.c_type_has_inner_from_path(&resolved_path) {
1236                                                         write!(w, "\tif o.inner.is_null() {{ return 0; }}\n").unwrap();
1237                                                 }
1238
1239                                                 let path = &p.path;
1240                                                 let ref_type: syn::Type = syn::parse_quote!(&#path);
1241                                                 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");
1242
1243                                                 writeln!(w, "\t// Note that we'd love to use alloc::collections::hash_map::DefaultHasher but it's not in core").unwrap();
1244                                                 writeln!(w, "\t#[allow(deprecated)]").unwrap();
1245                                                 writeln!(w, "\tlet mut hasher = core::hash::SipHasher::new();").unwrap();
1246                                                 write!(w, "\tcore::hash::Hash::hash(").unwrap();
1247                                                 types.write_from_c_conversion_prefix(w, &ref_type, Some(&gen_types));
1248                                                 write!(w, "o").unwrap();
1249                                                 types.write_from_c_conversion_suffix(w, &ref_type, Some(&gen_types));
1250                                                 writeln!(w, ", &mut hasher);").unwrap();
1251                                                 writeln!(w, "\tcore::hash::Hasher::finish(&hasher)\n}}").unwrap();
1252                                         } else if (path_matches_nongeneric(&trait_path.1, &["core", "clone", "Clone"]) || path_matches_nongeneric(&trait_path.1, &["Clone"])) &&
1253                                                         types.c_type_has_inner_from_path(&resolved_path) {
1254                                                 writeln!(w, "impl Clone for {} {{", ident).unwrap();
1255                                                 writeln!(w, "\tfn clone(&self) -> Self {{").unwrap();
1256                                                 writeln!(w, "\t\tSelf {{").unwrap();
1257                                                 writeln!(w, "\t\t\tinner: if <*mut native{}>::is_null(self.inner) {{ core::ptr::null_mut() }} else {{", ident).unwrap();
1258                                                 writeln!(w, "\t\t\t\tObjOps::heap_alloc(unsafe {{ &*ObjOps::untweak_ptr(self.inner) }}.clone()) }},").unwrap();
1259                                                 writeln!(w, "\t\t\tis_owned: true,").unwrap();
1260                                                 writeln!(w, "\t\t}}\n\t}}\n}}").unwrap();
1261                                                 writeln!(w, "#[allow(unused)]").unwrap();
1262                                                 writeln!(w, "/// Used only if an object of this type is returned as a trait impl by a method").unwrap();
1263                                                 writeln!(w, "pub(crate) extern \"C\" fn {}_clone_void(this_ptr: *const c_void) -> *mut c_void {{", ident).unwrap();
1264                                                 writeln!(w, "\tBox::into_raw(Box::new(unsafe {{ (*(this_ptr as *mut native{})).clone() }})) as *mut c_void", ident).unwrap();
1265                                                 writeln!(w, "}}").unwrap();
1266                                                 writeln!(w, "#[no_mangle]").unwrap();
1267                                                 writeln!(w, "/// Creates a copy of the {}", ident).unwrap();
1268                                                 writeln!(w, "pub extern \"C\" fn {}_clone(orig: &{}) -> {} {{", ident, ident, ident).unwrap();
1269                                                 writeln!(w, "\torig.clone()").unwrap();
1270                                                 writeln!(w, "}}").unwrap();
1271                                         } else if path_matches_nongeneric(&trait_path.1, &["FromStr"]) {
1272                                                 let mut err_opt = None;
1273                                                 for item in i.items.iter() {
1274                                                         match item {
1275                                                                 syn::ImplItem::Type(ty) if format!("{}", ty.ident) == "Err" => {
1276                                                                         err_opt = Some(&ty.ty);
1277                                                                 },
1278                                                                 _ => {}
1279                                                         }
1280                                                 }
1281                                                 let err_ty = err_opt.unwrap();
1282                                                 if let Some(container) = types.get_c_mangled_container_type(vec![&*i.self_ty, &err_ty], Some(&gen_types), "Result") {
1283                                                         writeln!(w, "#[no_mangle]").unwrap();
1284                                                         writeln!(w, "/// Read a {} object from a string", ident).unwrap();
1285                                                         writeln!(w, "pub extern \"C\" fn {}_from_str(s: crate::c_types::Str) -> {} {{", ident, container).unwrap();
1286                                                         writeln!(w, "\tmatch {}::from_str(s.into_str()) {{", resolved_path).unwrap();
1287
1288                                                         writeln!(w, "\t\tOk(r) => {{").unwrap();
1289                                                         let new_var = types.write_to_c_conversion_new_var(w, &format_ident!("r"), &*i.self_ty, Some(&gen_types), false);
1290                                                         write!(w, "\t\t\tcrate::c_types::CResultTempl::ok(\n\t\t\t\t").unwrap();
1291                                                         types.write_to_c_conversion_inline_prefix(w, &*i.self_ty, Some(&gen_types), false);
1292                                                         write!(w, "{}r", if new_var { "local_" } else { "" }).unwrap();
1293                                                         types.write_to_c_conversion_inline_suffix(w, &*i.self_ty, Some(&gen_types), false);
1294                                                         writeln!(w, "\n\t\t\t)\n\t\t}},").unwrap();
1295
1296                                                         writeln!(w, "\t\tErr(e) => {{").unwrap();
1297                                                         let new_var = types.write_to_c_conversion_new_var(w, &format_ident!("e"), &err_ty, Some(&gen_types), false);
1298                                                         write!(w, "\t\t\tcrate::c_types::CResultTempl::err(\n\t\t\t\t").unwrap();
1299                                                         types.write_to_c_conversion_inline_prefix(w, &err_ty, Some(&gen_types), false);
1300                                                         write!(w, "{}e", if new_var { "local_" } else { "" }).unwrap();
1301                                                         types.write_to_c_conversion_inline_suffix(w, &err_ty, Some(&gen_types), false);
1302                                                         writeln!(w, "\n\t\t\t)\n\t\t}},").unwrap();
1303
1304                                                         writeln!(w, "\t}}.into()\n}}").unwrap();
1305                                                 }
1306                                         } else if path_matches_nongeneric(&trait_path.1, &["Display"]) {
1307                                                 writeln!(w, "#[no_mangle]").unwrap();
1308                                                 writeln!(w, "/// Get the string representation of a {} object", ident).unwrap();
1309                                                 writeln!(w, "pub extern \"C\" fn {}_to_str(o: &crate::{}) -> Str {{", ident, resolved_path).unwrap();
1310
1311                                                 let self_ty = &i.self_ty;
1312                                                 let ref_type: syn::Type = syn::parse_quote!(&#self_ty);
1313                                                 let new_var = types.write_from_c_conversion_new_var(w, &format_ident!("o"), &ref_type, Some(&gen_types));
1314                                                 write!(w, "\talloc::format!(\"{{}}\", ").unwrap();
1315                                                 types.write_from_c_conversion_prefix(w, &ref_type, Some(&gen_types));
1316                                                 write!(w, "{}o", if new_var { "local_" } else { "" }).unwrap();
1317                                                 types.write_from_c_conversion_suffix(w, &ref_type, Some(&gen_types));
1318                                                 writeln!(w, ").into()").unwrap();
1319
1320                                                 writeln!(w, "}}").unwrap();
1321                                         } else {
1322                                                 //XXX: implement for other things like ToString
1323                                                 // If we have no generics, try a manual implementation:
1324                                                 maybe_convert_trait_impl(w, &trait_path.1, &*i.self_ty, types, &gen_types);
1325                                         }
1326                                 } else {
1327                                         let is_opaque = types.crate_types.opaques.contains_key(&resolved_path);
1328                                         let is_mirrored_enum = types.crate_types.mirrored_enums.contains_key(&resolved_path);
1329                                         for item in i.items.iter() {
1330                                                 match item {
1331                                                         syn::ImplItem::Method(m) => {
1332                                                                 if let syn::Visibility::Public(_) = m.vis {
1333                                                                         match export_status(&m.attrs) {
1334                                                                                 ExportStatus::Export => {},
1335                                                                                 ExportStatus::NoExport|ExportStatus::TestOnly => continue,
1336                                                                                 ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
1337                                                                         }
1338                                                                         let mut meth_gen_types = gen_types.push_ctx();
1339                                                                         assert!(meth_gen_types.learn_generics(&m.sig.generics, types));
1340                                                                         if m.defaultness.is_some() { unimplemented!(); }
1341                                                                         writeln_fn_docs(w, &m.attrs, "", types, Some(&meth_gen_types), m.sig.inputs.iter(), &m.sig.output);
1342                                                                         if let syn::ReturnType::Type(_, _) = &m.sig.output {
1343                                                                                 writeln!(w, "#[must_use]").unwrap();
1344                                                                         }
1345                                                                         write!(w, "#[no_mangle]\npub extern \"C\" fn {}_{}(", ident, m.sig.ident).unwrap();
1346                                                                         let ret_type = format!("crate::{}", resolved_path);
1347                                                                         write_method_params(w, &m.sig, &ret_type, types, Some(&meth_gen_types), false, true);
1348                                                                         write!(w, " {{\n\t").unwrap();
1349                                                                         write_method_var_decl_body(w, &m.sig, "", types, Some(&meth_gen_types), false);
1350                                                                         let mut takes_self = false;
1351                                                                         let mut takes_mut_self = false;
1352                                                                         let mut takes_owned_self = false;
1353                                                                         for inp in m.sig.inputs.iter() {
1354                                                                                 if let syn::FnArg::Receiver(r) = inp {
1355                                                                                         takes_self = true;
1356                                                                                         if r.mutability.is_some() { takes_mut_self = true; }
1357                                                                                         if r.reference.is_none() { takes_owned_self = true; }
1358                                                                                 }
1359                                                                         }
1360                                                                         if !takes_mut_self && !takes_self {
1361                                                                                 write!(w, "{}::{}(", resolved_path, m.sig.ident).unwrap();
1362                                                                         } else {
1363                                                                                 if is_mirrored_enum {
1364                                                                                         write!(w, "this_arg.to_native().{}(", m.sig.ident).unwrap();
1365                                                                                 } else if is_opaque {
1366                                                                                         if takes_owned_self {
1367                                                                                                 write!(w, "(*unsafe {{ Box::from_raw(this_arg.take_inner()) }}).{}(", m.sig.ident).unwrap();
1368                                                                                         } else if takes_mut_self {
1369                                                                                                 write!(w, "unsafe {{ &mut (*ObjOps::untweak_ptr(this_arg.inner as *mut crate::{}::native{})) }}.{}(", rsplit_once(&resolved_path, "::").unwrap().0, ident, m.sig.ident).unwrap();
1370                                                                                         } else {
1371                                                                                                 write!(w, "unsafe {{ &*ObjOps::untweak_ptr(this_arg.inner) }}.{}(", m.sig.ident).unwrap();
1372                                                                                         }
1373                                                                                 } else {
1374                                                                                         unimplemented!();
1375                                                                                 }
1376                                                                         }
1377                                                                         write_method_call_params(w, &m.sig, "", types, Some(&meth_gen_types), &ret_type, false);
1378                                                                         writeln!(w, "\n}}\n").unwrap();
1379                                                                 }
1380                                                         },
1381                                                         _ => {},
1382                                                 }
1383                                         }
1384                                 }
1385                         } else if let Some(resolved_path) = types.maybe_resolve_ident(&ident) {
1386                                 create_alias_for_impl(resolved_path, i, types, move |aliased_impl, types| writeln_impl(w, &aliased_impl, types));
1387                         } else {
1388                                 eprintln!("Not implementing anything for {} due to no-resolve (probably the type isn't pub)", ident);
1389                         }
1390                 }
1391         }
1392 }
1393
1394 fn create_alias_for_impl<F: FnMut(syn::ItemImpl, &mut TypeResolver)>(resolved_path: String, i: &syn::ItemImpl, types: &mut TypeResolver, mut callback: F) {
1395         if let Some(aliases) = types.crate_types.reverse_alias_map.get(&resolved_path).cloned() {
1396                 let mut gen_types = Some(GenericTypes::new(Some(resolved_path.clone())));
1397                 if !gen_types.as_mut().unwrap().learn_generics(&i.generics, types) {
1398                         gen_types = None;
1399                 }
1400                 let alias_module = rsplit_once(&resolved_path, "::").unwrap().0;
1401
1402                 'alias_impls: for (alias_resolved, arguments) in aliases {
1403                         let mut new_ty_generics = Vec::new();
1404                         let mut new_ty_bounds = Vec::new();
1405                         let mut need_generics = false;
1406
1407                         let alias_resolver_override;
1408                         let alias_resolver = if alias_module != types.module_path {
1409                                 alias_resolver_override = ImportResolver::new(types.types.crate_name, &types.crate_types.lib_ast.dependencies,
1410                                         alias_module, &types.crate_types.lib_ast.modules.get(alias_module).unwrap().items);
1411                                 &alias_resolver_override
1412                         } else { &types.types };
1413                         let mut where_clause = syn::WhereClause { where_token: syn::Token![where](Span::call_site()),
1414                                 predicates: syn::punctuated::Punctuated::new()
1415                         };
1416                         for (idx, gen) in i.generics.params.iter().enumerate() {
1417                                 match gen {
1418                                         syn::GenericParam::Type(type_param) => {
1419                                                 'bounds_check: for bound in type_param.bounds.iter() {
1420                                                         if let syn::TypeParamBound::Trait(trait_bound) = bound {
1421                                                                 if let syn::PathArguments::AngleBracketed(ref t) = &arguments {
1422                                                                         assert!(idx < t.args.len());
1423                                                                         if let syn::GenericArgument::Type(syn::Type::Path(p)) = &t.args[idx] {
1424                                                                                 let generic_bound = types.maybe_resolve_path(&trait_bound.path, None)
1425                                                                                         .unwrap_or_else(|| format!("{}::{}", types.module_path, single_ident_generic_path_to_ident(&trait_bound.path).unwrap()));
1426
1427                                                                                 if let Some(generic_arg) = alias_resolver.maybe_resolve_path(&p.path, None) {
1428                                                                                         new_ty_generics.push((type_param.ident.clone(), syn::Type::Path(p.clone())));
1429                                                                                         if let Some(traits_impld) = types.crate_types.trait_impls.get(&generic_arg) {
1430                                                                                                 for trait_impld in traits_impld {
1431                                                                                                         if *trait_impld == generic_bound { continue 'bounds_check; }
1432                                                                                                 }
1433                                                                                                 eprintln!("struct {}'s generic arg {} didn't match bound {}", alias_resolved, generic_arg, generic_bound);
1434                                                                                                 continue 'alias_impls;
1435                                                                                         } else {
1436                                                                                                 eprintln!("struct {}'s generic arg {} didn't match bound {}", alias_resolved, generic_arg, generic_bound);
1437                                                                                                 continue 'alias_impls;
1438                                                                                         }
1439                                                                                 } else if gen_types.is_some() {
1440                                                                                         let resp =  types.maybe_resolve_path(&p.path, gen_types.as_ref());
1441                                                                                         if generic_bound == "core::ops::Deref" && resp.is_some() {
1442                                                                                                 new_ty_bounds.push((type_param.ident.clone(),
1443                                                                                                         string_path_to_syn_path("core::ops::Deref")));
1444                                                                                                 let mut bounds = syn::punctuated::Punctuated::new();
1445                                                                                                 bounds.push(syn::TypeParamBound::Trait(syn::TraitBound {
1446                                                                                                         paren_token: None,
1447                                                                                                         modifier: syn::TraitBoundModifier::None,
1448                                                                                                         lifetimes: None,
1449                                                                                                         path: string_path_to_syn_path(&types.resolve_path(&p.path, gen_types.as_ref())),
1450                                                                                                 }));
1451                                                                                                 let mut path = string_path_to_syn_path(&format!("{}::Target", type_param.ident));
1452                                                                                                 path.leading_colon = None;
1453                                                                                                 where_clause.predicates.push(syn::WherePredicate::Type(syn::PredicateType {
1454                                                                                                         lifetimes: None,
1455                                                                                                         bounded_ty: syn::Type::Path(syn::TypePath { qself: None, path }),
1456                                                                                                         colon_token: syn::Token![:](Span::call_site()),
1457                                                                                                         bounds,
1458                                                                                                 }));
1459                                                                                         } else {
1460                                                                                                 new_ty_generics.push((type_param.ident.clone(),
1461                                                                                                         gen_types.as_ref().resolve_type(&syn::Type::Path(p.clone())).clone()));
1462                                                                                         }
1463                                                                                         need_generics = true;
1464                                                                                 } else {
1465                                                                                         unimplemented!();
1466                                                                                 }
1467                                                                         } else { unimplemented!(); }
1468                                                                 } else { unimplemented!(); }
1469                                                         } else { unimplemented!(); }
1470                                                 }
1471                                         },
1472                                         syn::GenericParam::Lifetime(_) => {},
1473                                         syn::GenericParam::Const(_) => unimplemented!(),
1474                                 }
1475                         }
1476                         let mut params = syn::punctuated::Punctuated::new();
1477                         let alias = string_path_to_syn_path(&alias_resolved);
1478                         let real_aliased =
1479                                 if need_generics {
1480                                         let alias_generics = types.crate_types.opaques.get(&alias_resolved).unwrap().1;
1481
1482                                         // If we need generics on the alias, create impl generic bounds...
1483                                         assert_eq!(new_ty_generics.len() + new_ty_bounds.len(), i.generics.params.len());
1484                                         let mut args = syn::punctuated::Punctuated::new();
1485                                         for (ident, param) in new_ty_generics.drain(..) {
1486                                                 // TODO: We blindly assume that generics in the type alias and
1487                                                 // the aliased type have the same names, which we really shouldn't.
1488                                                 if alias_generics.params.iter().any(|generic|
1489                                                         if let syn::GenericParam::Type(t) = generic { t.ident == ident } else { false })
1490                                                 {
1491                                                         args.push(parse_quote!(#ident));
1492                                                 }
1493                                                 params.push(syn::GenericParam::Type(syn::TypeParam {
1494                                                         attrs: Vec::new(),
1495                                                         ident,
1496                                                         colon_token: None,
1497                                                         bounds: syn::punctuated::Punctuated::new(),
1498                                                         eq_token: Some(syn::token::Eq(Span::call_site())),
1499                                                         default: Some(param),
1500                                                 }));
1501                                         }
1502                                         for (ident, param) in new_ty_bounds.drain(..) {
1503                                                 // TODO: We blindly assume that generics in the type alias and
1504                                                 // the aliased type have the same names, which we really shouldn't.
1505                                                 if alias_generics.params.iter().any(|generic|
1506                                                         if let syn::GenericParam::Type(t) = generic { t.ident == ident } else { false })
1507                                                 {
1508                                                         args.push(parse_quote!(#ident));
1509                                                 }
1510                                                 params.push(syn::GenericParam::Type(syn::TypeParam {
1511                                                         attrs: Vec::new(),
1512                                                         ident,
1513                                                         colon_token: Some(syn::token::Colon(Span::call_site())),
1514                                                         bounds: syn::punctuated::Punctuated::from_iter(
1515                                                                 Some(syn::TypeParamBound::Trait(syn::TraitBound {
1516                                                                         path: param, paren_token: None, lifetimes: None,
1517                                                                         modifier: syn::TraitBoundModifier::None,
1518                                                                 }))
1519                                                         ),
1520                                                         eq_token: None,
1521                                                         default: None,
1522                                                 }));
1523                                         }
1524                                         // ... and swap the last segment of the impl self_ty to use the generic bounds.
1525                                         let mut res = alias.clone();
1526                                         res.segments.last_mut().unwrap().arguments = syn::PathArguments::AngleBracketed(syn::AngleBracketedGenericArguments {
1527                                                 colon2_token: None,
1528                                                 lt_token: syn::token::Lt(Span::call_site()),
1529                                                 args,
1530                                                 gt_token: syn::token::Gt(Span::call_site()),
1531                                         });
1532                                         res
1533                                 } else { alias.clone() };
1534                         callback(syn::ItemImpl {
1535                                 attrs: i.attrs.clone(),
1536                                 brace_token: syn::token::Brace(Span::call_site()),
1537                                 defaultness: None,
1538                                 generics: syn::Generics {
1539                                         lt_token: None,
1540                                         params,
1541                                         gt_token: None,
1542                                         where_clause: Some(where_clause),
1543                                 },
1544                                 impl_token: syn::Token![impl](Span::call_site()),
1545                                 items: i.items.clone(),
1546                                 self_ty: Box::new(syn::Type::Path(syn::TypePath { qself: None, path: real_aliased })),
1547                                 trait_: i.trait_.clone(),
1548                                 unsafety: None,
1549                         }, types);
1550                 }
1551         } else {
1552                 eprintln!("Not implementing anything for {} due to it being marked not exported", resolved_path);
1553         }
1554 }
1555
1556 /// Replaces upper case charachters with underscore followed by lower case except the first
1557 /// charachter and repeated upper case characthers (which are only made lower case).
1558 fn camel_to_snake_case(camel: &str) -> String {
1559         let mut res = "".to_string();
1560         let mut last_upper = -1;
1561         for (idx, c) in camel.chars().enumerate() {
1562                 if c.is_uppercase() {
1563                         if last_upper != idx as isize - 1 { res.push('_'); }
1564                         res.push(c.to_lowercase().next().unwrap());
1565                         last_upper = idx as isize;
1566                 } else {
1567                         res.push(c);
1568                 }
1569         }
1570         res
1571 }
1572
1573
1574 /// Print a mapping of an enum. If all of the enum's fields are C-mapped in some form (or the enum
1575 /// is unitary), we generate an equivalent enum with all types replaced with their C mapped
1576 /// versions followed by conversion functions which map between the Rust version and the C mapped
1577 /// version.
1578 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) {
1579         match export_status(&e.attrs) {
1580                 ExportStatus::Export => {},
1581                 ExportStatus::NoExport|ExportStatus::TestOnly => return,
1582                 ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
1583         }
1584
1585         if is_enum_opaque(e) {
1586                 eprintln!("Skipping enum {} as it contains non-unit fields", e.ident);
1587                 writeln_opaque(w, &e.ident, &format!("{}", e.ident), &e.generics, &e.attrs, types, extra_headers, cpp_headers);
1588                 return;
1589         }
1590         writeln_docs(w, &e.attrs, "");
1591
1592         let mut gen_types = GenericTypes::new(None);
1593         assert!(gen_types.learn_generics(&e.generics, types));
1594
1595         let mut needs_free = false;
1596         let mut constr = Vec::new();
1597
1598         writeln!(w, "#[must_use]\n#[derive(Clone)]\n#[repr(C)]\npub enum {} {{", e.ident).unwrap();
1599         for var in e.variants.iter() {
1600                 assert_eq!(export_status(&var.attrs), ExportStatus::Export); // We can't partially-export a mirrored enum
1601                 writeln_docs(w, &var.attrs, "\t");
1602                 write!(w, "\t{}", var.ident).unwrap();
1603                 writeln!(&mut constr, "#[no_mangle]\n/// Utility method to constructs a new {}-variant {}", var.ident, e.ident).unwrap();
1604                 let constr_name = camel_to_snake_case(&format!("{}", var.ident));
1605                 write!(&mut constr, "pub extern \"C\" fn {}_{}(", e.ident, constr_name).unwrap();
1606                 let mut empty_tuple_variant = false;
1607                 if let syn::Fields::Named(fields) = &var.fields {
1608                         needs_free = true;
1609                         writeln!(w, " {{").unwrap();
1610                         for (idx, field) in fields.named.iter().enumerate() {
1611                                 if export_status(&field.attrs) == ExportStatus::TestOnly { continue; }
1612                                 writeln_field_docs(w, &field.attrs, "\t\t", types, Some(&gen_types), &field.ty);
1613                                 write!(w, "\t\t{}: ", field.ident.as_ref().unwrap()).unwrap();
1614                                 write!(&mut constr, "{}{}: ", if idx != 0 { ", " } else { "" }, field.ident.as_ref().unwrap()).unwrap();
1615                                 types.write_c_type(w, &field.ty, Some(&gen_types), true);
1616                                 types.write_c_type(&mut constr, &field.ty, Some(&gen_types), true);
1617                                 writeln!(w, ",").unwrap();
1618                         }
1619                         write!(w, "\t}}").unwrap();
1620                 } else if let syn::Fields::Unnamed(fields) = &var.fields {
1621                         if fields.unnamed.len() == 1 {
1622                                 let mut empty_check = Vec::new();
1623                                 types.write_c_type(&mut empty_check, &fields.unnamed[0].ty, Some(&gen_types), true);
1624                                 if empty_check.is_empty() {
1625                                         empty_tuple_variant = true;
1626                                 }
1627                         }
1628                         if !empty_tuple_variant {
1629                                 needs_free = true;
1630                                 writeln!(w, "(").unwrap();
1631                                 for (idx, field) in fields.unnamed.iter().enumerate() {
1632                                         if export_status(&field.attrs) == ExportStatus::TestOnly { continue; }
1633                                         writeln_field_docs(w, &field.attrs, "\t\t", types, Some(&gen_types), &field.ty);
1634                                         write!(w, "\t\t").unwrap();
1635                                         types.write_c_type(w, &field.ty, Some(&gen_types), true);
1636
1637                                         write!(&mut constr, "{}: ", ('a' as u8 + idx as u8) as char).unwrap();
1638                                         types.write_c_type(&mut constr, &field.ty, Some(&gen_types), false);
1639                                         if idx != fields.unnamed.len() - 1 {
1640                                                 writeln!(w, ",").unwrap();
1641                                                 write!(&mut constr, ",").unwrap();
1642                                         }
1643                                 }
1644                                 write!(w, ")").unwrap();
1645                         }
1646                 }
1647                 if var.discriminant.is_some() { unimplemented!(); }
1648                 write!(&mut constr, ") -> {} {{\n\t{}::{}", e.ident, e.ident, var.ident).unwrap();
1649                 if let syn::Fields::Named(fields) = &var.fields {
1650                         writeln!(&mut constr, " {{").unwrap();
1651                         for field in fields.named.iter() {
1652                                 writeln!(&mut constr, "\t\t{},", field.ident.as_ref().unwrap()).unwrap();
1653                         }
1654                         writeln!(&mut constr, "\t}}").unwrap();
1655                 } else if let syn::Fields::Unnamed(fields) = &var.fields {
1656                         if !empty_tuple_variant {
1657                                 write!(&mut constr, "(").unwrap();
1658                                 for (idx, field) in fields.unnamed.iter().enumerate() {
1659                                         let mut ref_c_ty = Vec::new();
1660                                         let mut nonref_c_ty = Vec::new();
1661                                         types.write_c_type(&mut ref_c_ty, &field.ty, Some(&gen_types), false);
1662                                         types.write_c_type(&mut nonref_c_ty, &field.ty, Some(&gen_types), true);
1663
1664                                         if ref_c_ty != nonref_c_ty {
1665                                                 // We blindly assume references in field types are always opaque types, and
1666                                                 // print out an opaque reference -> owned reference conversion here.
1667                                                 write!(&mut constr, "{} {{ inner: {}.inner, is_owned: false }}, ", String::from_utf8(nonref_c_ty).unwrap(), ('a' as u8 + idx as u8) as char).unwrap();
1668                                         } else {
1669                                                 write!(&mut constr, "{}, ", ('a' as u8 + idx as u8) as char).unwrap();
1670                                         }
1671                                 }
1672                                 writeln!(&mut constr, ")").unwrap();
1673                         } else {
1674                                 writeln!(&mut constr, "").unwrap();
1675                         }
1676                 }
1677                 writeln!(&mut constr, "}}").unwrap();
1678                 writeln!(w, ",").unwrap();
1679         }
1680         writeln!(w, "}}\nuse {}::{} as {}Import;", types.module_path, e.ident, e.ident).unwrap();
1681         write!(w, "pub(crate) type native{} = {}Import", e.ident, e.ident).unwrap();
1682         maybe_write_generics(w, &e.generics, &types, true);
1683         writeln!(w, ";\n\nimpl {} {{", e.ident).unwrap();
1684
1685         macro_rules! write_conv {
1686                 ($fn_sig: expr, $to_c: expr, $ref: expr) => {
1687                         writeln!(w, "\t#[allow(unused)]\n\tpub(crate) fn {} {{\n\t\tmatch {} {{", $fn_sig, if $to_c { "native" } else { "self" }).unwrap();
1688                         for var in e.variants.iter() {
1689                                 write!(w, "\t\t\t{}{}::{} ", if $to_c { "native" } else { "" }, e.ident, var.ident).unwrap();
1690                                 let mut empty_tuple_variant = false;
1691                                 if let syn::Fields::Named(fields) = &var.fields {
1692                                         write!(w, "{{").unwrap();
1693                                         for field in fields.named.iter() {
1694                                                 if export_status(&field.attrs) == ExportStatus::TestOnly { continue; }
1695                                                 write!(w, "{}{}, ", if $ref { "ref " } else { "mut " }, field.ident.as_ref().unwrap()).unwrap();
1696                                         }
1697                                         write!(w, "}} ").unwrap();
1698                                 } else if let syn::Fields::Unnamed(fields) = &var.fields {
1699                                         if fields.unnamed.len() == 1 {
1700                                                 let mut empty_check = Vec::new();
1701                                                 types.write_c_type(&mut empty_check, &fields.unnamed[0].ty, Some(&gen_types), true);
1702                                                 if empty_check.is_empty() {
1703                                                         empty_tuple_variant = true;
1704                                                 }
1705                                         }
1706                                         if !empty_tuple_variant || $to_c {
1707                                                 write!(w, "(").unwrap();
1708                                                 for (idx, field) in fields.unnamed.iter().enumerate() {
1709                                                         if export_status(&field.attrs) == ExportStatus::TestOnly { continue; }
1710                                                         write!(w, "{}{}, ", if $ref { "ref " } else { "mut " }, ('a' as u8 + idx as u8) as char).unwrap();
1711                                                 }
1712                                                 write!(w, ") ").unwrap();
1713                                         }
1714                                 }
1715                                 write!(w, "=>").unwrap();
1716
1717                                 macro_rules! handle_field_a {
1718                                         ($field: expr, $field_ident: expr) => { {
1719                                                 if export_status(&$field.attrs) == ExportStatus::TestOnly { continue; }
1720                                                 let mut sink = ::std::io::sink();
1721                                                 let mut out: &mut dyn std::io::Write = if $ref { &mut sink } else { w };
1722                                                 let new_var = if $to_c {
1723                                                         types.write_to_c_conversion_new_var(&mut out, $field_ident, &$field.ty, Some(&gen_types), true)
1724                                                 } else {
1725                                                         types.write_from_c_conversion_new_var(&mut out, $field_ident, &$field.ty, Some(&gen_types))
1726                                                 };
1727                                                 if $ref || new_var {
1728                                                         if $ref {
1729                                                                 write!(w, "let mut {}_nonref = (*{}).clone();\n\t\t\t\t", $field_ident, $field_ident).unwrap();
1730                                                                 if new_var {
1731                                                                         let nonref_ident = format_ident!("{}_nonref", $field_ident);
1732                                                                         if $to_c {
1733                                                                                 types.write_to_c_conversion_new_var(w, &nonref_ident, &$field.ty, Some(&gen_types), true);
1734                                                                         } else {
1735                                                                                 types.write_from_c_conversion_new_var(w, &nonref_ident, &$field.ty, Some(&gen_types));
1736                                                                         }
1737                                                                         write!(w, "\n\t\t\t\t").unwrap();
1738                                                                 }
1739                                                         } else {
1740                                                                 write!(w, "\n\t\t\t\t").unwrap();
1741                                                         }
1742                                                 }
1743                                         } }
1744                                 }
1745                                 if let syn::Fields::Named(fields) = &var.fields {
1746                                         write!(w, " {{\n\t\t\t\t").unwrap();
1747                                         for field in fields.named.iter() {
1748                                                 handle_field_a!(field, field.ident.as_ref().unwrap());
1749                                         }
1750                                 } else if let syn::Fields::Unnamed(fields) = &var.fields {
1751                                         write!(w, " {{\n\t\t\t\t").unwrap();
1752                                         for (idx, field) in fields.unnamed.iter().enumerate() {
1753                                                 if !empty_tuple_variant {
1754                                                         handle_field_a!(field, &format_ident!("{}", ('a' as u8 + idx as u8) as char));
1755                                                 }
1756                                         }
1757                                 } else { write!(w, " ").unwrap(); }
1758
1759                                 write!(w, "{}{}::{}", if $to_c { "" } else { "native" }, e.ident, var.ident).unwrap();
1760
1761                                 macro_rules! handle_field_b {
1762                                         ($field: expr, $field_ident: expr) => { {
1763                                                 if export_status(&$field.attrs) == ExportStatus::TestOnly { continue; }
1764                                                 if $to_c {
1765                                                         types.write_to_c_conversion_inline_prefix(w, &$field.ty, Some(&gen_types), true);
1766                                                 } else {
1767                                                         types.write_from_c_conversion_prefix(w, &$field.ty, Some(&gen_types));
1768                                                 }
1769                                                 write!(w, "{}{}", $field_ident,
1770                                                         if $ref { "_nonref" } else { "" }).unwrap();
1771                                                 if $to_c {
1772                                                         types.write_to_c_conversion_inline_suffix(w, &$field.ty, Some(&gen_types), true);
1773                                                 } else {
1774                                                         types.write_from_c_conversion_suffix(w, &$field.ty, Some(&gen_types));
1775                                                 }
1776                                                 write!(w, ",").unwrap();
1777                                         } }
1778                                 }
1779
1780                                 if let syn::Fields::Named(fields) = &var.fields {
1781                                         write!(w, " {{").unwrap();
1782                                         for field in fields.named.iter() {
1783                                                 if export_status(&field.attrs) == ExportStatus::TestOnly { continue; }
1784                                                 write!(w, "\n\t\t\t\t\t{}: ", field.ident.as_ref().unwrap()).unwrap();
1785                                                 handle_field_b!(field, field.ident.as_ref().unwrap());
1786                                         }
1787                                         writeln!(w, "\n\t\t\t\t}}").unwrap();
1788                                         write!(w, "\t\t\t}}").unwrap();
1789                                 } else if let syn::Fields::Unnamed(fields) = &var.fields {
1790                                         if !empty_tuple_variant || !$to_c {
1791                                                 write!(w, " (").unwrap();
1792                                                 for (idx, field) in fields.unnamed.iter().enumerate() {
1793                                                         write!(w, "\n\t\t\t\t\t").unwrap();
1794                                                         handle_field_b!(field, &format_ident!("{}", ('a' as u8 + idx as u8) as char));
1795                                                 }
1796                                                 writeln!(w, "\n\t\t\t\t)").unwrap();
1797                                         }
1798                                         write!(w, "\t\t\t}}").unwrap();
1799                                 }
1800                                 writeln!(w, ",").unwrap();
1801                         }
1802                         writeln!(w, "\t\t}}\n\t}}").unwrap();
1803                 }
1804         }
1805
1806         write_conv!(format!("to_native(&self) -> native{}", e.ident), false, true);
1807         write_conv!(format!("into_native(self) -> native{}", e.ident), false, false);
1808         write_conv!(format!("from_native(native: &native{}) -> Self", e.ident), true, true);
1809         write_conv!(format!("native_into(native: native{}) -> Self", e.ident), true, false);
1810         writeln!(w, "}}").unwrap();
1811
1812         if needs_free {
1813                 writeln!(w, "/// Frees any resources used by the {}", e.ident).unwrap();
1814                 writeln!(w, "#[no_mangle]\npub extern \"C\" fn {}_free(this_ptr: {}) {{ }}", e.ident, e.ident).unwrap();
1815         }
1816         writeln!(w, "/// Creates a copy of the {}", e.ident).unwrap();
1817         writeln!(w, "#[no_mangle]").unwrap();
1818         writeln!(w, "pub extern \"C\" fn {}_clone(orig: &{}) -> {} {{", e.ident, e.ident, e.ident).unwrap();
1819         writeln!(w, "\torig.clone()").unwrap();
1820         writeln!(w, "}}").unwrap();
1821         w.write_all(&constr).unwrap();
1822         write_cpp_wrapper(cpp_headers, &format!("{}", e.ident), needs_free, None);
1823 }
1824
1825 fn writeln_fn<'a, 'b, W: std::io::Write>(w: &mut W, f: &'a syn::ItemFn, types: &mut TypeResolver<'b, 'a>) {
1826         match export_status(&f.attrs) {
1827                 ExportStatus::Export => {},
1828                 ExportStatus::NoExport|ExportStatus::TestOnly => return,
1829                 ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
1830         }
1831         let mut gen_types = GenericTypes::new(None);
1832         if !gen_types.learn_generics(&f.sig.generics, types) { return; }
1833
1834         writeln_fn_docs(w, &f.attrs, "", types, Some(&gen_types), f.sig.inputs.iter(), &f.sig.output);
1835
1836         write!(w, "#[no_mangle]\npub extern \"C\" fn {}(", f.sig.ident).unwrap();
1837
1838
1839         write_method_params(w, &f.sig, "", types, Some(&gen_types), false, true);
1840         write!(w, " {{\n\t").unwrap();
1841         write_method_var_decl_body(w, &f.sig, "", types, Some(&gen_types), false);
1842         write!(w, "{}::{}", types.module_path, f.sig.ident).unwrap();
1843
1844         let mut function_generic_args = Vec::new();
1845         maybe_write_generics(&mut function_generic_args, &f.sig.generics, types, true);
1846         if !function_generic_args.is_empty() {
1847                 write!(w, "::{}", String::from_utf8(function_generic_args).unwrap()).unwrap();
1848         }
1849         write!(w, "(").unwrap();
1850
1851         write_method_call_params(w, &f.sig, "", types, Some(&gen_types), "", false);
1852         writeln!(w, "\n}}\n").unwrap();
1853 }
1854
1855 // ********************************
1856 // *** File/Crate Walking Logic ***
1857 // ********************************
1858
1859 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) {
1860         // We want to ignore all items declared in this module (as they are not pub), but we still need
1861         // to give the ImportResolver any use statements, so we copy them here.
1862         let mut use_items = Vec::new();
1863         for item in module.content.as_ref().unwrap().1.iter() {
1864                 if let syn::Item::Use(_) = item {
1865                         use_items.push(item);
1866                 }
1867         }
1868         let import_resolver = ImportResolver::from_borrowed_items(mod_path.splitn(2, "::").next().unwrap(), &libast.dependencies, mod_path, &use_items);
1869         let mut types = TypeResolver::new(mod_path, import_resolver, crate_types);
1870
1871         writeln!(w, "mod {} {{\n{}", module.ident, DEFAULT_IMPORTS).unwrap();
1872         for item in module.content.as_ref().unwrap().1.iter() {
1873                 match item {
1874                         syn::Item::Mod(m) => convert_priv_mod(w, libast, crate_types, out_dir, &format!("{}::{}", mod_path, module.ident), m),
1875                         syn::Item::Impl(i) => {
1876                                 writeln_impl(w, i, &mut types);
1877                         },
1878                         _ => {},
1879                 }
1880         }
1881         writeln!(w, "}}").unwrap();
1882 }
1883
1884 /// Do the Real Work of mapping an original file to C-callable wrappers. Creates a new file at
1885 /// `out_path` and fills it with wrapper structs/functions to allow calling the things in the AST
1886 /// at `module` from C.
1887 fn convert_file<'a, 'b>(libast: &'a FullLibraryAST, crate_types: &CrateTypes<'a>, out_dir: &str, header_file: &mut File, cpp_header_file: &mut File) {
1888         for (module, astmod) in libast.modules.iter() {
1889                 let orig_crate = module.splitn(2, "::").next().unwrap();
1890                 let ASTModule { ref attrs, ref items, ref submods } = astmod;
1891                 assert_eq!(export_status(&attrs), ExportStatus::Export);
1892
1893                 let new_file_path = if submods.is_empty() {
1894                         format!("{}/{}.rs", out_dir, module.replace("::", "/"))
1895                 } else if module != "" {
1896                         format!("{}/{}/mod.rs", out_dir, module.replace("::", "/"))
1897                 } else {
1898                         format!("{}/lib.rs", out_dir)
1899                 };
1900                 let _ = std::fs::create_dir((&new_file_path.as_ref() as &std::path::Path).parent().unwrap());
1901                 let mut out = std::fs::OpenOptions::new().write(true).create(true).truncate(true)
1902                         .open(new_file_path).expect("Unable to open new src file");
1903
1904                 writeln!(out, "// This file is Copyright its original authors, visible in version control").unwrap();
1905                 writeln!(out, "// history and in the source files from which this was generated.").unwrap();
1906                 writeln!(out, "//").unwrap();
1907                 writeln!(out, "// This file is licensed under the license available in the LICENSE or LICENSE.md").unwrap();
1908                 writeln!(out, "// file in the root of this repository or, if no such file exists, the same").unwrap();
1909                 writeln!(out, "// license as that which applies to the original source files from which this").unwrap();
1910                 writeln!(out, "// source was automatically generated.").unwrap();
1911                 writeln!(out, "").unwrap();
1912
1913                 writeln_docs(&mut out, &attrs, "");
1914
1915                 if module == "" {
1916                         // Special-case the top-level lib.rs with various lint allows and a pointer to the c_types
1917                         // and bitcoin hand-written modules.
1918                         writeln!(out, "//! C Bindings").unwrap();
1919                         writeln!(out, "#![allow(unknown_lints)]").unwrap();
1920                         writeln!(out, "#![allow(non_camel_case_types)]").unwrap();
1921                         writeln!(out, "#![allow(non_snake_case)]").unwrap();
1922                         writeln!(out, "#![allow(unused_imports)]").unwrap();
1923                         writeln!(out, "#![allow(unused_variables)]").unwrap();
1924                         writeln!(out, "#![allow(unused_mut)]").unwrap();
1925                         writeln!(out, "#![allow(unused_parens)]").unwrap();
1926                         writeln!(out, "#![allow(unused_unsafe)]").unwrap();
1927                         writeln!(out, "#![allow(unused_braces)]").unwrap();
1928                         // TODO: We need to map deny(missing_docs) in the source crate(s)
1929                         //writeln!(out, "#![deny(missing_docs)]").unwrap();
1930
1931                         writeln!(out, "#![cfg_attr(not(feature = \"std\"), no_std)]").unwrap();
1932                         writeln!(out, "#[cfg(not(any(feature = \"std\", feature = \"no-std\")))]").unwrap();
1933                         writeln!(out, "compile_error!(\"at least one of the `std` or `no-std` features must be enabled\");").unwrap();
1934                         writeln!(out, "extern crate alloc;").unwrap();
1935
1936                         writeln!(out, "pub mod version;").unwrap();
1937                         writeln!(out, "pub mod c_types;").unwrap();
1938                         writeln!(out, "pub mod bitcoin;").unwrap();
1939                 } else {
1940                         writeln!(out, "{}", DEFAULT_IMPORTS).unwrap();
1941                 }
1942
1943                 for m in submods {
1944                         writeln!(out, "pub mod {};", m).unwrap();
1945                 }
1946
1947                 eprintln!("Converting {} entries...", module);
1948
1949                 let import_resolver = ImportResolver::new(orig_crate, &libast.dependencies, module, items);
1950                 let mut type_resolver = TypeResolver::new(module, import_resolver, crate_types);
1951
1952                 for item in items.iter() {
1953                         match item {
1954                                 syn::Item::Use(_) => {}, // Handled above
1955                                 syn::Item::Static(_) => {},
1956                                 syn::Item::Enum(e) => {
1957                                         if let syn::Visibility::Public(_) = e.vis {
1958                                                 writeln_enum(&mut out, &e, &mut type_resolver, header_file, cpp_header_file);
1959                                         }
1960                                 },
1961                                 syn::Item::Impl(i) => {
1962                                         writeln_impl(&mut out, &i, &mut type_resolver);
1963                                 },
1964                                 syn::Item::Struct(s) => {
1965                                         if let syn::Visibility::Public(_) = s.vis {
1966                                                 writeln_struct(&mut out, &s, &mut type_resolver, header_file, cpp_header_file);
1967                                         }
1968                                 },
1969                                 syn::Item::Trait(t) => {
1970                                         if let syn::Visibility::Public(_) = t.vis {
1971                                                 writeln_trait(&mut out, &t, &mut type_resolver, header_file, cpp_header_file);
1972                                         }
1973                                 },
1974                                 syn::Item::Mod(m) => {
1975                                         convert_priv_mod(&mut out, libast, crate_types, out_dir, &format!("{}::{}", module, m.ident), m);
1976                                 },
1977                                 syn::Item::Const(c) => {
1978                                         // Re-export any primitive-type constants.
1979                                         if let syn::Visibility::Public(_) = c.vis {
1980                                                 if let syn::Type::Path(p) = &*c.ty {
1981                                                         let resolved_path = type_resolver.resolve_path(&p.path, None);
1982                                                         if type_resolver.is_primitive(&resolved_path) {
1983                                                                 writeln_field_docs(&mut out, &c.attrs, "", &mut type_resolver, None, &*c.ty);
1984                                                                 writeln!(out, "\n#[no_mangle]").unwrap();
1985                                                                 writeln!(out, "pub static {}: {} = {}::{};", c.ident, resolved_path, module, c.ident).unwrap();
1986                                                         }
1987                                                 }
1988                                         }
1989                                 },
1990                                 syn::Item::Type(t) => {
1991                                         if let syn::Visibility::Public(_) = t.vis {
1992                                                 match export_status(&t.attrs) {
1993                                                         ExportStatus::Export => {},
1994                                                         ExportStatus::NoExport|ExportStatus::TestOnly => continue,
1995                                                         ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
1996                                                 }
1997
1998                                                 match &*t.ty {
1999                                                         syn::Type::Path(p) => {
2000                                                                 let real_ty = type_resolver.resolve_path(&p.path, None);
2001                                                                 let real_generic_bounds = type_resolver.crate_types.opaques.get(&real_ty).map(|t| t.1).or(
2002                                                                         type_resolver.crate_types.priv_structs.get(&real_ty).map(|r| *r)).unwrap();
2003                                                                 let mut resolved_generics = t.generics.clone();
2004
2005                                                                 // Assume blindly that the bounds in the struct definition where
2006                                                                 // clause matches any equivalent bounds on the type alias.
2007                                                                 assert!(resolved_generics.where_clause.is_none());
2008                                                                 resolved_generics.where_clause = real_generic_bounds.where_clause.clone();
2009
2010                                                                 if let syn::PathArguments::AngleBracketed(real_generics) = &p.path.segments.last().unwrap().arguments {
2011                                                                         for (real_idx, real_param) in real_generics.args.iter().enumerate() {
2012                                                                                 if let syn::GenericArgument::Type(syn::Type::Path(real_param_path)) = real_param {
2013                                                                                         for param in resolved_generics.params.iter_mut() {
2014                                                                                                 if let syn::GenericParam::Type(type_param) = param {
2015                                                                                                         if Some(&type_param.ident) == real_param_path.path.get_ident() {
2016                                                                                                                 if let syn::GenericParam::Type(real_type_param) = &real_generic_bounds.params[real_idx] {
2017                                                                                                                         type_param.bounds = real_type_param.bounds.clone();
2018                                                                                                                         type_param.default = real_type_param.default.clone();
2019
2020                                                                                                                 }
2021                                                                                                         }
2022                                                                                                 }
2023                                                                                         }
2024                                                                                 }
2025                                                                         }
2026                                                                 }
2027
2028                                                                 writeln_opaque(&mut out, &t.ident, &format!("{}", t.ident), &resolved_generics, &t.attrs, &type_resolver, header_file, cpp_header_file)},
2029                                                         _ => {}
2030                                                 }
2031                                         }
2032                                 },
2033                                 syn::Item::Fn(f) => {
2034                                         if let syn::Visibility::Public(_) = f.vis {
2035                                                 writeln_fn(&mut out, &f, &mut type_resolver);
2036                                         }
2037                                 },
2038                                 syn::Item::Macro(_) => {},
2039                                 syn::Item::Verbatim(_) => {},
2040                                 syn::Item::ExternCrate(_) => {},
2041                                 _ => unimplemented!(),
2042                         }
2043                 }
2044
2045                 out.flush().unwrap();
2046         }
2047 }
2048
2049 fn walk_private_mod<'a>(ast_storage: &'a FullLibraryAST, orig_crate: &str, module: String, items: &'a syn::ItemMod, crate_types: &mut CrateTypes<'a>) {
2050         let import_resolver = ImportResolver::new(orig_crate, &ast_storage.dependencies, &module, &items.content.as_ref().unwrap().1);
2051         for item in items.content.as_ref().unwrap().1.iter() {
2052                 match item {
2053                         syn::Item::Mod(m) => walk_private_mod(ast_storage, orig_crate, format!("{}::{}", module, m.ident), m, crate_types),
2054                         syn::Item::Impl(i) => {
2055                                 if let &syn::Type::Path(ref p) = &*i.self_ty {
2056                                         if let Some(trait_path) = i.trait_.as_ref() {
2057                                                 if let Some(tp) = import_resolver.maybe_resolve_path(&trait_path.1, None) {
2058                                                         if let Some(sp) = import_resolver.maybe_resolve_path(&p.path, None) {
2059                                                                 match crate_types.trait_impls.entry(sp) {
2060                                                                         hash_map::Entry::Occupied(mut e) => { e.get_mut().push(tp); },
2061                                                                         hash_map::Entry::Vacant(e) => { e.insert(vec![tp]); },
2062                                                                 }
2063                                                         }
2064                                                 }
2065                                         }
2066                                 }
2067                         },
2068                         _ => {},
2069                 }
2070         }
2071 }
2072
2073 /// Walk the FullLibraryAST, deciding how things will be mapped and adding tracking to CrateTypes.
2074 fn walk_ast<'a>(ast_storage: &'a FullLibraryAST, crate_types: &mut CrateTypes<'a>) {
2075         for (module, astmod) in ast_storage.modules.iter() {
2076                 let ASTModule { ref attrs, ref items, submods: _ } = astmod;
2077                 assert_eq!(export_status(&attrs), ExportStatus::Export);
2078                 let orig_crate = module.splitn(2, "::").next().unwrap();
2079                 let import_resolver = ImportResolver::new(orig_crate, &ast_storage.dependencies, module, items);
2080
2081                 for item in items.iter() {
2082                         match item {
2083                                 syn::Item::Struct(s) => {
2084                                         if let syn::Visibility::Public(_) = s.vis {
2085                                                 let struct_path = format!("{}::{}", module, s.ident);
2086                                                 match export_status(&s.attrs) {
2087                                                         ExportStatus::Export => {},
2088                                                         ExportStatus::NoExport|ExportStatus::TestOnly => {
2089                                                                 crate_types.priv_structs.insert(struct_path, &s.generics);
2090                                                                 continue
2091                                                         },
2092                                                         ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
2093                                                 }
2094                                                 crate_types.opaques.insert(struct_path, (&s.ident, &s.generics));
2095                                         }
2096                                 },
2097                                 syn::Item::Trait(t) => {
2098                                         if let syn::Visibility::Public(_) = t.vis {
2099                                                 match export_status(&t.attrs) {
2100                                                         ExportStatus::Export|ExportStatus::NotImplementable => {},
2101                                                         ExportStatus::NoExport|ExportStatus::TestOnly => continue,
2102                                                 }
2103                                                 let trait_path = format!("{}::{}", module, t.ident);
2104                                                 walk_supertraits!(t, None, (
2105                                                         ("Clone", _) => {
2106                                                                 crate_types.set_clonable("crate::".to_owned() + &trait_path);
2107                                                         },
2108                                                         (_, _) => {}
2109                                                 ) );
2110                                                 crate_types.traits.insert(trait_path, &t);
2111                                         }
2112                                 },
2113                                 syn::Item::Type(t) => {
2114                                         if let syn::Visibility::Public(_) = t.vis {
2115                                                 match export_status(&t.attrs) {
2116                                                         ExportStatus::Export => {},
2117                                                         ExportStatus::NoExport|ExportStatus::TestOnly => continue,
2118                                                         ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
2119                                                 }
2120                                                 let type_path = format!("{}::{}", module, t.ident);
2121                                                 match &*t.ty {
2122                                                         syn::Type::Path(p) => {
2123                                                                 // If its a path with no generics, assume we don't map the aliased type and map it opaque
2124                                                                 let args_obj = p.path.segments.last().unwrap().arguments.clone();
2125                                                                 match crate_types.reverse_alias_map.entry(import_resolver.maybe_resolve_path(&p.path, None).unwrap()) {
2126                                                                         hash_map::Entry::Occupied(mut e) => { e.get_mut().push((type_path.clone(), args_obj)); },
2127                                                                         hash_map::Entry::Vacant(e) => { e.insert(vec![(type_path.clone(), args_obj)]); },
2128                                                                 }
2129
2130                                                                 crate_types.opaques.insert(type_path, (&t.ident, &t.generics));
2131                                                         },
2132                                                         _ => {
2133                                                                 crate_types.type_aliases.insert(type_path, import_resolver.resolve_imported_refs((*t.ty).clone()));
2134                                                         }
2135                                                 }
2136                                         }
2137                                 },
2138                                 syn::Item::Enum(e) if is_enum_opaque(e) => {
2139                                         if let syn::Visibility::Public(_) = e.vis {
2140                                                 match export_status(&e.attrs) {
2141                                                         ExportStatus::Export => {},
2142                                                         ExportStatus::NoExport|ExportStatus::TestOnly => continue,
2143                                                         ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
2144                                                 }
2145                                                 let enum_path = format!("{}::{}", module, e.ident);
2146                                                 crate_types.opaques.insert(enum_path, (&e.ident, &e.generics));
2147                                         }
2148                                 },
2149                                 syn::Item::Enum(e) => {
2150                                         if let syn::Visibility::Public(_) = e.vis {
2151                                                 match export_status(&e.attrs) {
2152                                                         ExportStatus::Export => {},
2153                                                         ExportStatus::NoExport|ExportStatus::TestOnly => continue,
2154                                                         ExportStatus::NotImplementable => panic!("(C-not implementable) must only appear on traits"),
2155                                                 }
2156                                                 let enum_path = format!("{}::{}", module, e.ident);
2157                                                 crate_types.mirrored_enums.insert(enum_path, &e);
2158                                         }
2159                                 },
2160                                 syn::Item::Impl(i) => {
2161                                         if let &syn::Type::Path(ref p) = &*i.self_ty {
2162                                                 if let Some(trait_path) = i.trait_.as_ref() {
2163                                                         if path_matches_nongeneric(&trait_path.1, &["core", "clone", "Clone"]) ||
2164                                                            path_matches_nongeneric(&trait_path.1, &["Clone"]) {
2165                                                                 if let Some(full_path) = import_resolver.maybe_resolve_path(&p.path, None) {
2166                                                                         crate_types.set_clonable("crate::".to_owned() + &full_path);
2167                                                                 }
2168                                                         }
2169                                                         if let Some(tp) = import_resolver.maybe_resolve_path(&trait_path.1, None) {
2170                                                                 if let Some(sp) = import_resolver.maybe_resolve_path(&p.path, None) {
2171                                                                         match crate_types.trait_impls.entry(sp) {
2172                                                                                 hash_map::Entry::Occupied(mut e) => { e.get_mut().push(tp); },
2173                                                                                 hash_map::Entry::Vacant(e) => { e.insert(vec![tp]); },
2174                                                                         }
2175                                                                 }
2176                                                         }
2177                                                 }
2178                                         }
2179                                 },
2180                                 syn::Item::Mod(m) => walk_private_mod(ast_storage, orig_crate, format!("{}::{}", module, m.ident), m, crate_types),
2181                                 _ => {},
2182                         }
2183                 }
2184         }
2185 }
2186
2187 fn main() {
2188         let args: Vec<String> = env::args().collect();
2189         if args.len() != 5 {
2190                 eprintln!("Usage: target/dir derived_templates.rs extra/includes.h extra/cpp/includes.hpp");
2191                 process::exit(1);
2192         }
2193
2194         let mut derived_templates = std::fs::OpenOptions::new().write(true).create(true).truncate(true)
2195                 .open(&args[2]).expect("Unable to open new header file");
2196         writeln!(&mut derived_templates, "{}", DEFAULT_IMPORTS).unwrap();
2197         let mut header_file = std::fs::OpenOptions::new().write(true).create(true).truncate(true)
2198                 .open(&args[3]).expect("Unable to open new header file");
2199         let mut cpp_header_file = std::fs::OpenOptions::new().write(true).create(true).truncate(true)
2200                 .open(&args[4]).expect("Unable to open new header file");
2201
2202         writeln!(header_file, "#if defined(__GNUC__)").unwrap();
2203         writeln!(header_file, "#define MUST_USE_STRUCT __attribute__((warn_unused))").unwrap();
2204         writeln!(header_file, "#define MUST_USE_RES __attribute__((warn_unused_result))").unwrap();
2205         writeln!(header_file, "#else").unwrap();
2206         writeln!(header_file, "#define MUST_USE_STRUCT").unwrap();
2207         writeln!(header_file, "#define MUST_USE_RES").unwrap();
2208         writeln!(header_file, "#endif").unwrap();
2209         writeln!(header_file, "#if defined(__clang__)").unwrap();
2210         writeln!(header_file, "#define NONNULL_PTR _Nonnull").unwrap();
2211         writeln!(header_file, "#else").unwrap();
2212         writeln!(header_file, "#define NONNULL_PTR").unwrap();
2213         writeln!(header_file, "#endif").unwrap();
2214         writeln!(cpp_header_file, "#include <string.h>\nnamespace LDK {{").unwrap();
2215
2216         // Write a few manually-defined types into the C++ header file
2217         write_cpp_wrapper(&mut cpp_header_file, "Str", true, None);
2218
2219         // First parse the full crate's ASTs, caching them so that we can hold references to the AST
2220         // objects in other datastructures:
2221         let mut lib_src = String::new();
2222         std::io::stdin().lock().read_to_string(&mut lib_src).unwrap();
2223         let lib_syntax = syn::parse_file(&lib_src).expect("Unable to parse file");
2224         let libast = FullLibraryAST::load_lib(lib_syntax);
2225
2226         // ...then walk the ASTs tracking what types we will map, and how, so that we can resolve them
2227         // when parsing other file ASTs...
2228         let mut libtypes = CrateTypes::new(&mut derived_templates, &libast);
2229         walk_ast(&libast, &mut libtypes);
2230
2231         // ... finally, do the actual file conversion/mapping, writing out types as we go.
2232         convert_file(&libast, &libtypes, &args[1], &mut header_file, &mut cpp_header_file);
2233
2234         // For container templates which we created while walking the crate, make sure we add C++
2235         // mapped types so that C++ users can utilize the auto-destructors available.
2236         for (ty, has_destructor) in libtypes.templates_defined.borrow().iter() {
2237                 write_cpp_wrapper(&mut cpp_header_file, ty, *has_destructor, None);
2238         }
2239         writeln!(cpp_header_file, "}}").unwrap();
2240
2241         header_file.flush().unwrap();
2242         cpp_header_file.flush().unwrap();
2243         derived_templates.flush().unwrap();
2244 }