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