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)") {
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 dependencies: &'mod_lifetime HashSet<syn::Ident>,
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 process_use_intern(crate_name: &str, module_path: &str, dependencies: &HashSet<syn::Ident>, imports: &mut HashMap<syn::Ident, (String, syn::Path)>,
451 u: &syn::UseTree, partial_path: &str, mut path: syn::punctuated::Punctuated<syn::PathSegment, syn::token::Colon2>) {
454 macro_rules! push_path {
455 ($ident: expr, $path_suffix: expr) => {
456 if partial_path == "" && format!("{}", $ident) == "super" {
457 let mut mod_iter = module_path.rsplitn(2, "::");
458 mod_iter.next().unwrap();
459 let super_mod = mod_iter.next().unwrap();
460 new_path = format!("{}{}", super_mod, $path_suffix);
461 assert_eq!(path.len(), 0);
462 for module in super_mod.split("::") {
463 path.push(syn::PathSegment { ident: syn::Ident::new(module, Span::call_site()), arguments: syn::PathArguments::None });
465 } else if partial_path == "" && format!("{}", $ident) == "self" {
466 new_path = format!("{}{}", module_path, $path_suffix);
467 for module in module_path.split("::") {
468 path.push(syn::PathSegment { ident: syn::Ident::new(module, Span::call_site()), arguments: syn::PathArguments::None });
470 } else if partial_path == "" && format!("{}", $ident) == "crate" {
471 new_path = format!("{}{}", crate_name, $path_suffix);
472 let crate_name_ident = format_ident!("{}", crate_name);
473 path.push(parse_quote!(#crate_name_ident));
474 } else if partial_path == "" && !dependencies.contains(&$ident) {
475 new_path = format!("{}::{}{}", crate_name, $ident, $path_suffix);
476 let crate_name_ident = format_ident!("{}", crate_name);
477 path.push(parse_quote!(#crate_name_ident));
478 } else if format!("{}", $ident) == "self" {
479 let mut path_iter = partial_path.rsplitn(2, "::");
480 path_iter.next().unwrap();
481 new_path = path_iter.next().unwrap().to_owned();
483 new_path = format!("{}{}{}", partial_path, $ident, $path_suffix);
486 path.push(parse_quote!(#ident));
490 syn::UseTree::Path(p) => {
491 push_path!(p.ident, "::");
492 Self::process_use_intern(crate_name, module_path, dependencies, imports, &p.tree, &new_path, path);
494 syn::UseTree::Name(n) => {
495 push_path!(n.ident, "");
496 let imported_ident = syn::Ident::new(new_path.rsplitn(2, "::").next().unwrap(), Span::call_site());
497 imports.insert(imported_ident, (new_path, syn::Path { leading_colon: Some(syn::Token![::](Span::call_site())), segments: path }));
499 syn::UseTree::Group(g) => {
500 for i in g.items.iter() {
501 Self::process_use_intern(crate_name, module_path, dependencies, imports, i, partial_path, path.clone());
504 syn::UseTree::Rename(r) => {
505 push_path!(r.ident, "");
506 imports.insert(r.rename.clone(), (new_path, syn::Path { leading_colon: Some(syn::Token![::](Span::call_site())), segments: path }));
508 syn::UseTree::Glob(_) => {
509 eprintln!("Ignoring * use for {} - this may result in resolution failures", partial_path);
514 fn process_use(crate_name: &str, module_path: &str, dependencies: &HashSet<syn::Ident>, imports: &mut HashMap<syn::Ident, (String, syn::Path)>, u: &syn::ItemUse) {
515 if let syn::Visibility::Public(_) = u.vis {
516 // We actually only use these for #[cfg(fuzztarget)]
517 eprintln!("Ignoring pub(use) tree!");
520 if u.leading_colon.is_some() { eprintln!("Ignoring leading-colon use!"); return; }
521 Self::process_use_intern(crate_name, module_path, dependencies, imports, &u.tree, "", syn::punctuated::Punctuated::new());
524 fn insert_primitive(imports: &mut HashMap<syn::Ident, (String, syn::Path)>, id: &str) {
525 let ident = format_ident!("{}", id);
526 let path = parse_quote!(#ident);
527 imports.insert(ident, (id.to_owned(), path));
530 pub fn new(crate_name: &'mod_lifetime str, dependencies: &'mod_lifetime HashSet<syn::Ident>, module_path: &'mod_lifetime str, contents: &'crate_lft [syn::Item]) -> Self {
531 Self::from_borrowed_items(crate_name, dependencies, module_path, &contents.iter().map(|a| a).collect::<Vec<_>>())
533 pub fn from_borrowed_items(crate_name: &'mod_lifetime str, dependencies: &'mod_lifetime HashSet<syn::Ident>, module_path: &'mod_lifetime str, contents: &[&'crate_lft syn::Item]) -> Self {
534 let mut imports = HashMap::new();
535 // Add primitives to the "imports" list:
536 Self::insert_primitive(&mut imports, "bool");
537 Self::insert_primitive(&mut imports, "u64");
538 Self::insert_primitive(&mut imports, "u32");
539 Self::insert_primitive(&mut imports, "u16");
540 Self::insert_primitive(&mut imports, "u8");
541 Self::insert_primitive(&mut imports, "usize");
542 Self::insert_primitive(&mut imports, "str");
543 Self::insert_primitive(&mut imports, "String");
545 // These are here to allow us to print native Rust types in trait fn impls even if we don't
547 Self::insert_primitive(&mut imports, "Result");
548 Self::insert_primitive(&mut imports, "Vec");
549 Self::insert_primitive(&mut imports, "Option");
551 let mut declared = HashMap::new();
552 let mut priv_modules = HashSet::new();
554 for item in contents.iter() {
556 syn::Item::Use(u) => Self::process_use(crate_name, module_path, dependencies, &mut imports, &u),
557 syn::Item::Struct(s) => {
558 if let syn::Visibility::Public(_) = s.vis {
559 match export_status(&s.attrs) {
560 ExportStatus::Export => { declared.insert(s.ident.clone(), DeclType::StructImported { generics: &s.generics }); },
561 ExportStatus::NoExport => { declared.insert(s.ident.clone(), DeclType::StructIgnored); },
562 ExportStatus::TestOnly => continue,
563 ExportStatus::NotImplementable => panic!("(C-not implementable) should only appear on traits!"),
567 syn::Item::Type(t) if export_status(&t.attrs) == ExportStatus::Export => {
568 if let syn::Visibility::Public(_) = t.vis {
569 declared.insert(t.ident.clone(), DeclType::StructImported { generics: &t.generics });
572 syn::Item::Enum(e) => {
573 if let syn::Visibility::Public(_) = e.vis {
574 match export_status(&e.attrs) {
575 ExportStatus::Export if is_enum_opaque(e) => { declared.insert(e.ident.clone(), DeclType::EnumIgnored { generics: &e.generics }); },
576 ExportStatus::Export => { declared.insert(e.ident.clone(), DeclType::MirroredEnum); },
577 ExportStatus::NotImplementable => panic!("(C-not implementable) should only appear on traits!"),
582 syn::Item::Trait(t) => {
583 match export_status(&t.attrs) {
584 ExportStatus::Export|ExportStatus::NotImplementable => {
585 if let syn::Visibility::Public(_) = t.vis {
586 declared.insert(t.ident.clone(), DeclType::Trait(t));
592 syn::Item::Mod(m) => {
593 priv_modules.insert(m.ident.clone());
599 Self { crate_name, dependencies, module_path, imports, declared, priv_modules }
602 pub fn maybe_resolve_declared(&self, id: &syn::Ident) -> Option<&DeclType<'crate_lft>> {
603 self.declared.get(id)
606 pub fn maybe_resolve_ident(&self, id: &syn::Ident) -> Option<String> {
607 if let Some((imp, _)) = self.imports.get(id) {
609 } else if self.declared.get(id).is_some() {
610 Some(self.module_path.to_string() + "::" + &format!("{}", id))
614 pub fn maybe_resolve_path(&self, p: &syn::Path, generics: Option<&GenericTypes>) -> Option<String> {
615 if let Some(gen_types) = generics {
616 if let Some(resp) = gen_types.maybe_resolve_path(p) {
617 return Some(resp.clone());
621 if p.leading_colon.is_some() {
622 let mut res: String = p.segments.iter().enumerate().map(|(idx, seg)| {
623 format!("{}{}", if idx == 0 { "" } else { "::" }, seg.ident)
625 let firstseg = p.segments.iter().next().unwrap();
626 if !self.dependencies.contains(&firstseg.ident) {
627 res = self.crate_name.to_owned() + "::" + &res;
630 } else if let Some(id) = p.get_ident() {
631 self.maybe_resolve_ident(id)
633 if p.segments.len() == 1 {
634 let seg = p.segments.iter().next().unwrap();
635 return self.maybe_resolve_ident(&seg.ident);
637 let mut seg_iter = p.segments.iter();
638 let first_seg = seg_iter.next().unwrap();
639 let remaining: String = seg_iter.map(|seg| {
640 format!("::{}", seg.ident)
642 let first_seg_str = format!("{}", first_seg.ident);
643 if let Some((imp, _)) = self.imports.get(&first_seg.ident) {
645 Some(imp.clone() + &remaining)
649 } else if let Some(_) = self.priv_modules.get(&first_seg.ident) {
650 Some(format!("{}::{}{}", self.module_path, first_seg.ident, remaining))
651 } else if first_seg_is_stdlib(&first_seg_str) || self.dependencies.contains(&first_seg.ident) {
652 Some(first_seg_str + &remaining)
657 /// Map all the Paths in a Type into absolute paths given a set of imports (generated via process_use_intern)
658 pub fn resolve_imported_refs(&self, mut ty: syn::Type) -> syn::Type {
660 syn::Type::Path(p) => {
661 if p.path.segments.len() != 1 { unimplemented!(); }
662 let mut args = p.path.segments[0].arguments.clone();
663 if let syn::PathArguments::AngleBracketed(ref mut generics) = &mut args {
664 for arg in generics.args.iter_mut() {
665 if let syn::GenericArgument::Type(ref mut t) = arg {
666 *t = self.resolve_imported_refs(t.clone());
670 if let Some((_, newpath)) = self.imports.get(single_ident_generic_path_to_ident(&p.path).unwrap()) {
671 p.path = newpath.clone();
673 p.path.segments[0].arguments = args;
675 syn::Type::Reference(r) => {
676 r.elem = Box::new(self.resolve_imported_refs((*r.elem).clone()));
678 syn::Type::Slice(s) => {
679 s.elem = Box::new(self.resolve_imported_refs((*s.elem).clone()));
681 syn::Type::Tuple(t) => {
682 for e in t.elems.iter_mut() {
683 *e = self.resolve_imported_refs(e.clone());
686 _ => unimplemented!(),
692 // templates_defined is walked to write the C++ header, so if we use the default hashing it get
693 // reordered on each genbindings run. Instead, we use SipHasher (which defaults to 0-keys) so that
694 // the sorting is stable across runs. It is deprecated, but the "replacement" doesn't actually
695 // accomplish the same goals, so we just ignore it.
697 pub type NonRandomHash = hash::BuildHasherDefault<hash::SipHasher>;
700 pub struct ASTModule {
701 pub attrs: Vec<syn::Attribute>,
702 pub items: Vec<syn::Item>,
703 pub submods: Vec<String>,
705 /// A struct containing the syn::File AST for each file in the crate.
706 pub struct FullLibraryAST {
707 pub modules: HashMap<String, ASTModule, NonRandomHash>,
708 pub dependencies: HashSet<syn::Ident>,
710 impl FullLibraryAST {
711 fn load_module(&mut self, module: String, attrs: Vec<syn::Attribute>, mut items: Vec<syn::Item>) {
712 let mut non_mod_items = Vec::with_capacity(items.len());
713 let mut submods = Vec::with_capacity(items.len());
714 for item in items.drain(..) {
716 syn::Item::Mod(m) if m.content.is_some() => {
717 if export_status(&m.attrs) == ExportStatus::Export {
718 if let syn::Visibility::Public(_) = m.vis {
719 let modident = format!("{}", m.ident);
720 let modname = if module != "" {
721 module.clone() + "::" + &modident
723 self.dependencies.insert(m.ident);
726 self.load_module(modname, m.attrs, m.content.unwrap().1);
727 submods.push(modident);
729 non_mod_items.push(syn::Item::Mod(m));
733 syn::Item::Mod(_) => panic!("--pretty=expanded output should never have non-body modules"),
734 syn::Item::ExternCrate(c) => {
735 if export_status(&c.attrs) == ExportStatus::Export {
736 self.dependencies.insert(c.ident);
739 _ => { non_mod_items.push(item); }
742 self.modules.insert(module, ASTModule { attrs, items: non_mod_items, submods });
745 pub fn load_lib(lib: syn::File) -> Self {
746 assert_eq!(export_status(&lib.attrs), ExportStatus::Export);
747 let mut res = Self { modules: HashMap::default(), dependencies: HashSet::new() };
748 res.load_module("".to_owned(), lib.attrs, lib.items);
753 /// List of manually-generated types which are clonable
754 fn initial_clonable_types() -> HashSet<String> {
755 let mut res = HashSet::new();
756 res.insert("crate::c_types::u5".to_owned());
757 res.insert("crate::c_types::FourBytes".to_owned());
758 res.insert("crate::c_types::TwelveBytes".to_owned());
759 res.insert("crate::c_types::SixteenBytes".to_owned());
760 res.insert("crate::c_types::TwentyBytes".to_owned());
761 res.insert("crate::c_types::ThirtyTwoBytes".to_owned());
762 res.insert("crate::c_types::SecretKey".to_owned());
763 res.insert("crate::c_types::PublicKey".to_owned());
764 res.insert("crate::c_types::Transaction".to_owned());
765 res.insert("crate::c_types::TxOut".to_owned());
766 res.insert("crate::c_types::Signature".to_owned());
767 res.insert("crate::c_types::RecoverableSignature".to_owned());
768 res.insert("crate::c_types::Bech32Error".to_owned());
769 res.insert("crate::c_types::Secp256k1Error".to_owned());
770 res.insert("crate::c_types::IOError".to_owned());
771 res.insert("crate::c_types::Error".to_owned());
772 res.insert("crate::c_types::Str".to_owned());
774 // Because some types are manually-mapped to CVec_u8Z we may end up checking if its clonable
775 // before we ever get to constructing the type fully via
776 // `write_c_mangled_container_path_intern` (which will add it here too), so we have to manually
777 // add it on startup.
778 res.insert("crate::c_types::derived::CVec_u8Z".to_owned());
782 /// Top-level struct tracking everything which has been defined while walking the crate.
783 pub struct CrateTypes<'a> {
784 /// This may contain structs or enums, but only when either is mapped as
785 /// struct X { inner: *mut originalX, .. }
786 pub opaques: HashMap<String, (&'a syn::Ident, &'a syn::Generics)>,
787 /// structs that weren't exposed
788 pub priv_structs: HashMap<String, &'a syn::Generics>,
789 /// Enums which are mapped as C enums with conversion functions
790 pub mirrored_enums: HashMap<String, &'a syn::ItemEnum>,
791 /// Traits which are mapped as a pointer + jump table
792 pub traits: HashMap<String, &'a syn::ItemTrait>,
793 /// Aliases from paths to some other Type
794 pub type_aliases: HashMap<String, syn::Type>,
795 /// Value is an alias to Key (maybe with some generics)
796 pub reverse_alias_map: HashMap<String, Vec<(String, syn::PathArguments)>>,
797 /// Template continer types defined, map from mangled type name -> whether a destructor fn
800 /// This is used at the end of processing to make C++ wrapper classes
801 pub templates_defined: RefCell<HashMap<String, bool, NonRandomHash>>,
802 /// The output file for any created template container types, written to as we find new
803 /// template containers which need to be defined.
804 template_file: RefCell<&'a mut File>,
805 /// Set of containers which are clonable
806 clonable_types: RefCell<HashSet<String>>,
808 pub trait_impls: HashMap<String, Vec<String>>,
809 /// The full set of modules in the crate(s)
810 pub lib_ast: &'a FullLibraryAST,
813 impl<'a> CrateTypes<'a> {
814 pub fn new(template_file: &'a mut File, libast: &'a FullLibraryAST) -> Self {
816 opaques: HashMap::new(), mirrored_enums: HashMap::new(), traits: HashMap::new(),
817 type_aliases: HashMap::new(), reverse_alias_map: HashMap::new(),
818 templates_defined: RefCell::new(HashMap::default()), priv_structs: HashMap::new(),
819 clonable_types: RefCell::new(initial_clonable_types()), trait_impls: HashMap::new(),
820 template_file: RefCell::new(template_file), lib_ast: &libast,
823 pub fn set_clonable(&self, object: String) {
824 self.clonable_types.borrow_mut().insert(object);
826 pub fn is_clonable(&self, object: &str) -> bool {
827 self.clonable_types.borrow().contains(object)
829 pub fn write_new_template(&self, mangled_container: String, has_destructor: bool, created_container: &[u8]) {
830 self.template_file.borrow_mut().write(created_container).unwrap();
831 self.templates_defined.borrow_mut().insert(mangled_container, has_destructor);
835 /// A struct which tracks resolving rust types into C-mapped equivalents, exists for one specific
836 /// module but contains a reference to the overall CrateTypes tracking.
837 pub struct TypeResolver<'mod_lifetime, 'crate_lft: 'mod_lifetime> {
838 pub module_path: &'mod_lifetime str,
839 pub crate_types: &'mod_lifetime CrateTypes<'crate_lft>,
840 pub types: ImportResolver<'mod_lifetime, 'crate_lft>,
843 /// Returned by write_empty_rust_val_check_suffix to indicate what type of dereferencing needs to
844 /// happen to get the inner value of a generic.
845 enum EmptyValExpectedTy {
846 /// A type which has a flag for being empty (eg an array where we treat all-0s as empty).
848 /// A Option mapped as a COption_*Z
850 /// A pointer which we want to convert to a reference.
855 /// Describes the appropriate place to print a general type-conversion string when converting a
857 enum ContainerPrefixLocation {
858 /// Prints a general type-conversion string prefix and suffix outside of the
859 /// container-conversion strings.
861 /// Prints a general type-conversion string prefix and suffix inside of the
862 /// container-conversion strings.
864 /// Does not print the usual type-conversion string prefix and suffix.
868 impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
869 pub fn new(module_path: &'a str, types: ImportResolver<'a, 'c>, crate_types: &'a CrateTypes<'c>) -> Self {
870 Self { module_path, types, crate_types }
873 // *************************************************
874 // *** Well know type and conversion definitions ***
875 // *************************************************
877 /// Returns true we if can just skip passing this to C entirely
878 pub fn skip_path(&self, full_path: &str) -> bool {
879 full_path == "bitcoin::secp256k1::Secp256k1" ||
880 full_path == "bitcoin::secp256k1::Signing" ||
881 full_path == "bitcoin::secp256k1::Verification"
883 /// Returns true we if can just skip passing this to C entirely
884 fn no_arg_path_to_rust(&self, full_path: &str) -> &str {
885 if full_path == "bitcoin::secp256k1::Secp256k1" {
886 "secp256k1::global::SECP256K1"
887 } else { unimplemented!(); }
890 /// Returns true if the object is a primitive and is mapped as-is with no conversion
892 pub fn is_primitive(&self, full_path: &str) -> bool {
903 pub fn is_clonable(&self, ty: &str) -> bool {
904 if self.crate_types.is_clonable(ty) { return true; }
905 if self.is_primitive(ty) { return true; }
911 /// Gets the C-mapped type for types which are outside of the crate, or which are manually
912 /// ignored by for some reason need mapping anyway.
913 fn c_type_from_path<'b>(&self, full_path: &'b str, is_ref: bool, _ptr_for_ref: bool) -> Option<&'b str> {
914 if self.is_primitive(full_path) {
915 return Some(full_path);
918 // Note that no !is_ref types can map to an array because Rust and C's call semantics
919 // for arrays are different (https://github.com/eqrion/cbindgen/issues/528)
921 "[u8; 32]" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
922 "[u8; 20]" if !is_ref => Some("crate::c_types::TwentyBytes"),
923 "[u8; 16]" if !is_ref => Some("crate::c_types::SixteenBytes"),
924 "[u8; 12]" if !is_ref => Some("crate::c_types::TwelveBytes"),
925 "[u8; 4]" if !is_ref => Some("crate::c_types::FourBytes"),
926 "[u8; 3]" if !is_ref => Some("crate::c_types::ThreeBytes"), // Used for RGB values
928 "str" if is_ref => Some("crate::c_types::Str"),
929 "alloc::string::String"|"String" => Some("crate::c_types::Str"),
931 "std::time::Duration"|"core::time::Duration" => Some("u64"),
932 "std::time::SystemTime" => Some("u64"),
933 "std::io::Error"|"lightning::io::Error" => Some("crate::c_types::IOError"),
934 "core::fmt::Arguments" if is_ref => Some("crate::c_types::Str"),
936 "core::convert::Infallible" => Some("crate::c_types::NotConstructable"),
938 "bitcoin::bech32::Error"|"bech32::Error"
939 if !is_ref => Some("crate::c_types::Bech32Error"),
940 "bitcoin::secp256k1::Error"|"secp256k1::Error"
941 if !is_ref => Some("crate::c_types::Secp256k1Error"),
943 "core::num::ParseIntError" => Some("crate::c_types::Error"),
944 "core::str::Utf8Error" => Some("crate::c_types::Error"),
946 "bitcoin::bech32::u5"|"bech32::u5" => Some("crate::c_types::u5"),
947 "core::num::NonZeroU8" => Some("u8"),
949 "secp256k1::PublicKey"|"bitcoin::secp256k1::PublicKey" => Some("crate::c_types::PublicKey"),
950 "bitcoin::secp256k1::ecdsa::Signature" => Some("crate::c_types::Signature"),
951 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some("crate::c_types::RecoverableSignature"),
952 "bitcoin::secp256k1::SecretKey" if is_ref => Some("*const [u8; 32]"),
953 "bitcoin::secp256k1::SecretKey" if !is_ref => Some("crate::c_types::SecretKey"),
954 "bitcoin::secp256k1::Scalar" if is_ref => Some("*const crate::c_types::BigEndianScalar"),
955 "bitcoin::secp256k1::Scalar" if !is_ref => Some("crate::c_types::BigEndianScalar"),
956 "bitcoin::secp256k1::ecdh::SharedSecret" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
958 "bitcoin::blockdata::script::Script" if is_ref => Some("crate::c_types::u8slice"),
959 "bitcoin::blockdata::script::Script" if !is_ref => Some("crate::c_types::derived::CVec_u8Z"),
960 "bitcoin::blockdata::transaction::OutPoint" => Some("crate::lightning::chain::transaction::OutPoint"),
961 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some("crate::c_types::Transaction"),
962 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some("crate::c_types::TxOut"),
963 "bitcoin::network::constants::Network" => Some("crate::bitcoin::network::Network"),
964 "bitcoin::util::address::WitnessVersion" => Some("crate::c_types::WitnessVersion"),
965 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some("*const [u8; 80]"),
966 "bitcoin::blockdata::block::Block" if is_ref => Some("crate::c_types::u8slice"),
968 "bitcoin::hash_types::PubkeyHash"|"bitcoin::hash_types::WPubkeyHash"|"bitcoin::hash_types::ScriptHash"
969 if is_ref => Some("*const [u8; 20]"),
970 "bitcoin::hash_types::WScriptHash"
971 if is_ref => Some("*const [u8; 32]"),
973 // Newtypes that we just expose in their original form.
974 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
975 if is_ref => Some("*const [u8; 32]"),
976 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
977 if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
978 "bitcoin::secp256k1::Message" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
979 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
980 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
981 if is_ref => Some("*const [u8; 32]"),
982 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
983 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
984 if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
986 "lightning::io::Read" => Some("crate::c_types::u8slice"),
992 fn from_c_conversion_new_var_from_path<'b>(&self, _full_path: &str, _is_ref: bool) -> Option<(&'b str, &'b str)> {
995 fn from_c_conversion_prefix_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<String> {
996 if self.is_primitive(full_path) {
997 return Some("".to_owned());
1000 "Vec" if !is_ref => Some("local_"),
1001 "Result" if !is_ref => Some("local_"),
1002 "Option" if is_ref => Some("&local_"),
1003 "Option" => Some("local_"),
1005 "[u8; 32]" if is_ref => Some("unsafe { &*"),
1006 "[u8; 32]" if !is_ref => Some(""),
1007 "[u8; 20]" if !is_ref => Some(""),
1008 "[u8; 16]" if !is_ref => Some(""),
1009 "[u8; 12]" if !is_ref => Some(""),
1010 "[u8; 4]" if !is_ref => Some(""),
1011 "[u8; 3]" if !is_ref => Some(""),
1013 "[u8]" if is_ref => Some(""),
1014 "[usize]" if is_ref => Some(""),
1016 "str" if is_ref => Some(""),
1017 "alloc::string::String"|"String" => Some(""),
1018 "std::io::Error"|"lightning::io::Error" => Some(""),
1019 // Note that we'll panic for String if is_ref, as we only have non-owned memory, we
1020 // cannot create a &String.
1022 "core::convert::Infallible" => Some("panic!(\"You must never construct a NotConstructable! : "),
1024 "bitcoin::bech32::Error"|"bech32::Error" if !is_ref => Some(""),
1025 "bitcoin::secp256k1::Error"|"secp256k1::Error" if !is_ref => Some(""),
1027 "core::num::ParseIntError" => Some("u8::from_str_radix(\" a\", 10).unwrap_err() /*"),
1028 "core::str::Utf8Error" => Some("core::str::from_utf8(&[0xff]).unwrap_err() /*"),
1030 "std::time::Duration"|"core::time::Duration" => Some("core::time::Duration::from_secs("),
1031 "std::time::SystemTime" => Some("(::std::time::SystemTime::UNIX_EPOCH + std::time::Duration::from_secs("),
1033 "bitcoin::bech32::u5"|"bech32::u5" => Some(""),
1034 "core::num::NonZeroU8" => Some("core::num::NonZeroU8::new("),
1036 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" if is_ref => Some("&"),
1037 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" => Some(""),
1038 "bitcoin::secp256k1::ecdsa::Signature" if is_ref => Some("&"),
1039 "bitcoin::secp256k1::ecdsa::Signature" => Some(""),
1040 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some(""),
1041 "bitcoin::secp256k1::SecretKey" if is_ref => Some("&::bitcoin::secp256k1::SecretKey::from_slice(&unsafe { *"),
1042 "bitcoin::secp256k1::SecretKey" if !is_ref => Some(""),
1043 "bitcoin::secp256k1::Scalar" if !is_ref => Some(""),
1044 "bitcoin::secp256k1::ecdh::SharedSecret" if !is_ref => Some("::bitcoin::secp256k1::ecdh::SharedSecret::from_bytes("),
1046 "bitcoin::blockdata::script::Script" if is_ref => Some("&::bitcoin::blockdata::script::Script::from(Vec::from("),
1047 "bitcoin::blockdata::script::Script" if !is_ref => Some("::bitcoin::blockdata::script::Script::from("),
1048 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" if is_ref => Some("&"),
1049 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(""),
1050 "bitcoin::blockdata::transaction::OutPoint" => Some("crate::c_types::C_to_bitcoin_outpoint("),
1051 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(""),
1052 "bitcoin::network::constants::Network" => Some(""),
1053 "bitcoin::util::address::WitnessVersion" => Some(""),
1054 "bitcoin::blockdata::block::BlockHeader" => Some("&::bitcoin::consensus::encode::deserialize(unsafe { &*"),
1055 "bitcoin::blockdata::block::Block" if is_ref => Some("&::bitcoin::consensus::encode::deserialize("),
1057 "bitcoin::hash_types::PubkeyHash" if is_ref =>
1058 Some("&bitcoin::hash_types::PubkeyHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
1059 "bitcoin::hash_types::WPubkeyHash" if is_ref =>
1060 Some("&bitcoin::hash_types::WPubkeyHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
1061 "bitcoin::hash_types::ScriptHash" if is_ref =>
1062 Some("&bitcoin::hash_types::ScriptHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
1063 "bitcoin::hash_types::WScriptHash" if is_ref =>
1064 Some("&bitcoin::hash_types::WScriptHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
1066 // Newtypes that we just expose in their original form.
1067 "bitcoin::hash_types::Txid" if is_ref => Some("&::bitcoin::hash_types::Txid::from_slice(&unsafe { &*"),
1068 "bitcoin::hash_types::Txid" if !is_ref => Some("::bitcoin::hash_types::Txid::from_slice(&"),
1069 "bitcoin::hash_types::BlockHash" => Some("::bitcoin::hash_types::BlockHash::from_slice(&"),
1070 "lightning::ln::PaymentHash" if !is_ref => Some("::lightning::ln::PaymentHash("),
1071 "lightning::ln::PaymentHash" if is_ref => Some("&::lightning::ln::PaymentHash(unsafe { *"),
1072 "lightning::ln::PaymentPreimage" if !is_ref => Some("::lightning::ln::PaymentPreimage("),
1073 "lightning::ln::PaymentPreimage" if is_ref => Some("&::lightning::ln::PaymentPreimage(unsafe { *"),
1074 "lightning::ln::PaymentSecret" if !is_ref => Some("::lightning::ln::PaymentSecret("),
1075 "lightning::ln::channelmanager::PaymentId" if !is_ref => Some("::lightning::ln::channelmanager::PaymentId("),
1076 "lightning::ln::channelmanager::PaymentId" if is_ref=> Some("&::lightning::ln::channelmanager::PaymentId( unsafe { *"),
1077 "lightning::chain::keysinterface::KeyMaterial" if !is_ref => Some("::lightning::chain::keysinterface::KeyMaterial("),
1078 "lightning::chain::keysinterface::KeyMaterial" if is_ref=> Some("&::lightning::chain::keysinterface::KeyMaterial( unsafe { *"),
1080 // List of traits we map (possibly during processing of other files):
1081 "lightning::io::Read" => Some("&mut "),
1084 }.map(|s| s.to_owned())
1086 fn from_c_conversion_suffix_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<String> {
1087 if self.is_primitive(full_path) {
1088 return Some("".to_owned());
1091 "Vec" if !is_ref => Some(""),
1092 "Option" => Some(""),
1093 "Result" if !is_ref => Some(""),
1095 "[u8; 32]" if is_ref => Some("}"),
1096 "[u8; 32]" if !is_ref => Some(".data"),
1097 "[u8; 20]" if !is_ref => Some(".data"),
1098 "[u8; 16]" if !is_ref => Some(".data"),
1099 "[u8; 12]" if !is_ref => Some(".data"),
1100 "[u8; 4]" if !is_ref => Some(".data"),
1101 "[u8; 3]" if !is_ref => Some(".data"),
1103 "[u8]" if is_ref => Some(".to_slice()"),
1104 "[usize]" if is_ref => Some(".to_slice()"),
1106 "str" if is_ref => Some(".into_str()"),
1107 "alloc::string::String"|"String" => Some(".into_string()"),
1108 "std::io::Error"|"lightning::io::Error" => Some(".to_rust()"),
1110 "core::convert::Infallible" => Some("\")"),
1112 "bitcoin::bech32::Error"|"bech32::Error" if !is_ref => Some(".into_rust()"),
1113 "bitcoin::secp256k1::Error"|"secp256k1::Error" if !is_ref => Some(".into_rust()"),
1115 "core::num::ParseIntError" => Some("*/"),
1116 "core::str::Utf8Error" => Some("*/"),
1118 "std::time::Duration"|"core::time::Duration" => Some(")"),
1119 "std::time::SystemTime" => Some("))"),
1121 "bitcoin::bech32::u5"|"bech32::u5" => Some(".into()"),
1122 "core::num::NonZeroU8" => Some(").expect(\"Value must be non-zero\")"),
1124 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" => Some(".into_rust()"),
1125 "bitcoin::secp256k1::ecdsa::Signature" => Some(".into_rust()"),
1126 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some(".into_rust()"),
1127 "bitcoin::secp256k1::SecretKey" if !is_ref => Some(".into_rust()"),
1128 "bitcoin::secp256k1::SecretKey" if is_ref => Some("}[..]).unwrap()"),
1129 "bitcoin::secp256k1::Scalar" if !is_ref => Some(".into_rust()"),
1130 "bitcoin::secp256k1::ecdh::SharedSecret" if !is_ref => Some(".data)"),
1132 "bitcoin::blockdata::script::Script" if is_ref => Some(".to_slice()))"),
1133 "bitcoin::blockdata::script::Script" if !is_ref => Some(".into_rust())"),
1134 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(".into_bitcoin()"),
1135 "bitcoin::blockdata::transaction::OutPoint" => Some(")"),
1136 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(".into_rust()"),
1137 "bitcoin::network::constants::Network" => Some(".into_bitcoin()"),
1138 "bitcoin::util::address::WitnessVersion" => Some(".into()"),
1139 "bitcoin::blockdata::block::BlockHeader" => Some(" }).unwrap()"),
1140 "bitcoin::blockdata::block::Block" => Some(".to_slice()).unwrap()"),
1142 "bitcoin::hash_types::PubkeyHash"|"bitcoin::hash_types::WPubkeyHash"|
1143 "bitcoin::hash_types::ScriptHash"|"bitcoin::hash_types::WScriptHash"
1144 if is_ref => Some(" }.clone()))"),
1146 // Newtypes that we just expose in their original form.
1147 "bitcoin::hash_types::Txid" if is_ref => Some(" }[..]).unwrap()"),
1148 "bitcoin::hash_types::Txid" => Some(".data[..]).unwrap()"),
1149 "bitcoin::hash_types::BlockHash" if !is_ref => Some(".data[..]).unwrap()"),
1150 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1151 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1152 if !is_ref => Some(".data)"),
1153 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1154 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1155 if is_ref => Some(" })"),
1157 // List of traits we map (possibly during processing of other files):
1158 "lightning::io::Read" => Some(".to_reader()"),
1161 }.map(|s| s.to_owned())
1164 fn to_c_conversion_new_var_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<(&'b str, &'b str)> {
1165 if self.is_primitive(full_path) {
1169 "[u8]" if is_ref => Some(("crate::c_types::u8slice::from_slice(", ")")),
1170 "[usize]" if is_ref => Some(("crate::c_types::usizeslice::from_slice(", ")")),
1172 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some(("{ let mut s = [0u8; 80]; s[..].copy_from_slice(&::bitcoin::consensus::encode::serialize(", ")); s }")),
1173 "bitcoin::blockdata::block::Block" if is_ref => Some(("::bitcoin::consensus::encode::serialize(", ")")),
1174 "bitcoin::hash_types::Txid" => None,
1177 }.map(|s| s.to_owned())
1179 fn to_c_conversion_inline_prefix_from_path(&self, full_path: &str, is_ref: bool, _ptr_for_ref: bool) -> Option<String> {
1180 if self.is_primitive(full_path) {
1181 return Some("".to_owned());
1184 "Result" if !is_ref => Some("local_"),
1185 "Vec" if !is_ref => Some("local_"),
1186 "Option" => Some("local_"),
1188 "[u8; 32]" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1189 "[u8; 32]" if is_ref => Some(""),
1190 "[u8; 20]" if !is_ref => Some("crate::c_types::TwentyBytes { data: "),
1191 "[u8; 16]" if !is_ref => Some("crate::c_types::SixteenBytes { data: "),
1192 "[u8; 12]" if !is_ref => Some("crate::c_types::TwelveBytes { data: "),
1193 "[u8; 4]" if !is_ref => Some("crate::c_types::FourBytes { data: "),
1194 "[u8; 3]" if is_ref => Some(""),
1196 "[u8]" if is_ref => Some("local_"),
1197 "[usize]" if is_ref => Some("local_"),
1199 "str" if is_ref => Some(""),
1200 "alloc::string::String"|"String" => Some(""),
1202 "std::time::Duration"|"core::time::Duration" => Some(""),
1203 "std::time::SystemTime" => Some(""),
1204 "std::io::Error"|"lightning::io::Error" => Some("crate::c_types::IOError::from_rust("),
1205 "core::fmt::Arguments" => Some("alloc::format!(\"{}\", "),
1207 "core::convert::Infallible" => Some("panic!(\"Cannot construct an Infallible: "),
1209 "bitcoin::bech32::Error"|"bech32::Error"
1210 if !is_ref => Some("crate::c_types::Bech32Error::from_rust("),
1211 "bitcoin::secp256k1::Error"|"secp256k1::Error"
1212 if !is_ref => Some("crate::c_types::Secp256k1Error::from_rust("),
1214 "core::num::ParseIntError" => Some("crate::c_types::Error { _dummy: 0 } /*"),
1215 "core::str::Utf8Error" => Some("crate::c_types::Error { _dummy: 0 } /*"),
1217 "bitcoin::bech32::u5"|"bech32::u5" => Some(""),
1219 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" => Some("crate::c_types::PublicKey::from_rust(&"),
1220 "bitcoin::secp256k1::ecdsa::Signature" => Some("crate::c_types::Signature::from_rust(&"),
1221 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some("crate::c_types::RecoverableSignature::from_rust(&"),
1222 "bitcoin::secp256k1::SecretKey" if is_ref => Some(""),
1223 "bitcoin::secp256k1::SecretKey" if !is_ref => Some("crate::c_types::SecretKey::from_rust("),
1224 "bitcoin::secp256k1::Scalar" if !is_ref => Some("crate::c_types::BigEndianScalar::from_rust("),
1225 "bitcoin::secp256k1::ecdh::SharedSecret" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1227 "bitcoin::blockdata::script::Script" if is_ref => Some("crate::c_types::u8slice::from_slice(&"),
1228 "bitcoin::blockdata::script::Script" if !is_ref => Some(""),
1229 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" if is_ref => Some("crate::c_types::Transaction::from_bitcoin("),
1230 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some("crate::c_types::Transaction::from_bitcoin(&"),
1231 "bitcoin::blockdata::transaction::OutPoint" => Some("crate::c_types::bitcoin_to_C_outpoint("),
1232 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some("crate::c_types::TxOut::from_rust("),
1233 "bitcoin::network::constants::Network" => Some("crate::bitcoin::network::Network::from_bitcoin("),
1234 "bitcoin::util::address::WitnessVersion" => Some(""),
1235 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some("&local_"),
1236 "bitcoin::blockdata::block::Block" if is_ref => Some("crate::c_types::u8slice::from_slice(&local_"),
1238 "bitcoin::hash_types::Txid" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1240 // Newtypes that we just expose in their original form.
1241 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1242 if is_ref => Some(""),
1243 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1244 if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1245 "bitcoin::secp256k1::Message" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1246 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1247 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1248 if is_ref => Some("&"),
1249 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1250 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1251 if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1253 "lightning::io::Read" => Some("crate::c_types::u8slice::from_vec(&crate::c_types::reader_to_vec("),
1256 }.map(|s| s.to_owned())
1258 fn to_c_conversion_inline_suffix_from_path(&self, full_path: &str, is_ref: bool, _ptr_for_ref: bool) -> Option<String> {
1259 if self.is_primitive(full_path) {
1260 return Some("".to_owned());
1263 "Result" if !is_ref => Some(""),
1264 "Vec" if !is_ref => Some(".into()"),
1265 "Option" => Some(""),
1267 "[u8; 32]" if !is_ref => Some(" }"),
1268 "[u8; 32]" if is_ref => Some(""),
1269 "[u8; 20]" if !is_ref => Some(" }"),
1270 "[u8; 16]" if !is_ref => Some(" }"),
1271 "[u8; 12]" if !is_ref => Some(" }"),
1272 "[u8; 4]" if !is_ref => Some(" }"),
1273 "[u8; 3]" if is_ref => Some(""),
1275 "[u8]" if is_ref => Some(""),
1276 "[usize]" if is_ref => Some(""),
1278 "str" if is_ref => Some(".into()"),
1279 "alloc::string::String"|"String" if is_ref => Some(".as_str().into()"),
1280 "alloc::string::String"|"String" => Some(".into()"),
1282 "std::time::Duration"|"core::time::Duration" => Some(".as_secs()"),
1283 "std::time::SystemTime" => Some(".duration_since(::std::time::SystemTime::UNIX_EPOCH).expect(\"Times must be post-1970\").as_secs()"),
1284 "std::io::Error"|"lightning::io::Error" => Some(")"),
1285 "core::fmt::Arguments" => Some(").into()"),
1287 "core::convert::Infallible" => Some("\")"),
1289 "bitcoin::secp256k1::Error"|"bech32::Error"
1290 if !is_ref => Some(")"),
1291 "bitcoin::secp256k1::Error"|"secp256k1::Error"
1292 if !is_ref => Some(")"),
1294 "core::num::ParseIntError" => Some("*/"),
1295 "core::str::Utf8Error" => Some("*/"),
1297 "bitcoin::bech32::u5"|"bech32::u5" => Some(".into()"),
1299 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" => Some(")"),
1300 "bitcoin::secp256k1::ecdsa::Signature" => Some(")"),
1301 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some(")"),
1302 "bitcoin::secp256k1::SecretKey" if !is_ref => Some(")"),
1303 "bitcoin::secp256k1::SecretKey" if is_ref => Some(".as_ref()"),
1304 "bitcoin::secp256k1::Scalar" if !is_ref => Some(")"),
1305 "bitcoin::secp256k1::ecdh::SharedSecret" if !is_ref => Some(".secret_bytes() }"),
1307 "bitcoin::blockdata::script::Script" if is_ref => Some("[..])"),
1308 "bitcoin::blockdata::script::Script" if !is_ref => Some(".into_bytes().into()"),
1309 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(")"),
1310 "bitcoin::blockdata::transaction::OutPoint" => Some(")"),
1311 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(")"),
1312 "bitcoin::network::constants::Network" => Some(")"),
1313 "bitcoin::util::address::WitnessVersion" => Some(".into()"),
1314 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some(""),
1315 "bitcoin::blockdata::block::Block" if is_ref => Some(")"),
1317 "bitcoin::hash_types::Txid" if !is_ref => Some(".into_inner() }"),
1319 // Newtypes that we just expose in their original form.
1320 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1321 if is_ref => Some(".as_inner()"),
1322 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1323 if !is_ref => Some(".into_inner() }"),
1324 "bitcoin::secp256k1::Message" if !is_ref => Some(".as_ref().clone() }"),
1325 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1326 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1327 if is_ref => Some(".0"),
1328 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1329 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1330 if !is_ref => Some(".0 }"),
1332 "lightning::io::Read" => Some("))"),
1335 }.map(|s| s.to_owned())
1338 fn empty_val_check_suffix_from_path(&self, full_path: &str) -> Option<&str> {
1340 "lightning::ln::PaymentSecret" => Some(".data == [0; 32]"),
1341 "secp256k1::PublicKey"|"bitcoin::secp256k1::PublicKey" => Some(".is_null()"),
1342 "bitcoin::secp256k1::ecdsa::Signature" => Some(".is_null()"),
1347 /// When printing a reference to the source crate's rust type, if we need to map it to a
1348 /// different "real" type, it can be done so here.
1349 /// This is useful to work around limitations in the binding type resolver, where we reference
1350 /// a non-public `use` alias.
1351 /// TODO: We should never need to use this!
1352 fn real_rust_type_mapping<'equiv>(&self, thing: &'equiv str) -> &'equiv str {
1354 "lightning::io::Read" => "crate::c_types::io::Read",
1359 // ****************************
1360 // *** Container Processing ***
1361 // ****************************
1363 /// Returns the module path in the generated mapping crate to the containers which we generate
1364 /// when writing to CrateTypes::template_file.
1365 pub fn generated_container_path() -> &'static str {
1366 "crate::c_types::derived"
1368 /// Returns the module path in the generated mapping crate to the container templates, which
1369 /// are then concretized and put in the generated container path/template_file.
1370 fn container_templ_path() -> &'static str {
1374 /// This should just be a closure, but doing so gets an error like
1375 /// error: reached the recursion limit while instantiating `types::TypeResolver::is_transpar...c/types.rs:1358:104: 1358:110]>>`
1376 /// which implies the concrete function instantiation of `is_transparent_container` ends up
1377 /// being recursive.
1378 fn deref_type<'one, 'b: 'one> (obj: &'one &'b syn::Type) -> &'b syn::Type { *obj }
1380 /// Returns true if the path containing the given args is a "transparent" container, ie an
1381 /// Option or a container which does not require a generated continer class.
1382 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 {
1383 if full_path == "Option" {
1384 let inner = args.next().unwrap();
1385 assert!(args.next().is_none());
1386 match generics.resolve_type(inner) {
1387 syn::Type::Reference(r) => {
1388 let elem = &*r.elem;
1390 syn::Type::Path(_) =>
1391 self.is_transparent_container(full_path, true, [elem].iter().map(Self::deref_type), generics),
1395 syn::Type::Array(a) => {
1396 if let syn::Expr::Lit(l) = &a.len {
1397 if let syn::Lit::Int(i) = &l.lit {
1398 if i.base10_digits().parse::<usize>().unwrap() >= 32 {
1399 let mut buf = Vec::new();
1400 self.write_rust_type(&mut buf, generics, &a.elem, false);
1401 let ty = String::from_utf8(buf).unwrap();
1404 // Blindly assume that if we're trying to create an empty value for an
1405 // array < 32 entries that all-0s may be a valid state.
1408 } else { unimplemented!(); }
1409 } else { unimplemented!(); }
1411 syn::Type::Path(p) => {
1412 if let Some(resolved) = self.maybe_resolve_path(&p.path, generics) {
1413 if self.c_type_has_inner_from_path(&resolved) { return true; }
1414 if self.is_primitive(&resolved) { return false; }
1415 // We want to move to using `Option_` mappings where possible rather than
1416 // manual mappings, as it makes downstream bindings simpler and is more
1417 // clear for users. Thus, we default to false but override for a few
1418 // types which had mappings defined when we were avoiding the `Option_`s.
1419 match &resolved as &str {
1420 "lightning::ln::PaymentSecret" => true,
1421 "lightning::ln::PaymentHash" => true,
1422 "lightning::ln::PaymentPreimage" => true,
1423 "lightning::ln::channelmanager::PaymentId" => true,
1424 "bitcoin::hash_types::BlockHash" => true,
1425 "secp256k1::PublicKey"|"bitcoin::secp256k1::PublicKey" => true,
1428 } else { unimplemented!(); }
1430 syn::Type::Tuple(_) => false,
1431 _ => unimplemented!(),
1435 /// Returns true if the path is a "transparent" container, ie an Option or a container which does
1436 /// not require a generated continer class.
1437 pub fn is_path_transparent_container(&self, full_path: &syn::Path, generics: Option<&GenericTypes>, is_ref: bool) -> bool {
1438 let inner_iter = match &full_path.segments.last().unwrap().arguments {
1439 syn::PathArguments::None => return false,
1440 syn::PathArguments::AngleBracketed(args) => args.args.iter().map(|arg| {
1441 if let syn::GenericArgument::Type(ref ty) = arg {
1443 } else { unimplemented!() }
1445 syn::PathArguments::Parenthesized(_) => unimplemented!(),
1447 self.is_transparent_container(&self.resolve_path(full_path, generics), is_ref, inner_iter, generics)
1449 /// Returns true if this is a known, supported, non-transparent container.
1450 fn is_known_container(&self, full_path: &str, is_ref: bool) -> bool {
1451 (full_path == "Result" && !is_ref) || (full_path == "Vec" && !is_ref) || full_path.ends_with("Tuple") || full_path == "Option"
1453 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)
1454 // Returns prefix + Vec<(prefix, var-name-to-inline-convert)> + suffix
1455 // expecting one element in the vec per generic type, each of which is inline-converted
1456 -> Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)> {
1458 "Result" if !is_ref => {
1460 vec![(" { Ok(mut o) => crate::c_types::CResultTempl::ok(".to_string(), "o".to_string()),
1461 (").into(), Err(mut e) => crate::c_types::CResultTempl::err(".to_string(), "e".to_string())],
1462 ").into() }", ContainerPrefixLocation::PerConv))
1466 // We should only get here if the single contained has an inner
1467 assert!(self.c_type_has_inner(single_contained.unwrap()));
1469 Some(("Vec::new(); for mut item in ", vec![(format!(".drain(..) {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1472 if let Some(syn::Type::Reference(_)) = single_contained {
1473 Some(("Vec::new(); for item in ", vec![(format!(".iter() {{ local_{}.push(", var_name), "(*item)".to_string())], "); }", ContainerPrefixLocation::PerConv))
1475 Some(("Vec::new(); for item in ", vec![(format!(".iter() {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1479 let mut is_contained_ref = false;
1480 let contained_struct = if let Some(syn::Type::Path(p)) = single_contained {
1481 Some(self.resolve_path(&p.path, generics))
1482 } else if let Some(syn::Type::Reference(r)) = single_contained {
1483 is_contained_ref = true;
1484 if let syn::Type::Path(p) = &*r.elem {
1485 Some(self.resolve_path(&p.path, generics))
1488 if let Some(inner_path) = contained_struct {
1489 let only_contained_has_inner = self.c_type_has_inner_from_path(&inner_path);
1490 if self.c_type_has_inner_from_path(&inner_path) {
1491 let is_inner_ref = if let Some(syn::Type::Reference(_)) = single_contained { true } else { false };
1493 return Some(("if ", vec![
1494 (".is_none() { core::ptr::null() } else { ObjOps::nonnull_ptr_to_inner(".to_owned(),
1495 format!("({}{}.unwrap())", var_access, if is_inner_ref { "" } else { ".as_ref()" }))
1496 ], ") }", ContainerPrefixLocation::OutsideConv));
1498 return Some(("if ", vec![
1499 (".is_none() { core::ptr::null_mut() } else { ".to_owned(), format!("({}.unwrap())", var_access))
1500 ], " }", ContainerPrefixLocation::OutsideConv));
1502 } else if !self.is_transparent_container("Option", is_ref, [single_contained.unwrap()].iter().map(|a| *a), generics) {
1503 if self.is_primitive(&inner_path) || (!is_contained_ref && !is_ref) || only_contained_has_inner {
1504 let inner_name = self.get_c_mangled_container_type(vec![single_contained.unwrap()], generics, "Option").unwrap();
1505 return Some(("if ", vec![
1506 (format!(".is_none() {{ {}::None }} else {{ {}::Some(", inner_name, inner_name),
1507 format!("{}.unwrap()", var_access))
1508 ], ") }", ContainerPrefixLocation::PerConv));
1510 let inner_name = self.get_c_mangled_container_type(vec![single_contained.unwrap()], generics, "Option").unwrap();
1511 return Some(("if ", vec![
1512 (format!(".is_none() {{ {}::None }} else {{ {}::Some(/* WARNING: CLONING CONVERSION HERE! &Option<Enum> is otherwise un-expressable. */", inner_name, inner_name),
1513 format!("{}.clone().unwrap()", var_access))
1514 ], ") }", ContainerPrefixLocation::PerConv));
1517 // If c_type_from_path is some (ie there's a manual mapping for the inner
1518 // type), lean on write_empty_rust_val, below.
1521 if let Some(t) = single_contained {
1522 if let syn::Type::Tuple(syn::TypeTuple { elems, .. }) = t {
1523 let inner_name = self.get_c_mangled_container_type(vec![single_contained.unwrap()], generics, "Option").unwrap();
1524 if elems.is_empty() {
1525 return Some(("if ", vec![
1526 (format!(".is_none() {{ {}::None }} else {{ {}::Some /* ",
1527 inner_name, inner_name), format!(""))
1528 ], " */ }", ContainerPrefixLocation::PerConv));
1530 return Some(("if ", vec![
1531 (format!(".is_none() {{ {}::None }} else {{ {}::Some(",
1532 inner_name, inner_name), format!("({}.unwrap())", var_access))
1533 ], ") }", ContainerPrefixLocation::PerConv));
1536 if let syn::Type::Reference(syn::TypeReference { elem, .. }) = t {
1537 if let syn::Type::Slice(_) = &**elem {
1538 return Some(("if ", vec![
1539 (".is_none() { SmartPtr::null() } else { SmartPtr::from_obj(".to_string(),
1540 format!("({}.unwrap())", var_access))
1541 ], ") }", ContainerPrefixLocation::PerConv));
1544 let mut v = Vec::new();
1545 self.write_empty_rust_val(generics, &mut v, t);
1546 let s = String::from_utf8(v).unwrap();
1547 return Some(("if ", vec![
1548 (format!(".is_none() {{ {} }} else {{ ", s), format!("({}.unwrap())", var_access))
1549 ], " }", ContainerPrefixLocation::PerConv));
1550 } else { unreachable!(); }
1556 /// only_contained_has_inner implies that there is only one contained element in the container
1557 /// and it has an inner field (ie is an "opaque" type we've defined).
1558 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)
1559 // Returns prefix + Vec<(prefix, var-name-to-inline-convert)> + suffix
1560 // expecting one element in the vec per generic type, each of which is inline-converted
1561 -> Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)> {
1562 let mut only_contained_has_inner = false;
1563 let only_contained_resolved = if let Some(syn::Type::Path(p)) = single_contained {
1564 let res = self.resolve_path(&p.path, generics);
1565 only_contained_has_inner = self.c_type_has_inner_from_path(&res);
1569 "Result" if !is_ref => {
1571 vec![(".result_ok { true => Ok(".to_string(), format!("(*unsafe {{ Box::from_raw(<*mut _>::take_ptr(&mut {}.contents.result)) }})", var_access)),
1572 ("), false => Err(".to_string(), format!("(*unsafe {{ Box::from_raw(<*mut _>::take_ptr(&mut {}.contents.err)) }})", var_access))],
1573 ")}", ContainerPrefixLocation::PerConv))
1575 "Slice" if is_ref && only_contained_has_inner => {
1576 Some(("Vec::new(); for mut item in ", vec![(format!(".as_slice().iter() {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1579 Some(("Vec::new(); for mut item in ", vec![(format!(".into_rust().drain(..) {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1582 if let Some(resolved) = only_contained_resolved {
1583 if self.is_primitive(&resolved) {
1584 return Some(("if ", vec![(".is_some() { Some(".to_string(), format!("{}.take()", var_access))], ") } else { None }", ContainerPrefixLocation::NoPrefix))
1585 } else if only_contained_has_inner {
1587 return Some(("if ", vec![(".inner.is_null() { None } else { Some((*".to_string(), format!("{}", var_access))], ").clone()) }", ContainerPrefixLocation::PerConv))
1589 return Some(("if ", vec![(".inner.is_null() { None } else { Some(".to_string(), format!("{}", var_access))], ") }", ContainerPrefixLocation::PerConv));
1594 if let Some(t) = single_contained {
1596 syn::Type::Reference(_)|syn::Type::Path(_)|syn::Type::Slice(_)|syn::Type::Array(_) => {
1597 let mut v = Vec::new();
1598 let ret_ref = self.write_empty_rust_val_check_suffix(generics, &mut v, t);
1599 let s = String::from_utf8(v).unwrap();
1601 EmptyValExpectedTy::ReferenceAsPointer =>
1602 return Some(("if ", vec![
1603 (format!("{} {{ None }} else {{ Some(", s), format!("unsafe {{ &mut *{} }}", var_access))
1604 ], ") }", ContainerPrefixLocation::NoPrefix)),
1605 EmptyValExpectedTy::OptionType =>
1606 return Some(("{ /* ", vec![
1607 (format!("*/ let {}_opt = {};", var_name, var_access),
1608 format!("}} if {}_opt{} {{ None }} else {{ Some({{ {}_opt.take()", var_name, s, var_name))
1609 ], ") } }", ContainerPrefixLocation::PerConv)),
1610 EmptyValExpectedTy::NonPointer =>
1611 return Some(("if ", vec![
1612 (format!("{} {{ None }} else {{ Some(", s), format!("{}", var_access))
1613 ], ") }", ContainerPrefixLocation::PerConv)),
1616 syn::Type::Tuple(_) => {
1617 return Some(("if ", vec![(".is_some() { Some(".to_string(), format!("{}.take()", var_access))], ") } else { None }", ContainerPrefixLocation::PerConv))
1619 _ => unimplemented!(),
1621 } else { unreachable!(); }
1627 /// Constructs a reference to the given type, possibly tweaking the type if relevant to make it
1628 /// convertable to C.
1629 pub fn create_ownable_reference(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> Option<syn::Type> {
1630 let default_value = Some(syn::Type::Reference(syn::TypeReference {
1631 and_token: syn::Token!(&)(Span::call_site()), lifetime: None, mutability: None,
1632 elem: Box::new(t.clone()) }));
1633 match generics.resolve_type(t) {
1634 syn::Type::Path(p) => {
1635 if let Some(resolved_path) = self.maybe_resolve_path(&p.path, generics) {
1636 if resolved_path != "Vec" { return default_value; }
1637 if p.path.segments.len() != 1 { unimplemented!(); }
1638 let only_seg = p.path.segments.iter().next().unwrap();
1639 if let syn::PathArguments::AngleBracketed(args) = &only_seg.arguments {
1640 if args.args.len() != 1 { unimplemented!(); }
1641 let inner_arg = args.args.iter().next().unwrap();
1642 if let syn::GenericArgument::Type(ty) = &inner_arg {
1643 let mut can_create = self.c_type_has_inner(&ty);
1644 if let syn::Type::Path(inner) = ty {
1645 if inner.path.segments.len() == 1 &&
1646 format!("{}", inner.path.segments[0].ident) == "Vec" {
1650 if !can_create { return default_value; }
1651 if let Some(inner_ty) = self.create_ownable_reference(&ty, generics) {
1652 return Some(syn::Type::Reference(syn::TypeReference {
1653 and_token: syn::Token![&](Span::call_site()),
1656 elem: Box::new(syn::Type::Slice(syn::TypeSlice {
1657 bracket_token: syn::token::Bracket { span: Span::call_site() },
1658 elem: Box::new(inner_ty)
1661 } else { return default_value; }
1662 } else { unimplemented!(); }
1663 } else { unimplemented!(); }
1664 } else { return None; }
1670 // *************************************************
1671 // *** Type definition during main.rs processing ***
1672 // *************************************************
1674 /// Returns true if the object at the given path is mapped as X { inner: *mut origX, .. }.
1675 pub fn c_type_has_inner_from_path(&self, full_path: &str) -> bool {
1676 self.crate_types.opaques.get(full_path).is_some()
1679 /// Returns true if the object at the given path is mapped as X { inner: *mut origX, .. }.
1680 pub fn c_type_has_inner(&self, ty: &syn::Type) -> bool {
1682 syn::Type::Path(p) => {
1683 if let Some(full_path) = self.maybe_resolve_path(&p.path, None) {
1684 self.c_type_has_inner_from_path(&full_path)
1687 syn::Type::Reference(r) => {
1688 self.c_type_has_inner(&*r.elem)
1694 pub fn maybe_resolve_ident(&self, id: &syn::Ident) -> Option<String> {
1695 self.types.maybe_resolve_ident(id)
1698 pub fn maybe_resolve_path(&self, p_arg: &syn::Path, generics: Option<&GenericTypes>) -> Option<String> {
1699 self.types.maybe_resolve_path(p_arg, generics)
1701 pub fn resolve_path(&self, p: &syn::Path, generics: Option<&GenericTypes>) -> String {
1702 self.maybe_resolve_path(p, generics).unwrap()
1705 // ***********************************
1706 // *** Original Rust Type Printing ***
1707 // ***********************************
1709 fn in_rust_prelude(resolved_path: &str) -> bool {
1710 match resolved_path {
1718 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) {
1719 if let Some(resolved) = self.maybe_resolve_path(&path, generics_resolver) {
1720 if self.is_primitive(&resolved) {
1721 write!(w, "{}", path.get_ident().unwrap()).unwrap();
1723 // TODO: We should have a generic "is from a dependency" check here instead of
1724 // checking for "bitcoin" explicitly.
1725 if resolved.starts_with("bitcoin::") || Self::in_rust_prelude(&resolved) {
1726 write!(w, "{}", resolved).unwrap();
1727 } else if !generated_crate_ref {
1728 // If we're printing a generic argument, it needs to reference the crate, otherwise
1729 // the original crate.
1730 write!(w, "{}", self.real_rust_type_mapping(&resolved)).unwrap();
1732 write!(w, "crate::{}", resolved).unwrap();
1735 if let syn::PathArguments::AngleBracketed(args) = &path.segments.iter().last().unwrap().arguments {
1736 self.write_rust_generic_arg(w, generics_resolver, args.args.iter(), with_ref_lifetime);
1739 if path.leading_colon.is_some() {
1740 write!(w, "::").unwrap();
1742 for (idx, seg) in path.segments.iter().enumerate() {
1743 if idx != 0 { write!(w, "::").unwrap(); }
1744 write!(w, "{}", seg.ident).unwrap();
1745 if let syn::PathArguments::AngleBracketed(args) = &seg.arguments {
1746 self.write_rust_generic_arg(w, generics_resolver, args.args.iter(), with_ref_lifetime);
1751 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>) {
1752 let mut had_params = false;
1753 for (idx, arg) in generics.enumerate() {
1754 if idx != 0 { write!(w, ", ").unwrap(); } else { write!(w, "<").unwrap(); }
1757 syn::GenericParam::Lifetime(lt) => write!(w, "'{}", lt.lifetime.ident).unwrap(),
1758 syn::GenericParam::Type(t) => {
1759 write!(w, "{}", t.ident).unwrap();
1760 if t.colon_token.is_some() { write!(w, ":").unwrap(); }
1761 for (idx, bound) in t.bounds.iter().enumerate() {
1762 if idx != 0 { write!(w, " + ").unwrap(); }
1764 syn::TypeParamBound::Trait(tb) => {
1765 if tb.paren_token.is_some() || tb.lifetimes.is_some() { unimplemented!(); }
1766 self.write_rust_path(w, generics_resolver, &tb.path, false, false);
1768 _ => unimplemented!(),
1771 if t.eq_token.is_some() || t.default.is_some() { unimplemented!(); }
1773 _ => unimplemented!(),
1776 if had_params { write!(w, ">").unwrap(); }
1779 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) {
1780 write!(w, "<").unwrap();
1781 for (idx, arg) in generics.enumerate() {
1782 if idx != 0 { write!(w, ", ").unwrap(); }
1784 syn::GenericArgument::Type(t) => self.write_rust_type(w, generics_resolver, t, with_ref_lifetime),
1785 _ => unimplemented!(),
1788 write!(w, ">").unwrap();
1790 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) {
1791 let real_ty = generics.resolve_type(t);
1792 let mut generate_crate_ref = force_crate_ref || t != real_ty;
1794 syn::Type::Path(p) => {
1795 if p.qself.is_some() {
1798 if let Some(resolved_ty) = self.maybe_resolve_path(&p.path, generics) {
1799 generate_crate_ref |= self.maybe_resolve_path(&p.path, None).as_ref() != Some(&resolved_ty);
1800 if self.crate_types.traits.get(&resolved_ty).is_none() { generate_crate_ref = false; }
1802 self.write_rust_path(w, generics, &p.path, with_ref_lifetime, generate_crate_ref);
1804 syn::Type::Reference(r) => {
1805 write!(w, "&").unwrap();
1806 if let Some(lft) = &r.lifetime {
1807 write!(w, "'{} ", lft.ident).unwrap();
1808 } else if with_ref_lifetime {
1809 write!(w, "'static ").unwrap();
1811 if r.mutability.is_some() {
1812 write!(w, "mut ").unwrap();
1814 self.do_write_rust_type(w, generics, &*r.elem, with_ref_lifetime, generate_crate_ref);
1816 syn::Type::Array(a) => {
1817 write!(w, "[").unwrap();
1818 self.do_write_rust_type(w, generics, &a.elem, with_ref_lifetime, generate_crate_ref);
1819 if let syn::Expr::Lit(l) = &a.len {
1820 if let syn::Lit::Int(i) = &l.lit {
1821 write!(w, "; {}]", i).unwrap();
1822 } else { unimplemented!(); }
1823 } else { unimplemented!(); }
1825 syn::Type::Slice(s) => {
1826 write!(w, "[").unwrap();
1827 self.do_write_rust_type(w, generics, &s.elem, with_ref_lifetime, generate_crate_ref);
1828 write!(w, "]").unwrap();
1830 syn::Type::Tuple(s) => {
1831 write!(w, "(").unwrap();
1832 for (idx, t) in s.elems.iter().enumerate() {
1833 if idx != 0 { write!(w, ", ").unwrap(); }
1834 self.do_write_rust_type(w, generics, &t, with_ref_lifetime, generate_crate_ref);
1836 write!(w, ")").unwrap();
1838 _ => unimplemented!(),
1841 pub fn write_rust_type<W: std::io::Write>(&self, w: &mut W, generics: Option<&GenericTypes>, t: &syn::Type, with_ref_lifetime: bool) {
1842 self.do_write_rust_type(w, generics, t, with_ref_lifetime, false);
1846 /// Prints a constructor for something which is "uninitialized" (but obviously not actually
1847 /// unint'd memory).
1848 pub fn write_empty_rust_val<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type) {
1850 syn::Type::Reference(r) => {
1851 self.write_empty_rust_val(generics, w, &*r.elem)
1853 syn::Type::Path(p) => {
1854 let resolved = self.resolve_path(&p.path, generics);
1855 if self.crate_types.opaques.get(&resolved).is_some() {
1856 write!(w, "crate::{} {{ inner: core::ptr::null_mut(), is_owned: true }}", resolved).unwrap();
1858 // Assume its a manually-mapped C type, where we can just define an null() fn
1859 write!(w, "{}::null()", self.c_type_from_path(&resolved, false, false).unwrap()).unwrap();
1862 syn::Type::Array(a) => {
1863 if let syn::Expr::Lit(l) = &a.len {
1864 if let syn::Lit::Int(i) = &l.lit {
1865 if i.base10_digits().parse::<usize>().unwrap() < 32 {
1866 // Blindly assume that if we're trying to create an empty value for an
1867 // array < 32 entries that all-0s may be a valid state.
1870 let arrty = format!("[u8; {}]", i.base10_digits());
1871 write!(w, "{}", self.to_c_conversion_inline_prefix_from_path(&arrty, false, false).unwrap()).unwrap();
1872 write!(w, "[0; {}]", i.base10_digits()).unwrap();
1873 write!(w, "{}", self.to_c_conversion_inline_suffix_from_path(&arrty, false, false).unwrap()).unwrap();
1874 } else { unimplemented!(); }
1875 } else { unimplemented!(); }
1877 _ => unimplemented!(),
1881 fn is_real_type_array(&self, resolved_type: &str) -> Option<syn::Type> {
1882 if let Some(real_ty) = self.c_type_from_path(&resolved_type, true, false) {
1883 if real_ty.ends_with("]") && real_ty.starts_with("*const [u8; ") {
1884 let mut split = real_ty.split("; ");
1885 split.next().unwrap();
1886 let tail_str = split.next().unwrap();
1887 assert!(split.next().is_none());
1888 let len = usize::from_str_radix(&tail_str[..tail_str.len() - 1], 10).unwrap();
1889 Some(parse_quote!([u8; #len]))
1894 /// Prints a suffix to determine if a variable is empty (ie was set by write_empty_rust_val).
1895 /// See EmptyValExpectedTy for information on return types.
1896 fn write_empty_rust_val_check_suffix<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type) -> EmptyValExpectedTy {
1898 syn::Type::Reference(r) => {
1899 return self.write_empty_rust_val_check_suffix(generics, w, &*r.elem);
1901 syn::Type::Path(p) => {
1902 let resolved = self.resolve_path(&p.path, generics);
1903 if let Some(arr_ty) = self.is_real_type_array(&resolved) {
1904 return self.write_empty_rust_val_check_suffix(generics, w, &arr_ty);
1906 if self.crate_types.opaques.get(&resolved).is_some() {
1907 write!(w, ".inner.is_null()").unwrap();
1908 EmptyValExpectedTy::NonPointer
1910 if let Some(suffix) = self.empty_val_check_suffix_from_path(&resolved) {
1911 write!(w, "{}", suffix).unwrap();
1912 // We may eventually need to allow empty_val_check_suffix_from_path to specify if we need a deref or not
1913 EmptyValExpectedTy::NonPointer
1915 write!(w, ".is_none()").unwrap();
1916 EmptyValExpectedTy::OptionType
1920 syn::Type::Array(a) => {
1921 if let syn::Expr::Lit(l) = &a.len {
1922 if let syn::Lit::Int(i) = &l.lit {
1923 write!(w, ".data == [0; {}]", i.base10_digits()).unwrap();
1924 EmptyValExpectedTy::NonPointer
1925 } else { unimplemented!(); }
1926 } else { unimplemented!(); }
1928 syn::Type::Slice(_) => {
1929 // Option<[]> always implies that we want to treat len() == 0 differently from
1930 // None, so we always map an Option<[]> into a pointer.
1931 write!(w, " == core::ptr::null_mut()").unwrap();
1932 EmptyValExpectedTy::ReferenceAsPointer
1934 _ => unimplemented!(),
1938 /// Prints a suffix to determine if a variable is empty (ie was set by write_empty_rust_val).
1939 pub fn write_empty_rust_val_check<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type, var_access: &str) {
1941 syn::Type::Reference(r) => {
1942 self.write_empty_rust_val_check(generics, w, &*r.elem, var_access);
1944 syn::Type::Path(_) => {
1945 write!(w, "{}", var_access).unwrap();
1946 self.write_empty_rust_val_check_suffix(generics, w, t);
1948 syn::Type::Array(a) => {
1949 if let syn::Expr::Lit(l) = &a.len {
1950 if let syn::Lit::Int(i) = &l.lit {
1951 let arrty = format!("[u8; {}]", i.base10_digits());
1952 // We don't (yet) support a new-var conversion here.
1953 assert!(self.from_c_conversion_new_var_from_path(&arrty, false).is_none());
1955 self.from_c_conversion_prefix_from_path(&arrty, false).unwrap(),
1957 self.from_c_conversion_suffix_from_path(&arrty, false).unwrap()).unwrap();
1958 self.write_empty_rust_val_check_suffix(generics, w, t);
1959 } else { unimplemented!(); }
1960 } else { unimplemented!(); }
1962 _ => unimplemented!(),
1966 // ********************************
1967 // *** Type conversion printing ***
1968 // ********************************
1970 /// Returns true we if can just skip passing this to C entirely
1971 pub fn skip_arg(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> bool {
1973 syn::Type::Path(p) => {
1974 if p.qself.is_some() { unimplemented!(); }
1975 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
1976 self.skip_path(&full_path)
1979 syn::Type::Reference(r) => {
1980 self.skip_arg(&*r.elem, generics)
1985 pub fn no_arg_to_rust<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
1987 syn::Type::Path(p) => {
1988 if p.qself.is_some() { unimplemented!(); }
1989 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
1990 write!(w, "{}", self.no_arg_path_to_rust(&full_path)).unwrap();
1993 syn::Type::Reference(r) => {
1994 self.no_arg_to_rust(w, &*r.elem, generics);
2000 fn write_conversion_inline_intern<W: std::io::Write,
2001 LP: Fn(&str, bool, bool) -> Option<String>, DL: Fn(&mut W, &DeclType, &str, bool, bool), SC: Fn(bool, Option<&str>) -> String>
2002 (&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, is_ref: bool, is_mut: bool, ptr_for_ref: bool,
2003 tupleconv: &str, prefix: bool, sliceconv: SC, path_lookup: LP, decl_lookup: DL) {
2004 match generics.resolve_type(t) {
2005 syn::Type::Reference(r) => {
2006 self.write_conversion_inline_intern(w, &*r.elem, generics, true, r.mutability.is_some(),
2007 ptr_for_ref, tupleconv, prefix, sliceconv, path_lookup, decl_lookup);
2009 syn::Type::Path(p) => {
2010 if p.qself.is_some() {
2014 let resolved_path = self.resolve_path(&p.path, generics);
2015 if let Some(aliased_type) = self.crate_types.type_aliases.get(&resolved_path) {
2016 return self.write_conversion_inline_intern(w, aliased_type, None, is_ref, is_mut, ptr_for_ref, tupleconv, prefix, sliceconv, path_lookup, decl_lookup);
2017 } else if self.is_primitive(&resolved_path) {
2018 if is_ref && prefix {
2019 write!(w, "*").unwrap();
2021 } else if let Some(c_type) = path_lookup(&resolved_path, is_ref, ptr_for_ref) {
2022 write!(w, "{}", c_type).unwrap();
2023 } else if let Some((_, generics)) = self.crate_types.opaques.get(&resolved_path) {
2024 decl_lookup(w, &DeclType::StructImported { generics: &generics }, &resolved_path, is_ref, is_mut);
2025 } else if self.crate_types.mirrored_enums.get(&resolved_path).is_some() {
2026 decl_lookup(w, &DeclType::MirroredEnum, &resolved_path, is_ref, is_mut);
2027 } else if let Some(t) = self.crate_types.traits.get(&resolved_path) {
2028 decl_lookup(w, &DeclType::Trait(t), &resolved_path, is_ref, is_mut);
2029 } else if let Some(ident) = single_ident_generic_path_to_ident(&p.path) {
2030 if let Some(decl_type) = self.types.maybe_resolve_declared(ident) {
2031 decl_lookup(w, decl_type, &self.maybe_resolve_ident(ident).unwrap(), is_ref, is_mut);
2032 } else { unimplemented!(); }
2033 } else { unimplemented!(); }
2035 syn::Type::Array(a) => {
2036 // We assume all arrays contain only [int_literal; X]s.
2037 // This may result in some outputs not compiling.
2038 if let syn::Expr::Lit(l) = &a.len {
2039 if let syn::Lit::Int(i) = &l.lit {
2040 write!(w, "{}", path_lookup(&format!("[u8; {}]", i.base10_digits()), is_ref, ptr_for_ref).unwrap()).unwrap();
2041 } else { unimplemented!(); }
2042 } else { unimplemented!(); }
2044 syn::Type::Slice(s) => {
2045 // We assume all slices contain only literals or references.
2046 // This may result in some outputs not compiling.
2047 if let syn::Type::Path(p) = &*s.elem {
2048 let resolved = self.resolve_path(&p.path, generics);
2049 if self.is_primitive(&resolved) {
2050 write!(w, "{}", path_lookup("[u8]", is_ref, ptr_for_ref).unwrap()).unwrap();
2052 write!(w, "{}", sliceconv(true, None)).unwrap();
2054 } else if let syn::Type::Reference(r) = &*s.elem {
2055 if let syn::Type::Path(p) = &*r.elem {
2056 write!(w, "{}", sliceconv(self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)), None)).unwrap();
2057 } else if let syn::Type::Slice(_) = &*r.elem {
2058 write!(w, "{}", sliceconv(false, None)).unwrap();
2059 } else { unimplemented!(); }
2060 } else if let syn::Type::Tuple(t) = &*s.elem {
2061 assert!(!t.elems.is_empty());
2063 write!(w, "{}", sliceconv(false, None)).unwrap();
2065 let mut needs_map = false;
2066 for e in t.elems.iter() {
2067 if let syn::Type::Reference(_) = e {
2072 let mut map_str = Vec::new();
2073 write!(&mut map_str, ".map(|(").unwrap();
2074 for i in 0..t.elems.len() {
2075 write!(&mut map_str, "{}{}", if i != 0 { ", " } else { "" }, ('a' as u8 + i as u8) as char).unwrap();
2077 write!(&mut map_str, ")| (").unwrap();
2078 for (idx, e) in t.elems.iter().enumerate() {
2079 if let syn::Type::Reference(_) = e {
2080 write!(&mut map_str, "{}{}", if idx != 0 { ", " } else { "" }, (idx as u8 + 'a' as u8) as char).unwrap();
2081 } else if let syn::Type::Path(_) = e {
2082 write!(&mut map_str, "{}*{}", if idx != 0 { ", " } else { "" }, (idx as u8 + 'a' as u8) as char).unwrap();
2083 } else { unimplemented!(); }
2085 write!(&mut map_str, "))").unwrap();
2086 write!(w, "{}", sliceconv(false, Some(&String::from_utf8(map_str).unwrap()))).unwrap();
2088 write!(w, "{}", sliceconv(false, None)).unwrap();
2091 } else if let syn::Type::Array(_) = &*s.elem {
2092 write!(w, "{}", sliceconv(false, Some(".map(|a| *a)"))).unwrap();
2093 } else { unimplemented!(); }
2095 syn::Type::Tuple(t) => {
2096 if t.elems.is_empty() {
2097 // cbindgen has poor support for (), see, eg https://github.com/eqrion/cbindgen/issues/527
2098 // so work around it by just pretending its a 0u8
2099 write!(w, "{}", tupleconv).unwrap();
2101 if prefix { write!(w, "local_").unwrap(); }
2104 _ => unimplemented!(),
2108 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) {
2109 self.write_conversion_inline_intern(w, t, generics, is_ref, false, ptr_for_ref, "() /*", true, |_, _| "local_".to_owned(),
2110 |a, b, c| self.to_c_conversion_inline_prefix_from_path(a, b, c),
2111 |w, decl_type, decl_path, is_ref, _is_mut| {
2113 DeclType::MirroredEnum if is_ref && ptr_for_ref => write!(w, "crate::{}::from_native(", decl_path).unwrap(),
2114 DeclType::MirroredEnum if is_ref => write!(w, "&crate::{}::from_native(", decl_path).unwrap(),
2115 DeclType::MirroredEnum => write!(w, "crate::{}::native_into(", decl_path).unwrap(),
2116 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if is_ref && from_ptr => {
2117 if !ptr_for_ref { write!(w, "&").unwrap(); }
2118 write!(w, "crate::{} {{ inner: unsafe {{ (", decl_path).unwrap()
2120 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if is_ref => {
2121 if !ptr_for_ref { write!(w, "&").unwrap(); }
2122 write!(w, "crate::{} {{ inner: unsafe {{ ObjOps::nonnull_ptr_to_inner((", decl_path).unwrap()
2124 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref && from_ptr =>
2125 write!(w, "crate::{} {{ inner: ", decl_path).unwrap(),
2126 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref =>
2127 write!(w, "crate::{} {{ inner: ObjOps::heap_alloc(", decl_path).unwrap(),
2128 DeclType::Trait(_) if is_ref => write!(w, "").unwrap(),
2129 DeclType::Trait(_) if !is_ref => write!(w, "Into::into(").unwrap(),
2130 _ => panic!("{:?}", decl_path),
2134 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) {
2135 self.write_to_c_conversion_inline_prefix_inner(w, t, generics, false, ptr_for_ref, false);
2137 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) {
2138 self.write_conversion_inline_intern(w, t, generics, is_ref, false, ptr_for_ref, "*/", false, |_, _| ".into()".to_owned(),
2139 |a, b, c| self.to_c_conversion_inline_suffix_from_path(a, b, c),
2140 |w, decl_type, full_path, is_ref, _is_mut| match decl_type {
2141 DeclType::MirroredEnum => write!(w, ")").unwrap(),
2142 DeclType::EnumIgnored { generics }|DeclType::StructImported { generics } if is_ref => {
2143 write!(w, " as *const {}<", full_path).unwrap();
2144 for param in generics.params.iter() {
2145 if let syn::GenericParam::Lifetime(_) = param {
2146 write!(w, "'_, ").unwrap();
2148 write!(w, "_, ").unwrap();
2152 write!(w, ">) as *mut _ }}, is_owned: false }}").unwrap();
2154 write!(w, ">) as *mut _) }}, is_owned: false }}").unwrap();
2157 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref && from_ptr =>
2158 write!(w, ", is_owned: true }}").unwrap(),
2159 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref => write!(w, "), is_owned: true }}").unwrap(),
2160 DeclType::Trait(_) if is_ref => {},
2161 DeclType::Trait(_) => {
2162 // This is used when we're converting a concrete Rust type into a C trait
2163 // for use when a Rust trait method returns an associated type.
2164 // Because all of our C traits implement From<RustTypesImplementingTraits>
2165 // we can just call .into() here and be done.
2166 write!(w, ")").unwrap()
2168 _ => unimplemented!(),
2171 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) {
2172 self.write_to_c_conversion_inline_suffix_inner(w, t, generics, false, ptr_for_ref, false);
2175 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) {
2176 self.write_conversion_inline_intern(w, t, generics, is_ref, false, false, "() /*", true, |_, _| "&local_".to_owned(),
2177 |a, b, _c| self.from_c_conversion_prefix_from_path(a, b),
2178 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
2179 DeclType::StructImported {..} if is_ref => write!(w, "").unwrap(),
2180 DeclType::StructImported {..} if !is_ref => write!(w, "*unsafe {{ Box::from_raw(").unwrap(),
2181 DeclType::MirroredEnum if is_ref => write!(w, "&").unwrap(),
2182 DeclType::MirroredEnum => {},
2183 DeclType::Trait(_) => {},
2184 _ => unimplemented!(),
2187 pub fn write_from_c_conversion_prefix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2188 self.write_from_c_conversion_prefix_inner(w, t, generics, false, false);
2190 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) {
2191 self.write_conversion_inline_intern(w, t, generics, is_ref, false, false, "*/", false,
2192 |has_inner, map_str_opt| match (has_inner, map_str_opt) {
2193 (false, Some(map_str)) => format!(".iter(){}.collect::<Vec<_>>()[..]", map_str),
2194 (false, None) => ".iter().collect::<Vec<_>>()[..]".to_owned(),
2195 (true, None) => "[..]".to_owned(),
2196 (true, Some(_)) => unreachable!(),
2198 |a, b, _c| self.from_c_conversion_suffix_from_path(a, b),
2199 |w, decl_type, _full_path, is_ref, is_mut| match decl_type {
2200 DeclType::StructImported {..} if is_ref && ptr_for_ref => write!(w, "XXX unimplemented").unwrap(),
2201 DeclType::StructImported {..} if is_mut && is_ref => write!(w, ".get_native_mut_ref()").unwrap(),
2202 DeclType::StructImported {..} if is_ref => write!(w, ".get_native_ref()").unwrap(),
2203 DeclType::StructImported {..} if !is_ref => write!(w, ".take_inner()) }}").unwrap(),
2204 DeclType::MirroredEnum if is_ref => write!(w, ".to_native()").unwrap(),
2205 DeclType::MirroredEnum => write!(w, ".into_native()").unwrap(),
2206 DeclType::Trait(_) => {},
2207 _ => unimplemented!(),
2210 pub fn write_from_c_conversion_suffix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2211 self.write_from_c_conversion_suffix_inner(w, t, generics, false, false);
2213 // Note that compared to the above conversion functions, the following two are generally
2214 // significantly undertested:
2215 pub fn write_from_c_conversion_to_ref_prefix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2216 self.write_conversion_inline_intern(w, t, generics, false, false, false, "() /*", true, |_, _| "&local_".to_owned(),
2218 if let Some(conv) = self.from_c_conversion_prefix_from_path(a, b) {
2219 Some(format!("&{}", conv))
2222 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
2223 DeclType::StructImported {..} if !is_ref => write!(w, "").unwrap(),
2224 _ => unimplemented!(),
2227 pub fn write_from_c_conversion_to_ref_suffix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2228 self.write_conversion_inline_intern(w, t, generics, false, false, false, "*/", false,
2229 |has_inner, map_str_opt| match (has_inner, map_str_opt) {
2230 (false, Some(map_str)) => format!(".iter(){}.collect::<Vec<_>>()[..]", map_str),
2231 (false, None) => ".iter().collect::<Vec<_>>()[..]".to_owned(),
2232 (true, None) => "[..]".to_owned(),
2233 (true, Some(_)) => unreachable!(),
2235 |a, b, _c| self.from_c_conversion_suffix_from_path(a, b),
2236 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
2237 DeclType::StructImported {..} if !is_ref => write!(w, ".get_native_ref()").unwrap(),
2238 _ => unimplemented!(),
2242 fn write_conversion_new_var_intern<'b, W: std::io::Write,
2243 LP: Fn(&str, bool) -> Option<(&str, &str)>,
2244 LC: Fn(&str, bool, Option<&syn::Type>, &syn::Ident, &str) -> Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)>,
2245 VP: Fn(&mut W, &syn::Type, Option<&GenericTypes>, bool, bool, bool),
2246 VS: Fn(&mut W, &syn::Type, Option<&GenericTypes>, bool, bool, bool)>
2247 (&self, w: &mut W, ident: &syn::Ident, var: &str, t: &syn::Type, generics: Option<&GenericTypes>,
2248 mut is_ref: bool, mut ptr_for_ref: bool, to_c: bool, from_ownable_ref: bool,
2249 path_lookup: &LP, container_lookup: &LC, var_prefix: &VP, var_suffix: &VS) -> bool {
2251 macro_rules! convert_container {
2252 ($container_type: expr, $args_len: expr, $args_iter: expr) => { {
2253 // For slices (and Options), we refuse to directly map them as is_ref when they
2254 // aren't opaque types containing an inner pointer. This is due to the fact that,
2255 // in both cases, the actual higher-level type is non-is_ref.
2256 let (ty_has_inner, ty_is_trait) = if $args_len == 1 {
2257 let ty = $args_iter().next().unwrap();
2258 if $container_type == "Slice" && to_c {
2259 // "To C ptr_for_ref" means "return the regular object with is_owned
2260 // set to false", which is totally what we want in a slice if we're about to
2261 // set ty_has_inner.
2264 if let syn::Type::Reference(t) = ty {
2265 if let syn::Type::Path(p) = &*t.elem {
2266 let resolved = self.resolve_path(&p.path, generics);
2267 (self.c_type_has_inner_from_path(&resolved), self.crate_types.traits.get(&resolved).is_some())
2268 } else { (false, false) }
2269 } else if let syn::Type::Path(p) = ty {
2270 let resolved = self.resolve_path(&p.path, generics);
2271 (self.c_type_has_inner_from_path(&resolved), self.crate_types.traits.get(&resolved).is_some())
2272 } else { (false, false) }
2273 } else { (true, false) };
2275 // Options get a bunch of special handling, since in general we map Option<>al
2276 // types into the same C type as non-Option-wrapped types. This ends up being
2277 // pretty manual here and most of the below special-cases are for Options.
2278 let mut needs_ref_map = false;
2279 let mut only_contained_type = None;
2280 let mut only_contained_type_nonref = None;
2281 let mut only_contained_has_inner = false;
2282 let mut contains_slice = false;
2284 only_contained_has_inner = ty_has_inner;
2285 let arg = $args_iter().next().unwrap();
2286 if let syn::Type::Reference(t) = arg {
2287 only_contained_type = Some(arg);
2288 only_contained_type_nonref = Some(&*t.elem);
2289 if let syn::Type::Path(_) = &*t.elem {
2291 } else if let syn::Type::Slice(_) = &*t.elem {
2292 contains_slice = true;
2293 } else { return false; }
2294 // If the inner element contains an inner pointer, we will just use that,
2295 // avoiding the need to map elements to references. Otherwise we'll need to
2296 // do an extra mapping step.
2297 needs_ref_map = !only_contained_has_inner && !ty_is_trait && $container_type == "Option";
2299 only_contained_type = Some(arg);
2300 only_contained_type_nonref = Some(arg);
2304 if let Some((prefix, conversions, suffix, prefix_location)) = container_lookup(&$container_type, is_ref, only_contained_type, ident, var) {
2305 assert_eq!(conversions.len(), $args_len);
2306 write!(w, "let mut local_{}{} = ", ident,
2307 if (!to_c && needs_ref_map) || (to_c && $container_type == "Option" && contains_slice) {"_base"} else { "" }).unwrap();
2308 if prefix_location == ContainerPrefixLocation::OutsideConv {
2309 var_prefix(w, $args_iter().next().unwrap(), generics, is_ref, ptr_for_ref, true);
2311 write!(w, "{}{}", prefix, var).unwrap();
2313 for ((pfx, var_name), (idx, ty)) in conversions.iter().zip($args_iter().enumerate()) {
2314 let mut var = std::io::Cursor::new(Vec::new());
2315 write!(&mut var, "{}", var_name).unwrap();
2316 let var_access = String::from_utf8(var.into_inner()).unwrap();
2318 let conv_ty = if needs_ref_map { only_contained_type_nonref.as_ref().unwrap() } else { ty };
2320 write!(w, "{} {{ ", pfx).unwrap();
2321 let new_var_name = format!("{}_{}", ident, idx);
2322 let new_var = self.write_conversion_new_var_intern(w, &format_ident!("{}", new_var_name),
2323 &var_access, conv_ty, generics, contains_slice || (is_ref && ty_has_inner), ptr_for_ref,
2324 to_c, from_ownable_ref, path_lookup, container_lookup, var_prefix, var_suffix);
2325 if new_var { write!(w, " ").unwrap(); }
2327 if prefix_location == ContainerPrefixLocation::PerConv {
2328 var_prefix(w, conv_ty, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2329 } else if !is_ref && !needs_ref_map && to_c && only_contained_has_inner {
2330 write!(w, "ObjOps::heap_alloc(").unwrap();
2333 write!(w, "{}{}", if contains_slice && !to_c { "local_" } else { "" }, if new_var { new_var_name } else { var_access }).unwrap();
2334 if prefix_location == ContainerPrefixLocation::PerConv {
2335 var_suffix(w, conv_ty, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2336 } else if !is_ref && !needs_ref_map && to_c && only_contained_has_inner {
2337 write!(w, ")").unwrap();
2339 write!(w, " }}").unwrap();
2341 write!(w, "{}", suffix).unwrap();
2342 if prefix_location == ContainerPrefixLocation::OutsideConv {
2343 var_suffix(w, $args_iter().next().unwrap(), generics, is_ref, ptr_for_ref, true);
2345 write!(w, ";").unwrap();
2346 if !to_c && needs_ref_map {
2347 write!(w, " let mut local_{} = local_{}_base.as_ref()", ident, ident).unwrap();
2349 write!(w, ".map(|a| &a[..])").unwrap();
2351 write!(w, ";").unwrap();
2352 } else if to_c && $container_type == "Option" && contains_slice {
2353 write!(w, " let mut local_{} = *local_{}_base;", ident, ident).unwrap();
2360 match generics.resolve_type(t) {
2361 syn::Type::Reference(r) => {
2362 if let syn::Type::Slice(_) = &*r.elem {
2363 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)
2365 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)
2368 syn::Type::Path(p) => {
2369 if p.qself.is_some() {
2372 let resolved_path = self.resolve_path(&p.path, generics);
2373 if let Some(aliased_type) = self.crate_types.type_aliases.get(&resolved_path) {
2374 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);
2376 if self.is_known_container(&resolved_path, is_ref) || self.is_path_transparent_container(&p.path, generics, is_ref) {
2377 if let syn::PathArguments::AngleBracketed(args) = &p.path.segments.iter().next().unwrap().arguments {
2378 convert_container!(resolved_path, args.args.len(), || args.args.iter().map(|arg| {
2379 if let syn::GenericArgument::Type(ty) = arg {
2380 generics.resolve_type(ty)
2381 } else { unimplemented!(); }
2383 } else { unimplemented!(); }
2385 if self.is_primitive(&resolved_path) {
2387 } else if let Some(ty_ident) = single_ident_generic_path_to_ident(&p.path) {
2388 if let Some((prefix, suffix)) = path_lookup(&resolved_path, is_ref) {
2389 write!(w, "let mut local_{} = {}{}{};", ident, prefix, var, suffix).unwrap();
2391 } else if self.types.maybe_resolve_declared(ty_ident).is_some() {
2396 syn::Type::Array(_) => {
2397 // We assume all arrays contain only primitive types.
2398 // This may result in some outputs not compiling.
2401 syn::Type::Slice(s) => {
2402 if let syn::Type::Path(p) = &*s.elem {
2403 let resolved = self.resolve_path(&p.path, generics);
2404 if self.is_primitive(&resolved) {
2405 let slice_path = format!("[{}]", resolved);
2406 if let Some((prefix, suffix)) = path_lookup(&slice_path, true) {
2407 write!(w, "let mut local_{} = {}{}{};", ident, prefix, var, suffix).unwrap();
2411 let tyref = [&*s.elem];
2413 // If we're converting from a slice to a Vec, assume we can clone the
2414 // elements and clone them into a new Vec first. Next we'll walk the
2415 // new Vec here and convert them to C types.
2416 write!(w, "let mut local_{}_clone = Vec::new(); local_{}_clone.extend_from_slice({}); let mut {} = local_{}_clone; ", ident, ident, ident, ident, ident).unwrap();
2419 convert_container!("Vec", 1, || tyref.iter().map(|t| generics.resolve_type(*t)));
2420 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2422 } else if let syn::Type::Reference(ty) = &*s.elem {
2423 let tyref = if from_ownable_ref || !to_c { [&*ty.elem] } else { [&*s.elem] };
2425 convert_container!("Slice", 1, || tyref.iter().map(|t| generics.resolve_type(*t)));
2426 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2427 } else if let syn::Type::Tuple(t) = &*s.elem {
2428 // When mapping into a temporary new var, we need to own all the underlying objects.
2429 // Thus, we drop any references inside the tuple and convert with non-reference types.
2430 let mut elems = syn::punctuated::Punctuated::new();
2431 for elem in t.elems.iter() {
2432 if let syn::Type::Reference(r) = elem {
2433 elems.push((*r.elem).clone());
2435 elems.push(elem.clone());
2438 let ty = [syn::Type::Tuple(syn::TypeTuple {
2439 paren_token: t.paren_token, elems
2443 convert_container!("Slice", 1, || ty.iter());
2444 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2445 } else if let syn::Type::Array(_) = &*s.elem {
2448 let arr_elem = [(*s.elem).clone()];
2449 convert_container!("Slice", 1, || arr_elem.iter());
2450 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2451 } else { unimplemented!() }
2453 syn::Type::Tuple(t) => {
2454 if !t.elems.is_empty() {
2455 // We don't (yet) support tuple elements which cannot be converted inline
2456 write!(w, "let (").unwrap();
2457 for idx in 0..t.elems.len() {
2458 if idx != 0 { write!(w, ", ").unwrap(); }
2459 write!(w, "{} orig_{}_{}", if is_ref { "ref" } else { "mut" }, ident, idx).unwrap();
2461 write!(w, ") = {}{}; ", var, if !to_c { ".to_rust()" } else { "" }).unwrap();
2462 // Like other template types, tuples are always mapped as their non-ref
2463 // versions for types which have different ref mappings. Thus, we convert to
2464 // non-ref versions and handle opaque types with inner pointers manually.
2465 for (idx, elem) in t.elems.iter().enumerate() {
2466 if let syn::Type::Path(p) = elem {
2467 let v_name = format!("orig_{}_{}", ident, idx);
2468 let tuple_elem_ident = format_ident!("{}", &v_name);
2469 if self.write_conversion_new_var_intern(w, &tuple_elem_ident, &v_name, elem, generics,
2470 false, ptr_for_ref, to_c, from_ownable_ref,
2471 path_lookup, container_lookup, var_prefix, var_suffix) {
2472 write!(w, " ").unwrap();
2473 // Opaque types with inner pointers shouldn't ever create new stack
2474 // variables, so we don't handle it and just assert that it doesn't
2476 assert!(!self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)));
2480 write!(w, "let mut local_{} = (", ident).unwrap();
2481 for (idx, elem) in t.elems.iter().enumerate() {
2482 let real_elem = generics.resolve_type(&elem);
2483 let ty_has_inner = {
2485 // "To C ptr_for_ref" means "return the regular object with
2486 // is_owned set to false", which is totally what we want
2487 // if we're about to set ty_has_inner.
2490 if let syn::Type::Reference(t) = real_elem {
2491 if let syn::Type::Path(p) = &*t.elem {
2492 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
2494 } else if let syn::Type::Path(p) = real_elem {
2495 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
2498 if idx != 0 { write!(w, ", ").unwrap(); }
2499 var_prefix(w, real_elem, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2500 if is_ref && ty_has_inner {
2501 // For ty_has_inner, the regular var_prefix mapping will take a
2502 // reference, so deref once here to make sure we keep the original ref.
2503 write!(w, "*").unwrap();
2505 write!(w, "orig_{}_{}", ident, idx).unwrap();
2506 if is_ref && !ty_has_inner {
2507 // If we don't have an inner variable's reference to maintain, just
2508 // hope the type is Clonable and use that.
2509 write!(w, ".clone()").unwrap();
2511 var_suffix(w, real_elem, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2513 write!(w, "){};", if to_c { ".into()" } else { "" }).unwrap();
2517 _ => unimplemented!(),
2521 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 {
2522 self.write_conversion_new_var_intern(w, ident, var_access, t, generics, from_ownable_ref, ptr_for_ref, true, from_ownable_ref,
2523 &|a, b| self.to_c_conversion_new_var_from_path(a, b),
2524 &|a, b, c, d, e| self.to_c_conversion_container_new_var(generics, a, b, c, d, e),
2525 // We force ptr_for_ref here since we can't generate a ref on one line and use it later
2526 &|a, b, c, d, e, f| self.write_to_c_conversion_inline_prefix_inner(a, b, c, d, e, f),
2527 &|a, b, c, d, e, f| self.write_to_c_conversion_inline_suffix_inner(a, b, c, d, e, f))
2529 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 {
2530 self.write_to_c_conversion_new_var_inner(w, ident, &format!("{}", ident), t, generics, ptr_for_ref, false)
2532 /// Prints new-var conversion for an "ownable_ref" type, ie prints conversion for
2533 /// `create_ownable_reference(t)`, not `t` itself.
2534 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 {
2535 self.write_to_c_conversion_new_var_inner(w, ident, &format!("{}", ident), t, generics, true, true)
2537 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 {
2538 self.write_conversion_new_var_intern(w, ident, &format!("{}", ident), t, generics, false, false, false, false,
2539 &|a, b| self.from_c_conversion_new_var_from_path(a, b),
2540 &|a, b, c, d, e| self.from_c_conversion_container_new_var(generics, a, b, c, d, e),
2541 // We force ptr_for_ref here since we can't generate a ref on one line and use it later
2542 &|a, b, c, d, e, _f| self.write_from_c_conversion_prefix_inner(a, b, c, d, e),
2543 &|a, b, c, d, e, _f| self.write_from_c_conversion_suffix_inner(a, b, c, d, e))
2546 // ******************************************************
2547 // *** C Container Type Equivalent and alias Printing ***
2548 // ******************************************************
2550 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 {
2551 for (idx, orig_t) in args.enumerate() {
2553 write!(w, ", ").unwrap();
2555 let t = generics.resolve_type(orig_t);
2556 if let syn::Type::Reference(r_arg) = t {
2557 assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
2559 if !self.write_c_type_intern(w, &*r_arg.elem, generics, false, false, false, true, true) { return false; }
2561 // While write_c_type_intern, above is correct, we don't want to blindly convert a
2562 // reference to something stupid, so check that the container is either opaque or a
2563 // predefined type (currently only Transaction).
2564 if let syn::Type::Path(p_arg) = &*r_arg.elem {
2565 let resolved = self.resolve_path(&p_arg.path, generics);
2566 assert!(self.crate_types.opaques.get(&resolved).is_some() ||
2567 self.crate_types.traits.get(&resolved).is_some() ||
2568 self.c_type_from_path(&resolved, true, true).is_some(), "Template generics should be opaque or have a predefined mapping");
2569 } else { unimplemented!(); }
2570 } else if let syn::Type::Path(p_arg) = t {
2571 if let Some(resolved) = self.maybe_resolve_path(&p_arg.path, generics) {
2572 if !self.is_primitive(&resolved) {
2573 assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
2576 assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
2578 if !self.write_c_type_intern(w, t, generics, false, false, false, true, true) { return false; }
2580 // We don't currently support outer reference types for non-primitive inners,
2581 // except for the empty tuple.
2582 if let syn::Type::Tuple(t_arg) = t {
2583 assert!(t_arg.elems.len() == 0 || !is_ref);
2587 if !self.write_c_type_intern(w, t, generics, false, false, false, true, true) { return false; }
2592 fn check_create_container(&self, mangled_container: String, container_type: &str, args: Vec<&syn::Type>, generics: Option<&GenericTypes>, is_ref: bool) -> bool {
2593 if !self.crate_types.templates_defined.borrow().get(&mangled_container).is_some() {
2594 let mut created_container: Vec<u8> = Vec::new();
2596 if container_type == "Result" {
2597 let mut a_ty: Vec<u8> = Vec::new();
2598 if let syn::Type::Tuple(tup) = args.iter().next().unwrap() {
2599 if tup.elems.is_empty() {
2600 write!(&mut a_ty, "()").unwrap();
2602 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t).take(1), generics, is_ref) { return false; }
2605 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t).take(1), generics, is_ref) { return false; }
2608 let mut b_ty: Vec<u8> = Vec::new();
2609 if let syn::Type::Tuple(tup) = args.iter().skip(1).next().unwrap() {
2610 if tup.elems.is_empty() {
2611 write!(&mut b_ty, "()").unwrap();
2613 if !self.write_template_generics(&mut b_ty, &mut args.iter().map(|t| *t).skip(1), generics, is_ref) { return false; }
2616 if !self.write_template_generics(&mut b_ty, &mut args.iter().map(|t| *t).skip(1), generics, is_ref) { return false; }
2619 let ok_str = String::from_utf8(a_ty).unwrap();
2620 let err_str = String::from_utf8(b_ty).unwrap();
2621 let is_clonable = self.is_clonable(&ok_str) && self.is_clonable(&err_str);
2622 write_result_block(&mut created_container, &mangled_container, &ok_str, &err_str, is_clonable);
2624 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2626 } else if container_type == "Vec" {
2627 let mut a_ty: Vec<u8> = Vec::new();
2628 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t), generics, is_ref) { return false; }
2629 let ty = String::from_utf8(a_ty).unwrap();
2630 let is_clonable = self.is_clonable(&ty);
2631 write_vec_block(&mut created_container, &mangled_container, &ty, is_clonable);
2633 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2635 } else if container_type.ends_with("Tuple") {
2636 let mut tuple_args = Vec::new();
2637 let mut is_clonable = true;
2638 for arg in args.iter() {
2639 let mut ty: Vec<u8> = Vec::new();
2640 if !self.write_template_generics(&mut ty, &mut [arg].iter().map(|t| **t), generics, is_ref) { return false; }
2641 let ty_str = String::from_utf8(ty).unwrap();
2642 if !self.is_clonable(&ty_str) {
2643 is_clonable = false;
2645 tuple_args.push(ty_str);
2647 write_tuple_block(&mut created_container, &mangled_container, &tuple_args, is_clonable);
2649 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2651 } else if container_type == "Option" {
2652 let mut a_ty: Vec<u8> = Vec::new();
2653 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t), generics, is_ref) { return false; }
2654 let ty = String::from_utf8(a_ty).unwrap();
2655 let is_clonable = self.is_clonable(&ty);
2656 write_option_block(&mut created_container, &mangled_container, &ty, is_clonable);
2658 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2663 self.crate_types.write_new_template(mangled_container.clone(), true, &created_container);
2667 fn path_to_generic_args(path: &syn::Path) -> Vec<&syn::Type> {
2668 if let syn::PathArguments::AngleBracketed(args) = &path.segments.iter().next().unwrap().arguments {
2669 args.args.iter().map(|gen| if let syn::GenericArgument::Type(t) = gen { t } else { unimplemented!() }).collect()
2670 } else { unimplemented!(); }
2672 fn write_c_mangled_container_path_intern<W: std::io::Write>
2673 (&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 {
2674 let mut mangled_type: Vec<u8> = Vec::new();
2675 if !self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) {
2676 write!(w, "C{}_", ident).unwrap();
2677 write!(mangled_type, "C{}_", ident).unwrap();
2678 } else { assert_eq!(args.len(), 1); }
2679 for arg in args.iter() {
2680 macro_rules! write_path {
2681 ($p_arg: expr, $extra_write: expr) => {
2682 if let Some(subtype) = self.maybe_resolve_path(&$p_arg.path, generics) {
2683 if self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) {
2685 if self.c_type_has_inner_from_path(&subtype) {
2686 if !self.write_c_path_intern(w, &$p_arg.path, generics, is_ref, is_mut, ptr_for_ref, false, true) { return false; }
2688 if let Some(arr_ty) = self.is_real_type_array(&subtype) {
2689 if !self.write_c_type_intern(w, &arr_ty, generics, false, true, false, false, true) { return false; }
2691 // Option<T> needs to be converted to a *mut T, ie mut ptr-for-ref
2692 if !self.write_c_path_intern(w, &$p_arg.path, generics, true, true, true, false, true) { return false; }
2696 write!(w, "{}", $p_arg.path.segments.last().unwrap().ident).unwrap();
2698 } else if self.is_known_container(&subtype, is_ref) || self.is_path_transparent_container(&$p_arg.path, generics, is_ref) {
2699 if !self.write_c_mangled_container_path_intern(w, Self::path_to_generic_args(&$p_arg.path), generics,
2700 &subtype, is_ref, is_mut, ptr_for_ref, true) {
2703 self.write_c_mangled_container_path_intern(&mut mangled_type, Self::path_to_generic_args(&$p_arg.path),
2704 generics, &subtype, is_ref, is_mut, ptr_for_ref, true);
2705 if let Some(w2) = $extra_write as Option<&mut Vec<u8>> {
2706 self.write_c_mangled_container_path_intern(w2, Self::path_to_generic_args(&$p_arg.path),
2707 generics, &subtype, is_ref, is_mut, ptr_for_ref, true);
2710 let id = subtype.rsplitn(2, ':').next().unwrap(); // Get the "Base" name of the resolved type
2711 write!(w, "{}", id).unwrap();
2712 write!(mangled_type, "{}", id).unwrap();
2713 if let Some(w2) = $extra_write as Option<&mut Vec<u8>> {
2714 write!(w2, "{}", id).unwrap();
2717 } else { return false; }
2720 match generics.resolve_type(arg) {
2721 syn::Type::Tuple(tuple) => {
2722 if tuple.elems.len() == 0 {
2723 write!(w, "None").unwrap();
2724 write!(mangled_type, "None").unwrap();
2726 let mut mangled_tuple_type: Vec<u8> = Vec::new();
2728 // Figure out what the mangled type should look like. To disambiguate
2729 // ((A, B), C) and (A, B, C) we prefix the generic args with a _ and suffix
2730 // them with a Z. Ideally we wouldn't use Z, but not many special chars are
2731 // available for use in type names.
2732 write!(w, "C{}Tuple_", tuple.elems.len()).unwrap();
2733 write!(mangled_type, "C{}Tuple_", tuple.elems.len()).unwrap();
2734 write!(mangled_tuple_type, "C{}Tuple_", tuple.elems.len()).unwrap();
2735 for elem in tuple.elems.iter() {
2736 if let syn::Type::Path(p) = elem {
2737 write_path!(p, Some(&mut mangled_tuple_type));
2738 } else if let syn::Type::Reference(refelem) = elem {
2739 if let syn::Type::Path(p) = &*refelem.elem {
2740 write_path!(p, Some(&mut mangled_tuple_type));
2741 } else { return false; }
2742 } else { return false; }
2744 write!(w, "Z").unwrap();
2745 write!(mangled_type, "Z").unwrap();
2746 write!(mangled_tuple_type, "Z").unwrap();
2747 if !self.check_create_container(String::from_utf8(mangled_tuple_type).unwrap(),
2748 &format!("{}Tuple", tuple.elems.len()), tuple.elems.iter().collect(), generics, is_ref) {
2753 syn::Type::Path(p_arg) => {
2754 write_path!(p_arg, None);
2756 syn::Type::Reference(refty) => {
2757 if let syn::Type::Path(p_arg) = &*refty.elem {
2758 write_path!(p_arg, None);
2759 } else if let syn::Type::Slice(_) = &*refty.elem {
2760 // write_c_type will actually do exactly what we want here, we just need to
2761 // make it a pointer so that its an option. Note that we cannot always convert
2762 // the Vec-as-slice (ie non-ref types) containers, so sometimes need to be able
2763 // to edit it, hence we use *mut here instead of *const.
2764 if args.len() != 1 { return false; }
2765 write!(w, "*mut ").unwrap();
2766 self.write_c_type(w, arg, None, true);
2767 } else { return false; }
2769 syn::Type::Array(a) => {
2770 if let syn::Type::Path(p_arg) = &*a.elem {
2771 let resolved = self.resolve_path(&p_arg.path, generics);
2772 if !self.is_primitive(&resolved) { return false; }
2773 if let syn::Expr::Lit(syn::ExprLit { lit: syn::Lit::Int(len), .. }) = &a.len {
2774 if self.c_type_from_path(&format!("[{}; {}]", resolved, len.base10_digits()), is_ref, ptr_for_ref).is_none() { return false; }
2775 if in_type || args.len() != 1 {
2776 write!(w, "_{}{}", resolved, len.base10_digits()).unwrap();
2777 write!(mangled_type, "_{}{}", resolved, len.base10_digits()).unwrap();
2779 let arrty = format!("[{}; {}]", resolved, len.base10_digits());
2780 let realty = self.c_type_from_path(&arrty, is_ref, ptr_for_ref).unwrap_or(&arrty);
2781 write!(w, "{}", realty).unwrap();
2782 write!(mangled_type, "{}", realty).unwrap();
2784 } else { return false; }
2785 } else { return false; }
2787 _ => { return false; },
2790 if self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) { return true; }
2791 // Push the "end of type" Z
2792 write!(w, "Z").unwrap();
2793 write!(mangled_type, "Z").unwrap();
2795 // Make sure the type is actually defined:
2796 self.check_create_container(String::from_utf8(mangled_type).unwrap(), ident, args, generics, is_ref)
2798 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 {
2799 if !self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) {
2800 write!(w, "{}::", Self::generated_container_path()).unwrap();
2802 self.write_c_mangled_container_path_intern(w, args, generics, ident, is_ref, is_mut, ptr_for_ref, false)
2804 pub fn get_c_mangled_container_type(&self, args: Vec<&syn::Type>, generics: Option<&GenericTypes>, template_name: &str) -> Option<String> {
2805 let mut out = Vec::new();
2806 if !self.write_c_mangled_container_path(&mut out, args, generics, template_name, false, false, false) {
2809 Some(String::from_utf8(out).unwrap())
2812 // **********************************
2813 // *** C Type Equivalent Printing ***
2814 // **********************************
2816 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 {
2817 let full_path = match self.maybe_resolve_path(&path, generics) {
2818 Some(path) => path, None => return false };
2819 if let Some(c_type) = self.c_type_from_path(&full_path, is_ref, ptr_for_ref) {
2820 write!(w, "{}", c_type).unwrap();
2822 } else if self.crate_types.traits.get(&full_path).is_some() {
2823 // Note that we always use the crate:: prefix here as we are always referring to a
2824 // concrete object which is of the generated type, it just implements the upstream
2826 if is_ref && ptr_for_ref {
2827 write!(w, "*{} crate::{}", if is_mut { "mut" } else { "const" }, full_path).unwrap();
2829 if with_ref_lifetime { unimplemented!(); }
2830 write!(w, "&{}crate::{}", if is_mut { "mut " } else { "" }, full_path).unwrap();
2832 write!(w, "crate::{}", full_path).unwrap();
2835 } else if self.crate_types.opaques.get(&full_path).is_some() || self.crate_types.mirrored_enums.get(&full_path).is_some() {
2836 let crate_pfx = if c_ty { "crate::" } else { "" };
2837 if is_ref && ptr_for_ref {
2838 // ptr_for_ref implies we're returning the object, which we can't really do for
2839 // opaque or mirrored types without box'ing them, which is quite a waste, so return
2840 // the actual object itself (for opaque types we'll set the pointer to the actual
2841 // type and note that its a reference).
2842 write!(w, "{}{}", crate_pfx, full_path).unwrap();
2843 } else if is_ref && with_ref_lifetime {
2845 // If we're concretizing something with a lifetime parameter, we have to pick a
2846 // lifetime, of which the only real available choice is `static`, obviously.
2847 write!(w, "&'static {}", crate_pfx).unwrap();
2849 self.write_rust_path(w, generics, path, with_ref_lifetime, false);
2851 // We shouldn't be mapping references in types, so panic here
2855 write!(w, "&{}{}{}", if is_mut { "mut " } else { "" }, crate_pfx, full_path).unwrap();
2857 write!(w, "{}{}", crate_pfx, full_path).unwrap();
2864 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 {
2865 match generics.resolve_type(t) {
2866 syn::Type::Path(p) => {
2867 if p.qself.is_some() {
2870 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
2871 if self.is_known_container(&full_path, is_ref) || self.is_path_transparent_container(&p.path, generics, is_ref) {
2872 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);
2874 if let Some(aliased_type) = self.crate_types.type_aliases.get(&full_path).cloned() {
2875 return self.write_c_type_intern(w, &aliased_type, None, is_ref, is_mut, ptr_for_ref, with_ref_lifetime, c_ty);
2878 self.write_c_path_intern(w, &p.path, generics, is_ref, is_mut, ptr_for_ref, with_ref_lifetime, c_ty)
2880 syn::Type::Reference(r) => {
2881 self.write_c_type_intern(w, &*r.elem, generics, true, r.mutability.is_some(), ptr_for_ref, with_ref_lifetime, c_ty)
2883 syn::Type::Array(a) => {
2884 if is_ref && is_mut {
2885 write!(w, "*mut [").unwrap();
2886 if !self.write_c_type_intern(w, &a.elem, generics, false, false, ptr_for_ref, with_ref_lifetime, c_ty) { return false; }
2888 write!(w, "*const [").unwrap();
2889 if !self.write_c_type_intern(w, &a.elem, generics, false, false, ptr_for_ref, with_ref_lifetime, c_ty) { return false; }
2891 let mut typecheck = Vec::new();
2892 if !self.write_c_type_intern(&mut typecheck, &a.elem, generics, false, false, ptr_for_ref, with_ref_lifetime, c_ty) { return false; }
2893 if typecheck[..] != ['u' as u8, '8' as u8] { return false; }
2895 if let syn::Expr::Lit(l) = &a.len {
2896 if let syn::Lit::Int(i) = &l.lit {
2898 if let Some(ty) = self.c_type_from_path(&format!("[u8; {}]", i.base10_digits()), false, ptr_for_ref) {
2899 write!(w, "{}", ty).unwrap();
2903 write!(w, "; {}]", i).unwrap();
2909 syn::Type::Slice(s) => {
2910 if !is_ref || is_mut { return false; }
2911 if let syn::Type::Path(p) = &*s.elem {
2912 let resolved = self.resolve_path(&p.path, generics);
2913 if self.is_primitive(&resolved) {
2914 write!(w, "{}::{}slice", Self::container_templ_path(), resolved).unwrap();
2917 let mut inner_c_ty = Vec::new();
2918 assert!(self.write_c_path_intern(&mut inner_c_ty, &p.path, generics, true, false, ptr_for_ref, with_ref_lifetime, c_ty));
2919 if self.is_clonable(&String::from_utf8(inner_c_ty).unwrap()) {
2920 if let Some(id) = p.path.get_ident() {
2921 let mangled_container = format!("CVec_{}Z", id);
2922 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
2923 self.check_create_container(mangled_container, "Vec", vec![&*s.elem], generics, false)
2927 } else if let syn::Type::Reference(r) = &*s.elem {
2928 if let syn::Type::Path(p) = &*r.elem {
2929 // Slices with "real types" inside are mapped as the equivalent non-ref Vec
2930 let resolved = self.resolve_path(&p.path, generics);
2931 let mangled_container = if let Some((ident, _)) = self.crate_types.opaques.get(&resolved) {
2932 format!("CVec_{}Z", ident)
2933 } else if let Some(en) = self.crate_types.mirrored_enums.get(&resolved) {
2934 format!("CVec_{}Z", en.ident)
2935 } else if let Some(id) = p.path.get_ident() {
2936 format!("CVec_{}Z", id)
2937 } else { return false; };
2938 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
2939 self.check_create_container(mangled_container, "Vec", vec![&*r.elem], generics, false)
2940 } else if let syn::Type::Slice(sl2) = &*r.elem {
2941 if let syn::Type::Reference(r2) = &*sl2.elem {
2942 if let syn::Type::Path(p) = &*r2.elem {
2943 // Slices with slices with opaque types (with is_owned flags) are mapped as non-ref Vecs
2944 let resolved = self.resolve_path(&p.path, generics);
2945 let mangled_container = if let Some((ident, _)) = self.crate_types.opaques.get(&resolved) {
2946 format!("CVec_CVec_{}ZZ", ident)
2947 } else { return false; };
2948 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
2949 let inner = &r2.elem;
2950 let vec_ty: syn::Type = syn::parse_quote!(Vec<#inner>);
2951 self.check_create_container(mangled_container, "Vec", vec![&vec_ty], generics, false)
2955 } else if let syn::Type::Tuple(_) = &*s.elem {
2956 let mut args = syn::punctuated::Punctuated::<_, syn::token::Comma>::new();
2957 args.push(syn::GenericArgument::Type((*s.elem).clone()));
2958 let mut segments = syn::punctuated::Punctuated::new();
2959 segments.push(parse_quote!(Vec<#args>));
2960 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)
2961 } else if let syn::Type::Array(a) = &*s.elem {
2962 if let syn::Expr::Lit(l) = &a.len {
2963 if let syn::Lit::Int(i) = &l.lit {
2964 let mut buf = Vec::new();
2965 self.write_rust_type(&mut buf, generics, &*a.elem, false);
2966 let arr_ty = String::from_utf8(buf).unwrap();
2968 let arr_str = format!("[{}; {}]", arr_ty, i.base10_digits());
2969 let ty = self.c_type_from_path(&arr_str, false, ptr_for_ref).unwrap()
2970 .rsplitn(2, "::").next().unwrap();
2972 let mangled_container = format!("CVec_{}Z", ty);
2973 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
2974 self.check_create_container(mangled_container, "Vec", vec![&*s.elem], generics, false)
2979 syn::Type::Tuple(t) => {
2980 if t.elems.len() == 0 {
2983 self.write_c_mangled_container_path(w, t.elems.iter().collect(), generics,
2984 &format!("{}Tuple", t.elems.len()), is_ref, is_mut, ptr_for_ref)
2990 pub fn write_c_type<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, ptr_for_ref: bool) {
2991 assert!(self.write_c_type_intern(w, t, generics, false, false, ptr_for_ref, false, true));
2993 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) {
2994 assert!(self.write_c_type_intern(w, t, generics, false, false, ptr_for_ref, true, false));
2996 pub fn understood_c_path(&self, p: &syn::Path) -> bool {
2997 self.write_c_path_intern(&mut std::io::sink(), p, None, false, false, false, false, true)
2999 pub fn understood_c_type(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> bool {
3000 self.write_c_type_intern(&mut std::io::sink(), t, generics, false, false, false, false, true)