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