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