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