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

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