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