1 // This file is Copyright its original authors, visible in version control
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
9 use std::cell::RefCell;
10 use std::collections::{HashMap, HashSet};
17 use proc_macro2::{TokenTree, Span};
18 use quote::format_ident;
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.
24 pub fn first_seg_self<'a>(t: &'a syn::Type) -> Option<impl Iterator<Item=&syn::PathSegment> + 'a> {
26 syn::Type::Path(p) => {
27 if p.qself.is_some() || p.path.leading_colon.is_some() {
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" {
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; }
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"
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)
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; }
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,
76 syn::Path { leading_colon: Some(syn::Token![::](Span::call_site())), segments }
79 #[derive(Debug, PartialEq)]
80 pub enum ExportStatus {
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
87 /// Concretly, this means that we do not implement the Rust trait for the C trait struct.
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() {
97 TokenTree::Punct(c) if c.as_char() == '=' => {
98 // Really not sure where syn gets '=' from here -
99 // it somehow represents '///' or '//!'
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() {
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() {
114 _ => all_test = false,
116 } else if let TokenTree::Literal(lit) = token {
117 if format!("{}", lit) != "fuzztarget" {
122 if all_test { return ExportStatus::TestOnly; }
124 } else if i == "test" {
125 return ExportStatus::TestOnly;
129 continue; // eg #[derive()]
131 _ => unimplemented!(),
134 match token_iter.next().unwrap() {
135 TokenTree::Literal(lit) => {
136 let line = format!("{}", lit);
137 if line.contains("(C-not exported)") || line.contains("This is not exported to bindings users") {
138 return ExportStatus::NoExport;
139 } else if line.contains("(C-not implementable)") {
140 return ExportStatus::NotImplementable;
143 _ => unimplemented!(),
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!(); }
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,
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,
179 /// A stack of sets of generic resolutions.
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.
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).
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)>,
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(), }
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
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(), }
207 /// Learn the generics in generics in the current context, given a TypeResolver.
208 pub fn learn_generics_with_impls<'b, 'c>(&mut self, generics: &'a syn::Generics, impld_generics: &'a syn::PathArguments, types: &'b TypeResolver<'a, 'c>) -> bool {
209 let mut new_typed_generics = HashMap::new();
210 // First learn simple generics...
211 for (idx, generic) in generics.params.iter().enumerate() {
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, "Sized" => continue, _ => {} }
220 if path_matches_nongeneric(&trait_bound.path, &["core", "clone", "Clone"]) { continue; }
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 path == "core::fmt::Debug" {
227 // #[derive(Debug)] will add Debug bounds on each genericin the
228 // auto-generated impl. In cases where the existing generic
229 // bound already requires Debug this is redundant and should be
230 // ignored (which we do here). However, in cases where this is
231 // not redundant, this may cause spurious Debug impls which may
235 if non_lifetimes_processed { return false; }
236 non_lifetimes_processed = true;
237 if path != "std::ops::Deref" && path != "core::ops::Deref" &&
238 path != "std::ops::DerefMut" && path != "core::ops::DerefMut" {
239 let p = string_path_to_syn_path(&path);
240 let ref_ty = parse_quote!(&#p);
241 let mut_ref_ty = parse_quote!(&mut #p);
242 self.default_generics.insert(&type_param.ident, (syn::Type::Path(syn::TypePath { qself: None, path: p }), ref_ty, mut_ref_ty));
243 new_typed_generics.insert(&type_param.ident, Some(path));
245 // If we're templated on Deref<Target = ConcreteThing>, store
246 // the reference type in `default_generics` which handles full
247 // types and not just paths.
248 if let syn::PathArguments::AngleBracketed(ref args) =
249 trait_bound.path.segments[0].arguments {
250 assert_eq!(trait_bound.path.segments.len(), 1);
251 for subargument in args.args.iter() {
253 syn::GenericArgument::Lifetime(_) => {},
254 syn::GenericArgument::Binding(ref b) => {
255 if &format!("{}", b.ident) != "Target" { return false; }
257 self.default_generics.insert(&type_param.ident, (parse_quote!(&#default), parse_quote!(&#default), parse_quote!(&mut #default)));
260 _ => unimplemented!(),
264 new_typed_generics.insert(&type_param.ident, None);
270 if let Some(default) = type_param.default.as_ref() {
271 assert!(type_param.bounds.is_empty());
272 self.default_generics.insert(&type_param.ident, (default.clone(), parse_quote!(&#default), parse_quote!(&mut #default)));
273 } else if type_param.bounds.is_empty() {
274 if let syn::PathArguments::AngleBracketed(args) = impld_generics {
275 match &args.args[idx] {
276 syn::GenericArgument::Type(ty) => {
277 self.default_generics.insert(&type_param.ident, (ty.clone(), parse_quote!(&#ty), parse_quote!(&mut #ty)));
279 _ => unimplemented!(),
287 // Then find generics where we are required to pass a Deref<Target=X> and pretend its just X.
288 if let Some(wh) = &generics.where_clause {
289 for pred in wh.predicates.iter() {
290 if let syn::WherePredicate::Type(t) = pred {
291 if let syn::Type::Path(p) = &t.bounded_ty {
292 if first_seg_self(&t.bounded_ty).is_some() && p.path.segments.len() == 1 { continue; }
293 if p.qself.is_some() { return false; }
294 if p.path.leading_colon.is_some() { return false; }
295 let mut p_iter = p.path.segments.iter();
296 let p_ident = &p_iter.next().unwrap().ident;
297 if let Some(gen) = new_typed_generics.get_mut(p_ident) {
298 if gen.is_some() { return false; }
299 if &format!("{}", p_iter.next().unwrap().ident) != "Target" {return false; }
301 let mut non_lifetimes_processed = false;
302 for bound in t.bounds.iter() {
303 if let syn::TypeParamBound::Trait(trait_bound) = bound {
304 if let Some(id) = trait_bound.path.get_ident() {
305 if format!("{}", id) == "Sized" { continue; }
306 if format!("{}", id) == "Send" { continue; }
307 if format!("{}", id) == "Sync" { continue; }
309 if non_lifetimes_processed { return false; }
310 non_lifetimes_processed = true;
311 assert_simple_bound(&trait_bound);
312 let resolved = types.resolve_path(&trait_bound.path, None);
313 let ty = syn::Type::Path(syn::TypePath {
314 qself: None, path: string_path_to_syn_path(&resolved)
316 let ref_ty = parse_quote!(&#ty);
317 let mut_ref_ty = parse_quote!(&mut #ty);
318 if types.crate_types.traits.get(&resolved).is_some() {
319 self.default_generics.insert(p_ident, (ty, ref_ty, mut_ref_ty));
321 self.default_generics.insert(p_ident, (ref_ty.clone(), ref_ty, mut_ref_ty));
324 *gen = Some(resolved);
327 } else { return false; }
328 } else { return false; }
332 for (key, value) in new_typed_generics.drain() {
333 if let Some(v) = value {
334 assert!(self.typed_generics.insert(key, v).is_none());
335 } else { return false; }
340 /// Learn the generics in generics in the current context, given a TypeResolver.
341 pub fn learn_generics<'b, 'c>(&mut self, generics: &'a syn::Generics, types: &'b TypeResolver<'a, 'c>) -> bool {
342 self.learn_generics_with_impls(generics, &syn::PathArguments::None, types)
345 /// Learn the associated types from the trait in the current context.
346 pub fn learn_associated_types<'b, 'c>(&mut self, t: &'a syn::ItemTrait, types: &'b TypeResolver<'a, 'c>) {
347 for item in t.items.iter() {
349 &syn::TraitItem::Type(ref t) => {
350 if t.default.is_some() || t.generics.lt_token.is_some() { unimplemented!(); }
351 let mut bounds_iter = t.bounds.iter();
353 match bounds_iter.next().unwrap() {
354 syn::TypeParamBound::Trait(tr) => {
355 assert_simple_bound(&tr);
356 if let Some(path) = types.maybe_resolve_path(&tr.path, None) {
357 if types.skip_path(&path) { continue; }
358 // In general we handle Deref<Target=X> as if it were just X (and
359 // implement Deref<Target=Self> for relevant types). We don't
360 // bother to implement it for associated types, however, so we just
361 // ignore such bounds.
362 if path != "std::ops::Deref" && path != "core::ops::Deref" &&
363 path != "std::ops::DerefMut" && path != "core::ops::DerefMut" {
364 self.typed_generics.insert(&t.ident, path);
366 let last_seg_args = &tr.path.segments.last().unwrap().arguments;
367 if let syn::PathArguments::AngleBracketed(args) = last_seg_args {
368 assert_eq!(args.args.len(), 1);
369 if let syn::GenericArgument::Binding(binding) = &args.args[0] {
370 assert_eq!(format!("{}", binding.ident), "Target");
371 if let syn::Type::Path(p) = &binding.ty {
372 // Note that we are assuming the order of type
373 // declarations here, but that should be easy
375 let real_path = self.maybe_resolve_path(&p.path).unwrap();
376 self.typed_generics.insert(&t.ident, real_path.clone());
377 } else { unimplemented!(); }
378 } else { unimplemented!(); }
379 } else { unimplemented!(); }
381 } else { unimplemented!(); }
382 for bound in bounds_iter {
383 if let syn::TypeParamBound::Trait(t) = bound {
384 // We only allow for `?Sized` here.
385 assert_eq!(t.path.segments.len(), 1);
386 assert_eq!(format!("{}", t.path.segments[0].ident), "Sized");
391 syn::TypeParamBound::Lifetime(_) => {},
400 /// Attempt to resolve a Path as a generic parameter and return the full path. as both a string
402 pub fn maybe_resolve_path<'b>(&'b self, path: &syn::Path) -> Option<&'b String> {
403 if let Some(ident) = path.get_ident() {
404 if let Some(ty) = &self.self_ty {
405 if format!("{}", ident) == "Self" {
409 if let Some(res) = self.typed_generics.get(ident) {
413 // Associated types are usually specified as "Self::Generic", so we check for that
415 let mut it = path.segments.iter();
416 if path.segments.len() == 2 && format!("{}", it.next().unwrap().ident) == "Self" {
417 let ident = &it.next().unwrap().ident;
418 if let Some(res) = self.typed_generics.get(ident) {
423 if let Some(parent) = self.parent {
424 parent.maybe_resolve_path(path)
431 pub trait ResolveType<'a> { fn resolve_type(&'a self, ty: &'a syn::Type) -> &'a syn::Type; }
432 impl<'a, 'b, 'c: 'a + 'b> ResolveType<'c> for Option<&GenericTypes<'a, 'b>> {
433 fn resolve_type(&'c self, ty: &'c syn::Type) -> &'c syn::Type {
434 if let Some(us) = self {
436 syn::Type::Path(p) => {
437 if let Some(ident) = p.path.get_ident() {
438 if let Some((ty, _, _)) = us.default_generics.get(ident) {
439 return self.resolve_type(ty);
443 syn::Type::Reference(syn::TypeReference { elem, mutability, .. }) => {
444 if let syn::Type::Path(p) = &**elem {
445 if let Some(ident) = p.path.get_ident() {
446 if let Some((_, refty, mut_ref_ty)) = us.default_generics.get(ident) {
447 if mutability.is_some() {
448 return self.resolve_type(mut_ref_ty);
450 return self.resolve_type(refty);
458 us.parent.resolve_type(ty)
463 #[derive(Clone, PartialEq)]
464 // The type of declaration and the object itself
465 pub enum DeclType<'a> {
467 Trait(&'a syn::ItemTrait),
468 StructImported { generics: &'a syn::Generics },
470 EnumIgnored { generics: &'a syn::Generics },
473 pub struct ImportResolver<'mod_lifetime, 'crate_lft: 'mod_lifetime> {
474 pub crate_name: &'mod_lifetime str,
475 library: &'crate_lft FullLibraryAST,
476 module_path: &'mod_lifetime str,
477 imports: HashMap<syn::Ident, (String, syn::Path)>,
478 declared: HashMap<syn::Ident, DeclType<'crate_lft>>,
479 priv_modules: HashSet<syn::Ident>,
481 impl<'mod_lifetime, 'crate_lft: 'mod_lifetime> ImportResolver<'mod_lifetime, 'crate_lft> {
482 fn walk_use_intern<F: FnMut(syn::Ident, (String, syn::Path))>(
483 crate_name: &str, module_path: &str, dependencies: &HashSet<syn::Ident>, u: &syn::UseTree,
485 mut path: syn::punctuated::Punctuated<syn::PathSegment, syn::token::Colon2>, handle_use: &mut F
488 macro_rules! push_path {
489 ($ident: expr, $path_suffix: expr) => {
490 if partial_path == "" && format!("{}", $ident) == "super" {
491 let mut mod_iter = module_path.rsplitn(2, "::");
492 mod_iter.next().unwrap();
493 let super_mod = mod_iter.next().unwrap();
494 new_path = format!("{}{}", super_mod, $path_suffix);
495 assert_eq!(path.len(), 0);
496 for module in super_mod.split("::") {
497 path.push(syn::PathSegment { ident: syn::Ident::new(module, Span::call_site()), arguments: syn::PathArguments::None });
499 } else if partial_path == "" && format!("{}", $ident) == "self" {
500 new_path = format!("{}{}", module_path, $path_suffix);
501 for module in module_path.split("::") {
502 path.push(syn::PathSegment { ident: syn::Ident::new(module, Span::call_site()), arguments: syn::PathArguments::None });
504 } else if partial_path == "" && format!("{}", $ident) == "crate" {
505 new_path = format!("{}{}", crate_name, $path_suffix);
506 let crate_name_ident = format_ident!("{}", crate_name);
507 path.push(parse_quote!(#crate_name_ident));
508 } else if partial_path == "" && !dependencies.contains(&$ident) {
509 new_path = format!("{}::{}{}", module_path, $ident, $path_suffix);
510 for module in module_path.split("::") {
511 path.push(syn::PathSegment { ident: syn::Ident::new(module, Span::call_site()), arguments: syn::PathArguments::None });
513 let ident_str = format_ident!("{}", $ident);
514 path.push(parse_quote!(#ident_str));
515 } else if format!("{}", $ident) == "self" {
516 let mut path_iter = partial_path.rsplitn(2, "::");
517 path_iter.next().unwrap();
518 new_path = path_iter.next().unwrap().to_owned();
520 new_path = format!("{}{}{}", partial_path, $ident, $path_suffix);
523 path.push(parse_quote!(#ident));
527 syn::UseTree::Path(p) => {
528 push_path!(p.ident, "::");
529 Self::walk_use_intern(crate_name, module_path, dependencies, &p.tree, &new_path, path, handle_use);
531 syn::UseTree::Name(n) => {
532 push_path!(n.ident, "");
533 let imported_ident = syn::Ident::new(new_path.rsplitn(2, "::").next().unwrap(), Span::call_site());
534 handle_use(imported_ident, (new_path, syn::Path { leading_colon: Some(syn::Token![::](Span::call_site())), segments: path }));
536 syn::UseTree::Group(g) => {
537 for i in g.items.iter() {
538 Self::walk_use_intern(crate_name, module_path, dependencies, i, partial_path, path.clone(), handle_use);
541 syn::UseTree::Rename(r) => {
542 push_path!(r.ident, "");
543 handle_use(r.rename.clone(), (new_path, syn::Path { leading_colon: Some(syn::Token![::](Span::call_site())), segments: path }));
545 syn::UseTree::Glob(_) => {
546 eprintln!("Ignoring * use for {} - this may result in resolution failures", partial_path);
551 fn process_use_intern(crate_name: &str, module_path: &str, dependencies: &HashSet<syn::Ident>,
552 imports: &mut HashMap<syn::Ident, (String, syn::Path)>, u: &syn::UseTree, partial_path: &str,
553 path: syn::punctuated::Punctuated<syn::PathSegment, syn::token::Colon2>
555 Self::walk_use_intern(crate_name, module_path, dependencies, u, partial_path, path,
556 &mut |k, v| { imports.insert(k, v); });
559 fn process_use(crate_name: &str, module_path: &str, dependencies: &HashSet<syn::Ident>, imports: &mut HashMap<syn::Ident, (String, syn::Path)>, u: &syn::ItemUse) {
560 if u.leading_colon.is_some() { eprintln!("Ignoring leading-colon use!"); return; }
561 Self::process_use_intern(crate_name, module_path, dependencies, imports, &u.tree, "", syn::punctuated::Punctuated::new());
564 fn insert_primitive(imports: &mut HashMap<syn::Ident, (String, syn::Path)>, id: &str) {
565 let ident = format_ident!("{}", id);
566 let path = parse_quote!(#ident);
567 imports.insert(ident, (id.to_owned(), path));
570 pub fn new(crate_name: &'mod_lifetime str, library: &'crate_lft FullLibraryAST, module_path: &'mod_lifetime str, contents: &'crate_lft [syn::Item]) -> Self {
571 Self::from_borrowed_items(crate_name, library, module_path, &contents.iter().map(|a| a).collect::<Vec<_>>())
573 pub fn from_borrowed_items(crate_name: &'mod_lifetime str, library: &'crate_lft FullLibraryAST, module_path: &'mod_lifetime str, contents: &[&'crate_lft syn::Item]) -> Self {
574 let mut imports = HashMap::new();
575 // Add primitives to the "imports" list:
576 Self::insert_primitive(&mut imports, "bool");
577 Self::insert_primitive(&mut imports, "u128");
578 Self::insert_primitive(&mut imports, "i64");
579 Self::insert_primitive(&mut imports, "f64");
580 Self::insert_primitive(&mut imports, "u64");
581 Self::insert_primitive(&mut imports, "u32");
582 Self::insert_primitive(&mut imports, "u16");
583 Self::insert_primitive(&mut imports, "u8");
584 Self::insert_primitive(&mut imports, "usize");
585 Self::insert_primitive(&mut imports, "str");
586 Self::insert_primitive(&mut imports, "String");
588 // These are here to allow us to print native Rust types in trait fn impls even if we don't
590 Self::insert_primitive(&mut imports, "Result");
591 Self::insert_primitive(&mut imports, "Vec");
592 Self::insert_primitive(&mut imports, "Option");
594 let mut declared = HashMap::new();
595 let mut priv_modules = HashSet::new();
597 for item in contents.iter() {
599 syn::Item::Use(u) => Self::process_use(crate_name, module_path, &library.dependencies, &mut imports, &u),
600 syn::Item::Struct(s) => {
601 if let syn::Visibility::Public(_) = s.vis {
602 match export_status(&s.attrs) {
603 ExportStatus::Export => { declared.insert(s.ident.clone(), DeclType::StructImported { generics: &s.generics }); },
604 ExportStatus::NoExport => { declared.insert(s.ident.clone(), DeclType::StructIgnored); },
605 ExportStatus::TestOnly => continue,
606 ExportStatus::NotImplementable => panic!("(C-not implementable) should only appear on traits!"),
610 syn::Item::Type(t) if export_status(&t.attrs) == ExportStatus::Export => {
611 if let syn::Visibility::Public(_) = t.vis {
612 declared.insert(t.ident.clone(), DeclType::StructImported { generics: &t.generics });
615 syn::Item::Enum(e) => {
616 if let syn::Visibility::Public(_) = e.vis {
617 match export_status(&e.attrs) {
618 ExportStatus::Export if is_enum_opaque(e) => { declared.insert(e.ident.clone(), DeclType::EnumIgnored { generics: &e.generics }); },
619 ExportStatus::Export => { declared.insert(e.ident.clone(), DeclType::MirroredEnum); },
620 ExportStatus::NotImplementable => panic!("(C-not implementable) should only appear on traits!"),
625 syn::Item::Trait(t) => {
626 if let syn::Visibility::Public(_) = t.vis {
627 declared.insert(t.ident.clone(), DeclType::Trait(t));
630 syn::Item::Mod(m) => {
631 priv_modules.insert(m.ident.clone());
637 Self { crate_name, library, module_path, imports, declared, priv_modules }
640 pub fn maybe_resolve_declared(&self, id: &syn::Ident) -> Option<&DeclType<'crate_lft>> {
641 self.declared.get(id)
644 pub fn maybe_resolve_ident(&self, id: &syn::Ident) -> Option<String> {
645 if let Some((imp, _)) = self.imports.get(id) {
647 } else if self.declared.get(id).is_some() {
648 Some(self.module_path.to_string() + "::" + &format!("{}", id))
652 fn maybe_resolve_imported_path(&self, p: &syn::Path, generics: Option<&GenericTypes>) -> Option<String> {
653 if let Some(gen_types) = generics {
654 if let Some(resp) = gen_types.maybe_resolve_path(p) {
655 return Some(resp.clone());
659 if p.leading_colon.is_some() {
660 let mut res: String = p.segments.iter().enumerate().map(|(idx, seg)| {
661 format!("{}{}", if idx == 0 { "" } else { "::" }, seg.ident)
663 let firstseg = p.segments.iter().next().unwrap();
664 if !self.library.dependencies.contains(&firstseg.ident) {
665 res = self.crate_name.to_owned() + "::" + &res;
668 } else if let Some(id) = p.get_ident() {
669 self.maybe_resolve_ident(id)
671 if p.segments.len() == 1 {
672 let seg = p.segments.iter().next().unwrap();
673 return self.maybe_resolve_ident(&seg.ident);
675 let mut seg_iter = p.segments.iter();
676 let first_seg = seg_iter.next().unwrap();
677 let remaining: String = seg_iter.map(|seg| {
678 format!("::{}", seg.ident)
680 let first_seg_str = format!("{}", first_seg.ident);
681 if let Some((imp, _)) = self.imports.get(&first_seg.ident) {
683 Some(imp.clone() + &remaining)
687 } else if let Some(_) = self.priv_modules.get(&first_seg.ident) {
688 Some(format!("{}::{}{}", self.module_path, first_seg.ident, remaining))
689 } else if first_seg_is_stdlib(&first_seg_str) || self.library.dependencies.contains(&first_seg.ident) {
690 Some(first_seg_str + &remaining)
691 } else if first_seg_str == "crate" {
692 Some(self.crate_name.to_owned() + &remaining)
693 } else if self.library.modules.get(&format!("{}::{}", self.module_path, first_seg.ident)).is_some() {
694 Some(format!("{}::{}{}", self.module_path, first_seg.ident, remaining))
699 pub fn maybe_resolve_path(&self, p: &syn::Path, generics: Option<&GenericTypes>) -> Option<String> {
700 self.maybe_resolve_imported_path(p, generics).map(|mut path| {
701 if path == "core::ops::Deref" || path == "core::ops::DerefMut" {
702 let last_seg = p.segments.last().unwrap();
703 if let syn::PathArguments::AngleBracketed(args) = &last_seg.arguments {
704 assert_eq!(args.args.len(), 1);
705 if let syn::GenericArgument::Binding(binding) = &args.args[0] {
706 if let syn::Type::Path(p) = &binding.ty {
707 if let Some(inner_ty) = self.maybe_resolve_path(&p.path, generics) {
708 let mut module_riter = inner_ty.rsplitn(2, "::");
709 let ty_ident = module_riter.next().unwrap();
710 let module_name = module_riter.next().unwrap();
711 let module = self.library.modules.get(module_name).unwrap();
712 for item in module.items.iter() {
714 syn::Item::Trait(t) => {
715 if t.ident == ty_ident {
724 } else { unimplemented!(); }
725 } else { unimplemented!(); }
729 // Now that we've resolved the path to the path as-imported, check whether the path
730 // is actually a pub(.*) use statement and map it to the real path.
731 let path_tmp = path.clone();
732 let crate_name = path_tmp.splitn(2, "::").next().unwrap();
733 let mut module_riter = path_tmp.rsplitn(2, "::");
734 let obj = module_riter.next().unwrap();
735 if let Some(module_path) = module_riter.next() {
736 if let Some(m) = self.library.modules.get(module_path) {
737 for item in m.items.iter() {
738 if let syn::Item::Use(syn::ItemUse { vis, tree, .. }) = item {
740 syn::Visibility::Public(_)|
741 syn::Visibility::Crate(_)|
742 syn::Visibility::Restricted(_) => {
743 Self::walk_use_intern(crate_name, module_path,
744 &self.library.dependencies, tree, "",
745 syn::punctuated::Punctuated::new(), &mut |ident, (use_path, _)| {
746 if format!("{}", ident) == obj {
751 syn::Visibility::Inherited => {},
763 /// Map all the Paths in a Type into absolute paths given a set of imports (generated via process_use_intern)
764 pub fn resolve_imported_refs(&self, mut ty: syn::Type) -> syn::Type {
766 syn::Type::Path(p) => {
767 if p.path.segments.len() != 1 { unimplemented!(); }
768 let mut args = p.path.segments[0].arguments.clone();
769 if let syn::PathArguments::AngleBracketed(ref mut generics) = &mut args {
770 for arg in generics.args.iter_mut() {
771 if let syn::GenericArgument::Type(ref mut t) = arg {
772 *t = self.resolve_imported_refs(t.clone());
776 if let Some((_, newpath)) = self.imports.get(single_ident_generic_path_to_ident(&p.path).unwrap()) {
777 p.path = newpath.clone();
779 p.path.segments[0].arguments = args;
781 syn::Type::Reference(r) => {
782 r.elem = Box::new(self.resolve_imported_refs((*r.elem).clone()));
784 syn::Type::Slice(s) => {
785 s.elem = Box::new(self.resolve_imported_refs((*s.elem).clone()));
787 syn::Type::Tuple(t) => {
788 for e in t.elems.iter_mut() {
789 *e = self.resolve_imported_refs(e.clone());
792 _ => unimplemented!(),
798 // templates_defined is walked to write the C++ header, so if we use the default hashing it get
799 // reordered on each genbindings run. Instead, we use SipHasher (which defaults to 0-keys) so that
800 // the sorting is stable across runs. It is deprecated, but the "replacement" doesn't actually
801 // accomplish the same goals, so we just ignore it.
803 pub type NonRandomHash = hash::BuildHasherDefault<hash::SipHasher>;
806 pub struct ASTModule {
807 pub attrs: Vec<syn::Attribute>,
808 pub items: Vec<syn::Item>,
809 pub submods: Vec<String>,
811 /// A struct containing the syn::File AST for each file in the crate.
812 pub struct FullLibraryAST {
813 pub modules: HashMap<String, ASTModule, NonRandomHash>,
814 pub dependencies: HashSet<syn::Ident>,
816 impl FullLibraryAST {
817 fn load_module(&mut self, module: String, attrs: Vec<syn::Attribute>, mut items: Vec<syn::Item>) {
818 let mut non_mod_items = Vec::with_capacity(items.len());
819 let mut submods = Vec::with_capacity(items.len());
820 for item in items.drain(..) {
822 syn::Item::Mod(m) if m.content.is_some() => {
823 if export_status(&m.attrs) == ExportStatus::Export {
824 if let syn::Visibility::Public(_) = m.vis {
825 let modident = format!("{}", m.ident);
826 let modname = if module != "" {
827 module.clone() + "::" + &modident
829 self.dependencies.insert(m.ident);
832 self.load_module(modname, m.attrs, m.content.unwrap().1);
833 submods.push(modident);
835 non_mod_items.push(syn::Item::Mod(m));
839 syn::Item::Mod(_) => panic!("--pretty=expanded output should never have non-body modules"),
840 syn::Item::ExternCrate(c) => {
841 if export_status(&c.attrs) == ExportStatus::Export {
842 self.dependencies.insert(c.ident);
845 _ => { non_mod_items.push(item); }
848 self.modules.insert(module, ASTModule { attrs, items: non_mod_items, submods });
851 pub fn load_lib(lib: syn::File) -> Self {
852 assert_eq!(export_status(&lib.attrs), ExportStatus::Export);
853 let mut res = Self { modules: HashMap::default(), dependencies: HashSet::new() };
854 res.load_module("".to_owned(), lib.attrs, lib.items);
859 /// List of manually-generated types which are clonable
860 fn initial_clonable_types() -> HashSet<String> {
861 let mut res = HashSet::new();
862 res.insert("crate::c_types::U5".to_owned());
863 res.insert("crate::c_types::U128".to_owned());
864 res.insert("crate::c_types::FourBytes".to_owned());
865 res.insert("crate::c_types::TwelveBytes".to_owned());
866 res.insert("crate::c_types::SixteenBytes".to_owned());
867 res.insert("crate::c_types::TwentyBytes".to_owned());
868 res.insert("crate::c_types::ThirtyTwoBytes".to_owned());
869 res.insert("crate::c_types::EightU16s".to_owned());
870 res.insert("crate::c_types::SecretKey".to_owned());
871 res.insert("crate::c_types::PublicKey".to_owned());
872 res.insert("crate::c_types::Transaction".to_owned());
873 res.insert("crate::c_types::Witness".to_owned());
874 res.insert("crate::c_types::WitnessVersion".to_owned());
875 res.insert("crate::c_types::WitnessProgram".to_owned());
876 res.insert("crate::c_types::TxIn".to_owned());
877 res.insert("crate::c_types::TxOut".to_owned());
878 res.insert("crate::c_types::ECDSASignature".to_owned());
879 res.insert("crate::c_types::SchnorrSignature".to_owned());
880 res.insert("crate::c_types::RecoverableSignature".to_owned());
881 res.insert("crate::c_types::BigEndianScalar".to_owned());
882 res.insert("crate::c_types::Bech32Error".to_owned());
883 res.insert("crate::c_types::Secp256k1Error".to_owned());
884 res.insert("crate::c_types::IOError".to_owned());
885 res.insert("crate::c_types::Error".to_owned());
886 res.insert("crate::c_types::Str".to_owned());
888 // Because some types are manually-mapped to CVec_u8Z we may end up checking if its clonable
889 // before we ever get to constructing the type fully via
890 // `write_c_mangled_container_path_intern` (which will add it here too), so we have to manually
891 // add it on startup.
892 res.insert("crate::c_types::derived::CVec_u8Z".to_owned());
896 /// Top-level struct tracking everything which has been defined while walking the crate.
897 pub struct CrateTypes<'a> {
898 /// This may contain structs or enums, but only when either is mapped as
899 /// struct X { inner: *mut originalX, .. }
900 pub opaques: HashMap<String, (&'a syn::Ident, &'a syn::Generics)>,
901 /// structs that weren't exposed
902 pub priv_structs: HashMap<String, &'a syn::Generics>,
903 /// Enums which are mapped as C enums with conversion functions
904 pub mirrored_enums: HashMap<String, &'a syn::ItemEnum>,
905 /// Traits which are mapped as a pointer + jump table
906 pub traits: HashMap<String, &'a syn::ItemTrait>,
907 /// Aliases from paths to some other Type
908 pub type_aliases: HashMap<String, syn::Type>,
909 /// Value is an alias to Key (maybe with some generics)
910 pub reverse_alias_map: HashMap<String, Vec<(String, syn::PathArguments)>>,
911 /// Template continer types defined, map from mangled type name -> whether a destructor fn
914 /// This is used at the end of processing to make C++ wrapper classes
915 pub templates_defined: RefCell<HashMap<String, bool, NonRandomHash>>,
916 /// The output file for any created template container types, written to as we find new
917 /// template containers which need to be defined.
918 template_file: RefCell<&'a mut File>,
919 /// Set of containers which are clonable
920 clonable_types: RefCell<HashSet<String>>,
922 pub trait_impls: HashMap<String, Vec<String>>,
924 pub traits_impld: HashMap<String, Vec<String>>,
925 /// The full set of modules in the crate(s)
926 pub lib_ast: &'a FullLibraryAST,
929 impl<'a> CrateTypes<'a> {
930 pub fn new(template_file: &'a mut File, libast: &'a FullLibraryAST) -> Self {
932 opaques: HashMap::new(), mirrored_enums: HashMap::new(), traits: HashMap::new(),
933 type_aliases: HashMap::new(), reverse_alias_map: HashMap::new(),
934 templates_defined: RefCell::new(HashMap::default()), priv_structs: HashMap::new(),
935 clonable_types: RefCell::new(initial_clonable_types()),
936 trait_impls: HashMap::new(), traits_impld: HashMap::new(),
937 template_file: RefCell::new(template_file), lib_ast: &libast,
940 pub fn set_clonable(&self, object: String) {
941 self.clonable_types.borrow_mut().insert(object);
943 pub fn is_clonable(&self, object: &str) -> bool {
944 self.clonable_types.borrow().contains(object)
946 pub fn write_new_template(&self, mangled_container: String, has_destructor: bool, created_container: &[u8]) {
947 self.template_file.borrow_mut().write(created_container).unwrap();
948 self.templates_defined.borrow_mut().insert(mangled_container, has_destructor);
952 /// A struct which tracks resolving rust types into C-mapped equivalents, exists for one specific
953 /// module but contains a reference to the overall CrateTypes tracking.
954 pub struct TypeResolver<'mod_lifetime, 'crate_lft: 'mod_lifetime> {
955 pub module_path: &'mod_lifetime str,
956 pub crate_types: &'mod_lifetime CrateTypes<'crate_lft>,
957 pub types: ImportResolver<'mod_lifetime, 'crate_lft>,
960 /// Returned by write_empty_rust_val_check_suffix to indicate what type of dereferencing needs to
961 /// happen to get the inner value of a generic.
962 enum EmptyValExpectedTy {
963 /// A type which has a flag for being empty (eg an array where we treat all-0s as empty).
965 /// A Option mapped as a COption_*Z
967 /// A pointer which we want to convert to a reference.
972 /// Describes the appropriate place to print a general type-conversion string when converting a
974 enum ContainerPrefixLocation {
975 /// Prints a general type-conversion string prefix and suffix outside of the
976 /// container-conversion strings.
978 /// Prints a general type-conversion string prefix and suffix inside of the
979 /// container-conversion strings.
981 /// Does not print the usual type-conversion string prefix and suffix.
985 impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
986 pub fn new(module_path: &'a str, types: ImportResolver<'a, 'c>, crate_types: &'a CrateTypes<'c>) -> Self {
987 Self { module_path, types, crate_types }
990 // *************************************************
991 // *** Well know type and conversion definitions ***
992 // *************************************************
994 /// Returns true we if can just skip passing this to C entirely
995 pub fn skip_path(&self, full_path: &str) -> bool {
996 full_path == "bitcoin::secp256k1::Secp256k1" ||
997 full_path == "bitcoin::secp256k1::Signing" ||
998 full_path == "bitcoin::secp256k1::Verification"
1000 /// Returns true we if can just skip passing this to C entirely
1001 fn no_arg_path_to_rust(&self, full_path: &str) -> &str {
1002 if full_path == "bitcoin::secp256k1::Secp256k1" {
1003 "secp256k1::global::SECP256K1"
1004 } else { unimplemented!(); }
1007 /// Returns true if the object is a primitive and is mapped as-is with no conversion
1009 pub fn is_primitive(&self, full_path: &str) -> bool {
1022 pub fn is_clonable(&self, ty: &str) -> bool {
1023 if self.crate_types.is_clonable(ty) { return true; }
1024 if self.is_primitive(ty) { return true; }
1030 /// Gets the C-mapped type for types which are outside of the crate, or which are manually
1031 /// ignored by for some reason need mapping anyway.
1032 fn c_type_from_path<'b>(&self, full_path: &'b str, is_ref: bool, _ptr_for_ref: bool) -> Option<&'b str> {
1033 if self.is_primitive(full_path) {
1034 return Some(full_path);
1037 // Note that no !is_ref types can map to an array because Rust and C's call semantics
1038 // for arrays are different (https://github.com/eqrion/cbindgen/issues/528)
1040 "[u8; 32]" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
1041 "[u8; 20]" if !is_ref => Some("crate::c_types::TwentyBytes"),
1042 "[u8; 16]" if !is_ref => Some("crate::c_types::SixteenBytes"),
1043 "[u8; 12]" if !is_ref => Some("crate::c_types::TwelveBytes"),
1044 "[u8; 4]" if !is_ref => Some("crate::c_types::FourBytes"),
1045 "[u8; 3]" if !is_ref => Some("crate::c_types::ThreeBytes"), // Used for RGB values
1046 "[u16; 32]" if !is_ref => Some("crate::c_types::ThirtyTwoU16s"),
1048 "str" if is_ref => Some("crate::c_types::Str"),
1049 "alloc::string::String"|"String"|"std::path::PathBuf" => Some("crate::c_types::Str"),
1051 "bitcoin::Address" => Some("crate::c_types::Str"),
1053 "std::time::Duration"|"core::time::Duration" => Some("u64"),
1054 "std::time::SystemTime" => Some("u64"),
1055 "std::io::Error"|"lightning::io::Error"|"lightning::io::ErrorKind" => Some("crate::c_types::IOError"),
1056 "core::fmt::Arguments" if is_ref => Some("crate::c_types::Str"),
1058 "core::convert::Infallible" => Some("crate::c_types::NotConstructable"),
1060 "bitcoin::bech32::Error"|"bech32::Error"
1061 if !is_ref => Some("crate::c_types::Bech32Error"),
1062 "bitcoin::secp256k1::Error"|"secp256k1::Error"
1063 if !is_ref => Some("crate::c_types::Secp256k1Error"),
1065 "core::num::ParseIntError" => Some("crate::c_types::Error"),
1066 "core::str::Utf8Error" => Some("crate::c_types::Error"),
1068 "bitcoin::bech32::u5"|"bech32::u5" => Some("crate::c_types::U5"),
1069 "u128" => Some("crate::c_types::U128"),
1070 "core::num::NonZeroU8" => Some("u8"),
1072 "secp256k1::PublicKey"|"bitcoin::secp256k1::PublicKey" => Some("crate::c_types::PublicKey"),
1073 "bitcoin::secp256k1::ecdsa::Signature" => Some("crate::c_types::ECDSASignature"),
1074 "bitcoin::secp256k1::schnorr::Signature" => Some("crate::c_types::SchnorrSignature"),
1075 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some("crate::c_types::RecoverableSignature"),
1076 "bitcoin::secp256k1::SecretKey" if is_ref => Some("*const [u8; 32]"),
1077 "bitcoin::secp256k1::SecretKey" if !is_ref => Some("crate::c_types::SecretKey"),
1078 "bitcoin::secp256k1::KeyPair" if !is_ref => Some("crate::c_types::SecretKey"),
1079 "bitcoin::secp256k1::Scalar" if is_ref => Some("*const crate::c_types::BigEndianScalar"),
1080 "bitcoin::secp256k1::Scalar" if !is_ref => Some("crate::c_types::BigEndianScalar"),
1081 "bitcoin::secp256k1::ecdh::SharedSecret" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
1083 "bitcoin::blockdata::script::Script"|"bitcoin::Script" => Some("crate::c_types::u8slice"),
1084 "bitcoin::blockdata::script::ScriptBuf"|"bitcoin::ScriptBuf" => Some("crate::c_types::derived::CVec_u8Z"),
1085 "bitcoin::OutPoint"|"bitcoin::blockdata::transaction::OutPoint" => Some("crate::lightning::chain::transaction::OutPoint"),
1086 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some("crate::c_types::Transaction"),
1087 "bitcoin::Witness" => Some("crate::c_types::Witness"),
1088 "bitcoin::TxIn"|"bitcoin::blockdata::transaction::TxIn" if !is_ref => Some("crate::c_types::TxIn"),
1089 "bitcoin::TxOut"|"bitcoin::blockdata::transaction::TxOut" => Some("crate::c_types::TxOut"),
1090 "bitcoin::network::constants::Network" => Some("crate::bitcoin::network::Network"),
1091 "bitcoin::address::WitnessVersion" => Some("crate::c_types::WitnessVersion"),
1092 "bitcoin::address::WitnessProgram" => Some("crate::c_types::WitnessProgram"),
1093 "bitcoin::blockdata::block::Header" if is_ref => Some("*const [u8; 80]"),
1094 "bitcoin::blockdata::block::Block" if is_ref => Some("crate::c_types::u8slice"),
1096 "bitcoin::blockdata::locktime::absolute::LockTime" => Some("u32"),
1098 "bitcoin::psbt::PartiallySignedTransaction" if !is_ref => Some("crate::c_types::derived::CVec_u8Z"),
1100 "bitcoin::PubkeyHash"|"bitcoin::hash_types::PubkeyHash"|
1101 "bitcoin::hash_types::WPubkeyHash"|
1102 "bitcoin::ScriptHash"|"bitcoin::hash_types::ScriptHash"
1103 if !is_ref => Some("crate::c_types::TwentyBytes"),
1104 "bitcoin::PubkeyHash"|"bitcoin::hash_types::PubkeyHash"|
1105 "bitcoin::hash_types::WPubkeyHash"|
1106 "bitcoin::ScriptHash"|"bitcoin::hash_types::ScriptHash"
1107 if is_ref => Some("*const [u8; 20]"),
1108 "bitcoin::hash_types::WScriptHash"
1109 if is_ref => Some("*const [u8; 32]"),
1111 // Newtypes that we just expose in their original form.
1112 "bitcoin::hash_types::Txid"|"bitcoin::BlockHash"|"bitcoin::hash_types::BlockHash"|"bitcoin::hashes::sha256::Hash"|"bitcoin::blockdata::constants::ChainHash"
1113 if is_ref => Some("*const [u8; 32]"),
1114 "bitcoin::hash_types::Txid"|"bitcoin::BlockHash"|"bitcoin::hash_types::BlockHash"|"bitcoin::hashes::sha256::Hash"|"bitcoin::blockdata::constants::ChainHash"
1115 if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
1116 "bitcoin::secp256k1::Message" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
1117 "bitcoin::secp256k1::Message" if is_ref => Some("*const [u8; 32]"),
1118 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1119 |"lightning::ln::channelmanager::PaymentId"|"lightning::ln::channelmanager::InterceptId"
1120 |"lightning::sign::KeyMaterial"|"lightning::chain::ClaimId"
1121 |"lightning::ln::ChannelId"|"lightning::ln::channel_id::ChannelId"
1122 if is_ref => Some("*const [u8; 32]"),
1123 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1124 |"lightning::ln::channelmanager::PaymentId"|"lightning::ln::channelmanager::InterceptId"
1125 |"lightning::sign::KeyMaterial"|"lightning::chain::ClaimId"
1126 |"lightning::ln::ChannelId"|"lightning::ln::channel_id::ChannelId"
1127 if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
1129 "lightning::io::Read" => Some("crate::c_types::u8slice"),
1135 fn from_c_conversion_new_var_from_path<'b>(&self, _full_path: &str, _is_ref: bool) -> Option<(&'b str, &'b str)> {
1138 fn from_c_conversion_prefix_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<String> {
1139 if self.is_primitive(full_path) {
1140 return Some("".to_owned());
1143 "Vec" if !is_ref => Some("local_"),
1144 "Result" if !is_ref => Some("local_"),
1145 "Option" if is_ref => Some("&local_"),
1146 "Option" => Some("local_"),
1148 "[u8; 32]" if is_ref => Some("unsafe { &*"),
1149 "[u8; 32]" if !is_ref => Some(""),
1150 "[u8; 20]" if !is_ref => Some(""),
1151 "[u8; 16]" if !is_ref => Some(""),
1152 "[u8; 12]" if !is_ref => Some(""),
1153 "[u8; 4]" if !is_ref => Some(""),
1154 "[u8; 3]" if !is_ref => Some(""),
1155 "[u16; 32]" if !is_ref => Some(""),
1157 "[u8]" if is_ref => Some(""),
1158 "[usize]" if is_ref => Some(""),
1160 "str" if is_ref => Some(""),
1161 "alloc::string::String"|"String"|"std::path::PathBuf" => Some(""),
1162 "std::io::Error"|"lightning::io::Error"|"lightning::io::ErrorKind" => Some(""),
1163 // Note that we'll panic for String if is_ref, as we only have non-owned memory, we
1164 // cannot create a &String.
1166 "core::convert::Infallible" => Some("panic!(\"You must never construct a NotConstructable! : "),
1168 "bitcoin::bech32::Error"|"bech32::Error" if !is_ref => Some(""),
1169 "bitcoin::secp256k1::Error"|"secp256k1::Error" if !is_ref => Some(""),
1171 "core::num::ParseIntError" => Some("u8::from_str_radix(\" a\", 10).unwrap_err() /*"),
1172 "core::str::Utf8Error" => Some("core::str::from_utf8(&[0xff]).unwrap_err() /*"),
1174 "std::time::Duration"|"core::time::Duration" => Some("core::time::Duration::from_secs("),
1175 "std::time::SystemTime" => Some("(::std::time::SystemTime::UNIX_EPOCH + std::time::Duration::from_secs("),
1177 "bitcoin::bech32::u5"|"bech32::u5" => Some(""),
1179 "core::num::NonZeroU8" => Some("core::num::NonZeroU8::new("),
1181 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" if is_ref => Some("&"),
1182 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" => Some(""),
1183 "bitcoin::secp256k1::ecdsa::Signature"|"bitcoin::secp256k1::schnorr::Signature" if is_ref => Some("&"),
1184 "bitcoin::secp256k1::ecdsa::Signature"|"bitcoin::secp256k1::schnorr::Signature" => Some(""),
1185 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some(""),
1186 "bitcoin::secp256k1::SecretKey" if is_ref => Some("&::bitcoin::secp256k1::SecretKey::from_slice(&unsafe { *"),
1187 "bitcoin::secp256k1::SecretKey" if !is_ref => Some(""),
1188 "bitcoin::secp256k1::KeyPair" if !is_ref => Some("::bitcoin::secp256k1::KeyPair::from_secret_key(&secp256k1::global::SECP256K1, &"),
1189 "bitcoin::secp256k1::Scalar" if is_ref => Some("&"),
1190 "bitcoin::secp256k1::Scalar" if !is_ref => Some(""),
1191 "bitcoin::secp256k1::ecdh::SharedSecret" if !is_ref => Some("::bitcoin::secp256k1::ecdh::SharedSecret::from_bytes("),
1193 "bitcoin::blockdata::script::Script"|"bitcoin::Script" => Some("::bitcoin::blockdata::script::Script::from_bytes("),
1194 "bitcoin::blockdata::script::ScriptBuf"|"bitcoin::ScriptBuf" => Some("::bitcoin::blockdata::script::ScriptBuf::from("),
1195 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" if is_ref => Some("&"),
1196 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(""),
1197 "bitcoin::Witness" if is_ref => Some("&"),
1198 "bitcoin::Witness" => Some(""),
1199 "bitcoin::OutPoint"|"bitcoin::blockdata::transaction::OutPoint" => Some("crate::c_types::C_to_bitcoin_outpoint("),
1200 "bitcoin::TxIn"|"bitcoin::blockdata::transaction::TxIn" if !is_ref => Some(""),
1201 "bitcoin::TxOut"|"bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(""),
1202 "bitcoin::network::constants::Network" => Some(""),
1203 "bitcoin::address::WitnessVersion" => Some(""),
1204 "bitcoin::address::WitnessProgram" if is_ref => Some("&"),
1205 "bitcoin::address::WitnessProgram" if !is_ref => Some(""),
1206 "bitcoin::blockdata::block::Header" => Some("&::bitcoin::consensus::encode::deserialize(unsafe { &*"),
1207 "bitcoin::blockdata::block::Block" if is_ref => Some("&::bitcoin::consensus::encode::deserialize("),
1209 "bitcoin::blockdata::locktime::absolute::LockTime" => Some("::bitcoin::blockdata::locktime::absolute::LockTime::from_consensus("),
1211 "bitcoin::psbt::PartiallySignedTransaction" if !is_ref => Some("::bitcoin::psbt::PartiallySignedTransaction::deserialize("),
1213 "bitcoin::PubkeyHash"|"bitcoin::hash_types::PubkeyHash" if !is_ref =>
1214 Some("bitcoin::hash_types::PubkeyHash::from_raw_hash(bitcoin::hashes::Hash::from_byte_array("),
1215 "bitcoin::PubkeyHash"|"bitcoin::hash_types::PubkeyHash" if is_ref =>
1216 Some("&bitcoin::hash_types::PubkeyHash::from_raw_hash(bitcoin::hashes::Hash::from_byte_array(unsafe { *"),
1217 "bitcoin::hash_types::WPubkeyHash" if is_ref =>
1218 Some("&bitcoin::hash_types::WPubkeyHash::from_raw_hash(bitcoin::hashes::Hash::from_byte_array(unsafe { *"),
1219 "bitcoin::ScriptHash"|"bitcoin::hash_types::ScriptHash" if !is_ref =>
1220 Some("bitcoin::hash_types::ScriptHash::from_raw_hash(bitcoin::hashes::Hash::from_byte_array("),
1221 "bitcoin::ScriptHash"|"bitcoin::hash_types::ScriptHash" if is_ref =>
1222 Some("&bitcoin::hash_types::ScriptHash::from_raw_hash(bitcoin::hashes::Hash::from_byte_array(unsafe { *"),
1223 "bitcoin::hash_types::WScriptHash" if is_ref =>
1224 Some("&bitcoin::hash_types::WScriptHash::from_raw_hash(bitcoin::hashes::Hash::from_byte_array(unsafe { *"),
1226 // Newtypes that we just expose in their original form.
1227 "bitcoin::hash_types::Txid" if is_ref => Some("&::bitcoin::hash_types::Txid::from_slice(&unsafe { &*"),
1228 "bitcoin::hash_types::Txid" if !is_ref => Some("::bitcoin::hash_types::Txid::from_slice(&"),
1229 "bitcoin::hash_types::BlockHash"|"bitcoin::BlockHash" => Some("::bitcoin::hash_types::BlockHash::from_slice(&"),
1230 "bitcoin::blockdata::constants::ChainHash" => Some("::bitcoin::blockdata::constants::ChainHash::from(&"),
1231 "lightning::ln::PaymentHash" if !is_ref => Some("::lightning::ln::PaymentHash("),
1232 "lightning::ln::PaymentHash" if is_ref => Some("&::lightning::ln::PaymentHash(unsafe { *"),
1233 "lightning::ln::PaymentPreimage" if !is_ref => Some("::lightning::ln::PaymentPreimage("),
1234 "lightning::ln::PaymentPreimage" if is_ref => Some("&::lightning::ln::PaymentPreimage(unsafe { *"),
1235 "lightning::ln::PaymentSecret" if !is_ref => Some("::lightning::ln::PaymentSecret("),
1236 "lightning::ln::channelmanager::PaymentId" if !is_ref => Some("::lightning::ln::channelmanager::PaymentId("),
1237 "lightning::ln::channelmanager::PaymentId" if is_ref=> Some("&::lightning::ln::channelmanager::PaymentId( unsafe { *"),
1238 "lightning::ln::channelmanager::InterceptId" if !is_ref => Some("::lightning::ln::channelmanager::InterceptId("),
1239 "lightning::ln::channelmanager::InterceptId" if is_ref=> Some("&::lightning::ln::channelmanager::InterceptId( unsafe { *"),
1240 "lightning::ln::ChannelId"|"lightning::ln::channel_id::ChannelId" if !is_ref => Some("::lightning::ln::ChannelId("),
1241 "lightning::ln::ChannelId"|"lightning::ln::channel_id::ChannelId" if is_ref => Some("&::lightning::ln::ChannelId(unsafe { *"),
1242 "lightning::sign::KeyMaterial" if !is_ref => Some("::lightning::sign::KeyMaterial("),
1243 "lightning::sign::KeyMaterial" if is_ref=> Some("&::lightning::sign::KeyMaterial( unsafe { *"),
1244 "lightning::chain::ClaimId" if !is_ref => Some("::lightning::chain::ClaimId("),
1245 "lightning::chain::ClaimId" if is_ref=> Some("&::lightning::chain::ClaimId( unsafe { *"),
1247 // List of traits we map (possibly during processing of other files):
1248 "lightning::io::Read" => Some("&mut "),
1251 }.map(|s| s.to_owned())
1253 fn from_c_conversion_suffix_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<String> {
1254 if self.is_primitive(full_path) {
1255 return Some("".to_owned());
1258 "Vec" if !is_ref => Some(""),
1259 "Option" => Some(""),
1260 "Result" if !is_ref => Some(""),
1262 "[u8; 32]" if is_ref => Some("}"),
1263 "[u8; 32]" if !is_ref => Some(".data"),
1264 "[u8; 20]" if !is_ref => Some(".data"),
1265 "[u8; 16]" if !is_ref => Some(".data"),
1266 "[u8; 12]" if !is_ref => Some(".data"),
1267 "[u8; 4]" if !is_ref => Some(".data"),
1268 "[u8; 3]" if !is_ref => Some(".data"),
1269 "[u16; 32]" if !is_ref => Some(".data"),
1271 "[u8]" if is_ref => Some(".to_slice()"),
1272 "[usize]" if is_ref => Some(".to_slice()"),
1274 "str" if is_ref => Some(".into_str()"),
1275 "alloc::string::String"|"String" => Some(".into_string()"),
1276 "std::path::PathBuf" => Some(".into_pathbuf()"),
1277 "std::io::Error"|"lightning::io::Error" => Some(".to_rust()"),
1278 "lightning::io::ErrorKind" => Some(".to_rust_kind()"),
1280 "core::convert::Infallible" => Some("\")"),
1282 "bitcoin::bech32::Error"|"bech32::Error" if !is_ref => Some(".into_rust()"),
1283 "bitcoin::secp256k1::Error"|"secp256k1::Error" if !is_ref => Some(".into_rust()"),
1285 "core::num::ParseIntError" => Some("*/"),
1286 "core::str::Utf8Error" => Some("*/"),
1288 "std::time::Duration"|"core::time::Duration" => Some(")"),
1289 "std::time::SystemTime" => Some("))"),
1291 "bitcoin::bech32::u5"|"bech32::u5" => Some(".into()"),
1292 "u128" => Some(".into()"),
1293 "core::num::NonZeroU8" => Some(").expect(\"Value must be non-zero\")"),
1295 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" => Some(".into_rust()"),
1296 "bitcoin::secp256k1::ecdsa::Signature"|"bitcoin::secp256k1::schnorr::Signature" => Some(".into_rust()"),
1297 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some(".into_rust()"),
1298 "bitcoin::secp256k1::SecretKey" if !is_ref => Some(".into_rust()"),
1299 "bitcoin::secp256k1::SecretKey" if is_ref => Some("}[..]).unwrap()"),
1300 "bitcoin::secp256k1::KeyPair" if !is_ref => Some(".into_rust())"),
1301 "bitcoin::secp256k1::Scalar" => Some(".into_rust()"),
1302 "bitcoin::secp256k1::ecdh::SharedSecret" if !is_ref => Some(".data)"),
1304 "bitcoin::blockdata::script::Script"|"bitcoin::Script" => Some(".to_slice())"),
1305 "bitcoin::blockdata::script::ScriptBuf"|"bitcoin::ScriptBuf" => Some(".into_rust())"),
1306 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(".into_bitcoin()"),
1307 "bitcoin::Witness" => Some(".into_bitcoin()"),
1308 "bitcoin::OutPoint"|"bitcoin::blockdata::transaction::OutPoint" => Some(")"),
1309 "bitcoin::TxIn"|"bitcoin::blockdata::transaction::TxIn" if !is_ref => Some(".into_rust()"),
1310 "bitcoin::TxOut"|"bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(".into_rust()"),
1311 "bitcoin::network::constants::Network" => Some(".into_bitcoin()"),
1312 "bitcoin::address::WitnessVersion" => Some(".into()"),
1313 "bitcoin::address::WitnessProgram" => Some(".into_bitcoin()"),
1314 "bitcoin::blockdata::block::Header" => Some(" }).unwrap()"),
1315 "bitcoin::blockdata::block::Block" => Some(".to_slice()).unwrap()"),
1317 "bitcoin::blockdata::locktime::absolute::LockTime" => Some(")"),
1319 "bitcoin::psbt::PartiallySignedTransaction" if !is_ref => Some(".as_slice()).expect(\"Invalid PSBT format\")"),
1321 "bitcoin::PubkeyHash"|"bitcoin::hash_types::PubkeyHash"|
1322 "bitcoin::hash_types::WPubkeyHash"|"bitcoin::hash_types::WScriptHash"|
1323 "bitcoin::ScriptHash"|"bitcoin::hash_types::ScriptHash"
1324 if !is_ref => Some(".data))"),
1325 "bitcoin::PubkeyHash"|"bitcoin::hash_types::PubkeyHash"|
1326 "bitcoin::hash_types::WPubkeyHash"|"bitcoin::hash_types::WScriptHash"|
1327 "bitcoin::ScriptHash"|"bitcoin::hash_types::ScriptHash"
1328 if is_ref => Some(" }.clone()))"),
1330 // Newtypes that we just expose in their original form.
1331 "bitcoin::hash_types::Txid" if is_ref => Some(" }[..]).unwrap()"),
1332 "bitcoin::hash_types::Txid" => Some(".data[..]).unwrap()"),
1333 "bitcoin::hash_types::BlockHash"|"bitcoin::BlockHash" if !is_ref => Some(".data[..]).unwrap()"),
1334 "bitcoin::blockdata::constants::ChainHash" if !is_ref => Some(".data)"),
1335 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1336 |"lightning::ln::channelmanager::PaymentId"|"lightning::ln::channelmanager::InterceptId"
1337 |"lightning::sign::KeyMaterial"|"lightning::chain::ClaimId"
1338 |"lightning::ln::ChannelId"|"lightning::ln::channel_id::ChannelId"
1339 if !is_ref => Some(".data)"),
1340 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1341 |"lightning::ln::channelmanager::PaymentId"|"lightning::ln::channelmanager::InterceptId"
1342 |"lightning::sign::KeyMaterial"|"lightning::chain::ClaimId"
1343 |"lightning::ln::ChannelId"|"lightning::ln::channel_id::ChannelId"
1344 if is_ref => Some(" })"),
1346 // List of traits we map (possibly during processing of other files):
1347 "lightning::io::Read" => Some(".to_reader()"),
1350 }.map(|s| s.to_owned())
1353 fn to_c_conversion_new_var_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<(&'b str, &'b str)> {
1354 if self.is_primitive(full_path) {
1358 "[u8]" if is_ref => Some(("crate::c_types::u8slice::from_slice(", ")")),
1359 "[usize]" if is_ref => Some(("crate::c_types::usizeslice::from_slice(", ")")),
1361 "bitcoin::blockdata::block::Header" if is_ref => Some(("{ let mut s = [0u8; 80]; s[..].copy_from_slice(&::bitcoin::consensus::encode::serialize(", ")); s }")),
1362 "bitcoin::blockdata::block::Block" if is_ref => Some(("::bitcoin::consensus::encode::serialize(", ")")),
1365 }.map(|s| s.to_owned())
1367 fn to_c_conversion_inline_prefix_from_path(&self, full_path: &str, is_ref: bool, _ptr_for_ref: bool) -> Option<String> {
1368 if self.is_primitive(full_path) {
1369 return Some("".to_owned());
1372 "Result" if !is_ref => Some("local_"),
1373 "Vec" if !is_ref => Some("local_"),
1374 "Option" => Some("local_"),
1376 "[u8; 32]" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1377 "[u8; 32]" if is_ref => Some(""),
1378 "[u8; 20]" if !is_ref => Some("crate::c_types::TwentyBytes { data: "),
1379 "[u8; 16]" if !is_ref => Some("crate::c_types::SixteenBytes { data: "),
1380 "[u8; 12]" if !is_ref => Some("crate::c_types::TwelveBytes { data: "),
1381 "[u8; 4]" if !is_ref => Some("crate::c_types::FourBytes { data: "),
1382 "[u8; 3]" if is_ref => Some(""),
1383 "[u16; 32]" if !is_ref => Some("crate::c_types::ThirtyTwoU16s { data: "),
1385 "[u8]" if is_ref => Some("local_"),
1386 "[usize]" if is_ref => Some("local_"),
1388 "str" if is_ref => Some(""),
1389 "alloc::string::String"|"String"|"std::path::PathBuf" => Some(""),
1391 "bitcoin::Address" => Some("alloc::string::ToString::to_string(&"),
1393 "std::time::Duration"|"core::time::Duration" => Some(""),
1394 "std::time::SystemTime" => Some(""),
1395 "std::io::Error"|"lightning::io::Error" => Some("crate::c_types::IOError::from_rust("),
1396 "lightning::io::ErrorKind" => Some("crate::c_types::IOError::from_rust_kind("),
1397 "core::fmt::Arguments" => Some("alloc::format!(\"{}\", "),
1399 "core::convert::Infallible" => Some("panic!(\"Cannot construct an Infallible: "),
1401 "bitcoin::bech32::Error"|"bech32::Error"
1402 if !is_ref => Some("crate::c_types::Bech32Error::from_rust("),
1403 "bitcoin::secp256k1::Error"|"secp256k1::Error"
1404 if !is_ref => Some("crate::c_types::Secp256k1Error::from_rust("),
1406 "core::num::ParseIntError" => Some("crate::c_types::Error { _dummy: 0 } /*"),
1407 "core::str::Utf8Error" => Some("crate::c_types::Error { _dummy: 0 } /*"),
1409 "bitcoin::bech32::u5"|"bech32::u5" => Some(""),
1412 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" => Some("crate::c_types::PublicKey::from_rust(&"),
1413 "bitcoin::secp256k1::ecdsa::Signature" => Some("crate::c_types::ECDSASignature::from_rust(&"),
1414 "bitcoin::secp256k1::schnorr::Signature" => Some("crate::c_types::SchnorrSignature::from_rust(&"),
1415 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some("crate::c_types::RecoverableSignature::from_rust(&"),
1416 "bitcoin::secp256k1::SecretKey" if is_ref => Some(""),
1417 "bitcoin::secp256k1::SecretKey" if !is_ref => Some("crate::c_types::SecretKey::from_rust("),
1418 "bitcoin::secp256k1::KeyPair" if !is_ref => Some("crate::c_types::SecretKey::from_rust("),
1419 "bitcoin::secp256k1::Scalar" if !is_ref => Some("crate::c_types::BigEndianScalar::from_rust(&"),
1420 "bitcoin::secp256k1::ecdh::SharedSecret" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1422 "bitcoin::blockdata::script::Script"|"bitcoin::Script" => Some("crate::c_types::u8slice::from_slice("),
1423 "bitcoin::blockdata::script::ScriptBuf"|"bitcoin::ScriptBuf" => Some(""),
1424 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" if is_ref => Some("crate::c_types::Transaction::from_bitcoin("),
1425 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some("crate::c_types::Transaction::from_bitcoin(&"),
1426 "bitcoin::Witness" if is_ref => Some("crate::c_types::Witness::from_bitcoin("),
1427 "bitcoin::Witness" if !is_ref => Some("crate::c_types::Witness::from_bitcoin(&"),
1428 "bitcoin::OutPoint"|"bitcoin::blockdata::transaction::OutPoint" if is_ref => Some("crate::c_types::bitcoin_to_C_outpoint("),
1429 "bitcoin::OutPoint"|"bitcoin::blockdata::transaction::OutPoint" if !is_ref => Some("crate::c_types::bitcoin_to_C_outpoint(&"),
1430 "bitcoin::TxIn"|"bitcoin::blockdata::transaction::TxIn" if !is_ref => Some("crate::c_types::TxIn::from_rust(&"),
1431 "bitcoin::TxOut"|"bitcoin::blockdata::transaction::TxOut" if !is_ref => Some("crate::c_types::TxOut::from_rust(&"),
1432 "bitcoin::TxOut"|"bitcoin::blockdata::transaction::TxOut" if is_ref => Some("crate::c_types::TxOut::from_rust("),
1433 "bitcoin::network::constants::Network" => Some("crate::bitcoin::network::Network::from_bitcoin("),
1434 "bitcoin::address::WitnessVersion" => Some(""),
1435 "bitcoin::address::WitnessProgram" => Some("crate::c_types::WitnessProgram::from_bitcoin("),
1436 "bitcoin::blockdata::block::Header" if is_ref => Some("&local_"),
1437 "bitcoin::blockdata::block::Block" if is_ref => Some("crate::c_types::u8slice::from_slice(&local_"),
1439 "bitcoin::blockdata::locktime::absolute::LockTime" => Some(""),
1441 "bitcoin::psbt::PartiallySignedTransaction" if !is_ref => Some(""),
1443 "bitcoin::PubkeyHash"|"bitcoin::hash_types::PubkeyHash"|
1444 "bitcoin::hash_types::WPubkeyHash"|"bitcoin::hash_types::WScriptHash"|
1445 "bitcoin::ScriptHash"|"bitcoin::hash_types::ScriptHash"
1446 if !is_ref => Some("crate::c_types::TwentyBytes { data: *"),
1448 // Newtypes that we just expose in their original form.
1449 "bitcoin::hash_types::Txid"|"bitcoin::BlockHash"|"bitcoin::hash_types::BlockHash"|"bitcoin::hashes::sha256::Hash"|"bitcoin::blockdata::constants::ChainHash"
1450 if is_ref => Some(""),
1451 "bitcoin::hash_types::Txid"|"bitcoin::BlockHash"|"bitcoin::hash_types::BlockHash"|"bitcoin::hashes::sha256::Hash"|"bitcoin::blockdata::constants::ChainHash"
1452 if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: *"),
1453 "bitcoin::secp256k1::Message" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1454 "bitcoin::secp256k1::Message" if is_ref => Some(""),
1455 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1456 |"lightning::ln::channelmanager::PaymentId"|"lightning::ln::channelmanager::InterceptId"
1457 |"lightning::sign::KeyMaterial"|"lightning::chain::ClaimId"
1458 |"lightning::ln::ChannelId"|"lightning::ln::channel_id::ChannelId"
1459 if is_ref => Some("&"),
1460 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1461 |"lightning::ln::channelmanager::PaymentId"|"lightning::ln::channelmanager::InterceptId"
1462 |"lightning::sign::KeyMaterial"|"lightning::chain::ClaimId"
1463 |"lightning::ln::ChannelId"|"lightning::ln::channel_id::ChannelId"
1464 if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1466 "lightning::io::Read" => Some("crate::c_types::u8slice::from_vec(&crate::c_types::reader_to_vec("),
1469 }.map(|s| s.to_owned())
1471 fn to_c_conversion_inline_suffix_from_path(&self, full_path: &str, is_ref: bool, _ptr_for_ref: bool) -> Option<String> {
1472 if self.is_primitive(full_path) {
1473 return Some("".to_owned());
1476 "Result" if !is_ref => Some(""),
1477 "Vec" if !is_ref => Some(".into()"),
1478 "Option" => Some(""),
1480 "[u8; 32]" if !is_ref => Some(" }"),
1481 "[u8; 32]" if is_ref => Some(""),
1482 "[u8; 20]" if !is_ref => Some(" }"),
1483 "[u8; 16]" if !is_ref => Some(" }"),
1484 "[u8; 12]" if !is_ref => Some(" }"),
1485 "[u8; 4]" if !is_ref => Some(" }"),
1486 "[u8; 3]" if is_ref => Some(""),
1487 "[u16; 32]" if !is_ref => Some(" }"),
1489 "[u8]" if is_ref => Some(""),
1490 "[usize]" if is_ref => Some(""),
1492 "str" if is_ref => Some(".into()"),
1493 "alloc::string::String"|"String"|"std::path::PathBuf" if is_ref => Some(".as_str().into()"),
1494 "alloc::string::String"|"String"|"std::path::PathBuf" => Some(".into()"),
1496 "bitcoin::Address" => Some(").into()"),
1498 "std::time::Duration"|"core::time::Duration" => Some(".as_secs()"),
1499 "std::time::SystemTime" => Some(".duration_since(::std::time::SystemTime::UNIX_EPOCH).expect(\"Times must be post-1970\").as_secs()"),
1500 "std::io::Error"|"lightning::io::Error"|"lightning::io::ErrorKind" => Some(")"),
1501 "core::fmt::Arguments" => Some(").into()"),
1503 "core::convert::Infallible" => Some("\")"),
1505 "bitcoin::secp256k1::Error"|"bech32::Error"
1506 if !is_ref => Some(")"),
1507 "bitcoin::secp256k1::Error"|"secp256k1::Error"
1508 if !is_ref => Some(")"),
1510 "core::num::ParseIntError" => Some("*/"),
1511 "core::str::Utf8Error" => Some("*/"),
1513 "bitcoin::bech32::u5"|"bech32::u5" => Some(".into()"),
1514 "u128" => Some(".into()"),
1516 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" => Some(")"),
1517 "bitcoin::secp256k1::ecdsa::Signature"|"bitcoin::secp256k1::schnorr::Signature" => Some(")"),
1518 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some(")"),
1519 "bitcoin::secp256k1::SecretKey" if !is_ref => Some(")"),
1520 "bitcoin::secp256k1::SecretKey" if is_ref => Some(".as_ref()"),
1521 "bitcoin::secp256k1::KeyPair" if !is_ref => Some(".secret_key())"),
1522 "bitcoin::secp256k1::Scalar" if !is_ref => Some(")"),
1523 "bitcoin::secp256k1::ecdh::SharedSecret" if !is_ref => Some(".secret_bytes() }"),
1525 "bitcoin::blockdata::script::Script"|"bitcoin::Script" => Some(".as_ref())"),
1526 "bitcoin::blockdata::script::ScriptBuf"|"bitcoin::ScriptBuf" if is_ref => Some(".as_bytes().to_vec().into()"),
1527 "bitcoin::blockdata::script::ScriptBuf"|"bitcoin::ScriptBuf" if !is_ref => Some(".to_bytes().into()"),
1528 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(")"),
1529 "bitcoin::Witness" => Some(")"),
1530 "bitcoin::OutPoint"|"bitcoin::blockdata::transaction::OutPoint" => Some(")"),
1531 "bitcoin::TxIn"|"bitcoin::blockdata::transaction::TxIn" if !is_ref => Some(")"),
1532 "bitcoin::TxOut"|"bitcoin::blockdata::transaction::TxOut" => Some(")"),
1533 "bitcoin::network::constants::Network" => Some(")"),
1534 "bitcoin::address::WitnessVersion" => Some(".into()"),
1535 "bitcoin::address::WitnessProgram" => Some(")"),
1536 "bitcoin::blockdata::block::Header" if is_ref => Some(""),
1537 "bitcoin::blockdata::block::Block" if is_ref => Some(")"),
1539 "bitcoin::blockdata::locktime::absolute::LockTime" => Some(".to_consensus_u32()"),
1541 "bitcoin::psbt::PartiallySignedTransaction" if !is_ref => Some(".serialize().into()"),
1543 "bitcoin::PubkeyHash"|"bitcoin::hash_types::PubkeyHash"|
1544 "bitcoin::hash_types::WPubkeyHash"|"bitcoin::hash_types::WScriptHash"|
1545 "bitcoin::ScriptHash"|"bitcoin::hash_types::ScriptHash"
1546 if !is_ref => Some(".as_ref() }"),
1548 // Newtypes that we just expose in their original form.
1549 "bitcoin::hash_types::Txid"|"bitcoin::BlockHash"|"bitcoin::hash_types::BlockHash"|"bitcoin::hashes::sha256::Hash"|"bitcoin::blockdata::constants::ChainHash"
1550 if is_ref => Some(".as_ref()"),
1551 "bitcoin::hash_types::Txid"|"bitcoin::BlockHash"|"bitcoin::hash_types::BlockHash"|"bitcoin::hashes::sha256::Hash"|"bitcoin::blockdata::constants::ChainHash"
1552 if !is_ref => Some(".as_ref() }"),
1553 "bitcoin::secp256k1::Message" if !is_ref => Some(".as_ref().clone() }"),
1554 "bitcoin::secp256k1::Message" if is_ref => Some(".as_ref()"),
1555 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1556 |"lightning::ln::channelmanager::PaymentId"|"lightning::ln::channelmanager::InterceptId"
1557 |"lightning::sign::KeyMaterial"|"lightning::chain::ClaimId"
1558 |"lightning::ln::ChannelId"|"lightning::ln::channel_id::ChannelId"
1559 if is_ref => Some(".0"),
1560 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1561 |"lightning::ln::channelmanager::PaymentId"|"lightning::ln::channelmanager::InterceptId"
1562 |"lightning::sign::KeyMaterial"|"lightning::chain::ClaimId"
1563 |"lightning::ln::ChannelId"|"lightning::ln::channel_id::ChannelId"
1564 if !is_ref => Some(".0 }"),
1566 "lightning::io::Read" => Some("))"),
1569 }.map(|s| s.to_owned())
1572 fn empty_val_check_suffix_from_path(&self, full_path: &str) -> Option<&str> {
1574 "secp256k1::PublicKey"|"bitcoin::secp256k1::PublicKey" => Some(".is_null()"),
1579 /// When printing a reference to the source crate's rust type, if we need to map it to a
1580 /// different "real" type, it can be done so here.
1581 /// This is useful to work around limitations in the binding type resolver, where we reference
1582 /// a non-public `use` alias.
1583 /// TODO: We should never need to use this!
1584 fn real_rust_type_mapping<'equiv>(&self, thing: &'equiv str) -> &'equiv str {
1586 "lightning::io::Read" => "crate::c_types::io::Read",
1591 // ****************************
1592 // *** Container Processing ***
1593 // ****************************
1595 /// Returns the module path in the generated mapping crate to the containers which we generate
1596 /// when writing to CrateTypes::template_file.
1597 pub fn generated_container_path() -> &'static str {
1598 "crate::c_types::derived"
1600 /// Returns the module path in the generated mapping crate to the container templates, which
1601 /// are then concretized and put in the generated container path/template_file.
1602 fn container_templ_path() -> &'static str {
1606 /// This should just be a closure, but doing so gets an error like
1607 /// error: reached the recursion limit while instantiating `types::TypeResolver::is_transpar...c/types.rs:1358:104: 1358:110]>>`
1608 /// which implies the concrete function instantiation of `is_transparent_container` ends up
1609 /// being recursive.
1610 fn deref_type<'one, 'b: 'one> (obj: &'one &'b syn::Type) -> &'b syn::Type { *obj }
1612 /// Returns true if the path containing the given args is a "transparent" container, ie an
1613 /// Option or a container which does not require a generated continer class.
1614 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 {
1615 if full_path == "Option" {
1616 let inner = args.next().unwrap();
1617 assert!(args.next().is_none());
1618 match generics.resolve_type(inner) {
1619 syn::Type::Reference(r) => {
1620 let elem = &*r.elem;
1622 syn::Type::Path(_) =>
1623 self.is_transparent_container(full_path, true, [elem].iter().map(Self::deref_type), generics),
1627 syn::Type::Array(a) => {
1628 if let syn::Expr::Lit(l) = &a.len {
1629 if let syn::Lit::Int(i) = &l.lit {
1630 if i.base10_digits().parse::<usize>().unwrap() >= 32 {
1631 let mut buf = Vec::new();
1632 self.write_rust_type(&mut buf, generics, &a.elem, false);
1633 let ty = String::from_utf8(buf).unwrap();
1636 // Blindly assume that if we're trying to create an empty value for an
1637 // array < 32 entries that all-0s may be a valid state.
1640 } else { unimplemented!(); }
1641 } else { unimplemented!(); }
1643 syn::Type::Path(p) => {
1644 if let Some(resolved) = self.maybe_resolve_path(&p.path, generics) {
1645 if self.c_type_has_inner_from_path(&resolved) { return true; }
1646 if self.is_primitive(&resolved) { return false; }
1647 // We want to move to using `Option_` mappings where possible rather than
1648 // manual mappings, as it makes downstream bindings simpler and is more
1649 // clear for users. Thus, we default to false but override for a few
1650 // types which had mappings defined when we were avoiding the `Option_`s.
1651 match &resolved as &str {
1652 "secp256k1::PublicKey"|"bitcoin::secp256k1::PublicKey" => true,
1655 } else { unimplemented!(); }
1657 syn::Type::Tuple(_) => false,
1658 _ => unimplemented!(),
1662 /// Returns true if the path is a "transparent" container, ie an Option or a container which does
1663 /// not require a generated continer class.
1664 pub fn is_path_transparent_container(&self, full_path: &syn::Path, generics: Option<&GenericTypes>, is_ref: bool) -> bool {
1665 let inner_iter = match &full_path.segments.last().unwrap().arguments {
1666 syn::PathArguments::None => return false,
1667 syn::PathArguments::AngleBracketed(args) => args.args.iter().map(|arg| {
1668 if let syn::GenericArgument::Type(ref ty) = arg {
1670 } else { unimplemented!() }
1672 syn::PathArguments::Parenthesized(_) => unimplemented!(),
1674 self.is_transparent_container(&self.resolve_path(full_path, generics), is_ref, inner_iter, generics)
1676 /// Returns true if this is a known, supported, non-transparent container.
1677 fn is_known_container(&self, full_path: &str, is_ref: bool) -> bool {
1678 (full_path == "Result" && !is_ref) || (full_path == "Vec" && !is_ref) || full_path.ends_with("Tuple") || full_path == "Option"
1680 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)
1681 // Returns prefix + Vec<(prefix, var-name-to-inline-convert)> + suffix
1682 // expecting one element in the vec per generic type, each of which is inline-converted
1683 -> Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)> {
1685 "Result" if !is_ref => {
1687 vec![(" { Ok(mut o) => crate::c_types::CResultTempl::ok(".to_string(), "o".to_string()),
1688 (").into(), Err(mut e) => crate::c_types::CResultTempl::err(".to_string(), "e".to_string())],
1689 ").into() }", ContainerPrefixLocation::PerConv))
1693 // We should only get here if the single contained has an inner
1694 assert!(self.c_type_has_inner(single_contained.unwrap()));
1696 Some(("Vec::new(); for mut item in ", vec![(format!(".drain(..) {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1699 if let Some(syn::Type::Reference(_)) = single_contained {
1700 Some(("Vec::new(); for item in ", vec![(format!(".iter() {{ local_{}.push(", var_name), "(*item)".to_string())], "); }", ContainerPrefixLocation::PerConv))
1702 Some(("Vec::new(); for item in ", vec![(format!(".iter() {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1706 let mut is_contained_ref = false;
1707 let contained_struct = if let Some(syn::Type::Path(p)) = single_contained {
1708 Some(self.resolve_path(&p.path, generics))
1709 } else if let Some(syn::Type::Reference(r)) = single_contained {
1710 is_contained_ref = true;
1711 if let syn::Type::Path(p) = &*r.elem {
1712 Some(self.resolve_path(&p.path, generics))
1715 if let Some(inner_path) = contained_struct {
1716 let only_contained_has_inner = self.c_type_has_inner_from_path(&inner_path);
1717 if self.c_type_has_inner_from_path(&inner_path) {
1718 let is_inner_ref = if let Some(syn::Type::Reference(_)) = single_contained { true } else { false };
1720 return Some(("if ", vec![
1721 (".is_none() { core::ptr::null() } else { ObjOps::nonnull_ptr_to_inner(".to_owned(),
1722 format!("({}{}.unwrap())", var_access, if is_inner_ref { "" } else { ".as_ref()" }))
1723 ], ") }", ContainerPrefixLocation::OutsideConv));
1725 return Some(("if ", vec![
1726 (".is_none() { core::ptr::null_mut() } else { ".to_owned(), format!("({}.unwrap())", var_access))
1727 ], " }", ContainerPrefixLocation::OutsideConv));
1729 } else if !self.is_transparent_container("Option", is_ref, [single_contained.unwrap()].iter().map(|a| *a), generics) {
1730 if self.is_primitive(&inner_path) || (!is_contained_ref && !is_ref) || only_contained_has_inner {
1731 let inner_name = self.get_c_mangled_container_type(vec![single_contained.unwrap()], generics, "Option").unwrap();
1732 return Some(("if ", vec![
1733 (format!(".is_none() {{ {}::None }} else {{ {}::Some(", inner_name, inner_name),
1734 format!("{}.unwrap()", var_access))
1735 ], ") }", ContainerPrefixLocation::PerConv));
1737 let inner_name = self.get_c_mangled_container_type(vec![single_contained.unwrap()], generics, "Option").unwrap();
1738 return Some(("if ", vec![
1739 (format!(".is_none() {{ {}::None }} else {{ {}::Some(/* WARNING: CLONING CONVERSION HERE! &Option<Enum> is otherwise un-expressable. */", inner_name, inner_name),
1740 format!("(*{}.as_ref().unwrap()).clone()", var_access))
1741 ], ") }", ContainerPrefixLocation::PerConv));
1744 // If c_type_from_path is some (ie there's a manual mapping for the inner
1745 // type), lean on write_empty_rust_val, below.
1748 if let Some(t) = single_contained {
1749 if let syn::Type::Tuple(syn::TypeTuple { elems, .. }) = t {
1750 let inner_name = self.get_c_mangled_container_type(vec![single_contained.unwrap()], generics, "Option").unwrap();
1751 if elems.is_empty() {
1752 return Some(("if ", vec![
1753 (format!(".is_none() {{ {}::None }} else {{ {}::Some /* ",
1754 inner_name, inner_name), format!(""))
1755 ], " */ }", ContainerPrefixLocation::PerConv));
1757 return Some(("if ", vec![
1758 (format!(".is_none() {{ {}::None }} else {{ {}::Some(",
1759 inner_name, inner_name), format!("({}.unwrap())", var_access))
1760 ], ") }", ContainerPrefixLocation::PerConv));
1763 if let syn::Type::Reference(syn::TypeReference { elem, .. }) = t {
1764 if let syn::Type::Slice(_) = &**elem {
1765 return Some(("if ", vec![
1766 (".is_none() { SmartPtr::null() } else { SmartPtr::from_obj(".to_string(),
1767 format!("({}.unwrap())", var_access))
1768 ], ") }", ContainerPrefixLocation::PerConv));
1771 let mut v = Vec::new();
1772 self.write_empty_rust_val(generics, &mut v, t);
1773 let s = String::from_utf8(v).unwrap();
1774 return Some(("if ", vec![
1775 (format!(".is_none() {{ {} }} else {{ ", s), format!("({}.unwrap())", var_access))
1776 ], " }", ContainerPrefixLocation::PerConv));
1777 } else { unreachable!(); }
1783 /// only_contained_has_inner implies that there is only one contained element in the container
1784 /// and it has an inner field (ie is an "opaque" type we've defined).
1785 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)
1786 // Returns prefix + Vec<(prefix, var-name-to-inline-convert)> + suffix
1787 // expecting one element in the vec per generic type, each of which is inline-converted
1788 -> Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)> {
1789 let mut only_contained_has_inner = false;
1790 let only_contained_resolved = if let Some(syn::Type::Path(p)) = single_contained {
1791 let res = self.resolve_path(&p.path, generics);
1792 only_contained_has_inner = self.c_type_has_inner_from_path(&res);
1796 "Result" if !is_ref => {
1798 vec![(".result_ok { true => Ok(".to_string(), format!("(*unsafe {{ Box::from_raw(<*mut _>::take_ptr(&mut {}.contents.result)) }})", var_access)),
1799 ("), false => Err(".to_string(), format!("(*unsafe {{ Box::from_raw(<*mut _>::take_ptr(&mut {}.contents.err)) }})", var_access))],
1800 ")}", ContainerPrefixLocation::PerConv))
1802 "Slice" if is_ref && only_contained_has_inner => {
1803 Some(("Vec::new(); for mut item in ", vec![(format!(".as_slice().iter() {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1806 Some(("Vec::new(); for mut item in ", vec![(format!(".into_rust().drain(..) {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1809 if let Some(resolved) = only_contained_resolved {
1810 if self.is_primitive(&resolved) {
1811 return Some(("if ", vec![(".is_some() { Some(".to_string(), format!("{}.take()", var_access))], ") } else { None }", ContainerPrefixLocation::NoPrefix))
1812 } else if only_contained_has_inner {
1814 return Some(("if ", vec![(".inner.is_null() { None } else { Some((*".to_string(), format!("{}", var_access))], ").clone()) }", ContainerPrefixLocation::PerConv))
1816 return Some(("if ", vec![(".inner.is_null() { None } else { Some(".to_string(), format!("{}", var_access))], ") }", ContainerPrefixLocation::PerConv));
1821 if let Some(t) = single_contained {
1823 syn::Type::Reference(_)|syn::Type::Path(_)|syn::Type::Slice(_)|syn::Type::Array(_) => {
1824 let mut v = Vec::new();
1825 let ret_ref = self.write_empty_rust_val_check_suffix(generics, &mut v, t);
1826 let s = String::from_utf8(v).unwrap();
1828 EmptyValExpectedTy::ReferenceAsPointer =>
1829 return Some(("if ", vec![
1830 (format!("{} {{ None }} else {{ Some(", s), format!("unsafe {{ &mut *{} }}", var_access))
1831 ], ") }", ContainerPrefixLocation::NoPrefix)),
1832 EmptyValExpectedTy::OptionType =>
1833 return Some(("{ /*", vec![
1834 (format!("*/ let {}_opt = {}; if {}_opt{} {{ None }} else {{ Some({{", var_name, var_access, var_name, s),
1835 format!("{{ {}_opt.take() }}", var_name))
1836 ], "})} }", ContainerPrefixLocation::PerConv)),
1837 EmptyValExpectedTy::NonPointer =>
1838 return Some(("if ", vec![
1839 (format!("{} {{ None }} else {{ Some(", s), format!("{}", var_access))
1840 ], ") }", ContainerPrefixLocation::PerConv)),
1843 syn::Type::Tuple(_) => {
1844 return Some(("if ", vec![(".is_some() { Some(".to_string(), format!("{}.take()", var_access))], ") } else { None }", ContainerPrefixLocation::PerConv))
1846 _ => unimplemented!(),
1848 } else { unreachable!(); }
1854 /// Constructs a reference to the given type, possibly tweaking the type if relevant to make it
1855 /// convertable to C.
1856 pub fn create_ownable_reference(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> Option<syn::Type> {
1857 let default_value = Some(syn::Type::Reference(syn::TypeReference {
1858 and_token: syn::Token!(&)(Span::call_site()), lifetime: None, mutability: None,
1859 elem: Box::new(t.clone()) }));
1860 match generics.resolve_type(t) {
1861 syn::Type::Path(p) => {
1862 if let Some(resolved_path) = self.maybe_resolve_path(&p.path, generics) {
1863 if resolved_path != "Vec" { return default_value; }
1864 if p.path.segments.len() != 1 { unimplemented!(); }
1865 let only_seg = p.path.segments.iter().next().unwrap();
1866 if let syn::PathArguments::AngleBracketed(args) = &only_seg.arguments {
1867 if args.args.len() != 1 { unimplemented!(); }
1868 let inner_arg = args.args.iter().next().unwrap();
1869 if let syn::GenericArgument::Type(ty) = &inner_arg {
1870 let mut can_create = self.c_type_has_inner(&ty);
1871 if let syn::Type::Path(inner) = ty {
1872 if inner.path.segments.len() == 1 &&
1873 format!("{}", inner.path.segments[0].ident) == "Vec" {
1877 if !can_create { return default_value; }
1878 if let Some(inner_ty) = self.create_ownable_reference(&ty, generics) {
1879 return Some(syn::Type::Reference(syn::TypeReference {
1880 and_token: syn::Token![&](Span::call_site()),
1883 elem: Box::new(syn::Type::Slice(syn::TypeSlice {
1884 bracket_token: syn::token::Bracket { span: Span::call_site() },
1885 elem: Box::new(inner_ty)
1888 } else { return default_value; }
1889 } else { unimplemented!(); }
1890 } else { unimplemented!(); }
1891 } else { return None; }
1897 // *************************************************
1898 // *** Type definition during main.rs processing ***
1899 // *************************************************
1901 /// Returns true if the object at the given path is mapped as X { inner: *mut origX, .. }.
1902 pub fn c_type_has_inner_from_path(&self, full_path: &str) -> bool {
1903 self.crate_types.opaques.get(full_path).is_some()
1906 /// Returns true if the object at the given path is mapped as X { inner: *mut origX, .. }.
1907 pub fn c_type_has_inner(&self, ty: &syn::Type) -> bool {
1909 syn::Type::Path(p) => {
1910 if let Some(full_path) = self.maybe_resolve_path(&p.path, None) {
1911 self.c_type_has_inner_from_path(&full_path)
1914 syn::Type::Reference(r) => {
1915 self.c_type_has_inner(&*r.elem)
1921 pub fn maybe_resolve_ident(&self, id: &syn::Ident) -> Option<String> {
1922 self.types.maybe_resolve_ident(id)
1925 pub fn maybe_resolve_path(&self, p_arg: &syn::Path, generics: Option<&GenericTypes>) -> Option<String> {
1926 self.types.maybe_resolve_path(p_arg, generics)
1928 pub fn resolve_path(&self, p: &syn::Path, generics: Option<&GenericTypes>) -> String {
1929 self.maybe_resolve_path(p, generics).unwrap()
1932 // ***********************************
1933 // *** Original Rust Type Printing ***
1934 // ***********************************
1936 fn in_rust_prelude(resolved_path: &str) -> bool {
1937 match resolved_path {
1945 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) {
1946 if let Some(resolved) = self.maybe_resolve_path(&path, generics_resolver) {
1947 if self.is_primitive(&resolved) {
1948 write!(w, "{}", path.get_ident().unwrap()).unwrap();
1950 // TODO: We should have a generic "is from a dependency" check here instead of
1951 // checking for "bitcoin" explicitly.
1952 if resolved.starts_with("bitcoin::") || Self::in_rust_prelude(&resolved) {
1953 write!(w, "{}", resolved).unwrap();
1954 } else if !generated_crate_ref {
1955 // If we're printing a generic argument, it needs to reference the crate, otherwise
1956 // the original crate.
1957 write!(w, "{}", self.real_rust_type_mapping(&resolved)).unwrap();
1959 write!(w, "crate::{}", resolved).unwrap();
1962 if let syn::PathArguments::AngleBracketed(args) = &path.segments.iter().last().unwrap().arguments {
1963 self.write_rust_generic_arg(w, generics_resolver, args.args.iter(), with_ref_lifetime);
1966 if path.leading_colon.is_some() {
1967 write!(w, "::").unwrap();
1969 for (idx, seg) in path.segments.iter().enumerate() {
1970 if idx != 0 { write!(w, "::").unwrap(); }
1971 write!(w, "{}", seg.ident).unwrap();
1972 if let syn::PathArguments::AngleBracketed(args) = &seg.arguments {
1973 self.write_rust_generic_arg(w, generics_resolver, args.args.iter(), with_ref_lifetime);
1978 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>) {
1979 let mut had_params = false;
1980 for (idx, arg) in generics.enumerate() {
1981 if idx != 0 { write!(w, ", ").unwrap(); } else { write!(w, "<").unwrap(); }
1984 syn::GenericParam::Lifetime(lt) => write!(w, "'{}", lt.lifetime.ident).unwrap(),
1985 syn::GenericParam::Type(t) => {
1986 write!(w, "{}", t.ident).unwrap();
1987 if t.colon_token.is_some() { write!(w, ":").unwrap(); }
1988 for (idx, bound) in t.bounds.iter().enumerate() {
1989 if idx != 0 { write!(w, " + ").unwrap(); }
1991 syn::TypeParamBound::Trait(tb) => {
1992 if tb.paren_token.is_some() || tb.lifetimes.is_some() { unimplemented!(); }
1993 self.write_rust_path(w, generics_resolver, &tb.path, false, false);
1995 _ => unimplemented!(),
1998 if t.eq_token.is_some() || t.default.is_some() { unimplemented!(); }
2000 _ => unimplemented!(),
2003 if had_params { write!(w, ">").unwrap(); }
2006 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) {
2007 write!(w, "<").unwrap();
2008 for (idx, arg) in generics.enumerate() {
2009 if idx != 0 { write!(w, ", ").unwrap(); }
2011 syn::GenericArgument::Type(t) => self.write_rust_type(w, generics_resolver, t, with_ref_lifetime),
2012 _ => unimplemented!(),
2015 write!(w, ">").unwrap();
2017 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) {
2018 let real_ty = generics.resolve_type(t);
2019 let mut generate_crate_ref = force_crate_ref || t != real_ty;
2021 syn::Type::Path(p) => {
2022 if p.qself.is_some() {
2025 if let Some(resolved_ty) = self.maybe_resolve_path(&p.path, generics) {
2026 generate_crate_ref |= self.maybe_resolve_path(&p.path, None).as_ref() != Some(&resolved_ty);
2027 if self.crate_types.traits.get(&resolved_ty).is_none() { generate_crate_ref = false; }
2029 self.write_rust_path(w, generics, &p.path, with_ref_lifetime, generate_crate_ref);
2031 syn::Type::Reference(r) => {
2032 write!(w, "&").unwrap();
2033 if let Some(lft) = &r.lifetime {
2034 write!(w, "'{} ", lft.ident).unwrap();
2035 } else if with_ref_lifetime {
2036 write!(w, "'static ").unwrap();
2038 if r.mutability.is_some() {
2039 write!(w, "mut ").unwrap();
2041 self.do_write_rust_type(w, generics, &*r.elem, with_ref_lifetime, generate_crate_ref);
2043 syn::Type::Array(a) => {
2044 write!(w, "[").unwrap();
2045 self.do_write_rust_type(w, generics, &a.elem, with_ref_lifetime, generate_crate_ref);
2046 if let syn::Expr::Lit(l) = &a.len {
2047 if let syn::Lit::Int(i) = &l.lit {
2048 write!(w, "; {}]", i).unwrap();
2049 } else { unimplemented!(); }
2050 } else { unimplemented!(); }
2052 syn::Type::Slice(s) => {
2053 write!(w, "[").unwrap();
2054 self.do_write_rust_type(w, generics, &s.elem, with_ref_lifetime, generate_crate_ref);
2055 write!(w, "]").unwrap();
2057 syn::Type::Tuple(s) => {
2058 write!(w, "(").unwrap();
2059 for (idx, t) in s.elems.iter().enumerate() {
2060 if idx != 0 { write!(w, ", ").unwrap(); }
2061 self.do_write_rust_type(w, generics, &t, with_ref_lifetime, generate_crate_ref);
2063 write!(w, ")").unwrap();
2065 _ => unimplemented!(),
2068 pub fn write_rust_type<W: std::io::Write>(&self, w: &mut W, generics: Option<&GenericTypes>, t: &syn::Type, with_ref_lifetime: bool) {
2069 self.do_write_rust_type(w, generics, t, with_ref_lifetime, false);
2073 /// Prints a constructor for something which is "uninitialized" (but obviously not actually
2074 /// unint'd memory).
2075 pub fn write_empty_rust_val<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type) {
2077 syn::Type::Reference(r) => {
2078 self.write_empty_rust_val(generics, w, &*r.elem)
2080 syn::Type::Path(p) => {
2081 let resolved = self.resolve_path(&p.path, generics);
2082 if self.crate_types.opaques.get(&resolved).is_some() {
2083 write!(w, "crate::{} {{ inner: core::ptr::null_mut(), is_owned: true }}", resolved).unwrap();
2085 // Assume its a manually-mapped C type, where we can just define an null() fn
2086 write!(w, "{}::null()", self.c_type_from_path(&resolved, false, false).unwrap()).unwrap();
2089 syn::Type::Array(a) => {
2090 if let syn::Expr::Lit(l) = &a.len {
2091 if let syn::Lit::Int(i) = &l.lit {
2092 if i.base10_digits().parse::<usize>().unwrap() < 32 {
2093 // Blindly assume that if we're trying to create an empty value for an
2094 // array < 32 entries that all-0s may be a valid state.
2097 let arrty = format!("[u8; {}]", i.base10_digits());
2098 write!(w, "{}", self.to_c_conversion_inline_prefix_from_path(&arrty, false, false).unwrap()).unwrap();
2099 write!(w, "[0; {}]", i.base10_digits()).unwrap();
2100 write!(w, "{}", self.to_c_conversion_inline_suffix_from_path(&arrty, false, false).unwrap()).unwrap();
2101 } else { unimplemented!(); }
2102 } else { unimplemented!(); }
2104 _ => unimplemented!(),
2108 /// Prints a suffix to determine if a variable is empty (ie was set by write_empty_rust_val).
2109 /// See EmptyValExpectedTy for information on return types.
2110 fn write_empty_rust_val_check_suffix<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type) -> EmptyValExpectedTy {
2112 syn::Type::Reference(r) => {
2113 return self.write_empty_rust_val_check_suffix(generics, w, &*r.elem);
2115 syn::Type::Path(p) => {
2116 let resolved = self.resolve_path(&p.path, generics);
2117 if self.crate_types.opaques.get(&resolved).is_some() {
2118 write!(w, ".inner.is_null()").unwrap();
2119 EmptyValExpectedTy::NonPointer
2121 if let Some(suffix) = self.empty_val_check_suffix_from_path(&resolved) {
2122 write!(w, "{}", suffix).unwrap();
2123 // We may eventually need to allow empty_val_check_suffix_from_path to specify if we need a deref or not
2124 EmptyValExpectedTy::NonPointer
2126 write!(w, ".is_none()").unwrap();
2127 EmptyValExpectedTy::OptionType
2131 syn::Type::Array(a) => {
2132 if let syn::Expr::Lit(l) = &a.len {
2133 if let syn::Lit::Int(i) = &l.lit {
2134 write!(w, ".data == [0; {}]", i.base10_digits()).unwrap();
2135 EmptyValExpectedTy::NonPointer
2136 } else { unimplemented!(); }
2137 } else { unimplemented!(); }
2139 syn::Type::Slice(_) => {
2140 // Option<[]> always implies that we want to treat len() == 0 differently from
2141 // None, so we always map an Option<[]> into a pointer.
2142 write!(w, " == core::ptr::null_mut()").unwrap();
2143 EmptyValExpectedTy::ReferenceAsPointer
2145 _ => unimplemented!(),
2149 /// Prints a suffix to determine if a variable is empty (ie was set by write_empty_rust_val).
2150 pub fn write_empty_rust_val_check<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type, var_access: &str) {
2152 syn::Type::Reference(r) => {
2153 self.write_empty_rust_val_check(generics, w, &*r.elem, var_access);
2155 syn::Type::Path(_) => {
2156 write!(w, "{}", var_access).unwrap();
2157 self.write_empty_rust_val_check_suffix(generics, w, t);
2159 syn::Type::Array(a) => {
2160 if let syn::Expr::Lit(l) = &a.len {
2161 if let syn::Lit::Int(i) = &l.lit {
2162 let arrty = format!("[u8; {}]", i.base10_digits());
2163 // We don't (yet) support a new-var conversion here.
2164 assert!(self.from_c_conversion_new_var_from_path(&arrty, false).is_none());
2166 self.from_c_conversion_prefix_from_path(&arrty, false).unwrap(),
2168 self.from_c_conversion_suffix_from_path(&arrty, false).unwrap()).unwrap();
2169 self.write_empty_rust_val_check_suffix(generics, w, t);
2170 } else { unimplemented!(); }
2171 } else { unimplemented!(); }
2173 _ => unimplemented!(),
2177 // ********************************
2178 // *** Type conversion printing ***
2179 // ********************************
2181 /// Returns true we if can just skip passing this to C entirely
2182 pub fn skip_arg(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> bool {
2184 syn::Type::Path(p) => {
2185 if p.qself.is_some() { unimplemented!(); }
2186 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
2187 self.skip_path(&full_path)
2190 syn::Type::Reference(r) => {
2191 self.skip_arg(&*r.elem, generics)
2196 pub fn no_arg_to_rust<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2198 syn::Type::Path(p) => {
2199 if p.qself.is_some() { unimplemented!(); }
2200 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
2201 write!(w, "{}", self.no_arg_path_to_rust(&full_path)).unwrap();
2204 syn::Type::Reference(r) => {
2205 self.no_arg_to_rust(w, &*r.elem, generics);
2211 fn write_conversion_inline_intern<W: std::io::Write,
2212 LP: Fn(&str, bool, bool) -> Option<String>, DL: Fn(&mut W, &DeclType, &str, bool, bool), SC: Fn(bool, Option<&str>) -> String>
2213 (&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, is_ref: bool, is_mut: bool, ptr_for_ref: bool,
2214 tupleconv: &str, prefix: bool, sliceconv: SC, path_lookup: LP, decl_lookup: DL) {
2215 match generics.resolve_type(t) {
2216 syn::Type::Reference(r) => {
2217 self.write_conversion_inline_intern(w, &*r.elem, generics, true, r.mutability.is_some(),
2218 ptr_for_ref, tupleconv, prefix, sliceconv, path_lookup, decl_lookup);
2220 syn::Type::Path(p) => {
2221 if p.qself.is_some() {
2225 let resolved_path = self.resolve_path(&p.path, generics);
2226 if let Some(aliased_type) = self.crate_types.type_aliases.get(&resolved_path) {
2227 return self.write_conversion_inline_intern(w, aliased_type, None, is_ref, is_mut, ptr_for_ref, tupleconv, prefix, sliceconv, path_lookup, decl_lookup);
2228 } else if self.is_primitive(&resolved_path) {
2229 if is_ref && prefix {
2230 write!(w, "*").unwrap();
2232 } else if let Some(c_type) = path_lookup(&resolved_path, is_ref, ptr_for_ref) {
2233 write!(w, "{}", c_type).unwrap();
2234 } else if let Some((_, generics)) = self.crate_types.opaques.get(&resolved_path) {
2235 decl_lookup(w, &DeclType::StructImported { generics: &generics }, &resolved_path, is_ref, is_mut);
2236 } else if self.crate_types.mirrored_enums.get(&resolved_path).is_some() {
2237 decl_lookup(w, &DeclType::MirroredEnum, &resolved_path, is_ref, is_mut);
2238 } else if let Some(t) = self.crate_types.traits.get(&resolved_path) {
2239 decl_lookup(w, &DeclType::Trait(t), &resolved_path, is_ref, is_mut);
2240 } else if let Some(ident) = single_ident_generic_path_to_ident(&p.path) {
2241 if let Some(decl_type) = self.types.maybe_resolve_declared(ident) {
2242 decl_lookup(w, decl_type, &self.maybe_resolve_ident(ident).unwrap(), is_ref, is_mut);
2243 } else { unimplemented!(); }
2245 if let Some(trait_impls) = self.crate_types.traits_impld.get(&resolved_path) {
2246 if trait_impls.len() == 1 {
2247 // If this is a no-export'd crate and there's only one implementation
2248 // in the whole crate, just treat it as a reference to whatever the
2250 let implementor = self.crate_types.opaques.get(&trait_impls[0]).unwrap();
2251 decl_lookup(w, &DeclType::StructImported { generics: &implementor.1 }, &trait_impls[0], true, is_mut);
2258 syn::Type::Array(a) => {
2259 if let syn::Type::Path(p) = &*a.elem {
2260 let inner_ty = self.resolve_path(&p.path, generics);
2261 if let syn::Expr::Lit(l) = &a.len {
2262 if let syn::Lit::Int(i) = &l.lit {
2263 write!(w, "{}", path_lookup(&format!("[{}; {}]", inner_ty, i.base10_digits()), is_ref, ptr_for_ref).unwrap()).unwrap();
2264 } else { unimplemented!(); }
2265 } else { unimplemented!(); }
2266 } else { unimplemented!(); }
2268 syn::Type::Slice(s) => {
2269 // We assume all slices contain only literals or references.
2270 // This may result in some outputs not compiling.
2271 if let syn::Type::Path(p) = &*s.elem {
2272 let resolved = self.resolve_path(&p.path, generics);
2273 if self.is_primitive(&resolved) {
2274 write!(w, "{}", path_lookup("[u8]", is_ref, ptr_for_ref).unwrap()).unwrap();
2276 write!(w, "{}", sliceconv(true, None)).unwrap();
2278 } else if let syn::Type::Reference(r) = &*s.elem {
2279 if let syn::Type::Path(p) = &*r.elem {
2280 write!(w, "{}", sliceconv(self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)), None)).unwrap();
2281 } else if let syn::Type::Slice(_) = &*r.elem {
2282 write!(w, "{}", sliceconv(false, None)).unwrap();
2283 } else { unimplemented!(); }
2284 } else if let syn::Type::Tuple(t) = &*s.elem {
2285 assert!(!t.elems.is_empty());
2287 write!(w, "{}", sliceconv(false, None)).unwrap();
2289 let mut needs_map = false;
2290 for e in t.elems.iter() {
2291 if let syn::Type::Reference(_) = e {
2296 let mut map_str = Vec::new();
2297 write!(&mut map_str, ".map(|(").unwrap();
2298 for i in 0..t.elems.len() {
2299 write!(&mut map_str, "{}{}", if i != 0 { ", " } else { "" }, ('a' as u8 + i as u8) as char).unwrap();
2301 write!(&mut map_str, ")| (").unwrap();
2302 for (idx, e) in t.elems.iter().enumerate() {
2303 if let syn::Type::Reference(_) = e {
2304 write!(&mut map_str, "{}{}", if idx != 0 { ", " } else { "" }, (idx as u8 + 'a' as u8) as char).unwrap();
2305 } else if let syn::Type::Path(_) = e {
2306 write!(&mut map_str, "{}*{}", if idx != 0 { ", " } else { "" }, (idx as u8 + 'a' as u8) as char).unwrap();
2307 } else { unimplemented!(); }
2309 write!(&mut map_str, "))").unwrap();
2310 write!(w, "{}", sliceconv(false, Some(&String::from_utf8(map_str).unwrap()))).unwrap();
2312 write!(w, "{}", sliceconv(false, None)).unwrap();
2315 } else if let syn::Type::Array(_) = &*s.elem {
2316 write!(w, "{}", sliceconv(false, Some(".map(|a| *a)"))).unwrap();
2317 } else { unimplemented!(); }
2319 syn::Type::Tuple(t) => {
2320 if t.elems.is_empty() {
2321 // cbindgen has poor support for (), see, eg https://github.com/eqrion/cbindgen/issues/527
2322 // so work around it by just pretending its a 0u8
2323 write!(w, "{}", tupleconv).unwrap();
2325 if prefix { write!(w, "local_").unwrap(); }
2328 _ => unimplemented!(),
2332 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) {
2333 self.write_conversion_inline_intern(w, t, generics, is_ref, false, ptr_for_ref, "() /*", true, |_, _| "local_".to_owned(),
2334 |a, b, c| self.to_c_conversion_inline_prefix_from_path(a, b, c),
2335 |w, decl_type, decl_path, is_ref, _is_mut| {
2337 DeclType::MirroredEnum if is_ref && ptr_for_ref => write!(w, "crate::{}::from_native(", decl_path).unwrap(),
2338 DeclType::MirroredEnum if is_ref => write!(w, "&crate::{}::from_native(", decl_path).unwrap(),
2339 DeclType::MirroredEnum => write!(w, "crate::{}::native_into(", decl_path).unwrap(),
2340 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if is_ref && from_ptr => {
2341 if !ptr_for_ref { write!(w, "&").unwrap(); }
2342 write!(w, "crate::{} {{ inner: unsafe {{ (", decl_path).unwrap()
2344 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if is_ref => {
2345 if !ptr_for_ref { write!(w, "&").unwrap(); }
2346 write!(w, "crate::{} {{ inner: unsafe {{ ObjOps::nonnull_ptr_to_inner((", decl_path).unwrap()
2348 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref && from_ptr =>
2349 write!(w, "crate::{} {{ inner: ", decl_path).unwrap(),
2350 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref =>
2351 write!(w, "crate::{} {{ inner: ObjOps::heap_alloc(", decl_path).unwrap(),
2352 DeclType::Trait(_) if is_ref => write!(w, "").unwrap(),
2353 DeclType::Trait(_) if !is_ref => write!(w, "Into::into(").unwrap(),
2354 _ => panic!("{:?}", decl_path),
2358 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) {
2359 self.write_to_c_conversion_inline_prefix_inner(w, t, generics, false, ptr_for_ref, false);
2361 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) {
2362 self.write_conversion_inline_intern(w, t, generics, is_ref, false, ptr_for_ref, "*/", false, |_, _| ".into()".to_owned(),
2363 |a, b, c| self.to_c_conversion_inline_suffix_from_path(a, b, c),
2364 |w, decl_type, full_path, is_ref, _is_mut| match decl_type {
2365 DeclType::MirroredEnum => write!(w, ")").unwrap(),
2366 DeclType::EnumIgnored { generics }|DeclType::StructImported { generics } if is_ref => {
2367 write!(w, " as *const {}<", full_path).unwrap();
2368 for param in generics.params.iter() {
2369 if let syn::GenericParam::Lifetime(_) = param {
2370 write!(w, "'_, ").unwrap();
2372 write!(w, "_, ").unwrap();
2376 write!(w, ">) as *mut _ }}, is_owned: false }}").unwrap();
2378 write!(w, ">) as *mut _) }}, is_owned: false }}").unwrap();
2381 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref && from_ptr =>
2382 write!(w, ", is_owned: true }}").unwrap(),
2383 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref => write!(w, "), is_owned: true }}").unwrap(),
2384 DeclType::Trait(_) if is_ref => {},
2385 DeclType::Trait(_) => {
2386 // This is used when we're converting a concrete Rust type into a C trait
2387 // for use when a Rust trait method returns an associated type.
2388 // Because all of our C traits implement From<RustTypesImplementingTraits>
2389 // we can just call .into() here and be done.
2390 write!(w, ")").unwrap()
2392 _ => unimplemented!(),
2395 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) {
2396 self.write_to_c_conversion_inline_suffix_inner(w, t, generics, false, ptr_for_ref, false);
2399 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) {
2400 self.write_conversion_inline_intern(w, t, generics, is_ref, false, false, "() /*", true, |_, _| "&local_".to_owned(),
2401 |a, b, _c| self.from_c_conversion_prefix_from_path(a, b),
2402 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
2403 DeclType::StructImported {..} if is_ref => write!(w, "").unwrap(),
2404 DeclType::StructImported {..} if !is_ref => write!(w, "*unsafe {{ Box::from_raw(").unwrap(),
2405 DeclType::MirroredEnum if is_ref => write!(w, "&").unwrap(),
2406 DeclType::MirroredEnum => {},
2407 DeclType::Trait(_) => {},
2408 _ => unimplemented!(),
2411 pub fn write_from_c_conversion_prefix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2412 self.write_from_c_conversion_prefix_inner(w, t, generics, false, false);
2414 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) {
2415 self.write_conversion_inline_intern(w, t, generics, is_ref, false, false, "*/", false,
2416 |has_inner, map_str_opt| match (has_inner, map_str_opt) {
2417 (false, Some(map_str)) => format!(".iter(){}.collect::<Vec<_>>()[..]", map_str),
2418 (false, None) => ".iter().collect::<Vec<_>>()[..]".to_owned(),
2419 (true, None) => "[..]".to_owned(),
2420 (true, Some(_)) => unreachable!(),
2422 |a, b, _c| self.from_c_conversion_suffix_from_path(a, b),
2423 |w, decl_type, _full_path, is_ref, is_mut| match decl_type {
2424 DeclType::StructImported {..} if is_ref && ptr_for_ref => write!(w, "XXX unimplemented").unwrap(),
2425 DeclType::StructImported {..} if is_mut && is_ref => write!(w, ".get_native_mut_ref()").unwrap(),
2426 DeclType::StructImported {..} if is_ref => write!(w, ".get_native_ref()").unwrap(),
2427 DeclType::StructImported {..} if !is_ref => write!(w, ".take_inner()) }}").unwrap(),
2428 DeclType::MirroredEnum if is_ref => write!(w, ".to_native()").unwrap(),
2429 DeclType::MirroredEnum => write!(w, ".into_native()").unwrap(),
2430 DeclType::Trait(_) => {},
2431 _ => unimplemented!(),
2434 pub fn write_from_c_conversion_suffix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2435 self.write_from_c_conversion_suffix_inner(w, t, generics, false, false);
2437 // Note that compared to the above conversion functions, the following two are generally
2438 // significantly undertested:
2439 pub fn write_from_c_conversion_to_ref_prefix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2440 self.write_conversion_inline_intern(w, t, generics, false, false, false, "() /*", true, |_, _| "&local_".to_owned(),
2442 if let Some(conv) = self.from_c_conversion_prefix_from_path(a, b) {
2443 Some(format!("&{}", conv))
2446 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
2447 DeclType::StructImported {..} if !is_ref => write!(w, "").unwrap(),
2448 _ => unimplemented!(),
2451 pub fn write_from_c_conversion_to_ref_suffix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2452 self.write_conversion_inline_intern(w, t, generics, false, false, false, "*/", false,
2453 |has_inner, map_str_opt| match (has_inner, map_str_opt) {
2454 (false, Some(map_str)) => format!(".iter(){}.collect::<Vec<_>>()[..]", map_str),
2455 (false, None) => ".iter().collect::<Vec<_>>()[..]".to_owned(),
2456 (true, None) => "[..]".to_owned(),
2457 (true, Some(_)) => unreachable!(),
2459 |a, b, _c| self.from_c_conversion_suffix_from_path(a, b),
2460 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
2461 DeclType::StructImported {..} if !is_ref => write!(w, ".get_native_ref()").unwrap(),
2462 _ => unimplemented!(),
2466 fn write_conversion_new_var_intern<'b, W: std::io::Write,
2467 LP: Fn(&str, bool) -> Option<(&str, &str)>,
2468 LC: Fn(&str, bool, Option<&syn::Type>, &syn::Ident, &str) -> Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)>,
2469 VP: Fn(&mut W, &syn::Type, Option<&GenericTypes>, bool, bool, bool),
2470 VS: Fn(&mut W, &syn::Type, Option<&GenericTypes>, bool, bool, bool)>
2471 (&self, w: &mut W, ident: &syn::Ident, var: &str, t: &syn::Type, generics: Option<&GenericTypes>,
2472 mut is_ref: bool, mut ptr_for_ref: bool, to_c: bool, from_ownable_ref: bool,
2473 path_lookup: &LP, container_lookup: &LC, var_prefix: &VP, var_suffix: &VS) -> bool {
2475 macro_rules! convert_container {
2476 ($container_type: expr, $args_len: expr, $args_iter: expr) => { {
2477 // For slices (and Options), we refuse to directly map them as is_ref when they
2478 // aren't opaque types containing an inner pointer. This is due to the fact that,
2479 // in both cases, the actual higher-level type is non-is_ref.
2480 let (ty_has_inner, ty_is_trait) = if $args_len == 1 {
2481 let ty = $args_iter().next().unwrap();
2482 if $container_type == "Slice" && to_c {
2483 // "To C ptr_for_ref" means "return the regular object with is_owned
2484 // set to false", which is totally what we want in a slice if we're about to
2485 // set ty_has_inner.
2488 if let syn::Type::Reference(t) = ty {
2489 if let syn::Type::Path(p) = &*t.elem {
2490 let resolved = self.resolve_path(&p.path, generics);
2491 (self.c_type_has_inner_from_path(&resolved), self.crate_types.traits.get(&resolved).is_some())
2492 } else { (false, false) }
2493 } else if let syn::Type::Path(p) = ty {
2494 let resolved = self.resolve_path(&p.path, generics);
2495 (self.c_type_has_inner_from_path(&resolved), self.crate_types.traits.get(&resolved).is_some())
2496 } else { (false, false) }
2497 } else { (true, false) };
2499 // Options get a bunch of special handling, since in general we map Option<>al
2500 // types into the same C type as non-Option-wrapped types. This ends up being
2501 // pretty manual here and most of the below special-cases are for Options.
2502 let mut needs_ref_map = false;
2503 let mut only_contained_type = None;
2504 let mut only_contained_type_nonref = None;
2505 let mut only_contained_has_inner = false;
2506 let mut contains_slice = false;
2508 only_contained_has_inner = ty_has_inner;
2509 let arg = $args_iter().next().unwrap();
2510 if let syn::Type::Reference(t) = arg {
2511 only_contained_type = Some(arg);
2512 only_contained_type_nonref = Some(&*t.elem);
2513 if let syn::Type::Path(_) = &*t.elem {
2515 } else if let syn::Type::Slice(_) = &*t.elem {
2516 contains_slice = true;
2517 } else { return false; }
2518 // If the inner element contains an inner pointer, we will just use that,
2519 // avoiding the need to map elements to references. Otherwise we'll need to
2520 // do an extra mapping step.
2521 needs_ref_map = !only_contained_has_inner && !ty_is_trait && $container_type == "Option";
2523 only_contained_type = Some(arg);
2524 only_contained_type_nonref = Some(arg);
2528 if let Some((prefix, conversions, suffix, prefix_location)) = container_lookup(&$container_type, is_ref, only_contained_type, ident, var) {
2529 assert_eq!(conversions.len(), $args_len);
2530 write!(w, "let mut local_{}{} = ", ident,
2531 if (!to_c && needs_ref_map) || (to_c && $container_type == "Option" && contains_slice) {"_base"} else { "" }).unwrap();
2532 if prefix_location == ContainerPrefixLocation::OutsideConv {
2533 var_prefix(w, $args_iter().next().unwrap(), generics, is_ref, true, true);
2535 write!(w, "{}{}", prefix, var).unwrap();
2537 for ((pfx, var_name), (idx, ty)) in conversions.iter().zip($args_iter().enumerate()) {
2538 let mut var = std::io::Cursor::new(Vec::new());
2539 write!(&mut var, "{}", var_name).unwrap();
2540 let var_access = String::from_utf8(var.into_inner()).unwrap();
2542 let conv_ty = if needs_ref_map { only_contained_type_nonref.as_ref().unwrap() } else { ty };
2544 write!(w, "{} {{ ", pfx).unwrap();
2545 let new_var_name = format!("{}_{}", ident, idx);
2546 let new_var = self.write_conversion_new_var_intern(w, &format_ident!("{}", new_var_name),
2547 &var_access, conv_ty, generics, contains_slice || (is_ref && ty_has_inner), ptr_for_ref,
2548 to_c, from_ownable_ref, path_lookup, container_lookup, var_prefix, var_suffix);
2549 if new_var { write!(w, " ").unwrap(); }
2551 if prefix_location == ContainerPrefixLocation::PerConv {
2552 var_prefix(w, conv_ty, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2553 } else if !is_ref && !needs_ref_map && to_c && only_contained_has_inner {
2554 write!(w, "ObjOps::heap_alloc(").unwrap();
2557 write!(w, "{}{}", if contains_slice && !to_c { "local_" } else { "" }, if new_var { new_var_name } else { var_access }).unwrap();
2558 if prefix_location == ContainerPrefixLocation::PerConv {
2559 var_suffix(w, conv_ty, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2560 } else if !is_ref && !needs_ref_map && to_c && only_contained_has_inner {
2561 write!(w, ")").unwrap();
2563 write!(w, " }}").unwrap();
2565 write!(w, "{}", suffix).unwrap();
2566 if prefix_location == ContainerPrefixLocation::OutsideConv {
2567 var_suffix(w, $args_iter().next().unwrap(), generics, is_ref, ptr_for_ref, true);
2569 write!(w, ";").unwrap();
2570 if !to_c && needs_ref_map {
2571 write!(w, " let mut local_{} = local_{}_base.as_ref()", ident, ident).unwrap();
2573 write!(w, ".map(|a| &a[..])").unwrap();
2575 write!(w, ";").unwrap();
2576 } else if to_c && $container_type == "Option" && contains_slice {
2577 write!(w, " let mut local_{} = *local_{}_base;", ident, ident).unwrap();
2584 match generics.resolve_type(t) {
2585 syn::Type::Reference(r) => {
2586 if let syn::Type::Slice(_) = &*r.elem {
2587 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)
2589 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)
2592 syn::Type::Path(p) => {
2593 if p.qself.is_some() {
2596 let resolved_path = self.resolve_path(&p.path, generics);
2597 if let Some(aliased_type) = self.crate_types.type_aliases.get(&resolved_path) {
2598 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);
2600 if self.is_known_container(&resolved_path, is_ref) || self.is_path_transparent_container(&p.path, generics, is_ref) {
2601 if let syn::PathArguments::AngleBracketed(args) = &p.path.segments.iter().next().unwrap().arguments {
2602 convert_container!(resolved_path, args.args.len(), || args.args.iter().map(|arg| {
2603 if let syn::GenericArgument::Type(ty) = arg {
2604 generics.resolve_type(ty)
2605 } else { unimplemented!(); }
2607 } else { unimplemented!(); }
2609 if self.is_primitive(&resolved_path) {
2611 } else if let Some(ty_ident) = single_ident_generic_path_to_ident(&p.path) {
2612 if let Some((prefix, suffix)) = path_lookup(&resolved_path, is_ref) {
2613 write!(w, "let mut local_{} = {}{}{};", ident, prefix, var, suffix).unwrap();
2615 } else if self.types.maybe_resolve_declared(ty_ident).is_some() {
2620 syn::Type::Array(_) => {
2621 // We assume all arrays contain only primitive types.
2622 // This may result in some outputs not compiling.
2625 syn::Type::Slice(s) => {
2626 if let syn::Type::Path(p) = &*s.elem {
2627 let resolved = self.resolve_path(&p.path, generics);
2628 if self.is_primitive(&resolved) {
2629 let slice_path = format!("[{}]", resolved);
2630 if let Some((prefix, suffix)) = path_lookup(&slice_path, true) {
2631 write!(w, "let mut local_{} = {}{}{};", ident, prefix, var, suffix).unwrap();
2635 let tyref = [&*s.elem];
2637 // If we're converting from a slice to a Vec, assume we can clone the
2638 // elements and clone them into a new Vec first. Next we'll walk the
2639 // new Vec here and convert them to C types.
2640 write!(w, "let mut local_{}_clone = Vec::new(); local_{}_clone.extend_from_slice({}); let mut {} = local_{}_clone; ", ident, ident, ident, ident, ident).unwrap();
2643 convert_container!("Vec", 1, || tyref.iter().map(|t| generics.resolve_type(*t)));
2644 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2646 } else if let syn::Type::Reference(ty) = &*s.elem {
2647 let tyref = if from_ownable_ref || !to_c { [&*ty.elem] } else { [&*s.elem] };
2649 convert_container!("Slice", 1, || tyref.iter().map(|t| generics.resolve_type(*t)));
2650 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2651 } else if let syn::Type::Tuple(t) = &*s.elem {
2652 // When mapping into a temporary new var, we need to own all the underlying objects.
2653 // Thus, we drop any references inside the tuple and convert with non-reference types.
2654 let mut elems = syn::punctuated::Punctuated::new();
2655 for elem in t.elems.iter() {
2656 if let syn::Type::Reference(r) = elem {
2657 elems.push((*r.elem).clone());
2659 elems.push(elem.clone());
2662 let ty = [syn::Type::Tuple(syn::TypeTuple {
2663 paren_token: t.paren_token, elems
2667 convert_container!("Slice", 1, || ty.iter());
2668 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2669 } else if let syn::Type::Array(_) = &*s.elem {
2672 let arr_elem = [(*s.elem).clone()];
2673 convert_container!("Slice", 1, || arr_elem.iter());
2674 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2675 } else { unimplemented!() }
2677 syn::Type::Tuple(t) => {
2678 if !t.elems.is_empty() {
2679 // We don't (yet) support tuple elements which cannot be converted inline
2680 write!(w, "let (").unwrap();
2681 for idx in 0..t.elems.len() {
2682 if idx != 0 { write!(w, ", ").unwrap(); }
2683 write!(w, "{} orig_{}_{}", if is_ref { "ref" } else { "mut" }, ident, idx).unwrap();
2685 write!(w, ") = {}{}; ", var, if !to_c { ".to_rust()" } else { "" }).unwrap();
2686 // Like other template types, tuples are always mapped as their non-ref
2687 // versions for types which have different ref mappings. Thus, we convert to
2688 // non-ref versions and handle opaque types with inner pointers manually.
2689 for (idx, elem) in t.elems.iter().enumerate() {
2690 if let syn::Type::Path(p) = elem {
2691 let v_name = format!("orig_{}_{}", ident, idx);
2692 let tuple_elem_ident = format_ident!("{}", &v_name);
2693 if self.write_conversion_new_var_intern(w, &tuple_elem_ident, &v_name, elem, generics,
2694 false, ptr_for_ref, to_c, from_ownable_ref,
2695 path_lookup, container_lookup, var_prefix, var_suffix) {
2696 write!(w, " ").unwrap();
2697 // Opaque types with inner pointers shouldn't ever create new stack
2698 // variables, so we don't handle it and just assert that it doesn't
2700 assert!(!self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)));
2704 write!(w, "let mut local_{} = (", ident).unwrap();
2705 for (idx, elem) in t.elems.iter().enumerate() {
2706 let real_elem = generics.resolve_type(&elem);
2707 let ty_has_inner = {
2709 // "To C ptr_for_ref" means "return the regular object with
2710 // is_owned set to false", which is totally what we want
2711 // if we're about to set ty_has_inner.
2714 if let syn::Type::Reference(t) = real_elem {
2715 if let syn::Type::Path(p) = &*t.elem {
2716 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
2718 } else if let syn::Type::Path(p) = real_elem {
2719 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
2722 if idx != 0 { write!(w, ", ").unwrap(); }
2723 var_prefix(w, real_elem, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2724 if is_ref && ty_has_inner {
2725 // For ty_has_inner, the regular var_prefix mapping will take a
2726 // reference, so deref once here to make sure we keep the original ref.
2727 write!(w, "*").unwrap();
2729 write!(w, "orig_{}_{}", ident, idx).unwrap();
2730 if is_ref && !ty_has_inner {
2731 // If we don't have an inner variable's reference to maintain, just
2732 // hope the type is Clonable and use that.
2733 write!(w, ".clone()").unwrap();
2735 var_suffix(w, real_elem, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2737 write!(w, "){};", if to_c { ".into()" } else { "" }).unwrap();
2741 _ => unimplemented!(),
2745 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 {
2746 self.write_conversion_new_var_intern(w, ident, var_access, t, generics, from_ownable_ref, ptr_for_ref, true, from_ownable_ref,
2747 &|a, b| self.to_c_conversion_new_var_from_path(a, b),
2748 &|a, b, c, d, e| self.to_c_conversion_container_new_var(generics, a, b, c, d, e),
2749 // We force ptr_for_ref here since we can't generate a ref on one line and use it later
2750 &|a, b, c, d, e, f| self.write_to_c_conversion_inline_prefix_inner(a, b, c, d, e, f),
2751 &|a, b, c, d, e, f| self.write_to_c_conversion_inline_suffix_inner(a, b, c, d, e, f))
2753 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 {
2754 self.write_to_c_conversion_new_var_inner(w, ident, &format!("{}", ident), t, generics, ptr_for_ref, false)
2756 /// Prints new-var conversion for an "ownable_ref" type, ie prints conversion for
2757 /// `create_ownable_reference(t)`, not `t` itself.
2758 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 {
2759 self.write_to_c_conversion_new_var_inner(w, ident, &format!("{}", ident), t, generics, true, true)
2761 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 {
2762 self.write_conversion_new_var_intern(w, ident, &format!("{}", ident), t, generics, false, false, false, false,
2763 &|a, b| self.from_c_conversion_new_var_from_path(a, b),
2764 &|a, b, c, d, e| self.from_c_conversion_container_new_var(generics, a, b, c, d, e),
2765 // We force ptr_for_ref here since we can't generate a ref on one line and use it later
2766 &|a, b, c, d, e, _f| self.write_from_c_conversion_prefix_inner(a, b, c, d, e),
2767 &|a, b, c, d, e, _f| self.write_from_c_conversion_suffix_inner(a, b, c, d, e))
2770 // ******************************************************
2771 // *** C Container Type Equivalent and alias Printing ***
2772 // ******************************************************
2774 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 {
2775 for (idx, orig_t) in args.enumerate() {
2777 write!(w, ", ").unwrap();
2779 let t = generics.resolve_type(orig_t);
2780 if let syn::Type::Reference(r_arg) = t {
2781 assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
2783 if !self.write_c_type_intern(w, &*r_arg.elem, generics, false, false, false, true, true) { return false; }
2785 // While write_c_type_intern, above is correct, we don't want to blindly convert a
2786 // reference to something stupid, so check that the container is either opaque or a
2787 // predefined type (currently only Transaction).
2788 if let syn::Type::Path(p_arg) = &*r_arg.elem {
2789 let resolved = self.resolve_path(&p_arg.path, generics);
2790 assert!(self.crate_types.opaques.get(&resolved).is_some() ||
2791 self.crate_types.traits.get(&resolved).is_some() ||
2792 self.c_type_from_path(&resolved, true, true).is_some(), "Template generics should be opaque or have a predefined mapping");
2793 } else { unimplemented!(); }
2794 } else if let syn::Type::Path(p_arg) = t {
2795 if let Some(resolved) = self.maybe_resolve_path(&p_arg.path, generics) {
2796 if !self.is_primitive(&resolved) && self.c_type_from_path(&resolved, false, false).is_none() {
2798 // We don't currently support outer reference types for non-primitive inners
2805 if !self.write_c_type_intern(w, t, generics, false, false, false, true, true) { return false; }
2807 // We don't currently support outer reference types for non-primitive inners,
2808 // except for the empty tuple.
2809 if let syn::Type::Tuple(t_arg) = t {
2810 assert!(t_arg.elems.len() == 0 || !is_ref);
2814 if !self.write_c_type_intern(w, t, generics, false, false, false, true, true) { return false; }
2819 fn check_create_container(&self, mangled_container: String, container_type: &str, args: Vec<&syn::Type>, generics: Option<&GenericTypes>, is_ref: bool) -> bool {
2820 if !self.crate_types.templates_defined.borrow().get(&mangled_container).is_some() {
2821 let mut created_container: Vec<u8> = Vec::new();
2823 if container_type == "Result" {
2824 let mut a_ty: Vec<u8> = Vec::new();
2825 if let syn::Type::Tuple(tup) = args.iter().next().unwrap() {
2826 if tup.elems.is_empty() {
2827 write!(&mut a_ty, "()").unwrap();
2829 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t).take(1), generics, is_ref) { return false; }
2832 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t).take(1), generics, is_ref) { return false; }
2835 let mut b_ty: Vec<u8> = Vec::new();
2836 if let syn::Type::Tuple(tup) = args.iter().skip(1).next().unwrap() {
2837 if tup.elems.is_empty() {
2838 write!(&mut b_ty, "()").unwrap();
2840 if !self.write_template_generics(&mut b_ty, &mut args.iter().map(|t| *t).skip(1), generics, is_ref) { return false; }
2843 if !self.write_template_generics(&mut b_ty, &mut args.iter().map(|t| *t).skip(1), generics, is_ref) { return false; }
2846 let ok_str = String::from_utf8(a_ty).unwrap();
2847 let err_str = String::from_utf8(b_ty).unwrap();
2848 let is_clonable = self.is_clonable(&ok_str) && self.is_clonable(&err_str);
2849 write_result_block(&mut created_container, &mangled_container, &ok_str, &err_str, is_clonable);
2851 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2853 } else if container_type == "Vec" {
2854 let mut a_ty: Vec<u8> = Vec::new();
2855 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t), generics, is_ref) { return false; }
2856 let ty = String::from_utf8(a_ty).unwrap();
2857 let is_clonable = self.is_clonable(&ty);
2858 write_vec_block(&mut created_container, &mangled_container, &ty, is_clonable);
2860 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2862 } else if container_type.ends_with("Tuple") {
2863 let mut tuple_args = Vec::new();
2864 let mut is_clonable = true;
2865 for arg in args.iter() {
2866 let mut ty: Vec<u8> = Vec::new();
2867 if !self.write_template_generics(&mut ty, &mut [arg].iter().map(|t| **t), generics, is_ref) { return false; }
2868 let ty_str = String::from_utf8(ty).unwrap();
2869 if !self.is_clonable(&ty_str) {
2870 is_clonable = false;
2872 tuple_args.push(ty_str);
2874 write_tuple_block(&mut created_container, &mangled_container, &tuple_args, is_clonable);
2876 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2878 } else if container_type == "Option" {
2879 let mut a_ty: Vec<u8> = Vec::new();
2880 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t), generics, is_ref) { return false; }
2881 let ty = String::from_utf8(a_ty).unwrap();
2882 let is_clonable = self.is_clonable(&ty);
2883 write_option_block(&mut created_container, &mangled_container, &ty, is_clonable);
2885 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2890 self.crate_types.write_new_template(mangled_container.clone(), true, &created_container);
2894 fn path_to_generic_args(path: &syn::Path) -> Vec<&syn::Type> {
2895 if let syn::PathArguments::AngleBracketed(args) = &path.segments.iter().next().unwrap().arguments {
2896 args.args.iter().map(|gen| if let syn::GenericArgument::Type(t) = gen { t } else { unimplemented!() }).collect()
2897 } else { unimplemented!(); }
2899 fn write_c_mangled_container_path_intern<W: std::io::Write>
2900 (&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 {
2901 let mut mangled_type: Vec<u8> = Vec::new();
2902 if !self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) {
2903 write!(w, "C{}_", ident).unwrap();
2904 write!(mangled_type, "C{}_", ident).unwrap();
2905 } else { assert_eq!(args.len(), 1); }
2906 for arg in args.iter() {
2907 macro_rules! write_path {
2908 ($p_arg: expr, $extra_write: expr) => {
2909 if let Some(subtype) = self.maybe_resolve_path(&$p_arg.path, generics) {
2910 if self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) {
2912 if self.c_type_has_inner_from_path(&subtype) {
2913 if !self.write_c_path_intern(w, &$p_arg.path, generics, is_ref, is_mut, ptr_for_ref, false, true) { return false; }
2915 // Option<T> needs to be converted to a *mut T, ie mut ptr-for-ref
2916 if !self.write_c_path_intern(w, &$p_arg.path, generics, true, true, true, false, true) { return false; }
2919 write!(w, "{}", $p_arg.path.segments.last().unwrap().ident).unwrap();
2921 } else if self.is_known_container(&subtype, is_ref) || self.is_path_transparent_container(&$p_arg.path, generics, is_ref) {
2922 if !self.write_c_mangled_container_path_intern(w, Self::path_to_generic_args(&$p_arg.path), generics,
2923 &subtype, is_ref, is_mut, ptr_for_ref, true) {
2926 self.write_c_mangled_container_path_intern(&mut mangled_type, Self::path_to_generic_args(&$p_arg.path),
2927 generics, &subtype, is_ref, is_mut, ptr_for_ref, true);
2928 if let Some(w2) = $extra_write as Option<&mut Vec<u8>> {
2929 self.write_c_mangled_container_path_intern(w2, Self::path_to_generic_args(&$p_arg.path),
2930 generics, &subtype, is_ref, is_mut, ptr_for_ref, true);
2933 let mut resolved = Vec::new();
2935 if self.write_c_path_intern(&mut resolved, &$p_arg.path, generics, false, false, false, false, false) {
2936 let inner = std::str::from_utf8(&resolved).unwrap();
2937 inner.rsplitn(2, "::").next().unwrap()
2939 subtype.rsplitn(2, "::").next().unwrap()
2941 write!(w, "{}", id).unwrap();
2942 write!(mangled_type, "{}", id).unwrap();
2943 if let Some(w2) = $extra_write as Option<&mut Vec<u8>> {
2944 write!(w2, "{}", id).unwrap();
2947 } else { return false; }
2950 match generics.resolve_type(arg) {
2951 syn::Type::Tuple(tuple) => {
2952 if tuple.elems.len() == 0 {
2953 write!(w, "None").unwrap();
2954 write!(mangled_type, "None").unwrap();
2956 let mut mangled_tuple_type: Vec<u8> = Vec::new();
2958 // Figure out what the mangled type should look like. To disambiguate
2959 // ((A, B), C) and (A, B, C) we prefix the generic args with a _ and suffix
2960 // them with a Z. Ideally we wouldn't use Z, but not many special chars are
2961 // available for use in type names.
2962 write!(w, "C{}Tuple_", tuple.elems.len()).unwrap();
2963 write!(mangled_type, "C{}Tuple_", tuple.elems.len()).unwrap();
2964 write!(mangled_tuple_type, "C{}Tuple_", tuple.elems.len()).unwrap();
2965 for elem in tuple.elems.iter() {
2966 if let syn::Type::Path(p) = elem {
2967 write_path!(p, Some(&mut mangled_tuple_type));
2968 } else if let syn::Type::Reference(refelem) = elem {
2969 if let syn::Type::Path(p) = &*refelem.elem {
2970 write_path!(p, Some(&mut mangled_tuple_type));
2971 } else { return false; }
2972 } else if let syn::Type::Array(_) = elem {
2973 let mut resolved = Vec::new();
2974 if !self.write_c_type_intern(&mut resolved, &elem, generics, false, false, false, false, false) { return false; }
2975 let array_inner = String::from_utf8(resolved).unwrap();
2976 let arr_name = array_inner.rsplitn(2, "::").next().unwrap();
2977 write!(w, "{}", arr_name).unwrap();
2978 write!(mangled_type, "{}", arr_name).unwrap();
2979 } else { return false; }
2981 write!(w, "Z").unwrap();
2982 write!(mangled_type, "Z").unwrap();
2983 write!(mangled_tuple_type, "Z").unwrap();
2984 if !self.check_create_container(String::from_utf8(mangled_tuple_type).unwrap(),
2985 &format!("{}Tuple", tuple.elems.len()), tuple.elems.iter().collect(), generics, is_ref) {
2990 syn::Type::Path(p_arg) => {
2991 write_path!(p_arg, None);
2993 syn::Type::Reference(refty) => {
2994 if let syn::Type::Path(p_arg) = &*refty.elem {
2995 write_path!(p_arg, None);
2996 } else if let syn::Type::Slice(_) = &*refty.elem {
2997 // write_c_type will actually do exactly what we want here, we just need to
2998 // make it a pointer so that its an option. Note that we cannot always convert
2999 // the Vec-as-slice (ie non-ref types) containers, so sometimes need to be able
3000 // to edit it, hence we use *mut here instead of *const.
3001 if args.len() != 1 { return false; }
3002 write!(w, "*mut ").unwrap();
3003 self.write_c_type(w, arg, None, true);
3004 } else { return false; }
3006 syn::Type::Array(a) => {
3007 if let syn::Type::Path(p_arg) = &*a.elem {
3008 let resolved = self.resolve_path(&p_arg.path, generics);
3009 if !self.is_primitive(&resolved) { return false; }
3010 if let syn::Expr::Lit(syn::ExprLit { lit: syn::Lit::Int(len), .. }) = &a.len {
3011 if self.c_type_from_path(&format!("[{}; {}]", resolved, len.base10_digits()), is_ref, ptr_for_ref).is_none() { return false; }
3012 if in_type || args.len() != 1 {
3013 write!(w, "_{}{}", resolved, len.base10_digits()).unwrap();
3014 write!(mangled_type, "_{}{}", resolved, len.base10_digits()).unwrap();
3016 let arrty = format!("[{}; {}]", resolved, len.base10_digits());
3017 let realty = self.c_type_from_path(&arrty, is_ref, ptr_for_ref).unwrap_or(&arrty);
3018 write!(w, "{}", realty).unwrap();
3019 write!(mangled_type, "{}", realty).unwrap();
3021 } else { return false; }
3022 } else { return false; }
3024 _ => { return false; },
3027 if self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) { return true; }
3028 // Push the "end of type" Z
3029 write!(w, "Z").unwrap();
3030 write!(mangled_type, "Z").unwrap();
3032 // Make sure the type is actually defined:
3033 self.check_create_container(String::from_utf8(mangled_type).unwrap(), ident, args, generics, is_ref)
3035 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 {
3036 if !self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) {
3037 write!(w, "{}::", Self::generated_container_path()).unwrap();
3039 self.write_c_mangled_container_path_intern(w, args, generics, ident, is_ref, is_mut, ptr_for_ref, false)
3041 pub fn get_c_mangled_container_type(&self, args: Vec<&syn::Type>, generics: Option<&GenericTypes>, template_name: &str) -> Option<String> {
3042 let mut out = Vec::new();
3043 if !self.write_c_mangled_container_path(&mut out, args, generics, template_name, false, false, false) {
3046 Some(String::from_utf8(out).unwrap())
3049 // **********************************
3050 // *** C Type Equivalent Printing ***
3051 // **********************************
3053 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 {
3054 let full_path = match self.maybe_resolve_path(&path, generics) {
3055 Some(path) => path, None => return false };
3056 if let Some(c_type) = self.c_type_from_path(&full_path, is_ref, ptr_for_ref) {
3057 write!(w, "{}", c_type).unwrap();
3059 } else if self.crate_types.traits.get(&full_path).is_some() {
3060 // Note that we always use the crate:: prefix here as we are always referring to a
3061 // concrete object which is of the generated type, it just implements the upstream
3063 if is_ref && ptr_for_ref {
3064 write!(w, "*{} crate::{}", if is_mut { "mut" } else { "const" }, full_path).unwrap();
3066 if with_ref_lifetime { unimplemented!(); }
3067 write!(w, "&{}crate::{}", if is_mut { "mut " } else { "" }, full_path).unwrap();
3069 write!(w, "crate::{}", full_path).unwrap();
3072 } else if self.crate_types.opaques.get(&full_path).is_some() || self.crate_types.mirrored_enums.get(&full_path).is_some() {
3073 let crate_pfx = if c_ty { "crate::" } else { "" };
3074 if is_ref && ptr_for_ref {
3075 // ptr_for_ref implies we're returning the object, which we can't really do for
3076 // opaque or mirrored types without box'ing them, which is quite a waste, so return
3077 // the actual object itself (for opaque types we'll set the pointer to the actual
3078 // type and note that its a reference).
3079 write!(w, "{}{}", crate_pfx, full_path).unwrap();
3080 } else if is_ref && with_ref_lifetime {
3082 // If we're concretizing something with a lifetime parameter, we have to pick a
3083 // lifetime, of which the only real available choice is `static`, obviously.
3084 write!(w, "&'static {}", crate_pfx).unwrap();
3086 self.write_rust_path(w, generics, path, with_ref_lifetime, false);
3088 // We shouldn't be mapping references in types, so panic here
3092 write!(w, "&{}{}{}", if is_mut { "mut " } else { "" }, crate_pfx, full_path).unwrap();
3094 write!(w, "{}{}", crate_pfx, full_path).unwrap();
3098 if let Some(trait_impls) = self.crate_types.traits_impld.get(&full_path) {
3099 if trait_impls.len() == 1 {
3100 // If this is a no-export'd crate and there's only one implementation in the
3101 // whole crate, just treat it as a reference to whatever the implementor is.
3102 if with_ref_lifetime {
3103 // Hope we're being printed in function generics and let rustc derive the
3105 write!(w, "_").unwrap();
3107 write!(w, "&crate::{}", trait_impls[0]).unwrap();
3115 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 {
3116 match generics.resolve_type(t) {
3117 syn::Type::Path(p) => {
3118 if p.qself.is_some() {
3121 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
3122 if self.is_known_container(&full_path, is_ref) || self.is_path_transparent_container(&p.path, generics, is_ref) {
3123 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);
3125 if let Some(aliased_type) = self.crate_types.type_aliases.get(&full_path).cloned() {
3126 return self.write_c_type_intern(w, &aliased_type, None, is_ref, is_mut, ptr_for_ref, with_ref_lifetime, c_ty);
3129 self.write_c_path_intern(w, &p.path, generics, is_ref, is_mut, ptr_for_ref, with_ref_lifetime, c_ty)
3131 syn::Type::Reference(r) => {
3132 self.write_c_type_intern(w, &*r.elem, generics, true, r.mutability.is_some(), ptr_for_ref, with_ref_lifetime, c_ty)
3134 syn::Type::Array(a) => {
3135 if is_ref && is_mut {
3136 write!(w, "*mut [").unwrap();
3137 if !self.write_c_type_intern(w, &a.elem, generics, false, false, ptr_for_ref, with_ref_lifetime, c_ty) { return false; }
3139 write!(w, "*const [").unwrap();
3140 if !self.write_c_type_intern(w, &a.elem, generics, false, false, ptr_for_ref, with_ref_lifetime, c_ty) { return false; }
3142 if let syn::Expr::Lit(l) = &a.len {
3143 if let syn::Lit::Int(i) = &l.lit {
3144 let mut inner_ty = Vec::new();
3145 if !self.write_c_type_intern(&mut inner_ty, &*a.elem, generics, false, false, ptr_for_ref, false, c_ty) { return false; }
3146 let inner_ty_str = String::from_utf8(inner_ty).unwrap();
3148 if let Some(ty) = self.c_type_from_path(&format!("[{}; {}]", inner_ty_str, i.base10_digits()), false, ptr_for_ref) {
3149 write!(w, "{}", ty).unwrap();
3153 write!(w, "; {}]", i).unwrap();
3159 syn::Type::Slice(s) => {
3160 if !is_ref || is_mut { return false; }
3161 if let syn::Type::Path(p) = &*s.elem {
3162 let resolved = self.resolve_path(&p.path, generics);
3163 if self.is_primitive(&resolved) {
3164 write!(w, "{}::{}slice", Self::container_templ_path(), resolved).unwrap();
3167 let mut inner_c_ty = Vec::new();
3168 assert!(self.write_c_path_intern(&mut inner_c_ty, &p.path, generics, true, false, ptr_for_ref, with_ref_lifetime, c_ty));
3169 let inner_ty_str = String::from_utf8(inner_c_ty).unwrap();
3170 if self.is_clonable(&inner_ty_str) {
3171 let inner_ty_ident = inner_ty_str.rsplitn(2, "::").next().unwrap();
3172 let mangled_container = format!("CVec_{}Z", inner_ty_ident);
3173 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
3174 self.check_create_container(mangled_container, "Vec", vec![&*s.elem], generics, false)
3177 } else if let syn::Type::Reference(r) = &*s.elem {
3178 if let syn::Type::Path(p) = &*r.elem {
3179 // Slices with "real types" inside are mapped as the equivalent non-ref Vec
3180 let resolved = self.resolve_path(&p.path, generics);
3181 let mangled_container = if let Some((ident, _)) = self.crate_types.opaques.get(&resolved) {
3182 format!("CVec_{}Z", ident)
3183 } else if let Some(en) = self.crate_types.mirrored_enums.get(&resolved) {
3184 format!("CVec_{}Z", en.ident)
3185 } else if let Some(id) = p.path.get_ident() {
3186 format!("CVec_{}Z", id)
3187 } else { return false; };
3188 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
3189 self.check_create_container(mangled_container, "Vec", vec![&*r.elem], generics, false)
3190 } else if let syn::Type::Slice(sl2) = &*r.elem {
3191 if let syn::Type::Reference(r2) = &*sl2.elem {
3192 if let syn::Type::Path(p) = &*r2.elem {
3193 // Slices with slices with opaque types (with is_owned flags) are mapped as non-ref Vecs
3194 let resolved = self.resolve_path(&p.path, generics);
3195 let mangled_container = if let Some((ident, _)) = self.crate_types.opaques.get(&resolved) {
3196 format!("CVec_CVec_{}ZZ", ident)
3197 } else { return false; };
3198 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
3199 let inner = &r2.elem;
3200 let vec_ty: syn::Type = syn::parse_quote!(Vec<#inner>);
3201 self.check_create_container(mangled_container, "Vec", vec![&vec_ty], generics, false)
3205 } else if let syn::Type::Tuple(_) = &*s.elem {
3206 let mut args = syn::punctuated::Punctuated::<_, syn::token::Comma>::new();
3207 args.push(syn::GenericArgument::Type((*s.elem).clone()));
3208 let mut segments = syn::punctuated::Punctuated::new();
3209 segments.push(parse_quote!(Vec<#args>));
3210 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)
3211 } else if let syn::Type::Array(a) = &*s.elem {
3212 if let syn::Expr::Lit(l) = &a.len {
3213 if let syn::Lit::Int(i) = &l.lit {
3214 let mut buf = Vec::new();
3215 self.write_rust_type(&mut buf, generics, &*a.elem, false);
3216 let arr_ty = String::from_utf8(buf).unwrap();
3218 let arr_str = format!("[{}; {}]", arr_ty, i.base10_digits());
3219 let ty = self.c_type_from_path(&arr_str, false, ptr_for_ref).unwrap()
3220 .rsplitn(2, "::").next().unwrap();
3222 let mangled_container = format!("CVec_{}Z", ty);
3223 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
3224 self.check_create_container(mangled_container, "Vec", vec![&*s.elem], generics, false)
3229 syn::Type::Tuple(t) => {
3230 if t.elems.len() == 0 {
3233 self.write_c_mangled_container_path(w, t.elems.iter().collect(), generics,
3234 &format!("{}Tuple", t.elems.len()), is_ref, is_mut, ptr_for_ref)
3240 pub fn write_c_type<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, ptr_for_ref: bool) {
3241 assert!(self.write_c_type_intern(w, t, generics, false, false, ptr_for_ref, false, true));
3243 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) {
3244 assert!(self.write_c_type_intern(w, t, generics, false, false, ptr_for_ref, true, false));
3246 pub fn understood_c_path(&self, p: &syn::Path) -> bool {
3247 self.write_c_path_intern(&mut std::io::sink(), p, None, false, false, false, false, true)
3249 pub fn understood_c_type(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> bool {
3250 self.write_c_type_intern(&mut std::io::sink(), t, generics, false, false, false, false, true)