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