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