_ Git - ldk-c-bindings/blob - c-bindings-gen/src/types.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 use std::cell::RefCell;
  10 use std::collections::{HashMap, HashSet};
  11 use std::fs::File;
  12 use std::io::Write;
  13 use std::hash;
  14
  15 use crate::blocks::*;
  16
  17 use proc_macro2::{TokenTree, Span};
  18 use quote::format_ident;
  19 use syn::parse_quote;
  20
  21 // The following utils are used purely to build our known types maps - they break down all the
  22 // types we need to resolve to include the given object, and no more.
  23
  24 pub fn first_seg_self<'a>(t: &'a syn::Type) -> Option<impl Iterator<Item=&syn::PathSegment> + 'a> {
  25         match t {
  26                 syn::Type::Path(p) => {
  27                         if p.qself.is_some() || p.path.leading_colon.is_some() {
  28                                 return None;
  29                         }
  30                         let mut segs = p.path.segments.iter();
  31                         let ty = segs.next().unwrap();
  32                         if !ty.arguments.is_empty() { return None; }
  33                         if format!("{}", ty.ident) == "Self" {
  34                                 Some(segs)
  35                         } else { None }
  36                 },
  37                 _ => None,
  38         }
  39 }
  40
  41 pub fn get_single_remaining_path_seg<'a, I: Iterator<Item=&'a syn::PathSegment>>(segs: &mut I) -> Option<&'a syn::Ident> {
  42         if let Some(ty) = segs.next() {
  43                 if !ty.arguments.is_empty() { unimplemented!(); }
  44                 if segs.next().is_some() { return None; }
  45                 Some(&ty.ident)
  46         } else { None }
  47 }
  48
  49 pub fn first_seg_is_stdlib(first_seg_str: &str) -> bool {
  50         first_seg_str == "std" || first_seg_str == "core" || first_seg_str == "alloc"
  51 }
  52
  53 pub fn single_ident_generic_path_to_ident(p: &syn::Path) -> Option<&syn::Ident> {
  54         if p.segments.len() == 1 {
  55                 Some(&p.segments.iter().next().unwrap().ident)
  56         } else { None }
  57 }
  58
  59 pub fn path_matches_nongeneric(p: &syn::Path, exp: &[&str]) -> bool {
  60         if p.segments.len() != exp.len() { return false; }
  61         for (seg, e) in p.segments.iter().zip(exp.iter()) {
  62                 if seg.arguments != syn::PathArguments::None { return false; }
  63                 if &format!("{}", seg.ident) != *e { return false; }
  64         }
  65         true
  66 }
  67
  68 pub fn string_path_to_syn_path(path: &str) -> syn::Path {
  69         let mut segments = syn::punctuated::Punctuated::new();
  70         for seg in path.split("::") {
  71                 segments.push(syn::PathSegment {
  72                         ident: syn::Ident::new(seg, Span::call_site()),
  73                         arguments: syn::PathArguments::None,
  74                 });
  75         }
  76         syn::Path { leading_colon: Some(syn::Token![::](Span::call_site())), segments }
  77 }
  78
  79 #[derive(Debug, PartialEq)]
  80 pub enum ExportStatus {
  81         Export,
  82         NoExport,
  83         TestOnly,
  84         /// This is used only for traits to indicate that users should not be able to implement their
  85         /// own version of a trait, but we should export Rust implementations of the trait (and the
  86         /// trait itself).
  87         /// Concretly, this means that we do not implement the Rust trait for the C trait struct.
  88         NotImplementable,
  89 }
  90 /// Gets the ExportStatus of an object (struct, fn, etc) given its attributes.
  91 pub fn export_status(attrs: &[syn::Attribute]) -> ExportStatus {
  92         for attr in attrs.iter() {
  93                 let tokens_clone = attr.tokens.clone();
  94                 let mut token_iter = tokens_clone.into_iter();
  95                 if let Some(token) = token_iter.next() {
  96                         match token {
  97                                 TokenTree::Punct(c) if c.as_char() == '=' => {
  98                                         // Really not sure where syn gets '=' from here -
  99                                         // it somehow represents '///' or '//!'
 100                                 },
 101                                 TokenTree::Group(g) => {
 102                                         if format!("{}", single_ident_generic_path_to_ident(&attr.path).unwrap()) == "cfg" {
 103                                                 let mut iter = g.stream().into_iter();
 104                                                 if let TokenTree::Ident(i) = iter.next().unwrap() {
 105                                                         if i == "any" {
 106                                                                 // #[cfg(any(test, feature = ""))]
 107                                                                 if let TokenTree::Group(g) = iter.next().unwrap() {
 108                                                                         let mut all_test = true;
 109                                                                         for token in g.stream().into_iter() {
 110                                                                                 if let TokenTree::Ident(i) = token {
 111                                                                                         match format!("{}", i).as_str() {
 112                                                                                                 "test" => {},
 113                                                                                                 "feature" => {},
 114                                                                                                 _ => all_test = false,
 115                                                                                         }
 116                                                                                 } else if let TokenTree::Literal(lit) = token {
 117                                                                                         if format!("{}", lit) != "fuzztarget" {
 118                                                                                                 all_test = false;
 119                                                                                         }
 120                                                                                 }
 121                                                                         }
 122                                                                         if all_test { return ExportStatus::TestOnly; }
 123                                                                 }
 124                                                         } else if i == "test" {
 125                                                                 return ExportStatus::TestOnly;
 126                                                         }
 127                                                 }
 128                                         }
 129                                         continue; // eg #[derive()]
 130                                 },
 131                                 _ => unimplemented!(),
 132                         }
 133                 } else { continue; }
 134                 match token_iter.next().unwrap() {
 135                         TokenTree::Literal(lit) => {
 136                                 let line = format!("{}", lit);
 137                                 if line.contains("(C-not exported)") {
 138                                         return ExportStatus::NoExport;
 139                                 } else if line.contains("(C-not implementable)") {
 140                                         return ExportStatus::NotImplementable;
 141                                 }
 142                         },
 143                         _ => unimplemented!(),
 144                 }
 145         }
 146         ExportStatus::Export
 147 }
 148
 149 pub fn assert_simple_bound(bound: &syn::TraitBound) {
 150         if bound.paren_token.is_some() { unimplemented!(); }
 151         if let syn::TraitBoundModifier::Maybe(_) = bound.modifier { unimplemented!(); }
 152 }
 153
 154 /// Returns true if the enum will be mapped as an opaue (ie struct with a pointer to the underlying
 155 /// type), otherwise it is mapped into a transparent, C-compatible version of itself.
 156 pub fn is_enum_opaque(e: &syn::ItemEnum) -> bool {
 157         for var in e.variants.iter() {
 158                 if let syn::Fields::Named(fields) = &var.fields {
 159                         for field in fields.named.iter() {
 160                                 match export_status(&field.attrs) {
 161                                         ExportStatus::Export|ExportStatus::TestOnly => {},
 162                                         ExportStatus::NotImplementable => panic!("(C-not implementable) should only appear on traits!"),
 163                                         ExportStatus::NoExport => return true,
 164                                 }
 165                         }
 166                 } else if let syn::Fields::Unnamed(fields) = &var.fields {
 167                         for field in fields.unnamed.iter() {
 168                                 match export_status(&field.attrs) {
 169                                         ExportStatus::Export|ExportStatus::TestOnly => {},
 170                                         ExportStatus::NotImplementable => panic!("(C-not implementable) should only appear on traits!"),
 171                                         ExportStatus::NoExport => return true,
 172                                 }
 173                         }
 174                 }
 175         }
 176         false
 177 }
 178
 179 /// A stack of sets of generic resolutions.
 180 ///
 181 /// This tracks the template parameters for a function, struct, or trait, allowing resolution into
 182 /// a concrete type. By pushing a new context onto the stack, this can track a function's template
 183 /// parameters inside of a generic struct or trait.
 184 ///
 185 /// It maps both direct types as well as Deref<Target = X>, mapping them via the provided
 186 /// TypeResolver's resolve_path function (ie traits map to the concrete jump table, structs to the
 187 /// concrete C container struct, etc).
 188 #[must_use]
 189 pub struct GenericTypes<'a, 'b> {
 190         self_ty: Option<String>,
 191         parent: Option<&'b GenericTypes<'b, 'b>>,
 192         typed_generics: HashMap<&'a syn::Ident, String>,
 193         default_generics: HashMap<&'a syn::Ident, (syn::Type, syn::Type, syn::Type)>,
 194 }
 195 impl<'a, 'p: 'a> GenericTypes<'a, 'p> {
 196         pub fn new(self_ty: Option<String>) -> Self {
 197                 Self { self_ty, parent: None, typed_generics: HashMap::new(), default_generics: HashMap::new(), }
 198         }
 199
 200         /// push a new context onto the stack, allowing for a new set of generics to be learned which
 201         /// will override any lower contexts, but which will still fall back to resoltion via lower
 202         /// contexts.
 203         pub fn push_ctx<'c>(&'c self) -> GenericTypes<'a, 'c> {
 204                 GenericTypes { self_ty: None, parent: Some(self), typed_generics: HashMap::new(), default_generics: HashMap::new(), }
 205         }
 206
 207         /// Learn the generics in generics in the current context, given a TypeResolver.
 208         pub fn learn_generics_with_impls<'b, 'c>(&mut self, generics: &'a syn::Generics, impld_generics: &'a syn::PathArguments, types: &'b TypeResolver<'a, 'c>) -> bool {
 209                 let mut new_typed_generics = HashMap::new();
 210                 // First learn simple generics...
 211                 for (idx, generic) in generics.params.iter().enumerate() {
 212                         match generic {
 213                                 syn::GenericParam::Type(type_param) => {
 214                                         let mut non_lifetimes_processed = false;
 215                                         'bound_loop: for bound in type_param.bounds.iter() {
 216                                                 if let syn::TypeParamBound::Trait(trait_bound) = bound {
 217                                                         if let Some(ident) = single_ident_generic_path_to_ident(&trait_bound.path) {
 218                                                                 match &format!("{}", ident) as &str { "Send" => continue, "Sync" => continue, _ => {} }
 219                                                         }
 220                                                         if path_matches_nongeneric(&trait_bound.path, &["core", "clone", "Clone"]) { continue; }
 221
 222                                                         assert_simple_bound(&trait_bound);
 223                                                         if let Some(path) = types.maybe_resolve_path(&trait_bound.path, None) {
 224                                                                 if types.skip_path(&path) { continue; }
 225                                                                 if path == "Sized" { continue; }
 226                                                                 if non_lifetimes_processed { return false; }
 227                                                                 non_lifetimes_processed = true;
 228                                                                 if path != "std::ops::Deref" && path != "core::ops::Deref" {
 229                                                                         let p = string_path_to_syn_path(&path);
 230                                                                         let ref_ty = parse_quote!(&#p);
 231                                                                         let mut_ref_ty = parse_quote!(&mut #p);
 232                                                                         self.default_generics.insert(&type_param.ident, (syn::Type::Path(syn::TypePath { qself: None, path: p }), ref_ty, mut_ref_ty));
 233                                                                         new_typed_generics.insert(&type_param.ident, Some(path));
 234                                                                 } else {
 235                                                                         // If we're templated on Deref<Target = ConcreteThing>, store
 236                                                                         // the reference type in `default_generics` which handles full
 237                                                                         // types and not just paths.
 238                                                                         if let syn::PathArguments::AngleBracketed(ref args) =
 239                                                                                         trait_bound.path.segments[0].arguments {
 240                                                                                 assert_eq!(trait_bound.path.segments.len(), 1);
 241                                                                                 for subargument in args.args.iter() {
 242                                                                                         match subargument {
 243                                                                                                 syn::GenericArgument::Lifetime(_) => {},
 244                                                                                                 syn::GenericArgument::Binding(ref b) => {
 245                                                                                                         if &format!("{}", b.ident) != "Target" { return false; }
 246                                                                                                         let default = &b.ty;
 247                                                                                                         self.default_generics.insert(&type_param.ident, (parse_quote!(&#default), parse_quote!(&#default), parse_quote!(&mut #default)));
 248                                                                                                         break 'bound_loop;
 249                                                                                                 },
 250                                                                                                 _ => unimplemented!(),
 251                                                                                         }
 252                                                                                 }
 253                                                                         } else {
 254                                                                                 new_typed_generics.insert(&type_param.ident, None);
 255                                                                         }
 256                                                                 }
 257                                                         }
 258                                                 }
 259                                         }
 260                                         if let Some(default) = type_param.default.as_ref() {
 261                                                 assert!(type_param.bounds.is_empty());
 262                                                 self.default_generics.insert(&type_param.ident, (default.clone(), parse_quote!(&#default), parse_quote!(&mut #default)));
 263                                         } else if type_param.bounds.is_empty() {
 264                                                 if let syn::PathArguments::AngleBracketed(args) = impld_generics {
 265                                                         match &args.args[idx] {
 266                                                                 syn::GenericArgument::Type(ty) => {
 267                                                                         self.default_generics.insert(&type_param.ident, (ty.clone(), parse_quote!(&#ty), parse_quote!(&mut #ty)));
 268                                                                 }
 269                                                                 _ => unimplemented!(),
 270                                                         }
 271                                                 }
 272                                         }
 273                                 },
 274                                 _ => {},
 275                         }
 276                 }
 277                 // Then find generics where we are required to pass a Deref<Target=X> and pretend its just X.
 278                 if let Some(wh) = &generics.where_clause {
 279                         for pred in wh.predicates.iter() {
 280                                 if let syn::WherePredicate::Type(t) = pred {
 281                                         if let syn::Type::Path(p) = &t.bounded_ty {
 282                                                 if first_seg_self(&t.bounded_ty).is_some() && p.path.segments.len() == 1 { continue; }
 283                                                 if p.qself.is_some() { return false; }
 284                                                 if p.path.leading_colon.is_some() { return false; }
 285                                                 let mut p_iter = p.path.segments.iter();
 286                                                 let p_ident = &p_iter.next().unwrap().ident;
 287                                                 if let Some(gen) = new_typed_generics.get_mut(p_ident) {
 288                                                         if gen.is_some() { return false; }
 289                                                         if &format!("{}", p_iter.next().unwrap().ident) != "Target" {return false; }
 290
 291                                                         let mut non_lifetimes_processed = false;
 292                                                         for bound in t.bounds.iter() {
 293                                                                 if let syn::TypeParamBound::Trait(trait_bound) = bound {
 294                                                                         if let Some(id) = trait_bound.path.get_ident() {
 295                                                                                 if format!("{}", id) == "Sized" { continue; }
 296                                                                         }
 297                                                                         if non_lifetimes_processed { return false; }
 298                                                                         non_lifetimes_processed = true;
 299                                                                         assert_simple_bound(&trait_bound);
 300                                                                         let resolved = types.resolve_path(&trait_bound.path, None);
 301                                                                         let ty = syn::Type::Path(syn::TypePath {
 302                                                                                 qself: None, path: string_path_to_syn_path(&resolved)
 303                                                                         });
 304                                                                         let ref_ty = parse_quote!(&#ty);
 305                                                                         let mut_ref_ty = parse_quote!(&mut #ty);
 306                                                                         if types.crate_types.traits.get(&resolved).is_some() {
 307                                                                                 self.default_generics.insert(p_ident, (ty, ref_ty, mut_ref_ty));
 308                                                                         } else {
 309                                                                                 self.default_generics.insert(p_ident, (ref_ty.clone(), ref_ty, mut_ref_ty));
 310                                                                         }
 311
 312                                                                         *gen = Some(resolved);
 313                                                                 }
 314                                                         }
 315                                                 } else { return false; }
 316                                         } else { return false; }
 317                                 }
 318                         }
 319                 }
 320                 for (key, value) in new_typed_generics.drain() {
 321                         if let Some(v) = value {
 322                                 assert!(self.typed_generics.insert(key, v).is_none());
 323                         } else { return false; }
 324                 }
 325                 true
 326         }
 327
 328         /// Learn the generics in generics in the current context, given a TypeResolver.
 329         pub fn learn_generics<'b, 'c>(&mut self, generics: &'a syn::Generics, types: &'b TypeResolver<'a, 'c>) -> bool {
 330                 self.learn_generics_with_impls(generics, &syn::PathArguments::None, types)
 331         }
 332
 333         /// Learn the associated types from the trait in the current context.
 334         pub fn learn_associated_types<'b, 'c>(&mut self, t: &'a syn::ItemTrait, types: &'b TypeResolver<'a, 'c>) {
 335                 for item in t.items.iter() {
 336                         match item {
 337                                 &syn::TraitItem::Type(ref t) => {
 338                                         if t.default.is_some() || t.generics.lt_token.is_some() { unimplemented!(); }
 339                                         let mut bounds_iter = t.bounds.iter();
 340                                         loop {
 341                                                 match bounds_iter.next().unwrap() {
 342                                                         syn::TypeParamBound::Trait(tr) => {
 343                                                                 assert_simple_bound(&tr);
 344                                                                 if let Some(path) = types.maybe_resolve_path(&tr.path, None) {
 345                                                                         if types.skip_path(&path) { continue; }
 346                                                                         // In general we handle Deref<Target=X> as if it were just X (and
 347                                                                         // implement Deref<Target=Self> for relevant types). We don't
 348                                                                         // bother to implement it for associated types, however, so we just
 349                                                                         // ignore such bounds.
 350                                                                         if path != "std::ops::Deref" && path != "core::ops::Deref" {
 351                                                                                 self.typed_generics.insert(&t.ident, path);
 352                                                                         }
 353                                                                 } else { unimplemented!(); }
 354                                                                 for bound in bounds_iter {
 355                                                                         if let syn::TypeParamBound::Trait(_) = bound { unimplemented!(); }
 356                                                                 }
 357                                                                 break;
 358                                                         },
 359                                                         syn::TypeParamBound::Lifetime(_) => {},
 360                                                 }
 361                                         }
 362                                 },
 363                                 _ => {},
 364                         }
 365                 }
 366         }
 367
 368         /// Attempt to resolve a Path as a generic parameter and return the full path. as both a string
 369         /// and syn::Path.
 370         pub fn maybe_resolve_path<'b>(&'b self, path: &syn::Path) -> Option<&'b String> {
 371                 if let Some(ident) = path.get_ident() {
 372                         if let Some(ty) = &self.self_ty {
 373                                 if format!("{}", ident) == "Self" {
 374                                         return Some(&ty);
 375                                 }
 376                         }
 377                         if let Some(res) = self.typed_generics.get(ident) {
 378                                 return Some(res);
 379                         }
 380                 } else {
 381                         // Associated types are usually specified as "Self::Generic", so we check for that
 382                         // explicitly here.
 383                         let mut it = path.segments.iter();
 384                         if path.segments.len() == 2 && format!("{}", it.next().unwrap().ident) == "Self" {
 385                                 let ident = &it.next().unwrap().ident;
 386                                 if let Some(res) = self.typed_generics.get(ident) {
 387                                         return Some(res);
 388                                 }
 389                         }
 390                 }
 391                 if let Some(parent) = self.parent {
 392                         parent.maybe_resolve_path(path)
 393                 } else {
 394                         None
 395                 }
 396         }
 397 }
 398
 399 pub trait ResolveType<'a> { fn resolve_type(&'a self, ty: &'a syn::Type) -> &'a syn::Type; }
 400 impl<'a, 'b, 'c: 'a + 'b> ResolveType<'c> for Option<&GenericTypes<'a, 'b>> {
 401         fn resolve_type(&'c self, ty: &'c syn::Type) -> &'c syn::Type {
 402                 if let Some(us) = self {
 403                         match ty {
 404                                 syn::Type::Path(p) => {
 405                                         if let Some(ident) = p.path.get_ident() {
 406                                                 if let Some((ty, _, _)) = us.default_generics.get(ident) {
 407                                                         return self.resolve_type(ty);
 408                                                 }
 409                                         }
 410                                 },
 411                                 syn::Type::Reference(syn::TypeReference { elem, mutability, .. }) => {
 412                                         if let syn::Type::Path(p) = &**elem {
 413                                                 if let Some(ident) = p.path.get_ident() {
 414                                                         if let Some((_, refty, mut_ref_ty)) = us.default_generics.get(ident) {
 415                                                                 if mutability.is_some() {
 416                                                                         return self.resolve_type(mut_ref_ty);
 417                                                                 } else {
 418                                                                         return self.resolve_type(refty);
 419                                                                 }
 420                                                         }
 421                                                 }
 422                                         }
 423                                 }
 424                                 _ => {},
 425                         }
 426                         us.parent.resolve_type(ty)
 427                 } else { ty }
 428         }
 429 }
 430
 431 #[derive(Clone, PartialEq)]
 432 // The type of declaration and the object itself
 433 pub enum DeclType<'a> {
 434         MirroredEnum,
 435         Trait(&'a syn::ItemTrait),
 436         StructImported { generics: &'a syn::Generics  },
 437         StructIgnored,
 438         EnumIgnored { generics: &'a syn::Generics },
 439 }
 440
 441 pub struct ImportResolver<'mod_lifetime, 'crate_lft: 'mod_lifetime> {
 442         pub crate_name: &'mod_lifetime str,
 443         library: &'crate_lft FullLibraryAST,
 444         module_path: &'mod_lifetime str,
 445         imports: HashMap<syn::Ident, (String, syn::Path)>,
 446         declared: HashMap<syn::Ident, DeclType<'crate_lft>>,
 447         priv_modules: HashSet<syn::Ident>,
 448 }
 449 impl<'mod_lifetime, 'crate_lft: 'mod_lifetime> ImportResolver<'mod_lifetime, 'crate_lft> {
 450         fn walk_use_intern<F: FnMut(syn::Ident, (String, syn::Path))>(
 451                 crate_name: &str, module_path: &str, dependencies: &HashSet<syn::Ident>, u: &syn::UseTree,
 452                 partial_path: &str,
 453                 mut path: syn::punctuated::Punctuated<syn::PathSegment, syn::token::Colon2>, handle_use: &mut F
 454         ) {
 455                 let new_path;
 456                 macro_rules! push_path {
 457                         ($ident: expr, $path_suffix: expr) => {
 458                                 if partial_path == "" && format!("{}", $ident) == "super" {
 459                                         let mut mod_iter = module_path.rsplitn(2, "::");
 460                                         mod_iter.next().unwrap();
 461                                         let super_mod = mod_iter.next().unwrap();
 462                                         new_path = format!("{}{}", super_mod, $path_suffix);
 463                                         assert_eq!(path.len(), 0);
 464                                         for module in super_mod.split("::") {
 465                                                 path.push(syn::PathSegment { ident: syn::Ident::new(module, Span::call_site()), arguments: syn::PathArguments::None });
 466                                         }
 467                                 } else if partial_path == "" && format!("{}", $ident) == "self" {
 468                                         new_path = format!("{}{}", module_path, $path_suffix);
 469                                         for module in module_path.split("::") {
 470                                                 path.push(syn::PathSegment { ident: syn::Ident::new(module, Span::call_site()), arguments: syn::PathArguments::None });
 471                                         }
 472                                 } else if partial_path == "" && format!("{}", $ident) == "crate" {
 473                                         new_path = format!("{}{}", crate_name, $path_suffix);
 474                                         let crate_name_ident = format_ident!("{}", crate_name);
 475                                         path.push(parse_quote!(#crate_name_ident));
 476                                 } else if partial_path == "" && !dependencies.contains(&$ident) {
 477                                         new_path = format!("{}::{}{}", crate_name, $ident, $path_suffix);
 478                                         let crate_name_ident = format_ident!("{}", crate_name);
 479                                         path.push(parse_quote!(#crate_name_ident));
 480                                 } else if format!("{}", $ident) == "self" {
 481                                         let mut path_iter = partial_path.rsplitn(2, "::");
 482                                         path_iter.next().unwrap();
 483                                         new_path = path_iter.next().unwrap().to_owned();
 484                                 } else {
 485                                         new_path = format!("{}{}{}", partial_path, $ident, $path_suffix);
 486                                 }
 487                                 let ident = &$ident;
 488                                 path.push(parse_quote!(#ident));
 489                         }
 490                 }
 491                 match u {
 492                         syn::UseTree::Path(p) => {
 493                                 push_path!(p.ident, "::");
 494                                 Self::walk_use_intern(crate_name, module_path, dependencies, &p.tree, &new_path, path, handle_use);
 495                         },
 496                         syn::UseTree::Name(n) => {
 497                                 push_path!(n.ident, "");
 498                                 let imported_ident = syn::Ident::new(new_path.rsplitn(2, "::").next().unwrap(), Span::call_site());
 499                                 handle_use(imported_ident, (new_path, syn::Path { leading_colon: Some(syn::Token![::](Span::call_site())), segments: path }));
 500                         },
 501                         syn::UseTree::Group(g) => {
 502                                 for i in g.items.iter() {
 503                                         Self::walk_use_intern(crate_name, module_path, dependencies, i, partial_path, path.clone(), handle_use);
 504                                 }
 505                         },
 506                         syn::UseTree::Rename(r) => {
 507                                 push_path!(r.ident, "");
 508                                 handle_use(r.rename.clone(), (new_path, syn::Path { leading_colon: Some(syn::Token![::](Span::call_site())), segments: path }));
 509                         },
 510                         syn::UseTree::Glob(_) => {
 511                                 eprintln!("Ignoring * use for {} - this may result in resolution failures", partial_path);
 512                         },
 513                 }
 514         }
 515
 516         fn process_use_intern(crate_name: &str, module_path: &str, dependencies: &HashSet<syn::Ident>,
 517                 imports: &mut HashMap<syn::Ident, (String, syn::Path)>, u: &syn::UseTree, partial_path: &str,
 518                 path: syn::punctuated::Punctuated<syn::PathSegment, syn::token::Colon2>
 519         ) {
 520                 Self::walk_use_intern(crate_name, module_path, dependencies, u, partial_path, path,
 521                         &mut |k, v| { imports.insert(k, v); });
 522         }
 523
 524         fn process_use(crate_name: &str, module_path: &str, dependencies: &HashSet<syn::Ident>, imports: &mut HashMap<syn::Ident, (String, syn::Path)>, u: &syn::ItemUse) {
 525                 if u.leading_colon.is_some() { eprintln!("Ignoring leading-colon use!"); return; }
 526                 Self::process_use_intern(crate_name, module_path, dependencies, imports, &u.tree, "", syn::punctuated::Punctuated::new());
 527         }
 528
 529         fn insert_primitive(imports: &mut HashMap<syn::Ident, (String, syn::Path)>, id: &str) {
 530                 let ident = format_ident!("{}", id);
 531                 let path = parse_quote!(#ident);
 532                 imports.insert(ident, (id.to_owned(), path));
 533         }
 534
 535         pub fn new(crate_name: &'mod_lifetime str, library: &'crate_lft FullLibraryAST, module_path: &'mod_lifetime str, contents: &'crate_lft [syn::Item]) -> Self {
 536                 Self::from_borrowed_items(crate_name, library, module_path, &contents.iter().map(|a| a).collect::<Vec<_>>())
 537         }
 538         pub fn from_borrowed_items(crate_name: &'mod_lifetime str, library: &'crate_lft FullLibraryAST, module_path: &'mod_lifetime str, contents: &[&'crate_lft syn::Item]) -> Self {
 539                 let mut imports = HashMap::new();
 540                 // Add primitives to the "imports" list:
 541                 Self::insert_primitive(&mut imports, "bool");
 542                 Self::insert_primitive(&mut imports, "u128");
 543                 Self::insert_primitive(&mut imports, "u64");
 544                 Self::insert_primitive(&mut imports, "u32");
 545                 Self::insert_primitive(&mut imports, "u16");
 546                 Self::insert_primitive(&mut imports, "u8");
 547                 Self::insert_primitive(&mut imports, "usize");
 548                 Self::insert_primitive(&mut imports, "str");
 549                 Self::insert_primitive(&mut imports, "String");
 550
 551                 // These are here to allow us to print native Rust types in trait fn impls even if we don't
 552                 // have C mappings:
 553                 Self::insert_primitive(&mut imports, "Result");
 554                 Self::insert_primitive(&mut imports, "Vec");
 555                 Self::insert_primitive(&mut imports, "Option");
 556
 557                 let mut declared = HashMap::new();
 558                 let mut priv_modules = HashSet::new();
 559
 560                 for item in contents.iter() {
 561                         match item {
 562                                 syn::Item::Use(u) => Self::process_use(crate_name, module_path, &library.dependencies, &mut imports, &u),
 563                                 syn::Item::Struct(s) => {
 564                                         if let syn::Visibility::Public(_) = s.vis {
 565                                                 match export_status(&s.attrs) {
 566                                                         ExportStatus::Export => { declared.insert(s.ident.clone(), DeclType::StructImported { generics: &s.generics }); },
 567                                                         ExportStatus::NoExport => { declared.insert(s.ident.clone(), DeclType::StructIgnored); },
 568                                                         ExportStatus::TestOnly => continue,
 569                                                         ExportStatus::NotImplementable => panic!("(C-not implementable) should only appear on traits!"),
 570                                                 }
 571                                         }
 572                                 },
 573                                 syn::Item::Type(t) if export_status(&t.attrs) == ExportStatus::Export => {
 574                                         if let syn::Visibility::Public(_) = t.vis {
 575                                                 declared.insert(t.ident.clone(), DeclType::StructImported { generics: &t.generics });
 576                                         }
 577                                 },
 578                                 syn::Item::Enum(e) => {
 579                                         if let syn::Visibility::Public(_) = e.vis {
 580                                                 match export_status(&e.attrs) {
 581                                                         ExportStatus::Export if is_enum_opaque(e) => { declared.insert(e.ident.clone(), DeclType::EnumIgnored { generics: &e.generics }); },
 582                                                         ExportStatus::Export => { declared.insert(e.ident.clone(), DeclType::MirroredEnum); },
 583                                                         ExportStatus::NotImplementable => panic!("(C-not implementable) should only appear on traits!"),
 584                                                         _ => continue,
 585                                                 }
 586                                         }
 587                                 },
 588                                 syn::Item::Trait(t) => {
 589                                         match export_status(&t.attrs) {
 590                                                 ExportStatus::Export|ExportStatus::NotImplementable => {
 591                                                         if let syn::Visibility::Public(_) = t.vis {
 592                                                                 declared.insert(t.ident.clone(), DeclType::Trait(t));
 593                                                         }
 594                                                 },
 595                                                 _ => continue,
 596                                         }
 597                                 },
 598                                 syn::Item::Mod(m) => {
 599                                         priv_modules.insert(m.ident.clone());
 600                                 },
 601                                 _ => {},
 602                         }
 603                 }
 604
 605                 Self { crate_name, library, module_path, imports, declared, priv_modules }
 606         }
 607
 608         pub fn maybe_resolve_declared(&self, id: &syn::Ident) -> Option<&DeclType<'crate_lft>> {
 609                 self.declared.get(id)
 610         }
 611
 612         pub fn maybe_resolve_ident(&self, id: &syn::Ident) -> Option<String> {
 613                 if let Some((imp, _)) = self.imports.get(id) {
 614                         Some(imp.clone())
 615                 } else if self.declared.get(id).is_some() {
 616                         Some(self.module_path.to_string() + "::" + &format!("{}", id))
 617                 } else { None }
 618         }
 619
 620         fn maybe_resolve_imported_path(&self, p: &syn::Path, generics: Option<&GenericTypes>) -> Option<String> {
 621                 if let Some(gen_types) = generics {
 622                         if let Some(resp) = gen_types.maybe_resolve_path(p) {
 623                                 return Some(resp.clone());
 624                         }
 625                 }
 626
 627                 if p.leading_colon.is_some() {
 628                         let mut res: String = p.segments.iter().enumerate().map(|(idx, seg)| {
 629                                 format!("{}{}", if idx == 0 { "" } else { "::" }, seg.ident)
 630                         }).collect();
 631                         let firstseg = p.segments.iter().next().unwrap();
 632                         if !self.library.dependencies.contains(&firstseg.ident) {
 633                                 res = self.crate_name.to_owned() + "::" + &res;
 634                         }
 635                         Some(res)
 636                 } else if let Some(id) = p.get_ident() {
 637                         self.maybe_resolve_ident(id)
 638                 } else {
 639                         if p.segments.len() == 1 {
 640                                 let seg = p.segments.iter().next().unwrap();
 641                                 return self.maybe_resolve_ident(&seg.ident);
 642                         }
 643                         let mut seg_iter = p.segments.iter();
 644                         let first_seg = seg_iter.next().unwrap();
 645                         let remaining: String = seg_iter.map(|seg| {
 646                                 format!("::{}", seg.ident)
 647                         }).collect();
 648                         let first_seg_str = format!("{}", first_seg.ident);
 649                         if let Some((imp, _)) = self.imports.get(&first_seg.ident) {
 650                                 if remaining != "" {
 651                                         Some(imp.clone() + &remaining)
 652                                 } else {
 653                                         Some(imp.clone())
 654                                 }
 655                         } else if let Some(_) = self.priv_modules.get(&first_seg.ident) {
 656                                 Some(format!("{}::{}{}", self.module_path, first_seg.ident, remaining))
 657                         } else if first_seg_is_stdlib(&first_seg_str) || self.library.dependencies.contains(&first_seg.ident) {
 658                                 Some(first_seg_str + &remaining)
 659                         } else if first_seg_str == "crate" {
 660                                 Some(self.crate_name.to_owned() + &remaining)
 661                         } else { None }
 662                 }
 663         }
 664
 665         pub fn maybe_resolve_path(&self, p: &syn::Path, generics: Option<&GenericTypes>) -> Option<String> {
 666                 self.maybe_resolve_imported_path(p, generics).map(|mut path| {
 667                         loop {
 668                                 // Now that we've resolved the path to the path as-imported, check whether the path
 669                                 // is actually a pub(.*) use statement and map it to the real path.
 670                                 let path_tmp = path.clone();
 671                                 let crate_name = path_tmp.splitn(2, "::").next().unwrap();
 672                                 let mut module_riter = path_tmp.rsplitn(2, "::");
 673                                 let obj = module_riter.next().unwrap();
 674                                 if let Some(module_path) = module_riter.next() {
 675                                         if let Some(m) = self.library.modules.get(module_path) {
 676                                                 for item in m.items.iter() {
 677                                                         if let syn::Item::Use(syn::ItemUse { vis, tree, .. }) = item {
 678                                                                 match vis {
 679                                                                         syn::Visibility::Public(_)|
 680                                                                         syn::Visibility::Crate(_)|
 681                                                                         syn::Visibility::Restricted(_) => {
 682                                                                                 Self::walk_use_intern(crate_name, module_path,
 683                                                                                         &self.library.dependencies, tree, "",
 684                                                                                         syn::punctuated::Punctuated::new(), &mut |ident, (use_path, _)| {
 685                                                                                                 if format!("{}", ident) == obj {
 686                                                                                                         path = use_path;
 687                                                                                                 }
 688                                                                                 });
 689                                                                         },
 690                                                                         syn::Visibility::Inherited => {},
 691                                                                 }
 692                                                         }
 693                                                 }
 694                                         }
 695                                 }
 696                                 break;
 697                         }
 698                         path
 699                 })
 700         }
 701
 702         /// Map all the Paths in a Type into absolute paths given a set of imports (generated via process_use_intern)
 703         pub fn resolve_imported_refs(&self, mut ty: syn::Type) -> syn::Type {
 704                 match &mut ty {
 705                         syn::Type::Path(p) => {
 706                                 if p.path.segments.len() != 1 { unimplemented!(); }
 707                                 let mut args = p.path.segments[0].arguments.clone();
 708                                 if let syn::PathArguments::AngleBracketed(ref mut generics) = &mut args {
 709                                         for arg in generics.args.iter_mut() {
 710                                                 if let syn::GenericArgument::Type(ref mut t) = arg {
 711                                                         *t = self.resolve_imported_refs(t.clone());
 712                                                 }
 713                                         }
 714                                 }
 715                                 if let Some((_, newpath)) = self.imports.get(single_ident_generic_path_to_ident(&p.path).unwrap()) {
 716                                         p.path = newpath.clone();
 717                                 }
 718                                 p.path.segments[0].arguments = args;
 719                         },
 720                         syn::Type::Reference(r) => {
 721                                 r.elem = Box::new(self.resolve_imported_refs((*r.elem).clone()));
 722                         },
 723                         syn::Type::Slice(s) => {
 724                                 s.elem = Box::new(self.resolve_imported_refs((*s.elem).clone()));
 725                         },
 726                         syn::Type::Tuple(t) => {
 727                                 for e in t.elems.iter_mut() {
 728                                         *e = self.resolve_imported_refs(e.clone());
 729                                 }
 730                         },
 731                         _ => unimplemented!(),
 732                 }
 733                 ty
 734         }
 735 }
 736
 737 // templates_defined is walked to write the C++ header, so if we use the default hashing it get
 738 // reordered on each genbindings run. Instead, we use SipHasher (which defaults to 0-keys) so that
 739 // the sorting is stable across runs. It is deprecated, but the "replacement" doesn't actually
 740 // accomplish the same goals, so we just ignore it.
 741 #[allow(deprecated)]
 742 pub type NonRandomHash = hash::BuildHasherDefault<hash::SipHasher>;
 743
 744 /// A public module
 745 pub struct ASTModule {
 746         pub attrs: Vec<syn::Attribute>,
 747         pub items: Vec<syn::Item>,
 748         pub submods: Vec<String>,
 749 }
 750 /// A struct containing the syn::File AST for each file in the crate.
 751 pub struct FullLibraryAST {
 752         pub modules: HashMap<String, ASTModule, NonRandomHash>,
 753         pub dependencies: HashSet<syn::Ident>,
 754 }
 755 impl FullLibraryAST {
 756         fn load_module(&mut self, module: String, attrs: Vec<syn::Attribute>, mut items: Vec<syn::Item>) {
 757                 let mut non_mod_items = Vec::with_capacity(items.len());
 758                 let mut submods = Vec::with_capacity(items.len());
 759                 for item in items.drain(..) {
 760                         match item {
 761                                 syn::Item::Mod(m) if m.content.is_some() => {
 762                                         if export_status(&m.attrs) == ExportStatus::Export {
 763                                                 if let syn::Visibility::Public(_) = m.vis {
 764                                                         let modident = format!("{}", m.ident);
 765                                                         let modname = if module != "" {
 766                                                                 module.clone() + "::" + &modident
 767                                                         } else {
 768                                                                 self.dependencies.insert(m.ident);
 769                                                                 modident.clone()
 770                                                         };
 771                                                         self.load_module(modname, m.attrs, m.content.unwrap().1);
 772                                                         submods.push(modident);
 773                                                 } else {
 774                                                         non_mod_items.push(syn::Item::Mod(m));
 775                                                 }
 776                                         }
 777                                 },
 778                                 syn::Item::Mod(_) => panic!("--pretty=expanded output should never have non-body modules"),
 779                                 syn::Item::ExternCrate(c) => {
 780                                         if export_status(&c.attrs) == ExportStatus::Export {
 781                                                 self.dependencies.insert(c.ident);
 782                                         }
 783                                 },
 784                                 _ => { non_mod_items.push(item); }
 785                         }
 786                 }
 787                 self.modules.insert(module, ASTModule { attrs, items: non_mod_items, submods });
 788         }
 789
 790         pub fn load_lib(lib: syn::File) -> Self {
 791                 assert_eq!(export_status(&lib.attrs), ExportStatus::Export);
 792                 let mut res = Self { modules: HashMap::default(), dependencies: HashSet::new() };
 793                 res.load_module("".to_owned(), lib.attrs, lib.items);
 794                 res
 795         }
 796 }
 797
 798 /// List of manually-generated types which are clonable
 799 fn initial_clonable_types() -> HashSet<String> {
 800         let mut res = HashSet::new();
 801         res.insert("crate::c_types::U5".to_owned());
 802         res.insert("crate::c_types::U128".to_owned());
 803         res.insert("crate::c_types::FourBytes".to_owned());
 804         res.insert("crate::c_types::TwelveBytes".to_owned());
 805         res.insert("crate::c_types::SixteenBytes".to_owned());
 806         res.insert("crate::c_types::TwentyBytes".to_owned());
 807         res.insert("crate::c_types::ThirtyTwoBytes".to_owned());
 808         res.insert("crate::c_types::EightU16s".to_owned());
 809         res.insert("crate::c_types::SecretKey".to_owned());
 810         res.insert("crate::c_types::PublicKey".to_owned());
 811         res.insert("crate::c_types::Transaction".to_owned());
 812         res.insert("crate::c_types::Witness".to_owned());
 813         res.insert("crate::c_types::TxOut".to_owned());
 814         res.insert("crate::c_types::Signature".to_owned());
 815         res.insert("crate::c_types::RecoverableSignature".to_owned());
 816         res.insert("crate::c_types::Bech32Error".to_owned());
 817         res.insert("crate::c_types::Secp256k1Error".to_owned());
 818         res.insert("crate::c_types::IOError".to_owned());
 819         res.insert("crate::c_types::Error".to_owned());
 820         res.insert("crate::c_types::Str".to_owned());
 821
 822         // Because some types are manually-mapped to CVec_u8Z we may end up checking if its clonable
 823         // before we ever get to constructing the type fully via
 824         // `write_c_mangled_container_path_intern` (which will add it here too), so we have to manually
 825         // add it on startup.
 826         res.insert("crate::c_types::derived::CVec_u8Z".to_owned());
 827         res
 828 }
 829
 830 /// Top-level struct tracking everything which has been defined while walking the crate.
 831 pub struct CrateTypes<'a> {
 832         /// This may contain structs or enums, but only when either is mapped as
 833         /// struct X { inner: *mut originalX, .. }
 834         pub opaques: HashMap<String, (&'a syn::Ident, &'a syn::Generics)>,
 835         /// structs that weren't exposed
 836         pub priv_structs: HashMap<String, &'a syn::Generics>,
 837         /// Enums which are mapped as C enums with conversion functions
 838         pub mirrored_enums: HashMap<String, &'a syn::ItemEnum>,
 839         /// Traits which are mapped as a pointer + jump table
 840         pub traits: HashMap<String, &'a syn::ItemTrait>,
 841         /// Aliases from paths to some other Type
 842         pub type_aliases: HashMap<String, syn::Type>,
 843         /// Value is an alias to Key (maybe with some generics)
 844         pub reverse_alias_map: HashMap<String, Vec<(String, syn::PathArguments)>>,
 845         /// Template continer types defined, map from mangled type name -> whether a destructor fn
 846         /// exists.
 847         ///
 848         /// This is used at the end of processing to make C++ wrapper classes
 849         pub templates_defined: RefCell<HashMap<String, bool, NonRandomHash>>,
 850         /// The output file for any created template container types, written to as we find new
 851         /// template containers which need to be defined.
 852         template_file: RefCell<&'a mut File>,
 853         /// Set of containers which are clonable
 854         clonable_types: RefCell<HashSet<String>>,
 855         /// Key impls Value
 856         pub trait_impls: HashMap<String, Vec<String>>,
 857         /// The full set of modules in the crate(s)
 858         pub lib_ast: &'a FullLibraryAST,
 859 }
 860
 861 impl<'a> CrateTypes<'a> {
 862         pub fn new(template_file: &'a mut File, libast: &'a FullLibraryAST) -> Self {
 863                 CrateTypes {
 864                         opaques: HashMap::new(), mirrored_enums: HashMap::new(), traits: HashMap::new(),
 865                         type_aliases: HashMap::new(), reverse_alias_map: HashMap::new(),
 866                         templates_defined: RefCell::new(HashMap::default()), priv_structs: HashMap::new(),
 867                         clonable_types: RefCell::new(initial_clonable_types()), trait_impls: HashMap::new(),
 868                         template_file: RefCell::new(template_file), lib_ast: &libast,
 869                 }
 870         }
 871         pub fn set_clonable(&self, object: String) {
 872                 self.clonable_types.borrow_mut().insert(object);
 873         }
 874         pub fn is_clonable(&self, object: &str) -> bool {
 875                 self.clonable_types.borrow().contains(object)
 876         }
 877         pub fn write_new_template(&self, mangled_container: String, has_destructor: bool, created_container: &[u8]) {
 878                 self.template_file.borrow_mut().write(created_container).unwrap();
 879                 self.templates_defined.borrow_mut().insert(mangled_container, has_destructor);
 880         }
 881 }
 882
 883 /// A struct which tracks resolving rust types into C-mapped equivalents, exists for one specific
 884 /// module but contains a reference to the overall CrateTypes tracking.
 885 pub struct TypeResolver<'mod_lifetime, 'crate_lft: 'mod_lifetime> {
 886         pub module_path: &'mod_lifetime str,
 887         pub crate_types: &'mod_lifetime CrateTypes<'crate_lft>,
 888         pub types: ImportResolver<'mod_lifetime, 'crate_lft>,
 889 }
 890
 891 /// Returned by write_empty_rust_val_check_suffix to indicate what type of dereferencing needs to
 892 /// happen to get the inner value of a generic.
 893 enum EmptyValExpectedTy {
 894         /// A type which has a flag for being empty (eg an array where we treat all-0s as empty).
 895         NonPointer,
 896         /// A Option mapped as a COption_*Z
 897         OptionType,
 898         /// A pointer which we want to convert to a reference.
 899         ReferenceAsPointer,
 900 }
 901
 902 #[derive(PartialEq)]
 903 /// Describes the appropriate place to print a general type-conversion string when converting a
 904 /// container.
 905 enum ContainerPrefixLocation {
 906         /// Prints a general type-conversion string prefix and suffix outside of the
 907         /// container-conversion strings.
 908         OutsideConv,
 909         /// Prints a general type-conversion string prefix and suffix inside of the
 910         /// container-conversion strings.
 911         PerConv,
 912         /// Does not print the usual type-conversion string prefix and suffix.
 913         NoPrefix,
 914 }
 915
 916 impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
 917         pub fn new(module_path: &'a str, types: ImportResolver<'a, 'c>, crate_types: &'a CrateTypes<'c>) -> Self {
 918                 Self { module_path, types, crate_types }
 919         }
 920
 921         // *************************************************
 922         // *** Well know type and conversion definitions ***
 923         // *************************************************
 924
 925         /// Returns true we if can just skip passing this to C entirely
 926         pub fn skip_path(&self, full_path: &str) -> bool {
 927                 full_path == "bitcoin::secp256k1::Secp256k1" ||
 928                 full_path == "bitcoin::secp256k1::Signing" ||
 929                 full_path == "bitcoin::secp256k1::Verification"
 930         }
 931         /// Returns true we if can just skip passing this to C entirely
 932         fn no_arg_path_to_rust(&self, full_path: &str) -> &str {
 933                 if full_path == "bitcoin::secp256k1::Secp256k1" {
 934                         "secp256k1::global::SECP256K1"
 935                 } else { unimplemented!(); }
 936         }
 937
 938         /// Returns true if the object is a primitive and is mapped as-is with no conversion
 939         /// whatsoever.
 940         pub fn is_primitive(&self, full_path: &str) -> bool {
 941                 match full_path {
 942                         "bool" => true,
 943                         "u64" => true,
 944                         "u32" => true,
 945                         "u16" => true,
 946                         "u8" => true,
 947                         "usize" => true,
 948                         _ => false,
 949                 }
 950         }
 951         pub fn is_clonable(&self, ty: &str) -> bool {
 952                 if self.crate_types.is_clonable(ty) { return true; }
 953                 if self.is_primitive(ty) { return true; }
 954                 match ty {
 955                         "()" => true,
 956                         _ => false,
 957                 }
 958         }
 959         /// Gets the C-mapped type for types which are outside of the crate, or which are manually
 960         /// ignored by for some reason need mapping anyway.
 961         fn c_type_from_path<'b>(&self, full_path: &'b str, is_ref: bool, _ptr_for_ref: bool) -> Option<&'b str> {
 962                 if self.is_primitive(full_path) {
 963                         return Some(full_path);
 964                 }
 965                 match full_path {
 966                         // Note that no !is_ref types can map to an array because Rust and C's call semantics
 967                         // for arrays are different (https://github.com/eqrion/cbindgen/issues/528)
 968
 969                         "[u8; 32]" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
 970                         "[u8; 20]" if !is_ref => Some("crate::c_types::TwentyBytes"),
 971                         "[u8; 16]" if !is_ref => Some("crate::c_types::SixteenBytes"),
 972                         "[u8; 12]" if !is_ref => Some("crate::c_types::TwelveBytes"),
 973                         "[u8; 4]" if !is_ref => Some("crate::c_types::FourBytes"),
 974                         "[u8; 3]" if !is_ref => Some("crate::c_types::ThreeBytes"), // Used for RGB values
 975                         "[u16; 8]" if !is_ref => Some("crate::c_types::EightU16s"),
 976
 977                         "str" if is_ref => Some("crate::c_types::Str"),
 978                         "alloc::string::String"|"String" => Some("crate::c_types::Str"),
 979
 980                         "std::time::Duration"|"core::time::Duration" => Some("u64"),
 981                         "std::time::SystemTime" => Some("u64"),
 982                         "std::io::Error"|"lightning::io::Error"|"lightning::io::ErrorKind" => Some("crate::c_types::IOError"),
 983                         "core::fmt::Arguments" if is_ref => Some("crate::c_types::Str"),
 984
 985                         "core::convert::Infallible" => Some("crate::c_types::NotConstructable"),
 986
 987                         "bitcoin::bech32::Error"|"bech32::Error"
 988                                 if !is_ref => Some("crate::c_types::Bech32Error"),
 989                         "bitcoin::secp256k1::Error"|"secp256k1::Error"
 990                                 if !is_ref => Some("crate::c_types::Secp256k1Error"),
 991
 992                         "core::num::ParseIntError" => Some("crate::c_types::Error"),
 993                         "core::str::Utf8Error" => Some("crate::c_types::Error"),
 994
 995                         "bitcoin::bech32::u5"|"bech32::u5" => Some("crate::c_types::U5"),
 996                         "u128" => Some("crate::c_types::U128"),
 997                         "core::num::NonZeroU8" => Some("u8"),
 998
 999                         "secp256k1::PublicKey"|"bitcoin::secp256k1::PublicKey" => Some("crate::c_types::PublicKey"),
1000                         "bitcoin::secp256k1::ecdsa::Signature" => Some("crate::c_types::Signature"),
1001                         "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some("crate::c_types::RecoverableSignature"),
1002                         "bitcoin::secp256k1::SecretKey" if is_ref  => Some("*const [u8; 32]"),
1003                         "bitcoin::secp256k1::SecretKey" if !is_ref => Some("crate::c_types::SecretKey"),
1004                         "bitcoin::secp256k1::Scalar" if is_ref  => Some("*const crate::c_types::BigEndianScalar"),
1005                         "bitcoin::secp256k1::Scalar" if !is_ref => Some("crate::c_types::BigEndianScalar"),
1006                         "bitcoin::secp256k1::ecdh::SharedSecret" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
1007
1008                         "bitcoin::blockdata::script::Script" if is_ref => Some("crate::c_types::u8slice"),
1009                         "bitcoin::blockdata::script::Script" if !is_ref => Some("crate::c_types::derived::CVec_u8Z"),
1010                         "bitcoin::blockdata::transaction::OutPoint" => Some("crate::lightning::chain::transaction::OutPoint"),
1011                         "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some("crate::c_types::Transaction"),
1012                         "bitcoin::Witness" => Some("crate::c_types::Witness"),
1013                         "bitcoin::TxOut"|"bitcoin::blockdata::transaction::TxOut" if !is_ref => Some("crate::c_types::TxOut"),
1014                         "bitcoin::network::constants::Network" => Some("crate::bitcoin::network::Network"),
1015                         "bitcoin::util::address::WitnessVersion" => Some("crate::c_types::WitnessVersion"),
1016                         "bitcoin::blockdata::block::BlockHeader" if is_ref  => Some("*const [u8; 80]"),
1017                         "bitcoin::blockdata::block::Block" if is_ref  => Some("crate::c_types::u8slice"),
1018
1019                         "bitcoin::hash_types::PubkeyHash"|"bitcoin::hash_types::WPubkeyHash"|"bitcoin::hash_types::ScriptHash"
1020                                 if is_ref => Some("*const [u8; 20]"),
1021                         "bitcoin::hash_types::WScriptHash"
1022                                 if is_ref => Some("*const [u8; 32]"),
1023
1024                         // Newtypes that we just expose in their original form.
1025                         "bitcoin::hash_types::Txid"|"bitcoin::BlockHash"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"|"bitcoin::blockdata::constants::ChainHash"
1026                                 if is_ref  => Some("*const [u8; 32]"),
1027                         "bitcoin::hash_types::Txid"|"bitcoin::BlockHash"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"|"bitcoin::blockdata::constants::ChainHash"
1028                                 if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
1029                         "bitcoin::secp256k1::Message" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
1030                         "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1031                         |"lightning::ln::channelmanager::PaymentId"|"lightning::ln::channelmanager::InterceptId"
1032                         |"lightning::chain::keysinterface::KeyMaterial"
1033                                 if is_ref => Some("*const [u8; 32]"),
1034                         "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1035                         |"lightning::ln::channelmanager::PaymentId"|"lightning::ln::channelmanager::InterceptId"
1036                         |"lightning::chain::keysinterface::KeyMaterial"
1037                                 if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
1038
1039                         "lightning::io::Read" => Some("crate::c_types::u8slice"),
1040
1041                         _ => None,
1042                 }
1043         }
1044
1045         fn from_c_conversion_new_var_from_path<'b>(&self, _full_path: &str, _is_ref: bool) -> Option<(&'b str, &'b str)> {
1046                 None
1047         }
1048         fn from_c_conversion_prefix_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<String> {
1049                 if self.is_primitive(full_path) {
1050                         return Some("".to_owned());
1051                 }
1052                 match full_path {
1053                         "Vec" if !is_ref => Some("local_"),
1054                         "Result" if !is_ref => Some("local_"),
1055                         "Option" if is_ref => Some("&local_"),
1056                         "Option" => Some("local_"),
1057
1058                         "[u8; 32]" if is_ref => Some("unsafe { &*"),
1059                         "[u8; 32]" if !is_ref => Some(""),
1060                         "[u8; 20]" if !is_ref => Some(""),
1061                         "[u8; 16]" if !is_ref => Some(""),
1062                         "[u8; 12]" if !is_ref => Some(""),
1063                         "[u8; 4]" if !is_ref => Some(""),
1064                         "[u8; 3]" if !is_ref => Some(""),
1065                         "[u16; 8]" if !is_ref => Some(""),
1066
1067                         "[u8]" if is_ref => Some(""),
1068                         "[usize]" if is_ref => Some(""),
1069
1070                         "str" if is_ref => Some(""),
1071                         "alloc::string::String"|"String" => Some(""),
1072                         "std::io::Error"|"lightning::io::Error"|"lightning::io::ErrorKind" => Some(""),
1073                         // Note that we'll panic for String if is_ref, as we only have non-owned memory, we
1074                         // cannot create a &String.
1075
1076                         "core::convert::Infallible" => Some("panic!(\"You must never construct a NotConstructable! : "),
1077
1078                         "bitcoin::bech32::Error"|"bech32::Error" if !is_ref => Some(""),
1079                         "bitcoin::secp256k1::Error"|"secp256k1::Error" if !is_ref => Some(""),
1080
1081                         "core::num::ParseIntError" => Some("u8::from_str_radix(\" a\", 10).unwrap_err() /*"),
1082                         "core::str::Utf8Error" => Some("core::str::from_utf8(&[0xff]).unwrap_err() /*"),
1083
1084                         "std::time::Duration"|"core::time::Duration" => Some("core::time::Duration::from_secs("),
1085                         "std::time::SystemTime" => Some("(::std::time::SystemTime::UNIX_EPOCH + std::time::Duration::from_secs("),
1086
1087                         "bitcoin::bech32::u5"|"bech32::u5" => Some(""),
1088                         "u128" => Some(""),
1089                         "core::num::NonZeroU8" => Some("core::num::NonZeroU8::new("),
1090
1091                         "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" if is_ref => Some("&"),
1092                         "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" => Some(""),
1093                         "bitcoin::secp256k1::ecdsa::Signature" if is_ref => Some("&"),
1094                         "bitcoin::secp256k1::ecdsa::Signature" => Some(""),
1095                         "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some(""),
1096                         "bitcoin::secp256k1::SecretKey" if is_ref => Some("&::bitcoin::secp256k1::SecretKey::from_slice(&unsafe { *"),
1097                         "bitcoin::secp256k1::SecretKey" if !is_ref => Some(""),
1098                         "bitcoin::secp256k1::Scalar" if !is_ref => Some(""),
1099                         "bitcoin::secp256k1::ecdh::SharedSecret" if !is_ref => Some("::bitcoin::secp256k1::ecdh::SharedSecret::from_bytes("),
1100
1101                         "bitcoin::blockdata::script::Script" if is_ref => Some("&::bitcoin::blockdata::script::Script::from(Vec::from("),
1102                         "bitcoin::blockdata::script::Script" if !is_ref => Some("::bitcoin::blockdata::script::Script::from("),
1103                         "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" if is_ref => Some("&"),
1104                         "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(""),
1105                         "bitcoin::Witness" if is_ref => Some("&"),
1106                         "bitcoin::Witness" => Some(""),
1107                         "bitcoin::blockdata::transaction::OutPoint" => Some("crate::c_types::C_to_bitcoin_outpoint("),
1108                         "bitcoin::TxOut"|"bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(""),
1109                         "bitcoin::network::constants::Network" => Some(""),
1110                         "bitcoin::util::address::WitnessVersion" => Some(""),
1111                         "bitcoin::blockdata::block::BlockHeader" => Some("&::bitcoin::consensus::encode::deserialize(unsafe { &*"),
1112                         "bitcoin::blockdata::block::Block" if is_ref => Some("&::bitcoin::consensus::encode::deserialize("),
1113
1114                         "bitcoin::hash_types::PubkeyHash" if is_ref =>
1115                                 Some("&bitcoin::hash_types::PubkeyHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
1116                         "bitcoin::hash_types::WPubkeyHash" if is_ref =>
1117                                 Some("&bitcoin::hash_types::WPubkeyHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
1118                         "bitcoin::hash_types::ScriptHash" if is_ref =>
1119                                 Some("&bitcoin::hash_types::ScriptHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
1120                         "bitcoin::hash_types::WScriptHash" if is_ref =>
1121                                 Some("&bitcoin::hash_types::WScriptHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
1122
1123                         // Newtypes that we just expose in their original form.
1124                         "bitcoin::hash_types::Txid" if is_ref => Some("&::bitcoin::hash_types::Txid::from_slice(&unsafe { &*"),
1125                         "bitcoin::hash_types::Txid" if !is_ref => Some("::bitcoin::hash_types::Txid::from_slice(&"),
1126                         "bitcoin::hash_types::BlockHash"|"bitcoin::BlockHash" => Some("::bitcoin::hash_types::BlockHash::from_slice(&"),
1127                         "bitcoin::blockdata::constants::ChainHash" => Some("::bitcoin::blockdata::constants::ChainHash::from_slice(&"),
1128                         "lightning::ln::PaymentHash" if !is_ref => Some("::lightning::ln::PaymentHash("),
1129                         "lightning::ln::PaymentHash" if is_ref => Some("&::lightning::ln::PaymentHash(unsafe { *"),
1130                         "lightning::ln::PaymentPreimage" if !is_ref => Some("::lightning::ln::PaymentPreimage("),
1131                         "lightning::ln::PaymentPreimage" if is_ref => Some("&::lightning::ln::PaymentPreimage(unsafe { *"),
1132                         "lightning::ln::PaymentSecret" if !is_ref => Some("::lightning::ln::PaymentSecret("),
1133                         "lightning::ln::channelmanager::PaymentId" if !is_ref => Some("::lightning::ln::channelmanager::PaymentId("),
1134                         "lightning::ln::channelmanager::PaymentId" if is_ref=> Some("&::lightning::ln::channelmanager::PaymentId( unsafe { *"),
1135                         "lightning::ln::channelmanager::InterceptId" if !is_ref => Some("::lightning::ln::channelmanager::InterceptId("),
1136                         "lightning::ln::channelmanager::InterceptId" if is_ref=> Some("&::lightning::ln::channelmanager::InterceptId( unsafe { *"),
1137                         "lightning::chain::keysinterface::KeyMaterial" if !is_ref => Some("::lightning::chain::keysinterface::KeyMaterial("),
1138                         "lightning::chain::keysinterface::KeyMaterial" if is_ref=> Some("&::lightning::chain::keysinterface::KeyMaterial( unsafe { *"),
1139
1140                         // List of traits we map (possibly during processing of other files):
1141                         "lightning::io::Read" => Some("&mut "),
1142
1143                         _ => None,
1144                 }.map(|s| s.to_owned())
1145         }
1146         fn from_c_conversion_suffix_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<String> {
1147                 if self.is_primitive(full_path) {
1148                         return Some("".to_owned());
1149                 }
1150                 match full_path {
1151                         "Vec" if !is_ref => Some(""),
1152                         "Option" => Some(""),
1153                         "Result" if !is_ref => Some(""),
1154
1155                         "[u8; 32]" if is_ref => Some("}"),
1156                         "[u8; 32]" if !is_ref => Some(".data"),
1157                         "[u8; 20]" if !is_ref => Some(".data"),
1158                         "[u8; 16]" if !is_ref => Some(".data"),
1159                         "[u8; 12]" if !is_ref => Some(".data"),
1160                         "[u8; 4]" if !is_ref => Some(".data"),
1161                         "[u8; 3]" if !is_ref => Some(".data"),
1162                         "[u16; 8]" if !is_ref => Some(".data"),
1163
1164                         "[u8]" if is_ref => Some(".to_slice()"),
1165                         "[usize]" if is_ref => Some(".to_slice()"),
1166
1167                         "str" if is_ref => Some(".into_str()"),
1168                         "alloc::string::String"|"String" => Some(".into_string()"),
1169                         "std::io::Error"|"lightning::io::Error" => Some(".to_rust()"),
1170                         "lightning::io::ErrorKind" => Some(".to_rust_kind()"),
1171
1172                         "core::convert::Infallible" => Some("\")"),
1173
1174                         "bitcoin::bech32::Error"|"bech32::Error" if !is_ref => Some(".into_rust()"),
1175                         "bitcoin::secp256k1::Error"|"secp256k1::Error" if !is_ref => Some(".into_rust()"),
1176
1177                         "core::num::ParseIntError" => Some("*/"),
1178                         "core::str::Utf8Error" => Some("*/"),
1179
1180                         "std::time::Duration"|"core::time::Duration" => Some(")"),
1181                         "std::time::SystemTime" => Some("))"),
1182
1183                         "bitcoin::bech32::u5"|"bech32::u5" => Some(".into()"),
1184                         "u128" => Some(".into()"),
1185                         "core::num::NonZeroU8" => Some(").expect(\"Value must be non-zero\")"),
1186
1187                         "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" => Some(".into_rust()"),
1188                         "bitcoin::secp256k1::ecdsa::Signature" => Some(".into_rust()"),
1189                         "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some(".into_rust()"),
1190                         "bitcoin::secp256k1::SecretKey" if !is_ref => Some(".into_rust()"),
1191                         "bitcoin::secp256k1::SecretKey" if is_ref => Some("}[..]).unwrap()"),
1192                         "bitcoin::secp256k1::Scalar" if !is_ref => Some(".into_rust()"),
1193                         "bitcoin::secp256k1::ecdh::SharedSecret" if !is_ref => Some(".data)"),
1194
1195                         "bitcoin::blockdata::script::Script" if is_ref => Some(".to_slice()))"),
1196                         "bitcoin::blockdata::script::Script" if !is_ref => Some(".into_rust())"),
1197                         "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(".into_bitcoin()"),
1198                         "bitcoin::Witness" => Some(".into_bitcoin()"),
1199                         "bitcoin::blockdata::transaction::OutPoint" => Some(")"),
1200                         "bitcoin::TxOut"|"bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(".into_rust()"),
1201                         "bitcoin::network::constants::Network" => Some(".into_bitcoin()"),
1202                         "bitcoin::util::address::WitnessVersion" => Some(".into()"),
1203                         "bitcoin::blockdata::block::BlockHeader" => Some(" }).unwrap()"),
1204                         "bitcoin::blockdata::block::Block" => Some(".to_slice()).unwrap()"),
1205
1206                         "bitcoin::hash_types::PubkeyHash"|"bitcoin::hash_types::WPubkeyHash"|
1207                         "bitcoin::hash_types::ScriptHash"|"bitcoin::hash_types::WScriptHash"
1208                                 if is_ref => Some(" }.clone()))"),
1209
1210                         // Newtypes that we just expose in their original form.
1211                         "bitcoin::hash_types::Txid" if is_ref => Some(" }[..]).unwrap()"),
1212                         "bitcoin::hash_types::Txid" => Some(".data[..]).unwrap()"),
1213                         "bitcoin::hash_types::BlockHash"|"bitcoin::BlockHash"|"bitcoin::blockdata::constants::ChainHash" if !is_ref => Some(".data[..]).unwrap()"),
1214                         "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1215                         |"lightning::ln::channelmanager::PaymentId"|"lightning::ln::channelmanager::InterceptId"
1216                         |"lightning::chain::keysinterface::KeyMaterial"
1217                                 if !is_ref => Some(".data)"),
1218                         "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1219                         |"lightning::ln::channelmanager::PaymentId"|"lightning::ln::channelmanager::InterceptId"
1220                         |"lightning::chain::keysinterface::KeyMaterial"
1221                                 if is_ref => Some(" })"),
1222
1223                         // List of traits we map (possibly during processing of other files):
1224                         "lightning::io::Read" => Some(".to_reader()"),
1225
1226                         _ => None,
1227                 }.map(|s| s.to_owned())
1228         }
1229
1230         fn to_c_conversion_new_var_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<(&'b str, &'b str)> {
1231                 if self.is_primitive(full_path) {
1232                         return None;
1233                 }
1234                 match full_path {
1235                         "[u8]" if is_ref => Some(("crate::c_types::u8slice::from_slice(", ")")),
1236                         "[usize]" if is_ref => Some(("crate::c_types::usizeslice::from_slice(", ")")),
1237
1238                         "bitcoin::blockdata::block::BlockHeader" if is_ref => Some(("{ let mut s = [0u8; 80]; s[..].copy_from_slice(&::bitcoin::consensus::encode::serialize(", ")); s }")),
1239                         "bitcoin::blockdata::block::Block" if is_ref => Some(("::bitcoin::consensus::encode::serialize(", ")")),
1240                         "bitcoin::hash_types::Txid" => None,
1241
1242                         _ => None,
1243                 }.map(|s| s.to_owned())
1244         }
1245         fn to_c_conversion_inline_prefix_from_path(&self, full_path: &str, is_ref: bool, _ptr_for_ref: bool) -> Option<String> {
1246                 if self.is_primitive(full_path) {
1247                         return Some("".to_owned());
1248                 }
1249                 match full_path {
1250                         "Result" if !is_ref => Some("local_"),
1251                         "Vec" if !is_ref => Some("local_"),
1252                         "Option" => Some("local_"),
1253
1254                         "[u8; 32]" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1255                         "[u8; 32]" if is_ref => Some(""),
1256                         "[u8; 20]" if !is_ref => Some("crate::c_types::TwentyBytes { data: "),
1257                         "[u8; 16]" if !is_ref => Some("crate::c_types::SixteenBytes { data: "),
1258                         "[u8; 12]" if !is_ref => Some("crate::c_types::TwelveBytes { data: "),
1259                         "[u8; 4]" if !is_ref => Some("crate::c_types::FourBytes { data: "),
1260                         "[u8; 3]" if is_ref => Some(""),
1261                         "[u16; 8]" if !is_ref => Some("crate::c_types::EightU16s { data: "),
1262
1263                         "[u8]" if is_ref => Some("local_"),
1264                         "[usize]" if is_ref => Some("local_"),
1265
1266                         "str" if is_ref => Some(""),
1267                         "alloc::string::String"|"String" => Some(""),
1268
1269                         "std::time::Duration"|"core::time::Duration" => Some(""),
1270                         "std::time::SystemTime" => Some(""),
1271                         "std::io::Error"|"lightning::io::Error" => Some("crate::c_types::IOError::from_rust("),
1272                         "lightning::io::ErrorKind" => Some("crate::c_types::IOError::from_rust_kind("),
1273                         "core::fmt::Arguments" => Some("alloc::format!(\"{}\", "),
1274
1275                         "core::convert::Infallible" => Some("panic!(\"Cannot construct an Infallible: "),
1276
1277                         "bitcoin::bech32::Error"|"bech32::Error"
1278                                 if !is_ref => Some("crate::c_types::Bech32Error::from_rust("),
1279                         "bitcoin::secp256k1::Error"|"secp256k1::Error"
1280                                 if !is_ref => Some("crate::c_types::Secp256k1Error::from_rust("),
1281
1282                         "core::num::ParseIntError" => Some("crate::c_types::Error { _dummy: 0 } /*"),
1283                         "core::str::Utf8Error" => Some("crate::c_types::Error { _dummy: 0 } /*"),
1284
1285                         "bitcoin::bech32::u5"|"bech32::u5" => Some(""),
1286                         "u128" => Some(""),
1287
1288                         "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" => Some("crate::c_types::PublicKey::from_rust(&"),
1289                         "bitcoin::secp256k1::ecdsa::Signature" => Some("crate::c_types::Signature::from_rust(&"),
1290                         "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some("crate::c_types::RecoverableSignature::from_rust(&"),
1291                         "bitcoin::secp256k1::SecretKey" if is_ref => Some(""),
1292                         "bitcoin::secp256k1::SecretKey" if !is_ref => Some("crate::c_types::SecretKey::from_rust("),
1293                         "bitcoin::secp256k1::Scalar" if !is_ref => Some("crate::c_types::BigEndianScalar::from_rust("),
1294                         "bitcoin::secp256k1::ecdh::SharedSecret" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1295
1296                         "bitcoin::blockdata::script::Script" if is_ref => Some("crate::c_types::u8slice::from_slice(&"),
1297                         "bitcoin::blockdata::script::Script" if !is_ref => Some(""),
1298                         "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" if is_ref => Some("crate::c_types::Transaction::from_bitcoin("),
1299                         "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some("crate::c_types::Transaction::from_bitcoin(&"),
1300                         "bitcoin::Witness" if is_ref => Some("crate::c_types::Witness::from_bitcoin("),
1301                         "bitcoin::Witness" if !is_ref => Some("crate::c_types::Witness::from_bitcoin(&"),
1302                         "bitcoin::blockdata::transaction::OutPoint" => Some("crate::c_types::bitcoin_to_C_outpoint("),
1303                         "bitcoin::TxOut"|"bitcoin::blockdata::transaction::TxOut" if !is_ref => Some("crate::c_types::TxOut::from_rust("),
1304                         "bitcoin::network::constants::Network" => Some("crate::bitcoin::network::Network::from_bitcoin("),
1305                         "bitcoin::util::address::WitnessVersion" => Some(""),
1306                         "bitcoin::blockdata::block::BlockHeader" if is_ref => Some("&local_"),
1307                         "bitcoin::blockdata::block::Block" if is_ref => Some("crate::c_types::u8slice::from_slice(&local_"),
1308
1309                         "bitcoin::hash_types::Txid" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1310
1311                         // Newtypes that we just expose in their original form.
1312                         "bitcoin::hash_types::Txid"|"bitcoin::BlockHash"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"|"bitcoin::blockdata::constants::ChainHash"
1313                                 if is_ref => Some(""),
1314                         "bitcoin::hash_types::Txid"|"bitcoin::BlockHash"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"|"bitcoin::blockdata::constants::ChainHash"
1315                                 if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1316                         "bitcoin::secp256k1::Message" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1317                         "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1318                         |"lightning::ln::channelmanager::PaymentId"|"lightning::ln::channelmanager::InterceptId"
1319                         |"lightning::chain::keysinterface::KeyMaterial"
1320                                 if is_ref => Some("&"),
1321                         "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1322                         |"lightning::ln::channelmanager::PaymentId"|"lightning::ln::channelmanager::InterceptId"
1323                         |"lightning::chain::keysinterface::KeyMaterial"
1324                                 if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1325
1326                         "lightning::io::Read" => Some("crate::c_types::u8slice::from_vec(&crate::c_types::reader_to_vec("),
1327
1328                         _ => None,
1329                 }.map(|s| s.to_owned())
1330         }
1331         fn to_c_conversion_inline_suffix_from_path(&self, full_path: &str, is_ref: bool, _ptr_for_ref: bool) -> Option<String> {
1332                 if self.is_primitive(full_path) {
1333                         return Some("".to_owned());
1334                 }
1335                 match full_path {
1336                         "Result" if !is_ref => Some(""),
1337                         "Vec" if !is_ref => Some(".into()"),
1338                         "Option" => Some(""),
1339
1340                         "[u8; 32]" if !is_ref => Some(" }"),
1341                         "[u8; 32]" if is_ref => Some(""),
1342                         "[u8; 20]" if !is_ref => Some(" }"),
1343                         "[u8; 16]" if !is_ref => Some(" }"),
1344                         "[u8; 12]" if !is_ref => Some(" }"),
1345                         "[u8; 4]" if !is_ref => Some(" }"),
1346                         "[u8; 3]" if is_ref => Some(""),
1347                         "[u16; 8]" if !is_ref => Some(" }"),
1348
1349                         "[u8]" if is_ref => Some(""),
1350                         "[usize]" if is_ref => Some(""),
1351
1352                         "str" if is_ref => Some(".into()"),
1353                         "alloc::string::String"|"String" if is_ref => Some(".as_str().into()"),
1354                         "alloc::string::String"|"String" => Some(".into()"),
1355
1356                         "std::time::Duration"|"core::time::Duration" => Some(".as_secs()"),
1357                         "std::time::SystemTime" => Some(".duration_since(::std::time::SystemTime::UNIX_EPOCH).expect(\"Times must be post-1970\").as_secs()"),
1358                         "std::io::Error"|"lightning::io::Error"|"lightning::io::ErrorKind" => Some(")"),
1359                         "core::fmt::Arguments" => Some(").into()"),
1360
1361                         "core::convert::Infallible" => Some("\")"),
1362
1363                         "bitcoin::secp256k1::Error"|"bech32::Error"
1364                                 if !is_ref => Some(")"),
1365                         "bitcoin::secp256k1::Error"|"secp256k1::Error"
1366                                 if !is_ref => Some(")"),
1367
1368                         "core::num::ParseIntError" => Some("*/"),
1369                         "core::str::Utf8Error" => Some("*/"),
1370
1371                         "bitcoin::bech32::u5"|"bech32::u5" => Some(".into()"),
1372                         "u128" => Some(".into()"),
1373
1374                         "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" => Some(")"),
1375                         "bitcoin::secp256k1::ecdsa::Signature" => Some(")"),
1376                         "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some(")"),
1377                         "bitcoin::secp256k1::SecretKey" if !is_ref => Some(")"),
1378                         "bitcoin::secp256k1::SecretKey" if is_ref => Some(".as_ref()"),
1379                         "bitcoin::secp256k1::Scalar" if !is_ref => Some(")"),
1380                         "bitcoin::secp256k1::ecdh::SharedSecret" if !is_ref => Some(".secret_bytes() }"),
1381
1382                         "bitcoin::blockdata::script::Script" if is_ref => Some("[..])"),
1383                         "bitcoin::blockdata::script::Script" if !is_ref => Some(".into_bytes().into()"),
1384                         "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(")"),
1385                         "bitcoin::Witness" => Some(")"),
1386                         "bitcoin::blockdata::transaction::OutPoint" => Some(")"),
1387                         "bitcoin::TxOut"|"bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(")"),
1388                         "bitcoin::network::constants::Network" => Some(")"),
1389                         "bitcoin::util::address::WitnessVersion" => Some(".into()"),
1390                         "bitcoin::blockdata::block::BlockHeader" if is_ref => Some(""),
1391                         "bitcoin::blockdata::block::Block" if is_ref => Some(")"),
1392
1393                         "bitcoin::hash_types::Txid" if !is_ref => Some(".into_inner() }"),
1394
1395                         // Newtypes that we just expose in their original form.
1396                         "bitcoin::hash_types::Txid"|"bitcoin::BlockHash"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"|"bitcoin::blockdata::constants::ChainHash"
1397                                 if is_ref => Some(".as_inner()"),
1398                         "bitcoin::hash_types::Txid"|"bitcoin::BlockHash"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"|"bitcoin::blockdata::constants::ChainHash"
1399                                 if !is_ref => Some(".into_inner() }"),
1400                         "bitcoin::secp256k1::Message" if !is_ref => Some(".as_ref().clone() }"),
1401                         "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1402                         |"lightning::ln::channelmanager::PaymentId"|"lightning::ln::channelmanager::InterceptId"
1403                         |"lightning::chain::keysinterface::KeyMaterial"
1404                                 if is_ref => Some(".0"),
1405                         "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1406                         |"lightning::ln::channelmanager::PaymentId"|"lightning::ln::channelmanager::InterceptId"
1407                         |"lightning::chain::keysinterface::KeyMaterial"
1408                                 if !is_ref => Some(".0 }"),
1409
1410                         "lightning::io::Read" => Some("))"),
1411
1412                         _ => None,
1413                 }.map(|s| s.to_owned())
1414         }
1415
1416         fn empty_val_check_suffix_from_path(&self, full_path: &str) -> Option<&str> {
1417                 match full_path {
1418                         "lightning::ln::PaymentSecret" => Some(".data == [0; 32]"),
1419                         "secp256k1::PublicKey"|"bitcoin::secp256k1::PublicKey" => Some(".is_null()"),
1420                         "bitcoin::secp256k1::ecdsa::Signature" => Some(".is_null()"),
1421                         _ => None
1422                 }
1423         }
1424
1425         /// When printing a reference to the source crate's rust type, if we need to map it to a
1426         /// different "real" type, it can be done so here.
1427         /// This is useful to work around limitations in the binding type resolver, where we reference
1428         /// a non-public `use` alias.
1429         /// TODO: We should never need to use this!
1430         fn real_rust_type_mapping<'equiv>(&self, thing: &'equiv str) -> &'equiv str {
1431                 match thing {
1432                         "lightning::io::Read" => "crate::c_types::io::Read",
1433                         _ => thing,
1434                 }
1435         }
1436
1437         // ****************************
1438         // *** Container Processing ***
1439         // ****************************
1440
1441         /// Returns the module path in the generated mapping crate to the containers which we generate
1442         /// when writing to CrateTypes::template_file.
1443         pub fn generated_container_path() -> &'static str {
1444                 "crate::c_types::derived"
1445         }
1446         /// Returns the module path in the generated mapping crate to the container templates, which
1447         /// are then concretized and put in the generated container path/template_file.
1448         fn container_templ_path() -> &'static str {
1449                 "crate::c_types"
1450         }
1451
1452         /// This should just be a closure, but doing so gets an error like
1453         /// error: reached the recursion limit while instantiating `types::TypeResolver::is_transpar...c/types.rs:1358:104: 1358:110]>>`
1454         /// which implies the concrete function instantiation of `is_transparent_container` ends up
1455         /// being recursive.
1456         fn deref_type<'one, 'b: 'one> (obj: &'one &'b syn::Type) -> &'b syn::Type { *obj }
1457
1458         /// Returns true if the path containing the given args is a "transparent" container, ie an
1459         /// Option or a container which does not require a generated continer class.
1460         fn is_transparent_container<'i, I: Iterator<Item=&'i syn::Type>>(&self, full_path: &str, _is_ref: bool, mut args: I, generics: Option<&GenericTypes>) -> bool {
1461                 if full_path == "Option" {
1462                         let inner = args.next().unwrap();
1463                         assert!(args.next().is_none());
1464                         match generics.resolve_type(inner) {
1465                                 syn::Type::Reference(r) => {
1466                                         let elem = &*r.elem;
1467                                         match elem {
1468                                                 syn::Type::Path(_) =>
1469                                                         self.is_transparent_container(full_path, true, [elem].iter().map(Self::deref_type), generics),
1470                                                 _ => true,
1471                                         }
1472                                 },
1473                                 syn::Type::Array(a) => {
1474                                         if let syn::Expr::Lit(l) = &a.len {
1475                                                 if let syn::Lit::Int(i) = &l.lit {
1476                                                         if i.base10_digits().parse::<usize>().unwrap() >= 32 {
1477                                                                 let mut buf = Vec::new();
1478                                                                 self.write_rust_type(&mut buf, generics, &a.elem, false);
1479                                                                 let ty = String::from_utf8(buf).unwrap();
1480                                                                 ty == "u8"
1481                                                         } else {
1482                                                                 // Blindly assume that if we're trying to create an empty value for an
1483                                                                 // array < 32 entries that all-0s may be a valid state.
1484                                                                 unimplemented!();
1485                                                         }
1486                                                 } else { unimplemented!(); }
1487                                         } else { unimplemented!(); }
1488                                 },
1489                                 syn::Type::Path(p) => {
1490                                         if let Some(resolved) = self.maybe_resolve_path(&p.path, generics) {
1491                                                 if self.c_type_has_inner_from_path(&resolved) { return true; }
1492                                                 if self.is_primitive(&resolved) { return false; }
1493                                                 // We want to move to using `Option_` mappings where possible rather than
1494                                                 // manual mappings, as it makes downstream bindings simpler and is more
1495                                                 // clear for users. Thus, we default to false but override for a few
1496                                                 // types which had mappings defined when we were avoiding the `Option_`s.
1497                                                 match &resolved as &str {
1498                                                         "lightning::ln::PaymentSecret" => true,
1499                                                         "lightning::ln::PaymentHash" => true,
1500                                                         "lightning::ln::PaymentPreimage" => true,
1501                                                         "lightning::ln::channelmanager::PaymentId" => true,
1502                                                         "bitcoin::hash_types::BlockHash"|"bitcoin::BlockHash" => true,
1503                                                         "secp256k1::PublicKey"|"bitcoin::secp256k1::PublicKey" => true,
1504                                                         _ => false,
1505                                                 }
1506                                         } else { unimplemented!(); }
1507                                 },
1508                                 syn::Type::Tuple(_) => false,
1509                                 _ => unimplemented!(),
1510                         }
1511                 } else { false }
1512         }
1513         /// Returns true if the path is a "transparent" container, ie an Option or a container which does
1514         /// not require a generated continer class.
1515         pub fn is_path_transparent_container(&self, full_path: &syn::Path, generics: Option<&GenericTypes>, is_ref: bool) -> bool {
1516                 let inner_iter = match &full_path.segments.last().unwrap().arguments {
1517                         syn::PathArguments::None => return false,
1518                         syn::PathArguments::AngleBracketed(args) => args.args.iter().map(|arg| {
1519                                 if let syn::GenericArgument::Type(ref ty) = arg {
1520                                         ty
1521                                 } else { unimplemented!() }
1522                         }),
1523                         syn::PathArguments::Parenthesized(_) => unimplemented!(),
1524                 };
1525                 self.is_transparent_container(&self.resolve_path(full_path, generics), is_ref, inner_iter, generics)
1526         }
1527         /// Returns true if this is a known, supported, non-transparent container.
1528         fn is_known_container(&self, full_path: &str, is_ref: bool) -> bool {
1529                 (full_path == "Result" && !is_ref) || (full_path == "Vec" && !is_ref) || full_path.ends_with("Tuple") || full_path == "Option"
1530         }
1531         fn to_c_conversion_container_new_var<'b>(&self, generics: Option<&GenericTypes>, full_path: &str, is_ref: bool, single_contained: Option<&syn::Type>, var_name: &syn::Ident, var_access: &str)
1532                         // Returns prefix + Vec<(prefix, var-name-to-inline-convert)> + suffix
1533                         // expecting one element in the vec per generic type, each of which is inline-converted
1534                         -> Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)> {
1535                 match full_path {
1536                         "Result" if !is_ref => {
1537                                 Some(("match ",
1538                                                 vec![(" { Ok(mut o) => crate::c_types::CResultTempl::ok(".to_string(), "o".to_string()),
1539                                                         (").into(), Err(mut e) => crate::c_types::CResultTempl::err(".to_string(), "e".to_string())],
1540                                                 ").into() }", ContainerPrefixLocation::PerConv))
1541                         },
1542                         "Vec" => {
1543                                 if is_ref {
1544                                         // We should only get here if the single contained has an inner
1545                                         assert!(self.c_type_has_inner(single_contained.unwrap()));
1546                                 }
1547                                 Some(("Vec::new(); for mut item in ", vec![(format!(".drain(..) {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1548                         },
1549                         "Slice" => {
1550                                 if let Some(syn::Type::Reference(_)) = single_contained {
1551                                         Some(("Vec::new(); for item in ", vec![(format!(".iter() {{ local_{}.push(", var_name), "(*item)".to_string())], "); }", ContainerPrefixLocation::PerConv))
1552                                 } else {
1553                                         Some(("Vec::new(); for item in ", vec![(format!(".iter() {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1554                                 }
1555                         },
1556                         "Option" => {
1557                                 let mut is_contained_ref = false;
1558                                 let contained_struct = if let Some(syn::Type::Path(p)) = single_contained {
1559                                         Some(self.resolve_path(&p.path, generics))
1560                                 } else if let Some(syn::Type::Reference(r)) = single_contained {
1561                                         is_contained_ref = true;
1562                                         if let syn::Type::Path(p) = &*r.elem {
1563                                                 Some(self.resolve_path(&p.path, generics))
1564                                         } else { None }
1565                                 } else { None };
1566                                 if let Some(inner_path) = contained_struct {
1567                                         let only_contained_has_inner = self.c_type_has_inner_from_path(&inner_path);
1568                                         if self.c_type_has_inner_from_path(&inner_path) {
1569                                                 let is_inner_ref = if let Some(syn::Type::Reference(_)) = single_contained { true } else { false };
1570                                                 if is_ref {
1571                                                         return Some(("if ", vec![
1572                                                                 (".is_none() { core::ptr::null() } else { ObjOps::nonnull_ptr_to_inner(".to_owned(),
1573                                                                         format!("({}{}.unwrap())", var_access, if is_inner_ref { "" } else { ".as_ref()" }))
1574                                                                 ], ") }", ContainerPrefixLocation::OutsideConv));
1575                                                 } else {
1576                                                         return Some(("if ", vec![
1577                                                                 (".is_none() { core::ptr::null_mut() } else { ".to_owned(), format!("({}.unwrap())", var_access))
1578                                                                 ], " }", ContainerPrefixLocation::OutsideConv));
1579                                                 }
1580                                         } else if !self.is_transparent_container("Option", is_ref, [single_contained.unwrap()].iter().map(|a| *a), generics) {
1581                                                 if self.is_primitive(&inner_path) || (!is_contained_ref && !is_ref) || only_contained_has_inner {
1582                                                         let inner_name = self.get_c_mangled_container_type(vec![single_contained.unwrap()], generics, "Option").unwrap();
1583                                                         return Some(("if ", vec![
1584                                                                 (format!(".is_none() {{ {}::None }} else {{ {}::Some(", inner_name, inner_name),
1585                                                                  format!("{}.unwrap()", var_access))
1586                                                                 ], ") }", ContainerPrefixLocation::PerConv));
1587                                                 } else {
1588                                                         let inner_name = self.get_c_mangled_container_type(vec![single_contained.unwrap()], generics, "Option").unwrap();
1589                                                         return Some(("if ", vec![
1590                                                                 (format!(".is_none() {{ {}::None }} else {{ {}::Some(/* WARNING: CLONING CONVERSION HERE! &Option<Enum> is otherwise un-expressable. */", inner_name, inner_name),
1591                                                                  format!("{}.clone().unwrap()", var_access))
1592                                                                 ], ") }", ContainerPrefixLocation::PerConv));
1593                                                 }
1594                                         } else {
1595                                                 // If c_type_from_path is some (ie there's a manual mapping for the inner
1596                                                 // type), lean on write_empty_rust_val, below.
1597                                         }
1598                                 }
1599                                 if let Some(t) = single_contained {
1600                                         if let syn::Type::Tuple(syn::TypeTuple { elems, .. }) = t {
1601                                                 let inner_name = self.get_c_mangled_container_type(vec![single_contained.unwrap()], generics, "Option").unwrap();
1602                                                 if elems.is_empty() {
1603                                                         return Some(("if ", vec![
1604                                                                 (format!(".is_none() {{ {}::None }} else {{ {}::Some /* ",
1605                                                                         inner_name, inner_name), format!(""))
1606                                                                 ], " */ }", ContainerPrefixLocation::PerConv));
1607                                                 } else {
1608                                                         return Some(("if ", vec![
1609                                                                 (format!(".is_none() {{ {}::None }} else {{ {}::Some(",
1610                                                                         inner_name, inner_name), format!("({}.unwrap())", var_access))
1611                                                                 ], ") }", ContainerPrefixLocation::PerConv));
1612                                                 }
1613                                         }
1614                                         if let syn::Type::Reference(syn::TypeReference { elem, .. }) = t {
1615                                                 if let syn::Type::Slice(_) = &**elem {
1616                                                         return Some(("if ", vec![
1617                                                                         (".is_none() { SmartPtr::null() } else { SmartPtr::from_obj(".to_string(),
1618                                                                          format!("({}.unwrap())", var_access))
1619                                                                 ], ") }", ContainerPrefixLocation::PerConv));
1620                                                 }
1621                                         }
1622                                         let mut v = Vec::new();
1623                                         self.write_empty_rust_val(generics, &mut v, t);
1624                                         let s = String::from_utf8(v).unwrap();
1625                                         return Some(("if ", vec![
1626                                                 (format!(".is_none() {{ {} }} else {{ ", s), format!("({}.unwrap())", var_access))
1627                                                 ], " }", ContainerPrefixLocation::PerConv));
1628                                 } else { unreachable!(); }
1629                         },
1630                         _ => None,
1631                 }
1632         }
1633
1634         /// only_contained_has_inner implies that there is only one contained element in the container
1635         /// and it has an inner field (ie is an "opaque" type we've defined).
1636         fn from_c_conversion_container_new_var<'b>(&self, generics: Option<&GenericTypes>, full_path: &str, is_ref: bool, single_contained: Option<&syn::Type>, var_name: &syn::Ident, var_access: &str)
1637                         // Returns prefix + Vec<(prefix, var-name-to-inline-convert)> + suffix
1638                         // expecting one element in the vec per generic type, each of which is inline-converted
1639                         -> Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)> {
1640                 let mut only_contained_has_inner = false;
1641                 let only_contained_resolved = if let Some(syn::Type::Path(p)) = single_contained {
1642                         let res = self.resolve_path(&p.path, generics);
1643                         only_contained_has_inner = self.c_type_has_inner_from_path(&res);
1644                         Some(res)
1645                 } else { None };
1646                 match full_path {
1647                         "Result" if !is_ref => {
1648                                 Some(("match ",
1649                                                 vec![(".result_ok { true => Ok(".to_string(), format!("(*unsafe {{ Box::from_raw(<*mut _>::take_ptr(&mut {}.contents.result)) }})", var_access)),
1650                                                      ("), false => Err(".to_string(), format!("(*unsafe {{ Box::from_raw(<*mut _>::take_ptr(&mut {}.contents.err)) }})", var_access))],
1651                                                 ")}", ContainerPrefixLocation::PerConv))
1652                         },
1653                         "Slice" if is_ref && only_contained_has_inner => {
1654                                 Some(("Vec::new(); for mut item in ", vec![(format!(".as_slice().iter() {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1655                         },
1656                         "Vec"|"Slice" => {
1657                                 Some(("Vec::new(); for mut item in ", vec![(format!(".into_rust().drain(..) {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1658                         },
1659                         "Option" => {
1660                                 if let Some(resolved) = only_contained_resolved {
1661                                         if self.is_primitive(&resolved) {
1662                                                 return Some(("if ", vec![(".is_some() { Some(".to_string(), format!("{}.take()", var_access))], ") } else { None }", ContainerPrefixLocation::NoPrefix))
1663                                         } else if only_contained_has_inner {
1664                                                 if is_ref {
1665                                                         return Some(("if ", vec![(".inner.is_null() { None } else { Some((*".to_string(), format!("{}", var_access))], ").clone()) }", ContainerPrefixLocation::PerConv))
1666                                                 } else {
1667                                                         return Some(("if ", vec![(".inner.is_null() { None } else { Some(".to_string(), format!("{}", var_access))], ") }", ContainerPrefixLocation::PerConv));
1668                                                 }
1669                                         }
1670                                 }
1671
1672                                 if let Some(t) = single_contained {
1673                                         match t {
1674                                                 syn::Type::Reference(_)|syn::Type::Path(_)|syn::Type::Slice(_)|syn::Type::Array(_) => {
1675                                                         let mut v = Vec::new();
1676                                                         let ret_ref = self.write_empty_rust_val_check_suffix(generics, &mut v, t);
1677                                                         let s = String::from_utf8(v).unwrap();
1678                                                         match ret_ref {
1679                                                                 EmptyValExpectedTy::ReferenceAsPointer =>
1680                                                                         return Some(("if ", vec![
1681                                                                                 (format!("{} {{ None }} else {{ Some(", s), format!("unsafe {{ &mut *{} }}", var_access))
1682                                                                         ], ") }", ContainerPrefixLocation::NoPrefix)),
1683                                                                 EmptyValExpectedTy::OptionType =>
1684                                                                         return Some(("{ /* ", vec![
1685                                                                                 (format!("*/ let {}_opt = {};", var_name, var_access),
1686                                                                                 format!("}} if {}_opt{} {{ None }} else {{ Some({{ {}_opt.take()", var_name, s, var_name))
1687                                                                         ], ") } }", ContainerPrefixLocation::PerConv)),
1688                                                                 EmptyValExpectedTy::NonPointer =>
1689                                                                         return Some(("if ", vec![
1690                                                                                 (format!("{} {{ None }} else {{ Some(", s), format!("{}", var_access))
1691                                                                         ], ") }", ContainerPrefixLocation::PerConv)),
1692                                                         }
1693                                                 },
1694                                                 syn::Type::Tuple(_) => {
1695                                                         return Some(("if ", vec![(".is_some() { Some(".to_string(), format!("{}.take()", var_access))], ") } else { None }", ContainerPrefixLocation::PerConv))
1696                                                 },
1697                                                 _ => unimplemented!(),
1698                                         }
1699                                 } else { unreachable!(); }
1700                         },
1701                         _ => None,
1702                 }
1703         }
1704
1705         /// Constructs a reference to the given type, possibly tweaking the type if relevant to make it
1706         /// convertable to C.
1707         pub fn create_ownable_reference(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> Option<syn::Type> {
1708                 let default_value = Some(syn::Type::Reference(syn::TypeReference {
1709                         and_token: syn::Token!(&)(Span::call_site()), lifetime: None, mutability: None,
1710                         elem: Box::new(t.clone()) }));
1711                 match generics.resolve_type(t) {
1712                         syn::Type::Path(p) => {
1713                                 if let Some(resolved_path) = self.maybe_resolve_path(&p.path, generics) {
1714                                         if resolved_path != "Vec" { return default_value; }
1715                                         if p.path.segments.len() != 1 { unimplemented!(); }
1716                                         let only_seg = p.path.segments.iter().next().unwrap();
1717                                         if let syn::PathArguments::AngleBracketed(args) = &only_seg.arguments {
1718                                                 if args.args.len() != 1 { unimplemented!(); }
1719                                                 let inner_arg = args.args.iter().next().unwrap();
1720                                                 if let syn::GenericArgument::Type(ty) = &inner_arg {
1721                                                         let mut can_create = self.c_type_has_inner(&ty);
1722                                                         if let syn::Type::Path(inner) = ty {
1723                                                                 if inner.path.segments.len() == 1 &&
1724                                                                                 format!("{}", inner.path.segments[0].ident) == "Vec" {
1725                                                                         can_create = true;
1726                                                                 }
1727                                                         }
1728                                                         if !can_create { return default_value; }
1729                                                         if let Some(inner_ty) = self.create_ownable_reference(&ty, generics) {
1730                                                                 return Some(syn::Type::Reference(syn::TypeReference {
1731                                                                         and_token: syn::Token![&](Span::call_site()),
1732                                                                         lifetime: None,
1733                                                                         mutability: None,
1734                                                                         elem: Box::new(syn::Type::Slice(syn::TypeSlice {
1735                                                                                 bracket_token: syn::token::Bracket { span: Span::call_site() },
1736                                                                                 elem: Box::new(inner_ty)
1737                                                                         }))
1738                                                                 }));
1739                                                         } else { return default_value; }
1740                                                 } else { unimplemented!(); }
1741                                         } else { unimplemented!(); }
1742                                 } else { return None; }
1743                         },
1744                         _ => default_value,
1745                 }
1746         }
1747
1748         // *************************************************
1749         // *** Type definition during main.rs processing ***
1750         // *************************************************
1751
1752         /// Returns true if the object at the given path is mapped as X { inner: *mut origX, .. }.
1753         pub fn c_type_has_inner_from_path(&self, full_path: &str) -> bool {
1754                 self.crate_types.opaques.get(full_path).is_some()
1755         }
1756
1757         /// Returns true if the object at the given path is mapped as X { inner: *mut origX, .. }.
1758         pub fn c_type_has_inner(&self, ty: &syn::Type) -> bool {
1759                 match ty {
1760                         syn::Type::Path(p) => {
1761                                 if let Some(full_path) = self.maybe_resolve_path(&p.path, None) {
1762                                         self.c_type_has_inner_from_path(&full_path)
1763                                 } else { false }
1764                         },
1765                         syn::Type::Reference(r) => {
1766                                 self.c_type_has_inner(&*r.elem)
1767                         },
1768                         _ => false,
1769                 }
1770         }
1771
1772         pub fn maybe_resolve_ident(&self, id: &syn::Ident) -> Option<String> {
1773                 self.types.maybe_resolve_ident(id)
1774         }
1775
1776         pub fn maybe_resolve_path(&self, p_arg: &syn::Path, generics: Option<&GenericTypes>) -> Option<String> {
1777                 self.types.maybe_resolve_path(p_arg, generics)
1778         }
1779         pub fn resolve_path(&self, p: &syn::Path, generics: Option<&GenericTypes>) -> String {
1780                 self.maybe_resolve_path(p, generics).unwrap()
1781         }
1782
1783         // ***********************************
1784         // *** Original Rust Type Printing ***
1785         // ***********************************
1786
1787         fn in_rust_prelude(resolved_path: &str) -> bool {
1788                 match resolved_path {
1789                         "Vec" => true,
1790                         "Result" => true,
1791                         "Option" => true,
1792                         _ => false,
1793                 }
1794         }
1795
1796         fn write_rust_path<W: std::io::Write>(&self, w: &mut W, generics_resolver: Option<&GenericTypes>, path: &syn::Path, with_ref_lifetime: bool, generated_crate_ref: bool) {
1797                 if let Some(resolved) = self.maybe_resolve_path(&path, generics_resolver) {
1798                         if self.is_primitive(&resolved) {
1799                                 write!(w, "{}", path.get_ident().unwrap()).unwrap();
1800                         } else {
1801                                 // TODO: We should have a generic "is from a dependency" check here instead of
1802                                 // checking for "bitcoin" explicitly.
1803                                 if resolved.starts_with("bitcoin::") || Self::in_rust_prelude(&resolved) {
1804                                         write!(w, "{}", resolved).unwrap();
1805                                 } else if !generated_crate_ref {
1806                                         // If we're printing a generic argument, it needs to reference the crate, otherwise
1807                                         // the original crate.
1808                                         write!(w, "{}", self.real_rust_type_mapping(&resolved)).unwrap();
1809                                 } else {
1810                                         write!(w, "crate::{}", resolved).unwrap();
1811                                 }
1812                         }
1813                         if let syn::PathArguments::AngleBracketed(args) = &path.segments.iter().last().unwrap().arguments {
1814                                 self.write_rust_generic_arg(w, generics_resolver, args.args.iter(), with_ref_lifetime);
1815                         }
1816                 } else {
1817                         if path.leading_colon.is_some() {
1818                                 write!(w, "::").unwrap();
1819                         }
1820                         for (idx, seg) in path.segments.iter().enumerate() {
1821                                 if idx != 0 { write!(w, "::").unwrap(); }
1822                                 write!(w, "{}", seg.ident).unwrap();
1823                                 if let syn::PathArguments::AngleBracketed(args) = &seg.arguments {
1824                                         self.write_rust_generic_arg(w, generics_resolver, args.args.iter(), with_ref_lifetime);
1825                                 }
1826                         }
1827                 }
1828         }
1829         pub fn write_rust_generic_param<'b, W: std::io::Write>(&self, w: &mut W, generics_resolver: Option<&GenericTypes>, generics: impl Iterator<Item=&'b syn::GenericParam>) {
1830                 let mut had_params = false;
1831                 for (idx, arg) in generics.enumerate() {
1832                         if idx != 0 { write!(w, ", ").unwrap(); } else { write!(w, "<").unwrap(); }
1833                         had_params = true;
1834                         match arg {
1835                                 syn::GenericParam::Lifetime(lt) => write!(w, "'{}", lt.lifetime.ident).unwrap(),
1836                                 syn::GenericParam::Type(t) => {
1837                                         write!(w, "{}", t.ident).unwrap();
1838                                         if t.colon_token.is_some() { write!(w, ":").unwrap(); }
1839                                         for (idx, bound) in t.bounds.iter().enumerate() {
1840                                                 if idx != 0 { write!(w, " + ").unwrap(); }
1841                                                 match bound {
1842                                                         syn::TypeParamBound::Trait(tb) => {
1843                                                                 if tb.paren_token.is_some() || tb.lifetimes.is_some() { unimplemented!(); }
1844                                                                 self.write_rust_path(w, generics_resolver, &tb.path, false, false);
1845                                                         },
1846                                                         _ => unimplemented!(),
1847                                                 }
1848                                         }
1849                                         if t.eq_token.is_some() || t.default.is_some() { unimplemented!(); }
1850                                 },
1851                                 _ => unimplemented!(),
1852                         }
1853                 }
1854                 if had_params { write!(w, ">").unwrap(); }
1855         }
1856
1857         pub fn write_rust_generic_arg<'b, W: std::io::Write>(&self, w: &mut W, generics_resolver: Option<&GenericTypes>, generics: impl Iterator<Item=&'b syn::GenericArgument>, with_ref_lifetime: bool) {
1858                 write!(w, "<").unwrap();
1859                 for (idx, arg) in generics.enumerate() {
1860                         if idx != 0 { write!(w, ", ").unwrap(); }
1861                         match arg {
1862                                 syn::GenericArgument::Type(t) => self.write_rust_type(w, generics_resolver, t, with_ref_lifetime),
1863                                 _ => unimplemented!(),
1864                         }
1865                 }
1866                 write!(w, ">").unwrap();
1867         }
1868         fn do_write_rust_type<W: std::io::Write>(&self, w: &mut W, generics: Option<&GenericTypes>, t: &syn::Type, with_ref_lifetime: bool, force_crate_ref: bool) {
1869                 let real_ty = generics.resolve_type(t);
1870                 let mut generate_crate_ref = force_crate_ref || t != real_ty;
1871                 match real_ty {
1872                         syn::Type::Path(p) => {
1873                                 if p.qself.is_some() {
1874                                         unimplemented!();
1875                                 }
1876                                 if let Some(resolved_ty) = self.maybe_resolve_path(&p.path, generics) {
1877                                         generate_crate_ref |= self.maybe_resolve_path(&p.path, None).as_ref() != Some(&resolved_ty);
1878                                         if self.crate_types.traits.get(&resolved_ty).is_none() { generate_crate_ref = false; }
1879                                 }
1880                                 self.write_rust_path(w, generics, &p.path, with_ref_lifetime, generate_crate_ref);
1881                         },
1882                         syn::Type::Reference(r) => {
1883                                 write!(w, "&").unwrap();
1884                                 if let Some(lft) = &r.lifetime {
1885                                         write!(w, "'{} ", lft.ident).unwrap();
1886                                 } else if with_ref_lifetime {
1887                                         write!(w, "'static ").unwrap();
1888                                 }
1889                                 if r.mutability.is_some() {
1890                                         write!(w, "mut ").unwrap();
1891                                 }
1892                                 self.do_write_rust_type(w, generics, &*r.elem, with_ref_lifetime, generate_crate_ref);
1893                         },
1894                         syn::Type::Array(a) => {
1895                                 write!(w, "[").unwrap();
1896                                 self.do_write_rust_type(w, generics, &a.elem, with_ref_lifetime, generate_crate_ref);
1897                                 if let syn::Expr::Lit(l) = &a.len {
1898                                         if let syn::Lit::Int(i) = &l.lit {
1899                                                 write!(w, "; {}]", i).unwrap();
1900                                         } else { unimplemented!(); }
1901                                 } else { unimplemented!(); }
1902                         }
1903                         syn::Type::Slice(s) => {
1904                                 write!(w, "[").unwrap();
1905                                 self.do_write_rust_type(w, generics, &s.elem, with_ref_lifetime, generate_crate_ref);
1906                                 write!(w, "]").unwrap();
1907                         },
1908                         syn::Type::Tuple(s) => {
1909                                 write!(w, "(").unwrap();
1910                                 for (idx, t) in s.elems.iter().enumerate() {
1911                                         if idx != 0 { write!(w, ", ").unwrap(); }
1912                                         self.do_write_rust_type(w, generics, &t, with_ref_lifetime, generate_crate_ref);
1913                                 }
1914                                 write!(w, ")").unwrap();
1915                         },
1916                         _ => unimplemented!(),
1917                 }
1918         }
1919         pub fn write_rust_type<W: std::io::Write>(&self, w: &mut W, generics: Option<&GenericTypes>, t: &syn::Type, with_ref_lifetime: bool) {
1920                 self.do_write_rust_type(w, generics, t, with_ref_lifetime, false);
1921         }
1922
1923
1924         /// Prints a constructor for something which is "uninitialized" (but obviously not actually
1925         /// unint'd memory).
1926         pub fn write_empty_rust_val<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type) {
1927                 match t {
1928                         syn::Type::Reference(r) => {
1929                                 self.write_empty_rust_val(generics, w, &*r.elem)
1930                         },
1931                         syn::Type::Path(p) => {
1932                                 let resolved = self.resolve_path(&p.path, generics);
1933                                 if self.crate_types.opaques.get(&resolved).is_some() {
1934                                         write!(w, "crate::{} {{ inner: core::ptr::null_mut(), is_owned: true }}", resolved).unwrap();
1935                                 } else {
1936                                         // Assume its a manually-mapped C type, where we can just define an null() fn
1937                                         write!(w, "{}::null()", self.c_type_from_path(&resolved, false, false).unwrap()).unwrap();
1938                                 }
1939                         },
1940                         syn::Type::Array(a) => {
1941                                 if let syn::Expr::Lit(l) = &a.len {
1942                                         if let syn::Lit::Int(i) = &l.lit {
1943                                                 if i.base10_digits().parse::<usize>().unwrap() < 32 {
1944                                                         // Blindly assume that if we're trying to create an empty value for an
1945                                                         // array < 32 entries that all-0s may be a valid state.
1946                                                         unimplemented!();
1947                                                 }
1948                                                 let arrty = format!("[u8; {}]", i.base10_digits());
1949                                                 write!(w, "{}", self.to_c_conversion_inline_prefix_from_path(&arrty, false, false).unwrap()).unwrap();
1950                                                 write!(w, "[0; {}]", i.base10_digits()).unwrap();
1951                                                 write!(w, "{}", self.to_c_conversion_inline_suffix_from_path(&arrty, false, false).unwrap()).unwrap();
1952                                         } else { unimplemented!(); }
1953                                 } else { unimplemented!(); }
1954                         }
1955                         _ => unimplemented!(),
1956                 }
1957         }
1958
1959         fn is_real_type_array(&self, resolved_type: &str) -> Option<syn::Type> {
1960                 if let Some(real_ty) = self.c_type_from_path(&resolved_type, true, false) {
1961                         if real_ty.ends_with("]") && real_ty.starts_with("*const [u8; ") {
1962                                 let mut split = real_ty.split("; ");
1963                                 split.next().unwrap();
1964                                 let tail_str = split.next().unwrap();
1965                                 assert!(split.next().is_none());
1966                                 let len = usize::from_str_radix(&tail_str[..tail_str.len() - 1], 10).unwrap();
1967                                 Some(parse_quote!([u8; #len]))
1968                         } else { None }
1969                 } else { None }
1970         }
1971
1972         /// Prints a suffix to determine if a variable is empty (ie was set by write_empty_rust_val).
1973         /// See EmptyValExpectedTy for information on return types.
1974         fn write_empty_rust_val_check_suffix<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type) -> EmptyValExpectedTy {
1975                 match t {
1976                         syn::Type::Reference(r) => {
1977                                 return self.write_empty_rust_val_check_suffix(generics, w, &*r.elem);
1978                         },
1979                         syn::Type::Path(p) => {
1980                                 let resolved = self.resolve_path(&p.path, generics);
1981                                 if let Some(arr_ty) = self.is_real_type_array(&resolved) {
1982                                         return self.write_empty_rust_val_check_suffix(generics, w, &arr_ty);
1983                                 }
1984                                 if self.crate_types.opaques.get(&resolved).is_some() {
1985                                         write!(w, ".inner.is_null()").unwrap();
1986                                         EmptyValExpectedTy::NonPointer
1987                                 } else {
1988                                         if let Some(suffix) = self.empty_val_check_suffix_from_path(&resolved) {
1989                                                 write!(w, "{}", suffix).unwrap();
1990                                                 // We may eventually need to allow empty_val_check_suffix_from_path to specify if we need a deref or not
1991                                                 EmptyValExpectedTy::NonPointer
1992                                         } else {
1993                                                 write!(w, ".is_none()").unwrap();
1994                                                 EmptyValExpectedTy::OptionType
1995                                         }
1996                                 }
1997                         },
1998                         syn::Type::Array(a) => {
1999                                 if let syn::Expr::Lit(l) = &a.len {
2000                                         if let syn::Lit::Int(i) = &l.lit {
2001                                                 write!(w, ".data == [0; {}]", i.base10_digits()).unwrap();
2002                                                 EmptyValExpectedTy::NonPointer
2003                                         } else { unimplemented!(); }
2004                                 } else { unimplemented!(); }
2005                         },
2006                         syn::Type::Slice(_) => {
2007                                 // Option<[]> always implies that we want to treat len() == 0 differently from
2008                                 // None, so we always map an Option<[]> into a pointer.
2009                                 write!(w, " == core::ptr::null_mut()").unwrap();
2010                                 EmptyValExpectedTy::ReferenceAsPointer
2011                         },
2012                         _ => unimplemented!(),
2013                 }
2014         }
2015
2016         /// Prints a suffix to determine if a variable is empty (ie was set by write_empty_rust_val).
2017         pub fn write_empty_rust_val_check<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type, var_access: &str) {
2018                 match t {
2019                         syn::Type::Reference(r) => {
2020                                 self.write_empty_rust_val_check(generics, w, &*r.elem, var_access);
2021                         },
2022                         syn::Type::Path(_) => {
2023                                 write!(w, "{}", var_access).unwrap();
2024                                 self.write_empty_rust_val_check_suffix(generics, w, t);
2025                         },
2026                         syn::Type::Array(a) => {
2027                                 if let syn::Expr::Lit(l) = &a.len {
2028                                         if let syn::Lit::Int(i) = &l.lit {
2029                                                 let arrty = format!("[u8; {}]", i.base10_digits());
2030                                                 // We don't (yet) support a new-var conversion here.
2031                                                 assert!(self.from_c_conversion_new_var_from_path(&arrty, false).is_none());
2032                                                 write!(w, "{}{}{}",
2033                                                         self.from_c_conversion_prefix_from_path(&arrty, false).unwrap(),
2034                                                         var_access,
2035                                                         self.from_c_conversion_suffix_from_path(&arrty, false).unwrap()).unwrap();
2036                                                 self.write_empty_rust_val_check_suffix(generics, w, t);
2037                                         } else { unimplemented!(); }
2038                                 } else { unimplemented!(); }
2039                         }
2040                         _ => unimplemented!(),
2041                 }
2042         }
2043
2044         // ********************************
2045         // *** Type conversion printing ***
2046         // ********************************
2047
2048         /// Returns true we if can just skip passing this to C entirely
2049         pub fn skip_arg(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> bool {
2050                 match t {
2051                         syn::Type::Path(p) => {
2052                                 if p.qself.is_some() { unimplemented!(); }
2053                                 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
2054                                         self.skip_path(&full_path)
2055                                 } else { false }
2056                         },
2057                         syn::Type::Reference(r) => {
2058                                 self.skip_arg(&*r.elem, generics)
2059                         },
2060                         _ => false,
2061                 }
2062         }
2063         pub fn no_arg_to_rust<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2064                 match t {
2065                         syn::Type::Path(p) => {
2066                                 if p.qself.is_some() { unimplemented!(); }
2067                                 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
2068                                         write!(w, "{}", self.no_arg_path_to_rust(&full_path)).unwrap();
2069                                 }
2070                         },
2071                         syn::Type::Reference(r) => {
2072                                 self.no_arg_to_rust(w, &*r.elem, generics);
2073                         },
2074                         _ => {},
2075                 }
2076         }
2077
2078         fn write_conversion_inline_intern<W: std::io::Write,
2079                         LP: Fn(&str, bool, bool) -> Option<String>, DL: Fn(&mut W, &DeclType, &str, bool, bool), SC: Fn(bool, Option<&str>) -> String>
2080                         (&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, is_ref: bool, is_mut: bool, ptr_for_ref: bool,
2081                          tupleconv: &str, prefix: bool, sliceconv: SC, path_lookup: LP, decl_lookup: DL) {
2082                 match generics.resolve_type(t) {
2083                         syn::Type::Reference(r) => {
2084                                 self.write_conversion_inline_intern(w, &*r.elem, generics, true, r.mutability.is_some(),
2085                                         ptr_for_ref, tupleconv, prefix, sliceconv, path_lookup, decl_lookup);
2086                         },
2087                         syn::Type::Path(p) => {
2088                                 if p.qself.is_some() {
2089                                         unimplemented!();
2090                                 }
2091
2092                                 let resolved_path = self.resolve_path(&p.path, generics);
2093                                 if let Some(aliased_type) = self.crate_types.type_aliases.get(&resolved_path) {
2094                                         return self.write_conversion_inline_intern(w, aliased_type, None, is_ref, is_mut, ptr_for_ref, tupleconv, prefix, sliceconv, path_lookup, decl_lookup);
2095                                 } else if self.is_primitive(&resolved_path) {
2096                                         if is_ref && prefix {
2097                                                 write!(w, "*").unwrap();
2098                                         }
2099                                 } else if let Some(c_type) = path_lookup(&resolved_path, is_ref, ptr_for_ref) {
2100                                         write!(w, "{}", c_type).unwrap();
2101                                 } else if let Some((_, generics)) = self.crate_types.opaques.get(&resolved_path) {
2102                                         decl_lookup(w, &DeclType::StructImported { generics: &generics }, &resolved_path, is_ref, is_mut);
2103                                 } else if self.crate_types.mirrored_enums.get(&resolved_path).is_some() {
2104                                         decl_lookup(w, &DeclType::MirroredEnum, &resolved_path, is_ref, is_mut);
2105                                 } else if let Some(t) = self.crate_types.traits.get(&resolved_path) {
2106                                         decl_lookup(w, &DeclType::Trait(t), &resolved_path, is_ref, is_mut);
2107                                 } else if let Some(ident) = single_ident_generic_path_to_ident(&p.path) {
2108                                         if let Some(decl_type) = self.types.maybe_resolve_declared(ident) {
2109                                                 decl_lookup(w, decl_type, &self.maybe_resolve_ident(ident).unwrap(), is_ref, is_mut);
2110                                         } else { unimplemented!(); }
2111                                 } else { unimplemented!(); }
2112                         },
2113                         syn::Type::Array(a) => {
2114                                 if let syn::Type::Path(p) = &*a.elem {
2115                                         let inner_ty = self.resolve_path(&p.path, generics);
2116                                         if let syn::Expr::Lit(l) = &a.len {
2117                                                 if let syn::Lit::Int(i) = &l.lit {
2118                                                         write!(w, "{}", path_lookup(&format!("[{}; {}]", inner_ty, i.base10_digits()), is_ref, ptr_for_ref).unwrap()).unwrap();
2119                                                 } else { unimplemented!(); }
2120                                         } else { unimplemented!(); }
2121                                 } else { unimplemented!(); }
2122                         },
2123                         syn::Type::Slice(s) => {
2124                                 // We assume all slices contain only literals or references.
2125                                 // This may result in some outputs not compiling.
2126                                 if let syn::Type::Path(p) = &*s.elem {
2127                                         let resolved = self.resolve_path(&p.path, generics);
2128                                         if self.is_primitive(&resolved) {
2129                                                 write!(w, "{}", path_lookup("[u8]", is_ref, ptr_for_ref).unwrap()).unwrap();
2130                                         } else {
2131                                                 write!(w, "{}", sliceconv(true, None)).unwrap();
2132                                         }
2133                                 } else if let syn::Type::Reference(r) = &*s.elem {
2134                                         if let syn::Type::Path(p) = &*r.elem {
2135                                                 write!(w, "{}", sliceconv(self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)), None)).unwrap();
2136                                         } else if let syn::Type::Slice(_) = &*r.elem {
2137                                                 write!(w, "{}", sliceconv(false, None)).unwrap();
2138                                         } else { unimplemented!(); }
2139                                 } else if let syn::Type::Tuple(t) = &*s.elem {
2140                                         assert!(!t.elems.is_empty());
2141                                         if prefix {
2142                                                 write!(w, "{}", sliceconv(false, None)).unwrap();
2143                                         } else {
2144                                                 let mut needs_map = false;
2145                                                 for e in t.elems.iter() {
2146                                                         if let syn::Type::Reference(_) = e {
2147                                                                 needs_map = true;
2148                                                         }
2149                                                 }
2150                                                 if needs_map {
2151                                                         let mut map_str = Vec::new();
2152                                                         write!(&mut map_str, ".map(|(").unwrap();
2153                                                         for i in 0..t.elems.len() {
2154                                                                 write!(&mut map_str, "{}{}", if i != 0 { ", " } else { "" }, ('a' as u8 + i as u8) as char).unwrap();
2155                                                         }
2156                                                         write!(&mut map_str, ")| (").unwrap();
2157                                                         for (idx, e) in t.elems.iter().enumerate() {
2158                                                                 if let syn::Type::Reference(_) = e {
2159                                                                         write!(&mut map_str, "{}{}", if idx != 0 { ", " } else { "" }, (idx as u8 + 'a' as u8) as char).unwrap();
2160                                                                 } else if let syn::Type::Path(_) = e {
2161                                                                         write!(&mut map_str, "{}*{}", if idx != 0 { ", " } else { "" }, (idx as u8 + 'a' as u8) as char).unwrap();
2162                                                                 } else { unimplemented!(); }
2163                                                         }
2164                                                         write!(&mut map_str, "))").unwrap();
2165                                                         write!(w, "{}", sliceconv(false, Some(&String::from_utf8(map_str).unwrap()))).unwrap();
2166                                                 } else {
2167                                                         write!(w, "{}", sliceconv(false, None)).unwrap();
2168                                                 }
2169                                         }
2170                                 } else if let syn::Type::Array(_) = &*s.elem {
2171                                         write!(w, "{}", sliceconv(false, Some(".map(|a| *a)"))).unwrap();
2172                                 } else { unimplemented!(); }
2173                         },
2174                         syn::Type::Tuple(t) => {
2175                                 if t.elems.is_empty() {
2176                                         // cbindgen has poor support for (), see, eg https://github.com/eqrion/cbindgen/issues/527
2177                                         // so work around it by just pretending its a 0u8
2178                                         write!(w, "{}", tupleconv).unwrap();
2179                                 } else {
2180                                         if prefix { write!(w, "local_").unwrap(); }
2181                                 }
2182                         },
2183                         _ => unimplemented!(),
2184                 }
2185         }
2186
2187         fn write_to_c_conversion_inline_prefix_inner<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, is_ref: bool, ptr_for_ref: bool, from_ptr: bool) {
2188                 self.write_conversion_inline_intern(w, t, generics, is_ref, false, ptr_for_ref, "() /*", true, |_, _| "local_".to_owned(),
2189                                 |a, b, c| self.to_c_conversion_inline_prefix_from_path(a, b, c),
2190                                 |w, decl_type, decl_path, is_ref, _is_mut| {
2191                                         match decl_type {
2192                                                 DeclType::MirroredEnum if is_ref && ptr_for_ref => write!(w, "crate::{}::from_native(", decl_path).unwrap(),
2193                                                 DeclType::MirroredEnum if is_ref => write!(w, "&crate::{}::from_native(", decl_path).unwrap(),
2194                                                 DeclType::MirroredEnum => write!(w, "crate::{}::native_into(", decl_path).unwrap(),
2195                                                 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if is_ref && from_ptr => {
2196                                                         if !ptr_for_ref { write!(w, "&").unwrap(); }
2197                                                         write!(w, "crate::{} {{ inner: unsafe {{ (", decl_path).unwrap()
2198                                                 },
2199                                                 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if is_ref => {
2200                                                         if !ptr_for_ref { write!(w, "&").unwrap(); }
2201                                                         write!(w, "crate::{} {{ inner: unsafe {{ ObjOps::nonnull_ptr_to_inner((", decl_path).unwrap()
2202                                                 },
2203                                                 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref && from_ptr =>
2204                                                         write!(w, "crate::{} {{ inner: ", decl_path).unwrap(),
2205                                                 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref =>
2206                                                         write!(w, "crate::{} {{ inner: ObjOps::heap_alloc(", decl_path).unwrap(),
2207                                                 DeclType::Trait(_) if is_ref => write!(w, "").unwrap(),
2208                                                 DeclType::Trait(_) if !is_ref => write!(w, "Into::into(").unwrap(),
2209                                                 _ => panic!("{:?}", decl_path),
2210                                         }
2211                                 });
2212         }
2213         pub fn write_to_c_conversion_inline_prefix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, ptr_for_ref: bool) {
2214                 self.write_to_c_conversion_inline_prefix_inner(w, t, generics, false, ptr_for_ref, false);
2215         }
2216         fn write_to_c_conversion_inline_suffix_inner<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, is_ref: bool, ptr_for_ref: bool, from_ptr: bool) {
2217                 self.write_conversion_inline_intern(w, t, generics, is_ref, false, ptr_for_ref, "*/", false, |_, _| ".into()".to_owned(),
2218                                 |a, b, c| self.to_c_conversion_inline_suffix_from_path(a, b, c),
2219                                 |w, decl_type, full_path, is_ref, _is_mut| match decl_type {
2220                                         DeclType::MirroredEnum => write!(w, ")").unwrap(),
2221                                         DeclType::EnumIgnored { generics }|DeclType::StructImported { generics } if is_ref => {
2222                                                 write!(w, " as *const {}<", full_path).unwrap();
2223                                                 for param in generics.params.iter() {
2224                                                         if let syn::GenericParam::Lifetime(_) = param {
2225                                                                 write!(w, "'_, ").unwrap();
2226                                                         } else {
2227                                                                 write!(w, "_, ").unwrap();
2228                                                         }
2229                                                 }
2230                                                 if from_ptr {
2231                                                         write!(w, ">) as *mut _ }}, is_owned: false }}").unwrap();
2232                                                 } else {
2233                                                         write!(w, ">) as *mut _) }}, is_owned: false }}").unwrap();
2234                                                 }
2235                                         },
2236                                         DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref && from_ptr =>
2237                                                 write!(w, ", is_owned: true }}").unwrap(),
2238                                         DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref => write!(w, "), is_owned: true }}").unwrap(),
2239                                         DeclType::Trait(_) if is_ref => {},
2240                                         DeclType::Trait(_) => {
2241                                                 // This is used when we're converting a concrete Rust type into a C trait
2242                                                 // for use when a Rust trait method returns an associated type.
2243                                                 // Because all of our C traits implement From<RustTypesImplementingTraits>
2244                                                 // we can just call .into() here and be done.
2245                                                 write!(w, ")").unwrap()
2246                                         },
2247                                         _ => unimplemented!(),
2248                                 });
2249         }
2250         pub fn write_to_c_conversion_inline_suffix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, ptr_for_ref: bool) {
2251                 self.write_to_c_conversion_inline_suffix_inner(w, t, generics, false, ptr_for_ref, false);
2252         }
2253
2254         fn write_from_c_conversion_prefix_inner<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, is_ref: bool, _ptr_for_ref: bool) {
2255                 self.write_conversion_inline_intern(w, t, generics, is_ref, false, false, "() /*", true, |_, _| "&local_".to_owned(),
2256                                 |a, b, _c| self.from_c_conversion_prefix_from_path(a, b),
2257                                 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
2258                                         DeclType::StructImported {..} if is_ref => write!(w, "").unwrap(),
2259                                         DeclType::StructImported {..} if !is_ref => write!(w, "*unsafe {{ Box::from_raw(").unwrap(),
2260                                         DeclType::MirroredEnum if is_ref => write!(w, "&").unwrap(),
2261                                         DeclType::MirroredEnum => {},
2262                                         DeclType::Trait(_) => {},
2263                                         _ => unimplemented!(),
2264                                 });
2265         }
2266         pub fn write_from_c_conversion_prefix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2267                 self.write_from_c_conversion_prefix_inner(w, t, generics, false, false);
2268         }
2269         fn write_from_c_conversion_suffix_inner<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, is_ref: bool, ptr_for_ref: bool) {
2270                 self.write_conversion_inline_intern(w, t, generics, is_ref, false, false, "*/", false,
2271                                 |has_inner, map_str_opt| match (has_inner, map_str_opt) {
2272                                         (false, Some(map_str)) => format!(".iter(){}.collect::<Vec<_>>()[..]", map_str),
2273                                         (false, None) => ".iter().collect::<Vec<_>>()[..]".to_owned(),
2274                                         (true, None) => "[..]".to_owned(),
2275                                         (true, Some(_)) => unreachable!(),
2276                                 },
2277                                 |a, b, _c| self.from_c_conversion_suffix_from_path(a, b),
2278                                 |w, decl_type, _full_path, is_ref, is_mut| match decl_type {
2279                                         DeclType::StructImported {..} if is_ref && ptr_for_ref => write!(w, "XXX unimplemented").unwrap(),
2280                                         DeclType::StructImported {..} if is_mut && is_ref => write!(w, ".get_native_mut_ref()").unwrap(),
2281                                         DeclType::StructImported {..} if is_ref => write!(w, ".get_native_ref()").unwrap(),
2282                                         DeclType::StructImported {..} if !is_ref => write!(w, ".take_inner()) }}").unwrap(),
2283                                         DeclType::MirroredEnum if is_ref => write!(w, ".to_native()").unwrap(),
2284                                         DeclType::MirroredEnum => write!(w, ".into_native()").unwrap(),
2285                                         DeclType::Trait(_) => {},
2286                                         _ => unimplemented!(),
2287                                 });
2288         }
2289         pub fn write_from_c_conversion_suffix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2290                 self.write_from_c_conversion_suffix_inner(w, t, generics, false, false);
2291         }
2292         // Note that compared to the above conversion functions, the following two are generally
2293         // significantly undertested:
2294         pub fn write_from_c_conversion_to_ref_prefix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2295                 self.write_conversion_inline_intern(w, t, generics, false, false, false, "() /*", true, |_, _| "&local_".to_owned(),
2296                                 |a, b, _c| {
2297                                         if let Some(conv) = self.from_c_conversion_prefix_from_path(a, b) {
2298                                                 Some(format!("&{}", conv))
2299                                         } else { None }
2300                                 },
2301                                 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
2302                                         DeclType::StructImported {..} if !is_ref => write!(w, "").unwrap(),
2303                                         _ => unimplemented!(),
2304                                 });
2305         }
2306         pub fn write_from_c_conversion_to_ref_suffix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2307                 self.write_conversion_inline_intern(w, t, generics, false, false, false, "*/", false,
2308                                 |has_inner, map_str_opt| match (has_inner, map_str_opt) {
2309                                         (false, Some(map_str)) => format!(".iter(){}.collect::<Vec<_>>()[..]", map_str),
2310                                         (false, None) => ".iter().collect::<Vec<_>>()[..]".to_owned(),
2311                                         (true, None) => "[..]".to_owned(),
2312                                         (true, Some(_)) => unreachable!(),
2313                                 },
2314                                 |a, b, _c| self.from_c_conversion_suffix_from_path(a, b),
2315                                 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
2316                                         DeclType::StructImported {..} if !is_ref => write!(w, ".get_native_ref()").unwrap(),
2317                                         _ => unimplemented!(),
2318                                 });
2319         }
2320
2321         fn write_conversion_new_var_intern<'b, W: std::io::Write,
2322                 LP: Fn(&str, bool) -> Option<(&str, &str)>,
2323                 LC: Fn(&str, bool, Option<&syn::Type>, &syn::Ident, &str) ->  Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)>,
2324                 VP: Fn(&mut W, &syn::Type, Option<&GenericTypes>, bool, bool, bool),
2325                 VS: Fn(&mut W, &syn::Type, Option<&GenericTypes>, bool, bool, bool)>
2326                         (&self, w: &mut W, ident: &syn::Ident, var: &str, t: &syn::Type, generics: Option<&GenericTypes>,
2327                          mut is_ref: bool, mut ptr_for_ref: bool, to_c: bool, from_ownable_ref: bool,
2328                          path_lookup: &LP, container_lookup: &LC, var_prefix: &VP, var_suffix: &VS) -> bool {
2329
2330                 macro_rules! convert_container {
2331                         ($container_type: expr, $args_len: expr, $args_iter: expr) => { {
2332                                 // For slices (and Options), we refuse to directly map them as is_ref when they
2333                                 // aren't opaque types containing an inner pointer. This is due to the fact that,
2334                                 // in both cases, the actual higher-level type is non-is_ref.
2335                                 let (ty_has_inner, ty_is_trait) = if $args_len == 1 {
2336                                         let ty = $args_iter().next().unwrap();
2337                                         if $container_type == "Slice" && to_c {
2338                                                 // "To C ptr_for_ref" means "return the regular object with is_owned
2339                                                 // set to false", which is totally what we want in a slice if we're about to
2340                                                 // set ty_has_inner.
2341                                                 ptr_for_ref = true;
2342                                         }
2343                                         if let syn::Type::Reference(t) = ty {
2344                                                 if let syn::Type::Path(p) = &*t.elem {
2345                                                         let resolved = self.resolve_path(&p.path, generics);
2346                                                         (self.c_type_has_inner_from_path(&resolved), self.crate_types.traits.get(&resolved).is_some())
2347                                                 } else { (false, false) }
2348                                         } else if let syn::Type::Path(p) = ty {
2349                                                 let resolved = self.resolve_path(&p.path, generics);
2350                                                 (self.c_type_has_inner_from_path(&resolved), self.crate_types.traits.get(&resolved).is_some())
2351                                         } else { (false, false) }
2352                                 } else { (true, false) };
2353
2354                                 // Options get a bunch of special handling, since in general we map Option<>al
2355                                 // types into the same C type as non-Option-wrapped types. This ends up being
2356                                 // pretty manual here and most of the below special-cases are for Options.
2357                                 let mut needs_ref_map = false;
2358                                 let mut only_contained_type = None;
2359                                 let mut only_contained_type_nonref = None;
2360                                 let mut only_contained_has_inner = false;
2361                                 let mut contains_slice = false;
2362                                 if $args_len == 1 {
2363                                         only_contained_has_inner = ty_has_inner;
2364                                         let arg = $args_iter().next().unwrap();
2365                                         if let syn::Type::Reference(t) = arg {
2366                                                 only_contained_type = Some(arg);
2367                                                 only_contained_type_nonref = Some(&*t.elem);
2368                                                 if let syn::Type::Path(_) = &*t.elem {
2369                                                         is_ref = true;
2370                                                 } else if let syn::Type::Slice(_) = &*t.elem {
2371                                                         contains_slice = true;
2372                                                 } else { return false; }
2373                                                 // If the inner element contains an inner pointer, we will just use that,
2374                                                 // avoiding the need to map elements to references. Otherwise we'll need to
2375                                                 // do an extra mapping step.
2376                                                 needs_ref_map = !only_contained_has_inner && !ty_is_trait && $container_type == "Option";
2377                                         } else {
2378                                                 only_contained_type = Some(arg);
2379                                                 only_contained_type_nonref = Some(arg);
2380                                         }
2381                                 }
2382
2383                                 if let Some((prefix, conversions, suffix, prefix_location)) = container_lookup(&$container_type, is_ref, only_contained_type, ident, var) {
2384                                         assert_eq!(conversions.len(), $args_len);
2385                                         write!(w, "let mut local_{}{} = ", ident,
2386                                                 if (!to_c && needs_ref_map) || (to_c && $container_type == "Option" && contains_slice) {"_base"} else { "" }).unwrap();
2387                                         if prefix_location == ContainerPrefixLocation::OutsideConv {
2388                                                 var_prefix(w, $args_iter().next().unwrap(), generics, is_ref, true, true);
2389                                         }
2390                                         write!(w, "{}{}", prefix, var).unwrap();
2391
2392                                         for ((pfx, var_name), (idx, ty)) in conversions.iter().zip($args_iter().enumerate()) {
2393                                                 let mut var = std::io::Cursor::new(Vec::new());
2394                                                 write!(&mut var, "{}", var_name).unwrap();
2395                                                 let var_access = String::from_utf8(var.into_inner()).unwrap();
2396
2397                                                 let conv_ty = if needs_ref_map { only_contained_type_nonref.as_ref().unwrap() } else { ty };
2398
2399                                                 write!(w, "{} {{ ", pfx).unwrap();
2400                                                 let new_var_name = format!("{}_{}", ident, idx);
2401                                                 let new_var = self.write_conversion_new_var_intern(w, &format_ident!("{}", new_var_name),
2402                                                                 &var_access, conv_ty, generics, contains_slice || (is_ref && ty_has_inner), ptr_for_ref,
2403                                                                 to_c, from_ownable_ref, path_lookup, container_lookup, var_prefix, var_suffix);
2404                                                 if new_var { write!(w, " ").unwrap(); }
2405
2406                                                 if prefix_location == ContainerPrefixLocation::PerConv {
2407                                                         var_prefix(w, conv_ty, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2408                                                 } else if !is_ref && !needs_ref_map && to_c && only_contained_has_inner {
2409                                                         write!(w, "ObjOps::heap_alloc(").unwrap();
2410                                                 }
2411
2412                                                 write!(w, "{}{}", if contains_slice && !to_c { "local_" } else { "" }, if new_var { new_var_name } else { var_access }).unwrap();
2413                                                 if prefix_location == ContainerPrefixLocation::PerConv {
2414                                                         var_suffix(w, conv_ty, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2415                                                 } else if !is_ref && !needs_ref_map && to_c && only_contained_has_inner {
2416                                                         write!(w, ")").unwrap();
2417                                                 }
2418                                                 write!(w, " }}").unwrap();
2419                                         }
2420                                         write!(w, "{}", suffix).unwrap();
2421                                         if prefix_location == ContainerPrefixLocation::OutsideConv {
2422                                                 var_suffix(w, $args_iter().next().unwrap(), generics, is_ref, ptr_for_ref, true);
2423                                         }
2424                                         write!(w, ";").unwrap();
2425                                         if !to_c && needs_ref_map {
2426                                                 write!(w, " let mut local_{} = local_{}_base.as_ref()", ident, ident).unwrap();
2427                                                 if contains_slice {
2428                                                         write!(w, ".map(|a| &a[..])").unwrap();
2429                                                 }
2430                                                 write!(w, ";").unwrap();
2431                                         } else if to_c && $container_type == "Option" && contains_slice {
2432                                                 write!(w, " let mut local_{} = *local_{}_base;", ident, ident).unwrap();
2433                                         }
2434                                         return true;
2435                                 }
2436                         } }
2437                 }
2438
2439                 match generics.resolve_type(t) {
2440                         syn::Type::Reference(r) => {
2441                                 if let syn::Type::Slice(_) = &*r.elem {
2442                                         self.write_conversion_new_var_intern(w, ident, var, &*r.elem, generics, is_ref, ptr_for_ref, to_c, from_ownable_ref, path_lookup, container_lookup, var_prefix, var_suffix)
2443                                 } else {
2444                                         self.write_conversion_new_var_intern(w, ident, var, &*r.elem, generics, true, ptr_for_ref, to_c, from_ownable_ref, path_lookup, container_lookup, var_prefix, var_suffix)
2445                                 }
2446                         },
2447                         syn::Type::Path(p) => {
2448                                 if p.qself.is_some() {
2449                                         unimplemented!();
2450                                 }
2451                                 let resolved_path = self.resolve_path(&p.path, generics);
2452                                 if let Some(aliased_type) = self.crate_types.type_aliases.get(&resolved_path) {
2453                                         return self.write_conversion_new_var_intern(w, ident, var, aliased_type, None, is_ref, ptr_for_ref, to_c, from_ownable_ref, path_lookup, container_lookup, var_prefix, var_suffix);
2454                                 }
2455                                 if self.is_known_container(&resolved_path, is_ref) || self.is_path_transparent_container(&p.path, generics, is_ref) {
2456                                         if let syn::PathArguments::AngleBracketed(args) = &p.path.segments.iter().next().unwrap().arguments {
2457                                                 convert_container!(resolved_path, args.args.len(), || args.args.iter().map(|arg| {
2458                                                         if let syn::GenericArgument::Type(ty) = arg {
2459                                                                 generics.resolve_type(ty)
2460                                                         } else { unimplemented!(); }
2461                                                 }));
2462                                         } else { unimplemented!(); }
2463                                 }
2464                                 if self.is_primitive(&resolved_path) {
2465                                         false
2466                                 } else if let Some(ty_ident) = single_ident_generic_path_to_ident(&p.path) {
2467                                         if let Some((prefix, suffix)) = path_lookup(&resolved_path, is_ref) {
2468                                                 write!(w, "let mut local_{} = {}{}{};", ident, prefix, var, suffix).unwrap();
2469                                                 true
2470                                         } else if self.types.maybe_resolve_declared(ty_ident).is_some() {
2471                                                 false
2472                                         } else { false }
2473                                 } else { false }
2474                         },
2475                         syn::Type::Array(_) => {
2476                                 // We assume all arrays contain only primitive types.
2477                                 // This may result in some outputs not compiling.
2478                                 false
2479                         },
2480                         syn::Type::Slice(s) => {
2481                                 if let syn::Type::Path(p) = &*s.elem {
2482                                         let resolved = self.resolve_path(&p.path, generics);
2483                                         if self.is_primitive(&resolved) {
2484                                                 let slice_path = format!("[{}]", resolved);
2485                                                 if let Some((prefix, suffix)) = path_lookup(&slice_path, true) {
2486                                                         write!(w, "let mut local_{} = {}{}{};", ident, prefix, var, suffix).unwrap();
2487                                                         true
2488                                                 } else { false }
2489                                         } else {
2490                                                 let tyref = [&*s.elem];
2491                                                 if to_c {
2492                                                         // If we're converting from a slice to a Vec, assume we can clone the
2493                                                         // elements and clone them into a new Vec first. Next we'll walk the
2494                                                         // new Vec here and convert them to C types.
2495                                                         write!(w, "let mut local_{}_clone = Vec::new(); local_{}_clone.extend_from_slice({}); let mut {} = local_{}_clone; ", ident, ident, ident, ident, ident).unwrap();
2496                                                 }
2497                                                 is_ref = false;
2498                                                 convert_container!("Vec", 1, || tyref.iter().map(|t| generics.resolve_type(*t)));
2499                                                 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2500                                         }
2501                                 } else if let syn::Type::Reference(ty) = &*s.elem {
2502                                         let tyref = if from_ownable_ref || !to_c { [&*ty.elem] } else { [&*s.elem] };
2503                                         is_ref = true;
2504                                         convert_container!("Slice", 1, || tyref.iter().map(|t| generics.resolve_type(*t)));
2505                                         unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2506                                 } else if let syn::Type::Tuple(t) = &*s.elem {
2507                                         // When mapping into a temporary new var, we need to own all the underlying objects.
2508                                         // Thus, we drop any references inside the tuple and convert with non-reference types.
2509                                         let mut elems = syn::punctuated::Punctuated::new();
2510                                         for elem in t.elems.iter() {
2511                                                 if let syn::Type::Reference(r) = elem {
2512                                                         elems.push((*r.elem).clone());
2513                                                 } else {
2514                                                         elems.push(elem.clone());
2515                                                 }
2516                                         }
2517                                         let ty = [syn::Type::Tuple(syn::TypeTuple {
2518                                                 paren_token: t.paren_token, elems
2519                                         })];
2520                                         is_ref = false;
2521                                         ptr_for_ref = true;
2522                                         convert_container!("Slice", 1, || ty.iter());
2523                                         unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2524                                 } else if let syn::Type::Array(_) = &*s.elem {
2525                                         is_ref = false;
2526                                         ptr_for_ref = true;
2527                                         let arr_elem = [(*s.elem).clone()];
2528                                         convert_container!("Slice", 1, || arr_elem.iter());
2529                                         unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2530                                 } else { unimplemented!() }
2531                         },
2532                         syn::Type::Tuple(t) => {
2533                                 if !t.elems.is_empty() {
2534                                         // We don't (yet) support tuple elements which cannot be converted inline
2535                                         write!(w, "let (").unwrap();
2536                                         for idx in 0..t.elems.len() {
2537                                                 if idx != 0 { write!(w, ", ").unwrap(); }
2538                                                 write!(w, "{} orig_{}_{}", if is_ref { "ref" } else { "mut" }, ident, idx).unwrap();
2539                                         }
2540                                         write!(w, ") = {}{}; ", var, if !to_c { ".to_rust()" } else { "" }).unwrap();
2541                                         // Like other template types, tuples are always mapped as their non-ref
2542                                         // versions for types which have different ref mappings. Thus, we convert to
2543                                         // non-ref versions and handle opaque types with inner pointers manually.
2544                                         for (idx, elem) in t.elems.iter().enumerate() {
2545                                                 if let syn::Type::Path(p) = elem {
2546                                                         let v_name = format!("orig_{}_{}", ident, idx);
2547                                                         let tuple_elem_ident = format_ident!("{}", &v_name);
2548                                                         if self.write_conversion_new_var_intern(w, &tuple_elem_ident, &v_name, elem, generics,
2549                                                                         false, ptr_for_ref, to_c, from_ownable_ref,
2550                                                                         path_lookup, container_lookup, var_prefix, var_suffix) {
2551                                                                 write!(w, " ").unwrap();
2552                                                                 // Opaque types with inner pointers shouldn't ever create new stack
2553                                                                 // variables, so we don't handle it and just assert that it doesn't
2554                                                                 // here.
2555                                                                 assert!(!self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)));
2556                                                         }
2557                                                 }
2558                                         }
2559                                         write!(w, "let mut local_{} = (", ident).unwrap();
2560                                         for (idx, elem) in t.elems.iter().enumerate() {
2561                                                 let real_elem = generics.resolve_type(&elem);
2562                                                 let ty_has_inner = {
2563                                                                 if to_c {
2564                                                                         // "To C ptr_for_ref" means "return the regular object with
2565                                                                         // is_owned set to false", which is totally what we want
2566                                                                         // if we're about to set ty_has_inner.
2567                                                                         ptr_for_ref = true;
2568                                                                 }
2569                                                                 if let syn::Type::Reference(t) = real_elem {
2570                                                                         if let syn::Type::Path(p) = &*t.elem {
2571                                                                                 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
2572                                                                         } else { false }
2573                                                                 } else if let syn::Type::Path(p) = real_elem {
2574                                                                         self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
2575                                                                 } else { false }
2576                                                         };
2577                                                 if idx != 0 { write!(w, ", ").unwrap(); }
2578                                                 var_prefix(w, real_elem, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2579                                                 if is_ref && ty_has_inner {
2580                                                         // For ty_has_inner, the regular var_prefix mapping will take a
2581                                                         // reference, so deref once here to make sure we keep the original ref.
2582                                                         write!(w, "*").unwrap();
2583                                                 }
2584                                                 write!(w, "orig_{}_{}", ident, idx).unwrap();
2585                                                 if is_ref && !ty_has_inner {
2586                                                         // If we don't have an inner variable's reference to maintain, just
2587                                                         // hope the type is Clonable and use that.
2588                                                         write!(w, ".clone()").unwrap();
2589                                                 }
2590                                                 var_suffix(w, real_elem, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2591                                         }
2592                                         write!(w, "){};", if to_c { ".into()" } else { "" }).unwrap();
2593                                         true
2594                                 } else { false }
2595                         },
2596                         _ => unimplemented!(),
2597                 }
2598         }
2599
2600         pub fn write_to_c_conversion_new_var_inner<W: std::io::Write>(&self, w: &mut W, ident: &syn::Ident, var_access: &str, t: &syn::Type, generics: Option<&GenericTypes>, ptr_for_ref: bool, from_ownable_ref: bool) -> bool {
2601                 self.write_conversion_new_var_intern(w, ident, var_access, t, generics, from_ownable_ref, ptr_for_ref, true, from_ownable_ref,
2602                         &|a, b| self.to_c_conversion_new_var_from_path(a, b),
2603                         &|a, b, c, d, e| self.to_c_conversion_container_new_var(generics, a, b, c, d, e),
2604                         // We force ptr_for_ref here since we can't generate a ref on one line and use it later
2605                         &|a, b, c, d, e, f| self.write_to_c_conversion_inline_prefix_inner(a, b, c, d, e, f),
2606                         &|a, b, c, d, e, f| self.write_to_c_conversion_inline_suffix_inner(a, b, c, d, e, f))
2607         }
2608         pub fn write_to_c_conversion_new_var<W: std::io::Write>(&self, w: &mut W, ident: &syn::Ident, t: &syn::Type, generics: Option<&GenericTypes>, ptr_for_ref: bool) -> bool {
2609                 self.write_to_c_conversion_new_var_inner(w, ident, &format!("{}", ident), t, generics, ptr_for_ref, false)
2610         }
2611         /// Prints new-var conversion for an "ownable_ref" type, ie prints conversion for
2612         /// `create_ownable_reference(t)`, not `t` itself.
2613         pub fn write_to_c_conversion_from_ownable_ref_new_var<W: std::io::Write>(&self, w: &mut W, ident: &syn::Ident, t: &syn::Type, generics: Option<&GenericTypes>) -> bool {
2614                 self.write_to_c_conversion_new_var_inner(w, ident, &format!("{}", ident), t, generics, true, true)
2615         }
2616         pub fn write_from_c_conversion_new_var<W: std::io::Write>(&self, w: &mut W, ident: &syn::Ident, t: &syn::Type, generics: Option<&GenericTypes>) -> bool {
2617                 self.write_conversion_new_var_intern(w, ident, &format!("{}", ident), t, generics, false, false, false, false,
2618                         &|a, b| self.from_c_conversion_new_var_from_path(a, b),
2619                         &|a, b, c, d, e| self.from_c_conversion_container_new_var(generics, a, b, c, d, e),
2620                         // We force ptr_for_ref here since we can't generate a ref on one line and use it later
2621                         &|a, b, c, d, e, _f| self.write_from_c_conversion_prefix_inner(a, b, c, d, e),
2622                         &|a, b, c, d, e, _f| self.write_from_c_conversion_suffix_inner(a, b, c, d, e))
2623         }
2624
2625         // ******************************************************
2626         // *** C Container Type Equivalent and alias Printing ***
2627         // ******************************************************
2628
2629         fn write_template_generics<'b, W: std::io::Write>(&self, w: &mut W, args: &mut dyn Iterator<Item=&'b syn::Type>, generics: Option<&GenericTypes>, is_ref: bool) -> bool {
2630                 for (idx, orig_t) in args.enumerate() {
2631                         if idx != 0 {
2632                                 write!(w, ", ").unwrap();
2633                         }
2634                         let t = generics.resolve_type(orig_t);
2635                         if let syn::Type::Reference(r_arg) = t {
2636                                 assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
2637
2638                                 if !self.write_c_type_intern(w, &*r_arg.elem, generics, false, false, false, true, true) { return false; }
2639
2640                                 // While write_c_type_intern, above is correct, we don't want to blindly convert a
2641                                 // reference to something stupid, so check that the container is either opaque or a
2642                                 // predefined type (currently only Transaction).
2643                                 if let syn::Type::Path(p_arg) = &*r_arg.elem {
2644                                         let resolved = self.resolve_path(&p_arg.path, generics);
2645                                         assert!(self.crate_types.opaques.get(&resolved).is_some() ||
2646                                                         self.crate_types.traits.get(&resolved).is_some() ||
2647                                                         self.c_type_from_path(&resolved, true, true).is_some(), "Template generics should be opaque or have a predefined mapping");
2648                                 } else { unimplemented!(); }
2649                         } else if let syn::Type::Path(p_arg) = t {
2650                                 if let Some(resolved) = self.maybe_resolve_path(&p_arg.path, generics) {
2651                                         if !self.is_primitive(&resolved) {
2652                                                 assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
2653                                         }
2654                                 } else {
2655                                         assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
2656                                 }
2657                                 if !self.write_c_type_intern(w, t, generics, false, false, false, true, true) { return false; }
2658                         } else {
2659                                 // We don't currently support outer reference types for non-primitive inners,
2660                                 // except for the empty tuple.
2661                                 if let syn::Type::Tuple(t_arg) = t {
2662                                         assert!(t_arg.elems.len() == 0 || !is_ref);
2663                                 } else {
2664                                         assert!(!is_ref);
2665                                 }
2666                                 if !self.write_c_type_intern(w, t, generics, false, false, false, true, true) { return false; }
2667                         }
2668                 }
2669                 true
2670         }
2671         fn check_create_container(&self, mangled_container: String, container_type: &str, args: Vec<&syn::Type>, generics: Option<&GenericTypes>, is_ref: bool) -> bool {
2672                 if !self.crate_types.templates_defined.borrow().get(&mangled_container).is_some() {
2673                         let mut created_container: Vec<u8> = Vec::new();
2674
2675                         if container_type == "Result" {
2676                                 let mut a_ty: Vec<u8> = Vec::new();
2677                                 if let syn::Type::Tuple(tup) = args.iter().next().unwrap() {
2678                                         if tup.elems.is_empty() {
2679                                                 write!(&mut a_ty, "()").unwrap();
2680                                         } else {
2681                                                 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t).take(1), generics, is_ref) { return false; }
2682                                         }
2683                                 } else {
2684                                         if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t).take(1), generics, is_ref) { return false; }
2685                                 }
2686
2687                                 let mut b_ty: Vec<u8> = Vec::new();
2688                                 if let syn::Type::Tuple(tup) = args.iter().skip(1).next().unwrap() {
2689                                         if tup.elems.is_empty() {
2690                                                 write!(&mut b_ty, "()").unwrap();
2691                                         } else {
2692                                                 if !self.write_template_generics(&mut b_ty, &mut args.iter().map(|t| *t).skip(1), generics, is_ref) { return false; }
2693                                         }
2694                                 } else {
2695                                         if !self.write_template_generics(&mut b_ty, &mut args.iter().map(|t| *t).skip(1), generics, is_ref) { return false; }
2696                                 }
2697
2698                                 let ok_str = String::from_utf8(a_ty).unwrap();
2699                                 let err_str = String::from_utf8(b_ty).unwrap();
2700                                 let is_clonable = self.is_clonable(&ok_str) && self.is_clonable(&err_str);
2701                                 write_result_block(&mut created_container, &mangled_container, &ok_str, &err_str, is_clonable);
2702                                 if is_clonable {
2703                                         self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2704                                 }
2705                         } else if container_type == "Vec" {
2706                                 let mut a_ty: Vec<u8> = Vec::new();
2707                                 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t), generics, is_ref) { return false; }
2708                                 let ty = String::from_utf8(a_ty).unwrap();
2709                                 let is_clonable = self.is_clonable(&ty);
2710                                 write_vec_block(&mut created_container, &mangled_container, &ty, is_clonable);
2711                                 if is_clonable {
2712                                         self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2713                                 }
2714                         } else if container_type.ends_with("Tuple") {
2715                                 let mut tuple_args = Vec::new();
2716                                 let mut is_clonable = true;
2717                                 for arg in args.iter() {
2718                                         let mut ty: Vec<u8> = Vec::new();
2719                                         if !self.write_template_generics(&mut ty, &mut [arg].iter().map(|t| **t), generics, is_ref) { return false; }
2720                                         let ty_str = String::from_utf8(ty).unwrap();
2721                                         if !self.is_clonable(&ty_str) {
2722                                                 is_clonable = false;
2723                                         }
2724                                         tuple_args.push(ty_str);
2725                                 }
2726                                 write_tuple_block(&mut created_container, &mangled_container, &tuple_args, is_clonable);
2727                                 if is_clonable {
2728                                         self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2729                                 }
2730                         } else if container_type == "Option" {
2731                                 let mut a_ty: Vec<u8> = Vec::new();
2732                                 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t), generics, is_ref) { return false; }
2733                                 let ty = String::from_utf8(a_ty).unwrap();
2734                                 let is_clonable = self.is_clonable(&ty);
2735                                 write_option_block(&mut created_container, &mangled_container, &ty, is_clonable);
2736                                 if is_clonable {
2737                                         self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2738                                 }
2739                         } else {
2740                                 unreachable!();
2741                         }
2742                         self.crate_types.write_new_template(mangled_container.clone(), true, &created_container);
2743                 }
2744                 true
2745         }
2746         fn path_to_generic_args(path: &syn::Path) -> Vec<&syn::Type> {
2747                 if let syn::PathArguments::AngleBracketed(args) = &path.segments.iter().next().unwrap().arguments {
2748                         args.args.iter().map(|gen| if let syn::GenericArgument::Type(t) = gen { t } else { unimplemented!() }).collect()
2749                 } else { unimplemented!(); }
2750         }
2751         fn write_c_mangled_container_path_intern<W: std::io::Write>
2752                         (&self, w: &mut W, args: Vec<&syn::Type>, generics: Option<&GenericTypes>, ident: &str, is_ref: bool, is_mut: bool, ptr_for_ref: bool, in_type: bool) -> bool {
2753                 let mut mangled_type: Vec<u8> = Vec::new();
2754                 if !self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) {
2755                         write!(w, "C{}_", ident).unwrap();
2756                         write!(mangled_type, "C{}_", ident).unwrap();
2757                 } else { assert_eq!(args.len(), 1); }
2758                 for arg in args.iter() {
2759                         macro_rules! write_path {
2760                                 ($p_arg: expr, $extra_write: expr) => {
2761                                         if let Some(subtype) = self.maybe_resolve_path(&$p_arg.path, generics) {
2762                                                 if self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) {
2763                                                         if !in_type {
2764                                                                 if self.c_type_has_inner_from_path(&subtype) {
2765                                                                         if !self.write_c_path_intern(w, &$p_arg.path, generics, is_ref, is_mut, ptr_for_ref, false, true) { return false; }
2766                                                                 } else {
2767                                                                         if let Some(arr_ty) = self.is_real_type_array(&subtype) {
2768                                                                                 if !self.write_c_type_intern(w, &arr_ty, generics, false, true, false, false, true) { return false; }
2769                                                                         } else {
2770                                                                                 // Option<T> needs to be converted to a *mut T, ie mut ptr-for-ref
2771                                                                                 if !self.write_c_path_intern(w, &$p_arg.path, generics, true, true, true, false, true) { return false; }
2772                                                                         }
2773                                                                 }
2774                                                         } else {
2775                                                                 write!(w, "{}", $p_arg.path.segments.last().unwrap().ident).unwrap();
2776                                                         }
2777                                                 } else if self.is_known_container(&subtype, is_ref) || self.is_path_transparent_container(&$p_arg.path, generics, is_ref) {
2778                                                         if !self.write_c_mangled_container_path_intern(w, Self::path_to_generic_args(&$p_arg.path), generics,
2779                                                                         &subtype, is_ref, is_mut, ptr_for_ref, true) {
2780                                                                 return false;
2781                                                         }
2782                                                         self.write_c_mangled_container_path_intern(&mut mangled_type, Self::path_to_generic_args(&$p_arg.path),
2783                                                                 generics, &subtype, is_ref, is_mut, ptr_for_ref, true);
2784                                                         if let Some(w2) = $extra_write as Option<&mut Vec<u8>> {
2785                                                                 self.write_c_mangled_container_path_intern(w2, Self::path_to_generic_args(&$p_arg.path),
2786                                                                         generics, &subtype, is_ref, is_mut, ptr_for_ref, true);
2787                                                         }
2788                                                 } else {
2789                                                         let id = subtype.rsplitn(2, ':').next().unwrap(); // Get the "Base" name of the resolved type
2790                                                         write!(w, "{}", id).unwrap();
2791                                                         write!(mangled_type, "{}", id).unwrap();
2792                                                         if let Some(w2) = $extra_write as Option<&mut Vec<u8>> {
2793                                                                 write!(w2, "{}", id).unwrap();
2794                                                         }
2795                                                 }
2796                                         } else { return false; }
2797                                 }
2798                         }
2799                         match generics.resolve_type(arg) {
2800                                 syn::Type::Tuple(tuple) => {
2801                                         if tuple.elems.len() == 0 {
2802                                                 write!(w, "None").unwrap();
2803                                                 write!(mangled_type, "None").unwrap();
2804                                         } else {
2805                                                 let mut mangled_tuple_type: Vec<u8> = Vec::new();
2806
2807                                                 // Figure out what the mangled type should look like. To disambiguate
2808                                                 // ((A, B), C) and (A, B, C) we prefix the generic args with a _ and suffix
2809                                                 // them with a Z. Ideally we wouldn't use Z, but not many special chars are
2810                                                 // available for use in type names.
2811                                                 write!(w, "C{}Tuple_", tuple.elems.len()).unwrap();
2812                                                 write!(mangled_type, "C{}Tuple_", tuple.elems.len()).unwrap();
2813                                                 write!(mangled_tuple_type, "C{}Tuple_", tuple.elems.len()).unwrap();
2814                                                 for elem in tuple.elems.iter() {
2815                                                         if let syn::Type::Path(p) = elem {
2816                                                                 write_path!(p, Some(&mut mangled_tuple_type));
2817                                                         } else if let syn::Type::Reference(refelem) = elem {
2818                                                                 if let syn::Type::Path(p) = &*refelem.elem {
2819                                                                         write_path!(p, Some(&mut mangled_tuple_type));
2820                                                                 } else { return false; }
2821                                                         } else if let syn::Type::Array(_) = elem {
2822                                                                 let mut resolved = Vec::new();
2823                                                                 if !self.write_c_type_intern(&mut resolved, &elem, generics, false, false, true, false, true) { return false; }
2824                                                                 let array_inner = String::from_utf8(resolved).unwrap();
2825                                                                 let arr_name = array_inner.split("::").last().unwrap();
2826                                                                 write!(w, "{}", arr_name).unwrap();
2827                                                                 write!(mangled_type, "{}", arr_name).unwrap();
2828                                                         } else { return false; }
2829                                                 }
2830                                                 write!(w, "Z").unwrap();
2831                                                 write!(mangled_type, "Z").unwrap();
2832                                                 write!(mangled_tuple_type, "Z").unwrap();
2833                                                 if !self.check_create_container(String::from_utf8(mangled_tuple_type).unwrap(),
2834                                                                 &format!("{}Tuple", tuple.elems.len()), tuple.elems.iter().collect(), generics, is_ref) {
2835                                                         return false;
2836                                                 }
2837                                         }
2838                                 },
2839                                 syn::Type::Path(p_arg) => {
2840                                         write_path!(p_arg, None);
2841                                 },
2842                                 syn::Type::Reference(refty) => {
2843                                         if let syn::Type::Path(p_arg) = &*refty.elem {
2844                                                 write_path!(p_arg, None);
2845                                         } else if let syn::Type::Slice(_) = &*refty.elem {
2846                                                 // write_c_type will actually do exactly what we want here, we just need to
2847                                                 // make it a pointer so that its an option. Note that we cannot always convert
2848                                                 // the Vec-as-slice (ie non-ref types) containers, so sometimes need to be able
2849                                                 // to edit it, hence we use *mut here instead of *const.
2850                                                 if args.len() != 1 { return false; }
2851                                                 write!(w, "*mut ").unwrap();
2852                                                 self.write_c_type(w, arg, None, true);
2853                                         } else { return false; }
2854                                 },
2855                                 syn::Type::Array(a) => {
2856                                         if let syn::Type::Path(p_arg) = &*a.elem {
2857                                                 let resolved = self.resolve_path(&p_arg.path, generics);
2858                                                 if !self.is_primitive(&resolved) { return false; }
2859                                                 if let syn::Expr::Lit(syn::ExprLit { lit: syn::Lit::Int(len), .. }) = &a.len {
2860                                                         if self.c_type_from_path(&format!("[{}; {}]", resolved, len.base10_digits()), is_ref, ptr_for_ref).is_none() { return false; }
2861                                                         if in_type || args.len() != 1 {
2862                                                                 write!(w, "_{}{}", resolved, len.base10_digits()).unwrap();
2863                                                                 write!(mangled_type, "_{}{}", resolved, len.base10_digits()).unwrap();
2864                                                         } else {
2865                                                                 let arrty = format!("[{}; {}]", resolved, len.base10_digits());
2866                                                                 let realty = self.c_type_from_path(&arrty, is_ref, ptr_for_ref).unwrap_or(&arrty);
2867                                                                 write!(w, "{}", realty).unwrap();
2868                                                                 write!(mangled_type, "{}", realty).unwrap();
2869                                                         }
2870                                                 } else { return false; }
2871                                         } else { return false; }
2872                                 },
2873                                 _ => { return false; },
2874                         }
2875                 }
2876                 if self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) { return true; }
2877                 // Push the "end of type" Z
2878                 write!(w, "Z").unwrap();
2879                 write!(mangled_type, "Z").unwrap();
2880
2881                 // Make sure the type is actually defined:
2882                 self.check_create_container(String::from_utf8(mangled_type).unwrap(), ident, args, generics, is_ref)
2883         }
2884         fn write_c_mangled_container_path<W: std::io::Write>(&self, w: &mut W, args: Vec<&syn::Type>, generics: Option<&GenericTypes>, ident: &str, is_ref: bool, is_mut: bool, ptr_for_ref: bool) -> bool {
2885                 if !self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) {
2886                         write!(w, "{}::", Self::generated_container_path()).unwrap();
2887                 }
2888                 self.write_c_mangled_container_path_intern(w, args, generics, ident, is_ref, is_mut, ptr_for_ref, false)
2889         }
2890         pub fn get_c_mangled_container_type(&self, args: Vec<&syn::Type>, generics: Option<&GenericTypes>, template_name: &str) -> Option<String> {
2891                 let mut out = Vec::new();
2892                 if !self.write_c_mangled_container_path(&mut out, args, generics, template_name, false, false, false) {
2893                         return None;
2894                 }
2895                 Some(String::from_utf8(out).unwrap())
2896         }
2897
2898         // **********************************
2899         // *** C Type Equivalent Printing ***
2900         // **********************************
2901
2902         fn write_c_path_intern<W: std::io::Write>(&self, w: &mut W, path: &syn::Path, generics: Option<&GenericTypes>, is_ref: bool, is_mut: bool, ptr_for_ref: bool, with_ref_lifetime: bool, c_ty: bool) -> bool {
2903                 let full_path = match self.maybe_resolve_path(&path, generics) {
2904                         Some(path) => path, None => return false };
2905                 if let Some(c_type) = self.c_type_from_path(&full_path, is_ref, ptr_for_ref) {
2906                         write!(w, "{}", c_type).unwrap();
2907                         true
2908                 } else if self.crate_types.traits.get(&full_path).is_some() {
2909                         // Note that we always use the crate:: prefix here as we are always referring to a
2910                         // concrete object which is of the generated type, it just implements the upstream
2911                         // type.
2912                         if is_ref && ptr_for_ref {
2913                                 write!(w, "*{} crate::{}", if is_mut { "mut" } else { "const" }, full_path).unwrap();
2914                         } else if is_ref {
2915                                 if with_ref_lifetime { unimplemented!(); }
2916                                 write!(w, "&{}crate::{}", if is_mut { "mut " } else { "" }, full_path).unwrap();
2917                         } else {
2918                                 write!(w, "crate::{}", full_path).unwrap();
2919                         }
2920                         true
2921                 } else if self.crate_types.opaques.get(&full_path).is_some() || self.crate_types.mirrored_enums.get(&full_path).is_some() {
2922                         let crate_pfx = if c_ty { "crate::" } else { "" };
2923                         if is_ref && ptr_for_ref {
2924                                 // ptr_for_ref implies we're returning the object, which we can't really do for
2925                                 // opaque or mirrored types without box'ing them, which is quite a waste, so return
2926                                 // the actual object itself (for opaque types we'll set the pointer to the actual
2927                                 // type and note that its a reference).
2928                                 write!(w, "{}{}", crate_pfx, full_path).unwrap();
2929                         } else if is_ref && with_ref_lifetime {
2930                                 assert!(!is_mut);
2931                                 // If we're concretizing something with a lifetime parameter, we have to pick a
2932                                 // lifetime, of which the only real available choice is `static`, obviously.
2933                                 write!(w, "&'static {}", crate_pfx).unwrap();
2934                                 if !c_ty {
2935                                         self.write_rust_path(w, generics, path, with_ref_lifetime, false);
2936                                 } else {
2937                                         // We shouldn't be mapping references in types, so panic here
2938                                         unimplemented!();
2939                                 }
2940                         } else if is_ref {
2941                                 write!(w, "&{}{}{}", if is_mut { "mut " } else { "" }, crate_pfx, full_path).unwrap();
2942                         } else {
2943                                 write!(w, "{}{}", crate_pfx, full_path).unwrap();
2944                         }
2945                         true
2946                 } else {
2947                         false
2948                 }
2949         }
2950         fn write_c_type_intern<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, is_ref: bool, is_mut: bool, ptr_for_ref: bool, with_ref_lifetime: bool, c_ty: bool) -> bool {
2951                 match generics.resolve_type(t) {
2952                         syn::Type::Path(p) => {
2953                                 if p.qself.is_some() {
2954                                         return false;
2955                                 }
2956                                 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
2957                                         if self.is_known_container(&full_path, is_ref) || self.is_path_transparent_container(&p.path, generics, is_ref) {
2958                                                 return self.write_c_mangled_container_path(w, Self::path_to_generic_args(&p.path), generics, &full_path, is_ref, is_mut, ptr_for_ref);
2959                                         }
2960                                         if let Some(aliased_type) = self.crate_types.type_aliases.get(&full_path).cloned() {
2961                                                 return self.write_c_type_intern(w, &aliased_type, None, is_ref, is_mut, ptr_for_ref, with_ref_lifetime, c_ty);
2962                                         }
2963                                 }
2964                                 self.write_c_path_intern(w, &p.path, generics, is_ref, is_mut, ptr_for_ref, with_ref_lifetime, c_ty)
2965                         },
2966                         syn::Type::Reference(r) => {
2967                                 self.write_c_type_intern(w, &*r.elem, generics, true, r.mutability.is_some(), ptr_for_ref, with_ref_lifetime, c_ty)
2968                         },
2969                         syn::Type::Array(a) => {
2970                                 if is_ref && is_mut {
2971                                         write!(w, "*mut [").unwrap();
2972                                         if !self.write_c_type_intern(w, &a.elem, generics, false, false, ptr_for_ref, with_ref_lifetime, c_ty) { return false; }
2973                                 } else if is_ref {
2974                                         write!(w, "*const [").unwrap();
2975                                         if !self.write_c_type_intern(w, &a.elem, generics, false, false, ptr_for_ref, with_ref_lifetime, c_ty) { return false; }
2976                                 }
2977                                 if let syn::Expr::Lit(l) = &a.len {
2978                                         if let syn::Lit::Int(i) = &l.lit {
2979                                                 let mut inner_ty = Vec::new();
2980                                                 if !self.write_c_type_intern(&mut inner_ty, &*a.elem, generics, false, false, ptr_for_ref, false, c_ty) { return false; }
2981                                                 let inner_ty_str = String::from_utf8(inner_ty).unwrap();
2982                                                 if !is_ref {
2983                                                         if let Some(ty) = self.c_type_from_path(&format!("[{}; {}]", inner_ty_str, i.base10_digits()), false, ptr_for_ref) {
2984                                                                 write!(w, "{}", ty).unwrap();
2985                                                                 true
2986                                                         } else { false }
2987                                                 } else {
2988                                                         write!(w, "; {}]", i).unwrap();
2989                                                         true
2990                                                 }
2991                                         } else { false }
2992                                 } else { false }
2993                         }
2994                         syn::Type::Slice(s) => {
2995                                 if !is_ref || is_mut { return false; }
2996                                 if let syn::Type::Path(p) = &*s.elem {
2997                                         let resolved = self.resolve_path(&p.path, generics);
2998                                         if self.is_primitive(&resolved) {
2999                                                 write!(w, "{}::{}slice", Self::container_templ_path(), resolved).unwrap();
3000                                                 true
3001                                         } else {
3002                                                 let mut inner_c_ty = Vec::new();
3003                                                 assert!(self.write_c_path_intern(&mut inner_c_ty, &p.path, generics, true, false, ptr_for_ref, with_ref_lifetime, c_ty));
3004                                                 let inner_ty_str = String::from_utf8(inner_c_ty).unwrap();
3005                                                 if self.is_clonable(&inner_ty_str) {
3006                                                         let inner_ty_ident = inner_ty_str.rsplitn(2, "::").next().unwrap();
3007                                                         let mangled_container = format!("CVec_{}Z", inner_ty_ident);
3008                                                         write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
3009                                                         self.check_create_container(mangled_container, "Vec", vec![&*s.elem], generics, false)
3010                                                 } else { false }
3011                                         }
3012                                 } else if let syn::Type::Reference(r) = &*s.elem {
3013                                         if let syn::Type::Path(p) = &*r.elem {
3014                                                 // Slices with "real types" inside are mapped as the equivalent non-ref Vec
3015                                                 let resolved = self.resolve_path(&p.path, generics);
3016                                                 let mangled_container = if let Some((ident, _)) = self.crate_types.opaques.get(&resolved) {
3017                                                         format!("CVec_{}Z", ident)
3018                                                 } else if let Some(en) = self.crate_types.mirrored_enums.get(&resolved) {
3019                                                         format!("CVec_{}Z", en.ident)
3020                                                 } else if let Some(id) = p.path.get_ident() {
3021                                                         format!("CVec_{}Z", id)
3022                                                 } else { return false; };
3023                                                 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
3024                                                 self.check_create_container(mangled_container, "Vec", vec![&*r.elem], generics, false)
3025                                         } else if let syn::Type::Slice(sl2) = &*r.elem {
3026                                                 if let syn::Type::Reference(r2) = &*sl2.elem {
3027                                                         if let syn::Type::Path(p) = &*r2.elem {
3028                                                                 // Slices with slices with opaque types (with is_owned flags) are mapped as non-ref Vecs
3029                                                                 let resolved = self.resolve_path(&p.path, generics);
3030                                                                 let mangled_container = if let Some((ident, _)) = self.crate_types.opaques.get(&resolved) {
3031                                                                         format!("CVec_CVec_{}ZZ", ident)
3032                                                                 } else { return false; };
3033                                                                 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
3034                                                                 let inner = &r2.elem;
3035                                                                 let vec_ty: syn::Type = syn::parse_quote!(Vec<#inner>);
3036                                                                 self.check_create_container(mangled_container, "Vec", vec![&vec_ty], generics, false)
3037                                                         } else { false }
3038                                                 } else { false }
3039                                         } else { false }
3040                                 } else if let syn::Type::Tuple(_) = &*s.elem {
3041                                         let mut args = syn::punctuated::Punctuated::<_, syn::token::Comma>::new();
3042                                         args.push(syn::GenericArgument::Type((*s.elem).clone()));
3043                                         let mut segments = syn::punctuated::Punctuated::new();
3044                                         segments.push(parse_quote!(Vec<#args>));
3045                                         self.write_c_type_intern(w, &syn::Type::Path(syn::TypePath { qself: None, path: syn::Path { leading_colon: None, segments } }), generics, false, is_mut, ptr_for_ref, with_ref_lifetime, c_ty)
3046                                 } else if let syn::Type::Array(a) = &*s.elem {
3047                                         if let syn::Expr::Lit(l) = &a.len {
3048                                                 if let syn::Lit::Int(i) = &l.lit {
3049                                                         let mut buf = Vec::new();
3050                                                         self.write_rust_type(&mut buf, generics, &*a.elem, false);
3051                                                         let arr_ty = String::from_utf8(buf).unwrap();
3052
3053                                                         let arr_str = format!("[{}; {}]", arr_ty, i.base10_digits());
3054                                                         let ty = self.c_type_from_path(&arr_str, false, ptr_for_ref).unwrap()
3055                                                                 .rsplitn(2, "::").next().unwrap();
3056
3057                                                         let mangled_container = format!("CVec_{}Z", ty);
3058                                                         write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
3059                                                         self.check_create_container(mangled_container, "Vec", vec![&*s.elem], generics, false)
3060                                                 } else { false }
3061                                         } else { false }
3062                                 } else { false }
3063                         },
3064                         syn::Type::Tuple(t) => {
3065                                 if t.elems.len() == 0 {
3066                                         true
3067                                 } else {
3068                                         self.write_c_mangled_container_path(w, t.elems.iter().collect(), generics,
3069                                                 &format!("{}Tuple", t.elems.len()), is_ref, is_mut, ptr_for_ref)
3070                                 }
3071                         },
3072                         _ => false,
3073                 }
3074         }
3075         pub fn write_c_type<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, ptr_for_ref: bool) {
3076                 assert!(self.write_c_type_intern(w, t, generics, false, false, ptr_for_ref, false, true));
3077         }
3078         pub fn write_c_type_in_generic_param<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, ptr_for_ref: bool) {
3079                 assert!(self.write_c_type_intern(w, t, generics, false, false, ptr_for_ref, true, false));
3080         }
3081         pub fn understood_c_path(&self, p: &syn::Path) -> bool {
3082                 self.write_c_path_intern(&mut std::io::sink(), p, None, false, false, false, false, true)
3083         }
3084         pub fn understood_c_type(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> bool {
3085                 self.write_c_type_intern(&mut std::io::sink(), t, generics, false, false, false, false, true)
3086         }
3087 }