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)
653 } else if first_seg_str == "crate" {
654 Some(self.crate_name.to_owned() + &remaining)
659 /// Map all the Paths in a Type into absolute paths given a set of imports (generated via process_use_intern)
660 pub fn resolve_imported_refs(&self, mut ty: syn::Type) -> syn::Type {
662 syn::Type::Path(p) => {
663 if p.path.segments.len() != 1 { unimplemented!(); }
664 let mut args = p.path.segments[0].arguments.clone();
665 if let syn::PathArguments::AngleBracketed(ref mut generics) = &mut args {
666 for arg in generics.args.iter_mut() {
667 if let syn::GenericArgument::Type(ref mut t) = arg {
668 *t = self.resolve_imported_refs(t.clone());
672 if let Some((_, newpath)) = self.imports.get(single_ident_generic_path_to_ident(&p.path).unwrap()) {
673 p.path = newpath.clone();
675 p.path.segments[0].arguments = args;
677 syn::Type::Reference(r) => {
678 r.elem = Box::new(self.resolve_imported_refs((*r.elem).clone()));
680 syn::Type::Slice(s) => {
681 s.elem = Box::new(self.resolve_imported_refs((*s.elem).clone()));
683 syn::Type::Tuple(t) => {
684 for e in t.elems.iter_mut() {
685 *e = self.resolve_imported_refs(e.clone());
688 _ => unimplemented!(),
694 // templates_defined is walked to write the C++ header, so if we use the default hashing it get
695 // reordered on each genbindings run. Instead, we use SipHasher (which defaults to 0-keys) so that
696 // the sorting is stable across runs. It is deprecated, but the "replacement" doesn't actually
697 // accomplish the same goals, so we just ignore it.
699 pub type NonRandomHash = hash::BuildHasherDefault<hash::SipHasher>;
702 pub struct ASTModule {
703 pub attrs: Vec<syn::Attribute>,
704 pub items: Vec<syn::Item>,
705 pub submods: Vec<String>,
707 /// A struct containing the syn::File AST for each file in the crate.
708 pub struct FullLibraryAST {
709 pub modules: HashMap<String, ASTModule, NonRandomHash>,
710 pub dependencies: HashSet<syn::Ident>,
712 impl FullLibraryAST {
713 fn load_module(&mut self, module: String, attrs: Vec<syn::Attribute>, mut items: Vec<syn::Item>) {
714 let mut non_mod_items = Vec::with_capacity(items.len());
715 let mut submods = Vec::with_capacity(items.len());
716 for item in items.drain(..) {
718 syn::Item::Mod(m) if m.content.is_some() => {
719 if export_status(&m.attrs) == ExportStatus::Export {
720 if let syn::Visibility::Public(_) = m.vis {
721 let modident = format!("{}", m.ident);
722 let modname = if module != "" {
723 module.clone() + "::" + &modident
725 self.dependencies.insert(m.ident);
728 self.load_module(modname, m.attrs, m.content.unwrap().1);
729 submods.push(modident);
731 non_mod_items.push(syn::Item::Mod(m));
735 syn::Item::Mod(_) => panic!("--pretty=expanded output should never have non-body modules"),
736 syn::Item::ExternCrate(c) => {
737 if export_status(&c.attrs) == ExportStatus::Export {
738 self.dependencies.insert(c.ident);
741 _ => { non_mod_items.push(item); }
744 self.modules.insert(module, ASTModule { attrs, items: non_mod_items, submods });
747 pub fn load_lib(lib: syn::File) -> Self {
748 assert_eq!(export_status(&lib.attrs), ExportStatus::Export);
749 let mut res = Self { modules: HashMap::default(), dependencies: HashSet::new() };
750 res.load_module("".to_owned(), lib.attrs, lib.items);
755 /// List of manually-generated types which are clonable
756 fn initial_clonable_types() -> HashSet<String> {
757 let mut res = HashSet::new();
758 res.insert("crate::c_types::u5".to_owned());
759 res.insert("crate::c_types::FourBytes".to_owned());
760 res.insert("crate::c_types::TwelveBytes".to_owned());
761 res.insert("crate::c_types::SixteenBytes".to_owned());
762 res.insert("crate::c_types::TwentyBytes".to_owned());
763 res.insert("crate::c_types::ThirtyTwoBytes".to_owned());
764 res.insert("crate::c_types::SecretKey".to_owned());
765 res.insert("crate::c_types::PublicKey".to_owned());
766 res.insert("crate::c_types::Transaction".to_owned());
767 res.insert("crate::c_types::TxOut".to_owned());
768 res.insert("crate::c_types::Signature".to_owned());
769 res.insert("crate::c_types::RecoverableSignature".to_owned());
770 res.insert("crate::c_types::Bech32Error".to_owned());
771 res.insert("crate::c_types::Secp256k1Error".to_owned());
772 res.insert("crate::c_types::IOError".to_owned());
773 res.insert("crate::c_types::Error".to_owned());
774 res.insert("crate::c_types::Str".to_owned());
776 // Because some types are manually-mapped to CVec_u8Z we may end up checking if its clonable
777 // before we ever get to constructing the type fully via
778 // `write_c_mangled_container_path_intern` (which will add it here too), so we have to manually
779 // add it on startup.
780 res.insert("crate::c_types::derived::CVec_u8Z".to_owned());
784 /// Top-level struct tracking everything which has been defined while walking the crate.
785 pub struct CrateTypes<'a> {
786 /// This may contain structs or enums, but only when either is mapped as
787 /// struct X { inner: *mut originalX, .. }
788 pub opaques: HashMap<String, (&'a syn::Ident, &'a syn::Generics)>,
789 /// structs that weren't exposed
790 pub priv_structs: HashMap<String, &'a syn::Generics>,
791 /// Enums which are mapped as C enums with conversion functions
792 pub mirrored_enums: HashMap<String, &'a syn::ItemEnum>,
793 /// Traits which are mapped as a pointer + jump table
794 pub traits: HashMap<String, &'a syn::ItemTrait>,
795 /// Aliases from paths to some other Type
796 pub type_aliases: HashMap<String, syn::Type>,
797 /// Value is an alias to Key (maybe with some generics)
798 pub reverse_alias_map: HashMap<String, Vec<(String, syn::PathArguments)>>,
799 /// Template continer types defined, map from mangled type name -> whether a destructor fn
802 /// This is used at the end of processing to make C++ wrapper classes
803 pub templates_defined: RefCell<HashMap<String, bool, NonRandomHash>>,
804 /// The output file for any created template container types, written to as we find new
805 /// template containers which need to be defined.
806 template_file: RefCell<&'a mut File>,
807 /// Set of containers which are clonable
808 clonable_types: RefCell<HashSet<String>>,
810 pub trait_impls: HashMap<String, Vec<String>>,
811 /// The full set of modules in the crate(s)
812 pub lib_ast: &'a FullLibraryAST,
815 impl<'a> CrateTypes<'a> {
816 pub fn new(template_file: &'a mut File, libast: &'a FullLibraryAST) -> Self {
818 opaques: HashMap::new(), mirrored_enums: HashMap::new(), traits: HashMap::new(),
819 type_aliases: HashMap::new(), reverse_alias_map: HashMap::new(),
820 templates_defined: RefCell::new(HashMap::default()), priv_structs: HashMap::new(),
821 clonable_types: RefCell::new(initial_clonable_types()), trait_impls: HashMap::new(),
822 template_file: RefCell::new(template_file), lib_ast: &libast,
825 pub fn set_clonable(&self, object: String) {
826 self.clonable_types.borrow_mut().insert(object);
828 pub fn is_clonable(&self, object: &str) -> bool {
829 self.clonable_types.borrow().contains(object)
831 pub fn write_new_template(&self, mangled_container: String, has_destructor: bool, created_container: &[u8]) {
832 self.template_file.borrow_mut().write(created_container).unwrap();
833 self.templates_defined.borrow_mut().insert(mangled_container, has_destructor);
837 /// A struct which tracks resolving rust types into C-mapped equivalents, exists for one specific
838 /// module but contains a reference to the overall CrateTypes tracking.
839 pub struct TypeResolver<'mod_lifetime, 'crate_lft: 'mod_lifetime> {
840 pub module_path: &'mod_lifetime str,
841 pub crate_types: &'mod_lifetime CrateTypes<'crate_lft>,
842 pub types: ImportResolver<'mod_lifetime, 'crate_lft>,
845 /// Returned by write_empty_rust_val_check_suffix to indicate what type of dereferencing needs to
846 /// happen to get the inner value of a generic.
847 enum EmptyValExpectedTy {
848 /// A type which has a flag for being empty (eg an array where we treat all-0s as empty).
850 /// A Option mapped as a COption_*Z
852 /// A pointer which we want to convert to a reference.
857 /// Describes the appropriate place to print a general type-conversion string when converting a
859 enum ContainerPrefixLocation {
860 /// Prints a general type-conversion string prefix and suffix outside of the
861 /// container-conversion strings.
863 /// Prints a general type-conversion string prefix and suffix inside of the
864 /// container-conversion strings.
866 /// Does not print the usual type-conversion string prefix and suffix.
870 impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
871 pub fn new(module_path: &'a str, types: ImportResolver<'a, 'c>, crate_types: &'a CrateTypes<'c>) -> Self {
872 Self { module_path, types, crate_types }
875 // *************************************************
876 // *** Well know type and conversion definitions ***
877 // *************************************************
879 /// Returns true we if can just skip passing this to C entirely
880 pub fn skip_path(&self, full_path: &str) -> bool {
881 full_path == "bitcoin::secp256k1::Secp256k1" ||
882 full_path == "bitcoin::secp256k1::Signing" ||
883 full_path == "bitcoin::secp256k1::Verification"
885 /// Returns true we if can just skip passing this to C entirely
886 fn no_arg_path_to_rust(&self, full_path: &str) -> &str {
887 if full_path == "bitcoin::secp256k1::Secp256k1" {
888 "secp256k1::global::SECP256K1"
889 } else { unimplemented!(); }
892 /// Returns true if the object is a primitive and is mapped as-is with no conversion
894 pub fn is_primitive(&self, full_path: &str) -> bool {
905 pub fn is_clonable(&self, ty: &str) -> bool {
906 if self.crate_types.is_clonable(ty) { return true; }
907 if self.is_primitive(ty) { return true; }
913 /// Gets the C-mapped type for types which are outside of the crate, or which are manually
914 /// ignored by for some reason need mapping anyway.
915 fn c_type_from_path<'b>(&self, full_path: &'b str, is_ref: bool, _ptr_for_ref: bool) -> Option<&'b str> {
916 if self.is_primitive(full_path) {
917 return Some(full_path);
920 // Note that no !is_ref types can map to an array because Rust and C's call semantics
921 // for arrays are different (https://github.com/eqrion/cbindgen/issues/528)
923 "[u8; 32]" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
924 "[u8; 20]" if !is_ref => Some("crate::c_types::TwentyBytes"),
925 "[u8; 16]" if !is_ref => Some("crate::c_types::SixteenBytes"),
926 "[u8; 12]" if !is_ref => Some("crate::c_types::TwelveBytes"),
927 "[u8; 4]" if !is_ref => Some("crate::c_types::FourBytes"),
928 "[u8; 3]" if !is_ref => Some("crate::c_types::ThreeBytes"), // Used for RGB values
930 "str" if is_ref => Some("crate::c_types::Str"),
931 "alloc::string::String"|"String" => Some("crate::c_types::Str"),
933 "std::time::Duration"|"core::time::Duration" => Some("u64"),
934 "std::time::SystemTime" => Some("u64"),
935 "std::io::Error"|"lightning::io::Error" => Some("crate::c_types::IOError"),
936 "core::fmt::Arguments" if is_ref => Some("crate::c_types::Str"),
938 "core::convert::Infallible" => Some("crate::c_types::NotConstructable"),
940 "bitcoin::bech32::Error"|"bech32::Error"
941 if !is_ref => Some("crate::c_types::Bech32Error"),
942 "bitcoin::secp256k1::Error"|"secp256k1::Error"
943 if !is_ref => Some("crate::c_types::Secp256k1Error"),
945 "core::num::ParseIntError" => Some("crate::c_types::Error"),
946 "core::str::Utf8Error" => Some("crate::c_types::Error"),
948 "bitcoin::bech32::u5"|"bech32::u5" => Some("crate::c_types::u5"),
949 "core::num::NonZeroU8" => Some("u8"),
951 "secp256k1::PublicKey"|"bitcoin::secp256k1::PublicKey" => Some("crate::c_types::PublicKey"),
952 "bitcoin::secp256k1::ecdsa::Signature" => Some("crate::c_types::Signature"),
953 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some("crate::c_types::RecoverableSignature"),
954 "bitcoin::secp256k1::SecretKey" if is_ref => Some("*const [u8; 32]"),
955 "bitcoin::secp256k1::SecretKey" if !is_ref => Some("crate::c_types::SecretKey"),
956 "bitcoin::secp256k1::Scalar" if is_ref => Some("*const crate::c_types::BigEndianScalar"),
957 "bitcoin::secp256k1::Scalar" if !is_ref => Some("crate::c_types::BigEndianScalar"),
958 "bitcoin::secp256k1::ecdh::SharedSecret" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
960 "bitcoin::blockdata::script::Script" if is_ref => Some("crate::c_types::u8slice"),
961 "bitcoin::blockdata::script::Script" if !is_ref => Some("crate::c_types::derived::CVec_u8Z"),
962 "bitcoin::blockdata::transaction::OutPoint" => Some("crate::lightning::chain::transaction::OutPoint"),
963 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some("crate::c_types::Transaction"),
964 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some("crate::c_types::TxOut"),
965 "bitcoin::network::constants::Network" => Some("crate::bitcoin::network::Network"),
966 "bitcoin::util::address::WitnessVersion" => Some("crate::c_types::WitnessVersion"),
967 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some("*const [u8; 80]"),
968 "bitcoin::blockdata::block::Block" if is_ref => Some("crate::c_types::u8slice"),
970 "bitcoin::hash_types::PubkeyHash"|"bitcoin::hash_types::WPubkeyHash"|"bitcoin::hash_types::ScriptHash"
971 if is_ref => Some("*const [u8; 20]"),
972 "bitcoin::hash_types::WScriptHash"
973 if is_ref => Some("*const [u8; 32]"),
975 // Newtypes that we just expose in their original form.
976 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
977 if is_ref => Some("*const [u8; 32]"),
978 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
979 if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
980 "bitcoin::secp256k1::Message" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
981 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
982 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
983 if is_ref => Some("*const [u8; 32]"),
984 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
985 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
986 if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
988 "lightning::io::Read" => Some("crate::c_types::u8slice"),
994 fn from_c_conversion_new_var_from_path<'b>(&self, _full_path: &str, _is_ref: bool) -> Option<(&'b str, &'b str)> {
997 fn from_c_conversion_prefix_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<String> {
998 if self.is_primitive(full_path) {
999 return Some("".to_owned());
1002 "Vec" if !is_ref => Some("local_"),
1003 "Result" if !is_ref => Some("local_"),
1004 "Option" if is_ref => Some("&local_"),
1005 "Option" => Some("local_"),
1007 "[u8; 32]" if is_ref => Some("unsafe { &*"),
1008 "[u8; 32]" if !is_ref => Some(""),
1009 "[u8; 20]" if !is_ref => Some(""),
1010 "[u8; 16]" if !is_ref => Some(""),
1011 "[u8; 12]" if !is_ref => Some(""),
1012 "[u8; 4]" if !is_ref => Some(""),
1013 "[u8; 3]" if !is_ref => Some(""),
1015 "[u8]" if is_ref => Some(""),
1016 "[usize]" if is_ref => Some(""),
1018 "str" if is_ref => Some(""),
1019 "alloc::string::String"|"String" => Some(""),
1020 "std::io::Error"|"lightning::io::Error" => Some(""),
1021 // Note that we'll panic for String if is_ref, as we only have non-owned memory, we
1022 // cannot create a &String.
1024 "core::convert::Infallible" => Some("panic!(\"You must never construct a NotConstructable! : "),
1026 "bitcoin::bech32::Error"|"bech32::Error" if !is_ref => Some(""),
1027 "bitcoin::secp256k1::Error"|"secp256k1::Error" if !is_ref => Some(""),
1029 "core::num::ParseIntError" => Some("u8::from_str_radix(\" a\", 10).unwrap_err() /*"),
1030 "core::str::Utf8Error" => Some("core::str::from_utf8(&[0xff]).unwrap_err() /*"),
1032 "std::time::Duration"|"core::time::Duration" => Some("core::time::Duration::from_secs("),
1033 "std::time::SystemTime" => Some("(::std::time::SystemTime::UNIX_EPOCH + std::time::Duration::from_secs("),
1035 "bitcoin::bech32::u5"|"bech32::u5" => Some(""),
1036 "core::num::NonZeroU8" => Some("core::num::NonZeroU8::new("),
1038 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" if is_ref => Some("&"),
1039 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" => Some(""),
1040 "bitcoin::secp256k1::ecdsa::Signature" if is_ref => Some("&"),
1041 "bitcoin::secp256k1::ecdsa::Signature" => Some(""),
1042 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some(""),
1043 "bitcoin::secp256k1::SecretKey" if is_ref => Some("&::bitcoin::secp256k1::SecretKey::from_slice(&unsafe { *"),
1044 "bitcoin::secp256k1::SecretKey" if !is_ref => Some(""),
1045 "bitcoin::secp256k1::Scalar" if !is_ref => Some(""),
1046 "bitcoin::secp256k1::ecdh::SharedSecret" if !is_ref => Some("::bitcoin::secp256k1::ecdh::SharedSecret::from_bytes("),
1048 "bitcoin::blockdata::script::Script" if is_ref => Some("&::bitcoin::blockdata::script::Script::from(Vec::from("),
1049 "bitcoin::blockdata::script::Script" if !is_ref => Some("::bitcoin::blockdata::script::Script::from("),
1050 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" if is_ref => Some("&"),
1051 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(""),
1052 "bitcoin::blockdata::transaction::OutPoint" => Some("crate::c_types::C_to_bitcoin_outpoint("),
1053 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(""),
1054 "bitcoin::network::constants::Network" => Some(""),
1055 "bitcoin::util::address::WitnessVersion" => Some(""),
1056 "bitcoin::blockdata::block::BlockHeader" => Some("&::bitcoin::consensus::encode::deserialize(unsafe { &*"),
1057 "bitcoin::blockdata::block::Block" if is_ref => Some("&::bitcoin::consensus::encode::deserialize("),
1059 "bitcoin::hash_types::PubkeyHash" if is_ref =>
1060 Some("&bitcoin::hash_types::PubkeyHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
1061 "bitcoin::hash_types::WPubkeyHash" if is_ref =>
1062 Some("&bitcoin::hash_types::WPubkeyHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
1063 "bitcoin::hash_types::ScriptHash" if is_ref =>
1064 Some("&bitcoin::hash_types::ScriptHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
1065 "bitcoin::hash_types::WScriptHash" if is_ref =>
1066 Some("&bitcoin::hash_types::WScriptHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
1068 // Newtypes that we just expose in their original form.
1069 "bitcoin::hash_types::Txid" if is_ref => Some("&::bitcoin::hash_types::Txid::from_slice(&unsafe { &*"),
1070 "bitcoin::hash_types::Txid" if !is_ref => Some("::bitcoin::hash_types::Txid::from_slice(&"),
1071 "bitcoin::hash_types::BlockHash" => Some("::bitcoin::hash_types::BlockHash::from_slice(&"),
1072 "lightning::ln::PaymentHash" if !is_ref => Some("::lightning::ln::PaymentHash("),
1073 "lightning::ln::PaymentHash" if is_ref => Some("&::lightning::ln::PaymentHash(unsafe { *"),
1074 "lightning::ln::PaymentPreimage" if !is_ref => Some("::lightning::ln::PaymentPreimage("),
1075 "lightning::ln::PaymentPreimage" if is_ref => Some("&::lightning::ln::PaymentPreimage(unsafe { *"),
1076 "lightning::ln::PaymentSecret" if !is_ref => Some("::lightning::ln::PaymentSecret("),
1077 "lightning::ln::channelmanager::PaymentId" if !is_ref => Some("::lightning::ln::channelmanager::PaymentId("),
1078 "lightning::ln::channelmanager::PaymentId" if is_ref=> Some("&::lightning::ln::channelmanager::PaymentId( unsafe { *"),
1079 "lightning::chain::keysinterface::KeyMaterial" if !is_ref => Some("::lightning::chain::keysinterface::KeyMaterial("),
1080 "lightning::chain::keysinterface::KeyMaterial" if is_ref=> Some("&::lightning::chain::keysinterface::KeyMaterial( unsafe { *"),
1082 // List of traits we map (possibly during processing of other files):
1083 "lightning::io::Read" => Some("&mut "),
1086 }.map(|s| s.to_owned())
1088 fn from_c_conversion_suffix_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<String> {
1089 if self.is_primitive(full_path) {
1090 return Some("".to_owned());
1093 "Vec" if !is_ref => Some(""),
1094 "Option" => Some(""),
1095 "Result" if !is_ref => Some(""),
1097 "[u8; 32]" if is_ref => Some("}"),
1098 "[u8; 32]" if !is_ref => Some(".data"),
1099 "[u8; 20]" if !is_ref => Some(".data"),
1100 "[u8; 16]" if !is_ref => Some(".data"),
1101 "[u8; 12]" if !is_ref => Some(".data"),
1102 "[u8; 4]" if !is_ref => Some(".data"),
1103 "[u8; 3]" if !is_ref => Some(".data"),
1105 "[u8]" if is_ref => Some(".to_slice()"),
1106 "[usize]" if is_ref => Some(".to_slice()"),
1108 "str" if is_ref => Some(".into_str()"),
1109 "alloc::string::String"|"String" => Some(".into_string()"),
1110 "std::io::Error"|"lightning::io::Error" => Some(".to_rust()"),
1112 "core::convert::Infallible" => Some("\")"),
1114 "bitcoin::bech32::Error"|"bech32::Error" if !is_ref => Some(".into_rust()"),
1115 "bitcoin::secp256k1::Error"|"secp256k1::Error" if !is_ref => Some(".into_rust()"),
1117 "core::num::ParseIntError" => Some("*/"),
1118 "core::str::Utf8Error" => Some("*/"),
1120 "std::time::Duration"|"core::time::Duration" => Some(")"),
1121 "std::time::SystemTime" => Some("))"),
1123 "bitcoin::bech32::u5"|"bech32::u5" => Some(".into()"),
1124 "core::num::NonZeroU8" => Some(").expect(\"Value must be non-zero\")"),
1126 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" => Some(".into_rust()"),
1127 "bitcoin::secp256k1::ecdsa::Signature" => Some(".into_rust()"),
1128 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some(".into_rust()"),
1129 "bitcoin::secp256k1::SecretKey" if !is_ref => Some(".into_rust()"),
1130 "bitcoin::secp256k1::SecretKey" if is_ref => Some("}[..]).unwrap()"),
1131 "bitcoin::secp256k1::Scalar" if !is_ref => Some(".into_rust()"),
1132 "bitcoin::secp256k1::ecdh::SharedSecret" if !is_ref => Some(".data)"),
1134 "bitcoin::blockdata::script::Script" if is_ref => Some(".to_slice()))"),
1135 "bitcoin::blockdata::script::Script" if !is_ref => Some(".into_rust())"),
1136 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(".into_bitcoin()"),
1137 "bitcoin::blockdata::transaction::OutPoint" => Some(")"),
1138 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(".into_rust()"),
1139 "bitcoin::network::constants::Network" => Some(".into_bitcoin()"),
1140 "bitcoin::util::address::WitnessVersion" => Some(".into()"),
1141 "bitcoin::blockdata::block::BlockHeader" => Some(" }).unwrap()"),
1142 "bitcoin::blockdata::block::Block" => Some(".to_slice()).unwrap()"),
1144 "bitcoin::hash_types::PubkeyHash"|"bitcoin::hash_types::WPubkeyHash"|
1145 "bitcoin::hash_types::ScriptHash"|"bitcoin::hash_types::WScriptHash"
1146 if is_ref => Some(" }.clone()))"),
1148 // Newtypes that we just expose in their original form.
1149 "bitcoin::hash_types::Txid" if is_ref => Some(" }[..]).unwrap()"),
1150 "bitcoin::hash_types::Txid" => Some(".data[..]).unwrap()"),
1151 "bitcoin::hash_types::BlockHash" if !is_ref => Some(".data[..]).unwrap()"),
1152 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1153 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1154 if !is_ref => Some(".data)"),
1155 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1156 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1157 if is_ref => Some(" })"),
1159 // List of traits we map (possibly during processing of other files):
1160 "lightning::io::Read" => Some(".to_reader()"),
1163 }.map(|s| s.to_owned())
1166 fn to_c_conversion_new_var_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<(&'b str, &'b str)> {
1167 if self.is_primitive(full_path) {
1171 "[u8]" if is_ref => Some(("crate::c_types::u8slice::from_slice(", ")")),
1172 "[usize]" if is_ref => Some(("crate::c_types::usizeslice::from_slice(", ")")),
1174 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some(("{ let mut s = [0u8; 80]; s[..].copy_from_slice(&::bitcoin::consensus::encode::serialize(", ")); s }")),
1175 "bitcoin::blockdata::block::Block" if is_ref => Some(("::bitcoin::consensus::encode::serialize(", ")")),
1176 "bitcoin::hash_types::Txid" => None,
1179 }.map(|s| s.to_owned())
1181 fn to_c_conversion_inline_prefix_from_path(&self, full_path: &str, is_ref: bool, _ptr_for_ref: bool) -> Option<String> {
1182 if self.is_primitive(full_path) {
1183 return Some("".to_owned());
1186 "Result" if !is_ref => Some("local_"),
1187 "Vec" if !is_ref => Some("local_"),
1188 "Option" => Some("local_"),
1190 "[u8; 32]" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1191 "[u8; 32]" if is_ref => Some(""),
1192 "[u8; 20]" if !is_ref => Some("crate::c_types::TwentyBytes { data: "),
1193 "[u8; 16]" if !is_ref => Some("crate::c_types::SixteenBytes { data: "),
1194 "[u8; 12]" if !is_ref => Some("crate::c_types::TwelveBytes { data: "),
1195 "[u8; 4]" if !is_ref => Some("crate::c_types::FourBytes { data: "),
1196 "[u8; 3]" if is_ref => Some(""),
1198 "[u8]" if is_ref => Some("local_"),
1199 "[usize]" if is_ref => Some("local_"),
1201 "str" if is_ref => Some(""),
1202 "alloc::string::String"|"String" => Some(""),
1204 "std::time::Duration"|"core::time::Duration" => Some(""),
1205 "std::time::SystemTime" => Some(""),
1206 "std::io::Error"|"lightning::io::Error" => Some("crate::c_types::IOError::from_rust("),
1207 "core::fmt::Arguments" => Some("alloc::format!(\"{}\", "),
1209 "core::convert::Infallible" => Some("panic!(\"Cannot construct an Infallible: "),
1211 "bitcoin::bech32::Error"|"bech32::Error"
1212 if !is_ref => Some("crate::c_types::Bech32Error::from_rust("),
1213 "bitcoin::secp256k1::Error"|"secp256k1::Error"
1214 if !is_ref => Some("crate::c_types::Secp256k1Error::from_rust("),
1216 "core::num::ParseIntError" => Some("crate::c_types::Error { _dummy: 0 } /*"),
1217 "core::str::Utf8Error" => Some("crate::c_types::Error { _dummy: 0 } /*"),
1219 "bitcoin::bech32::u5"|"bech32::u5" => Some(""),
1221 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" => Some("crate::c_types::PublicKey::from_rust(&"),
1222 "bitcoin::secp256k1::ecdsa::Signature" => Some("crate::c_types::Signature::from_rust(&"),
1223 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some("crate::c_types::RecoverableSignature::from_rust(&"),
1224 "bitcoin::secp256k1::SecretKey" if is_ref => Some(""),
1225 "bitcoin::secp256k1::SecretKey" if !is_ref => Some("crate::c_types::SecretKey::from_rust("),
1226 "bitcoin::secp256k1::Scalar" if !is_ref => Some("crate::c_types::BigEndianScalar::from_rust("),
1227 "bitcoin::secp256k1::ecdh::SharedSecret" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1229 "bitcoin::blockdata::script::Script" if is_ref => Some("crate::c_types::u8slice::from_slice(&"),
1230 "bitcoin::blockdata::script::Script" if !is_ref => Some(""),
1231 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" if is_ref => Some("crate::c_types::Transaction::from_bitcoin("),
1232 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some("crate::c_types::Transaction::from_bitcoin(&"),
1233 "bitcoin::blockdata::transaction::OutPoint" => Some("crate::c_types::bitcoin_to_C_outpoint("),
1234 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some("crate::c_types::TxOut::from_rust("),
1235 "bitcoin::network::constants::Network" => Some("crate::bitcoin::network::Network::from_bitcoin("),
1236 "bitcoin::util::address::WitnessVersion" => Some(""),
1237 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some("&local_"),
1238 "bitcoin::blockdata::block::Block" if is_ref => Some("crate::c_types::u8slice::from_slice(&local_"),
1240 "bitcoin::hash_types::Txid" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1242 // Newtypes that we just expose in their original form.
1243 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1244 if is_ref => Some(""),
1245 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1246 if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1247 "bitcoin::secp256k1::Message" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1248 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1249 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1250 if is_ref => Some("&"),
1251 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1252 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1253 if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1255 "lightning::io::Read" => Some("crate::c_types::u8slice::from_vec(&crate::c_types::reader_to_vec("),
1258 }.map(|s| s.to_owned())
1260 fn to_c_conversion_inline_suffix_from_path(&self, full_path: &str, is_ref: bool, _ptr_for_ref: bool) -> Option<String> {
1261 if self.is_primitive(full_path) {
1262 return Some("".to_owned());
1265 "Result" if !is_ref => Some(""),
1266 "Vec" if !is_ref => Some(".into()"),
1267 "Option" => Some(""),
1269 "[u8; 32]" if !is_ref => Some(" }"),
1270 "[u8; 32]" if is_ref => Some(""),
1271 "[u8; 20]" if !is_ref => Some(" }"),
1272 "[u8; 16]" if !is_ref => Some(" }"),
1273 "[u8; 12]" if !is_ref => Some(" }"),
1274 "[u8; 4]" if !is_ref => Some(" }"),
1275 "[u8; 3]" if is_ref => Some(""),
1277 "[u8]" if is_ref => Some(""),
1278 "[usize]" if is_ref => Some(""),
1280 "str" if is_ref => Some(".into()"),
1281 "alloc::string::String"|"String" if is_ref => Some(".as_str().into()"),
1282 "alloc::string::String"|"String" => Some(".into()"),
1284 "std::time::Duration"|"core::time::Duration" => Some(".as_secs()"),
1285 "std::time::SystemTime" => Some(".duration_since(::std::time::SystemTime::UNIX_EPOCH).expect(\"Times must be post-1970\").as_secs()"),
1286 "std::io::Error"|"lightning::io::Error" => Some(")"),
1287 "core::fmt::Arguments" => Some(").into()"),
1289 "core::convert::Infallible" => Some("\")"),
1291 "bitcoin::secp256k1::Error"|"bech32::Error"
1292 if !is_ref => Some(")"),
1293 "bitcoin::secp256k1::Error"|"secp256k1::Error"
1294 if !is_ref => Some(")"),
1296 "core::num::ParseIntError" => Some("*/"),
1297 "core::str::Utf8Error" => Some("*/"),
1299 "bitcoin::bech32::u5"|"bech32::u5" => Some(".into()"),
1301 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" => Some(")"),
1302 "bitcoin::secp256k1::ecdsa::Signature" => Some(")"),
1303 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some(")"),
1304 "bitcoin::secp256k1::SecretKey" if !is_ref => Some(")"),
1305 "bitcoin::secp256k1::SecretKey" if is_ref => Some(".as_ref()"),
1306 "bitcoin::secp256k1::Scalar" if !is_ref => Some(")"),
1307 "bitcoin::secp256k1::ecdh::SharedSecret" if !is_ref => Some(".secret_bytes() }"),
1309 "bitcoin::blockdata::script::Script" if is_ref => Some("[..])"),
1310 "bitcoin::blockdata::script::Script" if !is_ref => Some(".into_bytes().into()"),
1311 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(")"),
1312 "bitcoin::blockdata::transaction::OutPoint" => Some(")"),
1313 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(")"),
1314 "bitcoin::network::constants::Network" => Some(")"),
1315 "bitcoin::util::address::WitnessVersion" => Some(".into()"),
1316 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some(""),
1317 "bitcoin::blockdata::block::Block" if is_ref => Some(")"),
1319 "bitcoin::hash_types::Txid" if !is_ref => Some(".into_inner() }"),
1321 // Newtypes that we just expose in their original form.
1322 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1323 if is_ref => Some(".as_inner()"),
1324 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1325 if !is_ref => Some(".into_inner() }"),
1326 "bitcoin::secp256k1::Message" if !is_ref => Some(".as_ref().clone() }"),
1327 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1328 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1329 if is_ref => Some(".0"),
1330 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1331 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1332 if !is_ref => Some(".0 }"),
1334 "lightning::io::Read" => Some("))"),
1337 }.map(|s| s.to_owned())
1340 fn empty_val_check_suffix_from_path(&self, full_path: &str) -> Option<&str> {
1342 "lightning::ln::PaymentSecret" => Some(".data == [0; 32]"),
1343 "secp256k1::PublicKey"|"bitcoin::secp256k1::PublicKey" => Some(".is_null()"),
1344 "bitcoin::secp256k1::ecdsa::Signature" => Some(".is_null()"),
1349 /// When printing a reference to the source crate's rust type, if we need to map it to a
1350 /// different "real" type, it can be done so here.
1351 /// This is useful to work around limitations in the binding type resolver, where we reference
1352 /// a non-public `use` alias.
1353 /// TODO: We should never need to use this!
1354 fn real_rust_type_mapping<'equiv>(&self, thing: &'equiv str) -> &'equiv str {
1356 "lightning::io::Read" => "crate::c_types::io::Read",
1361 // ****************************
1362 // *** Container Processing ***
1363 // ****************************
1365 /// Returns the module path in the generated mapping crate to the containers which we generate
1366 /// when writing to CrateTypes::template_file.
1367 pub fn generated_container_path() -> &'static str {
1368 "crate::c_types::derived"
1370 /// Returns the module path in the generated mapping crate to the container templates, which
1371 /// are then concretized and put in the generated container path/template_file.
1372 fn container_templ_path() -> &'static str {
1376 /// This should just be a closure, but doing so gets an error like
1377 /// error: reached the recursion limit while instantiating `types::TypeResolver::is_transpar...c/types.rs:1358:104: 1358:110]>>`
1378 /// which implies the concrete function instantiation of `is_transparent_container` ends up
1379 /// being recursive.
1380 fn deref_type<'one, 'b: 'one> (obj: &'one &'b syn::Type) -> &'b syn::Type { *obj }
1382 /// Returns true if the path containing the given args is a "transparent" container, ie an
1383 /// Option or a container which does not require a generated continer class.
1384 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 {
1385 if full_path == "Option" {
1386 let inner = args.next().unwrap();
1387 assert!(args.next().is_none());
1388 match generics.resolve_type(inner) {
1389 syn::Type::Reference(r) => {
1390 let elem = &*r.elem;
1392 syn::Type::Path(_) =>
1393 self.is_transparent_container(full_path, true, [elem].iter().map(Self::deref_type), generics),
1397 syn::Type::Array(a) => {
1398 if let syn::Expr::Lit(l) = &a.len {
1399 if let syn::Lit::Int(i) = &l.lit {
1400 if i.base10_digits().parse::<usize>().unwrap() >= 32 {
1401 let mut buf = Vec::new();
1402 self.write_rust_type(&mut buf, generics, &a.elem, false);
1403 let ty = String::from_utf8(buf).unwrap();
1406 // Blindly assume that if we're trying to create an empty value for an
1407 // array < 32 entries that all-0s may be a valid state.
1410 } else { unimplemented!(); }
1411 } else { unimplemented!(); }
1413 syn::Type::Path(p) => {
1414 if let Some(resolved) = self.maybe_resolve_path(&p.path, generics) {
1415 if self.c_type_has_inner_from_path(&resolved) { return true; }
1416 if self.is_primitive(&resolved) { return false; }
1417 // We want to move to using `Option_` mappings where possible rather than
1418 // manual mappings, as it makes downstream bindings simpler and is more
1419 // clear for users. Thus, we default to false but override for a few
1420 // types which had mappings defined when we were avoiding the `Option_`s.
1421 match &resolved as &str {
1422 "lightning::ln::PaymentSecret" => true,
1423 "lightning::ln::PaymentHash" => true,
1424 "lightning::ln::PaymentPreimage" => true,
1425 "lightning::ln::channelmanager::PaymentId" => true,
1426 "bitcoin::hash_types::BlockHash" => true,
1427 "secp256k1::PublicKey"|"bitcoin::secp256k1::PublicKey" => true,
1430 } else { unimplemented!(); }
1432 syn::Type::Tuple(_) => false,
1433 _ => unimplemented!(),
1437 /// Returns true if the path is a "transparent" container, ie an Option or a container which does
1438 /// not require a generated continer class.
1439 pub fn is_path_transparent_container(&self, full_path: &syn::Path, generics: Option<&GenericTypes>, is_ref: bool) -> bool {
1440 let inner_iter = match &full_path.segments.last().unwrap().arguments {
1441 syn::PathArguments::None => return false,
1442 syn::PathArguments::AngleBracketed(args) => args.args.iter().map(|arg| {
1443 if let syn::GenericArgument::Type(ref ty) = arg {
1445 } else { unimplemented!() }
1447 syn::PathArguments::Parenthesized(_) => unimplemented!(),
1449 self.is_transparent_container(&self.resolve_path(full_path, generics), is_ref, inner_iter, generics)
1451 /// Returns true if this is a known, supported, non-transparent container.
1452 fn is_known_container(&self, full_path: &str, is_ref: bool) -> bool {
1453 (full_path == "Result" && !is_ref) || (full_path == "Vec" && !is_ref) || full_path.ends_with("Tuple") || full_path == "Option"
1455 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)
1456 // Returns prefix + Vec<(prefix, var-name-to-inline-convert)> + suffix
1457 // expecting one element in the vec per generic type, each of which is inline-converted
1458 -> Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)> {
1460 "Result" if !is_ref => {
1462 vec![(" { Ok(mut o) => crate::c_types::CResultTempl::ok(".to_string(), "o".to_string()),
1463 (").into(), Err(mut e) => crate::c_types::CResultTempl::err(".to_string(), "e".to_string())],
1464 ").into() }", ContainerPrefixLocation::PerConv))
1468 // We should only get here if the single contained has an inner
1469 assert!(self.c_type_has_inner(single_contained.unwrap()));
1471 Some(("Vec::new(); for mut item in ", vec![(format!(".drain(..) {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1474 if let Some(syn::Type::Reference(_)) = single_contained {
1475 Some(("Vec::new(); for item in ", vec![(format!(".iter() {{ local_{}.push(", var_name), "(*item)".to_string())], "); }", ContainerPrefixLocation::PerConv))
1477 Some(("Vec::new(); for item in ", vec![(format!(".iter() {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1481 let mut is_contained_ref = false;
1482 let contained_struct = if let Some(syn::Type::Path(p)) = single_contained {
1483 Some(self.resolve_path(&p.path, generics))
1484 } else if let Some(syn::Type::Reference(r)) = single_contained {
1485 is_contained_ref = true;
1486 if let syn::Type::Path(p) = &*r.elem {
1487 Some(self.resolve_path(&p.path, generics))
1490 if let Some(inner_path) = contained_struct {
1491 let only_contained_has_inner = self.c_type_has_inner_from_path(&inner_path);
1492 if self.c_type_has_inner_from_path(&inner_path) {
1493 let is_inner_ref = if let Some(syn::Type::Reference(_)) = single_contained { true } else { false };
1495 return Some(("if ", vec![
1496 (".is_none() { core::ptr::null() } else { ObjOps::nonnull_ptr_to_inner(".to_owned(),
1497 format!("({}{}.unwrap())", var_access, if is_inner_ref { "" } else { ".as_ref()" }))
1498 ], ") }", ContainerPrefixLocation::OutsideConv));
1500 return Some(("if ", vec![
1501 (".is_none() { core::ptr::null_mut() } else { ".to_owned(), format!("({}.unwrap())", var_access))
1502 ], " }", ContainerPrefixLocation::OutsideConv));
1504 } else if !self.is_transparent_container("Option", is_ref, [single_contained.unwrap()].iter().map(|a| *a), generics) {
1505 if self.is_primitive(&inner_path) || (!is_contained_ref && !is_ref) || only_contained_has_inner {
1506 let inner_name = self.get_c_mangled_container_type(vec![single_contained.unwrap()], generics, "Option").unwrap();
1507 return Some(("if ", vec![
1508 (format!(".is_none() {{ {}::None }} else {{ {}::Some(", inner_name, inner_name),
1509 format!("{}.unwrap()", var_access))
1510 ], ") }", ContainerPrefixLocation::PerConv));
1512 let inner_name = self.get_c_mangled_container_type(vec![single_contained.unwrap()], generics, "Option").unwrap();
1513 return Some(("if ", vec![
1514 (format!(".is_none() {{ {}::None }} else {{ {}::Some(/* WARNING: CLONING CONVERSION HERE! &Option<Enum> is otherwise un-expressable. */", inner_name, inner_name),
1515 format!("{}.clone().unwrap()", var_access))
1516 ], ") }", ContainerPrefixLocation::PerConv));
1519 // If c_type_from_path is some (ie there's a manual mapping for the inner
1520 // type), lean on write_empty_rust_val, below.
1523 if let Some(t) = single_contained {
1524 if let syn::Type::Tuple(syn::TypeTuple { elems, .. }) = t {
1525 let inner_name = self.get_c_mangled_container_type(vec![single_contained.unwrap()], generics, "Option").unwrap();
1526 if elems.is_empty() {
1527 return Some(("if ", vec![
1528 (format!(".is_none() {{ {}::None }} else {{ {}::Some /* ",
1529 inner_name, inner_name), format!(""))
1530 ], " */ }", ContainerPrefixLocation::PerConv));
1532 return Some(("if ", vec![
1533 (format!(".is_none() {{ {}::None }} else {{ {}::Some(",
1534 inner_name, inner_name), format!("({}.unwrap())", var_access))
1535 ], ") }", ContainerPrefixLocation::PerConv));
1538 if let syn::Type::Reference(syn::TypeReference { elem, .. }) = t {
1539 if let syn::Type::Slice(_) = &**elem {
1540 return Some(("if ", vec![
1541 (".is_none() { SmartPtr::null() } else { SmartPtr::from_obj(".to_string(),
1542 format!("({}.unwrap())", var_access))
1543 ], ") }", ContainerPrefixLocation::PerConv));
1546 let mut v = Vec::new();
1547 self.write_empty_rust_val(generics, &mut v, t);
1548 let s = String::from_utf8(v).unwrap();
1549 return Some(("if ", vec![
1550 (format!(".is_none() {{ {} }} else {{ ", s), format!("({}.unwrap())", var_access))
1551 ], " }", ContainerPrefixLocation::PerConv));
1552 } else { unreachable!(); }
1558 /// only_contained_has_inner implies that there is only one contained element in the container
1559 /// and it has an inner field (ie is an "opaque" type we've defined).
1560 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)
1561 // Returns prefix + Vec<(prefix, var-name-to-inline-convert)> + suffix
1562 // expecting one element in the vec per generic type, each of which is inline-converted
1563 -> Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)> {
1564 let mut only_contained_has_inner = false;
1565 let only_contained_resolved = if let Some(syn::Type::Path(p)) = single_contained {
1566 let res = self.resolve_path(&p.path, generics);
1567 only_contained_has_inner = self.c_type_has_inner_from_path(&res);
1571 "Result" if !is_ref => {
1573 vec![(".result_ok { true => Ok(".to_string(), format!("(*unsafe {{ Box::from_raw(<*mut _>::take_ptr(&mut {}.contents.result)) }})", var_access)),
1574 ("), false => Err(".to_string(), format!("(*unsafe {{ Box::from_raw(<*mut _>::take_ptr(&mut {}.contents.err)) }})", var_access))],
1575 ")}", ContainerPrefixLocation::PerConv))
1577 "Slice" if is_ref && only_contained_has_inner => {
1578 Some(("Vec::new(); for mut item in ", vec![(format!(".as_slice().iter() {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1581 Some(("Vec::new(); for mut item in ", vec![(format!(".into_rust().drain(..) {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1584 if let Some(resolved) = only_contained_resolved {
1585 if self.is_primitive(&resolved) {
1586 return Some(("if ", vec![(".is_some() { Some(".to_string(), format!("{}.take()", var_access))], ") } else { None }", ContainerPrefixLocation::NoPrefix))
1587 } else if only_contained_has_inner {
1589 return Some(("if ", vec![(".inner.is_null() { None } else { Some((*".to_string(), format!("{}", var_access))], ").clone()) }", ContainerPrefixLocation::PerConv))
1591 return Some(("if ", vec![(".inner.is_null() { None } else { Some(".to_string(), format!("{}", var_access))], ") }", ContainerPrefixLocation::PerConv));
1596 if let Some(t) = single_contained {
1598 syn::Type::Reference(_)|syn::Type::Path(_)|syn::Type::Slice(_)|syn::Type::Array(_) => {
1599 let mut v = Vec::new();
1600 let ret_ref = self.write_empty_rust_val_check_suffix(generics, &mut v, t);
1601 let s = String::from_utf8(v).unwrap();
1603 EmptyValExpectedTy::ReferenceAsPointer =>
1604 return Some(("if ", vec![
1605 (format!("{} {{ None }} else {{ Some(", s), format!("unsafe {{ &mut *{} }}", var_access))
1606 ], ") }", ContainerPrefixLocation::NoPrefix)),
1607 EmptyValExpectedTy::OptionType =>
1608 return Some(("{ /* ", vec![
1609 (format!("*/ let {}_opt = {};", var_name, var_access),
1610 format!("}} if {}_opt{} {{ None }} else {{ Some({{ {}_opt.take()", var_name, s, var_name))
1611 ], ") } }", ContainerPrefixLocation::PerConv)),
1612 EmptyValExpectedTy::NonPointer =>
1613 return Some(("if ", vec![
1614 (format!("{} {{ None }} else {{ Some(", s), format!("{}", var_access))
1615 ], ") }", ContainerPrefixLocation::PerConv)),
1618 syn::Type::Tuple(_) => {
1619 return Some(("if ", vec![(".is_some() { Some(".to_string(), format!("{}.take()", var_access))], ") } else { None }", ContainerPrefixLocation::PerConv))
1621 _ => unimplemented!(),
1623 } else { unreachable!(); }
1629 /// Constructs a reference to the given type, possibly tweaking the type if relevant to make it
1630 /// convertable to C.
1631 pub fn create_ownable_reference(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> Option<syn::Type> {
1632 let default_value = Some(syn::Type::Reference(syn::TypeReference {
1633 and_token: syn::Token!(&)(Span::call_site()), lifetime: None, mutability: None,
1634 elem: Box::new(t.clone()) }));
1635 match generics.resolve_type(t) {
1636 syn::Type::Path(p) => {
1637 if let Some(resolved_path) = self.maybe_resolve_path(&p.path, generics) {
1638 if resolved_path != "Vec" { return default_value; }
1639 if p.path.segments.len() != 1 { unimplemented!(); }
1640 let only_seg = p.path.segments.iter().next().unwrap();
1641 if let syn::PathArguments::AngleBracketed(args) = &only_seg.arguments {
1642 if args.args.len() != 1 { unimplemented!(); }
1643 let inner_arg = args.args.iter().next().unwrap();
1644 if let syn::GenericArgument::Type(ty) = &inner_arg {
1645 let mut can_create = self.c_type_has_inner(&ty);
1646 if let syn::Type::Path(inner) = ty {
1647 if inner.path.segments.len() == 1 &&
1648 format!("{}", inner.path.segments[0].ident) == "Vec" {
1652 if !can_create { return default_value; }
1653 if let Some(inner_ty) = self.create_ownable_reference(&ty, generics) {
1654 return Some(syn::Type::Reference(syn::TypeReference {
1655 and_token: syn::Token![&](Span::call_site()),
1658 elem: Box::new(syn::Type::Slice(syn::TypeSlice {
1659 bracket_token: syn::token::Bracket { span: Span::call_site() },
1660 elem: Box::new(inner_ty)
1663 } else { return default_value; }
1664 } else { unimplemented!(); }
1665 } else { unimplemented!(); }
1666 } else { return None; }
1672 // *************************************************
1673 // *** Type definition during main.rs processing ***
1674 // *************************************************
1676 /// Returns true if the object at the given path is mapped as X { inner: *mut origX, .. }.
1677 pub fn c_type_has_inner_from_path(&self, full_path: &str) -> bool {
1678 self.crate_types.opaques.get(full_path).is_some()
1681 /// Returns true if the object at the given path is mapped as X { inner: *mut origX, .. }.
1682 pub fn c_type_has_inner(&self, ty: &syn::Type) -> bool {
1684 syn::Type::Path(p) => {
1685 if let Some(full_path) = self.maybe_resolve_path(&p.path, None) {
1686 self.c_type_has_inner_from_path(&full_path)
1689 syn::Type::Reference(r) => {
1690 self.c_type_has_inner(&*r.elem)
1696 pub fn maybe_resolve_ident(&self, id: &syn::Ident) -> Option<String> {
1697 self.types.maybe_resolve_ident(id)
1700 pub fn maybe_resolve_path(&self, p_arg: &syn::Path, generics: Option<&GenericTypes>) -> Option<String> {
1701 self.types.maybe_resolve_path(p_arg, generics)
1703 pub fn resolve_path(&self, p: &syn::Path, generics: Option<&GenericTypes>) -> String {
1704 self.maybe_resolve_path(p, generics).unwrap()
1707 // ***********************************
1708 // *** Original Rust Type Printing ***
1709 // ***********************************
1711 fn in_rust_prelude(resolved_path: &str) -> bool {
1712 match resolved_path {
1720 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) {
1721 if let Some(resolved) = self.maybe_resolve_path(&path, generics_resolver) {
1722 if self.is_primitive(&resolved) {
1723 write!(w, "{}", path.get_ident().unwrap()).unwrap();
1725 // TODO: We should have a generic "is from a dependency" check here instead of
1726 // checking for "bitcoin" explicitly.
1727 if resolved.starts_with("bitcoin::") || Self::in_rust_prelude(&resolved) {
1728 write!(w, "{}", resolved).unwrap();
1729 } else if !generated_crate_ref {
1730 // If we're printing a generic argument, it needs to reference the crate, otherwise
1731 // the original crate.
1732 write!(w, "{}", self.real_rust_type_mapping(&resolved)).unwrap();
1734 write!(w, "crate::{}", resolved).unwrap();
1737 if let syn::PathArguments::AngleBracketed(args) = &path.segments.iter().last().unwrap().arguments {
1738 self.write_rust_generic_arg(w, generics_resolver, args.args.iter(), with_ref_lifetime);
1741 if path.leading_colon.is_some() {
1742 write!(w, "::").unwrap();
1744 for (idx, seg) in path.segments.iter().enumerate() {
1745 if idx != 0 { write!(w, "::").unwrap(); }
1746 write!(w, "{}", seg.ident).unwrap();
1747 if let syn::PathArguments::AngleBracketed(args) = &seg.arguments {
1748 self.write_rust_generic_arg(w, generics_resolver, args.args.iter(), with_ref_lifetime);
1753 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>) {
1754 let mut had_params = false;
1755 for (idx, arg) in generics.enumerate() {
1756 if idx != 0 { write!(w, ", ").unwrap(); } else { write!(w, "<").unwrap(); }
1759 syn::GenericParam::Lifetime(lt) => write!(w, "'{}", lt.lifetime.ident).unwrap(),
1760 syn::GenericParam::Type(t) => {
1761 write!(w, "{}", t.ident).unwrap();
1762 if t.colon_token.is_some() { write!(w, ":").unwrap(); }
1763 for (idx, bound) in t.bounds.iter().enumerate() {
1764 if idx != 0 { write!(w, " + ").unwrap(); }
1766 syn::TypeParamBound::Trait(tb) => {
1767 if tb.paren_token.is_some() || tb.lifetimes.is_some() { unimplemented!(); }
1768 self.write_rust_path(w, generics_resolver, &tb.path, false, false);
1770 _ => unimplemented!(),
1773 if t.eq_token.is_some() || t.default.is_some() { unimplemented!(); }
1775 _ => unimplemented!(),
1778 if had_params { write!(w, ">").unwrap(); }
1781 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) {
1782 write!(w, "<").unwrap();
1783 for (idx, arg) in generics.enumerate() {
1784 if idx != 0 { write!(w, ", ").unwrap(); }
1786 syn::GenericArgument::Type(t) => self.write_rust_type(w, generics_resolver, t, with_ref_lifetime),
1787 _ => unimplemented!(),
1790 write!(w, ">").unwrap();
1792 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) {
1793 let real_ty = generics.resolve_type(t);
1794 let mut generate_crate_ref = force_crate_ref || t != real_ty;
1796 syn::Type::Path(p) => {
1797 if p.qself.is_some() {
1800 if let Some(resolved_ty) = self.maybe_resolve_path(&p.path, generics) {
1801 generate_crate_ref |= self.maybe_resolve_path(&p.path, None).as_ref() != Some(&resolved_ty);
1802 if self.crate_types.traits.get(&resolved_ty).is_none() { generate_crate_ref = false; }
1804 self.write_rust_path(w, generics, &p.path, with_ref_lifetime, generate_crate_ref);
1806 syn::Type::Reference(r) => {
1807 write!(w, "&").unwrap();
1808 if let Some(lft) = &r.lifetime {
1809 write!(w, "'{} ", lft.ident).unwrap();
1810 } else if with_ref_lifetime {
1811 write!(w, "'static ").unwrap();
1813 if r.mutability.is_some() {
1814 write!(w, "mut ").unwrap();
1816 self.do_write_rust_type(w, generics, &*r.elem, with_ref_lifetime, generate_crate_ref);
1818 syn::Type::Array(a) => {
1819 write!(w, "[").unwrap();
1820 self.do_write_rust_type(w, generics, &a.elem, with_ref_lifetime, generate_crate_ref);
1821 if let syn::Expr::Lit(l) = &a.len {
1822 if let syn::Lit::Int(i) = &l.lit {
1823 write!(w, "; {}]", i).unwrap();
1824 } else { unimplemented!(); }
1825 } else { unimplemented!(); }
1827 syn::Type::Slice(s) => {
1828 write!(w, "[").unwrap();
1829 self.do_write_rust_type(w, generics, &s.elem, with_ref_lifetime, generate_crate_ref);
1830 write!(w, "]").unwrap();
1832 syn::Type::Tuple(s) => {
1833 write!(w, "(").unwrap();
1834 for (idx, t) in s.elems.iter().enumerate() {
1835 if idx != 0 { write!(w, ", ").unwrap(); }
1836 self.do_write_rust_type(w, generics, &t, with_ref_lifetime, generate_crate_ref);
1838 write!(w, ")").unwrap();
1840 _ => unimplemented!(),
1843 pub fn write_rust_type<W: std::io::Write>(&self, w: &mut W, generics: Option<&GenericTypes>, t: &syn::Type, with_ref_lifetime: bool) {
1844 self.do_write_rust_type(w, generics, t, with_ref_lifetime, false);
1848 /// Prints a constructor for something which is "uninitialized" (but obviously not actually
1849 /// unint'd memory).
1850 pub fn write_empty_rust_val<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type) {
1852 syn::Type::Reference(r) => {
1853 self.write_empty_rust_val(generics, w, &*r.elem)
1855 syn::Type::Path(p) => {
1856 let resolved = self.resolve_path(&p.path, generics);
1857 if self.crate_types.opaques.get(&resolved).is_some() {
1858 write!(w, "crate::{} {{ inner: core::ptr::null_mut(), is_owned: true }}", resolved).unwrap();
1860 // Assume its a manually-mapped C type, where we can just define an null() fn
1861 write!(w, "{}::null()", self.c_type_from_path(&resolved, false, false).unwrap()).unwrap();
1864 syn::Type::Array(a) => {
1865 if let syn::Expr::Lit(l) = &a.len {
1866 if let syn::Lit::Int(i) = &l.lit {
1867 if i.base10_digits().parse::<usize>().unwrap() < 32 {
1868 // Blindly assume that if we're trying to create an empty value for an
1869 // array < 32 entries that all-0s may be a valid state.
1872 let arrty = format!("[u8; {}]", i.base10_digits());
1873 write!(w, "{}", self.to_c_conversion_inline_prefix_from_path(&arrty, false, false).unwrap()).unwrap();
1874 write!(w, "[0; {}]", i.base10_digits()).unwrap();
1875 write!(w, "{}", self.to_c_conversion_inline_suffix_from_path(&arrty, false, false).unwrap()).unwrap();
1876 } else { unimplemented!(); }
1877 } else { unimplemented!(); }
1879 _ => unimplemented!(),
1883 fn is_real_type_array(&self, resolved_type: &str) -> Option<syn::Type> {
1884 if let Some(real_ty) = self.c_type_from_path(&resolved_type, true, false) {
1885 if real_ty.ends_with("]") && real_ty.starts_with("*const [u8; ") {
1886 let mut split = real_ty.split("; ");
1887 split.next().unwrap();
1888 let tail_str = split.next().unwrap();
1889 assert!(split.next().is_none());
1890 let len = usize::from_str_radix(&tail_str[..tail_str.len() - 1], 10).unwrap();
1891 Some(parse_quote!([u8; #len]))
1896 /// Prints a suffix to determine if a variable is empty (ie was set by write_empty_rust_val).
1897 /// See EmptyValExpectedTy for information on return types.
1898 fn write_empty_rust_val_check_suffix<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type) -> EmptyValExpectedTy {
1900 syn::Type::Reference(r) => {
1901 return self.write_empty_rust_val_check_suffix(generics, w, &*r.elem);
1903 syn::Type::Path(p) => {
1904 let resolved = self.resolve_path(&p.path, generics);
1905 if let Some(arr_ty) = self.is_real_type_array(&resolved) {
1906 return self.write_empty_rust_val_check_suffix(generics, w, &arr_ty);
1908 if self.crate_types.opaques.get(&resolved).is_some() {
1909 write!(w, ".inner.is_null()").unwrap();
1910 EmptyValExpectedTy::NonPointer
1912 if let Some(suffix) = self.empty_val_check_suffix_from_path(&resolved) {
1913 write!(w, "{}", suffix).unwrap();
1914 // We may eventually need to allow empty_val_check_suffix_from_path to specify if we need a deref or not
1915 EmptyValExpectedTy::NonPointer
1917 write!(w, ".is_none()").unwrap();
1918 EmptyValExpectedTy::OptionType
1922 syn::Type::Array(a) => {
1923 if let syn::Expr::Lit(l) = &a.len {
1924 if let syn::Lit::Int(i) = &l.lit {
1925 write!(w, ".data == [0; {}]", i.base10_digits()).unwrap();
1926 EmptyValExpectedTy::NonPointer
1927 } else { unimplemented!(); }
1928 } else { unimplemented!(); }
1930 syn::Type::Slice(_) => {
1931 // Option<[]> always implies that we want to treat len() == 0 differently from
1932 // None, so we always map an Option<[]> into a pointer.
1933 write!(w, " == core::ptr::null_mut()").unwrap();
1934 EmptyValExpectedTy::ReferenceAsPointer
1936 _ => unimplemented!(),
1940 /// Prints a suffix to determine if a variable is empty (ie was set by write_empty_rust_val).
1941 pub fn write_empty_rust_val_check<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type, var_access: &str) {
1943 syn::Type::Reference(r) => {
1944 self.write_empty_rust_val_check(generics, w, &*r.elem, var_access);
1946 syn::Type::Path(_) => {
1947 write!(w, "{}", var_access).unwrap();
1948 self.write_empty_rust_val_check_suffix(generics, w, t);
1950 syn::Type::Array(a) => {
1951 if let syn::Expr::Lit(l) = &a.len {
1952 if let syn::Lit::Int(i) = &l.lit {
1953 let arrty = format!("[u8; {}]", i.base10_digits());
1954 // We don't (yet) support a new-var conversion here.
1955 assert!(self.from_c_conversion_new_var_from_path(&arrty, false).is_none());
1957 self.from_c_conversion_prefix_from_path(&arrty, false).unwrap(),
1959 self.from_c_conversion_suffix_from_path(&arrty, false).unwrap()).unwrap();
1960 self.write_empty_rust_val_check_suffix(generics, w, t);
1961 } else { unimplemented!(); }
1962 } else { unimplemented!(); }
1964 _ => unimplemented!(),
1968 // ********************************
1969 // *** Type conversion printing ***
1970 // ********************************
1972 /// Returns true we if can just skip passing this to C entirely
1973 pub fn skip_arg(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> bool {
1975 syn::Type::Path(p) => {
1976 if p.qself.is_some() { unimplemented!(); }
1977 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
1978 self.skip_path(&full_path)
1981 syn::Type::Reference(r) => {
1982 self.skip_arg(&*r.elem, generics)
1987 pub fn no_arg_to_rust<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
1989 syn::Type::Path(p) => {
1990 if p.qself.is_some() { unimplemented!(); }
1991 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
1992 write!(w, "{}", self.no_arg_path_to_rust(&full_path)).unwrap();
1995 syn::Type::Reference(r) => {
1996 self.no_arg_to_rust(w, &*r.elem, generics);
2002 fn write_conversion_inline_intern<W: std::io::Write,
2003 LP: Fn(&str, bool, bool) -> Option<String>, DL: Fn(&mut W, &DeclType, &str, bool, bool), SC: Fn(bool, Option<&str>) -> String>
2004 (&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, is_ref: bool, is_mut: bool, ptr_for_ref: bool,
2005 tupleconv: &str, prefix: bool, sliceconv: SC, path_lookup: LP, decl_lookup: DL) {
2006 match generics.resolve_type(t) {
2007 syn::Type::Reference(r) => {
2008 self.write_conversion_inline_intern(w, &*r.elem, generics, true, r.mutability.is_some(),
2009 ptr_for_ref, tupleconv, prefix, sliceconv, path_lookup, decl_lookup);
2011 syn::Type::Path(p) => {
2012 if p.qself.is_some() {
2016 let resolved_path = self.resolve_path(&p.path, generics);
2017 if let Some(aliased_type) = self.crate_types.type_aliases.get(&resolved_path) {
2018 return self.write_conversion_inline_intern(w, aliased_type, None, is_ref, is_mut, ptr_for_ref, tupleconv, prefix, sliceconv, path_lookup, decl_lookup);
2019 } else if self.is_primitive(&resolved_path) {
2020 if is_ref && prefix {
2021 write!(w, "*").unwrap();
2023 } else if let Some(c_type) = path_lookup(&resolved_path, is_ref, ptr_for_ref) {
2024 write!(w, "{}", c_type).unwrap();
2025 } else if let Some((_, generics)) = self.crate_types.opaques.get(&resolved_path) {
2026 decl_lookup(w, &DeclType::StructImported { generics: &generics }, &resolved_path, is_ref, is_mut);
2027 } else if self.crate_types.mirrored_enums.get(&resolved_path).is_some() {
2028 decl_lookup(w, &DeclType::MirroredEnum, &resolved_path, is_ref, is_mut);
2029 } else if let Some(t) = self.crate_types.traits.get(&resolved_path) {
2030 decl_lookup(w, &DeclType::Trait(t), &resolved_path, is_ref, is_mut);
2031 } else if let Some(ident) = single_ident_generic_path_to_ident(&p.path) {
2032 if let Some(decl_type) = self.types.maybe_resolve_declared(ident) {
2033 decl_lookup(w, decl_type, &self.maybe_resolve_ident(ident).unwrap(), is_ref, is_mut);
2034 } else { unimplemented!(); }
2035 } else { unimplemented!(); }
2037 syn::Type::Array(a) => {
2038 // We assume all arrays contain only [int_literal; X]s.
2039 // This may result in some outputs not compiling.
2040 if let syn::Expr::Lit(l) = &a.len {
2041 if let syn::Lit::Int(i) = &l.lit {
2042 write!(w, "{}", path_lookup(&format!("[u8; {}]", i.base10_digits()), is_ref, ptr_for_ref).unwrap()).unwrap();
2043 } else { unimplemented!(); }
2044 } else { unimplemented!(); }
2046 syn::Type::Slice(s) => {
2047 // We assume all slices contain only literals or references.
2048 // This may result in some outputs not compiling.
2049 if let syn::Type::Path(p) = &*s.elem {
2050 let resolved = self.resolve_path(&p.path, generics);
2051 if self.is_primitive(&resolved) {
2052 write!(w, "{}", path_lookup("[u8]", is_ref, ptr_for_ref).unwrap()).unwrap();
2054 write!(w, "{}", sliceconv(true, None)).unwrap();
2056 } else if let syn::Type::Reference(r) = &*s.elem {
2057 if let syn::Type::Path(p) = &*r.elem {
2058 write!(w, "{}", sliceconv(self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)), None)).unwrap();
2059 } else if let syn::Type::Slice(_) = &*r.elem {
2060 write!(w, "{}", sliceconv(false, None)).unwrap();
2061 } else { unimplemented!(); }
2062 } else if let syn::Type::Tuple(t) = &*s.elem {
2063 assert!(!t.elems.is_empty());
2065 write!(w, "{}", sliceconv(false, None)).unwrap();
2067 let mut needs_map = false;
2068 for e in t.elems.iter() {
2069 if let syn::Type::Reference(_) = e {
2074 let mut map_str = Vec::new();
2075 write!(&mut map_str, ".map(|(").unwrap();
2076 for i in 0..t.elems.len() {
2077 write!(&mut map_str, "{}{}", if i != 0 { ", " } else { "" }, ('a' as u8 + i as u8) as char).unwrap();
2079 write!(&mut map_str, ")| (").unwrap();
2080 for (idx, e) in t.elems.iter().enumerate() {
2081 if let syn::Type::Reference(_) = e {
2082 write!(&mut map_str, "{}{}", if idx != 0 { ", " } else { "" }, (idx as u8 + 'a' as u8) as char).unwrap();
2083 } else if let syn::Type::Path(_) = e {
2084 write!(&mut map_str, "{}*{}", if idx != 0 { ", " } else { "" }, (idx as u8 + 'a' as u8) as char).unwrap();
2085 } else { unimplemented!(); }
2087 write!(&mut map_str, "))").unwrap();
2088 write!(w, "{}", sliceconv(false, Some(&String::from_utf8(map_str).unwrap()))).unwrap();
2090 write!(w, "{}", sliceconv(false, None)).unwrap();
2093 } else if let syn::Type::Array(_) = &*s.elem {
2094 write!(w, "{}", sliceconv(false, Some(".map(|a| *a)"))).unwrap();
2095 } else { unimplemented!(); }
2097 syn::Type::Tuple(t) => {
2098 if t.elems.is_empty() {
2099 // cbindgen has poor support for (), see, eg https://github.com/eqrion/cbindgen/issues/527
2100 // so work around it by just pretending its a 0u8
2101 write!(w, "{}", tupleconv).unwrap();
2103 if prefix { write!(w, "local_").unwrap(); }
2106 _ => unimplemented!(),
2110 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) {
2111 self.write_conversion_inline_intern(w, t, generics, is_ref, false, ptr_for_ref, "() /*", true, |_, _| "local_".to_owned(),
2112 |a, b, c| self.to_c_conversion_inline_prefix_from_path(a, b, c),
2113 |w, decl_type, decl_path, is_ref, _is_mut| {
2115 DeclType::MirroredEnum if is_ref && ptr_for_ref => write!(w, "crate::{}::from_native(", decl_path).unwrap(),
2116 DeclType::MirroredEnum if is_ref => write!(w, "&crate::{}::from_native(", decl_path).unwrap(),
2117 DeclType::MirroredEnum => write!(w, "crate::{}::native_into(", decl_path).unwrap(),
2118 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if is_ref && from_ptr => {
2119 if !ptr_for_ref { write!(w, "&").unwrap(); }
2120 write!(w, "crate::{} {{ inner: unsafe {{ (", decl_path).unwrap()
2122 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if is_ref => {
2123 if !ptr_for_ref { write!(w, "&").unwrap(); }
2124 write!(w, "crate::{} {{ inner: unsafe {{ ObjOps::nonnull_ptr_to_inner((", decl_path).unwrap()
2126 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref && from_ptr =>
2127 write!(w, "crate::{} {{ inner: ", decl_path).unwrap(),
2128 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref =>
2129 write!(w, "crate::{} {{ inner: ObjOps::heap_alloc(", decl_path).unwrap(),
2130 DeclType::Trait(_) if is_ref => write!(w, "").unwrap(),
2131 DeclType::Trait(_) if !is_ref => write!(w, "Into::into(").unwrap(),
2132 _ => panic!("{:?}", decl_path),
2136 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) {
2137 self.write_to_c_conversion_inline_prefix_inner(w, t, generics, false, ptr_for_ref, false);
2139 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) {
2140 self.write_conversion_inline_intern(w, t, generics, is_ref, false, ptr_for_ref, "*/", false, |_, _| ".into()".to_owned(),
2141 |a, b, c| self.to_c_conversion_inline_suffix_from_path(a, b, c),
2142 |w, decl_type, full_path, is_ref, _is_mut| match decl_type {
2143 DeclType::MirroredEnum => write!(w, ")").unwrap(),
2144 DeclType::EnumIgnored { generics }|DeclType::StructImported { generics } if is_ref => {
2145 write!(w, " as *const {}<", full_path).unwrap();
2146 for param in generics.params.iter() {
2147 if let syn::GenericParam::Lifetime(_) = param {
2148 write!(w, "'_, ").unwrap();
2150 write!(w, "_, ").unwrap();
2154 write!(w, ">) as *mut _ }}, is_owned: false }}").unwrap();
2156 write!(w, ">) as *mut _) }}, is_owned: false }}").unwrap();
2159 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref && from_ptr =>
2160 write!(w, ", is_owned: true }}").unwrap(),
2161 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref => write!(w, "), is_owned: true }}").unwrap(),
2162 DeclType::Trait(_) if is_ref => {},
2163 DeclType::Trait(_) => {
2164 // This is used when we're converting a concrete Rust type into a C trait
2165 // for use when a Rust trait method returns an associated type.
2166 // Because all of our C traits implement From<RustTypesImplementingTraits>
2167 // we can just call .into() here and be done.
2168 write!(w, ")").unwrap()
2170 _ => unimplemented!(),
2173 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) {
2174 self.write_to_c_conversion_inline_suffix_inner(w, t, generics, false, ptr_for_ref, false);
2177 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) {
2178 self.write_conversion_inline_intern(w, t, generics, is_ref, false, false, "() /*", true, |_, _| "&local_".to_owned(),
2179 |a, b, _c| self.from_c_conversion_prefix_from_path(a, b),
2180 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
2181 DeclType::StructImported {..} if is_ref => write!(w, "").unwrap(),
2182 DeclType::StructImported {..} if !is_ref => write!(w, "*unsafe {{ Box::from_raw(").unwrap(),
2183 DeclType::MirroredEnum if is_ref => write!(w, "&").unwrap(),
2184 DeclType::MirroredEnum => {},
2185 DeclType::Trait(_) => {},
2186 _ => unimplemented!(),
2189 pub fn write_from_c_conversion_prefix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2190 self.write_from_c_conversion_prefix_inner(w, t, generics, false, false);
2192 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) {
2193 self.write_conversion_inline_intern(w, t, generics, is_ref, false, false, "*/", false,
2194 |has_inner, map_str_opt| match (has_inner, map_str_opt) {
2195 (false, Some(map_str)) => format!(".iter(){}.collect::<Vec<_>>()[..]", map_str),
2196 (false, None) => ".iter().collect::<Vec<_>>()[..]".to_owned(),
2197 (true, None) => "[..]".to_owned(),
2198 (true, Some(_)) => unreachable!(),
2200 |a, b, _c| self.from_c_conversion_suffix_from_path(a, b),
2201 |w, decl_type, _full_path, is_ref, is_mut| match decl_type {
2202 DeclType::StructImported {..} if is_ref && ptr_for_ref => write!(w, "XXX unimplemented").unwrap(),
2203 DeclType::StructImported {..} if is_mut && is_ref => write!(w, ".get_native_mut_ref()").unwrap(),
2204 DeclType::StructImported {..} if is_ref => write!(w, ".get_native_ref()").unwrap(),
2205 DeclType::StructImported {..} if !is_ref => write!(w, ".take_inner()) }}").unwrap(),
2206 DeclType::MirroredEnum if is_ref => write!(w, ".to_native()").unwrap(),
2207 DeclType::MirroredEnum => write!(w, ".into_native()").unwrap(),
2208 DeclType::Trait(_) => {},
2209 _ => unimplemented!(),
2212 pub fn write_from_c_conversion_suffix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2213 self.write_from_c_conversion_suffix_inner(w, t, generics, false, false);
2215 // Note that compared to the above conversion functions, the following two are generally
2216 // significantly undertested:
2217 pub fn write_from_c_conversion_to_ref_prefix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2218 self.write_conversion_inline_intern(w, t, generics, false, false, false, "() /*", true, |_, _| "&local_".to_owned(),
2220 if let Some(conv) = self.from_c_conversion_prefix_from_path(a, b) {
2221 Some(format!("&{}", conv))
2224 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
2225 DeclType::StructImported {..} if !is_ref => write!(w, "").unwrap(),
2226 _ => unimplemented!(),
2229 pub fn write_from_c_conversion_to_ref_suffix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2230 self.write_conversion_inline_intern(w, t, generics, false, false, false, "*/", false,
2231 |has_inner, map_str_opt| match (has_inner, map_str_opt) {
2232 (false, Some(map_str)) => format!(".iter(){}.collect::<Vec<_>>()[..]", map_str),
2233 (false, None) => ".iter().collect::<Vec<_>>()[..]".to_owned(),
2234 (true, None) => "[..]".to_owned(),
2235 (true, Some(_)) => unreachable!(),
2237 |a, b, _c| self.from_c_conversion_suffix_from_path(a, b),
2238 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
2239 DeclType::StructImported {..} if !is_ref => write!(w, ".get_native_ref()").unwrap(),
2240 _ => unimplemented!(),
2244 fn write_conversion_new_var_intern<'b, W: std::io::Write,
2245 LP: Fn(&str, bool) -> Option<(&str, &str)>,
2246 LC: Fn(&str, bool, Option<&syn::Type>, &syn::Ident, &str) -> Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)>,
2247 VP: Fn(&mut W, &syn::Type, Option<&GenericTypes>, bool, bool, bool),
2248 VS: Fn(&mut W, &syn::Type, Option<&GenericTypes>, bool, bool, bool)>
2249 (&self, w: &mut W, ident: &syn::Ident, var: &str, t: &syn::Type, generics: Option<&GenericTypes>,
2250 mut is_ref: bool, mut ptr_for_ref: bool, to_c: bool, from_ownable_ref: bool,
2251 path_lookup: &LP, container_lookup: &LC, var_prefix: &VP, var_suffix: &VS) -> bool {
2253 macro_rules! convert_container {
2254 ($container_type: expr, $args_len: expr, $args_iter: expr) => { {
2255 // For slices (and Options), we refuse to directly map them as is_ref when they
2256 // aren't opaque types containing an inner pointer. This is due to the fact that,
2257 // in both cases, the actual higher-level type is non-is_ref.
2258 let (ty_has_inner, ty_is_trait) = if $args_len == 1 {
2259 let ty = $args_iter().next().unwrap();
2260 if $container_type == "Slice" && to_c {
2261 // "To C ptr_for_ref" means "return the regular object with is_owned
2262 // set to false", which is totally what we want in a slice if we're about to
2263 // set ty_has_inner.
2266 if let syn::Type::Reference(t) = ty {
2267 if let syn::Type::Path(p) = &*t.elem {
2268 let resolved = self.resolve_path(&p.path, generics);
2269 (self.c_type_has_inner_from_path(&resolved), self.crate_types.traits.get(&resolved).is_some())
2270 } else { (false, false) }
2271 } else if let syn::Type::Path(p) = ty {
2272 let resolved = self.resolve_path(&p.path, generics);
2273 (self.c_type_has_inner_from_path(&resolved), self.crate_types.traits.get(&resolved).is_some())
2274 } else { (false, false) }
2275 } else { (true, false) };
2277 // Options get a bunch of special handling, since in general we map Option<>al
2278 // types into the same C type as non-Option-wrapped types. This ends up being
2279 // pretty manual here and most of the below special-cases are for Options.
2280 let mut needs_ref_map = false;
2281 let mut only_contained_type = None;
2282 let mut only_contained_type_nonref = None;
2283 let mut only_contained_has_inner = false;
2284 let mut contains_slice = false;
2286 only_contained_has_inner = ty_has_inner;
2287 let arg = $args_iter().next().unwrap();
2288 if let syn::Type::Reference(t) = arg {
2289 only_contained_type = Some(arg);
2290 only_contained_type_nonref = Some(&*t.elem);
2291 if let syn::Type::Path(_) = &*t.elem {
2293 } else if let syn::Type::Slice(_) = &*t.elem {
2294 contains_slice = true;
2295 } else { return false; }
2296 // If the inner element contains an inner pointer, we will just use that,
2297 // avoiding the need to map elements to references. Otherwise we'll need to
2298 // do an extra mapping step.
2299 needs_ref_map = !only_contained_has_inner && !ty_is_trait && $container_type == "Option";
2301 only_contained_type = Some(arg);
2302 only_contained_type_nonref = Some(arg);
2306 if let Some((prefix, conversions, suffix, prefix_location)) = container_lookup(&$container_type, is_ref, only_contained_type, ident, var) {
2307 assert_eq!(conversions.len(), $args_len);
2308 write!(w, "let mut local_{}{} = ", ident,
2309 if (!to_c && needs_ref_map) || (to_c && $container_type == "Option" && contains_slice) {"_base"} else { "" }).unwrap();
2310 if prefix_location == ContainerPrefixLocation::OutsideConv {
2311 var_prefix(w, $args_iter().next().unwrap(), generics, is_ref, ptr_for_ref, true);
2313 write!(w, "{}{}", prefix, var).unwrap();
2315 for ((pfx, var_name), (idx, ty)) in conversions.iter().zip($args_iter().enumerate()) {
2316 let mut var = std::io::Cursor::new(Vec::new());
2317 write!(&mut var, "{}", var_name).unwrap();
2318 let var_access = String::from_utf8(var.into_inner()).unwrap();
2320 let conv_ty = if needs_ref_map { only_contained_type_nonref.as_ref().unwrap() } else { ty };
2322 write!(w, "{} {{ ", pfx).unwrap();
2323 let new_var_name = format!("{}_{}", ident, idx);
2324 let new_var = self.write_conversion_new_var_intern(w, &format_ident!("{}", new_var_name),
2325 &var_access, conv_ty, generics, contains_slice || (is_ref && ty_has_inner), ptr_for_ref,
2326 to_c, from_ownable_ref, path_lookup, container_lookup, var_prefix, var_suffix);
2327 if new_var { write!(w, " ").unwrap(); }
2329 if prefix_location == ContainerPrefixLocation::PerConv {
2330 var_prefix(w, conv_ty, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2331 } else if !is_ref && !needs_ref_map && to_c && only_contained_has_inner {
2332 write!(w, "ObjOps::heap_alloc(").unwrap();
2335 write!(w, "{}{}", if contains_slice && !to_c { "local_" } else { "" }, if new_var { new_var_name } else { var_access }).unwrap();
2336 if prefix_location == ContainerPrefixLocation::PerConv {
2337 var_suffix(w, conv_ty, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2338 } else if !is_ref && !needs_ref_map && to_c && only_contained_has_inner {
2339 write!(w, ")").unwrap();
2341 write!(w, " }}").unwrap();
2343 write!(w, "{}", suffix).unwrap();
2344 if prefix_location == ContainerPrefixLocation::OutsideConv {
2345 var_suffix(w, $args_iter().next().unwrap(), generics, is_ref, ptr_for_ref, true);
2347 write!(w, ";").unwrap();
2348 if !to_c && needs_ref_map {
2349 write!(w, " let mut local_{} = local_{}_base.as_ref()", ident, ident).unwrap();
2351 write!(w, ".map(|a| &a[..])").unwrap();
2353 write!(w, ";").unwrap();
2354 } else if to_c && $container_type == "Option" && contains_slice {
2355 write!(w, " let mut local_{} = *local_{}_base;", ident, ident).unwrap();
2362 match generics.resolve_type(t) {
2363 syn::Type::Reference(r) => {
2364 if let syn::Type::Slice(_) = &*r.elem {
2365 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)
2367 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)
2370 syn::Type::Path(p) => {
2371 if p.qself.is_some() {
2374 let resolved_path = self.resolve_path(&p.path, generics);
2375 if let Some(aliased_type) = self.crate_types.type_aliases.get(&resolved_path) {
2376 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);
2378 if self.is_known_container(&resolved_path, is_ref) || self.is_path_transparent_container(&p.path, generics, is_ref) {
2379 if let syn::PathArguments::AngleBracketed(args) = &p.path.segments.iter().next().unwrap().arguments {
2380 convert_container!(resolved_path, args.args.len(), || args.args.iter().map(|arg| {
2381 if let syn::GenericArgument::Type(ty) = arg {
2382 generics.resolve_type(ty)
2383 } else { unimplemented!(); }
2385 } else { unimplemented!(); }
2387 if self.is_primitive(&resolved_path) {
2389 } else if let Some(ty_ident) = single_ident_generic_path_to_ident(&p.path) {
2390 if let Some((prefix, suffix)) = path_lookup(&resolved_path, is_ref) {
2391 write!(w, "let mut local_{} = {}{}{};", ident, prefix, var, suffix).unwrap();
2393 } else if self.types.maybe_resolve_declared(ty_ident).is_some() {
2398 syn::Type::Array(_) => {
2399 // We assume all arrays contain only primitive types.
2400 // This may result in some outputs not compiling.
2403 syn::Type::Slice(s) => {
2404 if let syn::Type::Path(p) = &*s.elem {
2405 let resolved = self.resolve_path(&p.path, generics);
2406 if self.is_primitive(&resolved) {
2407 let slice_path = format!("[{}]", resolved);
2408 if let Some((prefix, suffix)) = path_lookup(&slice_path, true) {
2409 write!(w, "let mut local_{} = {}{}{};", ident, prefix, var, suffix).unwrap();
2413 let tyref = [&*s.elem];
2415 // If we're converting from a slice to a Vec, assume we can clone the
2416 // elements and clone them into a new Vec first. Next we'll walk the
2417 // new Vec here and convert them to C types.
2418 write!(w, "let mut local_{}_clone = Vec::new(); local_{}_clone.extend_from_slice({}); let mut {} = local_{}_clone; ", ident, ident, ident, ident, ident).unwrap();
2421 convert_container!("Vec", 1, || tyref.iter().map(|t| generics.resolve_type(*t)));
2422 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2424 } else if let syn::Type::Reference(ty) = &*s.elem {
2425 let tyref = if from_ownable_ref || !to_c { [&*ty.elem] } else { [&*s.elem] };
2427 convert_container!("Slice", 1, || tyref.iter().map(|t| generics.resolve_type(*t)));
2428 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2429 } else if let syn::Type::Tuple(t) = &*s.elem {
2430 // When mapping into a temporary new var, we need to own all the underlying objects.
2431 // Thus, we drop any references inside the tuple and convert with non-reference types.
2432 let mut elems = syn::punctuated::Punctuated::new();
2433 for elem in t.elems.iter() {
2434 if let syn::Type::Reference(r) = elem {
2435 elems.push((*r.elem).clone());
2437 elems.push(elem.clone());
2440 let ty = [syn::Type::Tuple(syn::TypeTuple {
2441 paren_token: t.paren_token, elems
2445 convert_container!("Slice", 1, || ty.iter());
2446 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2447 } else if let syn::Type::Array(_) = &*s.elem {
2450 let arr_elem = [(*s.elem).clone()];
2451 convert_container!("Slice", 1, || arr_elem.iter());
2452 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2453 } else { unimplemented!() }
2455 syn::Type::Tuple(t) => {
2456 if !t.elems.is_empty() {
2457 // We don't (yet) support tuple elements which cannot be converted inline
2458 write!(w, "let (").unwrap();
2459 for idx in 0..t.elems.len() {
2460 if idx != 0 { write!(w, ", ").unwrap(); }
2461 write!(w, "{} orig_{}_{}", if is_ref { "ref" } else { "mut" }, ident, idx).unwrap();
2463 write!(w, ") = {}{}; ", var, if !to_c { ".to_rust()" } else { "" }).unwrap();
2464 // Like other template types, tuples are always mapped as their non-ref
2465 // versions for types which have different ref mappings. Thus, we convert to
2466 // non-ref versions and handle opaque types with inner pointers manually.
2467 for (idx, elem) in t.elems.iter().enumerate() {
2468 if let syn::Type::Path(p) = elem {
2469 let v_name = format!("orig_{}_{}", ident, idx);
2470 let tuple_elem_ident = format_ident!("{}", &v_name);
2471 if self.write_conversion_new_var_intern(w, &tuple_elem_ident, &v_name, elem, generics,
2472 false, ptr_for_ref, to_c, from_ownable_ref,
2473 path_lookup, container_lookup, var_prefix, var_suffix) {
2474 write!(w, " ").unwrap();
2475 // Opaque types with inner pointers shouldn't ever create new stack
2476 // variables, so we don't handle it and just assert that it doesn't
2478 assert!(!self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)));
2482 write!(w, "let mut local_{} = (", ident).unwrap();
2483 for (idx, elem) in t.elems.iter().enumerate() {
2484 let real_elem = generics.resolve_type(&elem);
2485 let ty_has_inner = {
2487 // "To C ptr_for_ref" means "return the regular object with
2488 // is_owned set to false", which is totally what we want
2489 // if we're about to set ty_has_inner.
2492 if let syn::Type::Reference(t) = real_elem {
2493 if let syn::Type::Path(p) = &*t.elem {
2494 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
2496 } else if let syn::Type::Path(p) = real_elem {
2497 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
2500 if idx != 0 { write!(w, ", ").unwrap(); }
2501 var_prefix(w, real_elem, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2502 if is_ref && ty_has_inner {
2503 // For ty_has_inner, the regular var_prefix mapping will take a
2504 // reference, so deref once here to make sure we keep the original ref.
2505 write!(w, "*").unwrap();
2507 write!(w, "orig_{}_{}", ident, idx).unwrap();
2508 if is_ref && !ty_has_inner {
2509 // If we don't have an inner variable's reference to maintain, just
2510 // hope the type is Clonable and use that.
2511 write!(w, ".clone()").unwrap();
2513 var_suffix(w, real_elem, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2515 write!(w, "){};", if to_c { ".into()" } else { "" }).unwrap();
2519 _ => unimplemented!(),
2523 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 {
2524 self.write_conversion_new_var_intern(w, ident, var_access, t, generics, from_ownable_ref, ptr_for_ref, true, from_ownable_ref,
2525 &|a, b| self.to_c_conversion_new_var_from_path(a, b),
2526 &|a, b, c, d, e| self.to_c_conversion_container_new_var(generics, a, b, c, d, e),
2527 // We force ptr_for_ref here since we can't generate a ref on one line and use it later
2528 &|a, b, c, d, e, f| self.write_to_c_conversion_inline_prefix_inner(a, b, c, d, e, f),
2529 &|a, b, c, d, e, f| self.write_to_c_conversion_inline_suffix_inner(a, b, c, d, e, f))
2531 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 {
2532 self.write_to_c_conversion_new_var_inner(w, ident, &format!("{}", ident), t, generics, ptr_for_ref, false)
2534 /// Prints new-var conversion for an "ownable_ref" type, ie prints conversion for
2535 /// `create_ownable_reference(t)`, not `t` itself.
2536 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 {
2537 self.write_to_c_conversion_new_var_inner(w, ident, &format!("{}", ident), t, generics, true, true)
2539 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 {
2540 self.write_conversion_new_var_intern(w, ident, &format!("{}", ident), t, generics, false, false, false, false,
2541 &|a, b| self.from_c_conversion_new_var_from_path(a, b),
2542 &|a, b, c, d, e| self.from_c_conversion_container_new_var(generics, a, b, c, d, e),
2543 // We force ptr_for_ref here since we can't generate a ref on one line and use it later
2544 &|a, b, c, d, e, _f| self.write_from_c_conversion_prefix_inner(a, b, c, d, e),
2545 &|a, b, c, d, e, _f| self.write_from_c_conversion_suffix_inner(a, b, c, d, e))
2548 // ******************************************************
2549 // *** C Container Type Equivalent and alias Printing ***
2550 // ******************************************************
2552 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 {
2553 for (idx, orig_t) in args.enumerate() {
2555 write!(w, ", ").unwrap();
2557 let t = generics.resolve_type(orig_t);
2558 if let syn::Type::Reference(r_arg) = t {
2559 assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
2561 if !self.write_c_type_intern(w, &*r_arg.elem, generics, false, false, false, true, true) { return false; }
2563 // While write_c_type_intern, above is correct, we don't want to blindly convert a
2564 // reference to something stupid, so check that the container is either opaque or a
2565 // predefined type (currently only Transaction).
2566 if let syn::Type::Path(p_arg) = &*r_arg.elem {
2567 let resolved = self.resolve_path(&p_arg.path, generics);
2568 assert!(self.crate_types.opaques.get(&resolved).is_some() ||
2569 self.crate_types.traits.get(&resolved).is_some() ||
2570 self.c_type_from_path(&resolved, true, true).is_some(), "Template generics should be opaque or have a predefined mapping");
2571 } else { unimplemented!(); }
2572 } else if let syn::Type::Path(p_arg) = t {
2573 if let Some(resolved) = self.maybe_resolve_path(&p_arg.path, generics) {
2574 if !self.is_primitive(&resolved) {
2575 assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
2578 assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
2580 if !self.write_c_type_intern(w, t, generics, false, false, false, true, true) { return false; }
2582 // We don't currently support outer reference types for non-primitive inners,
2583 // except for the empty tuple.
2584 if let syn::Type::Tuple(t_arg) = t {
2585 assert!(t_arg.elems.len() == 0 || !is_ref);
2589 if !self.write_c_type_intern(w, t, generics, false, false, false, true, true) { return false; }
2594 fn check_create_container(&self, mangled_container: String, container_type: &str, args: Vec<&syn::Type>, generics: Option<&GenericTypes>, is_ref: bool) -> bool {
2595 if !self.crate_types.templates_defined.borrow().get(&mangled_container).is_some() {
2596 let mut created_container: Vec<u8> = Vec::new();
2598 if container_type == "Result" {
2599 let mut a_ty: Vec<u8> = Vec::new();
2600 if let syn::Type::Tuple(tup) = args.iter().next().unwrap() {
2601 if tup.elems.is_empty() {
2602 write!(&mut a_ty, "()").unwrap();
2604 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t).take(1), generics, is_ref) { return false; }
2607 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t).take(1), generics, is_ref) { return false; }
2610 let mut b_ty: Vec<u8> = Vec::new();
2611 if let syn::Type::Tuple(tup) = args.iter().skip(1).next().unwrap() {
2612 if tup.elems.is_empty() {
2613 write!(&mut b_ty, "()").unwrap();
2615 if !self.write_template_generics(&mut b_ty, &mut args.iter().map(|t| *t).skip(1), generics, is_ref) { return false; }
2618 if !self.write_template_generics(&mut b_ty, &mut args.iter().map(|t| *t).skip(1), generics, is_ref) { return false; }
2621 let ok_str = String::from_utf8(a_ty).unwrap();
2622 let err_str = String::from_utf8(b_ty).unwrap();
2623 let is_clonable = self.is_clonable(&ok_str) && self.is_clonable(&err_str);
2624 write_result_block(&mut created_container, &mangled_container, &ok_str, &err_str, is_clonable);
2626 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2628 } else if container_type == "Vec" {
2629 let mut a_ty: Vec<u8> = Vec::new();
2630 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t), generics, is_ref) { return false; }
2631 let ty = String::from_utf8(a_ty).unwrap();
2632 let is_clonable = self.is_clonable(&ty);
2633 write_vec_block(&mut created_container, &mangled_container, &ty, is_clonable);
2635 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2637 } else if container_type.ends_with("Tuple") {
2638 let mut tuple_args = Vec::new();
2639 let mut is_clonable = true;
2640 for arg in args.iter() {
2641 let mut ty: Vec<u8> = Vec::new();
2642 if !self.write_template_generics(&mut ty, &mut [arg].iter().map(|t| **t), generics, is_ref) { return false; }
2643 let ty_str = String::from_utf8(ty).unwrap();
2644 if !self.is_clonable(&ty_str) {
2645 is_clonable = false;
2647 tuple_args.push(ty_str);
2649 write_tuple_block(&mut created_container, &mangled_container, &tuple_args, is_clonable);
2651 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2653 } else if container_type == "Option" {
2654 let mut a_ty: Vec<u8> = Vec::new();
2655 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t), generics, is_ref) { return false; }
2656 let ty = String::from_utf8(a_ty).unwrap();
2657 let is_clonable = self.is_clonable(&ty);
2658 write_option_block(&mut created_container, &mangled_container, &ty, is_clonable);
2660 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2665 self.crate_types.write_new_template(mangled_container.clone(), true, &created_container);
2669 fn path_to_generic_args(path: &syn::Path) -> Vec<&syn::Type> {
2670 if let syn::PathArguments::AngleBracketed(args) = &path.segments.iter().next().unwrap().arguments {
2671 args.args.iter().map(|gen| if let syn::GenericArgument::Type(t) = gen { t } else { unimplemented!() }).collect()
2672 } else { unimplemented!(); }
2674 fn write_c_mangled_container_path_intern<W: std::io::Write>
2675 (&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 {
2676 let mut mangled_type: Vec<u8> = Vec::new();
2677 if !self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) {
2678 write!(w, "C{}_", ident).unwrap();
2679 write!(mangled_type, "C{}_", ident).unwrap();
2680 } else { assert_eq!(args.len(), 1); }
2681 for arg in args.iter() {
2682 macro_rules! write_path {
2683 ($p_arg: expr, $extra_write: expr) => {
2684 if let Some(subtype) = self.maybe_resolve_path(&$p_arg.path, generics) {
2685 if self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) {
2687 if self.c_type_has_inner_from_path(&subtype) {
2688 if !self.write_c_path_intern(w, &$p_arg.path, generics, is_ref, is_mut, ptr_for_ref, false, true) { return false; }
2690 if let Some(arr_ty) = self.is_real_type_array(&subtype) {
2691 if !self.write_c_type_intern(w, &arr_ty, generics, false, true, false, false, true) { return false; }
2693 // Option<T> needs to be converted to a *mut T, ie mut ptr-for-ref
2694 if !self.write_c_path_intern(w, &$p_arg.path, generics, true, true, true, false, true) { return false; }
2698 write!(w, "{}", $p_arg.path.segments.last().unwrap().ident).unwrap();
2700 } else if self.is_known_container(&subtype, is_ref) || self.is_path_transparent_container(&$p_arg.path, generics, is_ref) {
2701 if !self.write_c_mangled_container_path_intern(w, Self::path_to_generic_args(&$p_arg.path), generics,
2702 &subtype, is_ref, is_mut, ptr_for_ref, true) {
2705 self.write_c_mangled_container_path_intern(&mut mangled_type, Self::path_to_generic_args(&$p_arg.path),
2706 generics, &subtype, is_ref, is_mut, ptr_for_ref, true);
2707 if let Some(w2) = $extra_write as Option<&mut Vec<u8>> {
2708 self.write_c_mangled_container_path_intern(w2, Self::path_to_generic_args(&$p_arg.path),
2709 generics, &subtype, is_ref, is_mut, ptr_for_ref, true);
2712 let id = subtype.rsplitn(2, ':').next().unwrap(); // Get the "Base" name of the resolved type
2713 write!(w, "{}", id).unwrap();
2714 write!(mangled_type, "{}", id).unwrap();
2715 if let Some(w2) = $extra_write as Option<&mut Vec<u8>> {
2716 write!(w2, "{}", id).unwrap();
2719 } else { return false; }
2722 match generics.resolve_type(arg) {
2723 syn::Type::Tuple(tuple) => {
2724 if tuple.elems.len() == 0 {
2725 write!(w, "None").unwrap();
2726 write!(mangled_type, "None").unwrap();
2728 let mut mangled_tuple_type: Vec<u8> = Vec::new();
2730 // Figure out what the mangled type should look like. To disambiguate
2731 // ((A, B), C) and (A, B, C) we prefix the generic args with a _ and suffix
2732 // them with a Z. Ideally we wouldn't use Z, but not many special chars are
2733 // available for use in type names.
2734 write!(w, "C{}Tuple_", tuple.elems.len()).unwrap();
2735 write!(mangled_type, "C{}Tuple_", tuple.elems.len()).unwrap();
2736 write!(mangled_tuple_type, "C{}Tuple_", tuple.elems.len()).unwrap();
2737 for elem in tuple.elems.iter() {
2738 if let syn::Type::Path(p) = elem {
2739 write_path!(p, Some(&mut mangled_tuple_type));
2740 } else if let syn::Type::Reference(refelem) = elem {
2741 if let syn::Type::Path(p) = &*refelem.elem {
2742 write_path!(p, Some(&mut mangled_tuple_type));
2743 } else { return false; }
2744 } else { return false; }
2746 write!(w, "Z").unwrap();
2747 write!(mangled_type, "Z").unwrap();
2748 write!(mangled_tuple_type, "Z").unwrap();
2749 if !self.check_create_container(String::from_utf8(mangled_tuple_type).unwrap(),
2750 &format!("{}Tuple", tuple.elems.len()), tuple.elems.iter().collect(), generics, is_ref) {
2755 syn::Type::Path(p_arg) => {
2756 write_path!(p_arg, None);
2758 syn::Type::Reference(refty) => {
2759 if let syn::Type::Path(p_arg) = &*refty.elem {
2760 write_path!(p_arg, None);
2761 } else if let syn::Type::Slice(_) = &*refty.elem {
2762 // write_c_type will actually do exactly what we want here, we just need to
2763 // make it a pointer so that its an option. Note that we cannot always convert
2764 // the Vec-as-slice (ie non-ref types) containers, so sometimes need to be able
2765 // to edit it, hence we use *mut here instead of *const.
2766 if args.len() != 1 { return false; }
2767 write!(w, "*mut ").unwrap();
2768 self.write_c_type(w, arg, None, true);
2769 } else { return false; }
2771 syn::Type::Array(a) => {
2772 if let syn::Type::Path(p_arg) = &*a.elem {
2773 let resolved = self.resolve_path(&p_arg.path, generics);
2774 if !self.is_primitive(&resolved) { return false; }
2775 if let syn::Expr::Lit(syn::ExprLit { lit: syn::Lit::Int(len), .. }) = &a.len {
2776 if self.c_type_from_path(&format!("[{}; {}]", resolved, len.base10_digits()), is_ref, ptr_for_ref).is_none() { return false; }
2777 if in_type || args.len() != 1 {
2778 write!(w, "_{}{}", resolved, len.base10_digits()).unwrap();
2779 write!(mangled_type, "_{}{}", resolved, len.base10_digits()).unwrap();
2781 let arrty = format!("[{}; {}]", resolved, len.base10_digits());
2782 let realty = self.c_type_from_path(&arrty, is_ref, ptr_for_ref).unwrap_or(&arrty);
2783 write!(w, "{}", realty).unwrap();
2784 write!(mangled_type, "{}", realty).unwrap();
2786 } else { return false; }
2787 } else { return false; }
2789 _ => { return false; },
2792 if self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) { return true; }
2793 // Push the "end of type" Z
2794 write!(w, "Z").unwrap();
2795 write!(mangled_type, "Z").unwrap();
2797 // Make sure the type is actually defined:
2798 self.check_create_container(String::from_utf8(mangled_type).unwrap(), ident, args, generics, is_ref)
2800 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 {
2801 if !self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) {
2802 write!(w, "{}::", Self::generated_container_path()).unwrap();
2804 self.write_c_mangled_container_path_intern(w, args, generics, ident, is_ref, is_mut, ptr_for_ref, false)
2806 pub fn get_c_mangled_container_type(&self, args: Vec<&syn::Type>, generics: Option<&GenericTypes>, template_name: &str) -> Option<String> {
2807 let mut out = Vec::new();
2808 if !self.write_c_mangled_container_path(&mut out, args, generics, template_name, false, false, false) {
2811 Some(String::from_utf8(out).unwrap())
2814 // **********************************
2815 // *** C Type Equivalent Printing ***
2816 // **********************************
2818 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 {
2819 let full_path = match self.maybe_resolve_path(&path, generics) {
2820 Some(path) => path, None => return false };
2821 if let Some(c_type) = self.c_type_from_path(&full_path, is_ref, ptr_for_ref) {
2822 write!(w, "{}", c_type).unwrap();
2824 } else if self.crate_types.traits.get(&full_path).is_some() {
2825 // Note that we always use the crate:: prefix here as we are always referring to a
2826 // concrete object which is of the generated type, it just implements the upstream
2828 if is_ref && ptr_for_ref {
2829 write!(w, "*{} crate::{}", if is_mut { "mut" } else { "const" }, full_path).unwrap();
2831 if with_ref_lifetime { unimplemented!(); }
2832 write!(w, "&{}crate::{}", if is_mut { "mut " } else { "" }, full_path).unwrap();
2834 write!(w, "crate::{}", full_path).unwrap();
2837 } else if self.crate_types.opaques.get(&full_path).is_some() || self.crate_types.mirrored_enums.get(&full_path).is_some() {
2838 let crate_pfx = if c_ty { "crate::" } else { "" };
2839 if is_ref && ptr_for_ref {
2840 // ptr_for_ref implies we're returning the object, which we can't really do for
2841 // opaque or mirrored types without box'ing them, which is quite a waste, so return
2842 // the actual object itself (for opaque types we'll set the pointer to the actual
2843 // type and note that its a reference).
2844 write!(w, "{}{}", crate_pfx, full_path).unwrap();
2845 } else if is_ref && with_ref_lifetime {
2847 // If we're concretizing something with a lifetime parameter, we have to pick a
2848 // lifetime, of which the only real available choice is `static`, obviously.
2849 write!(w, "&'static {}", crate_pfx).unwrap();
2851 self.write_rust_path(w, generics, path, with_ref_lifetime, false);
2853 // We shouldn't be mapping references in types, so panic here
2857 write!(w, "&{}{}{}", if is_mut { "mut " } else { "" }, crate_pfx, full_path).unwrap();
2859 write!(w, "{}{}", crate_pfx, full_path).unwrap();
2866 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 {
2867 match generics.resolve_type(t) {
2868 syn::Type::Path(p) => {
2869 if p.qself.is_some() {
2872 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
2873 if self.is_known_container(&full_path, is_ref) || self.is_path_transparent_container(&p.path, generics, is_ref) {
2874 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);
2876 if let Some(aliased_type) = self.crate_types.type_aliases.get(&full_path).cloned() {
2877 return self.write_c_type_intern(w, &aliased_type, None, is_ref, is_mut, ptr_for_ref, with_ref_lifetime, c_ty);
2880 self.write_c_path_intern(w, &p.path, generics, is_ref, is_mut, ptr_for_ref, with_ref_lifetime, c_ty)
2882 syn::Type::Reference(r) => {
2883 self.write_c_type_intern(w, &*r.elem, generics, true, r.mutability.is_some(), ptr_for_ref, with_ref_lifetime, c_ty)
2885 syn::Type::Array(a) => {
2886 if is_ref && is_mut {
2887 write!(w, "*mut [").unwrap();
2888 if !self.write_c_type_intern(w, &a.elem, generics, false, false, ptr_for_ref, with_ref_lifetime, c_ty) { return false; }
2890 write!(w, "*const [").unwrap();
2891 if !self.write_c_type_intern(w, &a.elem, generics, false, false, ptr_for_ref, with_ref_lifetime, c_ty) { return false; }
2893 let mut typecheck = Vec::new();
2894 if !self.write_c_type_intern(&mut typecheck, &a.elem, generics, false, false, ptr_for_ref, with_ref_lifetime, c_ty) { return false; }
2895 if typecheck[..] != ['u' as u8, '8' as u8] { return false; }
2897 if let syn::Expr::Lit(l) = &a.len {
2898 if let syn::Lit::Int(i) = &l.lit {
2900 if let Some(ty) = self.c_type_from_path(&format!("[u8; {}]", i.base10_digits()), false, ptr_for_ref) {
2901 write!(w, "{}", ty).unwrap();
2905 write!(w, "; {}]", i).unwrap();
2911 syn::Type::Slice(s) => {
2912 if !is_ref || is_mut { return false; }
2913 if let syn::Type::Path(p) = &*s.elem {
2914 let resolved = self.resolve_path(&p.path, generics);
2915 if self.is_primitive(&resolved) {
2916 write!(w, "{}::{}slice", Self::container_templ_path(), resolved).unwrap();
2919 let mut inner_c_ty = Vec::new();
2920 assert!(self.write_c_path_intern(&mut inner_c_ty, &p.path, generics, true, false, ptr_for_ref, with_ref_lifetime, c_ty));
2921 if self.is_clonable(&String::from_utf8(inner_c_ty).unwrap()) {
2922 if let Some(id) = p.path.get_ident() {
2923 let mangled_container = format!("CVec_{}Z", id);
2924 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
2925 self.check_create_container(mangled_container, "Vec", vec![&*s.elem], generics, false)
2929 } else if let syn::Type::Reference(r) = &*s.elem {
2930 if let syn::Type::Path(p) = &*r.elem {
2931 // Slices with "real types" inside are mapped as the equivalent non-ref Vec
2932 let resolved = self.resolve_path(&p.path, generics);
2933 let mangled_container = if let Some((ident, _)) = self.crate_types.opaques.get(&resolved) {
2934 format!("CVec_{}Z", ident)
2935 } else if let Some(en) = self.crate_types.mirrored_enums.get(&resolved) {
2936 format!("CVec_{}Z", en.ident)
2937 } else if let Some(id) = p.path.get_ident() {
2938 format!("CVec_{}Z", id)
2939 } else { return false; };
2940 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
2941 self.check_create_container(mangled_container, "Vec", vec![&*r.elem], generics, false)
2942 } else if let syn::Type::Slice(sl2) = &*r.elem {
2943 if let syn::Type::Reference(r2) = &*sl2.elem {
2944 if let syn::Type::Path(p) = &*r2.elem {
2945 // Slices with slices with opaque types (with is_owned flags) are mapped as non-ref Vecs
2946 let resolved = self.resolve_path(&p.path, generics);
2947 let mangled_container = if let Some((ident, _)) = self.crate_types.opaques.get(&resolved) {
2948 format!("CVec_CVec_{}ZZ", ident)
2949 } else { return false; };
2950 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
2951 let inner = &r2.elem;
2952 let vec_ty: syn::Type = syn::parse_quote!(Vec<#inner>);
2953 self.check_create_container(mangled_container, "Vec", vec![&vec_ty], generics, false)
2957 } else if let syn::Type::Tuple(_) = &*s.elem {
2958 let mut args = syn::punctuated::Punctuated::<_, syn::token::Comma>::new();
2959 args.push(syn::GenericArgument::Type((*s.elem).clone()));
2960 let mut segments = syn::punctuated::Punctuated::new();
2961 segments.push(parse_quote!(Vec<#args>));
2962 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)
2963 } else if let syn::Type::Array(a) = &*s.elem {
2964 if let syn::Expr::Lit(l) = &a.len {
2965 if let syn::Lit::Int(i) = &l.lit {
2966 let mut buf = Vec::new();
2967 self.write_rust_type(&mut buf, generics, &*a.elem, false);
2968 let arr_ty = String::from_utf8(buf).unwrap();
2970 let arr_str = format!("[{}; {}]", arr_ty, i.base10_digits());
2971 let ty = self.c_type_from_path(&arr_str, false, ptr_for_ref).unwrap()
2972 .rsplitn(2, "::").next().unwrap();
2974 let mangled_container = format!("CVec_{}Z", ty);
2975 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
2976 self.check_create_container(mangled_container, "Vec", vec![&*s.elem], generics, false)
2981 syn::Type::Tuple(t) => {
2982 if t.elems.len() == 0 {
2985 self.write_c_mangled_container_path(w, t.elems.iter().collect(), generics,
2986 &format!("{}Tuple", t.elems.len()), is_ref, is_mut, ptr_for_ref)
2992 pub fn write_c_type<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, ptr_for_ref: bool) {
2993 assert!(self.write_c_type_intern(w, t, generics, false, false, ptr_for_ref, false, true));
2995 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) {
2996 assert!(self.write_c_type_intern(w, t, generics, false, false, ptr_for_ref, true, false));
2998 pub fn understood_c_path(&self, p: &syn::Path) -> bool {
2999 self.write_c_path_intern(&mut std::io::sink(), p, None, false, false, false, false, true)
3001 pub fn understood_c_type(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> bool {
3002 self.write_c_type_intern(&mut std::io::sink(), t, generics, false, false, false, false, true)