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, _ => {} }
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 non_lifetimes_processed { return false; }
227 non_lifetimes_processed = true;
228 if path != "std::ops::Deref" && path != "core::ops::Deref" {
229 let p = string_path_to_syn_path(&path);
230 let ref_ty = parse_quote!(&#p);
231 let mut_ref_ty = parse_quote!(&mut #p);
232 self.default_generics.insert(&type_param.ident, (syn::Type::Path(syn::TypePath { qself: None, path: p }), ref_ty, mut_ref_ty));
233 new_typed_generics.insert(&type_param.ident, Some(path));
235 // If we're templated on Deref<Target = ConcreteThing>, store
236 // the reference type in `default_generics` which handles full
237 // types and not just paths.
238 if let syn::PathArguments::AngleBracketed(ref args) =
239 trait_bound.path.segments[0].arguments {
240 assert_eq!(trait_bound.path.segments.len(), 1);
241 for subargument in args.args.iter() {
243 syn::GenericArgument::Lifetime(_) => {},
244 syn::GenericArgument::Binding(ref b) => {
245 if &format!("{}", b.ident) != "Target" { return false; }
247 self.default_generics.insert(&type_param.ident, (parse_quote!(&#default), parse_quote!(&#default), parse_quote!(&mut #default)));
250 _ => unimplemented!(),
254 new_typed_generics.insert(&type_param.ident, None);
260 if let Some(default) = type_param.default.as_ref() {
261 assert!(type_param.bounds.is_empty());
262 self.default_generics.insert(&type_param.ident, (default.clone(), parse_quote!(&#default), parse_quote!(&mut #default)));
263 } else if type_param.bounds.is_empty() {
264 if let syn::PathArguments::AngleBracketed(args) = impld_generics {
265 match &args.args[idx] {
266 syn::GenericArgument::Type(ty) => {
267 self.default_generics.insert(&type_param.ident, (ty.clone(), parse_quote!(&#ty), parse_quote!(&mut #ty)));
269 _ => unimplemented!(),
277 // Then find generics where we are required to pass a Deref<Target=X> and pretend its just X.
278 if let Some(wh) = &generics.where_clause {
279 for pred in wh.predicates.iter() {
280 if let syn::WherePredicate::Type(t) = pred {
281 if let syn::Type::Path(p) = &t.bounded_ty {
282 if first_seg_self(&t.bounded_ty).is_some() && p.path.segments.len() == 1 { continue; }
283 if p.qself.is_some() { return false; }
284 if p.path.leading_colon.is_some() { return false; }
285 let mut p_iter = p.path.segments.iter();
286 let p_ident = &p_iter.next().unwrap().ident;
287 if let Some(gen) = new_typed_generics.get_mut(p_ident) {
288 if gen.is_some() { return false; }
289 if &format!("{}", p_iter.next().unwrap().ident) != "Target" {return false; }
291 let mut non_lifetimes_processed = false;
292 for bound in t.bounds.iter() {
293 if let syn::TypeParamBound::Trait(trait_bound) = bound {
294 if let Some(id) = trait_bound.path.get_ident() {
295 if format!("{}", id) == "Sized" { continue; }
297 if non_lifetimes_processed { return false; }
298 non_lifetimes_processed = true;
299 assert_simple_bound(&trait_bound);
300 let resolved = types.resolve_path(&trait_bound.path, None);
301 let ty = syn::Type::Path(syn::TypePath {
302 qself: None, path: string_path_to_syn_path(&resolved)
304 let ref_ty = parse_quote!(&#ty);
305 let mut_ref_ty = parse_quote!(&mut #ty);
306 if types.crate_types.traits.get(&resolved).is_some() {
307 self.default_generics.insert(p_ident, (ty, ref_ty, mut_ref_ty));
309 self.default_generics.insert(p_ident, (ref_ty.clone(), ref_ty, mut_ref_ty));
312 *gen = Some(resolved);
315 } else { return false; }
316 } else { return false; }
320 for (key, value) in new_typed_generics.drain() {
321 if let Some(v) = value {
322 assert!(self.typed_generics.insert(key, v).is_none());
323 } else { return false; }
328 /// Learn the generics in generics in the current context, given a TypeResolver.
329 pub fn learn_generics<'b, 'c>(&mut self, generics: &'a syn::Generics, types: &'b TypeResolver<'a, 'c>) -> bool {
330 self.learn_generics_with_impls(generics, &syn::PathArguments::None, types)
333 /// Learn the associated types from the trait in the current context.
334 pub fn learn_associated_types<'b, 'c>(&mut self, t: &'a syn::ItemTrait, types: &'b TypeResolver<'a, 'c>) {
335 for item in t.items.iter() {
337 &syn::TraitItem::Type(ref t) => {
338 if t.default.is_some() || t.generics.lt_token.is_some() { unimplemented!(); }
339 let mut bounds_iter = t.bounds.iter();
341 match bounds_iter.next().unwrap() {
342 syn::TypeParamBound::Trait(tr) => {
343 assert_simple_bound(&tr);
344 if let Some(path) = types.maybe_resolve_path(&tr.path, None) {
345 if types.skip_path(&path) { continue; }
346 // In general we handle Deref<Target=X> as if it were just X (and
347 // implement Deref<Target=Self> for relevant types). We don't
348 // bother to implement it for associated types, however, so we just
349 // ignore such bounds.
350 if path != "std::ops::Deref" && path != "core::ops::Deref" {
351 self.typed_generics.insert(&t.ident, path);
353 } else { unimplemented!(); }
354 for bound in bounds_iter {
355 if let syn::TypeParamBound::Trait(_) = bound { unimplemented!(); }
359 syn::TypeParamBound::Lifetime(_) => {},
368 /// Attempt to resolve a Path as a generic parameter and return the full path. as both a string
370 pub fn maybe_resolve_path<'b>(&'b self, path: &syn::Path) -> Option<&'b String> {
371 if let Some(ident) = path.get_ident() {
372 if let Some(ty) = &self.self_ty {
373 if format!("{}", ident) == "Self" {
377 if let Some(res) = self.typed_generics.get(ident) {
381 // Associated types are usually specified as "Self::Generic", so we check for that
383 let mut it = path.segments.iter();
384 if path.segments.len() == 2 && format!("{}", it.next().unwrap().ident) == "Self" {
385 let ident = &it.next().unwrap().ident;
386 if let Some(res) = self.typed_generics.get(ident) {
391 if let Some(parent) = self.parent {
392 parent.maybe_resolve_path(path)
399 pub trait ResolveType<'a> { fn resolve_type(&'a self, ty: &'a syn::Type) -> &'a syn::Type; }
400 impl<'a, 'b, 'c: 'a + 'b> ResolveType<'c> for Option<&GenericTypes<'a, 'b>> {
401 fn resolve_type(&'c self, ty: &'c syn::Type) -> &'c syn::Type {
402 if let Some(us) = self {
404 syn::Type::Path(p) => {
405 if let Some(ident) = p.path.get_ident() {
406 if let Some((ty, _, _)) = us.default_generics.get(ident) {
407 return self.resolve_type(ty);
411 syn::Type::Reference(syn::TypeReference { elem, mutability, .. }) => {
412 if let syn::Type::Path(p) = &**elem {
413 if let Some(ident) = p.path.get_ident() {
414 if let Some((_, refty, mut_ref_ty)) = us.default_generics.get(ident) {
415 if mutability.is_some() {
416 return self.resolve_type(mut_ref_ty);
418 return self.resolve_type(refty);
426 us.parent.resolve_type(ty)
431 #[derive(Clone, PartialEq)]
432 // The type of declaration and the object itself
433 pub enum DeclType<'a> {
435 Trait(&'a syn::ItemTrait),
436 StructImported { generics: &'a syn::Generics },
438 EnumIgnored { generics: &'a syn::Generics },
441 pub struct ImportResolver<'mod_lifetime, 'crate_lft: 'mod_lifetime> {
442 pub crate_name: &'mod_lifetime str,
443 library: &'crate_lft FullLibraryAST,
444 module_path: &'mod_lifetime str,
445 imports: HashMap<syn::Ident, (String, syn::Path)>,
446 declared: HashMap<syn::Ident, DeclType<'crate_lft>>,
447 priv_modules: HashSet<syn::Ident>,
449 impl<'mod_lifetime, 'crate_lft: 'mod_lifetime> ImportResolver<'mod_lifetime, 'crate_lft> {
450 fn walk_use_intern<F: FnMut(syn::Ident, (String, syn::Path))>(
451 crate_name: &str, module_path: &str, dependencies: &HashSet<syn::Ident>, u: &syn::UseTree,
453 mut path: syn::punctuated::Punctuated<syn::PathSegment, syn::token::Colon2>, handle_use: &mut F
456 macro_rules! push_path {
457 ($ident: expr, $path_suffix: expr) => {
458 if partial_path == "" && format!("{}", $ident) == "super" {
459 let mut mod_iter = module_path.rsplitn(2, "::");
460 mod_iter.next().unwrap();
461 let super_mod = mod_iter.next().unwrap();
462 new_path = format!("{}{}", super_mod, $path_suffix);
463 assert_eq!(path.len(), 0);
464 for module in super_mod.split("::") {
465 path.push(syn::PathSegment { ident: syn::Ident::new(module, Span::call_site()), arguments: syn::PathArguments::None });
467 } else if partial_path == "" && format!("{}", $ident) == "self" {
468 new_path = format!("{}{}", module_path, $path_suffix);
469 for module in module_path.split("::") {
470 path.push(syn::PathSegment { ident: syn::Ident::new(module, Span::call_site()), arguments: syn::PathArguments::None });
472 } else if partial_path == "" && format!("{}", $ident) == "crate" {
473 new_path = format!("{}{}", crate_name, $path_suffix);
474 let crate_name_ident = format_ident!("{}", crate_name);
475 path.push(parse_quote!(#crate_name_ident));
476 } else if partial_path == "" && !dependencies.contains(&$ident) {
477 new_path = format!("{}::{}{}", module_path, $ident, $path_suffix);
478 for module in module_path.split("::") {
479 path.push(syn::PathSegment { ident: syn::Ident::new(module, Span::call_site()), arguments: syn::PathArguments::None });
481 let ident_str = format_ident!("{}", $ident);
482 path.push(parse_quote!(#ident_str));
483 } else if format!("{}", $ident) == "self" {
484 let mut path_iter = partial_path.rsplitn(2, "::");
485 path_iter.next().unwrap();
486 new_path = path_iter.next().unwrap().to_owned();
488 new_path = format!("{}{}{}", partial_path, $ident, $path_suffix);
491 path.push(parse_quote!(#ident));
495 syn::UseTree::Path(p) => {
496 push_path!(p.ident, "::");
497 Self::walk_use_intern(crate_name, module_path, dependencies, &p.tree, &new_path, path, handle_use);
499 syn::UseTree::Name(n) => {
500 push_path!(n.ident, "");
501 let imported_ident = syn::Ident::new(new_path.rsplitn(2, "::").next().unwrap(), Span::call_site());
502 handle_use(imported_ident, (new_path, syn::Path { leading_colon: Some(syn::Token![::](Span::call_site())), segments: path }));
504 syn::UseTree::Group(g) => {
505 for i in g.items.iter() {
506 Self::walk_use_intern(crate_name, module_path, dependencies, i, partial_path, path.clone(), handle_use);
509 syn::UseTree::Rename(r) => {
510 push_path!(r.ident, "");
511 handle_use(r.rename.clone(), (new_path, syn::Path { leading_colon: Some(syn::Token![::](Span::call_site())), segments: path }));
513 syn::UseTree::Glob(_) => {
514 eprintln!("Ignoring * use for {} - this may result in resolution failures", partial_path);
519 fn process_use_intern(crate_name: &str, module_path: &str, dependencies: &HashSet<syn::Ident>,
520 imports: &mut HashMap<syn::Ident, (String, syn::Path)>, u: &syn::UseTree, partial_path: &str,
521 path: syn::punctuated::Punctuated<syn::PathSegment, syn::token::Colon2>
523 Self::walk_use_intern(crate_name, module_path, dependencies, u, partial_path, path,
524 &mut |k, v| { imports.insert(k, v); });
527 fn process_use(crate_name: &str, module_path: &str, dependencies: &HashSet<syn::Ident>, imports: &mut HashMap<syn::Ident, (String, syn::Path)>, u: &syn::ItemUse) {
528 if u.leading_colon.is_some() { eprintln!("Ignoring leading-colon use!"); return; }
529 Self::process_use_intern(crate_name, module_path, dependencies, imports, &u.tree, "", syn::punctuated::Punctuated::new());
532 fn insert_primitive(imports: &mut HashMap<syn::Ident, (String, syn::Path)>, id: &str) {
533 let ident = format_ident!("{}", id);
534 let path = parse_quote!(#ident);
535 imports.insert(ident, (id.to_owned(), path));
538 pub fn new(crate_name: &'mod_lifetime str, library: &'crate_lft FullLibraryAST, module_path: &'mod_lifetime str, contents: &'crate_lft [syn::Item]) -> Self {
539 Self::from_borrowed_items(crate_name, library, module_path, &contents.iter().map(|a| a).collect::<Vec<_>>())
541 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 {
542 let mut imports = HashMap::new();
543 // Add primitives to the "imports" list:
544 Self::insert_primitive(&mut imports, "bool");
545 Self::insert_primitive(&mut imports, "u128");
546 Self::insert_primitive(&mut imports, "u64");
547 Self::insert_primitive(&mut imports, "u32");
548 Self::insert_primitive(&mut imports, "u16");
549 Self::insert_primitive(&mut imports, "u8");
550 Self::insert_primitive(&mut imports, "usize");
551 Self::insert_primitive(&mut imports, "str");
552 Self::insert_primitive(&mut imports, "String");
554 // These are here to allow us to print native Rust types in trait fn impls even if we don't
556 Self::insert_primitive(&mut imports, "Result");
557 Self::insert_primitive(&mut imports, "Vec");
558 Self::insert_primitive(&mut imports, "Option");
560 let mut declared = HashMap::new();
561 let mut priv_modules = HashSet::new();
563 for item in contents.iter() {
565 syn::Item::Use(u) => Self::process_use(crate_name, module_path, &library.dependencies, &mut imports, &u),
566 syn::Item::Struct(s) => {
567 if let syn::Visibility::Public(_) = s.vis {
568 match export_status(&s.attrs) {
569 ExportStatus::Export => { declared.insert(s.ident.clone(), DeclType::StructImported { generics: &s.generics }); },
570 ExportStatus::NoExport => { declared.insert(s.ident.clone(), DeclType::StructIgnored); },
571 ExportStatus::TestOnly => continue,
572 ExportStatus::NotImplementable => panic!("(C-not implementable) should only appear on traits!"),
576 syn::Item::Type(t) if export_status(&t.attrs) == ExportStatus::Export => {
577 if let syn::Visibility::Public(_) = t.vis {
578 declared.insert(t.ident.clone(), DeclType::StructImported { generics: &t.generics });
581 syn::Item::Enum(e) => {
582 if let syn::Visibility::Public(_) = e.vis {
583 match export_status(&e.attrs) {
584 ExportStatus::Export if is_enum_opaque(e) => { declared.insert(e.ident.clone(), DeclType::EnumIgnored { generics: &e.generics }); },
585 ExportStatus::Export => { declared.insert(e.ident.clone(), DeclType::MirroredEnum); },
586 ExportStatus::NotImplementable => panic!("(C-not implementable) should only appear on traits!"),
591 syn::Item::Trait(t) => {
592 match export_status(&t.attrs) {
593 ExportStatus::Export|ExportStatus::NotImplementable => {
594 if let syn::Visibility::Public(_) = t.vis {
595 declared.insert(t.ident.clone(), DeclType::Trait(t));
601 syn::Item::Mod(m) => {
602 priv_modules.insert(m.ident.clone());
608 Self { crate_name, library, module_path, imports, declared, priv_modules }
611 pub fn maybe_resolve_declared(&self, id: &syn::Ident) -> Option<&DeclType<'crate_lft>> {
612 self.declared.get(id)
615 pub fn maybe_resolve_ident(&self, id: &syn::Ident) -> Option<String> {
616 if let Some((imp, _)) = self.imports.get(id) {
618 } else if self.declared.get(id).is_some() {
619 Some(self.module_path.to_string() + "::" + &format!("{}", id))
623 fn maybe_resolve_imported_path(&self, p: &syn::Path, generics: Option<&GenericTypes>) -> Option<String> {
624 if let Some(gen_types) = generics {
625 if let Some(resp) = gen_types.maybe_resolve_path(p) {
626 return Some(resp.clone());
630 if p.leading_colon.is_some() {
631 let mut res: String = p.segments.iter().enumerate().map(|(idx, seg)| {
632 format!("{}{}", if idx == 0 { "" } else { "::" }, seg.ident)
634 let firstseg = p.segments.iter().next().unwrap();
635 if !self.library.dependencies.contains(&firstseg.ident) {
636 res = self.crate_name.to_owned() + "::" + &res;
639 } else if let Some(id) = p.get_ident() {
640 self.maybe_resolve_ident(id)
642 if p.segments.len() == 1 {
643 let seg = p.segments.iter().next().unwrap();
644 return self.maybe_resolve_ident(&seg.ident);
646 let mut seg_iter = p.segments.iter();
647 let first_seg = seg_iter.next().unwrap();
648 let remaining: String = seg_iter.map(|seg| {
649 format!("::{}", seg.ident)
651 let first_seg_str = format!("{}", first_seg.ident);
652 if let Some((imp, _)) = self.imports.get(&first_seg.ident) {
654 Some(imp.clone() + &remaining)
658 } else if let Some(_) = self.priv_modules.get(&first_seg.ident) {
659 Some(format!("{}::{}{}", self.module_path, first_seg.ident, remaining))
660 } else if first_seg_is_stdlib(&first_seg_str) || self.library.dependencies.contains(&first_seg.ident) {
661 Some(first_seg_str + &remaining)
662 } else if first_seg_str == "crate" {
663 Some(self.crate_name.to_owned() + &remaining)
668 pub fn maybe_resolve_path(&self, p: &syn::Path, generics: Option<&GenericTypes>) -> Option<String> {
669 self.maybe_resolve_imported_path(p, generics).map(|mut path| {
671 // Now that we've resolved the path to the path as-imported, check whether the path
672 // is actually a pub(.*) use statement and map it to the real path.
673 let path_tmp = path.clone();
674 let crate_name = path_tmp.splitn(2, "::").next().unwrap();
675 let mut module_riter = path_tmp.rsplitn(2, "::");
676 let obj = module_riter.next().unwrap();
677 if let Some(module_path) = module_riter.next() {
678 if let Some(m) = self.library.modules.get(module_path) {
679 for item in m.items.iter() {
680 if let syn::Item::Use(syn::ItemUse { vis, tree, .. }) = item {
682 syn::Visibility::Public(_)|
683 syn::Visibility::Crate(_)|
684 syn::Visibility::Restricted(_) => {
685 Self::walk_use_intern(crate_name, module_path,
686 &self.library.dependencies, tree, "",
687 syn::punctuated::Punctuated::new(), &mut |ident, (use_path, _)| {
688 if format!("{}", ident) == obj {
693 syn::Visibility::Inherited => {},
705 /// Map all the Paths in a Type into absolute paths given a set of imports (generated via process_use_intern)
706 pub fn resolve_imported_refs(&self, mut ty: syn::Type) -> syn::Type {
708 syn::Type::Path(p) => {
709 if p.path.segments.len() != 1 { unimplemented!(); }
710 let mut args = p.path.segments[0].arguments.clone();
711 if let syn::PathArguments::AngleBracketed(ref mut generics) = &mut args {
712 for arg in generics.args.iter_mut() {
713 if let syn::GenericArgument::Type(ref mut t) = arg {
714 *t = self.resolve_imported_refs(t.clone());
718 if let Some((_, newpath)) = self.imports.get(single_ident_generic_path_to_ident(&p.path).unwrap()) {
719 p.path = newpath.clone();
721 p.path.segments[0].arguments = args;
723 syn::Type::Reference(r) => {
724 r.elem = Box::new(self.resolve_imported_refs((*r.elem).clone()));
726 syn::Type::Slice(s) => {
727 s.elem = Box::new(self.resolve_imported_refs((*s.elem).clone()));
729 syn::Type::Tuple(t) => {
730 for e in t.elems.iter_mut() {
731 *e = self.resolve_imported_refs(e.clone());
734 _ => unimplemented!(),
740 // templates_defined is walked to write the C++ header, so if we use the default hashing it get
741 // reordered on each genbindings run. Instead, we use SipHasher (which defaults to 0-keys) so that
742 // the sorting is stable across runs. It is deprecated, but the "replacement" doesn't actually
743 // accomplish the same goals, so we just ignore it.
745 pub type NonRandomHash = hash::BuildHasherDefault<hash::SipHasher>;
748 pub struct ASTModule {
749 pub attrs: Vec<syn::Attribute>,
750 pub items: Vec<syn::Item>,
751 pub submods: Vec<String>,
753 /// A struct containing the syn::File AST for each file in the crate.
754 pub struct FullLibraryAST {
755 pub modules: HashMap<String, ASTModule, NonRandomHash>,
756 pub dependencies: HashSet<syn::Ident>,
758 impl FullLibraryAST {
759 fn load_module(&mut self, module: String, attrs: Vec<syn::Attribute>, mut items: Vec<syn::Item>) {
760 let mut non_mod_items = Vec::with_capacity(items.len());
761 let mut submods = Vec::with_capacity(items.len());
762 for item in items.drain(..) {
764 syn::Item::Mod(m) if m.content.is_some() => {
765 if export_status(&m.attrs) == ExportStatus::Export {
766 if let syn::Visibility::Public(_) = m.vis {
767 let modident = format!("{}", m.ident);
768 let modname = if module != "" {
769 module.clone() + "::" + &modident
771 self.dependencies.insert(m.ident);
774 self.load_module(modname, m.attrs, m.content.unwrap().1);
775 submods.push(modident);
777 non_mod_items.push(syn::Item::Mod(m));
781 syn::Item::Mod(_) => panic!("--pretty=expanded output should never have non-body modules"),
782 syn::Item::ExternCrate(c) => {
783 if export_status(&c.attrs) == ExportStatus::Export {
784 self.dependencies.insert(c.ident);
787 _ => { non_mod_items.push(item); }
790 self.modules.insert(module, ASTModule { attrs, items: non_mod_items, submods });
793 pub fn load_lib(lib: syn::File) -> Self {
794 assert_eq!(export_status(&lib.attrs), ExportStatus::Export);
795 let mut res = Self { modules: HashMap::default(), dependencies: HashSet::new() };
796 res.load_module("".to_owned(), lib.attrs, lib.items);
801 /// List of manually-generated types which are clonable
802 fn initial_clonable_types() -> HashSet<String> {
803 let mut res = HashSet::new();
804 res.insert("crate::c_types::U5".to_owned());
805 res.insert("crate::c_types::U128".to_owned());
806 res.insert("crate::c_types::FourBytes".to_owned());
807 res.insert("crate::c_types::TwelveBytes".to_owned());
808 res.insert("crate::c_types::SixteenBytes".to_owned());
809 res.insert("crate::c_types::TwentyBytes".to_owned());
810 res.insert("crate::c_types::ThirtyTwoBytes".to_owned());
811 res.insert("crate::c_types::EightU16s".to_owned());
812 res.insert("crate::c_types::SecretKey".to_owned());
813 res.insert("crate::c_types::PublicKey".to_owned());
814 res.insert("crate::c_types::Transaction".to_owned());
815 res.insert("crate::c_types::Witness".to_owned());
816 res.insert("crate::c_types::WitnessVersion".to_owned());
817 res.insert("crate::c_types::TxOut".to_owned());
818 res.insert("crate::c_types::Signature".to_owned());
819 res.insert("crate::c_types::RecoverableSignature".to_owned());
820 res.insert("crate::c_types::BigEndianScalar".to_owned());
821 res.insert("crate::c_types::Bech32Error".to_owned());
822 res.insert("crate::c_types::Secp256k1Error".to_owned());
823 res.insert("crate::c_types::IOError".to_owned());
824 res.insert("crate::c_types::Error".to_owned());
825 res.insert("crate::c_types::Str".to_owned());
827 // Because some types are manually-mapped to CVec_u8Z we may end up checking if its clonable
828 // before we ever get to constructing the type fully via
829 // `write_c_mangled_container_path_intern` (which will add it here too), so we have to manually
830 // add it on startup.
831 res.insert("crate::c_types::derived::CVec_u8Z".to_owned());
835 /// Top-level struct tracking everything which has been defined while walking the crate.
836 pub struct CrateTypes<'a> {
837 /// This may contain structs or enums, but only when either is mapped as
838 /// struct X { inner: *mut originalX, .. }
839 pub opaques: HashMap<String, (&'a syn::Ident, &'a syn::Generics)>,
840 /// structs that weren't exposed
841 pub priv_structs: HashMap<String, &'a syn::Generics>,
842 /// Enums which are mapped as C enums with conversion functions
843 pub mirrored_enums: HashMap<String, &'a syn::ItemEnum>,
844 /// Traits which are mapped as a pointer + jump table
845 pub traits: HashMap<String, &'a syn::ItemTrait>,
846 /// Aliases from paths to some other Type
847 pub type_aliases: HashMap<String, syn::Type>,
848 /// Value is an alias to Key (maybe with some generics)
849 pub reverse_alias_map: HashMap<String, Vec<(String, syn::PathArguments)>>,
850 /// Template continer types defined, map from mangled type name -> whether a destructor fn
853 /// This is used at the end of processing to make C++ wrapper classes
854 pub templates_defined: RefCell<HashMap<String, bool, NonRandomHash>>,
855 /// The output file for any created template container types, written to as we find new
856 /// template containers which need to be defined.
857 template_file: RefCell<&'a mut File>,
858 /// Set of containers which are clonable
859 clonable_types: RefCell<HashSet<String>>,
861 pub trait_impls: HashMap<String, Vec<String>>,
862 /// The full set of modules in the crate(s)
863 pub lib_ast: &'a FullLibraryAST,
866 impl<'a> CrateTypes<'a> {
867 pub fn new(template_file: &'a mut File, libast: &'a FullLibraryAST) -> Self {
869 opaques: HashMap::new(), mirrored_enums: HashMap::new(), traits: HashMap::new(),
870 type_aliases: HashMap::new(), reverse_alias_map: HashMap::new(),
871 templates_defined: RefCell::new(HashMap::default()), priv_structs: HashMap::new(),
872 clonable_types: RefCell::new(initial_clonable_types()), trait_impls: HashMap::new(),
873 template_file: RefCell::new(template_file), lib_ast: &libast,
876 pub fn set_clonable(&self, object: String) {
877 self.clonable_types.borrow_mut().insert(object);
879 pub fn is_clonable(&self, object: &str) -> bool {
880 self.clonable_types.borrow().contains(object)
882 pub fn write_new_template(&self, mangled_container: String, has_destructor: bool, created_container: &[u8]) {
883 self.template_file.borrow_mut().write(created_container).unwrap();
884 self.templates_defined.borrow_mut().insert(mangled_container, has_destructor);
888 /// A struct which tracks resolving rust types into C-mapped equivalents, exists for one specific
889 /// module but contains a reference to the overall CrateTypes tracking.
890 pub struct TypeResolver<'mod_lifetime, 'crate_lft: 'mod_lifetime> {
891 pub module_path: &'mod_lifetime str,
892 pub crate_types: &'mod_lifetime CrateTypes<'crate_lft>,
893 pub types: ImportResolver<'mod_lifetime, 'crate_lft>,
896 /// Returned by write_empty_rust_val_check_suffix to indicate what type of dereferencing needs to
897 /// happen to get the inner value of a generic.
898 enum EmptyValExpectedTy {
899 /// A type which has a flag for being empty (eg an array where we treat all-0s as empty).
901 /// A Option mapped as a COption_*Z
903 /// A pointer which we want to convert to a reference.
908 /// Describes the appropriate place to print a general type-conversion string when converting a
910 enum ContainerPrefixLocation {
911 /// Prints a general type-conversion string prefix and suffix outside of the
912 /// container-conversion strings.
914 /// Prints a general type-conversion string prefix and suffix inside of the
915 /// container-conversion strings.
917 /// Does not print the usual type-conversion string prefix and suffix.
921 impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
922 pub fn new(module_path: &'a str, types: ImportResolver<'a, 'c>, crate_types: &'a CrateTypes<'c>) -> Self {
923 Self { module_path, types, crate_types }
926 // *************************************************
927 // *** Well know type and conversion definitions ***
928 // *************************************************
930 /// Returns true we if can just skip passing this to C entirely
931 pub fn skip_path(&self, full_path: &str) -> bool {
932 full_path == "bitcoin::secp256k1::Secp256k1" ||
933 full_path == "bitcoin::secp256k1::Signing" ||
934 full_path == "bitcoin::secp256k1::Verification"
936 /// Returns true we if can just skip passing this to C entirely
937 fn no_arg_path_to_rust(&self, full_path: &str) -> &str {
938 if full_path == "bitcoin::secp256k1::Secp256k1" {
939 "secp256k1::global::SECP256K1"
940 } else { unimplemented!(); }
943 /// Returns true if the object is a primitive and is mapped as-is with no conversion
945 pub fn is_primitive(&self, full_path: &str) -> bool {
956 pub fn is_clonable(&self, ty: &str) -> bool {
957 if self.crate_types.is_clonable(ty) { return true; }
958 if self.is_primitive(ty) { return true; }
964 /// Gets the C-mapped type for types which are outside of the crate, or which are manually
965 /// ignored by for some reason need mapping anyway.
966 fn c_type_from_path<'b>(&self, full_path: &'b str, is_ref: bool, _ptr_for_ref: bool) -> Option<&'b str> {
967 if self.is_primitive(full_path) {
968 return Some(full_path);
971 // Note that no !is_ref types can map to an array because Rust and C's call semantics
972 // for arrays are different (https://github.com/eqrion/cbindgen/issues/528)
974 "[u8; 32]" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
975 "[u8; 20]" if !is_ref => Some("crate::c_types::TwentyBytes"),
976 "[u8; 16]" if !is_ref => Some("crate::c_types::SixteenBytes"),
977 "[u8; 12]" if !is_ref => Some("crate::c_types::TwelveBytes"),
978 "[u8; 4]" if !is_ref => Some("crate::c_types::FourBytes"),
979 "[u8; 3]" if !is_ref => Some("crate::c_types::ThreeBytes"), // Used for RGB values
980 "[u16; 8]" if !is_ref => Some("crate::c_types::EightU16s"),
982 "str" if is_ref => Some("crate::c_types::Str"),
983 "alloc::string::String"|"String" => Some("crate::c_types::Str"),
985 "bitcoin::Address" => Some("crate::c_types::Str"),
987 "std::time::Duration"|"core::time::Duration" => Some("u64"),
988 "std::time::SystemTime" => Some("u64"),
989 "std::io::Error"|"lightning::io::Error"|"lightning::io::ErrorKind" => Some("crate::c_types::IOError"),
990 "core::fmt::Arguments" if is_ref => Some("crate::c_types::Str"),
992 "core::convert::Infallible" => Some("crate::c_types::NotConstructable"),
994 "bitcoin::bech32::Error"|"bech32::Error"
995 if !is_ref => Some("crate::c_types::Bech32Error"),
996 "bitcoin::secp256k1::Error"|"secp256k1::Error"
997 if !is_ref => Some("crate::c_types::Secp256k1Error"),
999 "core::num::ParseIntError" => Some("crate::c_types::Error"),
1000 "core::str::Utf8Error" => Some("crate::c_types::Error"),
1002 "bitcoin::bech32::u5"|"bech32::u5" => Some("crate::c_types::U5"),
1003 "u128" => Some("crate::c_types::U128"),
1004 "core::num::NonZeroU8" => Some("u8"),
1006 "secp256k1::PublicKey"|"bitcoin::secp256k1::PublicKey" => Some("crate::c_types::PublicKey"),
1007 "bitcoin::secp256k1::ecdsa::Signature" => Some("crate::c_types::Signature"),
1008 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some("crate::c_types::RecoverableSignature"),
1009 "bitcoin::secp256k1::SecretKey" if is_ref => Some("*const [u8; 32]"),
1010 "bitcoin::secp256k1::SecretKey" if !is_ref => Some("crate::c_types::SecretKey"),
1011 "bitcoin::secp256k1::Scalar" if is_ref => Some("*const crate::c_types::BigEndianScalar"),
1012 "bitcoin::secp256k1::Scalar" if !is_ref => Some("crate::c_types::BigEndianScalar"),
1013 "bitcoin::secp256k1::ecdh::SharedSecret" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
1015 "bitcoin::blockdata::script::Script" if is_ref => Some("crate::c_types::u8slice"),
1016 "bitcoin::blockdata::script::Script" if !is_ref => Some("crate::c_types::derived::CVec_u8Z"),
1017 "bitcoin::OutPoint"|"bitcoin::blockdata::transaction::OutPoint" => Some("crate::lightning::chain::transaction::OutPoint"),
1018 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some("crate::c_types::Transaction"),
1019 "bitcoin::Witness" => Some("crate::c_types::Witness"),
1020 "bitcoin::TxOut"|"bitcoin::blockdata::transaction::TxOut" if !is_ref => Some("crate::c_types::TxOut"),
1021 "bitcoin::network::constants::Network" => Some("crate::bitcoin::network::Network"),
1022 "bitcoin::util::address::WitnessVersion" => Some("crate::c_types::WitnessVersion"),
1023 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some("*const [u8; 80]"),
1024 "bitcoin::blockdata::block::Block" if is_ref => Some("crate::c_types::u8slice"),
1026 "bitcoin::PubkeyHash"|"bitcoin::hash_types::PubkeyHash"|
1027 "bitcoin::hash_types::WPubkeyHash"|
1028 "bitcoin::ScriptHash"|"bitcoin::hash_types::ScriptHash"
1029 if !is_ref => Some("crate::c_types::TwentyBytes"),
1030 "bitcoin::PubkeyHash"|"bitcoin::hash_types::PubkeyHash"|
1031 "bitcoin::hash_types::WPubkeyHash"|
1032 "bitcoin::ScriptHash"|"bitcoin::hash_types::ScriptHash"
1033 if is_ref => Some("*const [u8; 20]"),
1034 "bitcoin::hash_types::WScriptHash"
1035 if is_ref => Some("*const [u8; 32]"),
1037 // Newtypes that we just expose in their original form.
1038 "bitcoin::hash_types::Txid"|"bitcoin::BlockHash"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"|"bitcoin::blockdata::constants::ChainHash"
1039 if is_ref => Some("*const [u8; 32]"),
1040 "bitcoin::hash_types::Txid"|"bitcoin::BlockHash"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"|"bitcoin::blockdata::constants::ChainHash"
1041 if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
1042 "bitcoin::secp256k1::Message" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
1043 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1044 |"lightning::ln::channelmanager::PaymentId"|"lightning::ln::channelmanager::InterceptId"
1045 |"lightning::chain::keysinterface::KeyMaterial"
1046 if is_ref => Some("*const [u8; 32]"),
1047 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1048 |"lightning::ln::channelmanager::PaymentId"|"lightning::ln::channelmanager::InterceptId"
1049 |"lightning::chain::keysinterface::KeyMaterial"
1050 if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
1052 "lightning::io::Read" => Some("crate::c_types::u8slice"),
1058 fn from_c_conversion_new_var_from_path<'b>(&self, _full_path: &str, _is_ref: bool) -> Option<(&'b str, &'b str)> {
1061 fn from_c_conversion_prefix_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<String> {
1062 if self.is_primitive(full_path) {
1063 return Some("".to_owned());
1066 "Vec" if !is_ref => Some("local_"),
1067 "Result" if !is_ref => Some("local_"),
1068 "Option" if is_ref => Some("&local_"),
1069 "Option" => Some("local_"),
1071 "[u8; 32]" if is_ref => Some("unsafe { &*"),
1072 "[u8; 32]" if !is_ref => Some(""),
1073 "[u8; 20]" if !is_ref => Some(""),
1074 "[u8; 16]" if !is_ref => Some(""),
1075 "[u8; 12]" if !is_ref => Some(""),
1076 "[u8; 4]" if !is_ref => Some(""),
1077 "[u8; 3]" if !is_ref => Some(""),
1078 "[u16; 8]" if !is_ref => Some(""),
1080 "[u8]" if is_ref => Some(""),
1081 "[usize]" if is_ref => Some(""),
1083 "str" if is_ref => Some(""),
1084 "alloc::string::String"|"String" => Some(""),
1085 "std::io::Error"|"lightning::io::Error"|"lightning::io::ErrorKind" => Some(""),
1086 // Note that we'll panic for String if is_ref, as we only have non-owned memory, we
1087 // cannot create a &String.
1089 "core::convert::Infallible" => Some("panic!(\"You must never construct a NotConstructable! : "),
1091 "bitcoin::bech32::Error"|"bech32::Error" if !is_ref => Some(""),
1092 "bitcoin::secp256k1::Error"|"secp256k1::Error" if !is_ref => Some(""),
1094 "core::num::ParseIntError" => Some("u8::from_str_radix(\" a\", 10).unwrap_err() /*"),
1095 "core::str::Utf8Error" => Some("core::str::from_utf8(&[0xff]).unwrap_err() /*"),
1097 "std::time::Duration"|"core::time::Duration" => Some("core::time::Duration::from_secs("),
1098 "std::time::SystemTime" => Some("(::std::time::SystemTime::UNIX_EPOCH + std::time::Duration::from_secs("),
1100 "bitcoin::bech32::u5"|"bech32::u5" => Some(""),
1102 "core::num::NonZeroU8" => Some("core::num::NonZeroU8::new("),
1104 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" if is_ref => Some("&"),
1105 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" => Some(""),
1106 "bitcoin::secp256k1::ecdsa::Signature" if is_ref => Some("&"),
1107 "bitcoin::secp256k1::ecdsa::Signature" => Some(""),
1108 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some(""),
1109 "bitcoin::secp256k1::SecretKey" if is_ref => Some("&::bitcoin::secp256k1::SecretKey::from_slice(&unsafe { *"),
1110 "bitcoin::secp256k1::SecretKey" if !is_ref => Some(""),
1111 "bitcoin::secp256k1::Scalar" if is_ref => Some("&"),
1112 "bitcoin::secp256k1::Scalar" if !is_ref => Some(""),
1113 "bitcoin::secp256k1::ecdh::SharedSecret" if !is_ref => Some("::bitcoin::secp256k1::ecdh::SharedSecret::from_bytes("),
1115 "bitcoin::blockdata::script::Script" if is_ref => Some("&::bitcoin::blockdata::script::Script::from(Vec::from("),
1116 "bitcoin::blockdata::script::Script" if !is_ref => Some("::bitcoin::blockdata::script::Script::from("),
1117 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" if is_ref => Some("&"),
1118 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(""),
1119 "bitcoin::Witness" if is_ref => Some("&"),
1120 "bitcoin::Witness" => Some(""),
1121 "bitcoin::OutPoint"|"bitcoin::blockdata::transaction::OutPoint" => Some("crate::c_types::C_to_bitcoin_outpoint("),
1122 "bitcoin::TxOut"|"bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(""),
1123 "bitcoin::network::constants::Network" => Some(""),
1124 "bitcoin::util::address::WitnessVersion" => Some(""),
1125 "bitcoin::blockdata::block::BlockHeader" => Some("&::bitcoin::consensus::encode::deserialize(unsafe { &*"),
1126 "bitcoin::blockdata::block::Block" if is_ref => Some("&::bitcoin::consensus::encode::deserialize("),
1128 "bitcoin::PubkeyHash"|"bitcoin::hash_types::PubkeyHash" if !is_ref =>
1129 Some("bitcoin::hash_types::PubkeyHash::from_hash(bitcoin::hashes::Hash::from_inner("),
1130 "bitcoin::PubkeyHash"|"bitcoin::hash_types::PubkeyHash" if is_ref =>
1131 Some("&bitcoin::hash_types::PubkeyHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
1132 "bitcoin::hash_types::WPubkeyHash" if is_ref =>
1133 Some("&bitcoin::hash_types::WPubkeyHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
1134 "bitcoin::ScriptHash"|"bitcoin::hash_types::ScriptHash" if !is_ref =>
1135 Some("bitcoin::hash_types::ScriptHash::from_hash(bitcoin::hashes::Hash::from_inner("),
1136 "bitcoin::ScriptHash"|"bitcoin::hash_types::ScriptHash" if is_ref =>
1137 Some("&bitcoin::hash_types::ScriptHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
1138 "bitcoin::hash_types::WScriptHash" if is_ref =>
1139 Some("&bitcoin::hash_types::WScriptHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
1141 // Newtypes that we just expose in their original form.
1142 "bitcoin::hash_types::Txid" if is_ref => Some("&::bitcoin::hash_types::Txid::from_slice(&unsafe { &*"),
1143 "bitcoin::hash_types::Txid" if !is_ref => Some("::bitcoin::hash_types::Txid::from_slice(&"),
1144 "bitcoin::hash_types::BlockHash"|"bitcoin::BlockHash" => Some("::bitcoin::hash_types::BlockHash::from_slice(&"),
1145 "bitcoin::blockdata::constants::ChainHash" => Some("::bitcoin::blockdata::constants::ChainHash::from(&"),
1146 "lightning::ln::PaymentHash" if !is_ref => Some("::lightning::ln::PaymentHash("),
1147 "lightning::ln::PaymentHash" if is_ref => Some("&::lightning::ln::PaymentHash(unsafe { *"),
1148 "lightning::ln::PaymentPreimage" if !is_ref => Some("::lightning::ln::PaymentPreimage("),
1149 "lightning::ln::PaymentPreimage" if is_ref => Some("&::lightning::ln::PaymentPreimage(unsafe { *"),
1150 "lightning::ln::PaymentSecret" if !is_ref => Some("::lightning::ln::PaymentSecret("),
1151 "lightning::ln::channelmanager::PaymentId" if !is_ref => Some("::lightning::ln::channelmanager::PaymentId("),
1152 "lightning::ln::channelmanager::PaymentId" if is_ref=> Some("&::lightning::ln::channelmanager::PaymentId( unsafe { *"),
1153 "lightning::ln::channelmanager::InterceptId" if !is_ref => Some("::lightning::ln::channelmanager::InterceptId("),
1154 "lightning::ln::channelmanager::InterceptId" if is_ref=> Some("&::lightning::ln::channelmanager::InterceptId( unsafe { *"),
1155 "lightning::chain::keysinterface::KeyMaterial" if !is_ref => Some("::lightning::chain::keysinterface::KeyMaterial("),
1156 "lightning::chain::keysinterface::KeyMaterial" if is_ref=> Some("&::lightning::chain::keysinterface::KeyMaterial( unsafe { *"),
1158 // List of traits we map (possibly during processing of other files):
1159 "lightning::io::Read" => Some("&mut "),
1162 }.map(|s| s.to_owned())
1164 fn from_c_conversion_suffix_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<String> {
1165 if self.is_primitive(full_path) {
1166 return Some("".to_owned());
1169 "Vec" if !is_ref => Some(""),
1170 "Option" => Some(""),
1171 "Result" if !is_ref => Some(""),
1173 "[u8; 32]" if is_ref => Some("}"),
1174 "[u8; 32]" if !is_ref => Some(".data"),
1175 "[u8; 20]" if !is_ref => Some(".data"),
1176 "[u8; 16]" if !is_ref => Some(".data"),
1177 "[u8; 12]" if !is_ref => Some(".data"),
1178 "[u8; 4]" if !is_ref => Some(".data"),
1179 "[u8; 3]" if !is_ref => Some(".data"),
1180 "[u16; 8]" if !is_ref => Some(".data"),
1182 "[u8]" if is_ref => Some(".to_slice()"),
1183 "[usize]" if is_ref => Some(".to_slice()"),
1185 "str" if is_ref => Some(".into_str()"),
1186 "alloc::string::String"|"String" => Some(".into_string()"),
1187 "std::io::Error"|"lightning::io::Error" => Some(".to_rust()"),
1188 "lightning::io::ErrorKind" => Some(".to_rust_kind()"),
1190 "core::convert::Infallible" => Some("\")"),
1192 "bitcoin::bech32::Error"|"bech32::Error" if !is_ref => Some(".into_rust()"),
1193 "bitcoin::secp256k1::Error"|"secp256k1::Error" if !is_ref => Some(".into_rust()"),
1195 "core::num::ParseIntError" => Some("*/"),
1196 "core::str::Utf8Error" => Some("*/"),
1198 "std::time::Duration"|"core::time::Duration" => Some(")"),
1199 "std::time::SystemTime" => Some("))"),
1201 "bitcoin::bech32::u5"|"bech32::u5" => Some(".into()"),
1202 "u128" => Some(".into()"),
1203 "core::num::NonZeroU8" => Some(").expect(\"Value must be non-zero\")"),
1205 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" => Some(".into_rust()"),
1206 "bitcoin::secp256k1::ecdsa::Signature" => Some(".into_rust()"),
1207 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some(".into_rust()"),
1208 "bitcoin::secp256k1::SecretKey" if !is_ref => Some(".into_rust()"),
1209 "bitcoin::secp256k1::SecretKey" if is_ref => Some("}[..]).unwrap()"),
1210 "bitcoin::secp256k1::Scalar" => Some(".into_rust()"),
1211 "bitcoin::secp256k1::ecdh::SharedSecret" if !is_ref => Some(".data)"),
1213 "bitcoin::blockdata::script::Script" if is_ref => Some(".to_slice()))"),
1214 "bitcoin::blockdata::script::Script" if !is_ref => Some(".into_rust())"),
1215 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(".into_bitcoin()"),
1216 "bitcoin::Witness" => Some(".into_bitcoin()"),
1217 "bitcoin::OutPoint"|"bitcoin::blockdata::transaction::OutPoint" => Some(")"),
1218 "bitcoin::TxOut"|"bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(".into_rust()"),
1219 "bitcoin::network::constants::Network" => Some(".into_bitcoin()"),
1220 "bitcoin::util::address::WitnessVersion" => Some(".into()"),
1221 "bitcoin::blockdata::block::BlockHeader" => Some(" }).unwrap()"),
1222 "bitcoin::blockdata::block::Block" => Some(".to_slice()).unwrap()"),
1224 "bitcoin::PubkeyHash"|"bitcoin::hash_types::PubkeyHash"|
1225 "bitcoin::hash_types::WPubkeyHash"|"bitcoin::hash_types::WScriptHash"|
1226 "bitcoin::ScriptHash"|"bitcoin::hash_types::ScriptHash"
1227 if !is_ref => Some(".data))"),
1228 "bitcoin::PubkeyHash"|"bitcoin::hash_types::PubkeyHash"|
1229 "bitcoin::hash_types::WPubkeyHash"|"bitcoin::hash_types::WScriptHash"|
1230 "bitcoin::ScriptHash"|"bitcoin::hash_types::ScriptHash"
1231 if is_ref => Some(" }.clone()))"),
1233 // Newtypes that we just expose in their original form.
1234 "bitcoin::hash_types::Txid" if is_ref => Some(" }[..]).unwrap()"),
1235 "bitcoin::hash_types::Txid" => Some(".data[..]).unwrap()"),
1236 "bitcoin::hash_types::BlockHash"|"bitcoin::BlockHash" if !is_ref => Some(".data[..]).unwrap()"),
1237 "bitcoin::blockdata::constants::ChainHash" if !is_ref => Some(".data[..])"),
1238 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1239 |"lightning::ln::channelmanager::PaymentId"|"lightning::ln::channelmanager::InterceptId"
1240 |"lightning::chain::keysinterface::KeyMaterial"
1241 if !is_ref => Some(".data)"),
1242 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1243 |"lightning::ln::channelmanager::PaymentId"|"lightning::ln::channelmanager::InterceptId"
1244 |"lightning::chain::keysinterface::KeyMaterial"
1245 if is_ref => Some(" })"),
1247 // List of traits we map (possibly during processing of other files):
1248 "lightning::io::Read" => Some(".to_reader()"),
1251 }.map(|s| s.to_owned())
1254 fn to_c_conversion_new_var_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<(&'b str, &'b str)> {
1255 if self.is_primitive(full_path) {
1259 "[u8]" if is_ref => Some(("crate::c_types::u8slice::from_slice(", ")")),
1260 "[usize]" if is_ref => Some(("crate::c_types::usizeslice::from_slice(", ")")),
1262 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some(("{ let mut s = [0u8; 80]; s[..].copy_from_slice(&::bitcoin::consensus::encode::serialize(", ")); s }")),
1263 "bitcoin::blockdata::block::Block" if is_ref => Some(("::bitcoin::consensus::encode::serialize(", ")")),
1264 "bitcoin::hash_types::Txid" => None,
1267 }.map(|s| s.to_owned())
1269 fn to_c_conversion_inline_prefix_from_path(&self, full_path: &str, is_ref: bool, _ptr_for_ref: bool) -> Option<String> {
1270 if self.is_primitive(full_path) {
1271 return Some("".to_owned());
1274 "Result" if !is_ref => Some("local_"),
1275 "Vec" if !is_ref => Some("local_"),
1276 "Option" => Some("local_"),
1278 "[u8; 32]" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1279 "[u8; 32]" if is_ref => Some(""),
1280 "[u8; 20]" if !is_ref => Some("crate::c_types::TwentyBytes { data: "),
1281 "[u8; 16]" if !is_ref => Some("crate::c_types::SixteenBytes { data: "),
1282 "[u8; 12]" if !is_ref => Some("crate::c_types::TwelveBytes { data: "),
1283 "[u8; 4]" if !is_ref => Some("crate::c_types::FourBytes { data: "),
1284 "[u8; 3]" if is_ref => Some(""),
1285 "[u16; 8]" if !is_ref => Some("crate::c_types::EightU16s { data: "),
1287 "[u8]" if is_ref => Some("local_"),
1288 "[usize]" if is_ref => Some("local_"),
1290 "str" if is_ref => Some(""),
1291 "alloc::string::String"|"String" => Some(""),
1293 "bitcoin::Address" => Some("alloc::string::ToString::to_string(&"),
1295 "std::time::Duration"|"core::time::Duration" => Some(""),
1296 "std::time::SystemTime" => Some(""),
1297 "std::io::Error"|"lightning::io::Error" => Some("crate::c_types::IOError::from_rust("),
1298 "lightning::io::ErrorKind" => Some("crate::c_types::IOError::from_rust_kind("),
1299 "core::fmt::Arguments" => Some("alloc::format!(\"{}\", "),
1301 "core::convert::Infallible" => Some("panic!(\"Cannot construct an Infallible: "),
1303 "bitcoin::bech32::Error"|"bech32::Error"
1304 if !is_ref => Some("crate::c_types::Bech32Error::from_rust("),
1305 "bitcoin::secp256k1::Error"|"secp256k1::Error"
1306 if !is_ref => Some("crate::c_types::Secp256k1Error::from_rust("),
1308 "core::num::ParseIntError" => Some("crate::c_types::Error { _dummy: 0 } /*"),
1309 "core::str::Utf8Error" => Some("crate::c_types::Error { _dummy: 0 } /*"),
1311 "bitcoin::bech32::u5"|"bech32::u5" => Some(""),
1314 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" => Some("crate::c_types::PublicKey::from_rust(&"),
1315 "bitcoin::secp256k1::ecdsa::Signature" => Some("crate::c_types::Signature::from_rust(&"),
1316 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some("crate::c_types::RecoverableSignature::from_rust(&"),
1317 "bitcoin::secp256k1::SecretKey" if is_ref => Some(""),
1318 "bitcoin::secp256k1::SecretKey" if !is_ref => Some("crate::c_types::SecretKey::from_rust("),
1319 "bitcoin::secp256k1::Scalar" if !is_ref => Some("crate::c_types::BigEndianScalar::from_rust(&"),
1320 "bitcoin::secp256k1::ecdh::SharedSecret" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1322 "bitcoin::blockdata::script::Script" if is_ref => Some("crate::c_types::u8slice::from_slice(&"),
1323 "bitcoin::blockdata::script::Script" if !is_ref => Some(""),
1324 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" if is_ref => Some("crate::c_types::Transaction::from_bitcoin("),
1325 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some("crate::c_types::Transaction::from_bitcoin(&"),
1326 "bitcoin::Witness" if is_ref => Some("crate::c_types::Witness::from_bitcoin("),
1327 "bitcoin::Witness" if !is_ref => Some("crate::c_types::Witness::from_bitcoin(&"),
1328 "bitcoin::OutPoint"|"bitcoin::blockdata::transaction::OutPoint" => Some("crate::c_types::bitcoin_to_C_outpoint("),
1329 "bitcoin::TxOut"|"bitcoin::blockdata::transaction::TxOut" if !is_ref => Some("crate::c_types::TxOut::from_rust("),
1330 "bitcoin::network::constants::Network" => Some("crate::bitcoin::network::Network::from_bitcoin("),
1331 "bitcoin::util::address::WitnessVersion" => Some(""),
1332 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some("&local_"),
1333 "bitcoin::blockdata::block::Block" if is_ref => Some("crate::c_types::u8slice::from_slice(&local_"),
1335 "bitcoin::hash_types::Txid" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1337 "bitcoin::PubkeyHash"|"bitcoin::hash_types::PubkeyHash"|
1338 "bitcoin::hash_types::WPubkeyHash"|"bitcoin::hash_types::WScriptHash"|
1339 "bitcoin::ScriptHash"|"bitcoin::hash_types::ScriptHash"
1340 if !is_ref => Some("crate::c_types::TwentyBytes { data: "),
1342 // Newtypes that we just expose in their original form.
1343 "bitcoin::hash_types::Txid"|"bitcoin::BlockHash"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"|"bitcoin::blockdata::constants::ChainHash"
1344 if is_ref => Some(""),
1345 "bitcoin::hash_types::Txid"|"bitcoin::BlockHash"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"|"bitcoin::blockdata::constants::ChainHash"
1346 if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1347 "bitcoin::secp256k1::Message" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1348 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1349 |"lightning::ln::channelmanager::PaymentId"|"lightning::ln::channelmanager::InterceptId"
1350 |"lightning::chain::keysinterface::KeyMaterial"
1351 if is_ref => Some("&"),
1352 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1353 |"lightning::ln::channelmanager::PaymentId"|"lightning::ln::channelmanager::InterceptId"
1354 |"lightning::chain::keysinterface::KeyMaterial"
1355 if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1357 "lightning::io::Read" => Some("crate::c_types::u8slice::from_vec(&crate::c_types::reader_to_vec("),
1360 }.map(|s| s.to_owned())
1362 fn to_c_conversion_inline_suffix_from_path(&self, full_path: &str, is_ref: bool, _ptr_for_ref: bool) -> Option<String> {
1363 if self.is_primitive(full_path) {
1364 return Some("".to_owned());
1367 "Result" if !is_ref => Some(""),
1368 "Vec" if !is_ref => Some(".into()"),
1369 "Option" => Some(""),
1371 "[u8; 32]" if !is_ref => Some(" }"),
1372 "[u8; 32]" if is_ref => Some(""),
1373 "[u8; 20]" if !is_ref => Some(" }"),
1374 "[u8; 16]" if !is_ref => Some(" }"),
1375 "[u8; 12]" if !is_ref => Some(" }"),
1376 "[u8; 4]" if !is_ref => Some(" }"),
1377 "[u8; 3]" if is_ref => Some(""),
1378 "[u16; 8]" if !is_ref => Some(" }"),
1380 "[u8]" if is_ref => Some(""),
1381 "[usize]" if is_ref => Some(""),
1383 "str" if is_ref => Some(".into()"),
1384 "alloc::string::String"|"String" if is_ref => Some(".as_str().into()"),
1385 "alloc::string::String"|"String" => Some(".into()"),
1387 "bitcoin::Address" => Some(").into()"),
1389 "std::time::Duration"|"core::time::Duration" => Some(".as_secs()"),
1390 "std::time::SystemTime" => Some(".duration_since(::std::time::SystemTime::UNIX_EPOCH).expect(\"Times must be post-1970\").as_secs()"),
1391 "std::io::Error"|"lightning::io::Error"|"lightning::io::ErrorKind" => Some(")"),
1392 "core::fmt::Arguments" => Some(").into()"),
1394 "core::convert::Infallible" => Some("\")"),
1396 "bitcoin::secp256k1::Error"|"bech32::Error"
1397 if !is_ref => Some(")"),
1398 "bitcoin::secp256k1::Error"|"secp256k1::Error"
1399 if !is_ref => Some(")"),
1401 "core::num::ParseIntError" => Some("*/"),
1402 "core::str::Utf8Error" => Some("*/"),
1404 "bitcoin::bech32::u5"|"bech32::u5" => Some(".into()"),
1405 "u128" => Some(".into()"),
1407 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" => Some(")"),
1408 "bitcoin::secp256k1::ecdsa::Signature" => Some(")"),
1409 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some(")"),
1410 "bitcoin::secp256k1::SecretKey" if !is_ref => Some(")"),
1411 "bitcoin::secp256k1::SecretKey" if is_ref => Some(".as_ref()"),
1412 "bitcoin::secp256k1::Scalar" if !is_ref => Some(")"),
1413 "bitcoin::secp256k1::ecdh::SharedSecret" if !is_ref => Some(".secret_bytes() }"),
1415 "bitcoin::blockdata::script::Script" if is_ref => Some("[..])"),
1416 "bitcoin::blockdata::script::Script" if !is_ref => Some(".into_bytes().into()"),
1417 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(")"),
1418 "bitcoin::Witness" => Some(")"),
1419 "bitcoin::OutPoint"|"bitcoin::blockdata::transaction::OutPoint" => Some(")"),
1420 "bitcoin::TxOut"|"bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(")"),
1421 "bitcoin::network::constants::Network" => Some(")"),
1422 "bitcoin::util::address::WitnessVersion" => Some(".into()"),
1423 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some(""),
1424 "bitcoin::blockdata::block::Block" if is_ref => Some(")"),
1426 "bitcoin::hash_types::Txid" if !is_ref => Some(".into_inner() }"),
1428 "bitcoin::PubkeyHash"|"bitcoin::hash_types::PubkeyHash"|
1429 "bitcoin::hash_types::WPubkeyHash"|"bitcoin::hash_types::WScriptHash"|
1430 "bitcoin::ScriptHash"|"bitcoin::hash_types::ScriptHash"
1431 if !is_ref => Some(".as_hash().into_inner() }"),
1433 // Newtypes that we just expose in their original form.
1434 "bitcoin::hash_types::Txid"|"bitcoin::BlockHash"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1435 if is_ref => Some(".as_inner()"),
1436 "bitcoin::hash_types::Txid"|"bitcoin::BlockHash"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1437 if !is_ref => Some(".into_inner() }"),
1438 "bitcoin::blockdata::constants::ChainHash" if is_ref => Some(".as_bytes() }"),
1439 "bitcoin::blockdata::constants::ChainHash" if !is_ref => Some(".to_bytes() }"),
1440 "bitcoin::secp256k1::Message" if !is_ref => Some(".as_ref().clone() }"),
1441 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1442 |"lightning::ln::channelmanager::PaymentId"|"lightning::ln::channelmanager::InterceptId"
1443 |"lightning::chain::keysinterface::KeyMaterial"
1444 if is_ref => Some(".0"),
1445 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1446 |"lightning::ln::channelmanager::PaymentId"|"lightning::ln::channelmanager::InterceptId"
1447 |"lightning::chain::keysinterface::KeyMaterial"
1448 if !is_ref => Some(".0 }"),
1450 "lightning::io::Read" => Some("))"),
1453 }.map(|s| s.to_owned())
1456 fn empty_val_check_suffix_from_path(&self, full_path: &str) -> Option<&str> {
1458 "lightning::ln::PaymentSecret" => Some(".data == [0; 32]"),
1459 "secp256k1::PublicKey"|"bitcoin::secp256k1::PublicKey" => Some(".is_null()"),
1460 "bitcoin::secp256k1::ecdsa::Signature" => Some(".is_null()"),
1465 /// When printing a reference to the source crate's rust type, if we need to map it to a
1466 /// different "real" type, it can be done so here.
1467 /// This is useful to work around limitations in the binding type resolver, where we reference
1468 /// a non-public `use` alias.
1469 /// TODO: We should never need to use this!
1470 fn real_rust_type_mapping<'equiv>(&self, thing: &'equiv str) -> &'equiv str {
1472 "lightning::io::Read" => "crate::c_types::io::Read",
1477 // ****************************
1478 // *** Container Processing ***
1479 // ****************************
1481 /// Returns the module path in the generated mapping crate to the containers which we generate
1482 /// when writing to CrateTypes::template_file.
1483 pub fn generated_container_path() -> &'static str {
1484 "crate::c_types::derived"
1486 /// Returns the module path in the generated mapping crate to the container templates, which
1487 /// are then concretized and put in the generated container path/template_file.
1488 fn container_templ_path() -> &'static str {
1492 /// This should just be a closure, but doing so gets an error like
1493 /// error: reached the recursion limit while instantiating `types::TypeResolver::is_transpar...c/types.rs:1358:104: 1358:110]>>`
1494 /// which implies the concrete function instantiation of `is_transparent_container` ends up
1495 /// being recursive.
1496 fn deref_type<'one, 'b: 'one> (obj: &'one &'b syn::Type) -> &'b syn::Type { *obj }
1498 /// Returns true if the path containing the given args is a "transparent" container, ie an
1499 /// Option or a container which does not require a generated continer class.
1500 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 {
1501 if full_path == "Option" {
1502 let inner = args.next().unwrap();
1503 assert!(args.next().is_none());
1504 match generics.resolve_type(inner) {
1505 syn::Type::Reference(r) => {
1506 let elem = &*r.elem;
1508 syn::Type::Path(_) =>
1509 self.is_transparent_container(full_path, true, [elem].iter().map(Self::deref_type), generics),
1513 syn::Type::Array(a) => {
1514 if let syn::Expr::Lit(l) = &a.len {
1515 if let syn::Lit::Int(i) = &l.lit {
1516 if i.base10_digits().parse::<usize>().unwrap() >= 32 {
1517 let mut buf = Vec::new();
1518 self.write_rust_type(&mut buf, generics, &a.elem, false);
1519 let ty = String::from_utf8(buf).unwrap();
1522 // Blindly assume that if we're trying to create an empty value for an
1523 // array < 32 entries that all-0s may be a valid state.
1526 } else { unimplemented!(); }
1527 } else { unimplemented!(); }
1529 syn::Type::Path(p) => {
1530 if let Some(resolved) = self.maybe_resolve_path(&p.path, generics) {
1531 if self.c_type_has_inner_from_path(&resolved) { return true; }
1532 if self.is_primitive(&resolved) { return false; }
1533 // We want to move to using `Option_` mappings where possible rather than
1534 // manual mappings, as it makes downstream bindings simpler and is more
1535 // clear for users. Thus, we default to false but override for a few
1536 // types which had mappings defined when we were avoiding the `Option_`s.
1537 match &resolved as &str {
1538 "lightning::ln::PaymentSecret" => true,
1539 "lightning::ln::PaymentHash" => true,
1540 "lightning::ln::PaymentPreimage" => true,
1541 "lightning::ln::channelmanager::PaymentId" => true,
1542 "bitcoin::hash_types::BlockHash"|"bitcoin::BlockHash" => true,
1543 "secp256k1::PublicKey"|"bitcoin::secp256k1::PublicKey" => true,
1546 } else { unimplemented!(); }
1548 syn::Type::Tuple(_) => false,
1549 _ => unimplemented!(),
1553 /// Returns true if the path is a "transparent" container, ie an Option or a container which does
1554 /// not require a generated continer class.
1555 pub fn is_path_transparent_container(&self, full_path: &syn::Path, generics: Option<&GenericTypes>, is_ref: bool) -> bool {
1556 let inner_iter = match &full_path.segments.last().unwrap().arguments {
1557 syn::PathArguments::None => return false,
1558 syn::PathArguments::AngleBracketed(args) => args.args.iter().map(|arg| {
1559 if let syn::GenericArgument::Type(ref ty) = arg {
1561 } else { unimplemented!() }
1563 syn::PathArguments::Parenthesized(_) => unimplemented!(),
1565 self.is_transparent_container(&self.resolve_path(full_path, generics), is_ref, inner_iter, generics)
1567 /// Returns true if this is a known, supported, non-transparent container.
1568 fn is_known_container(&self, full_path: &str, is_ref: bool) -> bool {
1569 (full_path == "Result" && !is_ref) || (full_path == "Vec" && !is_ref) || full_path.ends_with("Tuple") || full_path == "Option"
1571 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)
1572 // Returns prefix + Vec<(prefix, var-name-to-inline-convert)> + suffix
1573 // expecting one element in the vec per generic type, each of which is inline-converted
1574 -> Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)> {
1576 "Result" if !is_ref => {
1578 vec![(" { Ok(mut o) => crate::c_types::CResultTempl::ok(".to_string(), "o".to_string()),
1579 (").into(), Err(mut e) => crate::c_types::CResultTempl::err(".to_string(), "e".to_string())],
1580 ").into() }", ContainerPrefixLocation::PerConv))
1584 // We should only get here if the single contained has an inner
1585 assert!(self.c_type_has_inner(single_contained.unwrap()));
1587 Some(("Vec::new(); for mut item in ", vec![(format!(".drain(..) {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1590 if let Some(syn::Type::Reference(_)) = single_contained {
1591 Some(("Vec::new(); for item in ", vec![(format!(".iter() {{ local_{}.push(", var_name), "(*item)".to_string())], "); }", ContainerPrefixLocation::PerConv))
1593 Some(("Vec::new(); for item in ", vec![(format!(".iter() {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1597 let mut is_contained_ref = false;
1598 let contained_struct = if let Some(syn::Type::Path(p)) = single_contained {
1599 Some(self.resolve_path(&p.path, generics))
1600 } else if let Some(syn::Type::Reference(r)) = single_contained {
1601 is_contained_ref = true;
1602 if let syn::Type::Path(p) = &*r.elem {
1603 Some(self.resolve_path(&p.path, generics))
1606 if let Some(inner_path) = contained_struct {
1607 let only_contained_has_inner = self.c_type_has_inner_from_path(&inner_path);
1608 if self.c_type_has_inner_from_path(&inner_path) {
1609 let is_inner_ref = if let Some(syn::Type::Reference(_)) = single_contained { true } else { false };
1611 return Some(("if ", vec![
1612 (".is_none() { core::ptr::null() } else { ObjOps::nonnull_ptr_to_inner(".to_owned(),
1613 format!("({}{}.unwrap())", var_access, if is_inner_ref { "" } else { ".as_ref()" }))
1614 ], ") }", ContainerPrefixLocation::OutsideConv));
1616 return Some(("if ", vec![
1617 (".is_none() { core::ptr::null_mut() } else { ".to_owned(), format!("({}.unwrap())", var_access))
1618 ], " }", ContainerPrefixLocation::OutsideConv));
1620 } else if !self.is_transparent_container("Option", is_ref, [single_contained.unwrap()].iter().map(|a| *a), generics) {
1621 if self.is_primitive(&inner_path) || (!is_contained_ref && !is_ref) || only_contained_has_inner {
1622 let inner_name = self.get_c_mangled_container_type(vec![single_contained.unwrap()], generics, "Option").unwrap();
1623 return Some(("if ", vec![
1624 (format!(".is_none() {{ {}::None }} else {{ {}::Some(", inner_name, inner_name),
1625 format!("{}.unwrap()", var_access))
1626 ], ") }", ContainerPrefixLocation::PerConv));
1628 let inner_name = self.get_c_mangled_container_type(vec![single_contained.unwrap()], generics, "Option").unwrap();
1629 return Some(("if ", vec![
1630 (format!(".is_none() {{ {}::None }} else {{ {}::Some(/* WARNING: CLONING CONVERSION HERE! &Option<Enum> is otherwise un-expressable. */", inner_name, inner_name),
1631 format!("(*{}.as_ref().unwrap()).clone()", var_access))
1632 ], ") }", ContainerPrefixLocation::PerConv));
1635 // If c_type_from_path is some (ie there's a manual mapping for the inner
1636 // type), lean on write_empty_rust_val, below.
1639 if let Some(t) = single_contained {
1640 if let syn::Type::Tuple(syn::TypeTuple { elems, .. }) = t {
1641 let inner_name = self.get_c_mangled_container_type(vec![single_contained.unwrap()], generics, "Option").unwrap();
1642 if elems.is_empty() {
1643 return Some(("if ", vec![
1644 (format!(".is_none() {{ {}::None }} else {{ {}::Some /* ",
1645 inner_name, inner_name), format!(""))
1646 ], " */ }", ContainerPrefixLocation::PerConv));
1648 return Some(("if ", vec![
1649 (format!(".is_none() {{ {}::None }} else {{ {}::Some(",
1650 inner_name, inner_name), format!("({}.unwrap())", var_access))
1651 ], ") }", ContainerPrefixLocation::PerConv));
1654 if let syn::Type::Reference(syn::TypeReference { elem, .. }) = t {
1655 if let syn::Type::Slice(_) = &**elem {
1656 return Some(("if ", vec![
1657 (".is_none() { SmartPtr::null() } else { SmartPtr::from_obj(".to_string(),
1658 format!("({}.unwrap())", var_access))
1659 ], ") }", ContainerPrefixLocation::PerConv));
1662 let mut v = Vec::new();
1663 self.write_empty_rust_val(generics, &mut v, t);
1664 let s = String::from_utf8(v).unwrap();
1665 return Some(("if ", vec![
1666 (format!(".is_none() {{ {} }} else {{ ", s), format!("({}.unwrap())", var_access))
1667 ], " }", ContainerPrefixLocation::PerConv));
1668 } else { unreachable!(); }
1674 /// only_contained_has_inner implies that there is only one contained element in the container
1675 /// and it has an inner field (ie is an "opaque" type we've defined).
1676 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)
1677 // Returns prefix + Vec<(prefix, var-name-to-inline-convert)> + suffix
1678 // expecting one element in the vec per generic type, each of which is inline-converted
1679 -> Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)> {
1680 let mut only_contained_has_inner = false;
1681 let only_contained_resolved = if let Some(syn::Type::Path(p)) = single_contained {
1682 let res = self.resolve_path(&p.path, generics);
1683 only_contained_has_inner = self.c_type_has_inner_from_path(&res);
1687 "Result" if !is_ref => {
1689 vec![(".result_ok { true => Ok(".to_string(), format!("(*unsafe {{ Box::from_raw(<*mut _>::take_ptr(&mut {}.contents.result)) }})", var_access)),
1690 ("), false => Err(".to_string(), format!("(*unsafe {{ Box::from_raw(<*mut _>::take_ptr(&mut {}.contents.err)) }})", var_access))],
1691 ")}", ContainerPrefixLocation::PerConv))
1693 "Slice" if is_ref && only_contained_has_inner => {
1694 Some(("Vec::new(); for mut item in ", vec![(format!(".as_slice().iter() {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1697 Some(("Vec::new(); for mut item in ", vec![(format!(".into_rust().drain(..) {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1700 if let Some(resolved) = only_contained_resolved {
1701 if self.is_primitive(&resolved) {
1702 return Some(("if ", vec![(".is_some() { Some(".to_string(), format!("{}.take()", var_access))], ") } else { None }", ContainerPrefixLocation::NoPrefix))
1703 } else if only_contained_has_inner {
1705 return Some(("if ", vec![(".inner.is_null() { None } else { Some((*".to_string(), format!("{}", var_access))], ").clone()) }", ContainerPrefixLocation::PerConv))
1707 return Some(("if ", vec![(".inner.is_null() { None } else { Some(".to_string(), format!("{}", var_access))], ") }", ContainerPrefixLocation::PerConv));
1712 if let Some(t) = single_contained {
1714 syn::Type::Reference(_)|syn::Type::Path(_)|syn::Type::Slice(_)|syn::Type::Array(_) => {
1715 let mut v = Vec::new();
1716 let ret_ref = self.write_empty_rust_val_check_suffix(generics, &mut v, t);
1717 let s = String::from_utf8(v).unwrap();
1719 EmptyValExpectedTy::ReferenceAsPointer =>
1720 return Some(("if ", vec![
1721 (format!("{} {{ None }} else {{ Some(", s), format!("unsafe {{ &mut *{} }}", var_access))
1722 ], ") }", ContainerPrefixLocation::NoPrefix)),
1723 EmptyValExpectedTy::OptionType =>
1724 return Some(("{ /*", vec![
1725 (format!("*/ let {}_opt = {}; if {}_opt{} {{ None }} else {{ Some({{", var_name, var_access, var_name, s),
1726 format!("{{ {}_opt.take() }}", var_name))
1727 ], "})} }", ContainerPrefixLocation::PerConv)),
1728 EmptyValExpectedTy::NonPointer =>
1729 return Some(("if ", vec![
1730 (format!("{} {{ None }} else {{ Some(", s), format!("{}", var_access))
1731 ], ") }", ContainerPrefixLocation::PerConv)),
1734 syn::Type::Tuple(_) => {
1735 return Some(("if ", vec![(".is_some() { Some(".to_string(), format!("{}.take()", var_access))], ") } else { None }", ContainerPrefixLocation::PerConv))
1737 _ => unimplemented!(),
1739 } else { unreachable!(); }
1745 /// Constructs a reference to the given type, possibly tweaking the type if relevant to make it
1746 /// convertable to C.
1747 pub fn create_ownable_reference(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> Option<syn::Type> {
1748 let default_value = Some(syn::Type::Reference(syn::TypeReference {
1749 and_token: syn::Token!(&)(Span::call_site()), lifetime: None, mutability: None,
1750 elem: Box::new(t.clone()) }));
1751 match generics.resolve_type(t) {
1752 syn::Type::Path(p) => {
1753 if let Some(resolved_path) = self.maybe_resolve_path(&p.path, generics) {
1754 if resolved_path != "Vec" { return default_value; }
1755 if p.path.segments.len() != 1 { unimplemented!(); }
1756 let only_seg = p.path.segments.iter().next().unwrap();
1757 if let syn::PathArguments::AngleBracketed(args) = &only_seg.arguments {
1758 if args.args.len() != 1 { unimplemented!(); }
1759 let inner_arg = args.args.iter().next().unwrap();
1760 if let syn::GenericArgument::Type(ty) = &inner_arg {
1761 let mut can_create = self.c_type_has_inner(&ty);
1762 if let syn::Type::Path(inner) = ty {
1763 if inner.path.segments.len() == 1 &&
1764 format!("{}", inner.path.segments[0].ident) == "Vec" {
1768 if !can_create { return default_value; }
1769 if let Some(inner_ty) = self.create_ownable_reference(&ty, generics) {
1770 return Some(syn::Type::Reference(syn::TypeReference {
1771 and_token: syn::Token![&](Span::call_site()),
1774 elem: Box::new(syn::Type::Slice(syn::TypeSlice {
1775 bracket_token: syn::token::Bracket { span: Span::call_site() },
1776 elem: Box::new(inner_ty)
1779 } else { return default_value; }
1780 } else { unimplemented!(); }
1781 } else { unimplemented!(); }
1782 } else { return None; }
1788 // *************************************************
1789 // *** Type definition during main.rs processing ***
1790 // *************************************************
1792 /// Returns true if the object at the given path is mapped as X { inner: *mut origX, .. }.
1793 pub fn c_type_has_inner_from_path(&self, full_path: &str) -> bool {
1794 self.crate_types.opaques.get(full_path).is_some()
1797 /// Returns true if the object at the given path is mapped as X { inner: *mut origX, .. }.
1798 pub fn c_type_has_inner(&self, ty: &syn::Type) -> bool {
1800 syn::Type::Path(p) => {
1801 if let Some(full_path) = self.maybe_resolve_path(&p.path, None) {
1802 self.c_type_has_inner_from_path(&full_path)
1805 syn::Type::Reference(r) => {
1806 self.c_type_has_inner(&*r.elem)
1812 pub fn maybe_resolve_ident(&self, id: &syn::Ident) -> Option<String> {
1813 self.types.maybe_resolve_ident(id)
1816 pub fn maybe_resolve_path(&self, p_arg: &syn::Path, generics: Option<&GenericTypes>) -> Option<String> {
1817 self.types.maybe_resolve_path(p_arg, generics)
1819 pub fn resolve_path(&self, p: &syn::Path, generics: Option<&GenericTypes>) -> String {
1820 self.maybe_resolve_path(p, generics).unwrap()
1823 // ***********************************
1824 // *** Original Rust Type Printing ***
1825 // ***********************************
1827 fn in_rust_prelude(resolved_path: &str) -> bool {
1828 match resolved_path {
1836 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) {
1837 if let Some(resolved) = self.maybe_resolve_path(&path, generics_resolver) {
1838 if self.is_primitive(&resolved) {
1839 write!(w, "{}", path.get_ident().unwrap()).unwrap();
1841 // TODO: We should have a generic "is from a dependency" check here instead of
1842 // checking for "bitcoin" explicitly.
1843 if resolved.starts_with("bitcoin::") || Self::in_rust_prelude(&resolved) {
1844 write!(w, "{}", resolved).unwrap();
1845 } else if !generated_crate_ref {
1846 // If we're printing a generic argument, it needs to reference the crate, otherwise
1847 // the original crate.
1848 write!(w, "{}", self.real_rust_type_mapping(&resolved)).unwrap();
1850 write!(w, "crate::{}", resolved).unwrap();
1853 if let syn::PathArguments::AngleBracketed(args) = &path.segments.iter().last().unwrap().arguments {
1854 self.write_rust_generic_arg(w, generics_resolver, args.args.iter(), with_ref_lifetime);
1857 if path.leading_colon.is_some() {
1858 write!(w, "::").unwrap();
1860 for (idx, seg) in path.segments.iter().enumerate() {
1861 if idx != 0 { write!(w, "::").unwrap(); }
1862 write!(w, "{}", seg.ident).unwrap();
1863 if let syn::PathArguments::AngleBracketed(args) = &seg.arguments {
1864 self.write_rust_generic_arg(w, generics_resolver, args.args.iter(), with_ref_lifetime);
1869 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>) {
1870 let mut had_params = false;
1871 for (idx, arg) in generics.enumerate() {
1872 if idx != 0 { write!(w, ", ").unwrap(); } else { write!(w, "<").unwrap(); }
1875 syn::GenericParam::Lifetime(lt) => write!(w, "'{}", lt.lifetime.ident).unwrap(),
1876 syn::GenericParam::Type(t) => {
1877 write!(w, "{}", t.ident).unwrap();
1878 if t.colon_token.is_some() { write!(w, ":").unwrap(); }
1879 for (idx, bound) in t.bounds.iter().enumerate() {
1880 if idx != 0 { write!(w, " + ").unwrap(); }
1882 syn::TypeParamBound::Trait(tb) => {
1883 if tb.paren_token.is_some() || tb.lifetimes.is_some() { unimplemented!(); }
1884 self.write_rust_path(w, generics_resolver, &tb.path, false, false);
1886 _ => unimplemented!(),
1889 if t.eq_token.is_some() || t.default.is_some() { unimplemented!(); }
1891 _ => unimplemented!(),
1894 if had_params { write!(w, ">").unwrap(); }
1897 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) {
1898 write!(w, "<").unwrap();
1899 for (idx, arg) in generics.enumerate() {
1900 if idx != 0 { write!(w, ", ").unwrap(); }
1902 syn::GenericArgument::Type(t) => self.write_rust_type(w, generics_resolver, t, with_ref_lifetime),
1903 _ => unimplemented!(),
1906 write!(w, ">").unwrap();
1908 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) {
1909 let real_ty = generics.resolve_type(t);
1910 let mut generate_crate_ref = force_crate_ref || t != real_ty;
1912 syn::Type::Path(p) => {
1913 if p.qself.is_some() {
1916 if let Some(resolved_ty) = self.maybe_resolve_path(&p.path, generics) {
1917 generate_crate_ref |= self.maybe_resolve_path(&p.path, None).as_ref() != Some(&resolved_ty);
1918 if self.crate_types.traits.get(&resolved_ty).is_none() { generate_crate_ref = false; }
1920 self.write_rust_path(w, generics, &p.path, with_ref_lifetime, generate_crate_ref);
1922 syn::Type::Reference(r) => {
1923 write!(w, "&").unwrap();
1924 if let Some(lft) = &r.lifetime {
1925 write!(w, "'{} ", lft.ident).unwrap();
1926 } else if with_ref_lifetime {
1927 write!(w, "'static ").unwrap();
1929 if r.mutability.is_some() {
1930 write!(w, "mut ").unwrap();
1932 self.do_write_rust_type(w, generics, &*r.elem, with_ref_lifetime, generate_crate_ref);
1934 syn::Type::Array(a) => {
1935 write!(w, "[").unwrap();
1936 self.do_write_rust_type(w, generics, &a.elem, with_ref_lifetime, generate_crate_ref);
1937 if let syn::Expr::Lit(l) = &a.len {
1938 if let syn::Lit::Int(i) = &l.lit {
1939 write!(w, "; {}]", i).unwrap();
1940 } else { unimplemented!(); }
1941 } else { unimplemented!(); }
1943 syn::Type::Slice(s) => {
1944 write!(w, "[").unwrap();
1945 self.do_write_rust_type(w, generics, &s.elem, with_ref_lifetime, generate_crate_ref);
1946 write!(w, "]").unwrap();
1948 syn::Type::Tuple(s) => {
1949 write!(w, "(").unwrap();
1950 for (idx, t) in s.elems.iter().enumerate() {
1951 if idx != 0 { write!(w, ", ").unwrap(); }
1952 self.do_write_rust_type(w, generics, &t, with_ref_lifetime, generate_crate_ref);
1954 write!(w, ")").unwrap();
1956 _ => unimplemented!(),
1959 pub fn write_rust_type<W: std::io::Write>(&self, w: &mut W, generics: Option<&GenericTypes>, t: &syn::Type, with_ref_lifetime: bool) {
1960 self.do_write_rust_type(w, generics, t, with_ref_lifetime, false);
1964 /// Prints a constructor for something which is "uninitialized" (but obviously not actually
1965 /// unint'd memory).
1966 pub fn write_empty_rust_val<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type) {
1968 syn::Type::Reference(r) => {
1969 self.write_empty_rust_val(generics, w, &*r.elem)
1971 syn::Type::Path(p) => {
1972 let resolved = self.resolve_path(&p.path, generics);
1973 if self.crate_types.opaques.get(&resolved).is_some() {
1974 write!(w, "crate::{} {{ inner: core::ptr::null_mut(), is_owned: true }}", resolved).unwrap();
1976 // Assume its a manually-mapped C type, where we can just define an null() fn
1977 write!(w, "{}::null()", self.c_type_from_path(&resolved, false, false).unwrap()).unwrap();
1980 syn::Type::Array(a) => {
1981 if let syn::Expr::Lit(l) = &a.len {
1982 if let syn::Lit::Int(i) = &l.lit {
1983 if i.base10_digits().parse::<usize>().unwrap() < 32 {
1984 // Blindly assume that if we're trying to create an empty value for an
1985 // array < 32 entries that all-0s may be a valid state.
1988 let arrty = format!("[u8; {}]", i.base10_digits());
1989 write!(w, "{}", self.to_c_conversion_inline_prefix_from_path(&arrty, false, false).unwrap()).unwrap();
1990 write!(w, "[0; {}]", i.base10_digits()).unwrap();
1991 write!(w, "{}", self.to_c_conversion_inline_suffix_from_path(&arrty, false, false).unwrap()).unwrap();
1992 } else { unimplemented!(); }
1993 } else { unimplemented!(); }
1995 _ => unimplemented!(),
1999 fn is_real_type_array(&self, resolved_type: &str) -> Option<syn::Type> {
2000 if let Some(real_ty) = self.c_type_from_path(&resolved_type, true, false) {
2001 if real_ty.ends_with("]") && real_ty.starts_with("*const [u8; ") {
2002 let mut split = real_ty.split("; ");
2003 split.next().unwrap();
2004 let tail_str = split.next().unwrap();
2005 assert!(split.next().is_none());
2006 let len = usize::from_str_radix(&tail_str[..tail_str.len() - 1], 10).unwrap();
2007 Some(parse_quote!([u8; #len]))
2012 /// Prints a suffix to determine if a variable is empty (ie was set by write_empty_rust_val).
2013 /// See EmptyValExpectedTy for information on return types.
2014 fn write_empty_rust_val_check_suffix<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type) -> EmptyValExpectedTy {
2016 syn::Type::Reference(r) => {
2017 return self.write_empty_rust_val_check_suffix(generics, w, &*r.elem);
2019 syn::Type::Path(p) => {
2020 let resolved = self.resolve_path(&p.path, generics);
2021 if let Some(arr_ty) = self.is_real_type_array(&resolved) {
2022 return self.write_empty_rust_val_check_suffix(generics, w, &arr_ty);
2024 if self.crate_types.opaques.get(&resolved).is_some() {
2025 write!(w, ".inner.is_null()").unwrap();
2026 EmptyValExpectedTy::NonPointer
2028 if let Some(suffix) = self.empty_val_check_suffix_from_path(&resolved) {
2029 write!(w, "{}", suffix).unwrap();
2030 // We may eventually need to allow empty_val_check_suffix_from_path to specify if we need a deref or not
2031 EmptyValExpectedTy::NonPointer
2033 write!(w, ".is_none()").unwrap();
2034 EmptyValExpectedTy::OptionType
2038 syn::Type::Array(a) => {
2039 if let syn::Expr::Lit(l) = &a.len {
2040 if let syn::Lit::Int(i) = &l.lit {
2041 write!(w, ".data == [0; {}]", i.base10_digits()).unwrap();
2042 EmptyValExpectedTy::NonPointer
2043 } else { unimplemented!(); }
2044 } else { unimplemented!(); }
2046 syn::Type::Slice(_) => {
2047 // Option<[]> always implies that we want to treat len() == 0 differently from
2048 // None, so we always map an Option<[]> into a pointer.
2049 write!(w, " == core::ptr::null_mut()").unwrap();
2050 EmptyValExpectedTy::ReferenceAsPointer
2052 _ => unimplemented!(),
2056 /// Prints a suffix to determine if a variable is empty (ie was set by write_empty_rust_val).
2057 pub fn write_empty_rust_val_check<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type, var_access: &str) {
2059 syn::Type::Reference(r) => {
2060 self.write_empty_rust_val_check(generics, w, &*r.elem, var_access);
2062 syn::Type::Path(_) => {
2063 write!(w, "{}", var_access).unwrap();
2064 self.write_empty_rust_val_check_suffix(generics, w, t);
2066 syn::Type::Array(a) => {
2067 if let syn::Expr::Lit(l) = &a.len {
2068 if let syn::Lit::Int(i) = &l.lit {
2069 let arrty = format!("[u8; {}]", i.base10_digits());
2070 // We don't (yet) support a new-var conversion here.
2071 assert!(self.from_c_conversion_new_var_from_path(&arrty, false).is_none());
2073 self.from_c_conversion_prefix_from_path(&arrty, false).unwrap(),
2075 self.from_c_conversion_suffix_from_path(&arrty, false).unwrap()).unwrap();
2076 self.write_empty_rust_val_check_suffix(generics, w, t);
2077 } else { unimplemented!(); }
2078 } else { unimplemented!(); }
2080 _ => unimplemented!(),
2084 // ********************************
2085 // *** Type conversion printing ***
2086 // ********************************
2088 /// Returns true we if can just skip passing this to C entirely
2089 pub fn skip_arg(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> bool {
2091 syn::Type::Path(p) => {
2092 if p.qself.is_some() { unimplemented!(); }
2093 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
2094 self.skip_path(&full_path)
2097 syn::Type::Reference(r) => {
2098 self.skip_arg(&*r.elem, generics)
2103 pub fn no_arg_to_rust<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2105 syn::Type::Path(p) => {
2106 if p.qself.is_some() { unimplemented!(); }
2107 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
2108 write!(w, "{}", self.no_arg_path_to_rust(&full_path)).unwrap();
2111 syn::Type::Reference(r) => {
2112 self.no_arg_to_rust(w, &*r.elem, generics);
2118 fn write_conversion_inline_intern<W: std::io::Write,
2119 LP: Fn(&str, bool, bool) -> Option<String>, DL: Fn(&mut W, &DeclType, &str, bool, bool), SC: Fn(bool, Option<&str>) -> String>
2120 (&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, is_ref: bool, is_mut: bool, ptr_for_ref: bool,
2121 tupleconv: &str, prefix: bool, sliceconv: SC, path_lookup: LP, decl_lookup: DL) {
2122 match generics.resolve_type(t) {
2123 syn::Type::Reference(r) => {
2124 self.write_conversion_inline_intern(w, &*r.elem, generics, true, r.mutability.is_some(),
2125 ptr_for_ref, tupleconv, prefix, sliceconv, path_lookup, decl_lookup);
2127 syn::Type::Path(p) => {
2128 if p.qself.is_some() {
2132 let resolved_path = self.resolve_path(&p.path, generics);
2133 if let Some(aliased_type) = self.crate_types.type_aliases.get(&resolved_path) {
2134 return self.write_conversion_inline_intern(w, aliased_type, None, is_ref, is_mut, ptr_for_ref, tupleconv, prefix, sliceconv, path_lookup, decl_lookup);
2135 } else if self.is_primitive(&resolved_path) {
2136 if is_ref && prefix {
2137 write!(w, "*").unwrap();
2139 } else if let Some(c_type) = path_lookup(&resolved_path, is_ref, ptr_for_ref) {
2140 write!(w, "{}", c_type).unwrap();
2141 } else if let Some((_, generics)) = self.crate_types.opaques.get(&resolved_path) {
2142 decl_lookup(w, &DeclType::StructImported { generics: &generics }, &resolved_path, is_ref, is_mut);
2143 } else if self.crate_types.mirrored_enums.get(&resolved_path).is_some() {
2144 decl_lookup(w, &DeclType::MirroredEnum, &resolved_path, is_ref, is_mut);
2145 } else if let Some(t) = self.crate_types.traits.get(&resolved_path) {
2146 decl_lookup(w, &DeclType::Trait(t), &resolved_path, is_ref, is_mut);
2147 } else if let Some(ident) = single_ident_generic_path_to_ident(&p.path) {
2148 if let Some(decl_type) = self.types.maybe_resolve_declared(ident) {
2149 decl_lookup(w, decl_type, &self.maybe_resolve_ident(ident).unwrap(), is_ref, is_mut);
2150 } else { unimplemented!(); }
2151 } else { unimplemented!(); }
2153 syn::Type::Array(a) => {
2154 if let syn::Type::Path(p) = &*a.elem {
2155 let inner_ty = self.resolve_path(&p.path, generics);
2156 if let syn::Expr::Lit(l) = &a.len {
2157 if let syn::Lit::Int(i) = &l.lit {
2158 write!(w, "{}", path_lookup(&format!("[{}; {}]", inner_ty, i.base10_digits()), is_ref, ptr_for_ref).unwrap()).unwrap();
2159 } else { unimplemented!(); }
2160 } else { unimplemented!(); }
2161 } else { unimplemented!(); }
2163 syn::Type::Slice(s) => {
2164 // We assume all slices contain only literals or references.
2165 // This may result in some outputs not compiling.
2166 if let syn::Type::Path(p) = &*s.elem {
2167 let resolved = self.resolve_path(&p.path, generics);
2168 if self.is_primitive(&resolved) {
2169 write!(w, "{}", path_lookup("[u8]", is_ref, ptr_for_ref).unwrap()).unwrap();
2171 write!(w, "{}", sliceconv(true, None)).unwrap();
2173 } else if let syn::Type::Reference(r) = &*s.elem {
2174 if let syn::Type::Path(p) = &*r.elem {
2175 write!(w, "{}", sliceconv(self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)), None)).unwrap();
2176 } else if let syn::Type::Slice(_) = &*r.elem {
2177 write!(w, "{}", sliceconv(false, None)).unwrap();
2178 } else { unimplemented!(); }
2179 } else if let syn::Type::Tuple(t) = &*s.elem {
2180 assert!(!t.elems.is_empty());
2182 write!(w, "{}", sliceconv(false, None)).unwrap();
2184 let mut needs_map = false;
2185 for e in t.elems.iter() {
2186 if let syn::Type::Reference(_) = e {
2191 let mut map_str = Vec::new();
2192 write!(&mut map_str, ".map(|(").unwrap();
2193 for i in 0..t.elems.len() {
2194 write!(&mut map_str, "{}{}", if i != 0 { ", " } else { "" }, ('a' as u8 + i as u8) as char).unwrap();
2196 write!(&mut map_str, ")| (").unwrap();
2197 for (idx, e) in t.elems.iter().enumerate() {
2198 if let syn::Type::Reference(_) = e {
2199 write!(&mut map_str, "{}{}", if idx != 0 { ", " } else { "" }, (idx as u8 + 'a' as u8) as char).unwrap();
2200 } else if let syn::Type::Path(_) = e {
2201 write!(&mut map_str, "{}*{}", if idx != 0 { ", " } else { "" }, (idx as u8 + 'a' as u8) as char).unwrap();
2202 } else { unimplemented!(); }
2204 write!(&mut map_str, "))").unwrap();
2205 write!(w, "{}", sliceconv(false, Some(&String::from_utf8(map_str).unwrap()))).unwrap();
2207 write!(w, "{}", sliceconv(false, None)).unwrap();
2210 } else if let syn::Type::Array(_) = &*s.elem {
2211 write!(w, "{}", sliceconv(false, Some(".map(|a| *a)"))).unwrap();
2212 } else { unimplemented!(); }
2214 syn::Type::Tuple(t) => {
2215 if t.elems.is_empty() {
2216 // cbindgen has poor support for (), see, eg https://github.com/eqrion/cbindgen/issues/527
2217 // so work around it by just pretending its a 0u8
2218 write!(w, "{}", tupleconv).unwrap();
2220 if prefix { write!(w, "local_").unwrap(); }
2223 _ => unimplemented!(),
2227 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) {
2228 self.write_conversion_inline_intern(w, t, generics, is_ref, false, ptr_for_ref, "() /*", true, |_, _| "local_".to_owned(),
2229 |a, b, c| self.to_c_conversion_inline_prefix_from_path(a, b, c),
2230 |w, decl_type, decl_path, is_ref, _is_mut| {
2232 DeclType::MirroredEnum if is_ref && ptr_for_ref => write!(w, "crate::{}::from_native(", decl_path).unwrap(),
2233 DeclType::MirroredEnum if is_ref => write!(w, "&crate::{}::from_native(", decl_path).unwrap(),
2234 DeclType::MirroredEnum => write!(w, "crate::{}::native_into(", decl_path).unwrap(),
2235 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if is_ref && from_ptr => {
2236 if !ptr_for_ref { write!(w, "&").unwrap(); }
2237 write!(w, "crate::{} {{ inner: unsafe {{ (", decl_path).unwrap()
2239 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if is_ref => {
2240 if !ptr_for_ref { write!(w, "&").unwrap(); }
2241 write!(w, "crate::{} {{ inner: unsafe {{ ObjOps::nonnull_ptr_to_inner((", decl_path).unwrap()
2243 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref && from_ptr =>
2244 write!(w, "crate::{} {{ inner: ", decl_path).unwrap(),
2245 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref =>
2246 write!(w, "crate::{} {{ inner: ObjOps::heap_alloc(", decl_path).unwrap(),
2247 DeclType::Trait(_) if is_ref => write!(w, "").unwrap(),
2248 DeclType::Trait(_) if !is_ref => write!(w, "Into::into(").unwrap(),
2249 _ => panic!("{:?}", decl_path),
2253 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) {
2254 self.write_to_c_conversion_inline_prefix_inner(w, t, generics, false, ptr_for_ref, false);
2256 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) {
2257 self.write_conversion_inline_intern(w, t, generics, is_ref, false, ptr_for_ref, "*/", false, |_, _| ".into()".to_owned(),
2258 |a, b, c| self.to_c_conversion_inline_suffix_from_path(a, b, c),
2259 |w, decl_type, full_path, is_ref, _is_mut| match decl_type {
2260 DeclType::MirroredEnum => write!(w, ")").unwrap(),
2261 DeclType::EnumIgnored { generics }|DeclType::StructImported { generics } if is_ref => {
2262 write!(w, " as *const {}<", full_path).unwrap();
2263 for param in generics.params.iter() {
2264 if let syn::GenericParam::Lifetime(_) = param {
2265 write!(w, "'_, ").unwrap();
2267 write!(w, "_, ").unwrap();
2271 write!(w, ">) as *mut _ }}, is_owned: false }}").unwrap();
2273 write!(w, ">) as *mut _) }}, is_owned: false }}").unwrap();
2276 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref && from_ptr =>
2277 write!(w, ", is_owned: true }}").unwrap(),
2278 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref => write!(w, "), is_owned: true }}").unwrap(),
2279 DeclType::Trait(_) if is_ref => {},
2280 DeclType::Trait(_) => {
2281 // This is used when we're converting a concrete Rust type into a C trait
2282 // for use when a Rust trait method returns an associated type.
2283 // Because all of our C traits implement From<RustTypesImplementingTraits>
2284 // we can just call .into() here and be done.
2285 write!(w, ")").unwrap()
2287 _ => unimplemented!(),
2290 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) {
2291 self.write_to_c_conversion_inline_suffix_inner(w, t, generics, false, ptr_for_ref, false);
2294 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) {
2295 self.write_conversion_inline_intern(w, t, generics, is_ref, false, false, "() /*", true, |_, _| "&local_".to_owned(),
2296 |a, b, _c| self.from_c_conversion_prefix_from_path(a, b),
2297 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
2298 DeclType::StructImported {..} if is_ref => write!(w, "").unwrap(),
2299 DeclType::StructImported {..} if !is_ref => write!(w, "*unsafe {{ Box::from_raw(").unwrap(),
2300 DeclType::MirroredEnum if is_ref => write!(w, "&").unwrap(),
2301 DeclType::MirroredEnum => {},
2302 DeclType::Trait(_) => {},
2303 _ => unimplemented!(),
2306 pub fn write_from_c_conversion_prefix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2307 self.write_from_c_conversion_prefix_inner(w, t, generics, false, false);
2309 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) {
2310 self.write_conversion_inline_intern(w, t, generics, is_ref, false, false, "*/", false,
2311 |has_inner, map_str_opt| match (has_inner, map_str_opt) {
2312 (false, Some(map_str)) => format!(".iter(){}.collect::<Vec<_>>()[..]", map_str),
2313 (false, None) => ".iter().collect::<Vec<_>>()[..]".to_owned(),
2314 (true, None) => "[..]".to_owned(),
2315 (true, Some(_)) => unreachable!(),
2317 |a, b, _c| self.from_c_conversion_suffix_from_path(a, b),
2318 |w, decl_type, _full_path, is_ref, is_mut| match decl_type {
2319 DeclType::StructImported {..} if is_ref && ptr_for_ref => write!(w, "XXX unimplemented").unwrap(),
2320 DeclType::StructImported {..} if is_mut && is_ref => write!(w, ".get_native_mut_ref()").unwrap(),
2321 DeclType::StructImported {..} if is_ref => write!(w, ".get_native_ref()").unwrap(),
2322 DeclType::StructImported {..} if !is_ref => write!(w, ".take_inner()) }}").unwrap(),
2323 DeclType::MirroredEnum if is_ref => write!(w, ".to_native()").unwrap(),
2324 DeclType::MirroredEnum => write!(w, ".into_native()").unwrap(),
2325 DeclType::Trait(_) => {},
2326 _ => unimplemented!(),
2329 pub fn write_from_c_conversion_suffix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2330 self.write_from_c_conversion_suffix_inner(w, t, generics, false, false);
2332 // Note that compared to the above conversion functions, the following two are generally
2333 // significantly undertested:
2334 pub fn write_from_c_conversion_to_ref_prefix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2335 self.write_conversion_inline_intern(w, t, generics, false, false, false, "() /*", true, |_, _| "&local_".to_owned(),
2337 if let Some(conv) = self.from_c_conversion_prefix_from_path(a, b) {
2338 Some(format!("&{}", conv))
2341 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
2342 DeclType::StructImported {..} if !is_ref => write!(w, "").unwrap(),
2343 _ => unimplemented!(),
2346 pub fn write_from_c_conversion_to_ref_suffix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2347 self.write_conversion_inline_intern(w, t, generics, false, false, false, "*/", false,
2348 |has_inner, map_str_opt| match (has_inner, map_str_opt) {
2349 (false, Some(map_str)) => format!(".iter(){}.collect::<Vec<_>>()[..]", map_str),
2350 (false, None) => ".iter().collect::<Vec<_>>()[..]".to_owned(),
2351 (true, None) => "[..]".to_owned(),
2352 (true, Some(_)) => unreachable!(),
2354 |a, b, _c| self.from_c_conversion_suffix_from_path(a, b),
2355 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
2356 DeclType::StructImported {..} if !is_ref => write!(w, ".get_native_ref()").unwrap(),
2357 _ => unimplemented!(),
2361 fn write_conversion_new_var_intern<'b, W: std::io::Write,
2362 LP: Fn(&str, bool) -> Option<(&str, &str)>,
2363 LC: Fn(&str, bool, Option<&syn::Type>, &syn::Ident, &str) -> Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)>,
2364 VP: Fn(&mut W, &syn::Type, Option<&GenericTypes>, bool, bool, bool),
2365 VS: Fn(&mut W, &syn::Type, Option<&GenericTypes>, bool, bool, bool)>
2366 (&self, w: &mut W, ident: &syn::Ident, var: &str, t: &syn::Type, generics: Option<&GenericTypes>,
2367 mut is_ref: bool, mut ptr_for_ref: bool, to_c: bool, from_ownable_ref: bool,
2368 path_lookup: &LP, container_lookup: &LC, var_prefix: &VP, var_suffix: &VS) -> bool {
2370 macro_rules! convert_container {
2371 ($container_type: expr, $args_len: expr, $args_iter: expr) => { {
2372 // For slices (and Options), we refuse to directly map them as is_ref when they
2373 // aren't opaque types containing an inner pointer. This is due to the fact that,
2374 // in both cases, the actual higher-level type is non-is_ref.
2375 let (ty_has_inner, ty_is_trait) = if $args_len == 1 {
2376 let ty = $args_iter().next().unwrap();
2377 if $container_type == "Slice" && to_c {
2378 // "To C ptr_for_ref" means "return the regular object with is_owned
2379 // set to false", which is totally what we want in a slice if we're about to
2380 // set ty_has_inner.
2383 if let syn::Type::Reference(t) = ty {
2384 if let syn::Type::Path(p) = &*t.elem {
2385 let resolved = self.resolve_path(&p.path, generics);
2386 (self.c_type_has_inner_from_path(&resolved), self.crate_types.traits.get(&resolved).is_some())
2387 } else { (false, false) }
2388 } else if let syn::Type::Path(p) = ty {
2389 let resolved = self.resolve_path(&p.path, generics);
2390 (self.c_type_has_inner_from_path(&resolved), self.crate_types.traits.get(&resolved).is_some())
2391 } else { (false, false) }
2392 } else { (true, false) };
2394 // Options get a bunch of special handling, since in general we map Option<>al
2395 // types into the same C type as non-Option-wrapped types. This ends up being
2396 // pretty manual here and most of the below special-cases are for Options.
2397 let mut needs_ref_map = false;
2398 let mut only_contained_type = None;
2399 let mut only_contained_type_nonref = None;
2400 let mut only_contained_has_inner = false;
2401 let mut contains_slice = false;
2403 only_contained_has_inner = ty_has_inner;
2404 let arg = $args_iter().next().unwrap();
2405 if let syn::Type::Reference(t) = arg {
2406 only_contained_type = Some(arg);
2407 only_contained_type_nonref = Some(&*t.elem);
2408 if let syn::Type::Path(_) = &*t.elem {
2410 } else if let syn::Type::Slice(_) = &*t.elem {
2411 contains_slice = true;
2412 } else { return false; }
2413 // If the inner element contains an inner pointer, we will just use that,
2414 // avoiding the need to map elements to references. Otherwise we'll need to
2415 // do an extra mapping step.
2416 needs_ref_map = !only_contained_has_inner && !ty_is_trait && $container_type == "Option";
2418 only_contained_type = Some(arg);
2419 only_contained_type_nonref = Some(arg);
2423 if let Some((prefix, conversions, suffix, prefix_location)) = container_lookup(&$container_type, is_ref, only_contained_type, ident, var) {
2424 assert_eq!(conversions.len(), $args_len);
2425 write!(w, "let mut local_{}{} = ", ident,
2426 if (!to_c && needs_ref_map) || (to_c && $container_type == "Option" && contains_slice) {"_base"} else { "" }).unwrap();
2427 if prefix_location == ContainerPrefixLocation::OutsideConv {
2428 var_prefix(w, $args_iter().next().unwrap(), generics, is_ref, true, true);
2430 write!(w, "{}{}", prefix, var).unwrap();
2432 for ((pfx, var_name), (idx, ty)) in conversions.iter().zip($args_iter().enumerate()) {
2433 let mut var = std::io::Cursor::new(Vec::new());
2434 write!(&mut var, "{}", var_name).unwrap();
2435 let var_access = String::from_utf8(var.into_inner()).unwrap();
2437 let conv_ty = if needs_ref_map { only_contained_type_nonref.as_ref().unwrap() } else { ty };
2439 write!(w, "{} {{ ", pfx).unwrap();
2440 let new_var_name = format!("{}_{}", ident, idx);
2441 let new_var = self.write_conversion_new_var_intern(w, &format_ident!("{}", new_var_name),
2442 &var_access, conv_ty, generics, contains_slice || (is_ref && ty_has_inner), ptr_for_ref,
2443 to_c, from_ownable_ref, path_lookup, container_lookup, var_prefix, var_suffix);
2444 if new_var { write!(w, " ").unwrap(); }
2446 if prefix_location == ContainerPrefixLocation::PerConv {
2447 var_prefix(w, conv_ty, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2448 } else if !is_ref && !needs_ref_map && to_c && only_contained_has_inner {
2449 write!(w, "ObjOps::heap_alloc(").unwrap();
2452 write!(w, "{}{}", if contains_slice && !to_c { "local_" } else { "" }, if new_var { new_var_name } else { var_access }).unwrap();
2453 if prefix_location == ContainerPrefixLocation::PerConv {
2454 var_suffix(w, conv_ty, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2455 } else if !is_ref && !needs_ref_map && to_c && only_contained_has_inner {
2456 write!(w, ")").unwrap();
2458 write!(w, " }}").unwrap();
2460 write!(w, "{}", suffix).unwrap();
2461 if prefix_location == ContainerPrefixLocation::OutsideConv {
2462 var_suffix(w, $args_iter().next().unwrap(), generics, is_ref, ptr_for_ref, true);
2464 write!(w, ";").unwrap();
2465 if !to_c && needs_ref_map {
2466 write!(w, " let mut local_{} = local_{}_base.as_ref()", ident, ident).unwrap();
2468 write!(w, ".map(|a| &a[..])").unwrap();
2470 write!(w, ";").unwrap();
2471 } else if to_c && $container_type == "Option" && contains_slice {
2472 write!(w, " let mut local_{} = *local_{}_base;", ident, ident).unwrap();
2479 match generics.resolve_type(t) {
2480 syn::Type::Reference(r) => {
2481 if let syn::Type::Slice(_) = &*r.elem {
2482 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)
2484 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)
2487 syn::Type::Path(p) => {
2488 if p.qself.is_some() {
2491 let resolved_path = self.resolve_path(&p.path, generics);
2492 if let Some(aliased_type) = self.crate_types.type_aliases.get(&resolved_path) {
2493 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);
2495 if self.is_known_container(&resolved_path, is_ref) || self.is_path_transparent_container(&p.path, generics, is_ref) {
2496 if let syn::PathArguments::AngleBracketed(args) = &p.path.segments.iter().next().unwrap().arguments {
2497 convert_container!(resolved_path, args.args.len(), || args.args.iter().map(|arg| {
2498 if let syn::GenericArgument::Type(ty) = arg {
2499 generics.resolve_type(ty)
2500 } else { unimplemented!(); }
2502 } else { unimplemented!(); }
2504 if self.is_primitive(&resolved_path) {
2506 } else if let Some(ty_ident) = single_ident_generic_path_to_ident(&p.path) {
2507 if let Some((prefix, suffix)) = path_lookup(&resolved_path, is_ref) {
2508 write!(w, "let mut local_{} = {}{}{};", ident, prefix, var, suffix).unwrap();
2510 } else if self.types.maybe_resolve_declared(ty_ident).is_some() {
2515 syn::Type::Array(_) => {
2516 // We assume all arrays contain only primitive types.
2517 // This may result in some outputs not compiling.
2520 syn::Type::Slice(s) => {
2521 if let syn::Type::Path(p) = &*s.elem {
2522 let resolved = self.resolve_path(&p.path, generics);
2523 if self.is_primitive(&resolved) {
2524 let slice_path = format!("[{}]", resolved);
2525 if let Some((prefix, suffix)) = path_lookup(&slice_path, true) {
2526 write!(w, "let mut local_{} = {}{}{};", ident, prefix, var, suffix).unwrap();
2530 let tyref = [&*s.elem];
2532 // If we're converting from a slice to a Vec, assume we can clone the
2533 // elements and clone them into a new Vec first. Next we'll walk the
2534 // new Vec here and convert them to C types.
2535 write!(w, "let mut local_{}_clone = Vec::new(); local_{}_clone.extend_from_slice({}); let mut {} = local_{}_clone; ", ident, ident, ident, ident, ident).unwrap();
2538 convert_container!("Vec", 1, || tyref.iter().map(|t| generics.resolve_type(*t)));
2539 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2541 } else if let syn::Type::Reference(ty) = &*s.elem {
2542 let tyref = if from_ownable_ref || !to_c { [&*ty.elem] } else { [&*s.elem] };
2544 convert_container!("Slice", 1, || tyref.iter().map(|t| generics.resolve_type(*t)));
2545 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2546 } else if let syn::Type::Tuple(t) = &*s.elem {
2547 // When mapping into a temporary new var, we need to own all the underlying objects.
2548 // Thus, we drop any references inside the tuple and convert with non-reference types.
2549 let mut elems = syn::punctuated::Punctuated::new();
2550 for elem in t.elems.iter() {
2551 if let syn::Type::Reference(r) = elem {
2552 elems.push((*r.elem).clone());
2554 elems.push(elem.clone());
2557 let ty = [syn::Type::Tuple(syn::TypeTuple {
2558 paren_token: t.paren_token, elems
2562 convert_container!("Slice", 1, || ty.iter());
2563 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2564 } else if let syn::Type::Array(_) = &*s.elem {
2567 let arr_elem = [(*s.elem).clone()];
2568 convert_container!("Slice", 1, || arr_elem.iter());
2569 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2570 } else { unimplemented!() }
2572 syn::Type::Tuple(t) => {
2573 if !t.elems.is_empty() {
2574 // We don't (yet) support tuple elements which cannot be converted inline
2575 write!(w, "let (").unwrap();
2576 for idx in 0..t.elems.len() {
2577 if idx != 0 { write!(w, ", ").unwrap(); }
2578 write!(w, "{} orig_{}_{}", if is_ref { "ref" } else { "mut" }, ident, idx).unwrap();
2580 write!(w, ") = {}{}; ", var, if !to_c { ".to_rust()" } else { "" }).unwrap();
2581 // Like other template types, tuples are always mapped as their non-ref
2582 // versions for types which have different ref mappings. Thus, we convert to
2583 // non-ref versions and handle opaque types with inner pointers manually.
2584 for (idx, elem) in t.elems.iter().enumerate() {
2585 if let syn::Type::Path(p) = elem {
2586 let v_name = format!("orig_{}_{}", ident, idx);
2587 let tuple_elem_ident = format_ident!("{}", &v_name);
2588 if self.write_conversion_new_var_intern(w, &tuple_elem_ident, &v_name, elem, generics,
2589 false, ptr_for_ref, to_c, from_ownable_ref,
2590 path_lookup, container_lookup, var_prefix, var_suffix) {
2591 write!(w, " ").unwrap();
2592 // Opaque types with inner pointers shouldn't ever create new stack
2593 // variables, so we don't handle it and just assert that it doesn't
2595 assert!(!self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)));
2599 write!(w, "let mut local_{} = (", ident).unwrap();
2600 for (idx, elem) in t.elems.iter().enumerate() {
2601 let real_elem = generics.resolve_type(&elem);
2602 let ty_has_inner = {
2604 // "To C ptr_for_ref" means "return the regular object with
2605 // is_owned set to false", which is totally what we want
2606 // if we're about to set ty_has_inner.
2609 if let syn::Type::Reference(t) = real_elem {
2610 if let syn::Type::Path(p) = &*t.elem {
2611 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
2613 } else if let syn::Type::Path(p) = real_elem {
2614 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
2617 if idx != 0 { write!(w, ", ").unwrap(); }
2618 var_prefix(w, real_elem, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2619 if is_ref && ty_has_inner {
2620 // For ty_has_inner, the regular var_prefix mapping will take a
2621 // reference, so deref once here to make sure we keep the original ref.
2622 write!(w, "*").unwrap();
2624 write!(w, "orig_{}_{}", ident, idx).unwrap();
2625 if is_ref && !ty_has_inner {
2626 // If we don't have an inner variable's reference to maintain, just
2627 // hope the type is Clonable and use that.
2628 write!(w, ".clone()").unwrap();
2630 var_suffix(w, real_elem, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2632 write!(w, "){};", if to_c { ".into()" } else { "" }).unwrap();
2636 _ => unimplemented!(),
2640 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 {
2641 self.write_conversion_new_var_intern(w, ident, var_access, t, generics, from_ownable_ref, ptr_for_ref, true, from_ownable_ref,
2642 &|a, b| self.to_c_conversion_new_var_from_path(a, b),
2643 &|a, b, c, d, e| self.to_c_conversion_container_new_var(generics, a, b, c, d, e),
2644 // We force ptr_for_ref here since we can't generate a ref on one line and use it later
2645 &|a, b, c, d, e, f| self.write_to_c_conversion_inline_prefix_inner(a, b, c, d, e, f),
2646 &|a, b, c, d, e, f| self.write_to_c_conversion_inline_suffix_inner(a, b, c, d, e, f))
2648 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 {
2649 self.write_to_c_conversion_new_var_inner(w, ident, &format!("{}", ident), t, generics, ptr_for_ref, false)
2651 /// Prints new-var conversion for an "ownable_ref" type, ie prints conversion for
2652 /// `create_ownable_reference(t)`, not `t` itself.
2653 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 {
2654 self.write_to_c_conversion_new_var_inner(w, ident, &format!("{}", ident), t, generics, true, true)
2656 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 {
2657 self.write_conversion_new_var_intern(w, ident, &format!("{}", ident), t, generics, false, false, false, false,
2658 &|a, b| self.from_c_conversion_new_var_from_path(a, b),
2659 &|a, b, c, d, e| self.from_c_conversion_container_new_var(generics, a, b, c, d, e),
2660 // We force ptr_for_ref here since we can't generate a ref on one line and use it later
2661 &|a, b, c, d, e, _f| self.write_from_c_conversion_prefix_inner(a, b, c, d, e),
2662 &|a, b, c, d, e, _f| self.write_from_c_conversion_suffix_inner(a, b, c, d, e))
2665 // ******************************************************
2666 // *** C Container Type Equivalent and alias Printing ***
2667 // ******************************************************
2669 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 {
2670 for (idx, orig_t) in args.enumerate() {
2672 write!(w, ", ").unwrap();
2674 let t = generics.resolve_type(orig_t);
2675 if let syn::Type::Reference(r_arg) = t {
2676 assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
2678 if !self.write_c_type_intern(w, &*r_arg.elem, generics, false, false, false, true, true) { return false; }
2680 // While write_c_type_intern, above is correct, we don't want to blindly convert a
2681 // reference to something stupid, so check that the container is either opaque or a
2682 // predefined type (currently only Transaction).
2683 if let syn::Type::Path(p_arg) = &*r_arg.elem {
2684 let resolved = self.resolve_path(&p_arg.path, generics);
2685 assert!(self.crate_types.opaques.get(&resolved).is_some() ||
2686 self.crate_types.traits.get(&resolved).is_some() ||
2687 self.c_type_from_path(&resolved, true, true).is_some(), "Template generics should be opaque or have a predefined mapping");
2688 } else { unimplemented!(); }
2689 } else if let syn::Type::Path(p_arg) = t {
2690 if let Some(resolved) = self.maybe_resolve_path(&p_arg.path, generics) {
2691 if !self.is_primitive(&resolved) {
2693 // We don't currently support outer reference types for non-primitive inners
2699 // We don't currently support outer reference types for non-primitive inners
2703 if !self.write_c_type_intern(w, t, generics, false, false, false, true, true) { return false; }
2705 // We don't currently support outer reference types for non-primitive inners,
2706 // except for the empty tuple.
2707 if let syn::Type::Tuple(t_arg) = t {
2708 assert!(t_arg.elems.len() == 0 || !is_ref);
2712 if !self.write_c_type_intern(w, t, generics, false, false, false, true, true) { return false; }
2717 fn check_create_container(&self, mangled_container: String, container_type: &str, args: Vec<&syn::Type>, generics: Option<&GenericTypes>, is_ref: bool) -> bool {
2718 if !self.crate_types.templates_defined.borrow().get(&mangled_container).is_some() {
2719 let mut created_container: Vec<u8> = Vec::new();
2721 if container_type == "Result" {
2722 let mut a_ty: Vec<u8> = Vec::new();
2723 if let syn::Type::Tuple(tup) = args.iter().next().unwrap() {
2724 if tup.elems.is_empty() {
2725 write!(&mut a_ty, "()").unwrap();
2727 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t).take(1), generics, is_ref) { return false; }
2730 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t).take(1), generics, is_ref) { return false; }
2733 let mut b_ty: Vec<u8> = Vec::new();
2734 if let syn::Type::Tuple(tup) = args.iter().skip(1).next().unwrap() {
2735 if tup.elems.is_empty() {
2736 write!(&mut b_ty, "()").unwrap();
2738 if !self.write_template_generics(&mut b_ty, &mut args.iter().map(|t| *t).skip(1), generics, is_ref) { return false; }
2741 if !self.write_template_generics(&mut b_ty, &mut args.iter().map(|t| *t).skip(1), generics, is_ref) { return false; }
2744 let ok_str = String::from_utf8(a_ty).unwrap();
2745 let err_str = String::from_utf8(b_ty).unwrap();
2746 let is_clonable = self.is_clonable(&ok_str) && self.is_clonable(&err_str);
2747 write_result_block(&mut created_container, &mangled_container, &ok_str, &err_str, is_clonable);
2749 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2751 } else if container_type == "Vec" {
2752 let mut a_ty: Vec<u8> = Vec::new();
2753 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t), generics, is_ref) { return false; }
2754 let ty = String::from_utf8(a_ty).unwrap();
2755 let is_clonable = self.is_clonable(&ty);
2756 write_vec_block(&mut created_container, &mangled_container, &ty, is_clonable);
2758 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2760 } else if container_type.ends_with("Tuple") {
2761 let mut tuple_args = Vec::new();
2762 let mut is_clonable = true;
2763 for arg in args.iter() {
2764 let mut ty: Vec<u8> = Vec::new();
2765 if !self.write_template_generics(&mut ty, &mut [arg].iter().map(|t| **t), generics, is_ref) { return false; }
2766 let ty_str = String::from_utf8(ty).unwrap();
2767 if !self.is_clonable(&ty_str) {
2768 is_clonable = false;
2770 tuple_args.push(ty_str);
2772 write_tuple_block(&mut created_container, &mangled_container, &tuple_args, is_clonable);
2774 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2776 } else if container_type == "Option" {
2777 let mut a_ty: Vec<u8> = Vec::new();
2778 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t), generics, is_ref) { return false; }
2779 let ty = String::from_utf8(a_ty).unwrap();
2780 let is_clonable = self.is_clonable(&ty);
2781 write_option_block(&mut created_container, &mangled_container, &ty, is_clonable);
2783 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2788 self.crate_types.write_new_template(mangled_container.clone(), true, &created_container);
2792 fn path_to_generic_args(path: &syn::Path) -> Vec<&syn::Type> {
2793 if let syn::PathArguments::AngleBracketed(args) = &path.segments.iter().next().unwrap().arguments {
2794 args.args.iter().map(|gen| if let syn::GenericArgument::Type(t) = gen { t } else { unimplemented!() }).collect()
2795 } else { unimplemented!(); }
2797 fn write_c_mangled_container_path_intern<W: std::io::Write>
2798 (&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 {
2799 let mut mangled_type: Vec<u8> = Vec::new();
2800 if !self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) {
2801 write!(w, "C{}_", ident).unwrap();
2802 write!(mangled_type, "C{}_", ident).unwrap();
2803 } else { assert_eq!(args.len(), 1); }
2804 for arg in args.iter() {
2805 macro_rules! write_path {
2806 ($p_arg: expr, $extra_write: expr) => {
2807 if let Some(subtype) = self.maybe_resolve_path(&$p_arg.path, generics) {
2808 if self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) {
2810 if self.c_type_has_inner_from_path(&subtype) {
2811 if !self.write_c_path_intern(w, &$p_arg.path, generics, is_ref, is_mut, ptr_for_ref, false, true) { return false; }
2813 if let Some(arr_ty) = self.is_real_type_array(&subtype) {
2814 if !self.write_c_type_intern(w, &arr_ty, generics, false, true, false, false, true) { return false; }
2816 // Option<T> needs to be converted to a *mut T, ie mut ptr-for-ref
2817 if !self.write_c_path_intern(w, &$p_arg.path, generics, true, true, true, false, true) { return false; }
2821 write!(w, "{}", $p_arg.path.segments.last().unwrap().ident).unwrap();
2823 } else if self.is_known_container(&subtype, is_ref) || self.is_path_transparent_container(&$p_arg.path, generics, is_ref) {
2824 if !self.write_c_mangled_container_path_intern(w, Self::path_to_generic_args(&$p_arg.path), generics,
2825 &subtype, is_ref, is_mut, ptr_for_ref, true) {
2828 self.write_c_mangled_container_path_intern(&mut mangled_type, Self::path_to_generic_args(&$p_arg.path),
2829 generics, &subtype, is_ref, is_mut, ptr_for_ref, true);
2830 if let Some(w2) = $extra_write as Option<&mut Vec<u8>> {
2831 self.write_c_mangled_container_path_intern(w2, Self::path_to_generic_args(&$p_arg.path),
2832 generics, &subtype, is_ref, is_mut, ptr_for_ref, true);
2835 let id = subtype.rsplitn(2, ':').next().unwrap(); // Get the "Base" name of the resolved type
2836 write!(w, "{}", id).unwrap();
2837 write!(mangled_type, "{}", id).unwrap();
2838 if let Some(w2) = $extra_write as Option<&mut Vec<u8>> {
2839 write!(w2, "{}", id).unwrap();
2842 } else { return false; }
2845 match generics.resolve_type(arg) {
2846 syn::Type::Tuple(tuple) => {
2847 if tuple.elems.len() == 0 {
2848 write!(w, "None").unwrap();
2849 write!(mangled_type, "None").unwrap();
2851 let mut mangled_tuple_type: Vec<u8> = Vec::new();
2853 // Figure out what the mangled type should look like. To disambiguate
2854 // ((A, B), C) and (A, B, C) we prefix the generic args with a _ and suffix
2855 // them with a Z. Ideally we wouldn't use Z, but not many special chars are
2856 // available for use in type names.
2857 write!(w, "C{}Tuple_", tuple.elems.len()).unwrap();
2858 write!(mangled_type, "C{}Tuple_", tuple.elems.len()).unwrap();
2859 write!(mangled_tuple_type, "C{}Tuple_", tuple.elems.len()).unwrap();
2860 for elem in tuple.elems.iter() {
2861 if let syn::Type::Path(p) = elem {
2862 write_path!(p, Some(&mut mangled_tuple_type));
2863 } else if let syn::Type::Reference(refelem) = elem {
2864 if let syn::Type::Path(p) = &*refelem.elem {
2865 write_path!(p, Some(&mut mangled_tuple_type));
2866 } else { return false; }
2867 } else if let syn::Type::Array(_) = elem {
2868 let mut resolved = Vec::new();
2869 if !self.write_c_type_intern(&mut resolved, &elem, generics, false, false, true, false, true) { return false; }
2870 let array_inner = String::from_utf8(resolved).unwrap();
2871 let arr_name = array_inner.split("::").last().unwrap();
2872 write!(w, "{}", arr_name).unwrap();
2873 write!(mangled_type, "{}", arr_name).unwrap();
2874 } else { return false; }
2876 write!(w, "Z").unwrap();
2877 write!(mangled_type, "Z").unwrap();
2878 write!(mangled_tuple_type, "Z").unwrap();
2879 if !self.check_create_container(String::from_utf8(mangled_tuple_type).unwrap(),
2880 &format!("{}Tuple", tuple.elems.len()), tuple.elems.iter().collect(), generics, is_ref) {
2885 syn::Type::Path(p_arg) => {
2886 write_path!(p_arg, None);
2888 syn::Type::Reference(refty) => {
2889 if let syn::Type::Path(p_arg) = &*refty.elem {
2890 write_path!(p_arg, None);
2891 } else if let syn::Type::Slice(_) = &*refty.elem {
2892 // write_c_type will actually do exactly what we want here, we just need to
2893 // make it a pointer so that its an option. Note that we cannot always convert
2894 // the Vec-as-slice (ie non-ref types) containers, so sometimes need to be able
2895 // to edit it, hence we use *mut here instead of *const.
2896 if args.len() != 1 { return false; }
2897 write!(w, "*mut ").unwrap();
2898 self.write_c_type(w, arg, None, true);
2899 } else { return false; }
2901 syn::Type::Array(a) => {
2902 if let syn::Type::Path(p_arg) = &*a.elem {
2903 let resolved = self.resolve_path(&p_arg.path, generics);
2904 if !self.is_primitive(&resolved) { return false; }
2905 if let syn::Expr::Lit(syn::ExprLit { lit: syn::Lit::Int(len), .. }) = &a.len {
2906 if self.c_type_from_path(&format!("[{}; {}]", resolved, len.base10_digits()), is_ref, ptr_for_ref).is_none() { return false; }
2907 if in_type || args.len() != 1 {
2908 write!(w, "_{}{}", resolved, len.base10_digits()).unwrap();
2909 write!(mangled_type, "_{}{}", resolved, len.base10_digits()).unwrap();
2911 let arrty = format!("[{}; {}]", resolved, len.base10_digits());
2912 let realty = self.c_type_from_path(&arrty, is_ref, ptr_for_ref).unwrap_or(&arrty);
2913 write!(w, "{}", realty).unwrap();
2914 write!(mangled_type, "{}", realty).unwrap();
2916 } else { return false; }
2917 } else { return false; }
2919 _ => { return false; },
2922 if self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) { return true; }
2923 // Push the "end of type" Z
2924 write!(w, "Z").unwrap();
2925 write!(mangled_type, "Z").unwrap();
2927 // Make sure the type is actually defined:
2928 self.check_create_container(String::from_utf8(mangled_type).unwrap(), ident, args, generics, is_ref)
2930 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 {
2931 if !self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) {
2932 write!(w, "{}::", Self::generated_container_path()).unwrap();
2934 self.write_c_mangled_container_path_intern(w, args, generics, ident, is_ref, is_mut, ptr_for_ref, false)
2936 pub fn get_c_mangled_container_type(&self, args: Vec<&syn::Type>, generics: Option<&GenericTypes>, template_name: &str) -> Option<String> {
2937 let mut out = Vec::new();
2938 if !self.write_c_mangled_container_path(&mut out, args, generics, template_name, false, false, false) {
2941 Some(String::from_utf8(out).unwrap())
2944 // **********************************
2945 // *** C Type Equivalent Printing ***
2946 // **********************************
2948 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 {
2949 let full_path = match self.maybe_resolve_path(&path, generics) {
2950 Some(path) => path, None => return false };
2951 if let Some(c_type) = self.c_type_from_path(&full_path, is_ref, ptr_for_ref) {
2952 write!(w, "{}", c_type).unwrap();
2954 } else if self.crate_types.traits.get(&full_path).is_some() {
2955 // Note that we always use the crate:: prefix here as we are always referring to a
2956 // concrete object which is of the generated type, it just implements the upstream
2958 if is_ref && ptr_for_ref {
2959 write!(w, "*{} crate::{}", if is_mut { "mut" } else { "const" }, full_path).unwrap();
2961 if with_ref_lifetime { unimplemented!(); }
2962 write!(w, "&{}crate::{}", if is_mut { "mut " } else { "" }, full_path).unwrap();
2964 write!(w, "crate::{}", full_path).unwrap();
2967 } else if self.crate_types.opaques.get(&full_path).is_some() || self.crate_types.mirrored_enums.get(&full_path).is_some() {
2968 let crate_pfx = if c_ty { "crate::" } else { "" };
2969 if is_ref && ptr_for_ref {
2970 // ptr_for_ref implies we're returning the object, which we can't really do for
2971 // opaque or mirrored types without box'ing them, which is quite a waste, so return
2972 // the actual object itself (for opaque types we'll set the pointer to the actual
2973 // type and note that its a reference).
2974 write!(w, "{}{}", crate_pfx, full_path).unwrap();
2975 } else if is_ref && with_ref_lifetime {
2977 // If we're concretizing something with a lifetime parameter, we have to pick a
2978 // lifetime, of which the only real available choice is `static`, obviously.
2979 write!(w, "&'static {}", crate_pfx).unwrap();
2981 self.write_rust_path(w, generics, path, with_ref_lifetime, false);
2983 // We shouldn't be mapping references in types, so panic here
2987 write!(w, "&{}{}{}", if is_mut { "mut " } else { "" }, crate_pfx, full_path).unwrap();
2989 write!(w, "{}{}", crate_pfx, full_path).unwrap();
2996 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 {
2997 match generics.resolve_type(t) {
2998 syn::Type::Path(p) => {
2999 if p.qself.is_some() {
3002 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
3003 if self.is_known_container(&full_path, is_ref) || self.is_path_transparent_container(&p.path, generics, is_ref) {
3004 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);
3006 if let Some(aliased_type) = self.crate_types.type_aliases.get(&full_path).cloned() {
3007 return self.write_c_type_intern(w, &aliased_type, None, is_ref, is_mut, ptr_for_ref, with_ref_lifetime, c_ty);
3010 self.write_c_path_intern(w, &p.path, generics, is_ref, is_mut, ptr_for_ref, with_ref_lifetime, c_ty)
3012 syn::Type::Reference(r) => {
3013 self.write_c_type_intern(w, &*r.elem, generics, true, r.mutability.is_some(), ptr_for_ref, with_ref_lifetime, c_ty)
3015 syn::Type::Array(a) => {
3016 if is_ref && is_mut {
3017 write!(w, "*mut [").unwrap();
3018 if !self.write_c_type_intern(w, &a.elem, generics, false, false, ptr_for_ref, with_ref_lifetime, c_ty) { return false; }
3020 write!(w, "*const [").unwrap();
3021 if !self.write_c_type_intern(w, &a.elem, generics, false, false, ptr_for_ref, with_ref_lifetime, c_ty) { return false; }
3023 if let syn::Expr::Lit(l) = &a.len {
3024 if let syn::Lit::Int(i) = &l.lit {
3025 let mut inner_ty = Vec::new();
3026 if !self.write_c_type_intern(&mut inner_ty, &*a.elem, generics, false, false, ptr_for_ref, false, c_ty) { return false; }
3027 let inner_ty_str = String::from_utf8(inner_ty).unwrap();
3029 if let Some(ty) = self.c_type_from_path(&format!("[{}; {}]", inner_ty_str, i.base10_digits()), false, ptr_for_ref) {
3030 write!(w, "{}", ty).unwrap();
3034 write!(w, "; {}]", i).unwrap();
3040 syn::Type::Slice(s) => {
3041 if !is_ref || is_mut { return false; }
3042 if let syn::Type::Path(p) = &*s.elem {
3043 let resolved = self.resolve_path(&p.path, generics);
3044 if self.is_primitive(&resolved) {
3045 write!(w, "{}::{}slice", Self::container_templ_path(), resolved).unwrap();
3048 let mut inner_c_ty = Vec::new();
3049 assert!(self.write_c_path_intern(&mut inner_c_ty, &p.path, generics, true, false, ptr_for_ref, with_ref_lifetime, c_ty));
3050 let inner_ty_str = String::from_utf8(inner_c_ty).unwrap();
3051 if self.is_clonable(&inner_ty_str) {
3052 let inner_ty_ident = inner_ty_str.rsplitn(2, "::").next().unwrap();
3053 let mangled_container = format!("CVec_{}Z", inner_ty_ident);
3054 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
3055 self.check_create_container(mangled_container, "Vec", vec![&*s.elem], generics, false)
3058 } else if let syn::Type::Reference(r) = &*s.elem {
3059 if let syn::Type::Path(p) = &*r.elem {
3060 // Slices with "real types" inside are mapped as the equivalent non-ref Vec
3061 let resolved = self.resolve_path(&p.path, generics);
3062 let mangled_container = if let Some((ident, _)) = self.crate_types.opaques.get(&resolved) {
3063 format!("CVec_{}Z", ident)
3064 } else if let Some(en) = self.crate_types.mirrored_enums.get(&resolved) {
3065 format!("CVec_{}Z", en.ident)
3066 } else if let Some(id) = p.path.get_ident() {
3067 format!("CVec_{}Z", id)
3068 } else { return false; };
3069 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
3070 self.check_create_container(mangled_container, "Vec", vec![&*r.elem], generics, false)
3071 } else if let syn::Type::Slice(sl2) = &*r.elem {
3072 if let syn::Type::Reference(r2) = &*sl2.elem {
3073 if let syn::Type::Path(p) = &*r2.elem {
3074 // Slices with slices with opaque types (with is_owned flags) are mapped as non-ref Vecs
3075 let resolved = self.resolve_path(&p.path, generics);
3076 let mangled_container = if let Some((ident, _)) = self.crate_types.opaques.get(&resolved) {
3077 format!("CVec_CVec_{}ZZ", ident)
3078 } else { return false; };
3079 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
3080 let inner = &r2.elem;
3081 let vec_ty: syn::Type = syn::parse_quote!(Vec<#inner>);
3082 self.check_create_container(mangled_container, "Vec", vec![&vec_ty], generics, false)
3086 } else if let syn::Type::Tuple(_) = &*s.elem {
3087 let mut args = syn::punctuated::Punctuated::<_, syn::token::Comma>::new();
3088 args.push(syn::GenericArgument::Type((*s.elem).clone()));
3089 let mut segments = syn::punctuated::Punctuated::new();
3090 segments.push(parse_quote!(Vec<#args>));
3091 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)
3092 } else if let syn::Type::Array(a) = &*s.elem {
3093 if let syn::Expr::Lit(l) = &a.len {
3094 if let syn::Lit::Int(i) = &l.lit {
3095 let mut buf = Vec::new();
3096 self.write_rust_type(&mut buf, generics, &*a.elem, false);
3097 let arr_ty = String::from_utf8(buf).unwrap();
3099 let arr_str = format!("[{}; {}]", arr_ty, i.base10_digits());
3100 let ty = self.c_type_from_path(&arr_str, false, ptr_for_ref).unwrap()
3101 .rsplitn(2, "::").next().unwrap();
3103 let mangled_container = format!("CVec_{}Z", ty);
3104 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
3105 self.check_create_container(mangled_container, "Vec", vec![&*s.elem], generics, false)
3110 syn::Type::Tuple(t) => {
3111 if t.elems.len() == 0 {
3114 self.write_c_mangled_container_path(w, t.elems.iter().collect(), generics,
3115 &format!("{}Tuple", t.elems.len()), is_ref, is_mut, ptr_for_ref)
3121 pub fn write_c_type<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, ptr_for_ref: bool) {
3122 assert!(self.write_c_type_intern(w, t, generics, false, false, ptr_for_ref, false, true));
3124 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) {
3125 assert!(self.write_c_type_intern(w, t, generics, false, false, ptr_for_ref, true, false));
3127 pub fn understood_c_path(&self, p: &syn::Path) -> bool {
3128 self.write_c_path_intern(&mut std::io::sink(), p, None, false, false, false, false, true)
3130 pub fn understood_c_type(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> bool {
3131 self.write_c_type_intern(&mut std::io::sink(), t, generics, false, false, false, false, true)