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 library: &'crate_lft FullLibraryAST,
444 module_path: &'mod_lifetime str,
445 imports: HashMap<syn::Ident, (String, syn::Path)>,
446 declared: HashMap<syn::Ident, DeclType<'crate_lft>>,
447 priv_modules: HashSet<syn::Ident>,
449 impl<'mod_lifetime, 'crate_lft: 'mod_lifetime> ImportResolver<'mod_lifetime, 'crate_lft> {
450 fn walk_use_intern<F: FnMut(syn::Ident, (String, syn::Path))>(
451 crate_name: &str, module_path: &str, dependencies: &HashSet<syn::Ident>, u: &syn::UseTree,
453 mut path: syn::punctuated::Punctuated<syn::PathSegment, syn::token::Colon2>, handle_use: &mut F
456 macro_rules! push_path {
457 ($ident: expr, $path_suffix: expr) => {
458 if partial_path == "" && format!("{}", $ident) == "super" {
459 let mut mod_iter = module_path.rsplitn(2, "::");
460 mod_iter.next().unwrap();
461 let super_mod = mod_iter.next().unwrap();
462 new_path = format!("{}{}", super_mod, $path_suffix);
463 assert_eq!(path.len(), 0);
464 for module in super_mod.split("::") {
465 path.push(syn::PathSegment { ident: syn::Ident::new(module, Span::call_site()), arguments: syn::PathArguments::None });
467 } else if partial_path == "" && format!("{}", $ident) == "self" {
468 new_path = format!("{}{}", module_path, $path_suffix);
469 for module in module_path.split("::") {
470 path.push(syn::PathSegment { ident: syn::Ident::new(module, Span::call_site()), arguments: syn::PathArguments::None });
472 } else if partial_path == "" && format!("{}", $ident) == "crate" {
473 new_path = format!("{}{}", crate_name, $path_suffix);
474 let crate_name_ident = format_ident!("{}", crate_name);
475 path.push(parse_quote!(#crate_name_ident));
476 } else if partial_path == "" && !dependencies.contains(&$ident) {
477 new_path = format!("{}::{}{}", crate_name, $ident, $path_suffix);
478 let crate_name_ident = format_ident!("{}", crate_name);
479 path.push(parse_quote!(#crate_name_ident));
480 } else if format!("{}", $ident) == "self" {
481 let mut path_iter = partial_path.rsplitn(2, "::");
482 path_iter.next().unwrap();
483 new_path = path_iter.next().unwrap().to_owned();
485 new_path = format!("{}{}{}", partial_path, $ident, $path_suffix);
488 path.push(parse_quote!(#ident));
492 syn::UseTree::Path(p) => {
493 push_path!(p.ident, "::");
494 Self::walk_use_intern(crate_name, module_path, dependencies, &p.tree, &new_path, path, handle_use);
496 syn::UseTree::Name(n) => {
497 push_path!(n.ident, "");
498 let imported_ident = syn::Ident::new(new_path.rsplitn(2, "::").next().unwrap(), Span::call_site());
499 handle_use(imported_ident, (new_path, syn::Path { leading_colon: Some(syn::Token![::](Span::call_site())), segments: path }));
501 syn::UseTree::Group(g) => {
502 for i in g.items.iter() {
503 Self::walk_use_intern(crate_name, module_path, dependencies, i, partial_path, path.clone(), handle_use);
506 syn::UseTree::Rename(r) => {
507 push_path!(r.ident, "");
508 handle_use(r.rename.clone(), (new_path, syn::Path { leading_colon: Some(syn::Token![::](Span::call_site())), segments: path }));
510 syn::UseTree::Glob(_) => {
511 eprintln!("Ignoring * use for {} - this may result in resolution failures", partial_path);
516 fn process_use_intern(crate_name: &str, module_path: &str, dependencies: &HashSet<syn::Ident>,
517 imports: &mut HashMap<syn::Ident, (String, syn::Path)>, u: &syn::UseTree, partial_path: &str,
518 path: syn::punctuated::Punctuated<syn::PathSegment, syn::token::Colon2>
520 Self::walk_use_intern(crate_name, module_path, dependencies, u, partial_path, path,
521 &mut |k, v| { imports.insert(k, v); });
524 fn process_use(crate_name: &str, module_path: &str, dependencies: &HashSet<syn::Ident>, imports: &mut HashMap<syn::Ident, (String, syn::Path)>, u: &syn::ItemUse) {
525 if u.leading_colon.is_some() { eprintln!("Ignoring leading-colon use!"); return; }
526 Self::process_use_intern(crate_name, module_path, dependencies, imports, &u.tree, "", syn::punctuated::Punctuated::new());
529 fn insert_primitive(imports: &mut HashMap<syn::Ident, (String, syn::Path)>, id: &str) {
530 let ident = format_ident!("{}", id);
531 let path = parse_quote!(#ident);
532 imports.insert(ident, (id.to_owned(), path));
535 pub fn new(crate_name: &'mod_lifetime str, library: &'crate_lft FullLibraryAST, module_path: &'mod_lifetime str, contents: &'crate_lft [syn::Item]) -> Self {
536 Self::from_borrowed_items(crate_name, library, module_path, &contents.iter().map(|a| a).collect::<Vec<_>>())
538 pub fn from_borrowed_items(crate_name: &'mod_lifetime str, library: &'crate_lft FullLibraryAST, module_path: &'mod_lifetime str, contents: &[&'crate_lft syn::Item]) -> Self {
539 let mut imports = HashMap::new();
540 // Add primitives to the "imports" list:
541 Self::insert_primitive(&mut imports, "bool");
542 Self::insert_primitive(&mut imports, "u64");
543 Self::insert_primitive(&mut imports, "u32");
544 Self::insert_primitive(&mut imports, "u16");
545 Self::insert_primitive(&mut imports, "u8");
546 Self::insert_primitive(&mut imports, "usize");
547 Self::insert_primitive(&mut imports, "str");
548 Self::insert_primitive(&mut imports, "String");
550 // These are here to allow us to print native Rust types in trait fn impls even if we don't
552 Self::insert_primitive(&mut imports, "Result");
553 Self::insert_primitive(&mut imports, "Vec");
554 Self::insert_primitive(&mut imports, "Option");
556 let mut declared = HashMap::new();
557 let mut priv_modules = HashSet::new();
559 for item in contents.iter() {
561 syn::Item::Use(u) => Self::process_use(crate_name, module_path, &library.dependencies, &mut imports, &u),
562 syn::Item::Struct(s) => {
563 if let syn::Visibility::Public(_) = s.vis {
564 match export_status(&s.attrs) {
565 ExportStatus::Export => { declared.insert(s.ident.clone(), DeclType::StructImported { generics: &s.generics }); },
566 ExportStatus::NoExport => { declared.insert(s.ident.clone(), DeclType::StructIgnored); },
567 ExportStatus::TestOnly => continue,
568 ExportStatus::NotImplementable => panic!("(C-not implementable) should only appear on traits!"),
572 syn::Item::Type(t) if export_status(&t.attrs) == ExportStatus::Export => {
573 if let syn::Visibility::Public(_) = t.vis {
574 declared.insert(t.ident.clone(), DeclType::StructImported { generics: &t.generics });
577 syn::Item::Enum(e) => {
578 if let syn::Visibility::Public(_) = e.vis {
579 match export_status(&e.attrs) {
580 ExportStatus::Export if is_enum_opaque(e) => { declared.insert(e.ident.clone(), DeclType::EnumIgnored { generics: &e.generics }); },
581 ExportStatus::Export => { declared.insert(e.ident.clone(), DeclType::MirroredEnum); },
582 ExportStatus::NotImplementable => panic!("(C-not implementable) should only appear on traits!"),
587 syn::Item::Trait(t) => {
588 match export_status(&t.attrs) {
589 ExportStatus::Export|ExportStatus::NotImplementable => {
590 if let syn::Visibility::Public(_) = t.vis {
591 declared.insert(t.ident.clone(), DeclType::Trait(t));
597 syn::Item::Mod(m) => {
598 priv_modules.insert(m.ident.clone());
604 Self { crate_name, library, module_path, imports, declared, priv_modules }
607 pub fn maybe_resolve_declared(&self, id: &syn::Ident) -> Option<&DeclType<'crate_lft>> {
608 self.declared.get(id)
611 pub fn maybe_resolve_ident(&self, id: &syn::Ident) -> Option<String> {
612 if let Some((imp, _)) = self.imports.get(id) {
614 } else if self.declared.get(id).is_some() {
615 Some(self.module_path.to_string() + "::" + &format!("{}", id))
619 fn maybe_resolve_imported_path(&self, p: &syn::Path, generics: Option<&GenericTypes>) -> Option<String> {
620 if let Some(gen_types) = generics {
621 if let Some(resp) = gen_types.maybe_resolve_path(p) {
622 return Some(resp.clone());
626 if p.leading_colon.is_some() {
627 let mut res: String = p.segments.iter().enumerate().map(|(idx, seg)| {
628 format!("{}{}", if idx == 0 { "" } else { "::" }, seg.ident)
630 let firstseg = p.segments.iter().next().unwrap();
631 if !self.library.dependencies.contains(&firstseg.ident) {
632 res = self.crate_name.to_owned() + "::" + &res;
635 } else if let Some(id) = p.get_ident() {
636 self.maybe_resolve_ident(id)
638 if p.segments.len() == 1 {
639 let seg = p.segments.iter().next().unwrap();
640 return self.maybe_resolve_ident(&seg.ident);
642 let mut seg_iter = p.segments.iter();
643 let first_seg = seg_iter.next().unwrap();
644 let remaining: String = seg_iter.map(|seg| {
645 format!("::{}", seg.ident)
647 let first_seg_str = format!("{}", first_seg.ident);
648 if let Some((imp, _)) = self.imports.get(&first_seg.ident) {
650 Some(imp.clone() + &remaining)
654 } else if let Some(_) = self.priv_modules.get(&first_seg.ident) {
655 Some(format!("{}::{}{}", self.module_path, first_seg.ident, remaining))
656 } else if first_seg_is_stdlib(&first_seg_str) || self.library.dependencies.contains(&first_seg.ident) {
657 Some(first_seg_str + &remaining)
658 } else if first_seg_str == "crate" {
659 Some(self.crate_name.to_owned() + &remaining)
664 pub fn maybe_resolve_path(&self, p: &syn::Path, generics: Option<&GenericTypes>) -> Option<String> {
665 self.maybe_resolve_imported_path(p, generics).map(|mut path| {
667 // Now that we've resolved the path to the path as-imported, check whether the path
668 // is actually a pub(.*) use statement and map it to the real path.
669 let path_tmp = path.clone();
670 let crate_name = path_tmp.splitn(1, "::").next().unwrap();
671 let mut module_riter = path_tmp.rsplitn(2, "::");
672 let obj = module_riter.next().unwrap();
673 if let Some(module_path) = module_riter.next() {
674 if let Some(m) = self.library.modules.get(module_path) {
675 for item in m.items.iter() {
676 if let syn::Item::Use(syn::ItemUse { vis, tree, .. }) = item {
678 syn::Visibility::Public(_)|
679 syn::Visibility::Crate(_)|
680 syn::Visibility::Restricted(_) => {
681 Self::walk_use_intern(crate_name, module_path,
682 &self.library.dependencies, tree, "",
683 syn::punctuated::Punctuated::new(), &mut |ident, (use_path, _)| {
684 if format!("{}", ident) == obj {
689 syn::Visibility::Inherited => {},
701 /// Map all the Paths in a Type into absolute paths given a set of imports (generated via process_use_intern)
702 pub fn resolve_imported_refs(&self, mut ty: syn::Type) -> syn::Type {
704 syn::Type::Path(p) => {
705 if p.path.segments.len() != 1 { unimplemented!(); }
706 let mut args = p.path.segments[0].arguments.clone();
707 if let syn::PathArguments::AngleBracketed(ref mut generics) = &mut args {
708 for arg in generics.args.iter_mut() {
709 if let syn::GenericArgument::Type(ref mut t) = arg {
710 *t = self.resolve_imported_refs(t.clone());
714 if let Some((_, newpath)) = self.imports.get(single_ident_generic_path_to_ident(&p.path).unwrap()) {
715 p.path = newpath.clone();
717 p.path.segments[0].arguments = args;
719 syn::Type::Reference(r) => {
720 r.elem = Box::new(self.resolve_imported_refs((*r.elem).clone()));
722 syn::Type::Slice(s) => {
723 s.elem = Box::new(self.resolve_imported_refs((*s.elem).clone()));
725 syn::Type::Tuple(t) => {
726 for e in t.elems.iter_mut() {
727 *e = self.resolve_imported_refs(e.clone());
730 _ => unimplemented!(),
736 // templates_defined is walked to write the C++ header, so if we use the default hashing it get
737 // reordered on each genbindings run. Instead, we use SipHasher (which defaults to 0-keys) so that
738 // the sorting is stable across runs. It is deprecated, but the "replacement" doesn't actually
739 // accomplish the same goals, so we just ignore it.
741 pub type NonRandomHash = hash::BuildHasherDefault<hash::SipHasher>;
744 pub struct ASTModule {
745 pub attrs: Vec<syn::Attribute>,
746 pub items: Vec<syn::Item>,
747 pub submods: Vec<String>,
749 /// A struct containing the syn::File AST for each file in the crate.
750 pub struct FullLibraryAST {
751 pub modules: HashMap<String, ASTModule, NonRandomHash>,
752 pub dependencies: HashSet<syn::Ident>,
754 impl FullLibraryAST {
755 fn load_module(&mut self, module: String, attrs: Vec<syn::Attribute>, mut items: Vec<syn::Item>) {
756 let mut non_mod_items = Vec::with_capacity(items.len());
757 let mut submods = Vec::with_capacity(items.len());
758 for item in items.drain(..) {
760 syn::Item::Mod(m) if m.content.is_some() => {
761 if export_status(&m.attrs) == ExportStatus::Export {
762 if let syn::Visibility::Public(_) = m.vis {
763 let modident = format!("{}", m.ident);
764 let modname = if module != "" {
765 module.clone() + "::" + &modident
767 self.dependencies.insert(m.ident);
770 self.load_module(modname, m.attrs, m.content.unwrap().1);
771 submods.push(modident);
773 non_mod_items.push(syn::Item::Mod(m));
777 syn::Item::Mod(_) => panic!("--pretty=expanded output should never have non-body modules"),
778 syn::Item::ExternCrate(c) => {
779 if export_status(&c.attrs) == ExportStatus::Export {
780 self.dependencies.insert(c.ident);
783 _ => { non_mod_items.push(item); }
786 self.modules.insert(module, ASTModule { attrs, items: non_mod_items, submods });
789 pub fn load_lib(lib: syn::File) -> Self {
790 assert_eq!(export_status(&lib.attrs), ExportStatus::Export);
791 let mut res = Self { modules: HashMap::default(), dependencies: HashSet::new() };
792 res.load_module("".to_owned(), lib.attrs, lib.items);
797 /// List of manually-generated types which are clonable
798 fn initial_clonable_types() -> HashSet<String> {
799 let mut res = HashSet::new();
800 res.insert("crate::c_types::u5".to_owned());
801 res.insert("crate::c_types::FourBytes".to_owned());
802 res.insert("crate::c_types::TwelveBytes".to_owned());
803 res.insert("crate::c_types::SixteenBytes".to_owned());
804 res.insert("crate::c_types::TwentyBytes".to_owned());
805 res.insert("crate::c_types::ThirtyTwoBytes".to_owned());
806 res.insert("crate::c_types::SecretKey".to_owned());
807 res.insert("crate::c_types::PublicKey".to_owned());
808 res.insert("crate::c_types::Transaction".to_owned());
809 res.insert("crate::c_types::TxOut".to_owned());
810 res.insert("crate::c_types::Signature".to_owned());
811 res.insert("crate::c_types::RecoverableSignature".to_owned());
812 res.insert("crate::c_types::Bech32Error".to_owned());
813 res.insert("crate::c_types::Secp256k1Error".to_owned());
814 res.insert("crate::c_types::IOError".to_owned());
815 res.insert("crate::c_types::Error".to_owned());
816 res.insert("crate::c_types::Str".to_owned());
818 // Because some types are manually-mapped to CVec_u8Z we may end up checking if its clonable
819 // before we ever get to constructing the type fully via
820 // `write_c_mangled_container_path_intern` (which will add it here too), so we have to manually
821 // add it on startup.
822 res.insert("crate::c_types::derived::CVec_u8Z".to_owned());
826 /// Top-level struct tracking everything which has been defined while walking the crate.
827 pub struct CrateTypes<'a> {
828 /// This may contain structs or enums, but only when either is mapped as
829 /// struct X { inner: *mut originalX, .. }
830 pub opaques: HashMap<String, (&'a syn::Ident, &'a syn::Generics)>,
831 /// structs that weren't exposed
832 pub priv_structs: HashMap<String, &'a syn::Generics>,
833 /// Enums which are mapped as C enums with conversion functions
834 pub mirrored_enums: HashMap<String, &'a syn::ItemEnum>,
835 /// Traits which are mapped as a pointer + jump table
836 pub traits: HashMap<String, &'a syn::ItemTrait>,
837 /// Aliases from paths to some other Type
838 pub type_aliases: HashMap<String, syn::Type>,
839 /// Value is an alias to Key (maybe with some generics)
840 pub reverse_alias_map: HashMap<String, Vec<(String, syn::PathArguments)>>,
841 /// Template continer types defined, map from mangled type name -> whether a destructor fn
844 /// This is used at the end of processing to make C++ wrapper classes
845 pub templates_defined: RefCell<HashMap<String, bool, NonRandomHash>>,
846 /// The output file for any created template container types, written to as we find new
847 /// template containers which need to be defined.
848 template_file: RefCell<&'a mut File>,
849 /// Set of containers which are clonable
850 clonable_types: RefCell<HashSet<String>>,
852 pub trait_impls: HashMap<String, Vec<String>>,
853 /// The full set of modules in the crate(s)
854 pub lib_ast: &'a FullLibraryAST,
857 impl<'a> CrateTypes<'a> {
858 pub fn new(template_file: &'a mut File, libast: &'a FullLibraryAST) -> Self {
860 opaques: HashMap::new(), mirrored_enums: HashMap::new(), traits: HashMap::new(),
861 type_aliases: HashMap::new(), reverse_alias_map: HashMap::new(),
862 templates_defined: RefCell::new(HashMap::default()), priv_structs: HashMap::new(),
863 clonable_types: RefCell::new(initial_clonable_types()), trait_impls: HashMap::new(),
864 template_file: RefCell::new(template_file), lib_ast: &libast,
867 pub fn set_clonable(&self, object: String) {
868 self.clonable_types.borrow_mut().insert(object);
870 pub fn is_clonable(&self, object: &str) -> bool {
871 self.clonable_types.borrow().contains(object)
873 pub fn write_new_template(&self, mangled_container: String, has_destructor: bool, created_container: &[u8]) {
874 self.template_file.borrow_mut().write(created_container).unwrap();
875 self.templates_defined.borrow_mut().insert(mangled_container, has_destructor);
879 /// A struct which tracks resolving rust types into C-mapped equivalents, exists for one specific
880 /// module but contains a reference to the overall CrateTypes tracking.
881 pub struct TypeResolver<'mod_lifetime, 'crate_lft: 'mod_lifetime> {
882 pub module_path: &'mod_lifetime str,
883 pub crate_types: &'mod_lifetime CrateTypes<'crate_lft>,
884 pub types: ImportResolver<'mod_lifetime, 'crate_lft>,
887 /// Returned by write_empty_rust_val_check_suffix to indicate what type of dereferencing needs to
888 /// happen to get the inner value of a generic.
889 enum EmptyValExpectedTy {
890 /// A type which has a flag for being empty (eg an array where we treat all-0s as empty).
892 /// A Option mapped as a COption_*Z
894 /// A pointer which we want to convert to a reference.
899 /// Describes the appropriate place to print a general type-conversion string when converting a
901 enum ContainerPrefixLocation {
902 /// Prints a general type-conversion string prefix and suffix outside of the
903 /// container-conversion strings.
905 /// Prints a general type-conversion string prefix and suffix inside of the
906 /// container-conversion strings.
908 /// Does not print the usual type-conversion string prefix and suffix.
912 impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
913 pub fn new(module_path: &'a str, types: ImportResolver<'a, 'c>, crate_types: &'a CrateTypes<'c>) -> Self {
914 Self { module_path, types, crate_types }
917 // *************************************************
918 // *** Well know type and conversion definitions ***
919 // *************************************************
921 /// Returns true we if can just skip passing this to C entirely
922 pub fn skip_path(&self, full_path: &str) -> bool {
923 full_path == "bitcoin::secp256k1::Secp256k1" ||
924 full_path == "bitcoin::secp256k1::Signing" ||
925 full_path == "bitcoin::secp256k1::Verification"
927 /// Returns true we if can just skip passing this to C entirely
928 fn no_arg_path_to_rust(&self, full_path: &str) -> &str {
929 if full_path == "bitcoin::secp256k1::Secp256k1" {
930 "secp256k1::global::SECP256K1"
931 } else { unimplemented!(); }
934 /// Returns true if the object is a primitive and is mapped as-is with no conversion
936 pub fn is_primitive(&self, full_path: &str) -> bool {
947 pub fn is_clonable(&self, ty: &str) -> bool {
948 if self.crate_types.is_clonable(ty) { return true; }
949 if self.is_primitive(ty) { return true; }
955 /// Gets the C-mapped type for types which are outside of the crate, or which are manually
956 /// ignored by for some reason need mapping anyway.
957 fn c_type_from_path<'b>(&self, full_path: &'b str, is_ref: bool, _ptr_for_ref: bool) -> Option<&'b str> {
958 if self.is_primitive(full_path) {
959 return Some(full_path);
962 // Note that no !is_ref types can map to an array because Rust and C's call semantics
963 // for arrays are different (https://github.com/eqrion/cbindgen/issues/528)
965 "[u8; 32]" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
966 "[u8; 20]" if !is_ref => Some("crate::c_types::TwentyBytes"),
967 "[u8; 16]" if !is_ref => Some("crate::c_types::SixteenBytes"),
968 "[u8; 12]" if !is_ref => Some("crate::c_types::TwelveBytes"),
969 "[u8; 4]" if !is_ref => Some("crate::c_types::FourBytes"),
970 "[u8; 3]" if !is_ref => Some("crate::c_types::ThreeBytes"), // Used for RGB values
972 "str" if is_ref => Some("crate::c_types::Str"),
973 "alloc::string::String"|"String" => Some("crate::c_types::Str"),
975 "std::time::Duration"|"core::time::Duration" => Some("u64"),
976 "std::time::SystemTime" => Some("u64"),
977 "std::io::Error"|"lightning::io::Error"|"lightning::io::ErrorKind" => Some("crate::c_types::IOError"),
978 "core::fmt::Arguments" if is_ref => Some("crate::c_types::Str"),
980 "core::convert::Infallible" => Some("crate::c_types::NotConstructable"),
982 "bitcoin::bech32::Error"|"bech32::Error"
983 if !is_ref => Some("crate::c_types::Bech32Error"),
984 "bitcoin::secp256k1::Error"|"secp256k1::Error"
985 if !is_ref => Some("crate::c_types::Secp256k1Error"),
987 "core::num::ParseIntError" => Some("crate::c_types::Error"),
988 "core::str::Utf8Error" => Some("crate::c_types::Error"),
990 "bitcoin::bech32::u5"|"bech32::u5" => Some("crate::c_types::u5"),
991 "core::num::NonZeroU8" => Some("u8"),
993 "secp256k1::PublicKey"|"bitcoin::secp256k1::PublicKey" => Some("crate::c_types::PublicKey"),
994 "bitcoin::secp256k1::ecdsa::Signature" => Some("crate::c_types::Signature"),
995 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some("crate::c_types::RecoverableSignature"),
996 "bitcoin::secp256k1::SecretKey" if is_ref => Some("*const [u8; 32]"),
997 "bitcoin::secp256k1::SecretKey" if !is_ref => Some("crate::c_types::SecretKey"),
998 "bitcoin::secp256k1::Scalar" if is_ref => Some("*const crate::c_types::BigEndianScalar"),
999 "bitcoin::secp256k1::Scalar" if !is_ref => Some("crate::c_types::BigEndianScalar"),
1000 "bitcoin::secp256k1::ecdh::SharedSecret" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
1002 "bitcoin::blockdata::script::Script" if is_ref => Some("crate::c_types::u8slice"),
1003 "bitcoin::blockdata::script::Script" if !is_ref => Some("crate::c_types::derived::CVec_u8Z"),
1004 "bitcoin::blockdata::transaction::OutPoint" => Some("crate::lightning::chain::transaction::OutPoint"),
1005 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some("crate::c_types::Transaction"),
1006 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some("crate::c_types::TxOut"),
1007 "bitcoin::network::constants::Network" => Some("crate::bitcoin::network::Network"),
1008 "bitcoin::util::address::WitnessVersion" => Some("crate::c_types::WitnessVersion"),
1009 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some("*const [u8; 80]"),
1010 "bitcoin::blockdata::block::Block" if is_ref => Some("crate::c_types::u8slice"),
1012 "bitcoin::hash_types::PubkeyHash"|"bitcoin::hash_types::WPubkeyHash"|"bitcoin::hash_types::ScriptHash"
1013 if is_ref => Some("*const [u8; 20]"),
1014 "bitcoin::hash_types::WScriptHash"
1015 if is_ref => Some("*const [u8; 32]"),
1017 // Newtypes that we just expose in their original form.
1018 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1019 if is_ref => Some("*const [u8; 32]"),
1020 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1021 if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
1022 "bitcoin::secp256k1::Message" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
1023 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1024 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1025 if is_ref => Some("*const [u8; 32]"),
1026 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1027 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1028 if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
1030 "lightning::io::Read" => Some("crate::c_types::u8slice"),
1036 fn from_c_conversion_new_var_from_path<'b>(&self, _full_path: &str, _is_ref: bool) -> Option<(&'b str, &'b str)> {
1039 fn from_c_conversion_prefix_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<String> {
1040 if self.is_primitive(full_path) {
1041 return Some("".to_owned());
1044 "Vec" if !is_ref => Some("local_"),
1045 "Result" if !is_ref => Some("local_"),
1046 "Option" if is_ref => Some("&local_"),
1047 "Option" => Some("local_"),
1049 "[u8; 32]" if is_ref => Some("unsafe { &*"),
1050 "[u8; 32]" if !is_ref => Some(""),
1051 "[u8; 20]" if !is_ref => Some(""),
1052 "[u8; 16]" if !is_ref => Some(""),
1053 "[u8; 12]" if !is_ref => Some(""),
1054 "[u8; 4]" if !is_ref => Some(""),
1055 "[u8; 3]" if !is_ref => Some(""),
1057 "[u8]" if is_ref => Some(""),
1058 "[usize]" if is_ref => Some(""),
1060 "str" if is_ref => Some(""),
1061 "alloc::string::String"|"String" => Some(""),
1062 "std::io::Error"|"lightning::io::Error"|"lightning::io::ErrorKind" => Some(""),
1063 // Note that we'll panic for String if is_ref, as we only have non-owned memory, we
1064 // cannot create a &String.
1066 "core::convert::Infallible" => Some("panic!(\"You must never construct a NotConstructable! : "),
1068 "bitcoin::bech32::Error"|"bech32::Error" if !is_ref => Some(""),
1069 "bitcoin::secp256k1::Error"|"secp256k1::Error" if !is_ref => Some(""),
1071 "core::num::ParseIntError" => Some("u8::from_str_radix(\" a\", 10).unwrap_err() /*"),
1072 "core::str::Utf8Error" => Some("core::str::from_utf8(&[0xff]).unwrap_err() /*"),
1074 "std::time::Duration"|"core::time::Duration" => Some("core::time::Duration::from_secs("),
1075 "std::time::SystemTime" => Some("(::std::time::SystemTime::UNIX_EPOCH + std::time::Duration::from_secs("),
1077 "bitcoin::bech32::u5"|"bech32::u5" => Some(""),
1078 "core::num::NonZeroU8" => Some("core::num::NonZeroU8::new("),
1080 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" if is_ref => Some("&"),
1081 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" => Some(""),
1082 "bitcoin::secp256k1::ecdsa::Signature" if is_ref => Some("&"),
1083 "bitcoin::secp256k1::ecdsa::Signature" => Some(""),
1084 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some(""),
1085 "bitcoin::secp256k1::SecretKey" if is_ref => Some("&::bitcoin::secp256k1::SecretKey::from_slice(&unsafe { *"),
1086 "bitcoin::secp256k1::SecretKey" if !is_ref => Some(""),
1087 "bitcoin::secp256k1::Scalar" if !is_ref => Some(""),
1088 "bitcoin::secp256k1::ecdh::SharedSecret" if !is_ref => Some("::bitcoin::secp256k1::ecdh::SharedSecret::from_bytes("),
1090 "bitcoin::blockdata::script::Script" if is_ref => Some("&::bitcoin::blockdata::script::Script::from(Vec::from("),
1091 "bitcoin::blockdata::script::Script" if !is_ref => Some("::bitcoin::blockdata::script::Script::from("),
1092 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" if is_ref => Some("&"),
1093 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(""),
1094 "bitcoin::blockdata::transaction::OutPoint" => Some("crate::c_types::C_to_bitcoin_outpoint("),
1095 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(""),
1096 "bitcoin::network::constants::Network" => Some(""),
1097 "bitcoin::util::address::WitnessVersion" => Some(""),
1098 "bitcoin::blockdata::block::BlockHeader" => Some("&::bitcoin::consensus::encode::deserialize(unsafe { &*"),
1099 "bitcoin::blockdata::block::Block" if is_ref => Some("&::bitcoin::consensus::encode::deserialize("),
1101 "bitcoin::hash_types::PubkeyHash" if is_ref =>
1102 Some("&bitcoin::hash_types::PubkeyHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
1103 "bitcoin::hash_types::WPubkeyHash" if is_ref =>
1104 Some("&bitcoin::hash_types::WPubkeyHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
1105 "bitcoin::hash_types::ScriptHash" if is_ref =>
1106 Some("&bitcoin::hash_types::ScriptHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
1107 "bitcoin::hash_types::WScriptHash" if is_ref =>
1108 Some("&bitcoin::hash_types::WScriptHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
1110 // Newtypes that we just expose in their original form.
1111 "bitcoin::hash_types::Txid" if is_ref => Some("&::bitcoin::hash_types::Txid::from_slice(&unsafe { &*"),
1112 "bitcoin::hash_types::Txid" if !is_ref => Some("::bitcoin::hash_types::Txid::from_slice(&"),
1113 "bitcoin::hash_types::BlockHash" => Some("::bitcoin::hash_types::BlockHash::from_slice(&"),
1114 "lightning::ln::PaymentHash" if !is_ref => Some("::lightning::ln::PaymentHash("),
1115 "lightning::ln::PaymentHash" if is_ref => Some("&::lightning::ln::PaymentHash(unsafe { *"),
1116 "lightning::ln::PaymentPreimage" if !is_ref => Some("::lightning::ln::PaymentPreimage("),
1117 "lightning::ln::PaymentPreimage" if is_ref => Some("&::lightning::ln::PaymentPreimage(unsafe { *"),
1118 "lightning::ln::PaymentSecret" if !is_ref => Some("::lightning::ln::PaymentSecret("),
1119 "lightning::ln::channelmanager::PaymentId" if !is_ref => Some("::lightning::ln::channelmanager::PaymentId("),
1120 "lightning::ln::channelmanager::PaymentId" if is_ref=> Some("&::lightning::ln::channelmanager::PaymentId( unsafe { *"),
1121 "lightning::chain::keysinterface::KeyMaterial" if !is_ref => Some("::lightning::chain::keysinterface::KeyMaterial("),
1122 "lightning::chain::keysinterface::KeyMaterial" if is_ref=> Some("&::lightning::chain::keysinterface::KeyMaterial( unsafe { *"),
1124 // List of traits we map (possibly during processing of other files):
1125 "lightning::io::Read" => Some("&mut "),
1128 }.map(|s| s.to_owned())
1130 fn from_c_conversion_suffix_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<String> {
1131 if self.is_primitive(full_path) {
1132 return Some("".to_owned());
1135 "Vec" if !is_ref => Some(""),
1136 "Option" => Some(""),
1137 "Result" if !is_ref => Some(""),
1139 "[u8; 32]" if is_ref => Some("}"),
1140 "[u8; 32]" if !is_ref => Some(".data"),
1141 "[u8; 20]" if !is_ref => Some(".data"),
1142 "[u8; 16]" if !is_ref => Some(".data"),
1143 "[u8; 12]" if !is_ref => Some(".data"),
1144 "[u8; 4]" if !is_ref => Some(".data"),
1145 "[u8; 3]" if !is_ref => Some(".data"),
1147 "[u8]" if is_ref => Some(".to_slice()"),
1148 "[usize]" if is_ref => Some(".to_slice()"),
1150 "str" if is_ref => Some(".into_str()"),
1151 "alloc::string::String"|"String" => Some(".into_string()"),
1152 "std::io::Error"|"lightning::io::Error" => Some(".to_rust()"),
1153 "lightning::io::ErrorKind" => Some(".to_rust_kind()"),
1155 "core::convert::Infallible" => Some("\")"),
1157 "bitcoin::bech32::Error"|"bech32::Error" if !is_ref => Some(".into_rust()"),
1158 "bitcoin::secp256k1::Error"|"secp256k1::Error" if !is_ref => Some(".into_rust()"),
1160 "core::num::ParseIntError" => Some("*/"),
1161 "core::str::Utf8Error" => Some("*/"),
1163 "std::time::Duration"|"core::time::Duration" => Some(")"),
1164 "std::time::SystemTime" => Some("))"),
1166 "bitcoin::bech32::u5"|"bech32::u5" => Some(".into()"),
1167 "core::num::NonZeroU8" => Some(").expect(\"Value must be non-zero\")"),
1169 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" => Some(".into_rust()"),
1170 "bitcoin::secp256k1::ecdsa::Signature" => Some(".into_rust()"),
1171 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some(".into_rust()"),
1172 "bitcoin::secp256k1::SecretKey" if !is_ref => Some(".into_rust()"),
1173 "bitcoin::secp256k1::SecretKey" if is_ref => Some("}[..]).unwrap()"),
1174 "bitcoin::secp256k1::Scalar" if !is_ref => Some(".into_rust()"),
1175 "bitcoin::secp256k1::ecdh::SharedSecret" if !is_ref => Some(".data)"),
1177 "bitcoin::blockdata::script::Script" if is_ref => Some(".to_slice()))"),
1178 "bitcoin::blockdata::script::Script" if !is_ref => Some(".into_rust())"),
1179 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(".into_bitcoin()"),
1180 "bitcoin::blockdata::transaction::OutPoint" => Some(")"),
1181 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(".into_rust()"),
1182 "bitcoin::network::constants::Network" => Some(".into_bitcoin()"),
1183 "bitcoin::util::address::WitnessVersion" => Some(".into()"),
1184 "bitcoin::blockdata::block::BlockHeader" => Some(" }).unwrap()"),
1185 "bitcoin::blockdata::block::Block" => Some(".to_slice()).unwrap()"),
1187 "bitcoin::hash_types::PubkeyHash"|"bitcoin::hash_types::WPubkeyHash"|
1188 "bitcoin::hash_types::ScriptHash"|"bitcoin::hash_types::WScriptHash"
1189 if is_ref => Some(" }.clone()))"),
1191 // Newtypes that we just expose in their original form.
1192 "bitcoin::hash_types::Txid" if is_ref => Some(" }[..]).unwrap()"),
1193 "bitcoin::hash_types::Txid" => Some(".data[..]).unwrap()"),
1194 "bitcoin::hash_types::BlockHash" if !is_ref => Some(".data[..]).unwrap()"),
1195 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1196 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1197 if !is_ref => Some(".data)"),
1198 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1199 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1200 if is_ref => Some(" })"),
1202 // List of traits we map (possibly during processing of other files):
1203 "lightning::io::Read" => Some(".to_reader()"),
1206 }.map(|s| s.to_owned())
1209 fn to_c_conversion_new_var_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<(&'b str, &'b str)> {
1210 if self.is_primitive(full_path) {
1214 "[u8]" if is_ref => Some(("crate::c_types::u8slice::from_slice(", ")")),
1215 "[usize]" if is_ref => Some(("crate::c_types::usizeslice::from_slice(", ")")),
1217 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some(("{ let mut s = [0u8; 80]; s[..].copy_from_slice(&::bitcoin::consensus::encode::serialize(", ")); s }")),
1218 "bitcoin::blockdata::block::Block" if is_ref => Some(("::bitcoin::consensus::encode::serialize(", ")")),
1219 "bitcoin::hash_types::Txid" => None,
1222 }.map(|s| s.to_owned())
1224 fn to_c_conversion_inline_prefix_from_path(&self, full_path: &str, is_ref: bool, _ptr_for_ref: bool) -> Option<String> {
1225 if self.is_primitive(full_path) {
1226 return Some("".to_owned());
1229 "Result" if !is_ref => Some("local_"),
1230 "Vec" if !is_ref => Some("local_"),
1231 "Option" => Some("local_"),
1233 "[u8; 32]" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1234 "[u8; 32]" if is_ref => Some(""),
1235 "[u8; 20]" if !is_ref => Some("crate::c_types::TwentyBytes { data: "),
1236 "[u8; 16]" if !is_ref => Some("crate::c_types::SixteenBytes { data: "),
1237 "[u8; 12]" if !is_ref => Some("crate::c_types::TwelveBytes { data: "),
1238 "[u8; 4]" if !is_ref => Some("crate::c_types::FourBytes { data: "),
1239 "[u8; 3]" if is_ref => Some(""),
1241 "[u8]" if is_ref => Some("local_"),
1242 "[usize]" if is_ref => Some("local_"),
1244 "str" if is_ref => Some(""),
1245 "alloc::string::String"|"String" => Some(""),
1247 "std::time::Duration"|"core::time::Duration" => Some(""),
1248 "std::time::SystemTime" => Some(""),
1249 "std::io::Error"|"lightning::io::Error" => Some("crate::c_types::IOError::from_rust("),
1250 "lightning::io::ErrorKind" => Some("crate::c_types::IOError::from_rust_kind("),
1251 "core::fmt::Arguments" => Some("alloc::format!(\"{}\", "),
1253 "core::convert::Infallible" => Some("panic!(\"Cannot construct an Infallible: "),
1255 "bitcoin::bech32::Error"|"bech32::Error"
1256 if !is_ref => Some("crate::c_types::Bech32Error::from_rust("),
1257 "bitcoin::secp256k1::Error"|"secp256k1::Error"
1258 if !is_ref => Some("crate::c_types::Secp256k1Error::from_rust("),
1260 "core::num::ParseIntError" => Some("crate::c_types::Error { _dummy: 0 } /*"),
1261 "core::str::Utf8Error" => Some("crate::c_types::Error { _dummy: 0 } /*"),
1263 "bitcoin::bech32::u5"|"bech32::u5" => Some(""),
1265 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" => Some("crate::c_types::PublicKey::from_rust(&"),
1266 "bitcoin::secp256k1::ecdsa::Signature" => Some("crate::c_types::Signature::from_rust(&"),
1267 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some("crate::c_types::RecoverableSignature::from_rust(&"),
1268 "bitcoin::secp256k1::SecretKey" if is_ref => Some(""),
1269 "bitcoin::secp256k1::SecretKey" if !is_ref => Some("crate::c_types::SecretKey::from_rust("),
1270 "bitcoin::secp256k1::Scalar" if !is_ref => Some("crate::c_types::BigEndianScalar::from_rust("),
1271 "bitcoin::secp256k1::ecdh::SharedSecret" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1273 "bitcoin::blockdata::script::Script" if is_ref => Some("crate::c_types::u8slice::from_slice(&"),
1274 "bitcoin::blockdata::script::Script" if !is_ref => Some(""),
1275 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" if is_ref => Some("crate::c_types::Transaction::from_bitcoin("),
1276 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some("crate::c_types::Transaction::from_bitcoin(&"),
1277 "bitcoin::blockdata::transaction::OutPoint" => Some("crate::c_types::bitcoin_to_C_outpoint("),
1278 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some("crate::c_types::TxOut::from_rust("),
1279 "bitcoin::network::constants::Network" => Some("crate::bitcoin::network::Network::from_bitcoin("),
1280 "bitcoin::util::address::WitnessVersion" => Some(""),
1281 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some("&local_"),
1282 "bitcoin::blockdata::block::Block" if is_ref => Some("crate::c_types::u8slice::from_slice(&local_"),
1284 "bitcoin::hash_types::Txid" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1286 // Newtypes that we just expose in their original form.
1287 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1288 if is_ref => Some(""),
1289 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1290 if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1291 "bitcoin::secp256k1::Message" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1292 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1293 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1294 if is_ref => Some("&"),
1295 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1296 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1297 if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1299 "lightning::io::Read" => Some("crate::c_types::u8slice::from_vec(&crate::c_types::reader_to_vec("),
1302 }.map(|s| s.to_owned())
1304 fn to_c_conversion_inline_suffix_from_path(&self, full_path: &str, is_ref: bool, _ptr_for_ref: bool) -> Option<String> {
1305 if self.is_primitive(full_path) {
1306 return Some("".to_owned());
1309 "Result" if !is_ref => Some(""),
1310 "Vec" if !is_ref => Some(".into()"),
1311 "Option" => Some(""),
1313 "[u8; 32]" if !is_ref => Some(" }"),
1314 "[u8; 32]" if is_ref => Some(""),
1315 "[u8; 20]" if !is_ref => Some(" }"),
1316 "[u8; 16]" if !is_ref => Some(" }"),
1317 "[u8; 12]" if !is_ref => Some(" }"),
1318 "[u8; 4]" if !is_ref => Some(" }"),
1319 "[u8; 3]" if is_ref => Some(""),
1321 "[u8]" if is_ref => Some(""),
1322 "[usize]" if is_ref => Some(""),
1324 "str" if is_ref => Some(".into()"),
1325 "alloc::string::String"|"String" if is_ref => Some(".as_str().into()"),
1326 "alloc::string::String"|"String" => Some(".into()"),
1328 "std::time::Duration"|"core::time::Duration" => Some(".as_secs()"),
1329 "std::time::SystemTime" => Some(".duration_since(::std::time::SystemTime::UNIX_EPOCH).expect(\"Times must be post-1970\").as_secs()"),
1330 "std::io::Error"|"lightning::io::Error"|"lightning::io::ErrorKind" => Some(")"),
1331 "core::fmt::Arguments" => Some(").into()"),
1333 "core::convert::Infallible" => Some("\")"),
1335 "bitcoin::secp256k1::Error"|"bech32::Error"
1336 if !is_ref => Some(")"),
1337 "bitcoin::secp256k1::Error"|"secp256k1::Error"
1338 if !is_ref => Some(")"),
1340 "core::num::ParseIntError" => Some("*/"),
1341 "core::str::Utf8Error" => Some("*/"),
1343 "bitcoin::bech32::u5"|"bech32::u5" => Some(".into()"),
1345 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" => Some(")"),
1346 "bitcoin::secp256k1::ecdsa::Signature" => Some(")"),
1347 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some(")"),
1348 "bitcoin::secp256k1::SecretKey" if !is_ref => Some(")"),
1349 "bitcoin::secp256k1::SecretKey" if is_ref => Some(".as_ref()"),
1350 "bitcoin::secp256k1::Scalar" if !is_ref => Some(")"),
1351 "bitcoin::secp256k1::ecdh::SharedSecret" if !is_ref => Some(".secret_bytes() }"),
1353 "bitcoin::blockdata::script::Script" if is_ref => Some("[..])"),
1354 "bitcoin::blockdata::script::Script" if !is_ref => Some(".into_bytes().into()"),
1355 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(")"),
1356 "bitcoin::blockdata::transaction::OutPoint" => Some(")"),
1357 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(")"),
1358 "bitcoin::network::constants::Network" => Some(")"),
1359 "bitcoin::util::address::WitnessVersion" => Some(".into()"),
1360 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some(""),
1361 "bitcoin::blockdata::block::Block" if is_ref => Some(")"),
1363 "bitcoin::hash_types::Txid" if !is_ref => Some(".into_inner() }"),
1365 // Newtypes that we just expose in their original form.
1366 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1367 if is_ref => Some(".as_inner()"),
1368 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1369 if !is_ref => Some(".into_inner() }"),
1370 "bitcoin::secp256k1::Message" if !is_ref => Some(".as_ref().clone() }"),
1371 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1372 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1373 if is_ref => Some(".0"),
1374 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1375 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1376 if !is_ref => Some(".0 }"),
1378 "lightning::io::Read" => Some("))"),
1381 }.map(|s| s.to_owned())
1384 fn empty_val_check_suffix_from_path(&self, full_path: &str) -> Option<&str> {
1386 "lightning::ln::PaymentSecret" => Some(".data == [0; 32]"),
1387 "secp256k1::PublicKey"|"bitcoin::secp256k1::PublicKey" => Some(".is_null()"),
1388 "bitcoin::secp256k1::ecdsa::Signature" => Some(".is_null()"),
1393 /// When printing a reference to the source crate's rust type, if we need to map it to a
1394 /// different "real" type, it can be done so here.
1395 /// This is useful to work around limitations in the binding type resolver, where we reference
1396 /// a non-public `use` alias.
1397 /// TODO: We should never need to use this!
1398 fn real_rust_type_mapping<'equiv>(&self, thing: &'equiv str) -> &'equiv str {
1400 "lightning::io::Read" => "crate::c_types::io::Read",
1405 // ****************************
1406 // *** Container Processing ***
1407 // ****************************
1409 /// Returns the module path in the generated mapping crate to the containers which we generate
1410 /// when writing to CrateTypes::template_file.
1411 pub fn generated_container_path() -> &'static str {
1412 "crate::c_types::derived"
1414 /// Returns the module path in the generated mapping crate to the container templates, which
1415 /// are then concretized and put in the generated container path/template_file.
1416 fn container_templ_path() -> &'static str {
1420 /// This should just be a closure, but doing so gets an error like
1421 /// error: reached the recursion limit while instantiating `types::TypeResolver::is_transpar...c/types.rs:1358:104: 1358:110]>>`
1422 /// which implies the concrete function instantiation of `is_transparent_container` ends up
1423 /// being recursive.
1424 fn deref_type<'one, 'b: 'one> (obj: &'one &'b syn::Type) -> &'b syn::Type { *obj }
1426 /// Returns true if the path containing the given args is a "transparent" container, ie an
1427 /// Option or a container which does not require a generated continer class.
1428 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 {
1429 if full_path == "Option" {
1430 let inner = args.next().unwrap();
1431 assert!(args.next().is_none());
1432 match generics.resolve_type(inner) {
1433 syn::Type::Reference(r) => {
1434 let elem = &*r.elem;
1436 syn::Type::Path(_) =>
1437 self.is_transparent_container(full_path, true, [elem].iter().map(Self::deref_type), generics),
1441 syn::Type::Array(a) => {
1442 if let syn::Expr::Lit(l) = &a.len {
1443 if let syn::Lit::Int(i) = &l.lit {
1444 if i.base10_digits().parse::<usize>().unwrap() >= 32 {
1445 let mut buf = Vec::new();
1446 self.write_rust_type(&mut buf, generics, &a.elem, false);
1447 let ty = String::from_utf8(buf).unwrap();
1450 // Blindly assume that if we're trying to create an empty value for an
1451 // array < 32 entries that all-0s may be a valid state.
1454 } else { unimplemented!(); }
1455 } else { unimplemented!(); }
1457 syn::Type::Path(p) => {
1458 if let Some(resolved) = self.maybe_resolve_path(&p.path, generics) {
1459 if self.c_type_has_inner_from_path(&resolved) { return true; }
1460 if self.is_primitive(&resolved) { return false; }
1461 // We want to move to using `Option_` mappings where possible rather than
1462 // manual mappings, as it makes downstream bindings simpler and is more
1463 // clear for users. Thus, we default to false but override for a few
1464 // types which had mappings defined when we were avoiding the `Option_`s.
1465 match &resolved as &str {
1466 "lightning::ln::PaymentSecret" => true,
1467 "lightning::ln::PaymentHash" => true,
1468 "lightning::ln::PaymentPreimage" => true,
1469 "lightning::ln::channelmanager::PaymentId" => true,
1470 "bitcoin::hash_types::BlockHash" => true,
1471 "secp256k1::PublicKey"|"bitcoin::secp256k1::PublicKey" => true,
1474 } else { unimplemented!(); }
1476 syn::Type::Tuple(_) => false,
1477 _ => unimplemented!(),
1481 /// Returns true if the path is a "transparent" container, ie an Option or a container which does
1482 /// not require a generated continer class.
1483 pub fn is_path_transparent_container(&self, full_path: &syn::Path, generics: Option<&GenericTypes>, is_ref: bool) -> bool {
1484 let inner_iter = match &full_path.segments.last().unwrap().arguments {
1485 syn::PathArguments::None => return false,
1486 syn::PathArguments::AngleBracketed(args) => args.args.iter().map(|arg| {
1487 if let syn::GenericArgument::Type(ref ty) = arg {
1489 } else { unimplemented!() }
1491 syn::PathArguments::Parenthesized(_) => unimplemented!(),
1493 self.is_transparent_container(&self.resolve_path(full_path, generics), is_ref, inner_iter, generics)
1495 /// Returns true if this is a known, supported, non-transparent container.
1496 fn is_known_container(&self, full_path: &str, is_ref: bool) -> bool {
1497 (full_path == "Result" && !is_ref) || (full_path == "Vec" && !is_ref) || full_path.ends_with("Tuple") || full_path == "Option"
1499 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)
1500 // Returns prefix + Vec<(prefix, var-name-to-inline-convert)> + suffix
1501 // expecting one element in the vec per generic type, each of which is inline-converted
1502 -> Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)> {
1504 "Result" if !is_ref => {
1506 vec![(" { Ok(mut o) => crate::c_types::CResultTempl::ok(".to_string(), "o".to_string()),
1507 (").into(), Err(mut e) => crate::c_types::CResultTempl::err(".to_string(), "e".to_string())],
1508 ").into() }", ContainerPrefixLocation::PerConv))
1512 // We should only get here if the single contained has an inner
1513 assert!(self.c_type_has_inner(single_contained.unwrap()));
1515 Some(("Vec::new(); for mut item in ", vec![(format!(".drain(..) {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1518 if let Some(syn::Type::Reference(_)) = single_contained {
1519 Some(("Vec::new(); for item in ", vec![(format!(".iter() {{ local_{}.push(", var_name), "(*item)".to_string())], "); }", ContainerPrefixLocation::PerConv))
1521 Some(("Vec::new(); for item in ", vec![(format!(".iter() {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1525 let mut is_contained_ref = false;
1526 let contained_struct = if let Some(syn::Type::Path(p)) = single_contained {
1527 Some(self.resolve_path(&p.path, generics))
1528 } else if let Some(syn::Type::Reference(r)) = single_contained {
1529 is_contained_ref = true;
1530 if let syn::Type::Path(p) = &*r.elem {
1531 Some(self.resolve_path(&p.path, generics))
1534 if let Some(inner_path) = contained_struct {
1535 let only_contained_has_inner = self.c_type_has_inner_from_path(&inner_path);
1536 if self.c_type_has_inner_from_path(&inner_path) {
1537 let is_inner_ref = if let Some(syn::Type::Reference(_)) = single_contained { true } else { false };
1539 return Some(("if ", vec![
1540 (".is_none() { core::ptr::null() } else { ObjOps::nonnull_ptr_to_inner(".to_owned(),
1541 format!("({}{}.unwrap())", var_access, if is_inner_ref { "" } else { ".as_ref()" }))
1542 ], ") }", ContainerPrefixLocation::OutsideConv));
1544 return Some(("if ", vec![
1545 (".is_none() { core::ptr::null_mut() } else { ".to_owned(), format!("({}.unwrap())", var_access))
1546 ], " }", ContainerPrefixLocation::OutsideConv));
1548 } else if !self.is_transparent_container("Option", is_ref, [single_contained.unwrap()].iter().map(|a| *a), generics) {
1549 if self.is_primitive(&inner_path) || (!is_contained_ref && !is_ref) || only_contained_has_inner {
1550 let inner_name = self.get_c_mangled_container_type(vec![single_contained.unwrap()], generics, "Option").unwrap();
1551 return Some(("if ", vec![
1552 (format!(".is_none() {{ {}::None }} else {{ {}::Some(", inner_name, inner_name),
1553 format!("{}.unwrap()", var_access))
1554 ], ") }", ContainerPrefixLocation::PerConv));
1556 let inner_name = self.get_c_mangled_container_type(vec![single_contained.unwrap()], generics, "Option").unwrap();
1557 return Some(("if ", vec![
1558 (format!(".is_none() {{ {}::None }} else {{ {}::Some(/* WARNING: CLONING CONVERSION HERE! &Option<Enum> is otherwise un-expressable. */", inner_name, inner_name),
1559 format!("{}.clone().unwrap()", var_access))
1560 ], ") }", ContainerPrefixLocation::PerConv));
1563 // If c_type_from_path is some (ie there's a manual mapping for the inner
1564 // type), lean on write_empty_rust_val, below.
1567 if let Some(t) = single_contained {
1568 if let syn::Type::Tuple(syn::TypeTuple { elems, .. }) = t {
1569 let inner_name = self.get_c_mangled_container_type(vec![single_contained.unwrap()], generics, "Option").unwrap();
1570 if elems.is_empty() {
1571 return Some(("if ", vec![
1572 (format!(".is_none() {{ {}::None }} else {{ {}::Some /* ",
1573 inner_name, inner_name), format!(""))
1574 ], " */ }", ContainerPrefixLocation::PerConv));
1576 return Some(("if ", vec![
1577 (format!(".is_none() {{ {}::None }} else {{ {}::Some(",
1578 inner_name, inner_name), format!("({}.unwrap())", var_access))
1579 ], ") }", ContainerPrefixLocation::PerConv));
1582 if let syn::Type::Reference(syn::TypeReference { elem, .. }) = t {
1583 if let syn::Type::Slice(_) = &**elem {
1584 return Some(("if ", vec![
1585 (".is_none() { SmartPtr::null() } else { SmartPtr::from_obj(".to_string(),
1586 format!("({}.unwrap())", var_access))
1587 ], ") }", ContainerPrefixLocation::PerConv));
1590 let mut v = Vec::new();
1591 self.write_empty_rust_val(generics, &mut v, t);
1592 let s = String::from_utf8(v).unwrap();
1593 return Some(("if ", vec![
1594 (format!(".is_none() {{ {} }} else {{ ", s), format!("({}.unwrap())", var_access))
1595 ], " }", ContainerPrefixLocation::PerConv));
1596 } else { unreachable!(); }
1602 /// only_contained_has_inner implies that there is only one contained element in the container
1603 /// and it has an inner field (ie is an "opaque" type we've defined).
1604 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)
1605 // Returns prefix + Vec<(prefix, var-name-to-inline-convert)> + suffix
1606 // expecting one element in the vec per generic type, each of which is inline-converted
1607 -> Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)> {
1608 let mut only_contained_has_inner = false;
1609 let only_contained_resolved = if let Some(syn::Type::Path(p)) = single_contained {
1610 let res = self.resolve_path(&p.path, generics);
1611 only_contained_has_inner = self.c_type_has_inner_from_path(&res);
1615 "Result" if !is_ref => {
1617 vec![(".result_ok { true => Ok(".to_string(), format!("(*unsafe {{ Box::from_raw(<*mut _>::take_ptr(&mut {}.contents.result)) }})", var_access)),
1618 ("), false => Err(".to_string(), format!("(*unsafe {{ Box::from_raw(<*mut _>::take_ptr(&mut {}.contents.err)) }})", var_access))],
1619 ")}", ContainerPrefixLocation::PerConv))
1621 "Slice" if is_ref && only_contained_has_inner => {
1622 Some(("Vec::new(); for mut item in ", vec![(format!(".as_slice().iter() {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1625 Some(("Vec::new(); for mut item in ", vec![(format!(".into_rust().drain(..) {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1628 if let Some(resolved) = only_contained_resolved {
1629 if self.is_primitive(&resolved) {
1630 return Some(("if ", vec![(".is_some() { Some(".to_string(), format!("{}.take()", var_access))], ") } else { None }", ContainerPrefixLocation::NoPrefix))
1631 } else if only_contained_has_inner {
1633 return Some(("if ", vec![(".inner.is_null() { None } else { Some((*".to_string(), format!("{}", var_access))], ").clone()) }", ContainerPrefixLocation::PerConv))
1635 return Some(("if ", vec![(".inner.is_null() { None } else { Some(".to_string(), format!("{}", var_access))], ") }", ContainerPrefixLocation::PerConv));
1640 if let Some(t) = single_contained {
1642 syn::Type::Reference(_)|syn::Type::Path(_)|syn::Type::Slice(_)|syn::Type::Array(_) => {
1643 let mut v = Vec::new();
1644 let ret_ref = self.write_empty_rust_val_check_suffix(generics, &mut v, t);
1645 let s = String::from_utf8(v).unwrap();
1647 EmptyValExpectedTy::ReferenceAsPointer =>
1648 return Some(("if ", vec![
1649 (format!("{} {{ None }} else {{ Some(", s), format!("unsafe {{ &mut *{} }}", var_access))
1650 ], ") }", ContainerPrefixLocation::NoPrefix)),
1651 EmptyValExpectedTy::OptionType =>
1652 return Some(("{ /* ", vec![
1653 (format!("*/ let {}_opt = {};", var_name, var_access),
1654 format!("}} if {}_opt{} {{ None }} else {{ Some({{ {}_opt.take()", var_name, s, var_name))
1655 ], ") } }", ContainerPrefixLocation::PerConv)),
1656 EmptyValExpectedTy::NonPointer =>
1657 return Some(("if ", vec![
1658 (format!("{} {{ None }} else {{ Some(", s), format!("{}", var_access))
1659 ], ") }", ContainerPrefixLocation::PerConv)),
1662 syn::Type::Tuple(_) => {
1663 return Some(("if ", vec![(".is_some() { Some(".to_string(), format!("{}.take()", var_access))], ") } else { None }", ContainerPrefixLocation::PerConv))
1665 _ => unimplemented!(),
1667 } else { unreachable!(); }
1673 /// Constructs a reference to the given type, possibly tweaking the type if relevant to make it
1674 /// convertable to C.
1675 pub fn create_ownable_reference(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> Option<syn::Type> {
1676 let default_value = Some(syn::Type::Reference(syn::TypeReference {
1677 and_token: syn::Token!(&)(Span::call_site()), lifetime: None, mutability: None,
1678 elem: Box::new(t.clone()) }));
1679 match generics.resolve_type(t) {
1680 syn::Type::Path(p) => {
1681 if let Some(resolved_path) = self.maybe_resolve_path(&p.path, generics) {
1682 if resolved_path != "Vec" { return default_value; }
1683 if p.path.segments.len() != 1 { unimplemented!(); }
1684 let only_seg = p.path.segments.iter().next().unwrap();
1685 if let syn::PathArguments::AngleBracketed(args) = &only_seg.arguments {
1686 if args.args.len() != 1 { unimplemented!(); }
1687 let inner_arg = args.args.iter().next().unwrap();
1688 if let syn::GenericArgument::Type(ty) = &inner_arg {
1689 let mut can_create = self.c_type_has_inner(&ty);
1690 if let syn::Type::Path(inner) = ty {
1691 if inner.path.segments.len() == 1 &&
1692 format!("{}", inner.path.segments[0].ident) == "Vec" {
1696 if !can_create { return default_value; }
1697 if let Some(inner_ty) = self.create_ownable_reference(&ty, generics) {
1698 return Some(syn::Type::Reference(syn::TypeReference {
1699 and_token: syn::Token![&](Span::call_site()),
1702 elem: Box::new(syn::Type::Slice(syn::TypeSlice {
1703 bracket_token: syn::token::Bracket { span: Span::call_site() },
1704 elem: Box::new(inner_ty)
1707 } else { return default_value; }
1708 } else { unimplemented!(); }
1709 } else { unimplemented!(); }
1710 } else { return None; }
1716 // *************************************************
1717 // *** Type definition during main.rs processing ***
1718 // *************************************************
1720 /// Returns true if the object at the given path is mapped as X { inner: *mut origX, .. }.
1721 pub fn c_type_has_inner_from_path(&self, full_path: &str) -> bool {
1722 self.crate_types.opaques.get(full_path).is_some()
1725 /// Returns true if the object at the given path is mapped as X { inner: *mut origX, .. }.
1726 pub fn c_type_has_inner(&self, ty: &syn::Type) -> bool {
1728 syn::Type::Path(p) => {
1729 if let Some(full_path) = self.maybe_resolve_path(&p.path, None) {
1730 self.c_type_has_inner_from_path(&full_path)
1733 syn::Type::Reference(r) => {
1734 self.c_type_has_inner(&*r.elem)
1740 pub fn maybe_resolve_ident(&self, id: &syn::Ident) -> Option<String> {
1741 self.types.maybe_resolve_ident(id)
1744 pub fn maybe_resolve_path(&self, p_arg: &syn::Path, generics: Option<&GenericTypes>) -> Option<String> {
1745 self.types.maybe_resolve_path(p_arg, generics)
1747 pub fn resolve_path(&self, p: &syn::Path, generics: Option<&GenericTypes>) -> String {
1748 self.maybe_resolve_path(p, generics).unwrap()
1751 // ***********************************
1752 // *** Original Rust Type Printing ***
1753 // ***********************************
1755 fn in_rust_prelude(resolved_path: &str) -> bool {
1756 match resolved_path {
1764 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) {
1765 if let Some(resolved) = self.maybe_resolve_path(&path, generics_resolver) {
1766 if self.is_primitive(&resolved) {
1767 write!(w, "{}", path.get_ident().unwrap()).unwrap();
1769 // TODO: We should have a generic "is from a dependency" check here instead of
1770 // checking for "bitcoin" explicitly.
1771 if resolved.starts_with("bitcoin::") || Self::in_rust_prelude(&resolved) {
1772 write!(w, "{}", resolved).unwrap();
1773 } else if !generated_crate_ref {
1774 // If we're printing a generic argument, it needs to reference the crate, otherwise
1775 // the original crate.
1776 write!(w, "{}", self.real_rust_type_mapping(&resolved)).unwrap();
1778 write!(w, "crate::{}", resolved).unwrap();
1781 if let syn::PathArguments::AngleBracketed(args) = &path.segments.iter().last().unwrap().arguments {
1782 self.write_rust_generic_arg(w, generics_resolver, args.args.iter(), with_ref_lifetime);
1785 if path.leading_colon.is_some() {
1786 write!(w, "::").unwrap();
1788 for (idx, seg) in path.segments.iter().enumerate() {
1789 if idx != 0 { write!(w, "::").unwrap(); }
1790 write!(w, "{}", seg.ident).unwrap();
1791 if let syn::PathArguments::AngleBracketed(args) = &seg.arguments {
1792 self.write_rust_generic_arg(w, generics_resolver, args.args.iter(), with_ref_lifetime);
1797 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>) {
1798 let mut had_params = false;
1799 for (idx, arg) in generics.enumerate() {
1800 if idx != 0 { write!(w, ", ").unwrap(); } else { write!(w, "<").unwrap(); }
1803 syn::GenericParam::Lifetime(lt) => write!(w, "'{}", lt.lifetime.ident).unwrap(),
1804 syn::GenericParam::Type(t) => {
1805 write!(w, "{}", t.ident).unwrap();
1806 if t.colon_token.is_some() { write!(w, ":").unwrap(); }
1807 for (idx, bound) in t.bounds.iter().enumerate() {
1808 if idx != 0 { write!(w, " + ").unwrap(); }
1810 syn::TypeParamBound::Trait(tb) => {
1811 if tb.paren_token.is_some() || tb.lifetimes.is_some() { unimplemented!(); }
1812 self.write_rust_path(w, generics_resolver, &tb.path, false, false);
1814 _ => unimplemented!(),
1817 if t.eq_token.is_some() || t.default.is_some() { unimplemented!(); }
1819 _ => unimplemented!(),
1822 if had_params { write!(w, ">").unwrap(); }
1825 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) {
1826 write!(w, "<").unwrap();
1827 for (idx, arg) in generics.enumerate() {
1828 if idx != 0 { write!(w, ", ").unwrap(); }
1830 syn::GenericArgument::Type(t) => self.write_rust_type(w, generics_resolver, t, with_ref_lifetime),
1831 _ => unimplemented!(),
1834 write!(w, ">").unwrap();
1836 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) {
1837 let real_ty = generics.resolve_type(t);
1838 let mut generate_crate_ref = force_crate_ref || t != real_ty;
1840 syn::Type::Path(p) => {
1841 if p.qself.is_some() {
1844 if let Some(resolved_ty) = self.maybe_resolve_path(&p.path, generics) {
1845 generate_crate_ref |= self.maybe_resolve_path(&p.path, None).as_ref() != Some(&resolved_ty);
1846 if self.crate_types.traits.get(&resolved_ty).is_none() { generate_crate_ref = false; }
1848 self.write_rust_path(w, generics, &p.path, with_ref_lifetime, generate_crate_ref);
1850 syn::Type::Reference(r) => {
1851 write!(w, "&").unwrap();
1852 if let Some(lft) = &r.lifetime {
1853 write!(w, "'{} ", lft.ident).unwrap();
1854 } else if with_ref_lifetime {
1855 write!(w, "'static ").unwrap();
1857 if r.mutability.is_some() {
1858 write!(w, "mut ").unwrap();
1860 self.do_write_rust_type(w, generics, &*r.elem, with_ref_lifetime, generate_crate_ref);
1862 syn::Type::Array(a) => {
1863 write!(w, "[").unwrap();
1864 self.do_write_rust_type(w, generics, &a.elem, with_ref_lifetime, generate_crate_ref);
1865 if let syn::Expr::Lit(l) = &a.len {
1866 if let syn::Lit::Int(i) = &l.lit {
1867 write!(w, "; {}]", i).unwrap();
1868 } else { unimplemented!(); }
1869 } else { unimplemented!(); }
1871 syn::Type::Slice(s) => {
1872 write!(w, "[").unwrap();
1873 self.do_write_rust_type(w, generics, &s.elem, with_ref_lifetime, generate_crate_ref);
1874 write!(w, "]").unwrap();
1876 syn::Type::Tuple(s) => {
1877 write!(w, "(").unwrap();
1878 for (idx, t) in s.elems.iter().enumerate() {
1879 if idx != 0 { write!(w, ", ").unwrap(); }
1880 self.do_write_rust_type(w, generics, &t, with_ref_lifetime, generate_crate_ref);
1882 write!(w, ")").unwrap();
1884 _ => unimplemented!(),
1887 pub fn write_rust_type<W: std::io::Write>(&self, w: &mut W, generics: Option<&GenericTypes>, t: &syn::Type, with_ref_lifetime: bool) {
1888 self.do_write_rust_type(w, generics, t, with_ref_lifetime, false);
1892 /// Prints a constructor for something which is "uninitialized" (but obviously not actually
1893 /// unint'd memory).
1894 pub fn write_empty_rust_val<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type) {
1896 syn::Type::Reference(r) => {
1897 self.write_empty_rust_val(generics, w, &*r.elem)
1899 syn::Type::Path(p) => {
1900 let resolved = self.resolve_path(&p.path, generics);
1901 if self.crate_types.opaques.get(&resolved).is_some() {
1902 write!(w, "crate::{} {{ inner: core::ptr::null_mut(), is_owned: true }}", resolved).unwrap();
1904 // Assume its a manually-mapped C type, where we can just define an null() fn
1905 write!(w, "{}::null()", self.c_type_from_path(&resolved, false, false).unwrap()).unwrap();
1908 syn::Type::Array(a) => {
1909 if let syn::Expr::Lit(l) = &a.len {
1910 if let syn::Lit::Int(i) = &l.lit {
1911 if i.base10_digits().parse::<usize>().unwrap() < 32 {
1912 // Blindly assume that if we're trying to create an empty value for an
1913 // array < 32 entries that all-0s may be a valid state.
1916 let arrty = format!("[u8; {}]", i.base10_digits());
1917 write!(w, "{}", self.to_c_conversion_inline_prefix_from_path(&arrty, false, false).unwrap()).unwrap();
1918 write!(w, "[0; {}]", i.base10_digits()).unwrap();
1919 write!(w, "{}", self.to_c_conversion_inline_suffix_from_path(&arrty, false, false).unwrap()).unwrap();
1920 } else { unimplemented!(); }
1921 } else { unimplemented!(); }
1923 _ => unimplemented!(),
1927 fn is_real_type_array(&self, resolved_type: &str) -> Option<syn::Type> {
1928 if let Some(real_ty) = self.c_type_from_path(&resolved_type, true, false) {
1929 if real_ty.ends_with("]") && real_ty.starts_with("*const [u8; ") {
1930 let mut split = real_ty.split("; ");
1931 split.next().unwrap();
1932 let tail_str = split.next().unwrap();
1933 assert!(split.next().is_none());
1934 let len = usize::from_str_radix(&tail_str[..tail_str.len() - 1], 10).unwrap();
1935 Some(parse_quote!([u8; #len]))
1940 /// Prints a suffix to determine if a variable is empty (ie was set by write_empty_rust_val).
1941 /// See EmptyValExpectedTy for information on return types.
1942 fn write_empty_rust_val_check_suffix<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type) -> EmptyValExpectedTy {
1944 syn::Type::Reference(r) => {
1945 return self.write_empty_rust_val_check_suffix(generics, w, &*r.elem);
1947 syn::Type::Path(p) => {
1948 let resolved = self.resolve_path(&p.path, generics);
1949 if let Some(arr_ty) = self.is_real_type_array(&resolved) {
1950 return self.write_empty_rust_val_check_suffix(generics, w, &arr_ty);
1952 if self.crate_types.opaques.get(&resolved).is_some() {
1953 write!(w, ".inner.is_null()").unwrap();
1954 EmptyValExpectedTy::NonPointer
1956 if let Some(suffix) = self.empty_val_check_suffix_from_path(&resolved) {
1957 write!(w, "{}", suffix).unwrap();
1958 // We may eventually need to allow empty_val_check_suffix_from_path to specify if we need a deref or not
1959 EmptyValExpectedTy::NonPointer
1961 write!(w, ".is_none()").unwrap();
1962 EmptyValExpectedTy::OptionType
1966 syn::Type::Array(a) => {
1967 if let syn::Expr::Lit(l) = &a.len {
1968 if let syn::Lit::Int(i) = &l.lit {
1969 write!(w, ".data == [0; {}]", i.base10_digits()).unwrap();
1970 EmptyValExpectedTy::NonPointer
1971 } else { unimplemented!(); }
1972 } else { unimplemented!(); }
1974 syn::Type::Slice(_) => {
1975 // Option<[]> always implies that we want to treat len() == 0 differently from
1976 // None, so we always map an Option<[]> into a pointer.
1977 write!(w, " == core::ptr::null_mut()").unwrap();
1978 EmptyValExpectedTy::ReferenceAsPointer
1980 _ => unimplemented!(),
1984 /// Prints a suffix to determine if a variable is empty (ie was set by write_empty_rust_val).
1985 pub fn write_empty_rust_val_check<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type, var_access: &str) {
1987 syn::Type::Reference(r) => {
1988 self.write_empty_rust_val_check(generics, w, &*r.elem, var_access);
1990 syn::Type::Path(_) => {
1991 write!(w, "{}", var_access).unwrap();
1992 self.write_empty_rust_val_check_suffix(generics, w, t);
1994 syn::Type::Array(a) => {
1995 if let syn::Expr::Lit(l) = &a.len {
1996 if let syn::Lit::Int(i) = &l.lit {
1997 let arrty = format!("[u8; {}]", i.base10_digits());
1998 // We don't (yet) support a new-var conversion here.
1999 assert!(self.from_c_conversion_new_var_from_path(&arrty, false).is_none());
2001 self.from_c_conversion_prefix_from_path(&arrty, false).unwrap(),
2003 self.from_c_conversion_suffix_from_path(&arrty, false).unwrap()).unwrap();
2004 self.write_empty_rust_val_check_suffix(generics, w, t);
2005 } else { unimplemented!(); }
2006 } else { unimplemented!(); }
2008 _ => unimplemented!(),
2012 // ********************************
2013 // *** Type conversion printing ***
2014 // ********************************
2016 /// Returns true we if can just skip passing this to C entirely
2017 pub fn skip_arg(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> bool {
2019 syn::Type::Path(p) => {
2020 if p.qself.is_some() { unimplemented!(); }
2021 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
2022 self.skip_path(&full_path)
2025 syn::Type::Reference(r) => {
2026 self.skip_arg(&*r.elem, generics)
2031 pub fn no_arg_to_rust<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2033 syn::Type::Path(p) => {
2034 if p.qself.is_some() { unimplemented!(); }
2035 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
2036 write!(w, "{}", self.no_arg_path_to_rust(&full_path)).unwrap();
2039 syn::Type::Reference(r) => {
2040 self.no_arg_to_rust(w, &*r.elem, generics);
2046 fn write_conversion_inline_intern<W: std::io::Write,
2047 LP: Fn(&str, bool, bool) -> Option<String>, DL: Fn(&mut W, &DeclType, &str, bool, bool), SC: Fn(bool, Option<&str>) -> String>
2048 (&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, is_ref: bool, is_mut: bool, ptr_for_ref: bool,
2049 tupleconv: &str, prefix: bool, sliceconv: SC, path_lookup: LP, decl_lookup: DL) {
2050 match generics.resolve_type(t) {
2051 syn::Type::Reference(r) => {
2052 self.write_conversion_inline_intern(w, &*r.elem, generics, true, r.mutability.is_some(),
2053 ptr_for_ref, tupleconv, prefix, sliceconv, path_lookup, decl_lookup);
2055 syn::Type::Path(p) => {
2056 if p.qself.is_some() {
2060 let resolved_path = self.resolve_path(&p.path, generics);
2061 if let Some(aliased_type) = self.crate_types.type_aliases.get(&resolved_path) {
2062 return self.write_conversion_inline_intern(w, aliased_type, None, is_ref, is_mut, ptr_for_ref, tupleconv, prefix, sliceconv, path_lookup, decl_lookup);
2063 } else if self.is_primitive(&resolved_path) {
2064 if is_ref && prefix {
2065 write!(w, "*").unwrap();
2067 } else if let Some(c_type) = path_lookup(&resolved_path, is_ref, ptr_for_ref) {
2068 write!(w, "{}", c_type).unwrap();
2069 } else if let Some((_, generics)) = self.crate_types.opaques.get(&resolved_path) {
2070 decl_lookup(w, &DeclType::StructImported { generics: &generics }, &resolved_path, is_ref, is_mut);
2071 } else if self.crate_types.mirrored_enums.get(&resolved_path).is_some() {
2072 decl_lookup(w, &DeclType::MirroredEnum, &resolved_path, is_ref, is_mut);
2073 } else if let Some(t) = self.crate_types.traits.get(&resolved_path) {
2074 decl_lookup(w, &DeclType::Trait(t), &resolved_path, is_ref, is_mut);
2075 } else if let Some(ident) = single_ident_generic_path_to_ident(&p.path) {
2076 if let Some(decl_type) = self.types.maybe_resolve_declared(ident) {
2077 decl_lookup(w, decl_type, &self.maybe_resolve_ident(ident).unwrap(), is_ref, is_mut);
2078 } else { unimplemented!(); }
2079 } else { unimplemented!(); }
2081 syn::Type::Array(a) => {
2082 // We assume all arrays contain only [int_literal; X]s.
2083 // This may result in some outputs not compiling.
2084 if let syn::Expr::Lit(l) = &a.len {
2085 if let syn::Lit::Int(i) = &l.lit {
2086 write!(w, "{}", path_lookup(&format!("[u8; {}]", i.base10_digits()), is_ref, ptr_for_ref).unwrap()).unwrap();
2087 } else { unimplemented!(); }
2088 } else { unimplemented!(); }
2090 syn::Type::Slice(s) => {
2091 // We assume all slices contain only literals or references.
2092 // This may result in some outputs not compiling.
2093 if let syn::Type::Path(p) = &*s.elem {
2094 let resolved = self.resolve_path(&p.path, generics);
2095 if self.is_primitive(&resolved) {
2096 write!(w, "{}", path_lookup("[u8]", is_ref, ptr_for_ref).unwrap()).unwrap();
2098 write!(w, "{}", sliceconv(true, None)).unwrap();
2100 } else if let syn::Type::Reference(r) = &*s.elem {
2101 if let syn::Type::Path(p) = &*r.elem {
2102 write!(w, "{}", sliceconv(self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)), None)).unwrap();
2103 } else if let syn::Type::Slice(_) = &*r.elem {
2104 write!(w, "{}", sliceconv(false, None)).unwrap();
2105 } else { unimplemented!(); }
2106 } else if let syn::Type::Tuple(t) = &*s.elem {
2107 assert!(!t.elems.is_empty());
2109 write!(w, "{}", sliceconv(false, None)).unwrap();
2111 let mut needs_map = false;
2112 for e in t.elems.iter() {
2113 if let syn::Type::Reference(_) = e {
2118 let mut map_str = Vec::new();
2119 write!(&mut map_str, ".map(|(").unwrap();
2120 for i in 0..t.elems.len() {
2121 write!(&mut map_str, "{}{}", if i != 0 { ", " } else { "" }, ('a' as u8 + i as u8) as char).unwrap();
2123 write!(&mut map_str, ")| (").unwrap();
2124 for (idx, e) in t.elems.iter().enumerate() {
2125 if let syn::Type::Reference(_) = e {
2126 write!(&mut map_str, "{}{}", if idx != 0 { ", " } else { "" }, (idx as u8 + 'a' as u8) as char).unwrap();
2127 } else if let syn::Type::Path(_) = e {
2128 write!(&mut map_str, "{}*{}", if idx != 0 { ", " } else { "" }, (idx as u8 + 'a' as u8) as char).unwrap();
2129 } else { unimplemented!(); }
2131 write!(&mut map_str, "))").unwrap();
2132 write!(w, "{}", sliceconv(false, Some(&String::from_utf8(map_str).unwrap()))).unwrap();
2134 write!(w, "{}", sliceconv(false, None)).unwrap();
2137 } else if let syn::Type::Array(_) = &*s.elem {
2138 write!(w, "{}", sliceconv(false, Some(".map(|a| *a)"))).unwrap();
2139 } else { unimplemented!(); }
2141 syn::Type::Tuple(t) => {
2142 if t.elems.is_empty() {
2143 // cbindgen has poor support for (), see, eg https://github.com/eqrion/cbindgen/issues/527
2144 // so work around it by just pretending its a 0u8
2145 write!(w, "{}", tupleconv).unwrap();
2147 if prefix { write!(w, "local_").unwrap(); }
2150 _ => unimplemented!(),
2154 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) {
2155 self.write_conversion_inline_intern(w, t, generics, is_ref, false, ptr_for_ref, "() /*", true, |_, _| "local_".to_owned(),
2156 |a, b, c| self.to_c_conversion_inline_prefix_from_path(a, b, c),
2157 |w, decl_type, decl_path, is_ref, _is_mut| {
2159 DeclType::MirroredEnum if is_ref && ptr_for_ref => write!(w, "crate::{}::from_native(", decl_path).unwrap(),
2160 DeclType::MirroredEnum if is_ref => write!(w, "&crate::{}::from_native(", decl_path).unwrap(),
2161 DeclType::MirroredEnum => write!(w, "crate::{}::native_into(", decl_path).unwrap(),
2162 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if is_ref && from_ptr => {
2163 if !ptr_for_ref { write!(w, "&").unwrap(); }
2164 write!(w, "crate::{} {{ inner: unsafe {{ (", decl_path).unwrap()
2166 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if is_ref => {
2167 if !ptr_for_ref { write!(w, "&").unwrap(); }
2168 write!(w, "crate::{} {{ inner: unsafe {{ ObjOps::nonnull_ptr_to_inner((", decl_path).unwrap()
2170 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref && from_ptr =>
2171 write!(w, "crate::{} {{ inner: ", decl_path).unwrap(),
2172 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref =>
2173 write!(w, "crate::{} {{ inner: ObjOps::heap_alloc(", decl_path).unwrap(),
2174 DeclType::Trait(_) if is_ref => write!(w, "").unwrap(),
2175 DeclType::Trait(_) if !is_ref => write!(w, "Into::into(").unwrap(),
2176 _ => panic!("{:?}", decl_path),
2180 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) {
2181 self.write_to_c_conversion_inline_prefix_inner(w, t, generics, false, ptr_for_ref, false);
2183 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) {
2184 self.write_conversion_inline_intern(w, t, generics, is_ref, false, ptr_for_ref, "*/", false, |_, _| ".into()".to_owned(),
2185 |a, b, c| self.to_c_conversion_inline_suffix_from_path(a, b, c),
2186 |w, decl_type, full_path, is_ref, _is_mut| match decl_type {
2187 DeclType::MirroredEnum => write!(w, ")").unwrap(),
2188 DeclType::EnumIgnored { generics }|DeclType::StructImported { generics } if is_ref => {
2189 write!(w, " as *const {}<", full_path).unwrap();
2190 for param in generics.params.iter() {
2191 if let syn::GenericParam::Lifetime(_) = param {
2192 write!(w, "'_, ").unwrap();
2194 write!(w, "_, ").unwrap();
2198 write!(w, ">) as *mut _ }}, is_owned: false }}").unwrap();
2200 write!(w, ">) as *mut _) }}, is_owned: false }}").unwrap();
2203 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref && from_ptr =>
2204 write!(w, ", is_owned: true }}").unwrap(),
2205 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref => write!(w, "), is_owned: true }}").unwrap(),
2206 DeclType::Trait(_) if is_ref => {},
2207 DeclType::Trait(_) => {
2208 // This is used when we're converting a concrete Rust type into a C trait
2209 // for use when a Rust trait method returns an associated type.
2210 // Because all of our C traits implement From<RustTypesImplementingTraits>
2211 // we can just call .into() here and be done.
2212 write!(w, ")").unwrap()
2214 _ => unimplemented!(),
2217 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) {
2218 self.write_to_c_conversion_inline_suffix_inner(w, t, generics, false, ptr_for_ref, false);
2221 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) {
2222 self.write_conversion_inline_intern(w, t, generics, is_ref, false, false, "() /*", true, |_, _| "&local_".to_owned(),
2223 |a, b, _c| self.from_c_conversion_prefix_from_path(a, b),
2224 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
2225 DeclType::StructImported {..} if is_ref => write!(w, "").unwrap(),
2226 DeclType::StructImported {..} if !is_ref => write!(w, "*unsafe {{ Box::from_raw(").unwrap(),
2227 DeclType::MirroredEnum if is_ref => write!(w, "&").unwrap(),
2228 DeclType::MirroredEnum => {},
2229 DeclType::Trait(_) => {},
2230 _ => unimplemented!(),
2233 pub fn write_from_c_conversion_prefix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2234 self.write_from_c_conversion_prefix_inner(w, t, generics, false, false);
2236 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) {
2237 self.write_conversion_inline_intern(w, t, generics, is_ref, false, false, "*/", false,
2238 |has_inner, map_str_opt| match (has_inner, map_str_opt) {
2239 (false, Some(map_str)) => format!(".iter(){}.collect::<Vec<_>>()[..]", map_str),
2240 (false, None) => ".iter().collect::<Vec<_>>()[..]".to_owned(),
2241 (true, None) => "[..]".to_owned(),
2242 (true, Some(_)) => unreachable!(),
2244 |a, b, _c| self.from_c_conversion_suffix_from_path(a, b),
2245 |w, decl_type, _full_path, is_ref, is_mut| match decl_type {
2246 DeclType::StructImported {..} if is_ref && ptr_for_ref => write!(w, "XXX unimplemented").unwrap(),
2247 DeclType::StructImported {..} if is_mut && is_ref => write!(w, ".get_native_mut_ref()").unwrap(),
2248 DeclType::StructImported {..} if is_ref => write!(w, ".get_native_ref()").unwrap(),
2249 DeclType::StructImported {..} if !is_ref => write!(w, ".take_inner()) }}").unwrap(),
2250 DeclType::MirroredEnum if is_ref => write!(w, ".to_native()").unwrap(),
2251 DeclType::MirroredEnum => write!(w, ".into_native()").unwrap(),
2252 DeclType::Trait(_) => {},
2253 _ => unimplemented!(),
2256 pub fn write_from_c_conversion_suffix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2257 self.write_from_c_conversion_suffix_inner(w, t, generics, false, false);
2259 // Note that compared to the above conversion functions, the following two are generally
2260 // significantly undertested:
2261 pub fn write_from_c_conversion_to_ref_prefix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2262 self.write_conversion_inline_intern(w, t, generics, false, false, false, "() /*", true, |_, _| "&local_".to_owned(),
2264 if let Some(conv) = self.from_c_conversion_prefix_from_path(a, b) {
2265 Some(format!("&{}", conv))
2268 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
2269 DeclType::StructImported {..} if !is_ref => write!(w, "").unwrap(),
2270 _ => unimplemented!(),
2273 pub fn write_from_c_conversion_to_ref_suffix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2274 self.write_conversion_inline_intern(w, t, generics, false, false, false, "*/", false,
2275 |has_inner, map_str_opt| match (has_inner, map_str_opt) {
2276 (false, Some(map_str)) => format!(".iter(){}.collect::<Vec<_>>()[..]", map_str),
2277 (false, None) => ".iter().collect::<Vec<_>>()[..]".to_owned(),
2278 (true, None) => "[..]".to_owned(),
2279 (true, Some(_)) => unreachable!(),
2281 |a, b, _c| self.from_c_conversion_suffix_from_path(a, b),
2282 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
2283 DeclType::StructImported {..} if !is_ref => write!(w, ".get_native_ref()").unwrap(),
2284 _ => unimplemented!(),
2288 fn write_conversion_new_var_intern<'b, W: std::io::Write,
2289 LP: Fn(&str, bool) -> Option<(&str, &str)>,
2290 LC: Fn(&str, bool, Option<&syn::Type>, &syn::Ident, &str) -> Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)>,
2291 VP: Fn(&mut W, &syn::Type, Option<&GenericTypes>, bool, bool, bool),
2292 VS: Fn(&mut W, &syn::Type, Option<&GenericTypes>, bool, bool, bool)>
2293 (&self, w: &mut W, ident: &syn::Ident, var: &str, t: &syn::Type, generics: Option<&GenericTypes>,
2294 mut is_ref: bool, mut ptr_for_ref: bool, to_c: bool, from_ownable_ref: bool,
2295 path_lookup: &LP, container_lookup: &LC, var_prefix: &VP, var_suffix: &VS) -> bool {
2297 macro_rules! convert_container {
2298 ($container_type: expr, $args_len: expr, $args_iter: expr) => { {
2299 // For slices (and Options), we refuse to directly map them as is_ref when they
2300 // aren't opaque types containing an inner pointer. This is due to the fact that,
2301 // in both cases, the actual higher-level type is non-is_ref.
2302 let (ty_has_inner, ty_is_trait) = if $args_len == 1 {
2303 let ty = $args_iter().next().unwrap();
2304 if $container_type == "Slice" && to_c {
2305 // "To C ptr_for_ref" means "return the regular object with is_owned
2306 // set to false", which is totally what we want in a slice if we're about to
2307 // set ty_has_inner.
2310 if let syn::Type::Reference(t) = ty {
2311 if let syn::Type::Path(p) = &*t.elem {
2312 let resolved = self.resolve_path(&p.path, generics);
2313 (self.c_type_has_inner_from_path(&resolved), self.crate_types.traits.get(&resolved).is_some())
2314 } else { (false, false) }
2315 } else if let syn::Type::Path(p) = ty {
2316 let resolved = self.resolve_path(&p.path, generics);
2317 (self.c_type_has_inner_from_path(&resolved), self.crate_types.traits.get(&resolved).is_some())
2318 } else { (false, false) }
2319 } else { (true, false) };
2321 // Options get a bunch of special handling, since in general we map Option<>al
2322 // types into the same C type as non-Option-wrapped types. This ends up being
2323 // pretty manual here and most of the below special-cases are for Options.
2324 let mut needs_ref_map = false;
2325 let mut only_contained_type = None;
2326 let mut only_contained_type_nonref = None;
2327 let mut only_contained_has_inner = false;
2328 let mut contains_slice = false;
2330 only_contained_has_inner = ty_has_inner;
2331 let arg = $args_iter().next().unwrap();
2332 if let syn::Type::Reference(t) = arg {
2333 only_contained_type = Some(arg);
2334 only_contained_type_nonref = Some(&*t.elem);
2335 if let syn::Type::Path(_) = &*t.elem {
2337 } else if let syn::Type::Slice(_) = &*t.elem {
2338 contains_slice = true;
2339 } else { return false; }
2340 // If the inner element contains an inner pointer, we will just use that,
2341 // avoiding the need to map elements to references. Otherwise we'll need to
2342 // do an extra mapping step.
2343 needs_ref_map = !only_contained_has_inner && !ty_is_trait && $container_type == "Option";
2345 only_contained_type = Some(arg);
2346 only_contained_type_nonref = Some(arg);
2350 if let Some((prefix, conversions, suffix, prefix_location)) = container_lookup(&$container_type, is_ref, only_contained_type, ident, var) {
2351 assert_eq!(conversions.len(), $args_len);
2352 write!(w, "let mut local_{}{} = ", ident,
2353 if (!to_c && needs_ref_map) || (to_c && $container_type == "Option" && contains_slice) {"_base"} else { "" }).unwrap();
2354 if prefix_location == ContainerPrefixLocation::OutsideConv {
2355 var_prefix(w, $args_iter().next().unwrap(), generics, is_ref, ptr_for_ref, true);
2357 write!(w, "{}{}", prefix, var).unwrap();
2359 for ((pfx, var_name), (idx, ty)) in conversions.iter().zip($args_iter().enumerate()) {
2360 let mut var = std::io::Cursor::new(Vec::new());
2361 write!(&mut var, "{}", var_name).unwrap();
2362 let var_access = String::from_utf8(var.into_inner()).unwrap();
2364 let conv_ty = if needs_ref_map { only_contained_type_nonref.as_ref().unwrap() } else { ty };
2366 write!(w, "{} {{ ", pfx).unwrap();
2367 let new_var_name = format!("{}_{}", ident, idx);
2368 let new_var = self.write_conversion_new_var_intern(w, &format_ident!("{}", new_var_name),
2369 &var_access, conv_ty, generics, contains_slice || (is_ref && ty_has_inner), ptr_for_ref,
2370 to_c, from_ownable_ref, path_lookup, container_lookup, var_prefix, var_suffix);
2371 if new_var { write!(w, " ").unwrap(); }
2373 if prefix_location == ContainerPrefixLocation::PerConv {
2374 var_prefix(w, conv_ty, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2375 } else if !is_ref && !needs_ref_map && to_c && only_contained_has_inner {
2376 write!(w, "ObjOps::heap_alloc(").unwrap();
2379 write!(w, "{}{}", if contains_slice && !to_c { "local_" } else { "" }, if new_var { new_var_name } else { var_access }).unwrap();
2380 if prefix_location == ContainerPrefixLocation::PerConv {
2381 var_suffix(w, conv_ty, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2382 } else if !is_ref && !needs_ref_map && to_c && only_contained_has_inner {
2383 write!(w, ")").unwrap();
2385 write!(w, " }}").unwrap();
2387 write!(w, "{}", suffix).unwrap();
2388 if prefix_location == ContainerPrefixLocation::OutsideConv {
2389 var_suffix(w, $args_iter().next().unwrap(), generics, is_ref, ptr_for_ref, true);
2391 write!(w, ";").unwrap();
2392 if !to_c && needs_ref_map {
2393 write!(w, " let mut local_{} = local_{}_base.as_ref()", ident, ident).unwrap();
2395 write!(w, ".map(|a| &a[..])").unwrap();
2397 write!(w, ";").unwrap();
2398 } else if to_c && $container_type == "Option" && contains_slice {
2399 write!(w, " let mut local_{} = *local_{}_base;", ident, ident).unwrap();
2406 match generics.resolve_type(t) {
2407 syn::Type::Reference(r) => {
2408 if let syn::Type::Slice(_) = &*r.elem {
2409 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)
2411 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)
2414 syn::Type::Path(p) => {
2415 if p.qself.is_some() {
2418 let resolved_path = self.resolve_path(&p.path, generics);
2419 if let Some(aliased_type) = self.crate_types.type_aliases.get(&resolved_path) {
2420 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);
2422 if self.is_known_container(&resolved_path, is_ref) || self.is_path_transparent_container(&p.path, generics, is_ref) {
2423 if let syn::PathArguments::AngleBracketed(args) = &p.path.segments.iter().next().unwrap().arguments {
2424 convert_container!(resolved_path, args.args.len(), || args.args.iter().map(|arg| {
2425 if let syn::GenericArgument::Type(ty) = arg {
2426 generics.resolve_type(ty)
2427 } else { unimplemented!(); }
2429 } else { unimplemented!(); }
2431 if self.is_primitive(&resolved_path) {
2433 } else if let Some(ty_ident) = single_ident_generic_path_to_ident(&p.path) {
2434 if let Some((prefix, suffix)) = path_lookup(&resolved_path, is_ref) {
2435 write!(w, "let mut local_{} = {}{}{};", ident, prefix, var, suffix).unwrap();
2437 } else if self.types.maybe_resolve_declared(ty_ident).is_some() {
2442 syn::Type::Array(_) => {
2443 // We assume all arrays contain only primitive types.
2444 // This may result in some outputs not compiling.
2447 syn::Type::Slice(s) => {
2448 if let syn::Type::Path(p) = &*s.elem {
2449 let resolved = self.resolve_path(&p.path, generics);
2450 if self.is_primitive(&resolved) {
2451 let slice_path = format!("[{}]", resolved);
2452 if let Some((prefix, suffix)) = path_lookup(&slice_path, true) {
2453 write!(w, "let mut local_{} = {}{}{};", ident, prefix, var, suffix).unwrap();
2457 let tyref = [&*s.elem];
2459 // If we're converting from a slice to a Vec, assume we can clone the
2460 // elements and clone them into a new Vec first. Next we'll walk the
2461 // new Vec here and convert them to C types.
2462 write!(w, "let mut local_{}_clone = Vec::new(); local_{}_clone.extend_from_slice({}); let mut {} = local_{}_clone; ", ident, ident, ident, ident, ident).unwrap();
2465 convert_container!("Vec", 1, || tyref.iter().map(|t| generics.resolve_type(*t)));
2466 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2468 } else if let syn::Type::Reference(ty) = &*s.elem {
2469 let tyref = if from_ownable_ref || !to_c { [&*ty.elem] } else { [&*s.elem] };
2471 convert_container!("Slice", 1, || tyref.iter().map(|t| generics.resolve_type(*t)));
2472 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2473 } else if let syn::Type::Tuple(t) = &*s.elem {
2474 // When mapping into a temporary new var, we need to own all the underlying objects.
2475 // Thus, we drop any references inside the tuple and convert with non-reference types.
2476 let mut elems = syn::punctuated::Punctuated::new();
2477 for elem in t.elems.iter() {
2478 if let syn::Type::Reference(r) = elem {
2479 elems.push((*r.elem).clone());
2481 elems.push(elem.clone());
2484 let ty = [syn::Type::Tuple(syn::TypeTuple {
2485 paren_token: t.paren_token, elems
2489 convert_container!("Slice", 1, || ty.iter());
2490 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2491 } else if let syn::Type::Array(_) = &*s.elem {
2494 let arr_elem = [(*s.elem).clone()];
2495 convert_container!("Slice", 1, || arr_elem.iter());
2496 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2497 } else { unimplemented!() }
2499 syn::Type::Tuple(t) => {
2500 if !t.elems.is_empty() {
2501 // We don't (yet) support tuple elements which cannot be converted inline
2502 write!(w, "let (").unwrap();
2503 for idx in 0..t.elems.len() {
2504 if idx != 0 { write!(w, ", ").unwrap(); }
2505 write!(w, "{} orig_{}_{}", if is_ref { "ref" } else { "mut" }, ident, idx).unwrap();
2507 write!(w, ") = {}{}; ", var, if !to_c { ".to_rust()" } else { "" }).unwrap();
2508 // Like other template types, tuples are always mapped as their non-ref
2509 // versions for types which have different ref mappings. Thus, we convert to
2510 // non-ref versions and handle opaque types with inner pointers manually.
2511 for (idx, elem) in t.elems.iter().enumerate() {
2512 if let syn::Type::Path(p) = elem {
2513 let v_name = format!("orig_{}_{}", ident, idx);
2514 let tuple_elem_ident = format_ident!("{}", &v_name);
2515 if self.write_conversion_new_var_intern(w, &tuple_elem_ident, &v_name, elem, generics,
2516 false, ptr_for_ref, to_c, from_ownable_ref,
2517 path_lookup, container_lookup, var_prefix, var_suffix) {
2518 write!(w, " ").unwrap();
2519 // Opaque types with inner pointers shouldn't ever create new stack
2520 // variables, so we don't handle it and just assert that it doesn't
2522 assert!(!self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)));
2526 write!(w, "let mut local_{} = (", ident).unwrap();
2527 for (idx, elem) in t.elems.iter().enumerate() {
2528 let real_elem = generics.resolve_type(&elem);
2529 let ty_has_inner = {
2531 // "To C ptr_for_ref" means "return the regular object with
2532 // is_owned set to false", which is totally what we want
2533 // if we're about to set ty_has_inner.
2536 if let syn::Type::Reference(t) = real_elem {
2537 if let syn::Type::Path(p) = &*t.elem {
2538 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
2540 } else if let syn::Type::Path(p) = real_elem {
2541 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
2544 if idx != 0 { write!(w, ", ").unwrap(); }
2545 var_prefix(w, real_elem, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2546 if is_ref && ty_has_inner {
2547 // For ty_has_inner, the regular var_prefix mapping will take a
2548 // reference, so deref once here to make sure we keep the original ref.
2549 write!(w, "*").unwrap();
2551 write!(w, "orig_{}_{}", ident, idx).unwrap();
2552 if is_ref && !ty_has_inner {
2553 // If we don't have an inner variable's reference to maintain, just
2554 // hope the type is Clonable and use that.
2555 write!(w, ".clone()").unwrap();
2557 var_suffix(w, real_elem, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2559 write!(w, "){};", if to_c { ".into()" } else { "" }).unwrap();
2563 _ => unimplemented!(),
2567 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 {
2568 self.write_conversion_new_var_intern(w, ident, var_access, t, generics, from_ownable_ref, ptr_for_ref, true, from_ownable_ref,
2569 &|a, b| self.to_c_conversion_new_var_from_path(a, b),
2570 &|a, b, c, d, e| self.to_c_conversion_container_new_var(generics, a, b, c, d, e),
2571 // We force ptr_for_ref here since we can't generate a ref on one line and use it later
2572 &|a, b, c, d, e, f| self.write_to_c_conversion_inline_prefix_inner(a, b, c, d, e, f),
2573 &|a, b, c, d, e, f| self.write_to_c_conversion_inline_suffix_inner(a, b, c, d, e, f))
2575 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 {
2576 self.write_to_c_conversion_new_var_inner(w, ident, &format!("{}", ident), t, generics, ptr_for_ref, false)
2578 /// Prints new-var conversion for an "ownable_ref" type, ie prints conversion for
2579 /// `create_ownable_reference(t)`, not `t` itself.
2580 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 {
2581 self.write_to_c_conversion_new_var_inner(w, ident, &format!("{}", ident), t, generics, true, true)
2583 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 {
2584 self.write_conversion_new_var_intern(w, ident, &format!("{}", ident), t, generics, false, false, false, false,
2585 &|a, b| self.from_c_conversion_new_var_from_path(a, b),
2586 &|a, b, c, d, e| self.from_c_conversion_container_new_var(generics, a, b, c, d, e),
2587 // We force ptr_for_ref here since we can't generate a ref on one line and use it later
2588 &|a, b, c, d, e, _f| self.write_from_c_conversion_prefix_inner(a, b, c, d, e),
2589 &|a, b, c, d, e, _f| self.write_from_c_conversion_suffix_inner(a, b, c, d, e))
2592 // ******************************************************
2593 // *** C Container Type Equivalent and alias Printing ***
2594 // ******************************************************
2596 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 {
2597 for (idx, orig_t) in args.enumerate() {
2599 write!(w, ", ").unwrap();
2601 let t = generics.resolve_type(orig_t);
2602 if let syn::Type::Reference(r_arg) = t {
2603 assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
2605 if !self.write_c_type_intern(w, &*r_arg.elem, generics, false, false, false, true, true) { return false; }
2607 // While write_c_type_intern, above is correct, we don't want to blindly convert a
2608 // reference to something stupid, so check that the container is either opaque or a
2609 // predefined type (currently only Transaction).
2610 if let syn::Type::Path(p_arg) = &*r_arg.elem {
2611 let resolved = self.resolve_path(&p_arg.path, generics);
2612 assert!(self.crate_types.opaques.get(&resolved).is_some() ||
2613 self.crate_types.traits.get(&resolved).is_some() ||
2614 self.c_type_from_path(&resolved, true, true).is_some(), "Template generics should be opaque or have a predefined mapping");
2615 } else { unimplemented!(); }
2616 } else if let syn::Type::Path(p_arg) = t {
2617 if let Some(resolved) = self.maybe_resolve_path(&p_arg.path, generics) {
2618 if !self.is_primitive(&resolved) {
2619 assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
2622 assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
2624 if !self.write_c_type_intern(w, t, generics, false, false, false, true, true) { return false; }
2626 // We don't currently support outer reference types for non-primitive inners,
2627 // except for the empty tuple.
2628 if let syn::Type::Tuple(t_arg) = t {
2629 assert!(t_arg.elems.len() == 0 || !is_ref);
2633 if !self.write_c_type_intern(w, t, generics, false, false, false, true, true) { return false; }
2638 fn check_create_container(&self, mangled_container: String, container_type: &str, args: Vec<&syn::Type>, generics: Option<&GenericTypes>, is_ref: bool) -> bool {
2639 if !self.crate_types.templates_defined.borrow().get(&mangled_container).is_some() {
2640 let mut created_container: Vec<u8> = Vec::new();
2642 if container_type == "Result" {
2643 let mut a_ty: Vec<u8> = Vec::new();
2644 if let syn::Type::Tuple(tup) = args.iter().next().unwrap() {
2645 if tup.elems.is_empty() {
2646 write!(&mut a_ty, "()").unwrap();
2648 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t).take(1), generics, is_ref) { return false; }
2651 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t).take(1), generics, is_ref) { return false; }
2654 let mut b_ty: Vec<u8> = Vec::new();
2655 if let syn::Type::Tuple(tup) = args.iter().skip(1).next().unwrap() {
2656 if tup.elems.is_empty() {
2657 write!(&mut b_ty, "()").unwrap();
2659 if !self.write_template_generics(&mut b_ty, &mut args.iter().map(|t| *t).skip(1), generics, is_ref) { return false; }
2662 if !self.write_template_generics(&mut b_ty, &mut args.iter().map(|t| *t).skip(1), generics, is_ref) { return false; }
2665 let ok_str = String::from_utf8(a_ty).unwrap();
2666 let err_str = String::from_utf8(b_ty).unwrap();
2667 let is_clonable = self.is_clonable(&ok_str) && self.is_clonable(&err_str);
2668 write_result_block(&mut created_container, &mangled_container, &ok_str, &err_str, is_clonable);
2670 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2672 } else if container_type == "Vec" {
2673 let mut a_ty: Vec<u8> = Vec::new();
2674 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t), generics, is_ref) { return false; }
2675 let ty = String::from_utf8(a_ty).unwrap();
2676 let is_clonable = self.is_clonable(&ty);
2677 write_vec_block(&mut created_container, &mangled_container, &ty, is_clonable);
2679 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2681 } else if container_type.ends_with("Tuple") {
2682 let mut tuple_args = Vec::new();
2683 let mut is_clonable = true;
2684 for arg in args.iter() {
2685 let mut ty: Vec<u8> = Vec::new();
2686 if !self.write_template_generics(&mut ty, &mut [arg].iter().map(|t| **t), generics, is_ref) { return false; }
2687 let ty_str = String::from_utf8(ty).unwrap();
2688 if !self.is_clonable(&ty_str) {
2689 is_clonable = false;
2691 tuple_args.push(ty_str);
2693 write_tuple_block(&mut created_container, &mangled_container, &tuple_args, is_clonable);
2695 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2697 } else if container_type == "Option" {
2698 let mut a_ty: Vec<u8> = Vec::new();
2699 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t), generics, is_ref) { return false; }
2700 let ty = String::from_utf8(a_ty).unwrap();
2701 let is_clonable = self.is_clonable(&ty);
2702 write_option_block(&mut created_container, &mangled_container, &ty, is_clonable);
2704 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2709 self.crate_types.write_new_template(mangled_container.clone(), true, &created_container);
2713 fn path_to_generic_args(path: &syn::Path) -> Vec<&syn::Type> {
2714 if let syn::PathArguments::AngleBracketed(args) = &path.segments.iter().next().unwrap().arguments {
2715 args.args.iter().map(|gen| if let syn::GenericArgument::Type(t) = gen { t } else { unimplemented!() }).collect()
2716 } else { unimplemented!(); }
2718 fn write_c_mangled_container_path_intern<W: std::io::Write>
2719 (&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 {
2720 let mut mangled_type: Vec<u8> = Vec::new();
2721 if !self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) {
2722 write!(w, "C{}_", ident).unwrap();
2723 write!(mangled_type, "C{}_", ident).unwrap();
2724 } else { assert_eq!(args.len(), 1); }
2725 for arg in args.iter() {
2726 macro_rules! write_path {
2727 ($p_arg: expr, $extra_write: expr) => {
2728 if let Some(subtype) = self.maybe_resolve_path(&$p_arg.path, generics) {
2729 if self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) {
2731 if self.c_type_has_inner_from_path(&subtype) {
2732 if !self.write_c_path_intern(w, &$p_arg.path, generics, is_ref, is_mut, ptr_for_ref, false, true) { return false; }
2734 if let Some(arr_ty) = self.is_real_type_array(&subtype) {
2735 if !self.write_c_type_intern(w, &arr_ty, generics, false, true, false, false, true) { return false; }
2737 // Option<T> needs to be converted to a *mut T, ie mut ptr-for-ref
2738 if !self.write_c_path_intern(w, &$p_arg.path, generics, true, true, true, false, true) { return false; }
2742 write!(w, "{}", $p_arg.path.segments.last().unwrap().ident).unwrap();
2744 } else if self.is_known_container(&subtype, is_ref) || self.is_path_transparent_container(&$p_arg.path, generics, is_ref) {
2745 if !self.write_c_mangled_container_path_intern(w, Self::path_to_generic_args(&$p_arg.path), generics,
2746 &subtype, is_ref, is_mut, ptr_for_ref, true) {
2749 self.write_c_mangled_container_path_intern(&mut mangled_type, Self::path_to_generic_args(&$p_arg.path),
2750 generics, &subtype, is_ref, is_mut, ptr_for_ref, true);
2751 if let Some(w2) = $extra_write as Option<&mut Vec<u8>> {
2752 self.write_c_mangled_container_path_intern(w2, Self::path_to_generic_args(&$p_arg.path),
2753 generics, &subtype, is_ref, is_mut, ptr_for_ref, true);
2756 let id = subtype.rsplitn(2, ':').next().unwrap(); // Get the "Base" name of the resolved type
2757 write!(w, "{}", id).unwrap();
2758 write!(mangled_type, "{}", id).unwrap();
2759 if let Some(w2) = $extra_write as Option<&mut Vec<u8>> {
2760 write!(w2, "{}", id).unwrap();
2763 } else { return false; }
2766 match generics.resolve_type(arg) {
2767 syn::Type::Tuple(tuple) => {
2768 if tuple.elems.len() == 0 {
2769 write!(w, "None").unwrap();
2770 write!(mangled_type, "None").unwrap();
2772 let mut mangled_tuple_type: Vec<u8> = Vec::new();
2774 // Figure out what the mangled type should look like. To disambiguate
2775 // ((A, B), C) and (A, B, C) we prefix the generic args with a _ and suffix
2776 // them with a Z. Ideally we wouldn't use Z, but not many special chars are
2777 // available for use in type names.
2778 write!(w, "C{}Tuple_", tuple.elems.len()).unwrap();
2779 write!(mangled_type, "C{}Tuple_", tuple.elems.len()).unwrap();
2780 write!(mangled_tuple_type, "C{}Tuple_", tuple.elems.len()).unwrap();
2781 for elem in tuple.elems.iter() {
2782 if let syn::Type::Path(p) = elem {
2783 write_path!(p, Some(&mut mangled_tuple_type));
2784 } else if let syn::Type::Reference(refelem) = elem {
2785 if let syn::Type::Path(p) = &*refelem.elem {
2786 write_path!(p, Some(&mut mangled_tuple_type));
2787 } else { return false; }
2788 } else { return false; }
2790 write!(w, "Z").unwrap();
2791 write!(mangled_type, "Z").unwrap();
2792 write!(mangled_tuple_type, "Z").unwrap();
2793 if !self.check_create_container(String::from_utf8(mangled_tuple_type).unwrap(),
2794 &format!("{}Tuple", tuple.elems.len()), tuple.elems.iter().collect(), generics, is_ref) {
2799 syn::Type::Path(p_arg) => {
2800 write_path!(p_arg, None);
2802 syn::Type::Reference(refty) => {
2803 if let syn::Type::Path(p_arg) = &*refty.elem {
2804 write_path!(p_arg, None);
2805 } else if let syn::Type::Slice(_) = &*refty.elem {
2806 // write_c_type will actually do exactly what we want here, we just need to
2807 // make it a pointer so that its an option. Note that we cannot always convert
2808 // the Vec-as-slice (ie non-ref types) containers, so sometimes need to be able
2809 // to edit it, hence we use *mut here instead of *const.
2810 if args.len() != 1 { return false; }
2811 write!(w, "*mut ").unwrap();
2812 self.write_c_type(w, arg, None, true);
2813 } else { return false; }
2815 syn::Type::Array(a) => {
2816 if let syn::Type::Path(p_arg) = &*a.elem {
2817 let resolved = self.resolve_path(&p_arg.path, generics);
2818 if !self.is_primitive(&resolved) { return false; }
2819 if let syn::Expr::Lit(syn::ExprLit { lit: syn::Lit::Int(len), .. }) = &a.len {
2820 if self.c_type_from_path(&format!("[{}; {}]", resolved, len.base10_digits()), is_ref, ptr_for_ref).is_none() { return false; }
2821 if in_type || args.len() != 1 {
2822 write!(w, "_{}{}", resolved, len.base10_digits()).unwrap();
2823 write!(mangled_type, "_{}{}", resolved, len.base10_digits()).unwrap();
2825 let arrty = format!("[{}; {}]", resolved, len.base10_digits());
2826 let realty = self.c_type_from_path(&arrty, is_ref, ptr_for_ref).unwrap_or(&arrty);
2827 write!(w, "{}", realty).unwrap();
2828 write!(mangled_type, "{}", realty).unwrap();
2830 } else { return false; }
2831 } else { return false; }
2833 _ => { return false; },
2836 if self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) { return true; }
2837 // Push the "end of type" Z
2838 write!(w, "Z").unwrap();
2839 write!(mangled_type, "Z").unwrap();
2841 // Make sure the type is actually defined:
2842 self.check_create_container(String::from_utf8(mangled_type).unwrap(), ident, args, generics, is_ref)
2844 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 {
2845 if !self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) {
2846 write!(w, "{}::", Self::generated_container_path()).unwrap();
2848 self.write_c_mangled_container_path_intern(w, args, generics, ident, is_ref, is_mut, ptr_for_ref, false)
2850 pub fn get_c_mangled_container_type(&self, args: Vec<&syn::Type>, generics: Option<&GenericTypes>, template_name: &str) -> Option<String> {
2851 let mut out = Vec::new();
2852 if !self.write_c_mangled_container_path(&mut out, args, generics, template_name, false, false, false) {
2855 Some(String::from_utf8(out).unwrap())
2858 // **********************************
2859 // *** C Type Equivalent Printing ***
2860 // **********************************
2862 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 {
2863 let full_path = match self.maybe_resolve_path(&path, generics) {
2864 Some(path) => path, None => return false };
2865 if let Some(c_type) = self.c_type_from_path(&full_path, is_ref, ptr_for_ref) {
2866 write!(w, "{}", c_type).unwrap();
2868 } else if self.crate_types.traits.get(&full_path).is_some() {
2869 // Note that we always use the crate:: prefix here as we are always referring to a
2870 // concrete object which is of the generated type, it just implements the upstream
2872 if is_ref && ptr_for_ref {
2873 write!(w, "*{} crate::{}", if is_mut { "mut" } else { "const" }, full_path).unwrap();
2875 if with_ref_lifetime { unimplemented!(); }
2876 write!(w, "&{}crate::{}", if is_mut { "mut " } else { "" }, full_path).unwrap();
2878 write!(w, "crate::{}", full_path).unwrap();
2881 } else if self.crate_types.opaques.get(&full_path).is_some() || self.crate_types.mirrored_enums.get(&full_path).is_some() {
2882 let crate_pfx = if c_ty { "crate::" } else { "" };
2883 if is_ref && ptr_for_ref {
2884 // ptr_for_ref implies we're returning the object, which we can't really do for
2885 // opaque or mirrored types without box'ing them, which is quite a waste, so return
2886 // the actual object itself (for opaque types we'll set the pointer to the actual
2887 // type and note that its a reference).
2888 write!(w, "{}{}", crate_pfx, full_path).unwrap();
2889 } else if is_ref && with_ref_lifetime {
2891 // If we're concretizing something with a lifetime parameter, we have to pick a
2892 // lifetime, of which the only real available choice is `static`, obviously.
2893 write!(w, "&'static {}", crate_pfx).unwrap();
2895 self.write_rust_path(w, generics, path, with_ref_lifetime, false);
2897 // We shouldn't be mapping references in types, so panic here
2901 write!(w, "&{}{}{}", if is_mut { "mut " } else { "" }, crate_pfx, full_path).unwrap();
2903 write!(w, "{}{}", crate_pfx, full_path).unwrap();
2910 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 {
2911 match generics.resolve_type(t) {
2912 syn::Type::Path(p) => {
2913 if p.qself.is_some() {
2916 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
2917 if self.is_known_container(&full_path, is_ref) || self.is_path_transparent_container(&p.path, generics, is_ref) {
2918 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);
2920 if let Some(aliased_type) = self.crate_types.type_aliases.get(&full_path).cloned() {
2921 return self.write_c_type_intern(w, &aliased_type, None, is_ref, is_mut, ptr_for_ref, with_ref_lifetime, c_ty);
2924 self.write_c_path_intern(w, &p.path, generics, is_ref, is_mut, ptr_for_ref, with_ref_lifetime, c_ty)
2926 syn::Type::Reference(r) => {
2927 self.write_c_type_intern(w, &*r.elem, generics, true, r.mutability.is_some(), ptr_for_ref, with_ref_lifetime, c_ty)
2929 syn::Type::Array(a) => {
2930 if is_ref && is_mut {
2931 write!(w, "*mut [").unwrap();
2932 if !self.write_c_type_intern(w, &a.elem, generics, false, false, ptr_for_ref, with_ref_lifetime, c_ty) { return false; }
2934 write!(w, "*const [").unwrap();
2935 if !self.write_c_type_intern(w, &a.elem, generics, false, false, ptr_for_ref, with_ref_lifetime, c_ty) { return false; }
2937 let mut typecheck = Vec::new();
2938 if !self.write_c_type_intern(&mut typecheck, &a.elem, generics, false, false, ptr_for_ref, with_ref_lifetime, c_ty) { return false; }
2939 if typecheck[..] != ['u' as u8, '8' as u8] { return false; }
2941 if let syn::Expr::Lit(l) = &a.len {
2942 if let syn::Lit::Int(i) = &l.lit {
2944 if let Some(ty) = self.c_type_from_path(&format!("[u8; {}]", i.base10_digits()), false, ptr_for_ref) {
2945 write!(w, "{}", ty).unwrap();
2949 write!(w, "; {}]", i).unwrap();
2955 syn::Type::Slice(s) => {
2956 if !is_ref || is_mut { return false; }
2957 if let syn::Type::Path(p) = &*s.elem {
2958 let resolved = self.resolve_path(&p.path, generics);
2959 if self.is_primitive(&resolved) {
2960 write!(w, "{}::{}slice", Self::container_templ_path(), resolved).unwrap();
2963 let mut inner_c_ty = Vec::new();
2964 assert!(self.write_c_path_intern(&mut inner_c_ty, &p.path, generics, true, false, ptr_for_ref, with_ref_lifetime, c_ty));
2965 if self.is_clonable(&String::from_utf8(inner_c_ty).unwrap()) {
2966 if let Some(id) = p.path.get_ident() {
2967 let mangled_container = format!("CVec_{}Z", id);
2968 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
2969 self.check_create_container(mangled_container, "Vec", vec![&*s.elem], generics, false)
2973 } else if let syn::Type::Reference(r) = &*s.elem {
2974 if let syn::Type::Path(p) = &*r.elem {
2975 // Slices with "real types" inside are mapped as the equivalent non-ref Vec
2976 let resolved = self.resolve_path(&p.path, generics);
2977 let mangled_container = if let Some((ident, _)) = self.crate_types.opaques.get(&resolved) {
2978 format!("CVec_{}Z", ident)
2979 } else if let Some(en) = self.crate_types.mirrored_enums.get(&resolved) {
2980 format!("CVec_{}Z", en.ident)
2981 } else if let Some(id) = p.path.get_ident() {
2982 format!("CVec_{}Z", id)
2983 } else { return false; };
2984 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
2985 self.check_create_container(mangled_container, "Vec", vec![&*r.elem], generics, false)
2986 } else if let syn::Type::Slice(sl2) = &*r.elem {
2987 if let syn::Type::Reference(r2) = &*sl2.elem {
2988 if let syn::Type::Path(p) = &*r2.elem {
2989 // Slices with slices with opaque types (with is_owned flags) are mapped as non-ref Vecs
2990 let resolved = self.resolve_path(&p.path, generics);
2991 let mangled_container = if let Some((ident, _)) = self.crate_types.opaques.get(&resolved) {
2992 format!("CVec_CVec_{}ZZ", ident)
2993 } else { return false; };
2994 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
2995 let inner = &r2.elem;
2996 let vec_ty: syn::Type = syn::parse_quote!(Vec<#inner>);
2997 self.check_create_container(mangled_container, "Vec", vec![&vec_ty], generics, false)
3001 } else if let syn::Type::Tuple(_) = &*s.elem {
3002 let mut args = syn::punctuated::Punctuated::<_, syn::token::Comma>::new();
3003 args.push(syn::GenericArgument::Type((*s.elem).clone()));
3004 let mut segments = syn::punctuated::Punctuated::new();
3005 segments.push(parse_quote!(Vec<#args>));
3006 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)
3007 } else if let syn::Type::Array(a) = &*s.elem {
3008 if let syn::Expr::Lit(l) = &a.len {
3009 if let syn::Lit::Int(i) = &l.lit {
3010 let mut buf = Vec::new();
3011 self.write_rust_type(&mut buf, generics, &*a.elem, false);
3012 let arr_ty = String::from_utf8(buf).unwrap();
3014 let arr_str = format!("[{}; {}]", arr_ty, i.base10_digits());
3015 let ty = self.c_type_from_path(&arr_str, false, ptr_for_ref).unwrap()
3016 .rsplitn(2, "::").next().unwrap();
3018 let mangled_container = format!("CVec_{}Z", ty);
3019 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
3020 self.check_create_container(mangled_container, "Vec", vec![&*s.elem], generics, false)
3025 syn::Type::Tuple(t) => {
3026 if t.elems.len() == 0 {
3029 self.write_c_mangled_container_path(w, t.elems.iter().collect(), generics,
3030 &format!("{}Tuple", t.elems.len()), is_ref, is_mut, ptr_for_ref)
3036 pub fn write_c_type<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, ptr_for_ref: bool) {
3037 assert!(self.write_c_type_intern(w, t, generics, false, false, ptr_for_ref, false, true));
3039 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) {
3040 assert!(self.write_c_type_intern(w, t, generics, false, false, ptr_for_ref, true, false));
3042 pub fn understood_c_path(&self, p: &syn::Path) -> bool {
3043 self.write_c_path_intern(&mut std::io::sink(), p, None, false, false, false, false, true)
3045 pub fn understood_c_type(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> bool {
3046 self.write_c_type_intern(&mut std::io::sink(), t, generics, false, false, false, false, true)