_ 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
  19 // The following utils are used purely to build our known types maps - they break down all the
  20 // types we need to resolve to include the given object, and no more.
  21
  22 pub fn first_seg_self<'a>(t: &'a syn::Type) -> Option<impl Iterator<Item=&syn::PathSegment> + 'a> {
  23         match t {
  24                 syn::Type::Path(p) => {
  25                         if p.qself.is_some() || p.path.leading_colon.is_some() {
  26                                 return None;
  27                         }
  28                         let mut segs = p.path.segments.iter();
  29                         let ty = segs.next().unwrap();
  30                         if !ty.arguments.is_empty() { return None; }
  31                         if format!("{}", ty.ident) == "Self" {
  32                                 Some(segs)
  33                         } else { None }
  34                 },
  35                 _ => None,
  36         }
  37 }
  38
  39 pub fn get_single_remaining_path_seg<'a, I: Iterator<Item=&'a syn::PathSegment>>(segs: &mut I) -> Option<&'a syn::Ident> {
  40         if let Some(ty) = segs.next() {
  41                 if !ty.arguments.is_empty() { unimplemented!(); }
  42                 if segs.next().is_some() { return None; }
  43                 Some(&ty.ident)
  44         } else { None }
  45 }
  46
  47 pub fn single_ident_generic_path_to_ident(p: &syn::Path) -> Option<&syn::Ident> {
  48         if p.segments.len() == 1 {
  49                 Some(&p.segments.iter().next().unwrap().ident)
  50         } else { None }
  51 }
  52
  53 pub fn path_matches_nongeneric(p: &syn::Path, exp: &[&str]) -> bool {
  54         if p.segments.len() != exp.len() { return false; }
  55         for (seg, e) in p.segments.iter().zip(exp.iter()) {
  56                 if seg.arguments != syn::PathArguments::None { return false; }
  57                 if &format!("{}", seg.ident) != *e { return false; }
  58         }
  59         true
  60 }
  61
  62 #[derive(Debug, PartialEq)]
  63 pub enum ExportStatus {
  64         Export,
  65         NoExport,
  66         TestOnly,
  67 }
  68 /// Gets the ExportStatus of an object (struct, fn, etc) given its attributes.
  69 pub fn export_status(attrs: &[syn::Attribute]) -> ExportStatus {
  70         for attr in attrs.iter() {
  71                 let tokens_clone = attr.tokens.clone();
  72                 let mut token_iter = tokens_clone.into_iter();
  73                 if let Some(token) = token_iter.next() {
  74                         match token {
  75                                 TokenTree::Punct(c) if c.as_char() == '=' => {
  76                                         // Really not sure where syn gets '=' from here -
  77                                         // it somehow represents '///' or '//!'
  78                                 },
  79                                 TokenTree::Group(g) => {
  80                                         if format!("{}", single_ident_generic_path_to_ident(&attr.path).unwrap()) == "cfg" {
  81                                                 let mut iter = g.stream().into_iter();
  82                                                 if let TokenTree::Ident(i) = iter.next().unwrap() {
  83                                                         if i == "any" {
  84                                                                 // #[cfg(any(test, feature = ""))]
  85                                                                 if let TokenTree::Group(g) = iter.next().unwrap() {
  86                                                                         let mut all_test = true;
  87                                                                         for token in g.stream().into_iter() {
  88                                                                                 if let TokenTree::Ident(i) = token {
  89                                                                                         match format!("{}", i).as_str() {
  90                                                                                                 "test" => {},
  91                                                                                                 "feature" => {},
  92                                                                                                 _ => all_test = false,
  93                                                                                         }
  94                                                                                 } else if let TokenTree::Literal(lit) = token {
  95                                                                                         if format!("{}", lit) != "fuzztarget" {
  96                                                                                                 all_test = false;
  97                                                                                         }
  98                                                                                 }
  99                                                                         }
 100                                                                         if all_test { return ExportStatus::TestOnly; }
 101                                                                 }
 102                                                         } else if i == "test" || i == "feature" {
 103                                                                 // If its cfg(feature(...)) we assume its test-only
 104                                                                 return ExportStatus::TestOnly;
 105                                                         }
 106                                                 }
 107                                         }
 108                                         continue; // eg #[derive()]
 109                                 },
 110                                 _ => unimplemented!(),
 111                         }
 112                 } else { continue; }
 113                 match token_iter.next().unwrap() {
 114                         TokenTree::Literal(lit) => {
 115                                 let line = format!("{}", lit);
 116                                 if line.contains("(C-not exported)") {
 117                                         return ExportStatus::NoExport;
 118                                 }
 119                         },
 120                         _ => unimplemented!(),
 121                 }
 122         }
 123         ExportStatus::Export
 124 }
 125
 126 pub fn assert_simple_bound(bound: &syn::TraitBound) {
 127         if bound.paren_token.is_some() || bound.lifetimes.is_some() { unimplemented!(); }
 128         if let syn::TraitBoundModifier::Maybe(_) = bound.modifier { unimplemented!(); }
 129 }
 130
 131 /// Returns true if the enum will be mapped as an opaue (ie struct with a pointer to the underlying
 132 /// type), otherwise it is mapped into a transparent, C-compatible version of itself.
 133 pub fn is_enum_opaque(e: &syn::ItemEnum) -> bool {
 134         for var in e.variants.iter() {
 135                 if let syn::Fields::Named(fields) = &var.fields {
 136                         for field in fields.named.iter() {
 137                                 match export_status(&field.attrs) {
 138                                         ExportStatus::Export|ExportStatus::TestOnly => {},
 139                                         ExportStatus::NoExport => return true,
 140                                 }
 141                         }
 142                 } else if let syn::Fields::Unnamed(fields) = &var.fields {
 143                         for field in fields.unnamed.iter() {
 144                                 match export_status(&field.attrs) {
 145                                         ExportStatus::Export|ExportStatus::TestOnly => {},
 146                                         ExportStatus::NoExport => return true,
 147                                 }
 148                         }
 149                 }
 150         }
 151         false
 152 }
 153
 154 /// A stack of sets of generic resolutions.
 155 ///
 156 /// This tracks the template parameters for a function, struct, or trait, allowing resolution into
 157 /// a concrete type. By pushing a new context onto the stack, this can track a function's template
 158 /// parameters inside of a generic struct or trait.
 159 ///
 160 /// It maps both direct types as well as Deref<Target = X>, mapping them via the provided
 161 /// TypeResolver's resolve_path function (ie traits map to the concrete jump table, structs to the
 162 /// concrete C container struct, etc).
 163 #[must_use]
 164 pub struct GenericTypes<'a, 'b> {
 165         parent: Option<&'b GenericTypes<'b, 'b>>,
 166         typed_generics: HashMap<&'a syn::Ident, (String, Option<&'a syn::Path>)>,
 167 }
 168 impl<'a, 'p: 'a> GenericTypes<'a, 'p> {
 169         pub fn new() -> Self {
 170                 Self { parent: None, typed_generics: HashMap::new(), }
 171         }
 172
 173         /// push a new context onto the stack, allowing for a new set of generics to be learned which
 174         /// will override any lower contexts, but which will still fall back to resoltion via lower
 175         /// contexts.
 176         pub fn push_ctx<'c>(&'c self) -> GenericTypes<'a, 'c> {
 177                 GenericTypes { parent: Some(self), typed_generics: HashMap::new(), }
 178         }
 179
 180         /// Learn the generics in generics in the current context, given a TypeResolver.
 181         pub fn learn_generics<'b, 'c>(&mut self, generics: &'a syn::Generics, types: &'b TypeResolver<'a, 'c>) -> bool {
 182                 // First learn simple generics...
 183                 for generic in generics.params.iter() {
 184                         match generic {
 185                                 syn::GenericParam::Type(type_param) => {
 186                                         let mut non_lifetimes_processed = false;
 187                                         for bound in type_param.bounds.iter() {
 188                                                 if let syn::TypeParamBound::Trait(trait_bound) = bound {
 189                                                         if let Some(ident) = single_ident_generic_path_to_ident(&trait_bound.path) {
 190                                                                 match &format!("{}", ident) as &str { "Send" => continue, "Sync" => continue, _ => {} }
 191                                                         }
 192                                                         if path_matches_nongeneric(&trait_bound.path, &["core", "clone", "Clone"]) { continue; }
 193
 194                                                         assert_simple_bound(&trait_bound);
 195                                                         if let Some(mut path) = types.maybe_resolve_path(&trait_bound.path, None) {
 196                                                                 if types.skip_path(&path) { continue; }
 197                                                                 if path == "Sized" { continue; }
 198                                                                 if non_lifetimes_processed { return false; }
 199                                                                 non_lifetimes_processed = true;
 200                                                                 let new_ident = if path != "std::ops::Deref" {
 201                                                                         path = "crate::".to_string() + &path;
 202                                                                         Some(&trait_bound.path)
 203                                                                 } else { None };
 204                                                                 self.typed_generics.insert(&type_param.ident, (path, new_ident));
 205                                                         } else { return false; }
 206                                                 }
 207                                         }
 208                                 },
 209                                 _ => {},
 210                         }
 211                 }
 212                 // Then find generics where we are required to pass a Deref<Target=X> and pretend its just X.
 213                 if let Some(wh) = &generics.where_clause {
 214                         for pred in wh.predicates.iter() {
 215                                 if let syn::WherePredicate::Type(t) = pred {
 216                                         if let syn::Type::Path(p) = &t.bounded_ty {
 217                                                 if p.qself.is_some() { return false; }
 218                                                 if p.path.leading_colon.is_some() { return false; }
 219                                                 let mut p_iter = p.path.segments.iter();
 220                                                 if let Some(gen) = self.typed_generics.get_mut(&p_iter.next().unwrap().ident) {
 221                                                         if gen.0 != "std::ops::Deref" { return false; }
 222                                                         if &format!("{}", p_iter.next().unwrap().ident) != "Target" { return false; }
 223
 224                                                         let mut non_lifetimes_processed = false;
 225                                                         for bound in t.bounds.iter() {
 226                                                                 if let syn::TypeParamBound::Trait(trait_bound) = bound {
 227                                                                         if let Some(id) = trait_bound.path.get_ident() {
 228                                                                                 if format!("{}", id) == "Sized" { continue; }
 229                                                                         }
 230                                                                         if non_lifetimes_processed { return false; }
 231                                                                         non_lifetimes_processed = true;
 232                                                                         assert_simple_bound(&trait_bound);
 233                                                                         *gen = ("crate::".to_string() + &types.resolve_path(&trait_bound.path, None),
 234                                                                                 Some(&trait_bound.path));
 235                                                                 }
 236                                                         }
 237                                                 } else { return false; }
 238                                         } else { return false; }
 239                                 }
 240                         }
 241                 }
 242                 for (_, (_, ident)) in self.typed_generics.iter() {
 243                         if ident.is_none() { return false; }
 244                 }
 245                 true
 246         }
 247
 248         /// Learn the associated types from the trait in the current context.
 249         pub fn learn_associated_types<'b, 'c>(&mut self, t: &'a syn::ItemTrait, types: &'b TypeResolver<'a, 'c>) {
 250                 for item in t.items.iter() {
 251                         match item {
 252                                 &syn::TraitItem::Type(ref t) => {
 253                                         if t.default.is_some() || t.generics.lt_token.is_some() { unimplemented!(); }
 254                                         let mut bounds_iter = t.bounds.iter();
 255                                         match bounds_iter.next().unwrap() {
 256                                                 syn::TypeParamBound::Trait(tr) => {
 257                                                         assert_simple_bound(&tr);
 258                                                         if let Some(mut path) = types.maybe_resolve_path(&tr.path, None) {
 259                                                                 if types.skip_path(&path) { continue; }
 260                                                                 // In general we handle Deref<Target=X> as if it were just X (and
 261                                                                 // implement Deref<Target=Self> for relevant types). We don't
 262                                                                 // bother to implement it for associated types, however, so we just
 263                                                                 // ignore such bounds.
 264                                                                 let new_ident = if path != "std::ops::Deref" {
 265                                                                         path = "crate::".to_string() + &path;
 266                                                                         Some(&tr.path)
 267                                                                 } else { None };
 268                                                                 self.typed_generics.insert(&t.ident, (path, new_ident));
 269                                                         } else { unimplemented!(); }
 270                                                 },
 271                                                 _ => unimplemented!(),
 272                                         }
 273                                         if bounds_iter.next().is_some() { unimplemented!(); }
 274                                 },
 275                                 _ => {},
 276                         }
 277                 }
 278         }
 279
 280         /// Attempt to resolve an Ident as a generic parameter and return the full path.
 281         pub fn maybe_resolve_ident<'b>(&'b self, ident: &syn::Ident) -> Option<&'b String> {
 282                 if let Some(res) = self.typed_generics.get(ident).map(|(a, _)| a) {
 283                         return Some(res);
 284                 }
 285                 if let Some(parent) = self.parent {
 286                         parent.maybe_resolve_ident(ident)
 287                 } else {
 288                         None
 289                 }
 290         }
 291         /// Attempt to resolve a Path as a generic parameter and return the full path. as both a string
 292         /// and syn::Path.
 293         pub fn maybe_resolve_path<'b>(&'b self, path: &syn::Path) -> Option<(&'b String, &'a syn::Path)> {
 294                 if let Some(ident) = path.get_ident() {
 295                         if let Some(res) = self.typed_generics.get(ident).map(|(a, b)| (a, b.unwrap())) {
 296                                 return Some(res);
 297                         }
 298                 } else {
 299                         // Associated types are usually specified as "Self::Generic", so we check for that
 300                         // explicitly here.
 301                         let mut it = path.segments.iter();
 302                         if path.segments.len() == 2 && format!("{}", it.next().unwrap().ident) == "Self" {
 303                                 let ident = &it.next().unwrap().ident;
 304                                 if let Some(res) = self.typed_generics.get(ident).map(|(a, b)| (a, b.unwrap())) {
 305                                         return Some(res);
 306                                 }
 307                         }
 308                 }
 309                 if let Some(parent) = self.parent {
 310                         parent.maybe_resolve_path(path)
 311                 } else {
 312                         None
 313                 }
 314         }
 315 }
 316
 317 #[derive(Clone, PartialEq)]
 318 // The type of declaration and the object itself
 319 pub enum DeclType<'a> {
 320         MirroredEnum,
 321         Trait(&'a syn::ItemTrait),
 322         StructImported,
 323         StructIgnored,
 324         EnumIgnored,
 325 }
 326
 327 pub struct ImportResolver<'mod_lifetime, 'crate_lft: 'mod_lifetime> {
 328         crate_name: &'mod_lifetime str,
 329         dependencies: &'mod_lifetime HashSet<syn::Ident>,
 330         module_path: &'mod_lifetime str,
 331         imports: HashMap<syn::Ident, (String, syn::Path)>,
 332         declared: HashMap<syn::Ident, DeclType<'crate_lft>>,
 333         priv_modules: HashSet<syn::Ident>,
 334 }
 335 impl<'mod_lifetime, 'crate_lft: 'mod_lifetime> ImportResolver<'mod_lifetime, 'crate_lft> {
 336         fn process_use_intern(crate_name: &str, dependencies: &HashSet<syn::Ident>, imports: &mut HashMap<syn::Ident, (String, syn::Path)>,
 337                         u: &syn::UseTree, partial_path: &str, mut path: syn::punctuated::Punctuated<syn::PathSegment, syn::token::Colon2>) {
 338
 339                 let new_path;
 340                 macro_rules! push_path {
 341                         ($ident: expr, $path_suffix: expr) => {
 342                                 if partial_path == "" && !dependencies.contains(&$ident) {
 343                                         new_path = format!("{}::{}{}", crate_name, $ident, $path_suffix);
 344                                         path.push(syn::PathSegment { ident: syn::Ident::new(crate_name, Span::call_site()), arguments: syn::PathArguments::None });
 345                                 } else {
 346                                         new_path = format!("{}{}{}", partial_path, $ident, $path_suffix);
 347                                 }
 348                                 path.push(syn::PathSegment { ident: $ident.clone(), arguments: syn::PathArguments::None });
 349                         }
 350                 }
 351                 match u {
 352                         syn::UseTree::Path(p) => {
 353                                 push_path!(p.ident, "::");
 354                                 Self::process_use_intern(crate_name, dependencies, imports, &p.tree, &new_path, path);
 355                         },
 356                         syn::UseTree::Name(n) => {
 357                                 push_path!(n.ident, "");
 358                                 imports.insert(n.ident.clone(), (new_path, syn::Path { leading_colon: Some(syn::Token![::](Span::call_site())), segments: path }));
 359                         },
 360                         syn::UseTree::Group(g) => {
 361                                 for i in g.items.iter() {
 362                                         Self::process_use_intern(crate_name, dependencies, imports, i, partial_path, path.clone());
 363                                 }
 364                         },
 365                         syn::UseTree::Rename(r) => {
 366                                 push_path!(r.ident, "");
 367                                 imports.insert(r.rename.clone(), (new_path, syn::Path { leading_colon: Some(syn::Token![::](Span::call_site())), segments: path }));
 368                         },
 369                         syn::UseTree::Glob(_) => {
 370                                 eprintln!("Ignoring * use for {} - this may result in resolution failures", partial_path);
 371                         },
 372                 }
 373         }
 374
 375         fn process_use(crate_name: &str, dependencies: &HashSet<syn::Ident>, imports: &mut HashMap<syn::Ident, (String, syn::Path)>, u: &syn::ItemUse) {
 376                 if let syn::Visibility::Public(_) = u.vis {
 377                         // We actually only use these for #[cfg(fuzztarget)]
 378                         eprintln!("Ignoring pub(use) tree!");
 379                         return;
 380                 }
 381                 if u.leading_colon.is_some() { eprintln!("Ignoring leading-colon use!"); return; }
 382                 Self::process_use_intern(crate_name, dependencies, imports, &u.tree, "", syn::punctuated::Punctuated::new());
 383         }
 384
 385         fn insert_primitive(imports: &mut HashMap<syn::Ident, (String, syn::Path)>, id: &str) {
 386                 let ident = syn::Ident::new(id, Span::call_site());
 387                 let mut path = syn::punctuated::Punctuated::new();
 388                 path.push(syn::PathSegment { ident: ident.clone(), arguments: syn::PathArguments::None });
 389                 imports.insert(ident, (id.to_owned(), syn::Path { leading_colon: None, segments: path }));
 390         }
 391
 392         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 {
 393                 let mut imports = HashMap::new();
 394                 // Add primitives to the "imports" list:
 395                 Self::insert_primitive(&mut imports, "bool");
 396                 Self::insert_primitive(&mut imports, "u64");
 397                 Self::insert_primitive(&mut imports, "u32");
 398                 Self::insert_primitive(&mut imports, "u16");
 399                 Self::insert_primitive(&mut imports, "u8");
 400                 Self::insert_primitive(&mut imports, "usize");
 401                 Self::insert_primitive(&mut imports, "str");
 402                 Self::insert_primitive(&mut imports, "String");
 403
 404                 // These are here to allow us to print native Rust types in trait fn impls even if we don't
 405                 // have C mappings:
 406                 Self::insert_primitive(&mut imports, "Result");
 407                 Self::insert_primitive(&mut imports, "Vec");
 408                 Self::insert_primitive(&mut imports, "Option");
 409
 410                 let mut declared = HashMap::new();
 411                 let mut priv_modules = HashSet::new();
 412
 413                 for item in contents.iter() {
 414                         match item {
 415                                 syn::Item::Use(u) => Self::process_use(crate_name, dependencies, &mut imports, &u),
 416                                 syn::Item::Struct(s) => {
 417                                         if let syn::Visibility::Public(_) = s.vis {
 418                                                 match export_status(&s.attrs) {
 419                                                         ExportStatus::Export => { declared.insert(s.ident.clone(), DeclType::StructImported); },
 420                                                         ExportStatus::NoExport => { declared.insert(s.ident.clone(), DeclType::StructIgnored); },
 421                                                         ExportStatus::TestOnly => continue,
 422                                                 }
 423                                         }
 424                                 },
 425                                 syn::Item::Type(t) if export_status(&t.attrs) == ExportStatus::Export => {
 426                                         if let syn::Visibility::Public(_) = t.vis {
 427                                                 let mut process_alias = true;
 428                                                 for tok in t.generics.params.iter() {
 429                                                         if let syn::GenericParam::Lifetime(_) = tok {}
 430                                                         else { process_alias = false; }
 431                                                 }
 432                                                 if process_alias {
 433                                                         declared.insert(t.ident.clone(), DeclType::StructImported);
 434                                                 }
 435                                         }
 436                                 },
 437                                 syn::Item::Enum(e) => {
 438                                         if let syn::Visibility::Public(_) = e.vis {
 439                                                 match export_status(&e.attrs) {
 440                                                         ExportStatus::Export if is_enum_opaque(e) => { declared.insert(e.ident.clone(), DeclType::EnumIgnored); },
 441                                                         ExportStatus::Export => { declared.insert(e.ident.clone(), DeclType::MirroredEnum); },
 442                                                         _ => continue,
 443                                                 }
 444                                         }
 445                                 },
 446                                 syn::Item::Trait(t) if export_status(&t.attrs) == ExportStatus::Export => {
 447                                         if let syn::Visibility::Public(_) = t.vis {
 448                                                 declared.insert(t.ident.clone(), DeclType::Trait(t));
 449                                         }
 450                                 },
 451                                 syn::Item::Mod(m) => {
 452                                         priv_modules.insert(m.ident.clone());
 453                                 },
 454                                 _ => {},
 455                         }
 456                 }
 457
 458                 Self { crate_name, dependencies, module_path, imports, declared, priv_modules }
 459         }
 460
 461         pub fn get_declared_type(&self, ident: &syn::Ident) -> Option<&DeclType<'crate_lft>> {
 462                 self.declared.get(ident)
 463         }
 464
 465         pub fn maybe_resolve_declared(&self, id: &syn::Ident) -> Option<&DeclType<'crate_lft>> {
 466                 self.declared.get(id)
 467         }
 468
 469         pub fn maybe_resolve_ident(&self, id: &syn::Ident) -> Option<String> {
 470                 if let Some((imp, _)) = self.imports.get(id) {
 471                         Some(imp.clone())
 472                 } else if self.declared.get(id).is_some() {
 473                         Some(self.module_path.to_string() + "::" + &format!("{}", id))
 474                 } else { None }
 475         }
 476
 477         pub fn maybe_resolve_non_ignored_ident(&self, id: &syn::Ident) -> Option<String> {
 478                 if let Some((imp, _)) = self.imports.get(id) {
 479                         Some(imp.clone())
 480                 } else if let Some(decl_type) = self.declared.get(id) {
 481                         match decl_type {
 482                                 DeclType::StructIgnored => None,
 483                                 _ => Some(self.module_path.to_string() + "::" + &format!("{}", id)),
 484                         }
 485                 } else { None }
 486         }
 487
 488         pub fn maybe_resolve_path(&self, p_arg: &syn::Path, generics: Option<&GenericTypes>) -> Option<String> {
 489                 let p = if let Some(gen_types) = generics {
 490                         if let Some((_, synpath)) = gen_types.maybe_resolve_path(p_arg) {
 491                                 synpath
 492                         } else { p_arg }
 493                 } else { p_arg };
 494
 495                 if p.leading_colon.is_some() {
 496                         let mut res: String = p.segments.iter().enumerate().map(|(idx, seg)| {
 497                                 format!("{}{}", if idx == 0 { "" } else { "::" }, seg.ident)
 498                         }).collect();
 499                         let firstseg = p.segments.iter().next().unwrap();
 500                         if !self.dependencies.contains(&firstseg.ident) {
 501                                 res = self.crate_name.to_owned() + "::" + &res;
 502                         }
 503                         Some(res)
 504                 } else if let Some(id) = p.get_ident() {
 505                         self.maybe_resolve_ident(id)
 506                 } else {
 507                         if p.segments.len() == 1 {
 508                                 let seg = p.segments.iter().next().unwrap();
 509                                 return self.maybe_resolve_ident(&seg.ident);
 510                         }
 511                         let mut seg_iter = p.segments.iter();
 512                         let first_seg = seg_iter.next().unwrap();
 513                         let remaining: String = seg_iter.map(|seg| {
 514                                 format!("::{}", seg.ident)
 515                         }).collect();
 516                         if let Some((imp, _)) = self.imports.get(&first_seg.ident) {
 517                                 if remaining != "" {
 518                                         Some(imp.clone() + &remaining)
 519                                 } else {
 520                                         Some(imp.clone())
 521                                 }
 522                         } else if let Some(_) = self.priv_modules.get(&first_seg.ident) {
 523                                 Some(format!("{}::{}{}", self.module_path, first_seg.ident, remaining))
 524                         } else { None }
 525                 }
 526         }
 527
 528         /// Map all the Paths in a Type into absolute paths given a set of imports (generated via process_use_intern)
 529         pub fn resolve_imported_refs(&self, mut ty: syn::Type) -> syn::Type {
 530                 match &mut ty {
 531                         syn::Type::Path(p) => {
 532 eprintln!("rir {:?}", p);
 533                                 if p.path.segments.len() != 1 { unimplemented!(); }
 534                                 let mut args = p.path.segments[0].arguments.clone();
 535                                 if let syn::PathArguments::AngleBracketed(ref mut generics) = &mut args {
 536                                         for arg in generics.args.iter_mut() {
 537                                                 if let syn::GenericArgument::Type(ref mut t) = arg {
 538                                                         *t = self.resolve_imported_refs(t.clone());
 539                                                 }
 540                                         }
 541                                 }
 542                                 if let Some((_, newpath)) = self.imports.get(single_ident_generic_path_to_ident(&p.path).unwrap()) {
 543                                         p.path = newpath.clone();
 544                                 }
 545                                 p.path.segments[0].arguments = args;
 546                         },
 547                         syn::Type::Reference(r) => {
 548                                 r.elem = Box::new(self.resolve_imported_refs((*r.elem).clone()));
 549                         },
 550                         syn::Type::Slice(s) => {
 551                                 s.elem = Box::new(self.resolve_imported_refs((*s.elem).clone()));
 552                         },
 553                         syn::Type::Tuple(t) => {
 554                                 for e in t.elems.iter_mut() {
 555                                         *e = self.resolve_imported_refs(e.clone());
 556                                 }
 557                         },
 558                         _ => unimplemented!(),
 559                 }
 560                 ty
 561         }
 562 }
 563
 564 // templates_defined is walked to write the C++ header, so if we use the default hashing it get
 565 // reordered on each genbindings run. Instead, we use SipHasher (which defaults to 0-keys) so that
 566 // the sorting is stable across runs. It is deprecated, but the "replacement" doesn't actually
 567 // accomplish the same goals, so we just ignore it.
 568 #[allow(deprecated)]
 569 pub type NonRandomHash = hash::BuildHasherDefault<hash::SipHasher>;
 570
 571 /// A public module
 572 pub struct ASTModule {
 573         pub attrs: Vec<syn::Attribute>,
 574         pub items: Vec<syn::Item>,
 575         pub submods: Vec<String>,
 576 }
 577 /// A struct containing the syn::File AST for each file in the crate.
 578 pub struct FullLibraryAST {
 579         pub modules: HashMap<String, ASTModule, NonRandomHash>,
 580         pub dependencies: HashSet<syn::Ident>,
 581 }
 582 impl FullLibraryAST {
 583         fn load_module(&mut self, module: String, attrs: Vec<syn::Attribute>, mut items: Vec<syn::Item>) {
 584                 let mut non_mod_items = Vec::with_capacity(items.len());
 585                 let mut submods = Vec::with_capacity(items.len());
 586                 for item in items.drain(..) {
 587                         match item {
 588                                 syn::Item::Mod(m) if m.content.is_some() => {
 589                                         if export_status(&m.attrs) == ExportStatus::Export {
 590                                                 if let syn::Visibility::Public(_) = m.vis {
 591                                                         let modident = format!("{}", m.ident);
 592                                                         let modname = if module != "" {
 593                                                                 module.clone() + "::" + &modident
 594                                                         } else {
 595                                                                 modident.clone()
 596                                                         };
 597                                                         self.load_module(modname, m.attrs, m.content.unwrap().1);
 598                                                         submods.push(modident);
 599                                                 } else {
 600                                                         non_mod_items.push(syn::Item::Mod(m));
 601                                                 }
 602                                         }
 603                                 },
 604                                 syn::Item::Mod(_) => panic!("--pretty=expanded output should never have non-body modules"),
 605                                 syn::Item::ExternCrate(c) => {
 606                                         if export_status(&c.attrs) == ExportStatus::Export {
 607                                                 self.dependencies.insert(c.ident);
 608                                         }
 609                                 },
 610                                 _ => { non_mod_items.push(item); }
 611                         }
 612                 }
 613                 self.modules.insert(module, ASTModule { attrs, items: non_mod_items, submods });
 614         }
 615
 616         pub fn load_lib(lib: syn::File) -> Self {
 617                 assert_eq!(export_status(&lib.attrs), ExportStatus::Export);
 618                 let mut res = Self { modules: HashMap::default(), dependencies: HashSet::new() };
 619                 res.load_module("".to_owned(), lib.attrs, lib.items);
 620                 res
 621         }
 622 }
 623
 624 /// Top-level struct tracking everything which has been defined while walking the crate.
 625 pub struct CrateTypes<'a> {
 626         /// This may contain structs or enums, but only when either is mapped as
 627         /// struct X { inner: *mut originalX, .. }
 628         pub opaques: HashMap<String, &'a syn::Ident>,
 629         /// Enums which are mapped as C enums with conversion functions
 630         pub mirrored_enums: HashMap<String, &'a syn::ItemEnum>,
 631         /// Traits which are mapped as a pointer + jump table
 632         pub traits: HashMap<String, &'a syn::ItemTrait>,
 633         /// Aliases from paths to some other Type
 634         pub type_aliases: HashMap<String, syn::Type>,
 635         /// Value is an alias to Key (maybe with some generics)
 636         pub reverse_alias_map: HashMap<String, Vec<(syn::Path, syn::PathArguments)>>,
 637         /// Template continer types defined, map from mangled type name -> whether a destructor fn
 638         /// exists.
 639         ///
 640         /// This is used at the end of processing to make C++ wrapper classes
 641         pub templates_defined: RefCell<HashMap<String, bool, NonRandomHash>>,
 642         /// The output file for any created template container types, written to as we find new
 643         /// template containers which need to be defined.
 644         template_file: RefCell<&'a mut File>,
 645         /// Set of containers which are clonable
 646         clonable_types: RefCell<HashSet<String>>,
 647         /// Key impls Value
 648         pub trait_impls: HashMap<String, Vec<String>>,
 649         /// The full set of modules in the crate(s)
 650         pub lib_ast: &'a FullLibraryAST,
 651 }
 652
 653 impl<'a> CrateTypes<'a> {
 654         pub fn new(template_file: &'a mut File, libast: &'a FullLibraryAST) -> Self {
 655                 CrateTypes {
 656                         opaques: HashMap::new(), mirrored_enums: HashMap::new(), traits: HashMap::new(),
 657                         type_aliases: HashMap::new(), reverse_alias_map: HashMap::new(),
 658                         templates_defined: RefCell::new(HashMap::default()),
 659                         clonable_types: RefCell::new(HashSet::new()), trait_impls: HashMap::new(),
 660                         template_file: RefCell::new(template_file), lib_ast: &libast,
 661                 }
 662         }
 663         pub fn set_clonable(&self, object: String) {
 664                 self.clonable_types.borrow_mut().insert(object);
 665         }
 666         pub fn is_clonable(&self, object: &str) -> bool {
 667                 self.clonable_types.borrow().contains(object)
 668         }
 669         pub fn write_new_template(&self, mangled_container: String, has_destructor: bool, created_container: &[u8]) {
 670                 self.template_file.borrow_mut().write(created_container).unwrap();
 671                 self.templates_defined.borrow_mut().insert(mangled_container, has_destructor);
 672         }
 673 }
 674
 675 /// A struct which tracks resolving rust types into C-mapped equivalents, exists for one specific
 676 /// module but contains a reference to the overall CrateTypes tracking.
 677 pub struct TypeResolver<'mod_lifetime, 'crate_lft: 'mod_lifetime> {
 678         pub module_path: &'mod_lifetime str,
 679         pub crate_types: &'mod_lifetime CrateTypes<'crate_lft>,
 680         types: ImportResolver<'mod_lifetime, 'crate_lft>,
 681 }
 682
 683 /// Returned by write_empty_rust_val_check_suffix to indicate what type of dereferencing needs to
 684 /// happen to get the inner value of a generic.
 685 enum EmptyValExpectedTy {
 686         /// A type which has a flag for being empty (eg an array where we treat all-0s as empty).
 687         NonPointer,
 688         /// A pointer that we want to dereference and move out of.
 689         OwnedPointer,
 690         /// A pointer which we want to convert to a reference.
 691         ReferenceAsPointer,
 692 }
 693
 694 #[derive(PartialEq)]
 695 /// Describes the appropriate place to print a general type-conversion string when converting a
 696 /// container.
 697 enum ContainerPrefixLocation {
 698         /// Prints a general type-conversion string prefix and suffix outside of the
 699         /// container-conversion strings.
 700         OutsideConv,
 701         /// Prints a general type-conversion string prefix and suffix inside of the
 702         /// container-conversion strings.
 703         PerConv,
 704         /// Does not print the usual type-conversion string prefix and suffix.
 705         NoPrefix,
 706 }
 707
 708 impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
 709         pub fn new(module_path: &'a str, types: ImportResolver<'a, 'c>, crate_types: &'a CrateTypes<'c>) -> Self {
 710                 Self { module_path, types, crate_types }
 711         }
 712
 713         // *************************************************
 714         // *** Well know type and conversion definitions ***
 715         // *************************************************
 716
 717         /// Returns true we if can just skip passing this to C entirely
 718         fn skip_path(&self, full_path: &str) -> bool {
 719                 full_path == "bitcoin::secp256k1::Secp256k1" ||
 720                 full_path == "bitcoin::secp256k1::Signing" ||
 721                 full_path == "bitcoin::secp256k1::Verification"
 722         }
 723         /// Returns true we if can just skip passing this to C entirely
 724         fn no_arg_path_to_rust(&self, full_path: &str) -> &str {
 725                 if full_path == "bitcoin::secp256k1::Secp256k1" {
 726                         "secp256k1::SECP256K1"
 727                 } else { unimplemented!(); }
 728         }
 729
 730         /// Returns true if the object is a primitive and is mapped as-is with no conversion
 731         /// whatsoever.
 732         pub fn is_primitive(&self, full_path: &str) -> bool {
 733                 match full_path {
 734                         "bool" => true,
 735                         "u64" => true,
 736                         "u32" => true,
 737                         "u16" => true,
 738                         "u8" => true,
 739                         "usize" => true,
 740                         _ => false,
 741                 }
 742         }
 743         pub fn is_clonable(&self, ty: &str) -> bool {
 744                 if self.crate_types.is_clonable(ty) { return true; }
 745                 if self.is_primitive(ty) { return true; }
 746                 match ty {
 747                         "()" => true,
 748                         "crate::c_types::Signature" => true,
 749                         "crate::c_types::TxOut" => true,
 750                         _ => false,
 751                 }
 752         }
 753         /// Gets the C-mapped type for types which are outside of the crate, or which are manually
 754         /// ignored by for some reason need mapping anyway.
 755         fn c_type_from_path<'b>(&self, full_path: &'b str, is_ref: bool, _ptr_for_ref: bool) -> Option<&'b str> {
 756                 if self.is_primitive(full_path) {
 757                         return Some(full_path);
 758                 }
 759                 match full_path {
 760                         "Result" => Some("crate::c_types::derived::CResult"),
 761                         "Vec" if !is_ref => Some("crate::c_types::derived::CVec"),
 762                         "Option" => Some(""),
 763
 764                         // Note that no !is_ref types can map to an array because Rust and C's call semantics
 765                         // for arrays are different (https://github.com/eqrion/cbindgen/issues/528)
 766
 767                         "[u8; 32]" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
 768                         "[u8; 16]" if !is_ref => Some("crate::c_types::SixteenBytes"),
 769                         "[u8; 10]" if !is_ref => Some("crate::c_types::TenBytes"),
 770                         "[u8; 4]" if !is_ref => Some("crate::c_types::FourBytes"),
 771                         "[u8; 3]" if !is_ref => Some("crate::c_types::ThreeBytes"), // Used for RGB values
 772
 773                         "str" if is_ref => Some("crate::c_types::Str"),
 774                         "String" if !is_ref => Some("crate::c_types::derived::CVec_u8Z"),
 775                         "String" if is_ref => Some("crate::c_types::Str"),
 776
 777                         "std::time::Duration" => Some("u64"),
 778
 779                         "bitcoin::secp256k1::key::PublicKey" => Some("crate::c_types::PublicKey"),
 780                         "bitcoin::secp256k1::Signature" => Some("crate::c_types::Signature"),
 781                         "bitcoin::secp256k1::key::SecretKey" if is_ref  => Some("*const [u8; 32]"),
 782                         "bitcoin::secp256k1::key::SecretKey" if !is_ref => Some("crate::c_types::SecretKey"),
 783                         "bitcoin::secp256k1::Error" if !is_ref => Some("crate::c_types::Secp256k1Error"),
 784                         "bitcoin::blockdata::script::Script" if is_ref => Some("crate::c_types::u8slice"),
 785                         "bitcoin::blockdata::script::Script" if !is_ref => Some("crate::c_types::derived::CVec_u8Z"),
 786                         "bitcoin::blockdata::transaction::OutPoint" => Some("crate::lightning::chain::transaction::OutPoint"),
 787                         "bitcoin::blockdata::transaction::Transaction" => Some("crate::c_types::Transaction"),
 788                         "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some("crate::c_types::TxOut"),
 789                         "bitcoin::network::constants::Network" => Some("crate::bitcoin::network::Network"),
 790                         "bitcoin::blockdata::block::BlockHeader" if is_ref  => Some("*const [u8; 80]"),
 791                         "bitcoin::blockdata::block::Block" if is_ref  => Some("crate::c_types::u8slice"),
 792
 793                         // Newtypes that we just expose in their original form.
 794                         "bitcoin::hash_types::Txid" if is_ref  => Some("*const [u8; 32]"),
 795                         "bitcoin::hash_types::Txid" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
 796                         "bitcoin::hash_types::BlockHash" if is_ref  => Some("*const [u8; 32]"),
 797                         "bitcoin::hash_types::BlockHash" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
 798                         "bitcoin::secp256k1::Message" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
 799                         "lightning::ln::channelmanager::PaymentHash" if is_ref => Some("*const [u8; 32]"),
 800                         "lightning::ln::channelmanager::PaymentHash" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
 801                         "lightning::ln::channelmanager::PaymentPreimage" if is_ref => Some("*const [u8; 32]"),
 802                         "lightning::ln::channelmanager::PaymentPreimage" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
 803                         "lightning::ln::channelmanager::PaymentSecret" if is_ref => Some("crate::c_types::ThirtyTwoBytes"),
 804                         "lightning::ln::channelmanager::PaymentSecret" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
 805
 806                         // Override the default since Records contain an fmt with a lifetime:
 807                         "lightning::util::logger::Record" => Some("*const std::os::raw::c_char"),
 808
 809                         _ => None,
 810                 }
 811         }
 812
 813         fn from_c_conversion_new_var_from_path<'b>(&self, _full_path: &str, _is_ref: bool) -> Option<(&'b str, &'b str)> {
 814                 None
 815         }
 816         fn from_c_conversion_prefix_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<String> {
 817                 if self.is_primitive(full_path) {
 818                         return Some("".to_owned());
 819                 }
 820                 match full_path {
 821                         "Vec" if !is_ref => Some("local_"),
 822                         "Result" if !is_ref => Some("local_"),
 823                         "Option" if is_ref => Some("&local_"),
 824                         "Option" => Some("local_"),
 825
 826                         "[u8; 32]" if is_ref => Some("unsafe { &*"),
 827                         "[u8; 32]" if !is_ref => Some(""),
 828                         "[u8; 16]" if !is_ref => Some(""),
 829                         "[u8; 10]" if !is_ref => Some(""),
 830                         "[u8; 4]" if !is_ref => Some(""),
 831                         "[u8; 3]" if !is_ref => Some(""),
 832
 833                         "[u8]" if is_ref => Some(""),
 834                         "[usize]" if is_ref => Some(""),
 835
 836                         "str" if is_ref => Some(""),
 837                         "String" if !is_ref => Some("String::from_utf8("),
 838                         // Note that we'll panic for String if is_ref, as we only have non-owned memory, we
 839                         // cannot create a &String.
 840
 841                         "std::time::Duration" => Some("std::time::Duration::from_secs("),
 842
 843                         "bitcoin::secp256k1::key::PublicKey" if is_ref => Some("&"),
 844                         "bitcoin::secp256k1::key::PublicKey" => Some(""),
 845                         "bitcoin::secp256k1::Signature" if is_ref => Some("&"),
 846                         "bitcoin::secp256k1::Signature" => Some(""),
 847                         "bitcoin::secp256k1::key::SecretKey" if is_ref => Some("&::bitcoin::secp256k1::key::SecretKey::from_slice(&unsafe { *"),
 848                         "bitcoin::secp256k1::key::SecretKey" if !is_ref => Some(""),
 849                         "bitcoin::blockdata::script::Script" if is_ref => Some("&::bitcoin::blockdata::script::Script::from(Vec::from("),
 850                         "bitcoin::blockdata::script::Script" if !is_ref => Some("::bitcoin::blockdata::script::Script::from("),
 851                         "bitcoin::blockdata::transaction::Transaction" if is_ref => Some("&"),
 852                         "bitcoin::blockdata::transaction::Transaction" => Some(""),
 853                         "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(""),
 854                         "bitcoin::network::constants::Network" => Some(""),
 855                         "bitcoin::blockdata::block::BlockHeader" => Some("&::bitcoin::consensus::encode::deserialize(unsafe { &*"),
 856                         "bitcoin::blockdata::block::Block" if is_ref => Some("&::bitcoin::consensus::encode::deserialize("),
 857
 858                         // Newtypes that we just expose in their original form.
 859                         "bitcoin::hash_types::Txid" if is_ref => Some("&::bitcoin::hash_types::Txid::from_slice(&unsafe { &*"),
 860                         "bitcoin::hash_types::Txid" if !is_ref => Some("::bitcoin::hash_types::Txid::from_slice(&"),
 861                         "bitcoin::hash_types::BlockHash" => Some("::bitcoin::hash_types::BlockHash::from_slice(&"),
 862                         "lightning::ln::channelmanager::PaymentHash" if !is_ref => Some("::lightning::ln::channelmanager::PaymentHash("),
 863                         "lightning::ln::channelmanager::PaymentHash" if is_ref => Some("&::lightning::ln::channelmanager::PaymentHash(unsafe { *"),
 864                         "lightning::ln::channelmanager::PaymentPreimage" if !is_ref => Some("::lightning::ln::channelmanager::PaymentPreimage("),
 865                         "lightning::ln::channelmanager::PaymentPreimage" if is_ref => Some("&::lightning::ln::channelmanager::PaymentPreimage(unsafe { *"),
 866                         "lightning::ln::channelmanager::PaymentSecret" => Some("::lightning::ln::channelmanager::PaymentSecret("),
 867
 868                         // List of traits we map (possibly during processing of other files):
 869                         "crate::util::logger::Logger" => Some(""),
 870
 871                         _ => None,
 872                 }.map(|s| s.to_owned())
 873         }
 874         fn from_c_conversion_suffix_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<String> {
 875                 if self.is_primitive(full_path) {
 876                         return Some("".to_owned());
 877                 }
 878                 match full_path {
 879                         "Vec" if !is_ref => Some(""),
 880                         "Option" => Some(""),
 881                         "Result" if !is_ref => Some(""),
 882
 883                         "[u8; 32]" if is_ref => Some("}"),
 884                         "[u8; 32]" if !is_ref => Some(".data"),
 885                         "[u8; 16]" if !is_ref => Some(".data"),
 886                         "[u8; 10]" if !is_ref => Some(".data"),
 887                         "[u8; 4]" if !is_ref => Some(".data"),
 888                         "[u8; 3]" if !is_ref => Some(".data"),
 889
 890                         "[u8]" if is_ref => Some(".to_slice()"),
 891                         "[usize]" if is_ref => Some(".to_slice()"),
 892
 893                         "str" if is_ref => Some(".into()"),
 894                         "String" if !is_ref => Some(".into_rust()).unwrap()"),
 895
 896                         "std::time::Duration" => Some(")"),
 897
 898                         "bitcoin::secp256k1::key::PublicKey" => Some(".into_rust()"),
 899                         "bitcoin::secp256k1::Signature" => Some(".into_rust()"),
 900                         "bitcoin::secp256k1::key::SecretKey" if !is_ref => Some(".into_rust()"),
 901                         "bitcoin::secp256k1::key::SecretKey" if is_ref => Some("}[..]).unwrap()"),
 902                         "bitcoin::blockdata::script::Script" if is_ref => Some(".to_slice()))"),
 903                         "bitcoin::blockdata::script::Script" if !is_ref => Some(".into_rust())"),
 904                         "bitcoin::blockdata::transaction::Transaction" => Some(".into_bitcoin()"),
 905                         "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(".into_rust()"),
 906                         "bitcoin::network::constants::Network" => Some(".into_bitcoin()"),
 907                         "bitcoin::blockdata::block::BlockHeader" => Some(" }).unwrap()"),
 908                         "bitcoin::blockdata::block::Block" => Some(".to_slice()).unwrap()"),
 909
 910                         // Newtypes that we just expose in their original form.
 911                         "bitcoin::hash_types::Txid" if is_ref => Some(" }[..]).unwrap()"),
 912                         "bitcoin::hash_types::Txid" => Some(".data[..]).unwrap()"),
 913                         "bitcoin::hash_types::BlockHash" if !is_ref => Some(".data[..]).unwrap()"),
 914                         "lightning::ln::channelmanager::PaymentHash" if !is_ref => Some(".data)"),
 915                         "lightning::ln::channelmanager::PaymentHash" if is_ref => Some(" })"),
 916                         "lightning::ln::channelmanager::PaymentPreimage" if !is_ref => Some(".data)"),
 917                         "lightning::ln::channelmanager::PaymentPreimage" if is_ref => Some(" })"),
 918                         "lightning::ln::channelmanager::PaymentSecret" => Some(".data)"),
 919
 920                         // List of traits we map (possibly during processing of other files):
 921                         "crate::util::logger::Logger" => Some(""),
 922
 923                         _ => None,
 924                 }.map(|s| s.to_owned())
 925         }
 926
 927         fn to_c_conversion_new_var_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<(&'b str, &'b str)> {
 928                 if self.is_primitive(full_path) {
 929                         return None;
 930                 }
 931                 match full_path {
 932                         "[u8]" if is_ref => Some(("crate::c_types::u8slice::from_slice(", ")")),
 933                         "[usize]" if is_ref => Some(("crate::c_types::usizeslice::from_slice(", ")")),
 934
 935                         "bitcoin::blockdata::transaction::Transaction" if is_ref => Some(("::bitcoin::consensus::encode::serialize(", ")")),
 936                         "bitcoin::blockdata::transaction::Transaction" if !is_ref => Some(("::bitcoin::consensus::encode::serialize(&", ")")),
 937                         "bitcoin::blockdata::block::BlockHeader" if is_ref => Some(("{ let mut s = [0u8; 80]; s[..].copy_from_slice(&::bitcoin::consensus::encode::serialize(", ")); s }")),
 938                         "bitcoin::blockdata::block::Block" if is_ref => Some(("::bitcoin::consensus::encode::serialize(", ")")),
 939                         "bitcoin::hash_types::Txid" => None,
 940
 941                         // Override the default since Records contain an fmt with a lifetime:
 942                         // TODO: We should include the other record fields
 943                         "lightning::util::logger::Record" => Some(("std::ffi::CString::new(format!(\"{}\", ", ".args)).unwrap()")),
 944                         _ => None,
 945                 }.map(|s| s.to_owned())
 946         }
 947         fn to_c_conversion_inline_prefix_from_path(&self, full_path: &str, is_ref: bool, _ptr_for_ref: bool) -> Option<String> {
 948                 if self.is_primitive(full_path) {
 949                         return Some("".to_owned());
 950                 }
 951                 match full_path {
 952                         "Result" if !is_ref => Some("local_"),
 953                         "Vec" if !is_ref => Some("local_"),
 954                         "Option" => Some("local_"),
 955
 956                         "[u8; 32]" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
 957                         "[u8; 32]" if is_ref => Some("&"),
 958                         "[u8; 16]" if !is_ref => Some("crate::c_types::SixteenBytes { data: "),
 959                         "[u8; 10]" if !is_ref => Some("crate::c_types::TenBytes { data: "),
 960                         "[u8; 4]" if !is_ref => Some("crate::c_types::FourBytes { data: "),
 961                         "[u8; 3]" if is_ref => Some("&"),
 962
 963                         "[u8]" if is_ref => Some("local_"),
 964                         "[usize]" if is_ref => Some("local_"),
 965
 966                         "str" if is_ref => Some(""),
 967                         "String" => Some(""),
 968
 969                         "std::time::Duration" => Some(""),
 970
 971                         "bitcoin::secp256k1::key::PublicKey" => Some("crate::c_types::PublicKey::from_rust(&"),
 972                         "bitcoin::secp256k1::Signature" => Some("crate::c_types::Signature::from_rust(&"),
 973                         "bitcoin::secp256k1::key::SecretKey" if is_ref  => Some(""),
 974                         "bitcoin::secp256k1::key::SecretKey" if !is_ref => Some("crate::c_types::SecretKey::from_rust("),
 975                         "bitcoin::secp256k1::Error" if !is_ref => Some("crate::c_types::Secp256k1Error::from_rust("),
 976                         "bitcoin::blockdata::script::Script" if is_ref => Some("crate::c_types::u8slice::from_slice(&"),
 977                         "bitcoin::blockdata::script::Script" if !is_ref => Some(""),
 978                         "bitcoin::blockdata::transaction::Transaction" => Some("crate::c_types::Transaction::from_vec(local_"),
 979                         "bitcoin::blockdata::transaction::OutPoint" => Some("crate::c_types::bitcoin_to_C_outpoint("),
 980                         "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some("crate::c_types::TxOut::from_rust("),
 981                         "bitcoin::network::constants::Network" => Some("crate::bitcoin::network::Network::from_bitcoin("),
 982                         "bitcoin::blockdata::block::BlockHeader" if is_ref => Some("&local_"),
 983                         "bitcoin::blockdata::block::Block" if is_ref => Some("crate::c_types::u8slice::from_slice(&local_"),
 984
 985                         "bitcoin::hash_types::Txid" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
 986
 987                         // Newtypes that we just expose in their original form.
 988                         "bitcoin::hash_types::Txid" if is_ref => Some(""),
 989                         "bitcoin::hash_types::BlockHash" if is_ref => Some(""),
 990                         "bitcoin::hash_types::BlockHash" => Some("crate::c_types::ThirtyTwoBytes { data: "),
 991                         "bitcoin::secp256k1::Message" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
 992                         "lightning::ln::channelmanager::PaymentHash" if is_ref => Some("&"),
 993                         "lightning::ln::channelmanager::PaymentHash" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
 994                         "lightning::ln::channelmanager::PaymentPreimage" if is_ref => Some("&"),
 995                         "lightning::ln::channelmanager::PaymentPreimage" => Some("crate::c_types::ThirtyTwoBytes { data: "),
 996                         "lightning::ln::channelmanager::PaymentSecret" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
 997
 998                         // Override the default since Records contain an fmt with a lifetime:
 999                         "lightning::util::logger::Record" => Some("local_"),
1000
1001                         _ => None,
1002                 }.map(|s| s.to_owned())
1003         }
1004         fn to_c_conversion_inline_suffix_from_path(&self, full_path: &str, is_ref: bool, _ptr_for_ref: bool) -> Option<String> {
1005                 if self.is_primitive(full_path) {
1006                         return Some("".to_owned());
1007                 }
1008                 match full_path {
1009                         "Result" if !is_ref => Some(""),
1010                         "Vec" if !is_ref => Some(".into()"),
1011                         "Option" => Some(""),
1012
1013                         "[u8; 32]" if !is_ref => Some(" }"),
1014                         "[u8; 32]" if is_ref => Some(""),
1015                         "[u8; 16]" if !is_ref => Some(" }"),
1016                         "[u8; 10]" if !is_ref => Some(" }"),
1017                         "[u8; 4]" if !is_ref => Some(" }"),
1018                         "[u8; 3]" if is_ref => Some(""),
1019
1020                         "[u8]" if is_ref => Some(""),
1021                         "[usize]" if is_ref => Some(""),
1022
1023                         "str" if is_ref => Some(".into()"),
1024                         "String" if !is_ref => Some(".into_bytes().into()"),
1025                         "String" if is_ref => Some(".as_str().into()"),
1026
1027                         "std::time::Duration" => Some(".as_secs()"),
1028
1029                         "bitcoin::secp256k1::key::PublicKey" => Some(")"),
1030                         "bitcoin::secp256k1::Signature" => Some(")"),
1031                         "bitcoin::secp256k1::key::SecretKey" if !is_ref => Some(")"),
1032                         "bitcoin::secp256k1::key::SecretKey" if is_ref => Some(".as_ref()"),
1033                         "bitcoin::secp256k1::Error" if !is_ref => Some(")"),
1034                         "bitcoin::blockdata::script::Script" if is_ref => Some("[..])"),
1035                         "bitcoin::blockdata::script::Script" if !is_ref => Some(".into_bytes().into()"),
1036                         "bitcoin::blockdata::transaction::Transaction" => Some(")"),
1037                         "bitcoin::blockdata::transaction::OutPoint" => Some(")"),
1038                         "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(")"),
1039                         "bitcoin::network::constants::Network" => Some(")"),
1040                         "bitcoin::blockdata::block::BlockHeader" if is_ref => Some(""),
1041                         "bitcoin::blockdata::block::Block" if is_ref => Some(")"),
1042
1043                         "bitcoin::hash_types::Txid" if !is_ref => Some(".into_inner() }"),
1044
1045                         // Newtypes that we just expose in their original form.
1046                         "bitcoin::hash_types::Txid" if is_ref => Some(".as_inner()"),
1047                         "bitcoin::hash_types::BlockHash" if is_ref => Some(".as_inner()"),
1048                         "bitcoin::hash_types::BlockHash" => Some(".into_inner() }"),
1049                         "bitcoin::secp256k1::Message" if !is_ref => Some(".as_ref().clone() }"),
1050                         "lightning::ln::channelmanager::PaymentHash" if is_ref => Some(".0"),
1051                         "lightning::ln::channelmanager::PaymentHash" => Some(".0 }"),
1052                         "lightning::ln::channelmanager::PaymentPreimage" if is_ref => Some(".0"),
1053                         "lightning::ln::channelmanager::PaymentPreimage" => Some(".0 }"),
1054                         "lightning::ln::channelmanager::PaymentSecret" if !is_ref => Some(".0 }"),
1055
1056                         // Override the default since Records contain an fmt with a lifetime:
1057                         "lightning::util::logger::Record" => Some(".as_ptr()"),
1058
1059                         _ => None,
1060                 }.map(|s| s.to_owned())
1061         }
1062
1063         fn empty_val_check_suffix_from_path(&self, full_path: &str) -> Option<&str> {
1064                 match full_path {
1065                         "lightning::ln::channelmanager::PaymentSecret" => Some(".data == [0; 32]"),
1066                         "bitcoin::secp256k1::key::PublicKey" => Some(".is_null()"),
1067                         "bitcoin::secp256k1::Signature" => Some(".is_null()"),
1068                         _ => None
1069                 }
1070         }
1071
1072         // ****************************
1073         // *** Container Processing ***
1074         // ****************************
1075
1076         /// Returns the module path in the generated mapping crate to the containers which we generate
1077         /// when writing to CrateTypes::template_file.
1078         pub fn generated_container_path() -> &'static str {
1079                 "crate::c_types::derived"
1080         }
1081         /// Returns the module path in the generated mapping crate to the container templates, which
1082         /// are then concretized and put in the generated container path/template_file.
1083         fn container_templ_path() -> &'static str {
1084                 "crate::c_types"
1085         }
1086
1087         /// Returns true if the path containing the given args is a "transparent" container, ie an
1088         /// Option or a container which does not require a generated continer class.
1089         fn is_transparent_container<'i, I: Iterator<Item=&'i syn::Type>>(&self, full_path: &str, _is_ref: bool, mut args: I) -> bool {
1090                 if full_path == "Option" {
1091                         let inner = args.next().unwrap();
1092                         assert!(args.next().is_none());
1093                         match inner {
1094                                 syn::Type::Reference(_) => true,
1095                                 syn::Type::Path(p) => {
1096                                         if let Some(resolved) = self.maybe_resolve_path(&p.path, None) {
1097                                                 if self.is_primitive(&resolved) { false } else { true }
1098                                         } else { true }
1099                                 },
1100                                 syn::Type::Tuple(_) => false,
1101                                 _ => unimplemented!(),
1102                         }
1103                 } else { false }
1104         }
1105         /// Returns true if the path is a "transparent" container, ie an Option or a container which does
1106         /// not require a generated continer class.
1107         fn is_path_transparent_container(&self, full_path: &syn::Path, generics: Option<&GenericTypes>, is_ref: bool) -> bool {
1108                 let inner_iter = match &full_path.segments.last().unwrap().arguments {
1109                         syn::PathArguments::None => return false,
1110                         syn::PathArguments::AngleBracketed(args) => args.args.iter().map(|arg| {
1111                                 if let syn::GenericArgument::Type(ref ty) = arg {
1112                                         ty
1113                                 } else { unimplemented!() }
1114                         }),
1115                         syn::PathArguments::Parenthesized(_) => unimplemented!(),
1116                 };
1117                 self.is_transparent_container(&self.resolve_path(full_path, generics), is_ref, inner_iter)
1118         }
1119         /// Returns true if this is a known, supported, non-transparent container.
1120         fn is_known_container(&self, full_path: &str, is_ref: bool) -> bool {
1121                 (full_path == "Result" && !is_ref) || (full_path == "Vec" && !is_ref) || full_path.ends_with("Tuple") || full_path == "Option"
1122         }
1123         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)
1124                         // Returns prefix + Vec<(prefix, var-name-to-inline-convert)> + suffix
1125                         // expecting one element in the vec per generic type, each of which is inline-converted
1126                         -> Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)> {
1127                 match full_path {
1128                         "Result" if !is_ref => {
1129                                 Some(("match ",
1130                                                 vec![(" { Ok(mut o) => crate::c_types::CResultTempl::ok(".to_string(), "o".to_string()),
1131                                                         (").into(), Err(mut e) => crate::c_types::CResultTempl::err(".to_string(), "e".to_string())],
1132                                                 ").into() }", ContainerPrefixLocation::PerConv))
1133                         },
1134                         "Vec" if !is_ref => {
1135                                 Some(("Vec::new(); for mut item in ", vec![(format!(".drain(..) {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1136                         },
1137                         "Slice" => {
1138                                 Some(("Vec::new(); for item in ", vec![(format!(".iter() {{ local_{}.push(", var_name), "**item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1139                         },
1140                         "Option" => {
1141                                 if let Some(syn::Type::Path(p)) = single_contained {
1142                                         let inner_path = self.resolve_path(&p.path, generics);
1143                                         if self.is_primitive(&inner_path) {
1144                                                 return Some(("if ", vec![
1145                                                         (format!(".is_none() {{ {}::COption_{}Z::None }} else {{ ", Self::generated_container_path(), inner_path),
1146                                                          format!("{}::COption_{}Z::Some({}.unwrap())", Self::generated_container_path(), inner_path, var_access))
1147                                                         ], " }", ContainerPrefixLocation::NoPrefix));
1148                                         } else if self.c_type_has_inner_from_path(&inner_path) {
1149                                                 if is_ref {
1150                                                         return Some(("if ", vec![
1151                                                                 (".is_none() { std::ptr::null() } else { ".to_owned(), format!("({}.as_ref().unwrap())", var_access))
1152                                                                 ], " }", ContainerPrefixLocation::OutsideConv));
1153                                                 } else {
1154                                                         return Some(("if ", vec![
1155                                                                 (".is_none() { std::ptr::null_mut() } else { ".to_owned(), format!("({}.unwrap())", var_access))
1156                                                                 ], " }", ContainerPrefixLocation::OutsideConv));
1157                                                 }
1158                                         }
1159                                 }
1160                                 if let Some(t) = single_contained {
1161                                         let mut v = Vec::new();
1162                                         self.write_empty_rust_val(generics, &mut v, t);
1163                                         let s = String::from_utf8(v).unwrap();
1164                                         return Some(("if ", vec![
1165                                                 (format!(".is_none() {{ {} }} else {{ ", s), format!("({}.unwrap())", var_access))
1166                                                 ], " }", ContainerPrefixLocation::PerConv));
1167                                 } else { unreachable!(); }
1168                         },
1169                         _ => None,
1170                 }
1171         }
1172
1173         /// only_contained_has_inner implies that there is only one contained element in the container
1174         /// and it has an inner field (ie is an "opaque" type we've defined).
1175         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)
1176                         // Returns prefix + Vec<(prefix, var-name-to-inline-convert)> + suffix
1177                         // expecting one element in the vec per generic type, each of which is inline-converted
1178                         -> Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)> {
1179                 match full_path {
1180                         "Result" if !is_ref => {
1181                                 Some(("match ",
1182                                                 vec![(".result_ok { true => Ok(".to_string(), format!("(*unsafe {{ Box::from_raw(<*mut _>::take_ptr(&mut {}.contents.result)) }})", var_access)),
1183                                                      ("), false => Err(".to_string(), format!("(*unsafe {{ Box::from_raw(<*mut _>::take_ptr(&mut {}.contents.err)) }})", var_access))],
1184                                                 ")}", ContainerPrefixLocation::PerConv))
1185                         },
1186                         "Slice" if is_ref => {
1187                                 Some(("Vec::new(); for mut item in ", vec![(format!(".as_slice().iter() {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1188                         },
1189                         "Vec"|"Slice" => {
1190                                 Some(("Vec::new(); for mut item in ", vec![(format!(".into_rust().drain(..) {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1191                         },
1192                         "Option" => {
1193                                 if let Some(syn::Type::Path(p)) = single_contained {
1194                                         let inner_path = self.resolve_path(&p.path, generics);
1195                                         if self.is_primitive(&inner_path) {
1196                                                 return Some(("if ", vec![(".is_some() { Some(".to_string(), format!("{}.take()", var_access))], ") } else { None }", ContainerPrefixLocation::NoPrefix))
1197                                         } else if self.c_type_has_inner_from_path(&inner_path) {
1198                                                 if is_ref {
1199                                                         return Some(("if ", vec![(".inner.is_null() { None } else { Some((*".to_string(), format!("{}", var_access))], ").clone()) }", ContainerPrefixLocation::PerConv))
1200                                                 } else {
1201                                                         return Some(("if ", vec![(".inner.is_null() { None } else { Some(".to_string(), format!("{}", var_access))], ") }", ContainerPrefixLocation::PerConv));
1202                                                 }
1203                                         }
1204                                 }
1205
1206                                 if let Some(t) = single_contained {
1207                                         match t {
1208                                                 syn::Type::Reference(_)|syn::Type::Path(_)|syn::Type::Slice(_) => {
1209                                                         let mut v = Vec::new();
1210                                                         let ret_ref = self.write_empty_rust_val_check_suffix(generics, &mut v, t);
1211                                                         let s = String::from_utf8(v).unwrap();
1212                                                         match ret_ref {
1213                                                                 EmptyValExpectedTy::ReferenceAsPointer =>
1214                                                                         return Some(("if ", vec![
1215                                                                                 (format!("{} {{ None }} else {{ Some(", s), format!("unsafe {{ &mut *{} }}", var_access))
1216                                                                         ], ") }", ContainerPrefixLocation::NoPrefix)),
1217                                                                 EmptyValExpectedTy::OwnedPointer => {
1218                                                                         if let syn::Type::Slice(_) = t {
1219                                                                                         panic!();
1220                                                                         }
1221                                                                         return Some(("if ", vec![
1222                                                                                 (format!("{} {{ None }} else {{ Some(", s), format!("unsafe {{ *Box::from_raw({}) }}", var_access))
1223                                                                         ], ") }", ContainerPrefixLocation::NoPrefix));
1224                                                                 }
1225                                                                 EmptyValExpectedTy::NonPointer =>
1226                                                                         return Some(("if ", vec![
1227                                                                                 (format!("{} {{ None }} else {{ Some(", s), format!("{}", var_access))
1228                                                                         ], ") }", ContainerPrefixLocation::PerConv)),
1229                                                         }
1230                                                 },
1231                                                 syn::Type::Tuple(_) => {
1232                                                         return Some(("if ", vec![(".is_some() { Some(".to_string(), format!("{}.take()", var_access))], ") } else { None }", ContainerPrefixLocation::PerConv))
1233                                                 },
1234                                                 _ => unimplemented!(),
1235                                         }
1236                                 } else { unreachable!(); }
1237                         },
1238                         _ => None,
1239                 }
1240         }
1241
1242         // *************************************************
1243         // *** Type definition during main.rs processing ***
1244         // *************************************************
1245
1246         pub fn get_declared_type(&'a self, ident: &syn::Ident) -> Option<&'a DeclType<'c>> {
1247                 self.types.get_declared_type(ident)
1248         }
1249         /// Returns true if the object at the given path is mapped as X { inner: *mut origX, .. }.
1250         pub fn c_type_has_inner_from_path(&self, full_path: &str) -> bool{
1251                 self.crate_types.opaques.get(full_path).is_some()
1252         }
1253
1254         pub fn maybe_resolve_ident(&self, id: &syn::Ident) -> Option<String> {
1255                 self.types.maybe_resolve_ident(id)
1256         }
1257
1258         pub fn maybe_resolve_non_ignored_ident(&self, id: &syn::Ident) -> Option<String> {
1259                 self.types.maybe_resolve_non_ignored_ident(id)
1260         }
1261
1262         pub fn maybe_resolve_path(&self, p_arg: &syn::Path, generics: Option<&GenericTypes>) -> Option<String> {
1263                 self.types.maybe_resolve_path(p_arg, generics)
1264         }
1265         pub fn resolve_path(&self, p: &syn::Path, generics: Option<&GenericTypes>) -> String {
1266                 self.maybe_resolve_path(p, generics).unwrap()
1267         }
1268
1269         // ***********************************
1270         // *** Original Rust Type Printing ***
1271         // ***********************************
1272
1273         fn in_rust_prelude(resolved_path: &str) -> bool {
1274                 match resolved_path {
1275                         "Vec" => true,
1276                         "Result" => true,
1277                         "Option" => true,
1278                         _ => false,
1279                 }
1280         }
1281
1282         fn write_rust_path<W: std::io::Write>(&self, w: &mut W, generics_resolver: Option<&GenericTypes>, path: &syn::Path) {
1283                 if let Some(resolved) = self.maybe_resolve_path(&path, generics_resolver) {
1284                         if self.is_primitive(&resolved) {
1285                                 write!(w, "{}", path.get_ident().unwrap()).unwrap();
1286                         } else {
1287                                 // TODO: We should have a generic "is from a dependency" check here instead of
1288                                 // checking for "bitcoin" explicitly.
1289                                 if resolved.starts_with("bitcoin::") || Self::in_rust_prelude(&resolved) {
1290                                         write!(w, "{}", resolved).unwrap();
1291                                 // If we're printing a generic argument, it needs to reference the crate, otherwise
1292                                 // the original crate:
1293                                 } else if self.maybe_resolve_path(&path, None).as_ref() == Some(&resolved) {
1294                                         write!(w, "{}", resolved).unwrap();
1295                                 } else {
1296                                         write!(w, "crate::{}", resolved).unwrap();
1297                                 }
1298                         }
1299                         if let syn::PathArguments::AngleBracketed(args) = &path.segments.iter().last().unwrap().arguments {
1300                                 self.write_rust_generic_arg(w, generics_resolver, args.args.iter());
1301                         }
1302                 } else {
1303                         if path.leading_colon.is_some() {
1304                                 write!(w, "::").unwrap();
1305                         }
1306                         for (idx, seg) in path.segments.iter().enumerate() {
1307                                 if idx != 0 { write!(w, "::").unwrap(); }
1308                                 write!(w, "{}", seg.ident).unwrap();
1309                                 if let syn::PathArguments::AngleBracketed(args) = &seg.arguments {
1310                                         self.write_rust_generic_arg(w, generics_resolver, args.args.iter());
1311                                 }
1312                         }
1313                 }
1314         }
1315         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>) {
1316                 let mut had_params = false;
1317                 for (idx, arg) in generics.enumerate() {
1318                         if idx != 0 { write!(w, ", ").unwrap(); } else { write!(w, "<").unwrap(); }
1319                         had_params = true;
1320                         match arg {
1321                                 syn::GenericParam::Lifetime(lt) => write!(w, "'{}", lt.lifetime.ident).unwrap(),
1322                                 syn::GenericParam::Type(t) => {
1323                                         write!(w, "{}", t.ident).unwrap();
1324                                         if t.colon_token.is_some() { write!(w, ":").unwrap(); }
1325                                         for (idx, bound) in t.bounds.iter().enumerate() {
1326                                                 if idx != 0 { write!(w, " + ").unwrap(); }
1327                                                 match bound {
1328                                                         syn::TypeParamBound::Trait(tb) => {
1329                                                                 if tb.paren_token.is_some() || tb.lifetimes.is_some() { unimplemented!(); }
1330                                                                 self.write_rust_path(w, generics_resolver, &tb.path);
1331                                                         },
1332                                                         _ => unimplemented!(),
1333                                                 }
1334                                         }
1335                                         if t.eq_token.is_some() || t.default.is_some() { unimplemented!(); }
1336                                 },
1337                                 _ => unimplemented!(),
1338                         }
1339                 }
1340                 if had_params { write!(w, ">").unwrap(); }
1341         }
1342
1343         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>) {
1344                 write!(w, "<").unwrap();
1345                 for (idx, arg) in generics.enumerate() {
1346                         if idx != 0 { write!(w, ", ").unwrap(); }
1347                         match arg {
1348                                 syn::GenericArgument::Type(t) => self.write_rust_type(w, generics_resolver, t),
1349                                 _ => unimplemented!(),
1350                         }
1351                 }
1352                 write!(w, ">").unwrap();
1353         }
1354         pub fn write_rust_type<W: std::io::Write>(&self, w: &mut W, generics: Option<&GenericTypes>, t: &syn::Type) {
1355                 match t {
1356                         syn::Type::Path(p) => {
1357                                 if p.qself.is_some() {
1358                                         unimplemented!();
1359                                 }
1360                                 self.write_rust_path(w, generics, &p.path);
1361                         },
1362                         syn::Type::Reference(r) => {
1363                                 write!(w, "&").unwrap();
1364                                 if let Some(lft) = &r.lifetime {
1365                                         write!(w, "'{} ", lft.ident).unwrap();
1366                                 }
1367                                 if r.mutability.is_some() {
1368                                         write!(w, "mut ").unwrap();
1369                                 }
1370                                 self.write_rust_type(w, generics, &*r.elem);
1371                         },
1372                         syn::Type::Array(a) => {
1373                                 write!(w, "[").unwrap();
1374                                 self.write_rust_type(w, generics, &a.elem);
1375                                 if let syn::Expr::Lit(l) = &a.len {
1376                                         if let syn::Lit::Int(i) = &l.lit {
1377                                                 write!(w, "; {}]", i).unwrap();
1378                                         } else { unimplemented!(); }
1379                                 } else { unimplemented!(); }
1380                         }
1381                         syn::Type::Slice(s) => {
1382                                 write!(w, "[").unwrap();
1383                                 self.write_rust_type(w, generics, &s.elem);
1384                                 write!(w, "]").unwrap();
1385                         },
1386                         syn::Type::Tuple(s) => {
1387                                 write!(w, "(").unwrap();
1388                                 for (idx, t) in s.elems.iter().enumerate() {
1389                                         if idx != 0 { write!(w, ", ").unwrap(); }
1390                                         self.write_rust_type(w, generics, &t);
1391                                 }
1392                                 write!(w, ")").unwrap();
1393                         },
1394                         _ => unimplemented!(),
1395                 }
1396         }
1397
1398         /// Prints a constructor for something which is "uninitialized" (but obviously not actually
1399         /// unint'd memory).
1400         pub fn write_empty_rust_val<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type) {
1401                 match t {
1402                         syn::Type::Path(p) => {
1403                                 let resolved = self.resolve_path(&p.path, generics);
1404                                 if self.crate_types.opaques.get(&resolved).is_some() {
1405                                         write!(w, "crate::{} {{ inner: std::ptr::null_mut(), is_owned: true }}", resolved).unwrap();
1406                                 } else {
1407                                         // Assume its a manually-mapped C type, where we can just define an null() fn
1408                                         write!(w, "{}::null()", self.c_type_from_path(&resolved, false, false).unwrap()).unwrap();
1409                                 }
1410                         },
1411                         syn::Type::Array(a) => {
1412                                 if let syn::Expr::Lit(l) = &a.len {
1413                                         if let syn::Lit::Int(i) = &l.lit {
1414                                                 if i.base10_digits().parse::<usize>().unwrap() < 32 {
1415                                                         // Blindly assume that if we're trying to create an empty value for an
1416                                                         // array < 32 entries that all-0s may be a valid state.
1417                                                         unimplemented!();
1418                                                 }
1419                                                 let arrty = format!("[u8; {}]", i.base10_digits());
1420                                                 write!(w, "{}", self.to_c_conversion_inline_prefix_from_path(&arrty, false, false).unwrap()).unwrap();
1421                                                 write!(w, "[0; {}]", i.base10_digits()).unwrap();
1422                                                 write!(w, "{}", self.to_c_conversion_inline_suffix_from_path(&arrty, false, false).unwrap()).unwrap();
1423                                         } else { unimplemented!(); }
1424                                 } else { unimplemented!(); }
1425                         }
1426                         _ => unimplemented!(),
1427                 }
1428         }
1429
1430         fn is_real_type_array(&self, resolved_type: &str) -> Option<syn::Type> {
1431                 if let Some(real_ty) = self.c_type_from_path(&resolved_type, true, false) {
1432                         if real_ty.ends_with("]") && real_ty.starts_with("*const [u8; ") {
1433                                 let mut split = real_ty.split("; ");
1434                                 split.next().unwrap();
1435                                 let tail_str = split.next().unwrap();
1436                                 assert!(split.next().is_none());
1437                                 let len = &tail_str[..tail_str.len() - 1];
1438                                 Some(syn::Type::Array(syn::TypeArray {
1439                                                 bracket_token: syn::token::Bracket { span: Span::call_site() },
1440                                                 elem: Box::new(syn::Type::Path(syn::TypePath {
1441                                                         qself: None,
1442                                                         path: syn::Path::from(syn::PathSegment::from(syn::Ident::new("u8", Span::call_site()))),
1443                                                 })),
1444                                                 semi_token: syn::Token!(;)(Span::call_site()),
1445                                                 len: syn::Expr::Lit(syn::ExprLit { attrs: Vec::new(), lit: syn::Lit::Int(syn::LitInt::new(len, Span::call_site())) }),
1446                                         }))
1447                         } else { None }
1448                 } else { None }
1449         }
1450
1451         /// Prints a suffix to determine if a variable is empty (ie was set by write_empty_rust_val).
1452         /// See EmptyValExpectedTy for information on return types.
1453         fn write_empty_rust_val_check_suffix<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type) -> EmptyValExpectedTy {
1454                 match t {
1455                         syn::Type::Path(p) => {
1456                                 let resolved = self.resolve_path(&p.path, generics);
1457                                 if let Some(arr_ty) = self.is_real_type_array(&resolved) {
1458                                         write!(w, ".data").unwrap();
1459                                         return self.write_empty_rust_val_check_suffix(generics, w, &arr_ty);
1460                                 }
1461                                 if self.crate_types.opaques.get(&resolved).is_some() {
1462                                         write!(w, ".inner.is_null()").unwrap();
1463                                         EmptyValExpectedTy::NonPointer
1464                                 } else {
1465                                         if let Some(suffix) = self.empty_val_check_suffix_from_path(&resolved) {
1466                                                 write!(w, "{}", suffix).unwrap();
1467                                                 // We may eventually need to allow empty_val_check_suffix_from_path to specify if we need a deref or not
1468                                                 EmptyValExpectedTy::NonPointer
1469                                         } else {
1470                                                 write!(w, " == std::ptr::null_mut()").unwrap();
1471                                                 EmptyValExpectedTy::OwnedPointer
1472                                         }
1473                                 }
1474                         },
1475                         syn::Type::Array(a) => {
1476                                 if let syn::Expr::Lit(l) = &a.len {
1477                                         if let syn::Lit::Int(i) = &l.lit {
1478                                                 write!(w, " == [0; {}]", i.base10_digits()).unwrap();
1479                                                 EmptyValExpectedTy::NonPointer
1480                                         } else { unimplemented!(); }
1481                                 } else { unimplemented!(); }
1482                         },
1483                         syn::Type::Slice(_) => {
1484                                 // Option<[]> always implies that we want to treat len() == 0 differently from
1485                                 // None, so we always map an Option<[]> into a pointer.
1486                                 write!(w, " == std::ptr::null_mut()").unwrap();
1487                                 EmptyValExpectedTy::ReferenceAsPointer
1488                         },
1489                         _ => unimplemented!(),
1490                 }
1491         }
1492
1493         /// Prints a suffix to determine if a variable is empty (ie was set by write_empty_rust_val).
1494         pub fn write_empty_rust_val_check<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type, var_access: &str) {
1495                 match t {
1496                         syn::Type::Path(_) => {
1497                                 write!(w, "{}", var_access).unwrap();
1498                                 self.write_empty_rust_val_check_suffix(generics, w, t);
1499                         },
1500                         syn::Type::Array(a) => {
1501                                 if let syn::Expr::Lit(l) = &a.len {
1502                                         if let syn::Lit::Int(i) = &l.lit {
1503                                                 let arrty = format!("[u8; {}]", i.base10_digits());
1504                                                 // We don't (yet) support a new-var conversion here.
1505                                                 assert!(self.from_c_conversion_new_var_from_path(&arrty, false).is_none());
1506                                                 write!(w, "{}{}{}",
1507                                                         self.from_c_conversion_prefix_from_path(&arrty, false).unwrap(),
1508                                                         var_access,
1509                                                         self.from_c_conversion_suffix_from_path(&arrty, false).unwrap()).unwrap();
1510                                                 self.write_empty_rust_val_check_suffix(generics, w, t);
1511                                         } else { unimplemented!(); }
1512                                 } else { unimplemented!(); }
1513                         }
1514                         _ => unimplemented!(),
1515                 }
1516         }
1517
1518         // ********************************
1519         // *** Type conversion printing ***
1520         // ********************************
1521
1522         /// Returns true we if can just skip passing this to C entirely
1523         pub fn skip_arg(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> bool {
1524                 match t {
1525                         syn::Type::Path(p) => {
1526                                 if p.qself.is_some() { unimplemented!(); }
1527                                 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
1528                                         self.skip_path(&full_path)
1529                                 } else { false }
1530                         },
1531                         syn::Type::Reference(r) => {
1532                                 self.skip_arg(&*r.elem, generics)
1533                         },
1534                         _ => false,
1535                 }
1536         }
1537         pub fn no_arg_to_rust<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
1538                 match t {
1539                         syn::Type::Path(p) => {
1540                                 if p.qself.is_some() { unimplemented!(); }
1541                                 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
1542                                         write!(w, "{}", self.no_arg_path_to_rust(&full_path)).unwrap();
1543                                 }
1544                         },
1545                         syn::Type::Reference(r) => {
1546                                 self.no_arg_to_rust(w, &*r.elem, generics);
1547                         },
1548                         _ => {},
1549                 }
1550         }
1551
1552         fn write_conversion_inline_intern<W: std::io::Write,
1553                         LP: Fn(&str, bool, bool) -> Option<String>, DL: Fn(&mut W, &DeclType, &str, bool, bool), SC: Fn(bool) -> &'static str>
1554                         (&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, is_ref: bool, is_mut: bool, ptr_for_ref: bool,
1555                          tupleconv: &str, prefix: bool, sliceconv: SC, path_lookup: LP, decl_lookup: DL) {
1556                 match t {
1557                         syn::Type::Reference(r) => {
1558                                 self.write_conversion_inline_intern(w, &*r.elem, generics, true, r.mutability.is_some(),
1559                                         ptr_for_ref, tupleconv, prefix, sliceconv, path_lookup, decl_lookup);
1560                         },
1561                         syn::Type::Path(p) => {
1562                                 if p.qself.is_some() {
1563                                         unimplemented!();
1564                                 }
1565
1566                                 let resolved_path = self.resolve_path(&p.path, generics);
1567                                 if let Some(aliased_type) = self.crate_types.type_aliases.get(&resolved_path) {
1568                                         return self.write_conversion_inline_intern(w, aliased_type, None, is_ref, is_mut, ptr_for_ref, tupleconv, prefix, sliceconv, path_lookup, decl_lookup);
1569                                 } else if let Some(c_type) = path_lookup(&resolved_path, is_ref, ptr_for_ref) {
1570                                         write!(w, "{}", c_type).unwrap();
1571                                 } else if self.crate_types.opaques.get(&resolved_path).is_some() {
1572                                         decl_lookup(w, &DeclType::StructImported, &resolved_path, is_ref, is_mut);
1573                                 } else if self.crate_types.mirrored_enums.get(&resolved_path).is_some() {
1574                                         decl_lookup(w, &DeclType::MirroredEnum, &resolved_path, is_ref, is_mut);
1575                                 } else if let Some(t) = self.crate_types.traits.get(&resolved_path) {
1576                                         decl_lookup(w, &DeclType::Trait(t), &resolved_path, is_ref, is_mut);
1577                                 } else if let Some(ident) = single_ident_generic_path_to_ident(&p.path) {
1578                                         if let Some(decl_type) = self.types.maybe_resolve_declared(ident) {
1579                                                 decl_lookup(w, decl_type, &self.maybe_resolve_ident(ident).unwrap(), is_ref, is_mut);
1580                                         } else { unimplemented!(); }
1581                                 } else { unimplemented!(); }
1582                         },
1583                         syn::Type::Array(a) => {
1584                                 // We assume all arrays contain only [int_literal; X]s.
1585                                 // This may result in some outputs not compiling.
1586                                 if let syn::Expr::Lit(l) = &a.len {
1587                                         if let syn::Lit::Int(i) = &l.lit {
1588                                                 write!(w, "{}", path_lookup(&format!("[u8; {}]", i.base10_digits()), is_ref, ptr_for_ref).unwrap()).unwrap();
1589                                         } else { unimplemented!(); }
1590                                 } else { unimplemented!(); }
1591                         },
1592                         syn::Type::Slice(s) => {
1593                                 // We assume all slices contain only literals or references.
1594                                 // This may result in some outputs not compiling.
1595                                 if let syn::Type::Path(p) = &*s.elem {
1596                                         let resolved = self.resolve_path(&p.path, generics);
1597                                         assert!(self.is_primitive(&resolved));
1598                                         write!(w, "{}", path_lookup("[u8]", is_ref, ptr_for_ref).unwrap()).unwrap();
1599                                 } else if let syn::Type::Reference(r) = &*s.elem {
1600                                         if let syn::Type::Path(p) = &*r.elem {
1601                                                 write!(w, "{}", sliceconv(self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)))).unwrap();
1602                                         } else { unimplemented!(); }
1603                                 } else if let syn::Type::Tuple(t) = &*s.elem {
1604                                         assert!(!t.elems.is_empty());
1605                                         if prefix {
1606                                                 write!(w, "&local_").unwrap();
1607                                         } else {
1608                                                 let mut needs_map = false;
1609                                                 for e in t.elems.iter() {
1610                                                         if let syn::Type::Reference(_) = e {
1611                                                                 needs_map = true;
1612                                                         }
1613                                                 }
1614                                                 if needs_map {
1615                                                         write!(w, ".iter().map(|(").unwrap();
1616                                                         for i in 0..t.elems.len() {
1617                                                                 write!(w, "{}{}", if i != 0 { ", " } else { "" }, ('a' as u8 + i as u8) as char).unwrap();
1618                                                         }
1619                                                         write!(w, ")| (").unwrap();
1620                                                         for (idx, e) in t.elems.iter().enumerate() {
1621                                                                 if let syn::Type::Reference(_) = e {
1622                                                                         write!(w, "{}{}", if idx != 0 { ", " } else { "" }, (idx as u8 + 'a' as u8) as char).unwrap();
1623                                                                 } else if let syn::Type::Path(_) = e {
1624                                                                         write!(w, "{}*{}", if idx != 0 { ", " } else { "" }, (idx as u8 + 'a' as u8) as char).unwrap();
1625                                                                 } else { unimplemented!(); }
1626                                                         }
1627                                                         write!(w, ")).collect::<Vec<_>>()[..]").unwrap();
1628                                                 }
1629                                         }
1630                                 } else { unimplemented!(); }
1631                         },
1632                         syn::Type::Tuple(t) => {
1633                                 if t.elems.is_empty() {
1634                                         // cbindgen has poor support for (), see, eg https://github.com/eqrion/cbindgen/issues/527
1635                                         // so work around it by just pretending its a 0u8
1636                                         write!(w, "{}", tupleconv).unwrap();
1637                                 } else {
1638                                         if prefix { write!(w, "local_").unwrap(); }
1639                                 }
1640                         },
1641                         _ => unimplemented!(),
1642                 }
1643         }
1644
1645         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) {
1646                 self.write_conversion_inline_intern(w, t, generics, is_ref, false, ptr_for_ref, "0u8 /*", true, |_| "local_",
1647                                 |a, b, c| self.to_c_conversion_inline_prefix_from_path(a, b, c),
1648                                 |w, decl_type, decl_path, is_ref, _is_mut| {
1649                                         match decl_type {
1650                                                 DeclType::MirroredEnum if is_ref && ptr_for_ref => write!(w, "crate::{}::from_native(&", decl_path).unwrap(),
1651                                                 DeclType::MirroredEnum if is_ref => write!(w, "&crate::{}::from_native(&", decl_path).unwrap(),
1652                                                 DeclType::MirroredEnum => write!(w, "crate::{}::native_into(", decl_path).unwrap(),
1653                                                 DeclType::EnumIgnored|DeclType::StructImported if is_ref && ptr_for_ref && from_ptr =>
1654                                                         write!(w, "crate::{} {{ inner: unsafe {{ (", decl_path).unwrap(),
1655                                                 DeclType::EnumIgnored|DeclType::StructImported if is_ref && ptr_for_ref =>
1656                                                         write!(w, "crate::{} {{ inner: unsafe {{ ( (&(", decl_path).unwrap(),
1657                                                 DeclType::EnumIgnored|DeclType::StructImported if is_ref =>
1658                                                         write!(w, "&crate::{} {{ inner: unsafe {{ (", decl_path).unwrap(),
1659                                                 DeclType::EnumIgnored|DeclType::StructImported if !is_ref && from_ptr =>
1660                                                         write!(w, "crate::{} {{ inner: ", decl_path).unwrap(),
1661                                                 DeclType::EnumIgnored|DeclType::StructImported if !is_ref =>
1662                                                         write!(w, "crate::{} {{ inner: Box::into_raw(Box::new(", decl_path).unwrap(),
1663                                                 DeclType::Trait(_) if is_ref => write!(w, "&").unwrap(),
1664                                                 DeclType::Trait(_) if !is_ref => {},
1665                                                 _ => panic!("{:?}", decl_path),
1666                                         }
1667                                 });
1668         }
1669         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) {
1670                 self.write_to_c_conversion_inline_prefix_inner(w, t, generics, false, ptr_for_ref, false);
1671         }
1672         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) {
1673                 self.write_conversion_inline_intern(w, t, generics, is_ref, false, ptr_for_ref, "*/", false, |_| ".into()",
1674                                 |a, b, c| self.to_c_conversion_inline_suffix_from_path(a, b, c),
1675                                 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
1676                                         DeclType::MirroredEnum => write!(w, ")").unwrap(),
1677                                         DeclType::EnumIgnored|DeclType::StructImported if is_ref && ptr_for_ref && from_ptr =>
1678                                                 write!(w, " as *const _) as *mut _ }}, is_owned: false }}").unwrap(),
1679                                         DeclType::EnumIgnored|DeclType::StructImported if is_ref && ptr_for_ref =>
1680                                                 write!(w, ") as *const _) as *mut _) }}, is_owned: false }}").unwrap(),
1681                                         DeclType::EnumIgnored|DeclType::StructImported if is_ref =>
1682                                                 write!(w, " as *const _) as *mut _ }}, is_owned: false }}").unwrap(),
1683                                         DeclType::EnumIgnored|DeclType::StructImported if !is_ref && from_ptr =>
1684                                                 write!(w, ", is_owned: true }}").unwrap(),
1685                                         DeclType::EnumIgnored|DeclType::StructImported if !is_ref => write!(w, ")), is_owned: true }}").unwrap(),
1686                                         DeclType::Trait(_) if is_ref => {},
1687                                         DeclType::Trait(_) => {
1688                                                 // This is used when we're converting a concrete Rust type into a C trait
1689                                                 // for use when a Rust trait method returns an associated type.
1690                                                 // Because all of our C traits implement From<RustTypesImplementingTraits>
1691                                                 // we can just call .into() here and be done.
1692                                                 write!(w, ".into()").unwrap()
1693                                         },
1694                                         _ => unimplemented!(),
1695                                 });
1696         }
1697         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) {
1698                 self.write_to_c_conversion_inline_suffix_inner(w, t, generics, false, ptr_for_ref, false);
1699         }
1700
1701         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) {
1702                 self.write_conversion_inline_intern(w, t, generics, is_ref, false, false, "() /*", true, |_| "&local_",
1703                                 |a, b, _c| self.from_c_conversion_prefix_from_path(a, b),
1704                                 |w, decl_type, _full_path, is_ref, is_mut| match decl_type {
1705                                         DeclType::StructImported if is_ref && ptr_for_ref => write!(w, "unsafe {{ &*(*").unwrap(),
1706                                         DeclType::StructImported if is_mut && is_ref => write!(w, "unsafe {{ &mut *").unwrap(),
1707                                         DeclType::StructImported if is_ref => write!(w, "unsafe {{ &*").unwrap(),
1708                                         DeclType::StructImported if !is_ref => write!(w, "*unsafe {{ Box::from_raw(").unwrap(),
1709                                         DeclType::MirroredEnum if is_ref => write!(w, "&").unwrap(),
1710                                         DeclType::MirroredEnum => {},
1711                                         DeclType::Trait(_) => {},
1712                                         _ => unimplemented!(),
1713                                 });
1714         }
1715         pub fn write_from_c_conversion_prefix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
1716                 self.write_from_c_conversion_prefix_inner(w, t, generics, false, false);
1717         }
1718         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) {
1719                 self.write_conversion_inline_intern(w, t, generics, is_ref, false, false, "*/", false,
1720                                 |has_inner| match has_inner {
1721                                         false => ".iter().collect::<Vec<_>>()[..]",
1722                                         true => "[..]",
1723                                 },
1724                                 |a, b, _c| self.from_c_conversion_suffix_from_path(a, b),
1725                                 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
1726                                         DeclType::StructImported if is_ref && ptr_for_ref => write!(w, ").inner }}").unwrap(),
1727                                         DeclType::StructImported if is_ref => write!(w, ".inner }}").unwrap(),
1728                                         DeclType::StructImported if !is_ref => write!(w, ".take_inner()) }}").unwrap(),
1729                                         DeclType::MirroredEnum if is_ref => write!(w, ".to_native()").unwrap(),
1730                                         DeclType::MirroredEnum => write!(w, ".into_native()").unwrap(),
1731                                         DeclType::Trait(_) => {},
1732                                         _ => unimplemented!(),
1733                                 });
1734         }
1735         pub fn write_from_c_conversion_suffix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
1736                 self.write_from_c_conversion_suffix_inner(w, t, generics, false, false);
1737         }
1738         // Note that compared to the above conversion functions, the following two are generally
1739         // significantly undertested:
1740         pub fn write_from_c_conversion_to_ref_prefix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
1741                 self.write_conversion_inline_intern(w, t, generics, false, false, false, "() /*", true, |_| "&local_",
1742                                 |a, b, _c| {
1743                                         if let Some(conv) = self.from_c_conversion_prefix_from_path(a, b) {
1744                                                 Some(format!("&{}", conv))
1745                                         } else { None }
1746                                 },
1747                                 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
1748                                         DeclType::StructImported if !is_ref => write!(w, "unsafe {{ &*").unwrap(),
1749                                         _ => unimplemented!(),
1750                                 });
1751         }
1752         pub fn write_from_c_conversion_to_ref_suffix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
1753                 self.write_conversion_inline_intern(w, t, generics, false, false, false, "*/", false,
1754                                 |has_inner| match has_inner {
1755                                         false => ".iter().collect::<Vec<_>>()[..]",
1756                                         true => "[..]",
1757                                 },
1758                                 |a, b, _c| self.from_c_conversion_suffix_from_path(a, b),
1759                                 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
1760                                         DeclType::StructImported if !is_ref => write!(w, ".inner }}").unwrap(),
1761                                         _ => unimplemented!(),
1762                                 });
1763         }
1764
1765         fn write_conversion_new_var_intern<'b, W: std::io::Write,
1766                 LP: Fn(&str, bool) -> Option<(&str, &str)>,
1767                 LC: Fn(&str, bool, Option<&syn::Type>, &syn::Ident, &str) ->  Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)>,
1768                 VP: Fn(&mut W, &syn::Type, Option<&GenericTypes>, bool, bool, bool),
1769                 VS: Fn(&mut W, &syn::Type, Option<&GenericTypes>, bool, bool, bool)>
1770                         (&self, w: &mut W, ident: &syn::Ident, var: &str, t: &syn::Type, generics: Option<&GenericTypes>,
1771                          mut is_ref: bool, mut ptr_for_ref: bool, to_c: bool,
1772                          path_lookup: &LP, container_lookup: &LC, var_prefix: &VP, var_suffix: &VS) -> bool {
1773
1774                 macro_rules! convert_container {
1775                         ($container_type: expr, $args_len: expr, $args_iter: expr) => { {
1776                                 // For slices (and Options), we refuse to directly map them as is_ref when they
1777                                 // aren't opaque types containing an inner pointer. This is due to the fact that,
1778                                 // in both cases, the actual higher-level type is non-is_ref.
1779                                 let ty_has_inner = if $args_len == 1 {
1780                                         let ty = $args_iter().next().unwrap();
1781                                         if $container_type == "Slice" && to_c {
1782                                                 // "To C ptr_for_ref" means "return the regular object with is_owned
1783                                                 // set to false", which is totally what we want in a slice if we're about to
1784                                                 // set ty_has_inner.
1785                                                 ptr_for_ref = true;
1786                                         }
1787                                         if let syn::Type::Reference(t) = ty {
1788                                                 if let syn::Type::Path(p) = &*t.elem {
1789                                                         self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
1790                                                 } else { false }
1791                                         } else if let syn::Type::Path(p) = ty {
1792                                                 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
1793                                         } else { false }
1794                                 } else { true };
1795
1796                                 // Options get a bunch of special handling, since in general we map Option<>al
1797                                 // types into the same C type as non-Option-wrapped types. This ends up being
1798                                 // pretty manual here and most of the below special-cases are for Options.
1799                                 let mut needs_ref_map = false;
1800                                 let mut only_contained_type = None;
1801                                 let mut only_contained_has_inner = false;
1802                                 let mut contains_slice = false;
1803                                 if $args_len == 1 {
1804                                         only_contained_has_inner = ty_has_inner;
1805                                         let arg = $args_iter().next().unwrap();
1806                                         if let syn::Type::Reference(t) = arg {
1807                                                 only_contained_type = Some(&*t.elem);
1808                                                 if let syn::Type::Path(_) = &*t.elem {
1809                                                         is_ref = true;
1810                                                 } else if let syn::Type::Slice(_) = &*t.elem {
1811                                                         contains_slice = true;
1812                                                 } else { return false; }
1813                                                 // If the inner element contains an inner pointer, we will just use that,
1814                                                 // avoiding the need to map elements to references. Otherwise we'll need to
1815                                                 // do an extra mapping step.
1816                                                 needs_ref_map = !only_contained_has_inner;
1817                                         } else {
1818                                                 only_contained_type = Some(&arg);
1819                                         }
1820                                 }
1821
1822                                 if let Some((prefix, conversions, suffix, prefix_location)) = container_lookup(&$container_type, is_ref && ty_has_inner, only_contained_type, ident, var) {
1823                                         assert_eq!(conversions.len(), $args_len);
1824                                         write!(w, "let mut local_{}{} = ", ident, if !to_c && needs_ref_map {"_base"} else { "" }).unwrap();
1825                                         if prefix_location == ContainerPrefixLocation::OutsideConv {
1826                                                 var_prefix(w, $args_iter().next().unwrap(), generics, is_ref, ptr_for_ref, true);
1827                                         }
1828                                         write!(w, "{}{}", prefix, var).unwrap();
1829
1830                                         for ((pfx, var_name), (idx, ty)) in conversions.iter().zip($args_iter().enumerate()) {
1831                                                 let mut var = std::io::Cursor::new(Vec::new());
1832                                                 write!(&mut var, "{}", var_name).unwrap();
1833                                                 let var_access = String::from_utf8(var.into_inner()).unwrap();
1834
1835                                                 let conv_ty = if needs_ref_map { only_contained_type.as_ref().unwrap() } else { ty };
1836
1837                                                 write!(w, "{} {{ ", pfx).unwrap();
1838                                                 let new_var_name = format!("{}_{}", ident, idx);
1839                                                 let new_var = self.write_conversion_new_var_intern(w, &syn::Ident::new(&new_var_name, Span::call_site()),
1840                                                                 &var_access, conv_ty, generics, contains_slice || (is_ref && ty_has_inner), ptr_for_ref, to_c, path_lookup, container_lookup, var_prefix, var_suffix);
1841                                                 if new_var { write!(w, " ").unwrap(); }
1842
1843                                                 if prefix_location == ContainerPrefixLocation::PerConv {
1844                                                         var_prefix(w, conv_ty, generics, is_ref && ty_has_inner, ptr_for_ref, false);
1845                                                 } else if !is_ref && !needs_ref_map && to_c && only_contained_has_inner {
1846                                                         write!(w, "Box::into_raw(Box::new(").unwrap();
1847                                                 }
1848
1849                                                 write!(w, "{}{}", if contains_slice { "local_" } else { "" }, if new_var { new_var_name } else { var_access }).unwrap();
1850                                                 if prefix_location == ContainerPrefixLocation::PerConv {
1851                                                         var_suffix(w, conv_ty, generics, is_ref && ty_has_inner, ptr_for_ref, false);
1852                                                 } else if !is_ref && !needs_ref_map && to_c && only_contained_has_inner {
1853                                                         write!(w, "))").unwrap();
1854                                                 }
1855                                                 write!(w, " }}").unwrap();
1856                                         }
1857                                         write!(w, "{}", suffix).unwrap();
1858                                         if prefix_location == ContainerPrefixLocation::OutsideConv {
1859                                                 var_suffix(w, $args_iter().next().unwrap(), generics, is_ref, ptr_for_ref, true);
1860                                         }
1861                                         write!(w, ";").unwrap();
1862                                         if !to_c && needs_ref_map {
1863                                                 write!(w, " let mut local_{} = local_{}_base.as_ref()", ident, ident).unwrap();
1864                                                 if contains_slice {
1865                                                         write!(w, ".map(|a| &a[..])").unwrap();
1866                                                 }
1867                                                 write!(w, ";").unwrap();
1868                                         }
1869                                         return true;
1870                                 }
1871                         } }
1872                 }
1873
1874                 match t {
1875                         syn::Type::Reference(r) => {
1876                                 if let syn::Type::Slice(_) = &*r.elem {
1877                                         self.write_conversion_new_var_intern(w, ident, var, &*r.elem, generics, is_ref, ptr_for_ref, to_c, path_lookup, container_lookup, var_prefix, var_suffix)
1878                                 } else {
1879                                         self.write_conversion_new_var_intern(w, ident, var, &*r.elem, generics, true, ptr_for_ref, to_c, path_lookup, container_lookup, var_prefix, var_suffix)
1880                                 }
1881                         },
1882                         syn::Type::Path(p) => {
1883                                 if p.qself.is_some() {
1884                                         unimplemented!();
1885                                 }
1886                                 let resolved_path = self.resolve_path(&p.path, generics);
1887                                 if let Some(aliased_type) = self.crate_types.type_aliases.get(&resolved_path) {
1888                                         return self.write_conversion_new_var_intern(w, ident, var, aliased_type, None, is_ref, ptr_for_ref, to_c, path_lookup, container_lookup, var_prefix, var_suffix);
1889                                 }
1890                                 if self.is_known_container(&resolved_path, is_ref) || self.is_path_transparent_container(&p.path, generics, is_ref) {
1891                                         if let syn::PathArguments::AngleBracketed(args) = &p.path.segments.iter().next().unwrap().arguments {
1892                                                 convert_container!(resolved_path, args.args.len(), || args.args.iter().map(|arg| {
1893                                                         if let syn::GenericArgument::Type(ty) = arg {
1894                                                                 ty
1895                                                         } else { unimplemented!(); }
1896                                                 }));
1897                                         } else { unimplemented!(); }
1898                                 }
1899                                 if self.is_primitive(&resolved_path) {
1900                                         false
1901                                 } else if let Some(ty_ident) = single_ident_generic_path_to_ident(&p.path) {
1902                                         if let Some((prefix, suffix)) = path_lookup(&resolved_path, is_ref) {
1903                                                 write!(w, "let mut local_{} = {}{}{};", ident, prefix, var, suffix).unwrap();
1904                                                 true
1905                                         } else if self.types.maybe_resolve_declared(ty_ident).is_some() {
1906                                                 false
1907                                         } else { false }
1908                                 } else { false }
1909                         },
1910                         syn::Type::Array(_) => {
1911                                 // We assume all arrays contain only primitive types.
1912                                 // This may result in some outputs not compiling.
1913                                 false
1914                         },
1915                         syn::Type::Slice(s) => {
1916                                 if let syn::Type::Path(p) = &*s.elem {
1917                                         let resolved = self.resolve_path(&p.path, generics);
1918                                         assert!(self.is_primitive(&resolved));
1919                                         let slice_path = format!("[{}]", resolved);
1920                                         if let Some((prefix, suffix)) = path_lookup(&slice_path, true) {
1921                                                 write!(w, "let mut local_{} = {}{}{};", ident, prefix, var, suffix).unwrap();
1922                                                 true
1923                                         } else { false }
1924                                 } else if let syn::Type::Reference(ty) = &*s.elem {
1925                                         let tyref = [&*ty.elem];
1926                                         is_ref = true;
1927                                         convert_container!("Slice", 1, || tyref.iter().map(|t| *t));
1928                                         unimplemented!("convert_container should return true as container_lookup should succeed for slices");
1929                                 } else if let syn::Type::Tuple(t) = &*s.elem {
1930                                         // When mapping into a temporary new var, we need to own all the underlying objects.
1931                                         // Thus, we drop any references inside the tuple and convert with non-reference types.
1932                                         let mut elems = syn::punctuated::Punctuated::new();
1933                                         for elem in t.elems.iter() {
1934                                                 if let syn::Type::Reference(r) = elem {
1935                                                         elems.push((*r.elem).clone());
1936                                                 } else {
1937                                                         elems.push(elem.clone());
1938                                                 }
1939                                         }
1940                                         let ty = [syn::Type::Tuple(syn::TypeTuple {
1941                                                 paren_token: t.paren_token, elems
1942                                         })];
1943                                         is_ref = false;
1944                                         ptr_for_ref = true;
1945                                         convert_container!("Slice", 1, || ty.iter());
1946                                         unimplemented!("convert_container should return true as container_lookup should succeed for slices");
1947                                 } else { unimplemented!() }
1948                         },
1949                         syn::Type::Tuple(t) => {
1950                                 if !t.elems.is_empty() {
1951                                         // We don't (yet) support tuple elements which cannot be converted inline
1952                                         write!(w, "let (").unwrap();
1953                                         for idx in 0..t.elems.len() {
1954                                                 if idx != 0 { write!(w, ", ").unwrap(); }
1955                                                 write!(w, "{} orig_{}_{}", if is_ref { "ref" } else { "mut" }, ident, idx).unwrap();
1956                                         }
1957                                         write!(w, ") = {}{}; ", var, if !to_c { ".to_rust()" } else { "" }).unwrap();
1958                                         // Like other template types, tuples are always mapped as their non-ref
1959                                         // versions for types which have different ref mappings. Thus, we convert to
1960                                         // non-ref versions and handle opaque types with inner pointers manually.
1961                                         for (idx, elem) in t.elems.iter().enumerate() {
1962                                                 if let syn::Type::Path(p) = elem {
1963                                                         let v_name = format!("orig_{}_{}", ident, idx);
1964                                                         let tuple_elem_ident = syn::Ident::new(&v_name, Span::call_site());
1965                                                         if self.write_conversion_new_var_intern(w, &tuple_elem_ident, &v_name, elem, generics,
1966                                                                         false, ptr_for_ref, to_c,
1967                                                                         path_lookup, container_lookup, var_prefix, var_suffix) {
1968                                                                 write!(w, " ").unwrap();
1969                                                                 // Opaque types with inner pointers shouldn't ever create new stack
1970                                                                 // variables, so we don't handle it and just assert that it doesn't
1971                                                                 // here.
1972                                                                 assert!(!self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)));
1973                                                         }
1974                                                 }
1975                                         }
1976                                         write!(w, "let mut local_{} = (", ident).unwrap();
1977                                         for (idx, elem) in t.elems.iter().enumerate() {
1978                                                 let ty_has_inner = {
1979                                                                 if to_c {
1980                                                                         // "To C ptr_for_ref" means "return the regular object with
1981                                                                         // is_owned set to false", which is totally what we want
1982                                                                         // if we're about to set ty_has_inner.
1983                                                                         ptr_for_ref = true;
1984                                                                 }
1985                                                                 if let syn::Type::Reference(t) = elem {
1986                                                                         if let syn::Type::Path(p) = &*t.elem {
1987                                                                                 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
1988                                                                         } else { false }
1989                                                                 } else if let syn::Type::Path(p) = elem {
1990                                                                         self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
1991                                                                 } else { false }
1992                                                         };
1993                                                 if idx != 0 { write!(w, ", ").unwrap(); }
1994                                                 var_prefix(w, elem, generics, is_ref && ty_has_inner, ptr_for_ref, false);
1995                                                 if is_ref && ty_has_inner {
1996                                                         // For ty_has_inner, the regular var_prefix mapping will take a
1997                                                         // reference, so deref once here to make sure we keep the original ref.
1998                                                         write!(w, "*").unwrap();
1999                                                 }
2000                                                 write!(w, "orig_{}_{}", ident, idx).unwrap();
2001                                                 if is_ref && !ty_has_inner {
2002                                                         // If we don't have an inner variable's reference to maintain, just
2003                                                         // hope the type is Clonable and use that.
2004                                                         write!(w, ".clone()").unwrap();
2005                                                 }
2006                                                 var_suffix(w, elem, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2007                                         }
2008                                         write!(w, "){};", if to_c { ".into()" } else { "" }).unwrap();
2009                                         true
2010                                 } else { false }
2011                         },
2012                         _ => unimplemented!(),
2013                 }
2014         }
2015
2016         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) -> bool {
2017                 self.write_conversion_new_var_intern(w, ident, var_access, t, generics, false, ptr_for_ref, true,
2018                         &|a, b| self.to_c_conversion_new_var_from_path(a, b),
2019                         &|a, b, c, d, e| self.to_c_conversion_container_new_var(generics, a, b, c, d, e),
2020                         // We force ptr_for_ref here since we can't generate a ref on one line and use it later
2021                         &|a, b, c, d, e, f| self.write_to_c_conversion_inline_prefix_inner(a, b, c, d, e, f),
2022                         &|a, b, c, d, e, f| self.write_to_c_conversion_inline_suffix_inner(a, b, c, d, e, f))
2023         }
2024         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 {
2025                 self.write_to_c_conversion_new_var_inner(w, ident, &format!("{}", ident), t, generics, ptr_for_ref)
2026         }
2027         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 {
2028                 self.write_conversion_new_var_intern(w, ident, &format!("{}", ident), t, generics, false, false, false,
2029                         &|a, b| self.from_c_conversion_new_var_from_path(a, b),
2030                         &|a, b, c, d, e| self.from_c_conversion_container_new_var(generics, a, b, c, d, e),
2031                         // We force ptr_for_ref here since we can't generate a ref on one line and use it later
2032                         &|a, b, c, d, e, _f| self.write_from_c_conversion_prefix_inner(a, b, c, d, e),
2033                         &|a, b, c, d, e, _f| self.write_from_c_conversion_suffix_inner(a, b, c, d, e))
2034         }
2035
2036         // ******************************************************
2037         // *** C Container Type Equivalent and alias Printing ***
2038         // ******************************************************
2039
2040         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 {
2041                 for (idx, t) in args.enumerate() {
2042                         if idx != 0 {
2043                                 write!(w, ", ").unwrap();
2044                         }
2045                         if let syn::Type::Reference(r_arg) = t {
2046                                 assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
2047
2048                                 if !self.write_c_type_intern(w, &*r_arg.elem, generics, false, false, false) { return false; }
2049
2050                                 // While write_c_type_intern, above is correct, we don't want to blindly convert a
2051                                 // reference to something stupid, so check that the container is either opaque or a
2052                                 // predefined type (currently only Transaction).
2053                                 if let syn::Type::Path(p_arg) = &*r_arg.elem {
2054                                         let resolved = self.resolve_path(&p_arg.path, generics);
2055                                         assert!(self.crate_types.opaques.get(&resolved).is_some() ||
2056                                                         self.c_type_from_path(&resolved, true, true).is_some(), "Template generics should be opaque or have a predefined mapping");
2057                                 } else { unimplemented!(); }
2058                         } else if let syn::Type::Path(p_arg) = t {
2059                                 if let Some(resolved) = self.maybe_resolve_path(&p_arg.path, generics) {
2060                                         if !self.is_primitive(&resolved) {
2061                                                 assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
2062                                         }
2063                                 } else {
2064                                         assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
2065                                 }
2066                                 if !self.write_c_type_intern(w, t, generics, false, false, false) { return false; }
2067                         } else {
2068                                 assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
2069                                 if !self.write_c_type_intern(w, t, generics, false, false, false) { return false; }
2070                         }
2071                 }
2072                 true
2073         }
2074         fn check_create_container(&self, mangled_container: String, container_type: &str, args: Vec<&syn::Type>, generics: Option<&GenericTypes>, is_ref: bool) -> bool {
2075                 if !self.crate_types.templates_defined.borrow().get(&mangled_container).is_some() {
2076                         let mut created_container: Vec<u8> = Vec::new();
2077
2078                         if container_type == "Result" {
2079                                 let mut a_ty: Vec<u8> = Vec::new();
2080                                 if let syn::Type::Tuple(tup) = args.iter().next().unwrap() {
2081                                         if tup.elems.is_empty() {
2082                                                 write!(&mut a_ty, "()").unwrap();
2083                                         } else {
2084                                                 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t).take(1), generics, is_ref) { return false; }
2085                                         }
2086                                 } else {
2087                                         if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t).take(1), generics, is_ref) { return false; }
2088                                 }
2089
2090                                 let mut b_ty: Vec<u8> = Vec::new();
2091                                 if let syn::Type::Tuple(tup) = args.iter().skip(1).next().unwrap() {
2092                                         if tup.elems.is_empty() {
2093                                                 write!(&mut b_ty, "()").unwrap();
2094                                         } else {
2095                                                 if !self.write_template_generics(&mut b_ty, &mut args.iter().map(|t| *t).skip(1), generics, is_ref) { return false; }
2096                                         }
2097                                 } else {
2098                                         if !self.write_template_generics(&mut b_ty, &mut args.iter().map(|t| *t).skip(1), generics, is_ref) { return false; }
2099                                 }
2100
2101                                 let ok_str = String::from_utf8(a_ty).unwrap();
2102                                 let err_str = String::from_utf8(b_ty).unwrap();
2103                                 let is_clonable = self.is_clonable(&ok_str) && self.is_clonable(&err_str);
2104                                 write_result_block(&mut created_container, &mangled_container, &ok_str, &err_str, is_clonable);
2105                                 if is_clonable {
2106                                         self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2107                                 }
2108                         } else if container_type == "Vec" {
2109                                 let mut a_ty: Vec<u8> = Vec::new();
2110                                 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t), generics, is_ref) { return false; }
2111                                 let ty = String::from_utf8(a_ty).unwrap();
2112                                 let is_clonable = self.is_clonable(&ty);
2113                                 write_vec_block(&mut created_container, &mangled_container, &ty, is_clonable);
2114                                 if is_clonable {
2115                                         self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2116                                 }
2117                         } else if container_type.ends_with("Tuple") {
2118                                 let mut tuple_args = Vec::new();
2119                                 let mut is_clonable = true;
2120                                 for arg in args.iter() {
2121                                         let mut ty: Vec<u8> = Vec::new();
2122                                         if !self.write_template_generics(&mut ty, &mut [arg].iter().map(|t| **t), generics, is_ref) { return false; }
2123                                         let ty_str = String::from_utf8(ty).unwrap();
2124                                         if !self.is_clonable(&ty_str) {
2125                                                 is_clonable = false;
2126                                         }
2127                                         tuple_args.push(ty_str);
2128                                 }
2129                                 write_tuple_block(&mut created_container, &mangled_container, &tuple_args, is_clonable);
2130                                 if is_clonable {
2131                                         self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2132                                 }
2133                         } else if container_type == "Option" {
2134                                 let mut a_ty: Vec<u8> = Vec::new();
2135                                 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t), generics, is_ref) { return false; }
2136                                 let ty = String::from_utf8(a_ty).unwrap();
2137                                 let is_clonable = self.is_clonable(&ty);
2138                                 write_option_block(&mut created_container, &mangled_container, &ty, is_clonable);
2139                                 if is_clonable {
2140                                         self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2141                                 }
2142                         } else {
2143                                 unreachable!();
2144                         }
2145                         self.crate_types.write_new_template(mangled_container.clone(), true, &created_container);
2146                 }
2147                 true
2148         }
2149         fn path_to_generic_args(path: &syn::Path) -> Vec<&syn::Type> {
2150                 if let syn::PathArguments::AngleBracketed(args) = &path.segments.iter().next().unwrap().arguments {
2151                         args.args.iter().map(|gen| if let syn::GenericArgument::Type(t) = gen { t } else { unimplemented!() }).collect()
2152                 } else { unimplemented!(); }
2153         }
2154         fn write_c_mangled_container_path_intern<W: std::io::Write>
2155                         (&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 {
2156                 let mut mangled_type: Vec<u8> = Vec::new();
2157                 if !self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a)) {
2158                         write!(w, "C{}_", ident).unwrap();
2159                         write!(mangled_type, "C{}_", ident).unwrap();
2160                 } else { assert_eq!(args.len(), 1); }
2161                 for arg in args.iter() {
2162                         macro_rules! write_path {
2163                                 ($p_arg: expr, $extra_write: expr) => {
2164                                         if let Some(subtype) = self.maybe_resolve_path(&$p_arg.path, generics) {
2165                                                 if self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a)) {
2166                                                         if !in_type {
2167                                                                 if self.c_type_has_inner_from_path(&subtype) {
2168                                                                         if !self.write_c_path_intern(w, &$p_arg.path, generics, is_ref, is_mut, ptr_for_ref) { return false; }
2169                                                                 } else {
2170                                                                         if let Some(arr_ty) = self.is_real_type_array(&subtype) {
2171                                                                                 if !self.write_c_type_intern(w, &arr_ty, generics, false, true, false) { return false; }
2172                                                                         } else {
2173                                                                                 // Option<T> needs to be converted to a *mut T, ie mut ptr-for-ref
2174                                                                                 if !self.write_c_path_intern(w, &$p_arg.path, generics, true, true, true) { return false; }
2175                                                                         }
2176                                                                 }
2177                                                         } else {
2178                                                                 write!(w, "{}", $p_arg.path.segments.last().unwrap().ident).unwrap();
2179                                                         }
2180                                                 } else if self.is_known_container(&subtype, is_ref) || self.is_path_transparent_container(&$p_arg.path, generics, is_ref) {
2181                                                         if !self.write_c_mangled_container_path_intern(w, Self::path_to_generic_args(&$p_arg.path), generics,
2182                                                                         &subtype, is_ref, is_mut, ptr_for_ref, true) {
2183                                                                 return false;
2184                                                         }
2185                                                         self.write_c_mangled_container_path_intern(&mut mangled_type, Self::path_to_generic_args(&$p_arg.path),
2186                                                                 generics, &subtype, is_ref, is_mut, ptr_for_ref, true);
2187                                                         if let Some(w2) = $extra_write as Option<&mut Vec<u8>> {
2188                                                                 self.write_c_mangled_container_path_intern(w2, Self::path_to_generic_args(&$p_arg.path),
2189                                                                         generics, &subtype, is_ref, is_mut, ptr_for_ref, true);
2190                                                         }
2191                                                 } else {
2192                                                         let id = subtype.rsplitn(2, ':').next().unwrap(); // Get the "Base" name of the resolved type
2193                                                         write!(w, "{}", id).unwrap();
2194                                                         write!(mangled_type, "{}", id).unwrap();
2195                                                         if let Some(w2) = $extra_write as Option<&mut Vec<u8>> {
2196                                                                 write!(w2, "{}", id).unwrap();
2197                                                         }
2198                                                 }
2199                                         } else { return false; }
2200                                 }
2201                         }
2202                         if let syn::Type::Tuple(tuple) = arg {
2203                                 if tuple.elems.len() == 0 {
2204                                         write!(w, "None").unwrap();
2205                                         write!(mangled_type, "None").unwrap();
2206                                 } else {
2207                                         let mut mangled_tuple_type: Vec<u8> = Vec::new();
2208
2209                                         // Figure out what the mangled type should look like. To disambiguate
2210                                         // ((A, B), C) and (A, B, C) we prefix the generic args with a _ and suffix
2211                                         // them with a Z. Ideally we wouldn't use Z, but not many special chars are
2212                                         // available for use in type names.
2213                                         write!(w, "C{}Tuple_", tuple.elems.len()).unwrap();
2214                                         write!(mangled_type, "C{}Tuple_", tuple.elems.len()).unwrap();
2215                                         write!(mangled_tuple_type, "C{}Tuple_", tuple.elems.len()).unwrap();
2216                                         for elem in tuple.elems.iter() {
2217                                                 if let syn::Type::Path(p) = elem {
2218                                                         write_path!(p, Some(&mut mangled_tuple_type));
2219                                                 } else if let syn::Type::Reference(refelem) = elem {
2220                                                         if let syn::Type::Path(p) = &*refelem.elem {
2221                                                                 write_path!(p, Some(&mut mangled_tuple_type));
2222                                                         } else { return false; }
2223                                                 } else { return false; }
2224                                         }
2225                                         write!(w, "Z").unwrap();
2226                                         write!(mangled_type, "Z").unwrap();
2227                                         write!(mangled_tuple_type, "Z").unwrap();
2228                                         if !self.check_create_container(String::from_utf8(mangled_tuple_type).unwrap(),
2229                                                         &format!("{}Tuple", tuple.elems.len()), tuple.elems.iter().collect(), generics, is_ref) {
2230                                                 return false;
2231                                         }
2232                                 }
2233                         } else if let syn::Type::Path(p_arg) = arg {
2234                                 write_path!(p_arg, None);
2235                         } else if let syn::Type::Reference(refty) = arg {
2236                                 if let syn::Type::Path(p_arg) = &*refty.elem {
2237                                         write_path!(p_arg, None);
2238                                 } else if let syn::Type::Slice(_) = &*refty.elem {
2239                                         // write_c_type will actually do exactly what we want here, we just need to
2240                                         // make it a pointer so that its an option. Note that we cannot always convert
2241                                         // the Vec-as-slice (ie non-ref types) containers, so sometimes need to be able
2242                                         // to edit it, hence we use *mut here instead of *const.
2243                                         if args.len() != 1 { return false; }
2244                                         write!(w, "*mut ").unwrap();
2245                                         self.write_c_type(w, arg, None, true);
2246                                 } else { return false; }
2247                         } else if let syn::Type::Array(a) = arg {
2248                                 if let syn::Type::Path(p_arg) = &*a.elem {
2249                                         let resolved = self.resolve_path(&p_arg.path, generics);
2250                                         if !self.is_primitive(&resolved) { return false; }
2251                                         if let syn::Expr::Lit(syn::ExprLit { lit: syn::Lit::Int(len), .. }) = &a.len {
2252                                                 if self.c_type_from_path(&format!("[{}; {}]", resolved, len.base10_digits()), is_ref, ptr_for_ref).is_none() { return false; }
2253                                                 write!(w, "_{}{}", resolved, len.base10_digits()).unwrap();
2254                                                 write!(mangled_type, "_{}{}", resolved, len.base10_digits()).unwrap();
2255                                         } else { return false; }
2256                                 } else { return false; }
2257                         } else { return false; }
2258                 }
2259                 if self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a)) { return true; }
2260                 // Push the "end of type" Z
2261                 write!(w, "Z").unwrap();
2262                 write!(mangled_type, "Z").unwrap();
2263
2264                 // Make sure the type is actually defined:
2265                 self.check_create_container(String::from_utf8(mangled_type).unwrap(), ident, args, generics, is_ref)
2266         }
2267         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 {
2268                 if !self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a)) {
2269                         write!(w, "{}::", Self::generated_container_path()).unwrap();
2270                 }
2271                 self.write_c_mangled_container_path_intern(w, args, generics, ident, is_ref, is_mut, ptr_for_ref, false)
2272         }
2273
2274         // **********************************
2275         // *** C Type Equivalent Printing ***
2276         // **********************************
2277
2278         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) -> bool {
2279                 let full_path = match self.maybe_resolve_path(&path, generics) {
2280                         Some(path) => path, None => return false };
2281                 if let Some(c_type) = self.c_type_from_path(&full_path, is_ref, ptr_for_ref) {
2282                         write!(w, "{}", c_type).unwrap();
2283                         true
2284                 } else if self.crate_types.traits.get(&full_path).is_some() {
2285                         if is_ref && ptr_for_ref {
2286                                 write!(w, "*{} crate::{}", if is_mut { "mut" } else { "const" }, full_path).unwrap();
2287                         } else if is_ref {
2288                                 write!(w, "&{}crate::{}", if is_mut { "mut " } else { "" }, full_path).unwrap();
2289                         } else {
2290                                 write!(w, "crate::{}", full_path).unwrap();
2291                         }
2292                         true
2293                 } else if self.crate_types.opaques.get(&full_path).is_some() || self.crate_types.mirrored_enums.get(&full_path).is_some() {
2294                         if is_ref && ptr_for_ref {
2295                                 // ptr_for_ref implies we're returning the object, which we can't really do for
2296                                 // opaque or mirrored types without box'ing them, which is quite a waste, so return
2297                                 // the actual object itself (for opaque types we'll set the pointer to the actual
2298                                 // type and note that its a reference).
2299                                 write!(w, "crate::{}", full_path).unwrap();
2300                         } else if is_ref {
2301                                 write!(w, "&{}crate::{}", if is_mut { "mut " } else { "" }, full_path).unwrap();
2302                         } else {
2303                                 write!(w, "crate::{}", full_path).unwrap();
2304                         }
2305                         true
2306                 } else {
2307                         false
2308                 }
2309         }
2310         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) -> bool {
2311                 match t {
2312                         syn::Type::Path(p) => {
2313                                 if p.qself.is_some() {
2314                                         return false;
2315                                 }
2316                                 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
2317                                         if self.is_known_container(&full_path, is_ref) || self.is_path_transparent_container(&p.path, generics, is_ref) {
2318                                                 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);
2319                                         }
2320                                         if let Some(aliased_type) = self.crate_types.type_aliases.get(&full_path).cloned() {
2321                                                 return self.write_c_type_intern(w, &aliased_type, None, is_ref, is_mut, ptr_for_ref);
2322                                         }
2323                                 }
2324                                 self.write_c_path_intern(w, &p.path, generics, is_ref, is_mut, ptr_for_ref)
2325                         },
2326                         syn::Type::Reference(r) => {
2327                                 self.write_c_type_intern(w, &*r.elem, generics, true, r.mutability.is_some(), ptr_for_ref)
2328                         },
2329                         syn::Type::Array(a) => {
2330                                 if is_ref && is_mut {
2331                                         write!(w, "*mut [").unwrap();
2332                                         if !self.write_c_type_intern(w, &a.elem, generics, false, false, ptr_for_ref) { return false; }
2333                                 } else if is_ref {
2334                                         write!(w, "*const [").unwrap();
2335                                         if !self.write_c_type_intern(w, &a.elem, generics, false, false, ptr_for_ref) { return false; }
2336                                 } else {
2337                                         let mut typecheck = Vec::new();
2338                                         if !self.write_c_type_intern(&mut typecheck, &a.elem, generics, false, false, ptr_for_ref) { return false; }
2339                                         if typecheck[..] != ['u' as u8, '8' as u8] { return false; }
2340                                 }
2341                                 if let syn::Expr::Lit(l) = &a.len {
2342                                         if let syn::Lit::Int(i) = &l.lit {
2343                                                 if !is_ref {
2344                                                         if let Some(ty) = self.c_type_from_path(&format!("[u8; {}]", i.base10_digits()), false, ptr_for_ref) {
2345                                                                 write!(w, "{}", ty).unwrap();
2346                                                                 true
2347                                                         } else { false }
2348                                                 } else {
2349                                                         write!(w, "; {}]", i).unwrap();
2350                                                         true
2351                                                 }
2352                                         } else { false }
2353                                 } else { false }
2354                         }
2355                         syn::Type::Slice(s) => {
2356                                 if !is_ref || is_mut { return false; }
2357                                 if let syn::Type::Path(p) = &*s.elem {
2358                                         let resolved = self.resolve_path(&p.path, generics);
2359                                         if self.is_primitive(&resolved) {
2360                                                 write!(w, "{}::{}slice", Self::container_templ_path(), resolved).unwrap();
2361                                                 true
2362                                         } else { false }
2363                                 } else if let syn::Type::Reference(r) = &*s.elem {
2364                                         if let syn::Type::Path(p) = &*r.elem {
2365                                                 // Slices with "real types" inside are mapped as the equivalent non-ref Vec
2366                                                 let resolved = self.resolve_path(&p.path, generics);
2367                                                 let mangled_container = if let Some(ident) = self.crate_types.opaques.get(&resolved) {
2368                                                         format!("CVec_{}Z", ident)
2369                                                 } else if let Some(en) = self.crate_types.mirrored_enums.get(&resolved) {
2370                                                         format!("CVec_{}Z", en.ident)
2371                                                 } else if let Some(id) = p.path.get_ident() {
2372                                                         format!("CVec_{}Z", id)
2373                                                 } else { return false; };
2374                                                 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
2375                                                 self.check_create_container(mangled_container, "Vec", vec![&*r.elem], generics, false)
2376                                         } else { false }
2377                                 } else if let syn::Type::Tuple(_) = &*s.elem {
2378                                         let mut args = syn::punctuated::Punctuated::new();
2379                                         args.push(syn::GenericArgument::Type((*s.elem).clone()));
2380                                         let mut segments = syn::punctuated::Punctuated::new();
2381                                         segments.push(syn::PathSegment {
2382                                                 ident: syn::Ident::new("Vec", Span::call_site()),
2383                                                 arguments: syn::PathArguments::AngleBracketed(syn::AngleBracketedGenericArguments {
2384                                                         colon2_token: None, lt_token: syn::Token![<](Span::call_site()), args, gt_token: syn::Token![>](Span::call_site()),
2385                                                 })
2386                                         });
2387                                         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)
2388                                 } else { false }
2389                         },
2390                         syn::Type::Tuple(t) => {
2391                                 if t.elems.len() == 0 {
2392                                         true
2393                                 } else {
2394                                         self.write_c_mangled_container_path(w, t.elems.iter().collect(), generics,
2395                                                 &format!("{}Tuple", t.elems.len()), is_ref, is_mut, ptr_for_ref)
2396                                 }
2397                         },
2398                         _ => false,
2399                 }
2400         }
2401         pub fn write_c_type<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, ptr_for_ref: bool) {
2402                 assert!(self.write_c_type_intern(w, t, generics, false, false, ptr_for_ref));
2403         }
2404         pub fn understood_c_path(&self, p: &syn::Path) -> bool {
2405                 if p.leading_colon.is_some() { return false; }
2406                 self.write_c_path_intern(&mut std::io::sink(), p, None, false, false, false)
2407         }
2408         pub fn understood_c_type(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> bool {
2409                 self.write_c_type_intern(&mut std::io::sink(), t, generics, false, false, false)
2410         }
2411 }