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<'b, 'c>(&mut self, generics: &'a syn::Generics, types: &'b TypeResolver<'a, 'c>) -> bool {
209 let mut new_typed_generics = HashMap::new();
210 // First learn simple generics...
211 for generic in generics.params.iter() {
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)));
268 // Then find generics where we are required to pass a Deref<Target=X> and pretend its just X.
269 if let Some(wh) = &generics.where_clause {
270 for pred in wh.predicates.iter() {
271 if let syn::WherePredicate::Type(t) = pred {
272 if let syn::Type::Path(p) = &t.bounded_ty {
273 if p.qself.is_some() { return false; }
274 if p.path.leading_colon.is_some() { return false; }
275 let mut p_iter = p.path.segments.iter();
276 let p_ident = &p_iter.next().unwrap().ident;
277 if let Some(gen) = new_typed_generics.get_mut(p_ident) {
278 if gen.is_some() { return false; }
279 if &format!("{}", p_iter.next().unwrap().ident) != "Target" {return false; }
281 let mut non_lifetimes_processed = false;
282 for bound in t.bounds.iter() {
283 if let syn::TypeParamBound::Trait(trait_bound) = bound {
284 if let Some(id) = trait_bound.path.get_ident() {
285 if format!("{}", id) == "Sized" { continue; }
287 if non_lifetimes_processed { return false; }
288 non_lifetimes_processed = true;
289 assert_simple_bound(&trait_bound);
290 let resolved = types.resolve_path(&trait_bound.path, None);
291 let ty = syn::Type::Path(syn::TypePath {
292 qself: None, path: string_path_to_syn_path(&resolved)
294 let ref_ty = parse_quote!(&#ty);
295 let mut_ref_ty = parse_quote!(&mut #ty);
296 if types.crate_types.traits.get(&resolved).is_some() {
297 self.default_generics.insert(p_ident, (ty, ref_ty, mut_ref_ty));
299 self.default_generics.insert(p_ident, (ref_ty.clone(), ref_ty, mut_ref_ty));
302 *gen = Some(resolved);
305 } else { return false; }
306 } else { return false; }
310 for (key, value) in new_typed_generics.drain() {
311 if let Some(v) = value {
312 assert!(self.typed_generics.insert(key, v).is_none());
313 } else { return false; }
318 /// Learn the associated types from the trait in the current context.
319 pub fn learn_associated_types<'b, 'c>(&mut self, t: &'a syn::ItemTrait, types: &'b TypeResolver<'a, 'c>) {
320 for item in t.items.iter() {
322 &syn::TraitItem::Type(ref t) => {
323 if t.default.is_some() || t.generics.lt_token.is_some() { unimplemented!(); }
324 let mut bounds_iter = t.bounds.iter();
326 match bounds_iter.next().unwrap() {
327 syn::TypeParamBound::Trait(tr) => {
328 assert_simple_bound(&tr);
329 if let Some(path) = types.maybe_resolve_path(&tr.path, None) {
330 if types.skip_path(&path) { continue; }
331 // In general we handle Deref<Target=X> as if it were just X (and
332 // implement Deref<Target=Self> for relevant types). We don't
333 // bother to implement it for associated types, however, so we just
334 // ignore such bounds.
335 if path != "std::ops::Deref" && path != "core::ops::Deref" {
336 self.typed_generics.insert(&t.ident, path);
338 } else { unimplemented!(); }
339 for bound in bounds_iter {
340 if let syn::TypeParamBound::Trait(_) = bound { unimplemented!(); }
344 syn::TypeParamBound::Lifetime(_) => {},
353 /// Attempt to resolve a Path as a generic parameter and return the full path. as both a string
355 pub fn maybe_resolve_path<'b>(&'b self, path: &syn::Path) -> Option<&'b String> {
356 if let Some(ident) = path.get_ident() {
357 if let Some(ty) = &self.self_ty {
358 if format!("{}", ident) == "Self" {
362 if let Some(res) = self.typed_generics.get(ident) {
366 // Associated types are usually specified as "Self::Generic", so we check for that
368 let mut it = path.segments.iter();
369 if path.segments.len() == 2 && format!("{}", it.next().unwrap().ident) == "Self" {
370 let ident = &it.next().unwrap().ident;
371 if let Some(res) = self.typed_generics.get(ident) {
376 if let Some(parent) = self.parent {
377 parent.maybe_resolve_path(path)
384 pub trait ResolveType<'a> { fn resolve_type(&'a self, ty: &'a syn::Type) -> &'a syn::Type; }
385 impl<'a, 'b, 'c: 'a + 'b> ResolveType<'c> for Option<&GenericTypes<'a, 'b>> {
386 fn resolve_type(&'c self, ty: &'c syn::Type) -> &'c syn::Type {
387 if let Some(us) = self {
389 syn::Type::Path(p) => {
390 if let Some(ident) = p.path.get_ident() {
391 if let Some((ty, _, _)) = us.default_generics.get(ident) {
392 return self.resolve_type(ty);
396 syn::Type::Reference(syn::TypeReference { elem, mutability, .. }) => {
397 if let syn::Type::Path(p) = &**elem {
398 if let Some(ident) = p.path.get_ident() {
399 if let Some((_, refty, mut_ref_ty)) = us.default_generics.get(ident) {
400 if mutability.is_some() {
401 return self.resolve_type(mut_ref_ty);
403 return self.resolve_type(refty);
411 us.parent.resolve_type(ty)
416 #[derive(Clone, PartialEq)]
417 // The type of declaration and the object itself
418 pub enum DeclType<'a> {
420 Trait(&'a syn::ItemTrait),
421 StructImported { generics: &'a syn::Generics },
423 EnumIgnored { generics: &'a syn::Generics },
426 pub struct ImportResolver<'mod_lifetime, 'crate_lft: 'mod_lifetime> {
427 pub crate_name: &'mod_lifetime str,
428 dependencies: &'mod_lifetime HashSet<syn::Ident>,
429 module_path: &'mod_lifetime str,
430 imports: HashMap<syn::Ident, (String, syn::Path)>,
431 declared: HashMap<syn::Ident, DeclType<'crate_lft>>,
432 priv_modules: HashSet<syn::Ident>,
434 impl<'mod_lifetime, 'crate_lft: 'mod_lifetime> ImportResolver<'mod_lifetime, 'crate_lft> {
435 fn process_use_intern(crate_name: &str, module_path: &str, dependencies: &HashSet<syn::Ident>, imports: &mut HashMap<syn::Ident, (String, syn::Path)>,
436 u: &syn::UseTree, partial_path: &str, mut path: syn::punctuated::Punctuated<syn::PathSegment, syn::token::Colon2>) {
439 macro_rules! push_path {
440 ($ident: expr, $path_suffix: expr) => {
441 if partial_path == "" && format!("{}", $ident) == "super" {
442 let mut mod_iter = module_path.rsplitn(2, "::");
443 mod_iter.next().unwrap();
444 let super_mod = mod_iter.next().unwrap();
445 new_path = format!("{}{}", super_mod, $path_suffix);
446 assert_eq!(path.len(), 0);
447 for module in super_mod.split("::") {
448 path.push(syn::PathSegment { ident: syn::Ident::new(module, Span::call_site()), arguments: syn::PathArguments::None });
450 } else if partial_path == "" && format!("{}", $ident) == "self" {
451 new_path = format!("{}{}", module_path, $path_suffix);
452 for module in module_path.split("::") {
453 path.push(syn::PathSegment { ident: syn::Ident::new(module, Span::call_site()), arguments: syn::PathArguments::None });
455 } else if partial_path == "" && format!("{}", $ident) == "crate" {
456 new_path = format!("{}{}", crate_name, $path_suffix);
457 let crate_name_ident = format_ident!("{}", crate_name);
458 path.push(parse_quote!(#crate_name_ident));
459 } else if partial_path == "" && !dependencies.contains(&$ident) {
460 new_path = format!("{}::{}{}", crate_name, $ident, $path_suffix);
461 let crate_name_ident = format_ident!("{}", crate_name);
462 path.push(parse_quote!(#crate_name_ident));
463 } else if format!("{}", $ident) == "self" {
464 let mut path_iter = partial_path.rsplitn(2, "::");
465 path_iter.next().unwrap();
466 new_path = path_iter.next().unwrap().to_owned();
468 new_path = format!("{}{}{}", partial_path, $ident, $path_suffix);
471 path.push(parse_quote!(#ident));
475 syn::UseTree::Path(p) => {
476 push_path!(p.ident, "::");
477 Self::process_use_intern(crate_name, module_path, dependencies, imports, &p.tree, &new_path, path);
479 syn::UseTree::Name(n) => {
480 push_path!(n.ident, "");
481 let imported_ident = syn::Ident::new(new_path.rsplitn(2, "::").next().unwrap(), Span::call_site());
482 imports.insert(imported_ident, (new_path, syn::Path { leading_colon: Some(syn::Token![::](Span::call_site())), segments: path }));
484 syn::UseTree::Group(g) => {
485 for i in g.items.iter() {
486 Self::process_use_intern(crate_name, module_path, dependencies, imports, i, partial_path, path.clone());
489 syn::UseTree::Rename(r) => {
490 push_path!(r.ident, "");
491 imports.insert(r.rename.clone(), (new_path, syn::Path { leading_colon: Some(syn::Token![::](Span::call_site())), segments: path }));
493 syn::UseTree::Glob(_) => {
494 eprintln!("Ignoring * use for {} - this may result in resolution failures", partial_path);
499 fn process_use(crate_name: &str, module_path: &str, dependencies: &HashSet<syn::Ident>, imports: &mut HashMap<syn::Ident, (String, syn::Path)>, u: &syn::ItemUse) {
500 if let syn::Visibility::Public(_) = u.vis {
501 // We actually only use these for #[cfg(fuzztarget)]
502 eprintln!("Ignoring pub(use) tree!");
505 if u.leading_colon.is_some() { eprintln!("Ignoring leading-colon use!"); return; }
506 Self::process_use_intern(crate_name, module_path, dependencies, imports, &u.tree, "", syn::punctuated::Punctuated::new());
509 fn insert_primitive(imports: &mut HashMap<syn::Ident, (String, syn::Path)>, id: &str) {
510 let ident = format_ident!("{}", id);
511 let path = parse_quote!(#ident);
512 imports.insert(ident, (id.to_owned(), path));
515 pub fn new(crate_name: &'mod_lifetime str, dependencies: &'mod_lifetime HashSet<syn::Ident>, module_path: &'mod_lifetime str, contents: &'crate_lft [syn::Item]) -> Self {
516 Self::from_borrowed_items(crate_name, dependencies, module_path, &contents.iter().map(|a| a).collect::<Vec<_>>())
518 pub fn from_borrowed_items(crate_name: &'mod_lifetime str, dependencies: &'mod_lifetime HashSet<syn::Ident>, module_path: &'mod_lifetime str, contents: &[&'crate_lft syn::Item]) -> Self {
519 let mut imports = HashMap::new();
520 // Add primitives to the "imports" list:
521 Self::insert_primitive(&mut imports, "bool");
522 Self::insert_primitive(&mut imports, "u64");
523 Self::insert_primitive(&mut imports, "u32");
524 Self::insert_primitive(&mut imports, "u16");
525 Self::insert_primitive(&mut imports, "u8");
526 Self::insert_primitive(&mut imports, "usize");
527 Self::insert_primitive(&mut imports, "str");
528 Self::insert_primitive(&mut imports, "String");
530 // These are here to allow us to print native Rust types in trait fn impls even if we don't
532 Self::insert_primitive(&mut imports, "Result");
533 Self::insert_primitive(&mut imports, "Vec");
534 Self::insert_primitive(&mut imports, "Option");
536 let mut declared = HashMap::new();
537 let mut priv_modules = HashSet::new();
539 for item in contents.iter() {
541 syn::Item::Use(u) => Self::process_use(crate_name, module_path, dependencies, &mut imports, &u),
542 syn::Item::Struct(s) => {
543 if let syn::Visibility::Public(_) = s.vis {
544 match export_status(&s.attrs) {
545 ExportStatus::Export => { declared.insert(s.ident.clone(), DeclType::StructImported { generics: &s.generics }); },
546 ExportStatus::NoExport => { declared.insert(s.ident.clone(), DeclType::StructIgnored); },
547 ExportStatus::TestOnly => continue,
548 ExportStatus::NotImplementable => panic!("(C-not implementable) should only appear on traits!"),
552 syn::Item::Type(t) if export_status(&t.attrs) == ExportStatus::Export => {
553 if let syn::Visibility::Public(_) = t.vis {
554 declared.insert(t.ident.clone(), DeclType::StructImported { generics: &t.generics });
557 syn::Item::Enum(e) => {
558 if let syn::Visibility::Public(_) = e.vis {
559 match export_status(&e.attrs) {
560 ExportStatus::Export if is_enum_opaque(e) => { declared.insert(e.ident.clone(), DeclType::EnumIgnored { generics: &e.generics }); },
561 ExportStatus::Export => { declared.insert(e.ident.clone(), DeclType::MirroredEnum); },
562 ExportStatus::NotImplementable => panic!("(C-not implementable) should only appear on traits!"),
567 syn::Item::Trait(t) => {
568 match export_status(&t.attrs) {
569 ExportStatus::Export|ExportStatus::NotImplementable => {
570 if let syn::Visibility::Public(_) = t.vis {
571 declared.insert(t.ident.clone(), DeclType::Trait(t));
577 syn::Item::Mod(m) => {
578 priv_modules.insert(m.ident.clone());
584 Self { crate_name, dependencies, module_path, imports, declared, priv_modules }
587 pub fn maybe_resolve_declared(&self, id: &syn::Ident) -> Option<&DeclType<'crate_lft>> {
588 self.declared.get(id)
591 pub fn maybe_resolve_ident(&self, id: &syn::Ident) -> Option<String> {
592 if let Some((imp, _)) = self.imports.get(id) {
594 } else if self.declared.get(id).is_some() {
595 Some(self.module_path.to_string() + "::" + &format!("{}", id))
599 pub fn maybe_resolve_path(&self, p: &syn::Path, generics: Option<&GenericTypes>) -> Option<String> {
600 if let Some(gen_types) = generics {
601 if let Some(resp) = gen_types.maybe_resolve_path(p) {
602 return Some(resp.clone());
606 if p.leading_colon.is_some() {
607 let mut res: String = p.segments.iter().enumerate().map(|(idx, seg)| {
608 format!("{}{}", if idx == 0 { "" } else { "::" }, seg.ident)
610 let firstseg = p.segments.iter().next().unwrap();
611 if !self.dependencies.contains(&firstseg.ident) {
612 res = self.crate_name.to_owned() + "::" + &res;
615 } else if let Some(id) = p.get_ident() {
616 self.maybe_resolve_ident(id)
618 if p.segments.len() == 1 {
619 let seg = p.segments.iter().next().unwrap();
620 return self.maybe_resolve_ident(&seg.ident);
622 let mut seg_iter = p.segments.iter();
623 let first_seg = seg_iter.next().unwrap();
624 let remaining: String = seg_iter.map(|seg| {
625 format!("::{}", seg.ident)
627 let first_seg_str = format!("{}", first_seg.ident);
628 if let Some((imp, _)) = self.imports.get(&first_seg.ident) {
630 Some(imp.clone() + &remaining)
634 } else if let Some(_) = self.priv_modules.get(&first_seg.ident) {
635 Some(format!("{}::{}{}", self.module_path, first_seg.ident, remaining))
636 } else if first_seg_is_stdlib(&first_seg_str) || self.dependencies.contains(&first_seg.ident) {
637 Some(first_seg_str + &remaining)
642 /// Map all the Paths in a Type into absolute paths given a set of imports (generated via process_use_intern)
643 pub fn resolve_imported_refs(&self, mut ty: syn::Type) -> syn::Type {
645 syn::Type::Path(p) => {
646 if p.path.segments.len() != 1 { unimplemented!(); }
647 let mut args = p.path.segments[0].arguments.clone();
648 if let syn::PathArguments::AngleBracketed(ref mut generics) = &mut args {
649 for arg in generics.args.iter_mut() {
650 if let syn::GenericArgument::Type(ref mut t) = arg {
651 *t = self.resolve_imported_refs(t.clone());
655 if let Some((_, newpath)) = self.imports.get(single_ident_generic_path_to_ident(&p.path).unwrap()) {
656 p.path = newpath.clone();
658 p.path.segments[0].arguments = args;
660 syn::Type::Reference(r) => {
661 r.elem = Box::new(self.resolve_imported_refs((*r.elem).clone()));
663 syn::Type::Slice(s) => {
664 s.elem = Box::new(self.resolve_imported_refs((*s.elem).clone()));
666 syn::Type::Tuple(t) => {
667 for e in t.elems.iter_mut() {
668 *e = self.resolve_imported_refs(e.clone());
671 _ => unimplemented!(),
677 // templates_defined is walked to write the C++ header, so if we use the default hashing it get
678 // reordered on each genbindings run. Instead, we use SipHasher (which defaults to 0-keys) so that
679 // the sorting is stable across runs. It is deprecated, but the "replacement" doesn't actually
680 // accomplish the same goals, so we just ignore it.
682 pub type NonRandomHash = hash::BuildHasherDefault<hash::SipHasher>;
685 pub struct ASTModule {
686 pub attrs: Vec<syn::Attribute>,
687 pub items: Vec<syn::Item>,
688 pub submods: Vec<String>,
690 /// A struct containing the syn::File AST for each file in the crate.
691 pub struct FullLibraryAST {
692 pub modules: HashMap<String, ASTModule, NonRandomHash>,
693 pub dependencies: HashSet<syn::Ident>,
695 impl FullLibraryAST {
696 fn load_module(&mut self, module: String, attrs: Vec<syn::Attribute>, mut items: Vec<syn::Item>) {
697 let mut non_mod_items = Vec::with_capacity(items.len());
698 let mut submods = Vec::with_capacity(items.len());
699 for item in items.drain(..) {
701 syn::Item::Mod(m) if m.content.is_some() => {
702 if export_status(&m.attrs) == ExportStatus::Export {
703 if let syn::Visibility::Public(_) = m.vis {
704 let modident = format!("{}", m.ident);
705 let modname = if module != "" {
706 module.clone() + "::" + &modident
708 self.dependencies.insert(m.ident);
711 self.load_module(modname, m.attrs, m.content.unwrap().1);
712 submods.push(modident);
714 non_mod_items.push(syn::Item::Mod(m));
718 syn::Item::Mod(_) => panic!("--pretty=expanded output should never have non-body modules"),
719 syn::Item::ExternCrate(c) => {
720 if export_status(&c.attrs) == ExportStatus::Export {
721 self.dependencies.insert(c.ident);
724 _ => { non_mod_items.push(item); }
727 self.modules.insert(module, ASTModule { attrs, items: non_mod_items, submods });
730 pub fn load_lib(lib: syn::File) -> Self {
731 assert_eq!(export_status(&lib.attrs), ExportStatus::Export);
732 let mut res = Self { modules: HashMap::default(), dependencies: HashSet::new() };
733 res.load_module("".to_owned(), lib.attrs, lib.items);
738 /// List of manually-generated types which are clonable
739 fn initial_clonable_types() -> HashSet<String> {
740 let mut res = HashSet::new();
741 res.insert("crate::c_types::u5".to_owned());
742 res.insert("crate::c_types::FourBytes".to_owned());
743 res.insert("crate::c_types::TwelveBytes".to_owned());
744 res.insert("crate::c_types::SixteenBytes".to_owned());
745 res.insert("crate::c_types::TwentyBytes".to_owned());
746 res.insert("crate::c_types::ThirtyTwoBytes".to_owned());
747 res.insert("crate::c_types::SecretKey".to_owned());
748 res.insert("crate::c_types::PublicKey".to_owned());
749 res.insert("crate::c_types::Transaction".to_owned());
750 res.insert("crate::c_types::TxOut".to_owned());
751 res.insert("crate::c_types::Signature".to_owned());
752 res.insert("crate::c_types::RecoverableSignature".to_owned());
753 res.insert("crate::c_types::Bech32Error".to_owned());
754 res.insert("crate::c_types::Secp256k1Error".to_owned());
755 res.insert("crate::c_types::IOError".to_owned());
756 res.insert("crate::c_types::Error".to_owned());
757 res.insert("crate::c_types::Str".to_owned());
759 // Because some types are manually-mapped to CVec_u8Z we may end up checking if its clonable
760 // before we ever get to constructing the type fully via
761 // `write_c_mangled_container_path_intern` (which will add it here too), so we have to manually
762 // add it on startup.
763 res.insert("crate::c_types::derived::CVec_u8Z".to_owned());
767 /// Top-level struct tracking everything which has been defined while walking the crate.
768 pub struct CrateTypes<'a> {
769 /// This may contain structs or enums, but only when either is mapped as
770 /// struct X { inner: *mut originalX, .. }
771 pub opaques: HashMap<String, (&'a syn::Ident, &'a syn::Generics)>,
772 /// structs that weren't exposed
773 pub priv_structs: HashMap<String, &'a syn::Generics>,
774 /// Enums which are mapped as C enums with conversion functions
775 pub mirrored_enums: HashMap<String, &'a syn::ItemEnum>,
776 /// Traits which are mapped as a pointer + jump table
777 pub traits: HashMap<String, &'a syn::ItemTrait>,
778 /// Aliases from paths to some other Type
779 pub type_aliases: HashMap<String, syn::Type>,
780 /// Value is an alias to Key (maybe with some generics)
781 pub reverse_alias_map: HashMap<String, Vec<(String, syn::PathArguments)>>,
782 /// Template continer types defined, map from mangled type name -> whether a destructor fn
785 /// This is used at the end of processing to make C++ wrapper classes
786 pub templates_defined: RefCell<HashMap<String, bool, NonRandomHash>>,
787 /// The output file for any created template container types, written to as we find new
788 /// template containers which need to be defined.
789 template_file: RefCell<&'a mut File>,
790 /// Set of containers which are clonable
791 clonable_types: RefCell<HashSet<String>>,
793 pub trait_impls: HashMap<String, Vec<String>>,
794 /// The full set of modules in the crate(s)
795 pub lib_ast: &'a FullLibraryAST,
798 impl<'a> CrateTypes<'a> {
799 pub fn new(template_file: &'a mut File, libast: &'a FullLibraryAST) -> Self {
801 opaques: HashMap::new(), mirrored_enums: HashMap::new(), traits: HashMap::new(),
802 type_aliases: HashMap::new(), reverse_alias_map: HashMap::new(),
803 templates_defined: RefCell::new(HashMap::default()), priv_structs: HashMap::new(),
804 clonable_types: RefCell::new(initial_clonable_types()), trait_impls: HashMap::new(),
805 template_file: RefCell::new(template_file), lib_ast: &libast,
808 pub fn set_clonable(&self, object: String) {
809 self.clonable_types.borrow_mut().insert(object);
811 pub fn is_clonable(&self, object: &str) -> bool {
812 self.clonable_types.borrow().contains(object)
814 pub fn write_new_template(&self, mangled_container: String, has_destructor: bool, created_container: &[u8]) {
815 self.template_file.borrow_mut().write(created_container).unwrap();
816 self.templates_defined.borrow_mut().insert(mangled_container, has_destructor);
820 /// A struct which tracks resolving rust types into C-mapped equivalents, exists for one specific
821 /// module but contains a reference to the overall CrateTypes tracking.
822 pub struct TypeResolver<'mod_lifetime, 'crate_lft: 'mod_lifetime> {
823 pub module_path: &'mod_lifetime str,
824 pub crate_types: &'mod_lifetime CrateTypes<'crate_lft>,
825 pub types: ImportResolver<'mod_lifetime, 'crate_lft>,
828 /// Returned by write_empty_rust_val_check_suffix to indicate what type of dereferencing needs to
829 /// happen to get the inner value of a generic.
830 enum EmptyValExpectedTy {
831 /// A type which has a flag for being empty (eg an array where we treat all-0s as empty).
833 /// A Option mapped as a COption_*Z
835 /// A pointer which we want to convert to a reference.
840 /// Describes the appropriate place to print a general type-conversion string when converting a
842 enum ContainerPrefixLocation {
843 /// Prints a general type-conversion string prefix and suffix outside of the
844 /// container-conversion strings.
846 /// Prints a general type-conversion string prefix and suffix inside of the
847 /// container-conversion strings.
849 /// Does not print the usual type-conversion string prefix and suffix.
853 impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
854 pub fn new(module_path: &'a str, types: ImportResolver<'a, 'c>, crate_types: &'a CrateTypes<'c>) -> Self {
855 Self { module_path, types, crate_types }
858 // *************************************************
859 // *** Well know type and conversion definitions ***
860 // *************************************************
862 /// Returns true we if can just skip passing this to C entirely
863 pub fn skip_path(&self, full_path: &str) -> bool {
864 full_path == "bitcoin::secp256k1::Secp256k1" ||
865 full_path == "bitcoin::secp256k1::Signing" ||
866 full_path == "bitcoin::secp256k1::Verification"
868 /// Returns true we if can just skip passing this to C entirely
869 fn no_arg_path_to_rust(&self, full_path: &str) -> &str {
870 if full_path == "bitcoin::secp256k1::Secp256k1" {
871 "secp256k1::global::SECP256K1"
872 } else { unimplemented!(); }
875 /// Returns true if the object is a primitive and is mapped as-is with no conversion
877 pub fn is_primitive(&self, full_path: &str) -> bool {
888 pub fn is_clonable(&self, ty: &str) -> bool {
889 if self.crate_types.is_clonable(ty) { return true; }
890 if self.is_primitive(ty) { return true; }
896 /// Gets the C-mapped type for types which are outside of the crate, or which are manually
897 /// ignored by for some reason need mapping anyway.
898 fn c_type_from_path<'b>(&self, full_path: &'b str, is_ref: bool, _ptr_for_ref: bool) -> Option<&'b str> {
899 if self.is_primitive(full_path) {
900 return Some(full_path);
903 // Note that no !is_ref types can map to an array because Rust and C's call semantics
904 // for arrays are different (https://github.com/eqrion/cbindgen/issues/528)
906 "[u8; 32]" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
907 "[u8; 20]" if !is_ref => Some("crate::c_types::TwentyBytes"),
908 "[u8; 16]" if !is_ref => Some("crate::c_types::SixteenBytes"),
909 "[u8; 12]" if !is_ref => Some("crate::c_types::TwelveBytes"),
910 "[u8; 4]" if !is_ref => Some("crate::c_types::FourBytes"),
911 "[u8; 3]" if !is_ref => Some("crate::c_types::ThreeBytes"), // Used for RGB values
913 "str" if is_ref => Some("crate::c_types::Str"),
914 "alloc::string::String"|"String" => Some("crate::c_types::Str"),
916 "std::time::Duration"|"core::time::Duration" => Some("u64"),
917 "std::time::SystemTime" => Some("u64"),
918 "std::io::Error"|"lightning::io::Error" => Some("crate::c_types::IOError"),
919 "core::fmt::Arguments" if is_ref => Some("crate::c_types::Str"),
921 "core::convert::Infallible" => Some("crate::c_types::NotConstructable"),
923 "bitcoin::bech32::Error"|"bech32::Error"
924 if !is_ref => Some("crate::c_types::Bech32Error"),
925 "bitcoin::secp256k1::Error"|"secp256k1::Error"
926 if !is_ref => Some("crate::c_types::Secp256k1Error"),
928 "core::num::ParseIntError" => Some("crate::c_types::Error"),
929 "core::str::Utf8Error" => Some("crate::c_types::Error"),
931 "bitcoin::bech32::u5"|"bech32::u5" => Some("crate::c_types::u5"),
932 "core::num::NonZeroU8" => Some("u8"),
934 "secp256k1::PublicKey"|"bitcoin::secp256k1::PublicKey" => Some("crate::c_types::PublicKey"),
935 "bitcoin::secp256k1::ecdsa::Signature" => Some("crate::c_types::Signature"),
936 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some("crate::c_types::RecoverableSignature"),
937 "bitcoin::secp256k1::SecretKey" if is_ref => Some("*const [u8; 32]"),
938 "bitcoin::secp256k1::SecretKey" if !is_ref => Some("crate::c_types::SecretKey"),
939 "bitcoin::blockdata::script::Script" if is_ref => Some("crate::c_types::u8slice"),
940 "bitcoin::blockdata::script::Script" if !is_ref => Some("crate::c_types::derived::CVec_u8Z"),
941 "bitcoin::blockdata::transaction::OutPoint" => Some("crate::lightning::chain::transaction::OutPoint"),
942 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some("crate::c_types::Transaction"),
943 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some("crate::c_types::TxOut"),
944 "bitcoin::network::constants::Network" => Some("crate::bitcoin::network::Network"),
945 "bitcoin::util::address::WitnessVersion" => Some("crate::c_types::WitnessVersion"),
946 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some("*const [u8; 80]"),
947 "bitcoin::blockdata::block::Block" if is_ref => Some("crate::c_types::u8slice"),
949 "bitcoin::hash_types::PubkeyHash"|"bitcoin::hash_types::WPubkeyHash"|"bitcoin::hash_types::ScriptHash"
950 if is_ref => Some("*const [u8; 20]"),
951 "bitcoin::hash_types::WScriptHash"
952 if is_ref => Some("*const [u8; 32]"),
954 // Newtypes that we just expose in their original form.
955 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
956 if is_ref => Some("*const [u8; 32]"),
957 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
958 if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
959 "bitcoin::secp256k1::Message" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
960 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
961 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
962 if is_ref => Some("*const [u8; 32]"),
963 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
964 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
965 if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
967 "lightning::io::Read" => Some("crate::c_types::u8slice"),
973 fn from_c_conversion_new_var_from_path<'b>(&self, _full_path: &str, _is_ref: bool) -> Option<(&'b str, &'b str)> {
976 fn from_c_conversion_prefix_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<String> {
977 if self.is_primitive(full_path) {
978 return Some("".to_owned());
981 "Vec" if !is_ref => Some("local_"),
982 "Result" if !is_ref => Some("local_"),
983 "Option" if is_ref => Some("&local_"),
984 "Option" => Some("local_"),
986 "[u8; 32]" if is_ref => Some("unsafe { &*"),
987 "[u8; 32]" if !is_ref => Some(""),
988 "[u8; 20]" if !is_ref => Some(""),
989 "[u8; 16]" if !is_ref => Some(""),
990 "[u8; 12]" if !is_ref => Some(""),
991 "[u8; 4]" if !is_ref => Some(""),
992 "[u8; 3]" if !is_ref => Some(""),
994 "[u8]" if is_ref => Some(""),
995 "[usize]" if is_ref => Some(""),
997 "str" if is_ref => Some(""),
998 "alloc::string::String"|"String" => Some(""),
999 "std::io::Error"|"lightning::io::Error" => Some(""),
1000 // Note that we'll panic for String if is_ref, as we only have non-owned memory, we
1001 // cannot create a &String.
1003 "core::convert::Infallible" => Some("panic!(\"You must never construct a NotConstructable! : "),
1005 "bitcoin::bech32::Error"|"bech32::Error" if !is_ref => Some(""),
1006 "bitcoin::secp256k1::Error"|"secp256k1::Error" if !is_ref => Some(""),
1008 "core::num::ParseIntError" => Some("u8::from_str_radix(\" a\", 10).unwrap_err() /*"),
1009 "core::str::Utf8Error" => Some("core::str::from_utf8(&[0xff]).unwrap_err() /*"),
1011 "std::time::Duration"|"core::time::Duration" => Some("core::time::Duration::from_secs("),
1012 "std::time::SystemTime" => Some("(::std::time::SystemTime::UNIX_EPOCH + std::time::Duration::from_secs("),
1014 "bitcoin::bech32::u5"|"bech32::u5" => Some(""),
1015 "core::num::NonZeroU8" => Some("core::num::NonZeroU8::new("),
1017 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" if is_ref => Some("&"),
1018 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" => Some(""),
1019 "bitcoin::secp256k1::ecdsa::Signature" if is_ref => Some("&"),
1020 "bitcoin::secp256k1::ecdsa::Signature" => Some(""),
1021 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some(""),
1022 "bitcoin::secp256k1::SecretKey" if is_ref => Some("&::bitcoin::secp256k1::SecretKey::from_slice(&unsafe { *"),
1023 "bitcoin::secp256k1::SecretKey" if !is_ref => Some(""),
1024 "bitcoin::blockdata::script::Script" if is_ref => Some("&::bitcoin::blockdata::script::Script::from(Vec::from("),
1025 "bitcoin::blockdata::script::Script" if !is_ref => Some("::bitcoin::blockdata::script::Script::from("),
1026 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" if is_ref => Some("&"),
1027 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(""),
1028 "bitcoin::blockdata::transaction::OutPoint" => Some("crate::c_types::C_to_bitcoin_outpoint("),
1029 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(""),
1030 "bitcoin::network::constants::Network" => Some(""),
1031 "bitcoin::util::address::WitnessVersion" => Some(""),
1032 "bitcoin::blockdata::block::BlockHeader" => Some("&::bitcoin::consensus::encode::deserialize(unsafe { &*"),
1033 "bitcoin::blockdata::block::Block" if is_ref => Some("&::bitcoin::consensus::encode::deserialize("),
1035 "bitcoin::hash_types::PubkeyHash" if is_ref =>
1036 Some("&bitcoin::hash_types::PubkeyHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
1037 "bitcoin::hash_types::WPubkeyHash" if is_ref =>
1038 Some("&bitcoin::hash_types::WPubkeyHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
1039 "bitcoin::hash_types::ScriptHash" if is_ref =>
1040 Some("&bitcoin::hash_types::ScriptHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
1041 "bitcoin::hash_types::WScriptHash" if is_ref =>
1042 Some("&bitcoin::hash_types::WScriptHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
1044 // Newtypes that we just expose in their original form.
1045 "bitcoin::hash_types::Txid" if is_ref => Some("&::bitcoin::hash_types::Txid::from_slice(&unsafe { &*"),
1046 "bitcoin::hash_types::Txid" if !is_ref => Some("::bitcoin::hash_types::Txid::from_slice(&"),
1047 "bitcoin::hash_types::BlockHash" => Some("::bitcoin::hash_types::BlockHash::from_slice(&"),
1048 "lightning::ln::PaymentHash" if !is_ref => Some("::lightning::ln::PaymentHash("),
1049 "lightning::ln::PaymentHash" if is_ref => Some("&::lightning::ln::PaymentHash(unsafe { *"),
1050 "lightning::ln::PaymentPreimage" if !is_ref => Some("::lightning::ln::PaymentPreimage("),
1051 "lightning::ln::PaymentPreimage" if is_ref => Some("&::lightning::ln::PaymentPreimage(unsafe { *"),
1052 "lightning::ln::PaymentSecret" if !is_ref => Some("::lightning::ln::PaymentSecret("),
1053 "lightning::ln::channelmanager::PaymentId" if !is_ref => Some("::lightning::ln::channelmanager::PaymentId("),
1054 "lightning::ln::channelmanager::PaymentId" if is_ref=> Some("&::lightning::ln::channelmanager::PaymentId( unsafe { *"),
1055 "lightning::chain::keysinterface::KeyMaterial" if !is_ref => Some("::lightning::chain::keysinterface::KeyMaterial("),
1056 "lightning::chain::keysinterface::KeyMaterial" if is_ref=> Some("&::lightning::chain::keysinterface::KeyMaterial( unsafe { *"),
1058 // List of traits we map (possibly during processing of other files):
1059 "lightning::io::Read" => Some("&mut "),
1062 }.map(|s| s.to_owned())
1064 fn from_c_conversion_suffix_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<String> {
1065 if self.is_primitive(full_path) {
1066 return Some("".to_owned());
1069 "Vec" if !is_ref => Some(""),
1070 "Option" => Some(""),
1071 "Result" if !is_ref => Some(""),
1073 "[u8; 32]" if is_ref => Some("}"),
1074 "[u8; 32]" if !is_ref => Some(".data"),
1075 "[u8; 20]" if !is_ref => Some(".data"),
1076 "[u8; 16]" if !is_ref => Some(".data"),
1077 "[u8; 12]" if !is_ref => Some(".data"),
1078 "[u8; 4]" if !is_ref => Some(".data"),
1079 "[u8; 3]" if !is_ref => Some(".data"),
1081 "[u8]" if is_ref => Some(".to_slice()"),
1082 "[usize]" if is_ref => Some(".to_slice()"),
1084 "str" if is_ref => Some(".into_str()"),
1085 "alloc::string::String"|"String" => Some(".into_string()"),
1086 "std::io::Error"|"lightning::io::Error" => Some(".to_rust()"),
1088 "core::convert::Infallible" => Some("\")"),
1090 "bitcoin::bech32::Error"|"bech32::Error" if !is_ref => Some(".into_rust()"),
1091 "bitcoin::secp256k1::Error"|"secp256k1::Error" if !is_ref => Some(".into_rust()"),
1093 "core::num::ParseIntError" => Some("*/"),
1094 "core::str::Utf8Error" => Some("*/"),
1096 "std::time::Duration"|"core::time::Duration" => Some(")"),
1097 "std::time::SystemTime" => Some("))"),
1099 "bitcoin::bech32::u5"|"bech32::u5" => Some(".into()"),
1100 "core::num::NonZeroU8" => Some(").expect(\"Value must be non-zero\")"),
1102 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" => Some(".into_rust()"),
1103 "bitcoin::secp256k1::ecdsa::Signature" => Some(".into_rust()"),
1104 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some(".into_rust()"),
1105 "bitcoin::secp256k1::SecretKey" if !is_ref => Some(".into_rust()"),
1106 "bitcoin::secp256k1::SecretKey" if is_ref => Some("}[..]).unwrap()"),
1107 "bitcoin::blockdata::script::Script" if is_ref => Some(".to_slice()))"),
1108 "bitcoin::blockdata::script::Script" if !is_ref => Some(".into_rust())"),
1109 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(".into_bitcoin()"),
1110 "bitcoin::blockdata::transaction::OutPoint" => Some(")"),
1111 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(".into_rust()"),
1112 "bitcoin::network::constants::Network" => Some(".into_bitcoin()"),
1113 "bitcoin::util::address::WitnessVersion" => Some(".into()"),
1114 "bitcoin::blockdata::block::BlockHeader" => Some(" }).unwrap()"),
1115 "bitcoin::blockdata::block::Block" => Some(".to_slice()).unwrap()"),
1117 "bitcoin::hash_types::PubkeyHash"|"bitcoin::hash_types::WPubkeyHash"|
1118 "bitcoin::hash_types::ScriptHash"|"bitcoin::hash_types::WScriptHash"
1119 if is_ref => Some(" }.clone()))"),
1121 // Newtypes that we just expose in their original form.
1122 "bitcoin::hash_types::Txid" if is_ref => Some(" }[..]).unwrap()"),
1123 "bitcoin::hash_types::Txid" => Some(".data[..]).unwrap()"),
1124 "bitcoin::hash_types::BlockHash" if !is_ref => Some(".data[..]).unwrap()"),
1125 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1126 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1127 if !is_ref => Some(".data)"),
1128 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1129 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1130 if is_ref => Some(" })"),
1132 // List of traits we map (possibly during processing of other files):
1133 "lightning::io::Read" => Some(".to_reader()"),
1136 }.map(|s| s.to_owned())
1139 fn to_c_conversion_new_var_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<(&'b str, &'b str)> {
1140 if self.is_primitive(full_path) {
1144 "[u8]" if is_ref => Some(("crate::c_types::u8slice::from_slice(", ")")),
1145 "[usize]" if is_ref => Some(("crate::c_types::usizeslice::from_slice(", ")")),
1147 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some(("{ let mut s = [0u8; 80]; s[..].copy_from_slice(&::bitcoin::consensus::encode::serialize(", ")); s }")),
1148 "bitcoin::blockdata::block::Block" if is_ref => Some(("::bitcoin::consensus::encode::serialize(", ")")),
1149 "bitcoin::hash_types::Txid" => None,
1152 }.map(|s| s.to_owned())
1154 fn to_c_conversion_inline_prefix_from_path(&self, full_path: &str, is_ref: bool, _ptr_for_ref: bool) -> Option<String> {
1155 if self.is_primitive(full_path) {
1156 return Some("".to_owned());
1159 "Result" if !is_ref => Some("local_"),
1160 "Vec" if !is_ref => Some("local_"),
1161 "Option" => Some("local_"),
1163 "[u8; 32]" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1164 "[u8; 32]" if is_ref => Some(""),
1165 "[u8; 20]" if !is_ref => Some("crate::c_types::TwentyBytes { data: "),
1166 "[u8; 16]" if !is_ref => Some("crate::c_types::SixteenBytes { data: "),
1167 "[u8; 12]" if !is_ref => Some("crate::c_types::TwelveBytes { data: "),
1168 "[u8; 4]" if !is_ref => Some("crate::c_types::FourBytes { data: "),
1169 "[u8; 3]" if is_ref => Some(""),
1171 "[u8]" if is_ref => Some("local_"),
1172 "[usize]" if is_ref => Some("local_"),
1174 "str" if is_ref => Some(""),
1175 "alloc::string::String"|"String" => Some(""),
1177 "std::time::Duration"|"core::time::Duration" => Some(""),
1178 "std::time::SystemTime" => Some(""),
1179 "std::io::Error"|"lightning::io::Error" => Some("crate::c_types::IOError::from_rust("),
1180 "core::fmt::Arguments" => Some("alloc::format!(\"{}\", "),
1182 "core::convert::Infallible" => Some("panic!(\"Cannot construct an Infallible: "),
1184 "bitcoin::bech32::Error"|"bech32::Error"
1185 if !is_ref => Some("crate::c_types::Bech32Error::from_rust("),
1186 "bitcoin::secp256k1::Error"|"secp256k1::Error"
1187 if !is_ref => Some("crate::c_types::Secp256k1Error::from_rust("),
1189 "core::num::ParseIntError" => Some("crate::c_types::Error { _dummy: 0 } /*"),
1190 "core::str::Utf8Error" => Some("crate::c_types::Error { _dummy: 0 } /*"),
1192 "bitcoin::bech32::u5"|"bech32::u5" => Some(""),
1194 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" => Some("crate::c_types::PublicKey::from_rust(&"),
1195 "bitcoin::secp256k1::ecdsa::Signature" => Some("crate::c_types::Signature::from_rust(&"),
1196 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some("crate::c_types::RecoverableSignature::from_rust(&"),
1197 "bitcoin::secp256k1::SecretKey" if is_ref => Some(""),
1198 "bitcoin::secp256k1::SecretKey" if !is_ref => Some("crate::c_types::SecretKey::from_rust("),
1199 "bitcoin::blockdata::script::Script" if is_ref => Some("crate::c_types::u8slice::from_slice(&"),
1200 "bitcoin::blockdata::script::Script" if !is_ref => Some(""),
1201 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" if is_ref => Some("crate::c_types::Transaction::from_bitcoin("),
1202 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some("crate::c_types::Transaction::from_bitcoin(&"),
1203 "bitcoin::blockdata::transaction::OutPoint" => Some("crate::c_types::bitcoin_to_C_outpoint("),
1204 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some("crate::c_types::TxOut::from_rust("),
1205 "bitcoin::network::constants::Network" => Some("crate::bitcoin::network::Network::from_bitcoin("),
1206 "bitcoin::util::address::WitnessVersion" => Some(""),
1207 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some("&local_"),
1208 "bitcoin::blockdata::block::Block" if is_ref => Some("crate::c_types::u8slice::from_slice(&local_"),
1210 "bitcoin::hash_types::Txid" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1212 // Newtypes that we just expose in their original form.
1213 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1214 if is_ref => Some(""),
1215 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1216 if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1217 "bitcoin::secp256k1::Message" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1218 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1219 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1220 if is_ref => Some("&"),
1221 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1222 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1223 if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1225 "lightning::io::Read" => Some("crate::c_types::u8slice::from_vec(&crate::c_types::reader_to_vec("),
1228 }.map(|s| s.to_owned())
1230 fn to_c_conversion_inline_suffix_from_path(&self, full_path: &str, is_ref: bool, _ptr_for_ref: bool) -> Option<String> {
1231 if self.is_primitive(full_path) {
1232 return Some("".to_owned());
1235 "Result" if !is_ref => Some(""),
1236 "Vec" if !is_ref => Some(".into()"),
1237 "Option" => Some(""),
1239 "[u8; 32]" if !is_ref => Some(" }"),
1240 "[u8; 32]" if is_ref => Some(""),
1241 "[u8; 20]" if !is_ref => Some(" }"),
1242 "[u8; 16]" if !is_ref => Some(" }"),
1243 "[u8; 12]" if !is_ref => Some(" }"),
1244 "[u8; 4]" if !is_ref => Some(" }"),
1245 "[u8; 3]" if is_ref => Some(""),
1247 "[u8]" if is_ref => Some(""),
1248 "[usize]" if is_ref => Some(""),
1250 "str" if is_ref => Some(".into()"),
1251 "alloc::string::String"|"String" if is_ref => Some(".as_str().into()"),
1252 "alloc::string::String"|"String" => Some(".into()"),
1254 "std::time::Duration"|"core::time::Duration" => Some(".as_secs()"),
1255 "std::time::SystemTime" => Some(".duration_since(::std::time::SystemTime::UNIX_EPOCH).expect(\"Times must be post-1970\").as_secs()"),
1256 "std::io::Error"|"lightning::io::Error" => Some(")"),
1257 "core::fmt::Arguments" => Some(").into()"),
1259 "core::convert::Infallible" => Some("\")"),
1261 "bitcoin::secp256k1::Error"|"bech32::Error"
1262 if !is_ref => Some(")"),
1263 "bitcoin::secp256k1::Error"|"secp256k1::Error"
1264 if !is_ref => Some(")"),
1266 "core::num::ParseIntError" => Some("*/"),
1267 "core::str::Utf8Error" => Some("*/"),
1269 "bitcoin::bech32::u5"|"bech32::u5" => Some(".into()"),
1271 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" => Some(")"),
1272 "bitcoin::secp256k1::ecdsa::Signature" => Some(")"),
1273 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some(")"),
1274 "bitcoin::secp256k1::SecretKey" if !is_ref => Some(")"),
1275 "bitcoin::secp256k1::SecretKey" if is_ref => Some(".as_ref()"),
1276 "bitcoin::blockdata::script::Script" if is_ref => Some("[..])"),
1277 "bitcoin::blockdata::script::Script" if !is_ref => Some(".into_bytes().into()"),
1278 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(")"),
1279 "bitcoin::blockdata::transaction::OutPoint" => Some(")"),
1280 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(")"),
1281 "bitcoin::network::constants::Network" => Some(")"),
1282 "bitcoin::util::address::WitnessVersion" => Some(".into()"),
1283 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some(""),
1284 "bitcoin::blockdata::block::Block" if is_ref => Some(")"),
1286 "bitcoin::hash_types::Txid" if !is_ref => Some(".into_inner() }"),
1288 // Newtypes that we just expose in their original form.
1289 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1290 if is_ref => Some(".as_inner()"),
1291 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1292 if !is_ref => Some(".into_inner() }"),
1293 "bitcoin::secp256k1::Message" if !is_ref => Some(".as_ref().clone() }"),
1294 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1295 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1296 if is_ref => Some(".0"),
1297 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1298 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1299 if !is_ref => Some(".0 }"),
1301 "lightning::io::Read" => Some("))"),
1304 }.map(|s| s.to_owned())
1307 fn empty_val_check_suffix_from_path(&self, full_path: &str) -> Option<&str> {
1309 "lightning::ln::PaymentSecret" => Some(".data == [0; 32]"),
1310 "secp256k1::PublicKey"|"bitcoin::secp256k1::PublicKey" => Some(".is_null()"),
1311 "bitcoin::secp256k1::ecdsa::Signature" => Some(".is_null()"),
1316 /// When printing a reference to the source crate's rust type, if we need to map it to a
1317 /// different "real" type, it can be done so here.
1318 /// This is useful to work around limitations in the binding type resolver, where we reference
1319 /// a non-public `use` alias.
1320 /// TODO: We should never need to use this!
1321 fn real_rust_type_mapping<'equiv>(&self, thing: &'equiv str) -> &'equiv str {
1323 "lightning::io::Read" => "crate::c_types::io::Read",
1328 // ****************************
1329 // *** Container Processing ***
1330 // ****************************
1332 /// Returns the module path in the generated mapping crate to the containers which we generate
1333 /// when writing to CrateTypes::template_file.
1334 pub fn generated_container_path() -> &'static str {
1335 "crate::c_types::derived"
1337 /// Returns the module path in the generated mapping crate to the container templates, which
1338 /// are then concretized and put in the generated container path/template_file.
1339 fn container_templ_path() -> &'static str {
1343 /// This should just be a closure, but doing so gets an error like
1344 /// error: reached the recursion limit while instantiating `types::TypeResolver::is_transpar...c/types.rs:1358:104: 1358:110]>>`
1345 /// which implies the concrete function instantiation of `is_transparent_container` ends up
1346 /// being recursive.
1347 fn deref_type<'one, 'b: 'one> (obj: &'one &'b syn::Type) -> &'b syn::Type { *obj }
1349 /// Returns true if the path containing the given args is a "transparent" container, ie an
1350 /// Option or a container which does not require a generated continer class.
1351 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 {
1352 if full_path == "Option" {
1353 let inner = args.next().unwrap();
1354 assert!(args.next().is_none());
1355 match generics.resolve_type(inner) {
1356 syn::Type::Reference(r) => {
1357 let elem = &*r.elem;
1359 syn::Type::Path(_) =>
1360 self.is_transparent_container(full_path, true, [elem].iter().map(Self::deref_type), generics),
1364 syn::Type::Array(a) => {
1365 if let syn::Expr::Lit(l) = &a.len {
1366 if let syn::Lit::Int(i) = &l.lit {
1367 if i.base10_digits().parse::<usize>().unwrap() >= 32 {
1368 let mut buf = Vec::new();
1369 self.write_rust_type(&mut buf, generics, &a.elem, false);
1370 let ty = String::from_utf8(buf).unwrap();
1373 // Blindly assume that if we're trying to create an empty value for an
1374 // array < 32 entries that all-0s may be a valid state.
1377 } else { unimplemented!(); }
1378 } else { unimplemented!(); }
1380 syn::Type::Path(p) => {
1381 if let Some(resolved) = self.maybe_resolve_path(&p.path, generics) {
1382 if self.c_type_has_inner_from_path(&resolved) { return true; }
1383 if self.is_primitive(&resolved) { return false; }
1384 // We want to move to using `Option_` mappings where possible rather than
1385 // manual mappings, as it makes downstream bindings simpler and is more
1386 // clear for users. Thus, we default to false but override for a few
1387 // types which had mappings defined when we were avoiding the `Option_`s.
1388 match &resolved as &str {
1389 "lightning::ln::PaymentSecret" => true,
1390 "lightning::ln::PaymentHash" => true,
1391 "lightning::ln::PaymentPreimage" => true,
1392 "lightning::ln::channelmanager::PaymentId" => true,
1393 "bitcoin::hash_types::BlockHash" => true,
1394 "secp256k1::PublicKey"|"bitcoin::secp256k1::PublicKey" => true,
1397 } else { unimplemented!(); }
1399 syn::Type::Tuple(_) => false,
1400 _ => unimplemented!(),
1404 /// Returns true if the path is a "transparent" container, ie an Option or a container which does
1405 /// not require a generated continer class.
1406 pub fn is_path_transparent_container(&self, full_path: &syn::Path, generics: Option<&GenericTypes>, is_ref: bool) -> bool {
1407 let inner_iter = match &full_path.segments.last().unwrap().arguments {
1408 syn::PathArguments::None => return false,
1409 syn::PathArguments::AngleBracketed(args) => args.args.iter().map(|arg| {
1410 if let syn::GenericArgument::Type(ref ty) = arg {
1412 } else { unimplemented!() }
1414 syn::PathArguments::Parenthesized(_) => unimplemented!(),
1416 self.is_transparent_container(&self.resolve_path(full_path, generics), is_ref, inner_iter, generics)
1418 /// Returns true if this is a known, supported, non-transparent container.
1419 fn is_known_container(&self, full_path: &str, is_ref: bool) -> bool {
1420 (full_path == "Result" && !is_ref) || (full_path == "Vec" && !is_ref) || full_path.ends_with("Tuple") || full_path == "Option"
1422 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)
1423 // Returns prefix + Vec<(prefix, var-name-to-inline-convert)> + suffix
1424 // expecting one element in the vec per generic type, each of which is inline-converted
1425 -> Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)> {
1427 "Result" if !is_ref => {
1429 vec![(" { Ok(mut o) => crate::c_types::CResultTempl::ok(".to_string(), "o".to_string()),
1430 (").into(), Err(mut e) => crate::c_types::CResultTempl::err(".to_string(), "e".to_string())],
1431 ").into() }", ContainerPrefixLocation::PerConv))
1435 // We should only get here if the single contained has an inner
1436 assert!(self.c_type_has_inner(single_contained.unwrap()));
1438 Some(("Vec::new(); for mut item in ", vec![(format!(".drain(..) {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1441 if let Some(syn::Type::Reference(_)) = single_contained {
1442 Some(("Vec::new(); for item in ", vec![(format!(".iter() {{ local_{}.push(", var_name), "(*item)".to_string())], "); }", ContainerPrefixLocation::PerConv))
1444 Some(("Vec::new(); for item in ", vec![(format!(".iter() {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1448 let mut is_contained_ref = false;
1449 let contained_struct = if let Some(syn::Type::Path(p)) = single_contained {
1450 Some(self.resolve_path(&p.path, generics))
1451 } else if let Some(syn::Type::Reference(r)) = single_contained {
1452 is_contained_ref = true;
1453 if let syn::Type::Path(p) = &*r.elem {
1454 Some(self.resolve_path(&p.path, generics))
1457 if let Some(inner_path) = contained_struct {
1458 let only_contained_has_inner = self.c_type_has_inner_from_path(&inner_path);
1459 if self.c_type_has_inner_from_path(&inner_path) {
1460 let is_inner_ref = if let Some(syn::Type::Reference(_)) = single_contained { true } else { false };
1462 return Some(("if ", vec![
1463 (".is_none() { core::ptr::null() } else { ObjOps::nonnull_ptr_to_inner(".to_owned(),
1464 format!("({}{}.unwrap())", var_access, if is_inner_ref { "" } else { ".as_ref()" }))
1465 ], ") }", ContainerPrefixLocation::OutsideConv));
1467 return Some(("if ", vec![
1468 (".is_none() { core::ptr::null_mut() } else { ".to_owned(), format!("({}.unwrap())", var_access))
1469 ], " }", ContainerPrefixLocation::OutsideConv));
1471 } else if !self.is_transparent_container("Option", is_ref, [single_contained.unwrap()].iter().map(|a| *a), generics) {
1472 if self.is_primitive(&inner_path) || (!is_contained_ref && !is_ref) || only_contained_has_inner {
1473 let inner_name = self.get_c_mangled_container_type(vec![single_contained.unwrap()], generics, "Option").unwrap();
1474 return Some(("if ", vec![
1475 (format!(".is_none() {{ {}::None }} else {{ {}::Some(", inner_name, inner_name),
1476 format!("{}.unwrap()", var_access))
1477 ], ") }", ContainerPrefixLocation::PerConv));
1479 let inner_name = self.get_c_mangled_container_type(vec![single_contained.unwrap()], generics, "Option").unwrap();
1480 return Some(("if ", vec![
1481 (format!(".is_none() {{ {}::None }} else {{ {}::Some(/* WARNING: CLONING CONVERSION HERE! &Option<Enum> is otherwise un-expressable. */", inner_name, inner_name),
1482 format!("{}.clone().unwrap()", var_access))
1483 ], ") }", ContainerPrefixLocation::PerConv));
1486 // If c_type_from_path is some (ie there's a manual mapping for the inner
1487 // type), lean on write_empty_rust_val, below.
1490 if let Some(t) = single_contained {
1491 if let syn::Type::Tuple(syn::TypeTuple { elems, .. }) = t {
1492 let inner_name = self.get_c_mangled_container_type(vec![single_contained.unwrap()], generics, "Option").unwrap();
1493 if elems.is_empty() {
1494 return Some(("if ", vec![
1495 (format!(".is_none() {{ {}::None }} else {{ {}::Some /* ",
1496 inner_name, inner_name), format!(""))
1497 ], " */ }", ContainerPrefixLocation::PerConv));
1499 return Some(("if ", vec![
1500 (format!(".is_none() {{ {}::None }} else {{ {}::Some(",
1501 inner_name, inner_name), format!("({}.unwrap())", var_access))
1502 ], ") }", ContainerPrefixLocation::PerConv));
1505 if let syn::Type::Reference(syn::TypeReference { elem, .. }) = t {
1506 if let syn::Type::Slice(_) = &**elem {
1507 return Some(("if ", vec![
1508 (".is_none() { SmartPtr::null() } else { SmartPtr::from_obj(".to_string(),
1509 format!("({}.unwrap())", var_access))
1510 ], ") }", ContainerPrefixLocation::PerConv));
1513 let mut v = Vec::new();
1514 self.write_empty_rust_val(generics, &mut v, t);
1515 let s = String::from_utf8(v).unwrap();
1516 return Some(("if ", vec![
1517 (format!(".is_none() {{ {} }} else {{ ", s), format!("({}.unwrap())", var_access))
1518 ], " }", ContainerPrefixLocation::PerConv));
1519 } else { unreachable!(); }
1525 /// only_contained_has_inner implies that there is only one contained element in the container
1526 /// and it has an inner field (ie is an "opaque" type we've defined).
1527 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)
1528 // Returns prefix + Vec<(prefix, var-name-to-inline-convert)> + suffix
1529 // expecting one element in the vec per generic type, each of which is inline-converted
1530 -> Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)> {
1531 let mut only_contained_has_inner = false;
1532 let only_contained_resolved = if let Some(syn::Type::Path(p)) = single_contained {
1533 let res = self.resolve_path(&p.path, generics);
1534 only_contained_has_inner = self.c_type_has_inner_from_path(&res);
1538 "Result" if !is_ref => {
1540 vec![(".result_ok { true => Ok(".to_string(), format!("(*unsafe {{ Box::from_raw(<*mut _>::take_ptr(&mut {}.contents.result)) }})", var_access)),
1541 ("), false => Err(".to_string(), format!("(*unsafe {{ Box::from_raw(<*mut _>::take_ptr(&mut {}.contents.err)) }})", var_access))],
1542 ")}", ContainerPrefixLocation::PerConv))
1544 "Slice" if is_ref && only_contained_has_inner => {
1545 Some(("Vec::new(); for mut item in ", vec![(format!(".as_slice().iter() {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1548 Some(("Vec::new(); for mut item in ", vec![(format!(".into_rust().drain(..) {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1551 if let Some(resolved) = only_contained_resolved {
1552 if self.is_primitive(&resolved) {
1553 return Some(("if ", vec![(".is_some() { Some(".to_string(), format!("{}.take()", var_access))], ") } else { None }", ContainerPrefixLocation::NoPrefix))
1554 } else if only_contained_has_inner {
1556 return Some(("if ", vec![(".inner.is_null() { None } else { Some((*".to_string(), format!("{}", var_access))], ").clone()) }", ContainerPrefixLocation::PerConv))
1558 return Some(("if ", vec![(".inner.is_null() { None } else { Some(".to_string(), format!("{}", var_access))], ") }", ContainerPrefixLocation::PerConv));
1563 if let Some(t) = single_contained {
1565 syn::Type::Reference(_)|syn::Type::Path(_)|syn::Type::Slice(_)|syn::Type::Array(_) => {
1566 let mut v = Vec::new();
1567 let ret_ref = self.write_empty_rust_val_check_suffix(generics, &mut v, t);
1568 let s = String::from_utf8(v).unwrap();
1570 EmptyValExpectedTy::ReferenceAsPointer =>
1571 return Some(("if ", vec![
1572 (format!("{} {{ None }} else {{ Some(", s), format!("unsafe {{ &mut *{} }}", var_access))
1573 ], ") }", ContainerPrefixLocation::NoPrefix)),
1574 EmptyValExpectedTy::OptionType =>
1575 return Some(("{ /* ", vec![
1576 (format!("*/ let {}_opt = {};", var_name, var_access),
1577 format!("}} if {}_opt{} {{ None }} else {{ Some({{ {}_opt.take()", var_name, s, var_name))
1578 ], ") } }", ContainerPrefixLocation::PerConv)),
1579 EmptyValExpectedTy::NonPointer =>
1580 return Some(("if ", vec![
1581 (format!("{} {{ None }} else {{ Some(", s), format!("{}", var_access))
1582 ], ") }", ContainerPrefixLocation::PerConv)),
1585 syn::Type::Tuple(_) => {
1586 return Some(("if ", vec![(".is_some() { Some(".to_string(), format!("{}.take()", var_access))], ") } else { None }", ContainerPrefixLocation::PerConv))
1588 _ => unimplemented!(),
1590 } else { unreachable!(); }
1596 /// Constructs a reference to the given type, possibly tweaking the type if relevant to make it
1597 /// convertable to C.
1598 pub fn create_ownable_reference(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> Option<syn::Type> {
1599 let default_value = Some(syn::Type::Reference(syn::TypeReference {
1600 and_token: syn::Token!(&)(Span::call_site()), lifetime: None, mutability: None,
1601 elem: Box::new(t.clone()) }));
1602 match generics.resolve_type(t) {
1603 syn::Type::Path(p) => {
1604 if let Some(resolved_path) = self.maybe_resolve_path(&p.path, generics) {
1605 if resolved_path != "Vec" { return default_value; }
1606 if p.path.segments.len() != 1 { unimplemented!(); }
1607 let only_seg = p.path.segments.iter().next().unwrap();
1608 if let syn::PathArguments::AngleBracketed(args) = &only_seg.arguments {
1609 if args.args.len() != 1 { unimplemented!(); }
1610 let inner_arg = args.args.iter().next().unwrap();
1611 if let syn::GenericArgument::Type(ty) = &inner_arg {
1612 let mut can_create = self.c_type_has_inner(&ty);
1613 if let syn::Type::Path(inner) = ty {
1614 if inner.path.segments.len() == 1 &&
1615 format!("{}", inner.path.segments[0].ident) == "Vec" {
1619 if !can_create { return default_value; }
1620 if let Some(inner_ty) = self.create_ownable_reference(&ty, generics) {
1621 return Some(syn::Type::Reference(syn::TypeReference {
1622 and_token: syn::Token![&](Span::call_site()),
1625 elem: Box::new(syn::Type::Slice(syn::TypeSlice {
1626 bracket_token: syn::token::Bracket { span: Span::call_site() },
1627 elem: Box::new(inner_ty)
1630 } else { return default_value; }
1631 } else { unimplemented!(); }
1632 } else { unimplemented!(); }
1633 } else { return None; }
1639 // *************************************************
1640 // *** Type definition during main.rs processing ***
1641 // *************************************************
1643 /// Returns true if the object at the given path is mapped as X { inner: *mut origX, .. }.
1644 pub fn c_type_has_inner_from_path(&self, full_path: &str) -> bool {
1645 self.crate_types.opaques.get(full_path).is_some()
1648 /// Returns true if the object at the given path is mapped as X { inner: *mut origX, .. }.
1649 pub fn c_type_has_inner(&self, ty: &syn::Type) -> bool {
1651 syn::Type::Path(p) => {
1652 if let Some(full_path) = self.maybe_resolve_path(&p.path, None) {
1653 self.c_type_has_inner_from_path(&full_path)
1656 syn::Type::Reference(r) => {
1657 self.c_type_has_inner(&*r.elem)
1663 pub fn maybe_resolve_ident(&self, id: &syn::Ident) -> Option<String> {
1664 self.types.maybe_resolve_ident(id)
1667 pub fn maybe_resolve_path(&self, p_arg: &syn::Path, generics: Option<&GenericTypes>) -> Option<String> {
1668 self.types.maybe_resolve_path(p_arg, generics)
1670 pub fn resolve_path(&self, p: &syn::Path, generics: Option<&GenericTypes>) -> String {
1671 self.maybe_resolve_path(p, generics).unwrap()
1674 // ***********************************
1675 // *** Original Rust Type Printing ***
1676 // ***********************************
1678 fn in_rust_prelude(resolved_path: &str) -> bool {
1679 match resolved_path {
1687 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) {
1688 if let Some(resolved) = self.maybe_resolve_path(&path, generics_resolver) {
1689 if self.is_primitive(&resolved) {
1690 write!(w, "{}", path.get_ident().unwrap()).unwrap();
1692 // TODO: We should have a generic "is from a dependency" check here instead of
1693 // checking for "bitcoin" explicitly.
1694 if resolved.starts_with("bitcoin::") || Self::in_rust_prelude(&resolved) {
1695 write!(w, "{}", resolved).unwrap();
1696 } else if !generated_crate_ref {
1697 // If we're printing a generic argument, it needs to reference the crate, otherwise
1698 // the original crate.
1699 write!(w, "{}", self.real_rust_type_mapping(&resolved)).unwrap();
1701 write!(w, "crate::{}", resolved).unwrap();
1704 if let syn::PathArguments::AngleBracketed(args) = &path.segments.iter().last().unwrap().arguments {
1705 self.write_rust_generic_arg(w, generics_resolver, args.args.iter(), with_ref_lifetime);
1708 if path.leading_colon.is_some() {
1709 write!(w, "::").unwrap();
1711 for (idx, seg) in path.segments.iter().enumerate() {
1712 if idx != 0 { write!(w, "::").unwrap(); }
1713 write!(w, "{}", seg.ident).unwrap();
1714 if let syn::PathArguments::AngleBracketed(args) = &seg.arguments {
1715 self.write_rust_generic_arg(w, generics_resolver, args.args.iter(), with_ref_lifetime);
1720 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>) {
1721 let mut had_params = false;
1722 for (idx, arg) in generics.enumerate() {
1723 if idx != 0 { write!(w, ", ").unwrap(); } else { write!(w, "<").unwrap(); }
1726 syn::GenericParam::Lifetime(lt) => write!(w, "'{}", lt.lifetime.ident).unwrap(),
1727 syn::GenericParam::Type(t) => {
1728 write!(w, "{}", t.ident).unwrap();
1729 if t.colon_token.is_some() { write!(w, ":").unwrap(); }
1730 for (idx, bound) in t.bounds.iter().enumerate() {
1731 if idx != 0 { write!(w, " + ").unwrap(); }
1733 syn::TypeParamBound::Trait(tb) => {
1734 if tb.paren_token.is_some() || tb.lifetimes.is_some() { unimplemented!(); }
1735 self.write_rust_path(w, generics_resolver, &tb.path, false, false);
1737 _ => unimplemented!(),
1740 if t.eq_token.is_some() || t.default.is_some() { unimplemented!(); }
1742 _ => unimplemented!(),
1745 if had_params { write!(w, ">").unwrap(); }
1748 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) {
1749 write!(w, "<").unwrap();
1750 for (idx, arg) in generics.enumerate() {
1751 if idx != 0 { write!(w, ", ").unwrap(); }
1753 syn::GenericArgument::Type(t) => self.write_rust_type(w, generics_resolver, t, with_ref_lifetime),
1754 _ => unimplemented!(),
1757 write!(w, ">").unwrap();
1759 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) {
1760 let real_ty = generics.resolve_type(t);
1761 let mut generate_crate_ref = force_crate_ref || t != real_ty;
1763 syn::Type::Path(p) => {
1764 if p.qself.is_some() {
1767 if let Some(resolved_ty) = self.maybe_resolve_path(&p.path, generics) {
1768 generate_crate_ref |= self.maybe_resolve_path(&p.path, None).as_ref() != Some(&resolved_ty);
1769 if self.crate_types.traits.get(&resolved_ty).is_none() { generate_crate_ref = false; }
1771 self.write_rust_path(w, generics, &p.path, with_ref_lifetime, generate_crate_ref);
1773 syn::Type::Reference(r) => {
1774 write!(w, "&").unwrap();
1775 if let Some(lft) = &r.lifetime {
1776 write!(w, "'{} ", lft.ident).unwrap();
1777 } else if with_ref_lifetime {
1778 write!(w, "'static ").unwrap();
1780 if r.mutability.is_some() {
1781 write!(w, "mut ").unwrap();
1783 self.do_write_rust_type(w, generics, &*r.elem, with_ref_lifetime, generate_crate_ref);
1785 syn::Type::Array(a) => {
1786 write!(w, "[").unwrap();
1787 self.do_write_rust_type(w, generics, &a.elem, with_ref_lifetime, generate_crate_ref);
1788 if let syn::Expr::Lit(l) = &a.len {
1789 if let syn::Lit::Int(i) = &l.lit {
1790 write!(w, "; {}]", i).unwrap();
1791 } else { unimplemented!(); }
1792 } else { unimplemented!(); }
1794 syn::Type::Slice(s) => {
1795 write!(w, "[").unwrap();
1796 self.do_write_rust_type(w, generics, &s.elem, with_ref_lifetime, generate_crate_ref);
1797 write!(w, "]").unwrap();
1799 syn::Type::Tuple(s) => {
1800 write!(w, "(").unwrap();
1801 for (idx, t) in s.elems.iter().enumerate() {
1802 if idx != 0 { write!(w, ", ").unwrap(); }
1803 self.do_write_rust_type(w, generics, &t, with_ref_lifetime, generate_crate_ref);
1805 write!(w, ")").unwrap();
1807 _ => unimplemented!(),
1810 pub fn write_rust_type<W: std::io::Write>(&self, w: &mut W, generics: Option<&GenericTypes>, t: &syn::Type, with_ref_lifetime: bool) {
1811 self.do_write_rust_type(w, generics, t, with_ref_lifetime, false);
1815 /// Prints a constructor for something which is "uninitialized" (but obviously not actually
1816 /// unint'd memory).
1817 pub fn write_empty_rust_val<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type) {
1819 syn::Type::Reference(r) => {
1820 self.write_empty_rust_val(generics, w, &*r.elem)
1822 syn::Type::Path(p) => {
1823 let resolved = self.resolve_path(&p.path, generics);
1824 if self.crate_types.opaques.get(&resolved).is_some() {
1825 write!(w, "crate::{} {{ inner: core::ptr::null_mut(), is_owned: true }}", resolved).unwrap();
1827 // Assume its a manually-mapped C type, where we can just define an null() fn
1828 write!(w, "{}::null()", self.c_type_from_path(&resolved, false, false).unwrap()).unwrap();
1831 syn::Type::Array(a) => {
1832 if let syn::Expr::Lit(l) = &a.len {
1833 if let syn::Lit::Int(i) = &l.lit {
1834 if i.base10_digits().parse::<usize>().unwrap() < 32 {
1835 // Blindly assume that if we're trying to create an empty value for an
1836 // array < 32 entries that all-0s may be a valid state.
1839 let arrty = format!("[u8; {}]", i.base10_digits());
1840 write!(w, "{}", self.to_c_conversion_inline_prefix_from_path(&arrty, false, false).unwrap()).unwrap();
1841 write!(w, "[0; {}]", i.base10_digits()).unwrap();
1842 write!(w, "{}", self.to_c_conversion_inline_suffix_from_path(&arrty, false, false).unwrap()).unwrap();
1843 } else { unimplemented!(); }
1844 } else { unimplemented!(); }
1846 _ => unimplemented!(),
1850 fn is_real_type_array(&self, resolved_type: &str) -> Option<syn::Type> {
1851 if let Some(real_ty) = self.c_type_from_path(&resolved_type, true, false) {
1852 if real_ty.ends_with("]") && real_ty.starts_with("*const [u8; ") {
1853 let mut split = real_ty.split("; ");
1854 split.next().unwrap();
1855 let tail_str = split.next().unwrap();
1856 assert!(split.next().is_none());
1857 let len = usize::from_str_radix(&tail_str[..tail_str.len() - 1], 10).unwrap();
1858 Some(parse_quote!([u8; #len]))
1863 /// Prints a suffix to determine if a variable is empty (ie was set by write_empty_rust_val).
1864 /// See EmptyValExpectedTy for information on return types.
1865 fn write_empty_rust_val_check_suffix<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type) -> EmptyValExpectedTy {
1867 syn::Type::Reference(r) => {
1868 return self.write_empty_rust_val_check_suffix(generics, w, &*r.elem);
1870 syn::Type::Path(p) => {
1871 let resolved = self.resolve_path(&p.path, generics);
1872 if let Some(arr_ty) = self.is_real_type_array(&resolved) {
1873 return self.write_empty_rust_val_check_suffix(generics, w, &arr_ty);
1875 if self.crate_types.opaques.get(&resolved).is_some() {
1876 write!(w, ".inner.is_null()").unwrap();
1877 EmptyValExpectedTy::NonPointer
1879 if let Some(suffix) = self.empty_val_check_suffix_from_path(&resolved) {
1880 write!(w, "{}", suffix).unwrap();
1881 // We may eventually need to allow empty_val_check_suffix_from_path to specify if we need a deref or not
1882 EmptyValExpectedTy::NonPointer
1884 write!(w, ".is_none()").unwrap();
1885 EmptyValExpectedTy::OptionType
1889 syn::Type::Array(a) => {
1890 if let syn::Expr::Lit(l) = &a.len {
1891 if let syn::Lit::Int(i) = &l.lit {
1892 write!(w, ".data == [0; {}]", i.base10_digits()).unwrap();
1893 EmptyValExpectedTy::NonPointer
1894 } else { unimplemented!(); }
1895 } else { unimplemented!(); }
1897 syn::Type::Slice(_) => {
1898 // Option<[]> always implies that we want to treat len() == 0 differently from
1899 // None, so we always map an Option<[]> into a pointer.
1900 write!(w, " == core::ptr::null_mut()").unwrap();
1901 EmptyValExpectedTy::ReferenceAsPointer
1903 _ => unimplemented!(),
1907 /// Prints a suffix to determine if a variable is empty (ie was set by write_empty_rust_val).
1908 pub fn write_empty_rust_val_check<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type, var_access: &str) {
1910 syn::Type::Reference(r) => {
1911 self.write_empty_rust_val_check(generics, w, &*r.elem, var_access);
1913 syn::Type::Path(_) => {
1914 write!(w, "{}", var_access).unwrap();
1915 self.write_empty_rust_val_check_suffix(generics, w, t);
1917 syn::Type::Array(a) => {
1918 if let syn::Expr::Lit(l) = &a.len {
1919 if let syn::Lit::Int(i) = &l.lit {
1920 let arrty = format!("[u8; {}]", i.base10_digits());
1921 // We don't (yet) support a new-var conversion here.
1922 assert!(self.from_c_conversion_new_var_from_path(&arrty, false).is_none());
1924 self.from_c_conversion_prefix_from_path(&arrty, false).unwrap(),
1926 self.from_c_conversion_suffix_from_path(&arrty, false).unwrap()).unwrap();
1927 self.write_empty_rust_val_check_suffix(generics, w, t);
1928 } else { unimplemented!(); }
1929 } else { unimplemented!(); }
1931 _ => unimplemented!(),
1935 // ********************************
1936 // *** Type conversion printing ***
1937 // ********************************
1939 /// Returns true we if can just skip passing this to C entirely
1940 pub fn skip_arg(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> bool {
1942 syn::Type::Path(p) => {
1943 if p.qself.is_some() { unimplemented!(); }
1944 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
1945 self.skip_path(&full_path)
1948 syn::Type::Reference(r) => {
1949 self.skip_arg(&*r.elem, generics)
1954 pub fn no_arg_to_rust<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
1956 syn::Type::Path(p) => {
1957 if p.qself.is_some() { unimplemented!(); }
1958 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
1959 write!(w, "{}", self.no_arg_path_to_rust(&full_path)).unwrap();
1962 syn::Type::Reference(r) => {
1963 self.no_arg_to_rust(w, &*r.elem, generics);
1969 fn write_conversion_inline_intern<W: std::io::Write,
1970 LP: Fn(&str, bool, bool) -> Option<String>, DL: Fn(&mut W, &DeclType, &str, bool, bool), SC: Fn(bool, Option<&str>) -> String>
1971 (&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, is_ref: bool, is_mut: bool, ptr_for_ref: bool,
1972 tupleconv: &str, prefix: bool, sliceconv: SC, path_lookup: LP, decl_lookup: DL) {
1973 match generics.resolve_type(t) {
1974 syn::Type::Reference(r) => {
1975 self.write_conversion_inline_intern(w, &*r.elem, generics, true, r.mutability.is_some(),
1976 ptr_for_ref, tupleconv, prefix, sliceconv, path_lookup, decl_lookup);
1978 syn::Type::Path(p) => {
1979 if p.qself.is_some() {
1983 let resolved_path = self.resolve_path(&p.path, generics);
1984 if let Some(aliased_type) = self.crate_types.type_aliases.get(&resolved_path) {
1985 return self.write_conversion_inline_intern(w, aliased_type, None, is_ref, is_mut, ptr_for_ref, tupleconv, prefix, sliceconv, path_lookup, decl_lookup);
1986 } else if self.is_primitive(&resolved_path) {
1987 if is_ref && prefix {
1988 write!(w, "*").unwrap();
1990 } else if let Some(c_type) = path_lookup(&resolved_path, is_ref, ptr_for_ref) {
1991 write!(w, "{}", c_type).unwrap();
1992 } else if let Some((_, generics)) = self.crate_types.opaques.get(&resolved_path) {
1993 decl_lookup(w, &DeclType::StructImported { generics: &generics }, &resolved_path, is_ref, is_mut);
1994 } else if self.crate_types.mirrored_enums.get(&resolved_path).is_some() {
1995 decl_lookup(w, &DeclType::MirroredEnum, &resolved_path, is_ref, is_mut);
1996 } else if let Some(t) = self.crate_types.traits.get(&resolved_path) {
1997 decl_lookup(w, &DeclType::Trait(t), &resolved_path, is_ref, is_mut);
1998 } else if let Some(ident) = single_ident_generic_path_to_ident(&p.path) {
1999 if let Some(decl_type) = self.types.maybe_resolve_declared(ident) {
2000 decl_lookup(w, decl_type, &self.maybe_resolve_ident(ident).unwrap(), is_ref, is_mut);
2001 } else { unimplemented!(); }
2002 } else { unimplemented!(); }
2004 syn::Type::Array(a) => {
2005 // We assume all arrays contain only [int_literal; X]s.
2006 // This may result in some outputs not compiling.
2007 if let syn::Expr::Lit(l) = &a.len {
2008 if let syn::Lit::Int(i) = &l.lit {
2009 write!(w, "{}", path_lookup(&format!("[u8; {}]", i.base10_digits()), is_ref, ptr_for_ref).unwrap()).unwrap();
2010 } else { unimplemented!(); }
2011 } else { unimplemented!(); }
2013 syn::Type::Slice(s) => {
2014 // We assume all slices contain only literals or references.
2015 // This may result in some outputs not compiling.
2016 if let syn::Type::Path(p) = &*s.elem {
2017 let resolved = self.resolve_path(&p.path, generics);
2018 if self.is_primitive(&resolved) {
2019 write!(w, "{}", path_lookup("[u8]", is_ref, ptr_for_ref).unwrap()).unwrap();
2021 write!(w, "{}", sliceconv(true, None)).unwrap();
2023 } else if let syn::Type::Reference(r) = &*s.elem {
2024 if let syn::Type::Path(p) = &*r.elem {
2025 write!(w, "{}", sliceconv(self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)), None)).unwrap();
2026 } else if let syn::Type::Slice(_) = &*r.elem {
2027 write!(w, "{}", sliceconv(false, None)).unwrap();
2028 } else { unimplemented!(); }
2029 } else if let syn::Type::Tuple(t) = &*s.elem {
2030 assert!(!t.elems.is_empty());
2032 write!(w, "{}", sliceconv(false, None)).unwrap();
2034 let mut needs_map = false;
2035 for e in t.elems.iter() {
2036 if let syn::Type::Reference(_) = e {
2041 let mut map_str = Vec::new();
2042 write!(&mut map_str, ".map(|(").unwrap();
2043 for i in 0..t.elems.len() {
2044 write!(&mut map_str, "{}{}", if i != 0 { ", " } else { "" }, ('a' as u8 + i as u8) as char).unwrap();
2046 write!(&mut map_str, ")| (").unwrap();
2047 for (idx, e) in t.elems.iter().enumerate() {
2048 if let syn::Type::Reference(_) = e {
2049 write!(&mut map_str, "{}{}", if idx != 0 { ", " } else { "" }, (idx as u8 + 'a' as u8) as char).unwrap();
2050 } else if let syn::Type::Path(_) = e {
2051 write!(&mut map_str, "{}*{}", if idx != 0 { ", " } else { "" }, (idx as u8 + 'a' as u8) as char).unwrap();
2052 } else { unimplemented!(); }
2054 write!(&mut map_str, "))").unwrap();
2055 write!(w, "{}", sliceconv(false, Some(&String::from_utf8(map_str).unwrap()))).unwrap();
2057 write!(w, "{}", sliceconv(false, None)).unwrap();
2060 } else if let syn::Type::Array(_) = &*s.elem {
2061 write!(w, "{}", sliceconv(false, Some(".map(|a| *a)"))).unwrap();
2062 } else { unimplemented!(); }
2064 syn::Type::Tuple(t) => {
2065 if t.elems.is_empty() {
2066 // cbindgen has poor support for (), see, eg https://github.com/eqrion/cbindgen/issues/527
2067 // so work around it by just pretending its a 0u8
2068 write!(w, "{}", tupleconv).unwrap();
2070 if prefix { write!(w, "local_").unwrap(); }
2073 _ => unimplemented!(),
2077 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) {
2078 self.write_conversion_inline_intern(w, t, generics, is_ref, false, ptr_for_ref, "() /*", true, |_, _| "local_".to_owned(),
2079 |a, b, c| self.to_c_conversion_inline_prefix_from_path(a, b, c),
2080 |w, decl_type, decl_path, is_ref, _is_mut| {
2082 DeclType::MirroredEnum if is_ref && ptr_for_ref => write!(w, "crate::{}::from_native(", decl_path).unwrap(),
2083 DeclType::MirroredEnum if is_ref => write!(w, "&crate::{}::from_native(", decl_path).unwrap(),
2084 DeclType::MirroredEnum => write!(w, "crate::{}::native_into(", decl_path).unwrap(),
2085 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if is_ref && from_ptr => {
2086 if !ptr_for_ref { write!(w, "&").unwrap(); }
2087 write!(w, "crate::{} {{ inner: unsafe {{ (", decl_path).unwrap()
2089 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if is_ref => {
2090 if !ptr_for_ref { write!(w, "&").unwrap(); }
2091 write!(w, "crate::{} {{ inner: unsafe {{ ObjOps::nonnull_ptr_to_inner((", decl_path).unwrap()
2093 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref && from_ptr =>
2094 write!(w, "crate::{} {{ inner: ", decl_path).unwrap(),
2095 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref =>
2096 write!(w, "crate::{} {{ inner: ObjOps::heap_alloc(", decl_path).unwrap(),
2097 DeclType::Trait(_) if is_ref => write!(w, "").unwrap(),
2098 DeclType::Trait(_) if !is_ref => write!(w, "Into::into(").unwrap(),
2099 _ => panic!("{:?}", decl_path),
2103 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) {
2104 self.write_to_c_conversion_inline_prefix_inner(w, t, generics, false, ptr_for_ref, false);
2106 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) {
2107 self.write_conversion_inline_intern(w, t, generics, is_ref, false, ptr_for_ref, "*/", false, |_, _| ".into()".to_owned(),
2108 |a, b, c| self.to_c_conversion_inline_suffix_from_path(a, b, c),
2109 |w, decl_type, full_path, is_ref, _is_mut| match decl_type {
2110 DeclType::MirroredEnum => write!(w, ")").unwrap(),
2111 DeclType::EnumIgnored { generics }|DeclType::StructImported { generics } if is_ref => {
2112 write!(w, " as *const {}<", full_path).unwrap();
2113 for param in generics.params.iter() {
2114 if let syn::GenericParam::Lifetime(_) = param {
2115 write!(w, "'_, ").unwrap();
2117 write!(w, "_, ").unwrap();
2121 write!(w, ">) as *mut _ }}, is_owned: false }}").unwrap();
2123 write!(w, ">) as *mut _) }}, is_owned: false }}").unwrap();
2126 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref && from_ptr =>
2127 write!(w, ", is_owned: true }}").unwrap(),
2128 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref => write!(w, "), is_owned: true }}").unwrap(),
2129 DeclType::Trait(_) if is_ref => {},
2130 DeclType::Trait(_) => {
2131 // This is used when we're converting a concrete Rust type into a C trait
2132 // for use when a Rust trait method returns an associated type.
2133 // Because all of our C traits implement From<RustTypesImplementingTraits>
2134 // we can just call .into() here and be done.
2135 write!(w, ")").unwrap()
2137 _ => unimplemented!(),
2140 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) {
2141 self.write_to_c_conversion_inline_suffix_inner(w, t, generics, false, ptr_for_ref, false);
2144 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) {
2145 self.write_conversion_inline_intern(w, t, generics, is_ref, false, false, "() /*", true, |_, _| "&local_".to_owned(),
2146 |a, b, _c| self.from_c_conversion_prefix_from_path(a, b),
2147 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
2148 DeclType::StructImported {..} if is_ref => write!(w, "").unwrap(),
2149 DeclType::StructImported {..} if !is_ref => write!(w, "*unsafe {{ Box::from_raw(").unwrap(),
2150 DeclType::MirroredEnum if is_ref => write!(w, "&").unwrap(),
2151 DeclType::MirroredEnum => {},
2152 DeclType::Trait(_) => {},
2153 _ => unimplemented!(),
2156 pub fn write_from_c_conversion_prefix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2157 self.write_from_c_conversion_prefix_inner(w, t, generics, false, false);
2159 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) {
2160 self.write_conversion_inline_intern(w, t, generics, is_ref, false, false, "*/", false,
2161 |has_inner, map_str_opt| match (has_inner, map_str_opt) {
2162 (false, Some(map_str)) => format!(".iter(){}.collect::<Vec<_>>()[..]", map_str),
2163 (false, None) => ".iter().collect::<Vec<_>>()[..]".to_owned(),
2164 (true, None) => "[..]".to_owned(),
2165 (true, Some(_)) => unreachable!(),
2167 |a, b, _c| self.from_c_conversion_suffix_from_path(a, b),
2168 |w, decl_type, _full_path, is_ref, is_mut| match decl_type {
2169 DeclType::StructImported {..} if is_ref && ptr_for_ref => write!(w, "XXX unimplemented").unwrap(),
2170 DeclType::StructImported {..} if is_mut && is_ref => write!(w, ".get_native_mut_ref()").unwrap(),
2171 DeclType::StructImported {..} if is_ref => write!(w, ".get_native_ref()").unwrap(),
2172 DeclType::StructImported {..} if !is_ref => write!(w, ".take_inner()) }}").unwrap(),
2173 DeclType::MirroredEnum if is_ref => write!(w, ".to_native()").unwrap(),
2174 DeclType::MirroredEnum => write!(w, ".into_native()").unwrap(),
2175 DeclType::Trait(_) => {},
2176 _ => unimplemented!(),
2179 pub fn write_from_c_conversion_suffix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2180 self.write_from_c_conversion_suffix_inner(w, t, generics, false, false);
2182 // Note that compared to the above conversion functions, the following two are generally
2183 // significantly undertested:
2184 pub fn write_from_c_conversion_to_ref_prefix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2185 self.write_conversion_inline_intern(w, t, generics, false, false, false, "() /*", true, |_, _| "&local_".to_owned(),
2187 if let Some(conv) = self.from_c_conversion_prefix_from_path(a, b) {
2188 Some(format!("&{}", conv))
2191 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
2192 DeclType::StructImported {..} if !is_ref => write!(w, "").unwrap(),
2193 _ => unimplemented!(),
2196 pub fn write_from_c_conversion_to_ref_suffix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2197 self.write_conversion_inline_intern(w, t, generics, false, false, false, "*/", false,
2198 |has_inner, map_str_opt| match (has_inner, map_str_opt) {
2199 (false, Some(map_str)) => format!(".iter(){}.collect::<Vec<_>>()[..]", map_str),
2200 (false, None) => ".iter().collect::<Vec<_>>()[..]".to_owned(),
2201 (true, None) => "[..]".to_owned(),
2202 (true, Some(_)) => unreachable!(),
2204 |a, b, _c| self.from_c_conversion_suffix_from_path(a, b),
2205 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
2206 DeclType::StructImported {..} if !is_ref => write!(w, ".get_native_ref()").unwrap(),
2207 _ => unimplemented!(),
2211 fn write_conversion_new_var_intern<'b, W: std::io::Write,
2212 LP: Fn(&str, bool) -> Option<(&str, &str)>,
2213 LC: Fn(&str, bool, Option<&syn::Type>, &syn::Ident, &str) -> Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)>,
2214 VP: Fn(&mut W, &syn::Type, Option<&GenericTypes>, bool, bool, bool),
2215 VS: Fn(&mut W, &syn::Type, Option<&GenericTypes>, bool, bool, bool)>
2216 (&self, w: &mut W, ident: &syn::Ident, var: &str, t: &syn::Type, generics: Option<&GenericTypes>,
2217 mut is_ref: bool, mut ptr_for_ref: bool, to_c: bool, from_ownable_ref: bool,
2218 path_lookup: &LP, container_lookup: &LC, var_prefix: &VP, var_suffix: &VS) -> bool {
2220 macro_rules! convert_container {
2221 ($container_type: expr, $args_len: expr, $args_iter: expr) => { {
2222 // For slices (and Options), we refuse to directly map them as is_ref when they
2223 // aren't opaque types containing an inner pointer. This is due to the fact that,
2224 // in both cases, the actual higher-level type is non-is_ref.
2225 let (ty_has_inner, ty_is_trait) = if $args_len == 1 {
2226 let ty = $args_iter().next().unwrap();
2227 if $container_type == "Slice" && to_c {
2228 // "To C ptr_for_ref" means "return the regular object with is_owned
2229 // set to false", which is totally what we want in a slice if we're about to
2230 // set ty_has_inner.
2233 if let syn::Type::Reference(t) = ty {
2234 if let syn::Type::Path(p) = &*t.elem {
2235 let resolved = self.resolve_path(&p.path, generics);
2236 (self.c_type_has_inner_from_path(&resolved), self.crate_types.traits.get(&resolved).is_some())
2237 } else { (false, false) }
2238 } else if let syn::Type::Path(p) = ty {
2239 let resolved = self.resolve_path(&p.path, generics);
2240 (self.c_type_has_inner_from_path(&resolved), self.crate_types.traits.get(&resolved).is_some())
2241 } else { (false, false) }
2242 } else { (true, false) };
2244 // Options get a bunch of special handling, since in general we map Option<>al
2245 // types into the same C type as non-Option-wrapped types. This ends up being
2246 // pretty manual here and most of the below special-cases are for Options.
2247 let mut needs_ref_map = false;
2248 let mut only_contained_type = None;
2249 let mut only_contained_type_nonref = None;
2250 let mut only_contained_has_inner = false;
2251 let mut contains_slice = false;
2253 only_contained_has_inner = ty_has_inner;
2254 let arg = $args_iter().next().unwrap();
2255 if let syn::Type::Reference(t) = arg {
2256 only_contained_type = Some(arg);
2257 only_contained_type_nonref = Some(&*t.elem);
2258 if let syn::Type::Path(_) = &*t.elem {
2260 } else if let syn::Type::Slice(_) = &*t.elem {
2261 contains_slice = true;
2262 } else { return false; }
2263 // If the inner element contains an inner pointer, we will just use that,
2264 // avoiding the need to map elements to references. Otherwise we'll need to
2265 // do an extra mapping step.
2266 needs_ref_map = !only_contained_has_inner && !ty_is_trait && $container_type == "Option";
2268 only_contained_type = Some(arg);
2269 only_contained_type_nonref = Some(arg);
2273 if let Some((prefix, conversions, suffix, prefix_location)) = container_lookup(&$container_type, is_ref, only_contained_type, ident, var) {
2274 assert_eq!(conversions.len(), $args_len);
2275 write!(w, "let mut local_{}{} = ", ident,
2276 if (!to_c && needs_ref_map) || (to_c && $container_type == "Option" && contains_slice) {"_base"} else { "" }).unwrap();
2277 if prefix_location == ContainerPrefixLocation::OutsideConv {
2278 var_prefix(w, $args_iter().next().unwrap(), generics, is_ref, ptr_for_ref, true);
2280 write!(w, "{}{}", prefix, var).unwrap();
2282 for ((pfx, var_name), (idx, ty)) in conversions.iter().zip($args_iter().enumerate()) {
2283 let mut var = std::io::Cursor::new(Vec::new());
2284 write!(&mut var, "{}", var_name).unwrap();
2285 let var_access = String::from_utf8(var.into_inner()).unwrap();
2287 let conv_ty = if needs_ref_map { only_contained_type_nonref.as_ref().unwrap() } else { ty };
2289 write!(w, "{} {{ ", pfx).unwrap();
2290 let new_var_name = format!("{}_{}", ident, idx);
2291 let new_var = self.write_conversion_new_var_intern(w, &format_ident!("{}", new_var_name),
2292 &var_access, conv_ty, generics, contains_slice || (is_ref && ty_has_inner), ptr_for_ref,
2293 to_c, from_ownable_ref, path_lookup, container_lookup, var_prefix, var_suffix);
2294 if new_var { write!(w, " ").unwrap(); }
2296 if prefix_location == ContainerPrefixLocation::PerConv {
2297 var_prefix(w, conv_ty, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2298 } else if !is_ref && !needs_ref_map && to_c && only_contained_has_inner {
2299 write!(w, "ObjOps::heap_alloc(").unwrap();
2302 write!(w, "{}{}", if contains_slice && !to_c { "local_" } else { "" }, if new_var { new_var_name } else { var_access }).unwrap();
2303 if prefix_location == ContainerPrefixLocation::PerConv {
2304 var_suffix(w, conv_ty, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2305 } else if !is_ref && !needs_ref_map && to_c && only_contained_has_inner {
2306 write!(w, ")").unwrap();
2308 write!(w, " }}").unwrap();
2310 write!(w, "{}", suffix).unwrap();
2311 if prefix_location == ContainerPrefixLocation::OutsideConv {
2312 var_suffix(w, $args_iter().next().unwrap(), generics, is_ref, ptr_for_ref, true);
2314 write!(w, ";").unwrap();
2315 if !to_c && needs_ref_map {
2316 write!(w, " let mut local_{} = local_{}_base.as_ref()", ident, ident).unwrap();
2318 write!(w, ".map(|a| &a[..])").unwrap();
2320 write!(w, ";").unwrap();
2321 } else if to_c && $container_type == "Option" && contains_slice {
2322 write!(w, " let mut local_{} = *local_{}_base;", ident, ident).unwrap();
2329 match generics.resolve_type(t) {
2330 syn::Type::Reference(r) => {
2331 if let syn::Type::Slice(_) = &*r.elem {
2332 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)
2334 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)
2337 syn::Type::Path(p) => {
2338 if p.qself.is_some() {
2341 let resolved_path = self.resolve_path(&p.path, generics);
2342 if let Some(aliased_type) = self.crate_types.type_aliases.get(&resolved_path) {
2343 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);
2345 if self.is_known_container(&resolved_path, is_ref) || self.is_path_transparent_container(&p.path, generics, is_ref) {
2346 if let syn::PathArguments::AngleBracketed(args) = &p.path.segments.iter().next().unwrap().arguments {
2347 convert_container!(resolved_path, args.args.len(), || args.args.iter().map(|arg| {
2348 if let syn::GenericArgument::Type(ty) = arg {
2349 generics.resolve_type(ty)
2350 } else { unimplemented!(); }
2352 } else { unimplemented!(); }
2354 if self.is_primitive(&resolved_path) {
2356 } else if let Some(ty_ident) = single_ident_generic_path_to_ident(&p.path) {
2357 if let Some((prefix, suffix)) = path_lookup(&resolved_path, is_ref) {
2358 write!(w, "let mut local_{} = {}{}{};", ident, prefix, var, suffix).unwrap();
2360 } else if self.types.maybe_resolve_declared(ty_ident).is_some() {
2365 syn::Type::Array(_) => {
2366 // We assume all arrays contain only primitive types.
2367 // This may result in some outputs not compiling.
2370 syn::Type::Slice(s) => {
2371 if let syn::Type::Path(p) = &*s.elem {
2372 let resolved = self.resolve_path(&p.path, generics);
2373 if self.is_primitive(&resolved) {
2374 let slice_path = format!("[{}]", resolved);
2375 if let Some((prefix, suffix)) = path_lookup(&slice_path, true) {
2376 write!(w, "let mut local_{} = {}{}{};", ident, prefix, var, suffix).unwrap();
2380 let tyref = [&*s.elem];
2382 // If we're converting from a slice to a Vec, assume we can clone the
2383 // elements and clone them into a new Vec first. Next we'll walk the
2384 // new Vec here and convert them to C types.
2385 write!(w, "let mut local_{}_clone = Vec::new(); local_{}_clone.extend_from_slice({}); let mut {} = local_{}_clone; ", ident, ident, ident, ident, ident).unwrap();
2388 convert_container!("Vec", 1, || tyref.iter().map(|t| generics.resolve_type(*t)));
2389 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2391 } else if let syn::Type::Reference(ty) = &*s.elem {
2392 let tyref = if from_ownable_ref || !to_c { [&*ty.elem] } else { [&*s.elem] };
2394 convert_container!("Slice", 1, || tyref.iter().map(|t| generics.resolve_type(*t)));
2395 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2396 } else if let syn::Type::Tuple(t) = &*s.elem {
2397 // When mapping into a temporary new var, we need to own all the underlying objects.
2398 // Thus, we drop any references inside the tuple and convert with non-reference types.
2399 let mut elems = syn::punctuated::Punctuated::new();
2400 for elem in t.elems.iter() {
2401 if let syn::Type::Reference(r) = elem {
2402 elems.push((*r.elem).clone());
2404 elems.push(elem.clone());
2407 let ty = [syn::Type::Tuple(syn::TypeTuple {
2408 paren_token: t.paren_token, elems
2412 convert_container!("Slice", 1, || ty.iter());
2413 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2414 } else if let syn::Type::Array(_) = &*s.elem {
2417 let arr_elem = [(*s.elem).clone()];
2418 convert_container!("Slice", 1, || arr_elem.iter());
2419 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2420 } else { unimplemented!() }
2422 syn::Type::Tuple(t) => {
2423 if !t.elems.is_empty() {
2424 // We don't (yet) support tuple elements which cannot be converted inline
2425 write!(w, "let (").unwrap();
2426 for idx in 0..t.elems.len() {
2427 if idx != 0 { write!(w, ", ").unwrap(); }
2428 write!(w, "{} orig_{}_{}", if is_ref { "ref" } else { "mut" }, ident, idx).unwrap();
2430 write!(w, ") = {}{}; ", var, if !to_c { ".to_rust()" } else { "" }).unwrap();
2431 // Like other template types, tuples are always mapped as their non-ref
2432 // versions for types which have different ref mappings. Thus, we convert to
2433 // non-ref versions and handle opaque types with inner pointers manually.
2434 for (idx, elem) in t.elems.iter().enumerate() {
2435 if let syn::Type::Path(p) = elem {
2436 let v_name = format!("orig_{}_{}", ident, idx);
2437 let tuple_elem_ident = format_ident!("{}", &v_name);
2438 if self.write_conversion_new_var_intern(w, &tuple_elem_ident, &v_name, elem, generics,
2439 false, ptr_for_ref, to_c, from_ownable_ref,
2440 path_lookup, container_lookup, var_prefix, var_suffix) {
2441 write!(w, " ").unwrap();
2442 // Opaque types with inner pointers shouldn't ever create new stack
2443 // variables, so we don't handle it and just assert that it doesn't
2445 assert!(!self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)));
2449 write!(w, "let mut local_{} = (", ident).unwrap();
2450 for (idx, elem) in t.elems.iter().enumerate() {
2451 let real_elem = generics.resolve_type(&elem);
2452 let ty_has_inner = {
2454 // "To C ptr_for_ref" means "return the regular object with
2455 // is_owned set to false", which is totally what we want
2456 // if we're about to set ty_has_inner.
2459 if let syn::Type::Reference(t) = real_elem {
2460 if let syn::Type::Path(p) = &*t.elem {
2461 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
2463 } else if let syn::Type::Path(p) = real_elem {
2464 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
2467 if idx != 0 { write!(w, ", ").unwrap(); }
2468 var_prefix(w, real_elem, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2469 if is_ref && ty_has_inner {
2470 // For ty_has_inner, the regular var_prefix mapping will take a
2471 // reference, so deref once here to make sure we keep the original ref.
2472 write!(w, "*").unwrap();
2474 write!(w, "orig_{}_{}", ident, idx).unwrap();
2475 if is_ref && !ty_has_inner {
2476 // If we don't have an inner variable's reference to maintain, just
2477 // hope the type is Clonable and use that.
2478 write!(w, ".clone()").unwrap();
2480 var_suffix(w, real_elem, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2482 write!(w, "){};", if to_c { ".into()" } else { "" }).unwrap();
2486 _ => unimplemented!(),
2490 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 {
2491 self.write_conversion_new_var_intern(w, ident, var_access, t, generics, from_ownable_ref, ptr_for_ref, true, from_ownable_ref,
2492 &|a, b| self.to_c_conversion_new_var_from_path(a, b),
2493 &|a, b, c, d, e| self.to_c_conversion_container_new_var(generics, a, b, c, d, e),
2494 // We force ptr_for_ref here since we can't generate a ref on one line and use it later
2495 &|a, b, c, d, e, f| self.write_to_c_conversion_inline_prefix_inner(a, b, c, d, e, f),
2496 &|a, b, c, d, e, f| self.write_to_c_conversion_inline_suffix_inner(a, b, c, d, e, f))
2498 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 {
2499 self.write_to_c_conversion_new_var_inner(w, ident, &format!("{}", ident), t, generics, ptr_for_ref, false)
2501 /// Prints new-var conversion for an "ownable_ref" type, ie prints conversion for
2502 /// `create_ownable_reference(t)`, not `t` itself.
2503 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 {
2504 self.write_to_c_conversion_new_var_inner(w, ident, &format!("{}", ident), t, generics, true, true)
2506 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 {
2507 self.write_conversion_new_var_intern(w, ident, &format!("{}", ident), t, generics, false, false, false, false,
2508 &|a, b| self.from_c_conversion_new_var_from_path(a, b),
2509 &|a, b, c, d, e| self.from_c_conversion_container_new_var(generics, a, b, c, d, e),
2510 // We force ptr_for_ref here since we can't generate a ref on one line and use it later
2511 &|a, b, c, d, e, _f| self.write_from_c_conversion_prefix_inner(a, b, c, d, e),
2512 &|a, b, c, d, e, _f| self.write_from_c_conversion_suffix_inner(a, b, c, d, e))
2515 // ******************************************************
2516 // *** C Container Type Equivalent and alias Printing ***
2517 // ******************************************************
2519 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 {
2520 for (idx, orig_t) in args.enumerate() {
2522 write!(w, ", ").unwrap();
2524 let t = generics.resolve_type(orig_t);
2525 if let syn::Type::Reference(r_arg) = t {
2526 assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
2528 if !self.write_c_type_intern(w, &*r_arg.elem, generics, false, false, false, true, true) { return false; }
2530 // While write_c_type_intern, above is correct, we don't want to blindly convert a
2531 // reference to something stupid, so check that the container is either opaque or a
2532 // predefined type (currently only Transaction).
2533 if let syn::Type::Path(p_arg) = &*r_arg.elem {
2534 let resolved = self.resolve_path(&p_arg.path, generics);
2535 assert!(self.crate_types.opaques.get(&resolved).is_some() ||
2536 self.crate_types.traits.get(&resolved).is_some() ||
2537 self.c_type_from_path(&resolved, true, true).is_some(), "Template generics should be opaque or have a predefined mapping");
2538 } else { unimplemented!(); }
2539 } else if let syn::Type::Path(p_arg) = t {
2540 if let Some(resolved) = self.maybe_resolve_path(&p_arg.path, generics) {
2541 if !self.is_primitive(&resolved) {
2542 assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
2545 assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
2547 if !self.write_c_type_intern(w, t, generics, false, false, false, true, true) { return false; }
2549 // We don't currently support outer reference types for non-primitive inners,
2550 // except for the empty tuple.
2551 if let syn::Type::Tuple(t_arg) = t {
2552 assert!(t_arg.elems.len() == 0 || !is_ref);
2556 if !self.write_c_type_intern(w, t, generics, false, false, false, true, true) { return false; }
2561 fn check_create_container(&self, mangled_container: String, container_type: &str, args: Vec<&syn::Type>, generics: Option<&GenericTypes>, is_ref: bool) -> bool {
2562 if !self.crate_types.templates_defined.borrow().get(&mangled_container).is_some() {
2563 let mut created_container: Vec<u8> = Vec::new();
2565 if container_type == "Result" {
2566 let mut a_ty: Vec<u8> = Vec::new();
2567 if let syn::Type::Tuple(tup) = args.iter().next().unwrap() {
2568 if tup.elems.is_empty() {
2569 write!(&mut a_ty, "()").unwrap();
2571 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t).take(1), generics, is_ref) { return false; }
2574 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t).take(1), generics, is_ref) { return false; }
2577 let mut b_ty: Vec<u8> = Vec::new();
2578 if let syn::Type::Tuple(tup) = args.iter().skip(1).next().unwrap() {
2579 if tup.elems.is_empty() {
2580 write!(&mut b_ty, "()").unwrap();
2582 if !self.write_template_generics(&mut b_ty, &mut args.iter().map(|t| *t).skip(1), generics, is_ref) { return false; }
2585 if !self.write_template_generics(&mut b_ty, &mut args.iter().map(|t| *t).skip(1), generics, is_ref) { return false; }
2588 let ok_str = String::from_utf8(a_ty).unwrap();
2589 let err_str = String::from_utf8(b_ty).unwrap();
2590 let is_clonable = self.is_clonable(&ok_str) && self.is_clonable(&err_str);
2591 write_result_block(&mut created_container, &mangled_container, &ok_str, &err_str, is_clonable);
2593 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2595 } else if container_type == "Vec" {
2596 let mut a_ty: Vec<u8> = Vec::new();
2597 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t), generics, is_ref) { return false; }
2598 let ty = String::from_utf8(a_ty).unwrap();
2599 let is_clonable = self.is_clonable(&ty);
2600 write_vec_block(&mut created_container, &mangled_container, &ty, is_clonable);
2602 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2604 } else if container_type.ends_with("Tuple") {
2605 let mut tuple_args = Vec::new();
2606 let mut is_clonable = true;
2607 for arg in args.iter() {
2608 let mut ty: Vec<u8> = Vec::new();
2609 if !self.write_template_generics(&mut ty, &mut [arg].iter().map(|t| **t), generics, is_ref) { return false; }
2610 let ty_str = String::from_utf8(ty).unwrap();
2611 if !self.is_clonable(&ty_str) {
2612 is_clonable = false;
2614 tuple_args.push(ty_str);
2616 write_tuple_block(&mut created_container, &mangled_container, &tuple_args, is_clonable);
2618 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2620 } else if container_type == "Option" {
2621 let mut a_ty: Vec<u8> = Vec::new();
2622 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t), generics, is_ref) { return false; }
2623 let ty = String::from_utf8(a_ty).unwrap();
2624 let is_clonable = self.is_clonable(&ty);
2625 write_option_block(&mut created_container, &mangled_container, &ty, is_clonable);
2627 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2632 self.crate_types.write_new_template(mangled_container.clone(), true, &created_container);
2636 fn path_to_generic_args(path: &syn::Path) -> Vec<&syn::Type> {
2637 if let syn::PathArguments::AngleBracketed(args) = &path.segments.iter().next().unwrap().arguments {
2638 args.args.iter().map(|gen| if let syn::GenericArgument::Type(t) = gen { t } else { unimplemented!() }).collect()
2639 } else { unimplemented!(); }
2641 fn write_c_mangled_container_path_intern<W: std::io::Write>
2642 (&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 {
2643 let mut mangled_type: Vec<u8> = Vec::new();
2644 if !self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) {
2645 write!(w, "C{}_", ident).unwrap();
2646 write!(mangled_type, "C{}_", ident).unwrap();
2647 } else { assert_eq!(args.len(), 1); }
2648 for arg in args.iter() {
2649 macro_rules! write_path {
2650 ($p_arg: expr, $extra_write: expr) => {
2651 if let Some(subtype) = self.maybe_resolve_path(&$p_arg.path, generics) {
2652 if self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) {
2654 if self.c_type_has_inner_from_path(&subtype) {
2655 if !self.write_c_path_intern(w, &$p_arg.path, generics, is_ref, is_mut, ptr_for_ref, false, true) { return false; }
2657 if let Some(arr_ty) = self.is_real_type_array(&subtype) {
2658 if !self.write_c_type_intern(w, &arr_ty, generics, false, true, false, false, true) { return false; }
2660 // Option<T> needs to be converted to a *mut T, ie mut ptr-for-ref
2661 if !self.write_c_path_intern(w, &$p_arg.path, generics, true, true, true, false, true) { return false; }
2665 write!(w, "{}", $p_arg.path.segments.last().unwrap().ident).unwrap();
2667 } else if self.is_known_container(&subtype, is_ref) || self.is_path_transparent_container(&$p_arg.path, generics, is_ref) {
2668 if !self.write_c_mangled_container_path_intern(w, Self::path_to_generic_args(&$p_arg.path), generics,
2669 &subtype, is_ref, is_mut, ptr_for_ref, true) {
2672 self.write_c_mangled_container_path_intern(&mut mangled_type, Self::path_to_generic_args(&$p_arg.path),
2673 generics, &subtype, is_ref, is_mut, ptr_for_ref, true);
2674 if let Some(w2) = $extra_write as Option<&mut Vec<u8>> {
2675 self.write_c_mangled_container_path_intern(w2, Self::path_to_generic_args(&$p_arg.path),
2676 generics, &subtype, is_ref, is_mut, ptr_for_ref, true);
2679 let id = subtype.rsplitn(2, ':').next().unwrap(); // Get the "Base" name of the resolved type
2680 write!(w, "{}", id).unwrap();
2681 write!(mangled_type, "{}", id).unwrap();
2682 if let Some(w2) = $extra_write as Option<&mut Vec<u8>> {
2683 write!(w2, "{}", id).unwrap();
2686 } else { return false; }
2689 match generics.resolve_type(arg) {
2690 syn::Type::Tuple(tuple) => {
2691 if tuple.elems.len() == 0 {
2692 write!(w, "None").unwrap();
2693 write!(mangled_type, "None").unwrap();
2695 let mut mangled_tuple_type: Vec<u8> = Vec::new();
2697 // Figure out what the mangled type should look like. To disambiguate
2698 // ((A, B), C) and (A, B, C) we prefix the generic args with a _ and suffix
2699 // them with a Z. Ideally we wouldn't use Z, but not many special chars are
2700 // available for use in type names.
2701 write!(w, "C{}Tuple_", tuple.elems.len()).unwrap();
2702 write!(mangled_type, "C{}Tuple_", tuple.elems.len()).unwrap();
2703 write!(mangled_tuple_type, "C{}Tuple_", tuple.elems.len()).unwrap();
2704 for elem in tuple.elems.iter() {
2705 if let syn::Type::Path(p) = elem {
2706 write_path!(p, Some(&mut mangled_tuple_type));
2707 } else if let syn::Type::Reference(refelem) = elem {
2708 if let syn::Type::Path(p) = &*refelem.elem {
2709 write_path!(p, Some(&mut mangled_tuple_type));
2710 } else { return false; }
2711 } else { return false; }
2713 write!(w, "Z").unwrap();
2714 write!(mangled_type, "Z").unwrap();
2715 write!(mangled_tuple_type, "Z").unwrap();
2716 if !self.check_create_container(String::from_utf8(mangled_tuple_type).unwrap(),
2717 &format!("{}Tuple", tuple.elems.len()), tuple.elems.iter().collect(), generics, is_ref) {
2722 syn::Type::Path(p_arg) => {
2723 write_path!(p_arg, None);
2725 syn::Type::Reference(refty) => {
2726 if let syn::Type::Path(p_arg) = &*refty.elem {
2727 write_path!(p_arg, None);
2728 } else if let syn::Type::Slice(_) = &*refty.elem {
2729 // write_c_type will actually do exactly what we want here, we just need to
2730 // make it a pointer so that its an option. Note that we cannot always convert
2731 // the Vec-as-slice (ie non-ref types) containers, so sometimes need to be able
2732 // to edit it, hence we use *mut here instead of *const.
2733 if args.len() != 1 { return false; }
2734 write!(w, "*mut ").unwrap();
2735 self.write_c_type(w, arg, None, true);
2736 } else { return false; }
2738 syn::Type::Array(a) => {
2739 if let syn::Type::Path(p_arg) = &*a.elem {
2740 let resolved = self.resolve_path(&p_arg.path, generics);
2741 if !self.is_primitive(&resolved) { return false; }
2742 if let syn::Expr::Lit(syn::ExprLit { lit: syn::Lit::Int(len), .. }) = &a.len {
2743 if self.c_type_from_path(&format!("[{}; {}]", resolved, len.base10_digits()), is_ref, ptr_for_ref).is_none() { return false; }
2744 if in_type || args.len() != 1 {
2745 write!(w, "_{}{}", resolved, len.base10_digits()).unwrap();
2746 write!(mangled_type, "_{}{}", resolved, len.base10_digits()).unwrap();
2748 let arrty = format!("[{}; {}]", resolved, len.base10_digits());
2749 let realty = self.c_type_from_path(&arrty, is_ref, ptr_for_ref).unwrap_or(&arrty);
2750 write!(w, "{}", realty).unwrap();
2751 write!(mangled_type, "{}", realty).unwrap();
2753 } else { return false; }
2754 } else { return false; }
2756 _ => { return false; },
2759 if self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) { return true; }
2760 // Push the "end of type" Z
2761 write!(w, "Z").unwrap();
2762 write!(mangled_type, "Z").unwrap();
2764 // Make sure the type is actually defined:
2765 self.check_create_container(String::from_utf8(mangled_type).unwrap(), ident, args, generics, is_ref)
2767 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 {
2768 if !self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) {
2769 write!(w, "{}::", Self::generated_container_path()).unwrap();
2771 self.write_c_mangled_container_path_intern(w, args, generics, ident, is_ref, is_mut, ptr_for_ref, false)
2773 pub fn get_c_mangled_container_type(&self, args: Vec<&syn::Type>, generics: Option<&GenericTypes>, template_name: &str) -> Option<String> {
2774 let mut out = Vec::new();
2775 if !self.write_c_mangled_container_path(&mut out, args, generics, template_name, false, false, false) {
2778 Some(String::from_utf8(out).unwrap())
2781 // **********************************
2782 // *** C Type Equivalent Printing ***
2783 // **********************************
2785 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 {
2786 let full_path = match self.maybe_resolve_path(&path, generics) {
2787 Some(path) => path, None => return false };
2788 if let Some(c_type) = self.c_type_from_path(&full_path, is_ref, ptr_for_ref) {
2789 write!(w, "{}", c_type).unwrap();
2791 } else if self.crate_types.traits.get(&full_path).is_some() {
2792 // Note that we always use the crate:: prefix here as we are always referring to a
2793 // concrete object which is of the generated type, it just implements the upstream
2795 if is_ref && ptr_for_ref {
2796 write!(w, "*{} crate::{}", if is_mut { "mut" } else { "const" }, full_path).unwrap();
2798 if with_ref_lifetime { unimplemented!(); }
2799 write!(w, "&{}crate::{}", if is_mut { "mut " } else { "" }, full_path).unwrap();
2801 write!(w, "crate::{}", full_path).unwrap();
2804 } else if self.crate_types.opaques.get(&full_path).is_some() || self.crate_types.mirrored_enums.get(&full_path).is_some() {
2805 let crate_pfx = if c_ty { "crate::" } else { "" };
2806 if is_ref && ptr_for_ref {
2807 // ptr_for_ref implies we're returning the object, which we can't really do for
2808 // opaque or mirrored types without box'ing them, which is quite a waste, so return
2809 // the actual object itself (for opaque types we'll set the pointer to the actual
2810 // type and note that its a reference).
2811 write!(w, "{}{}", crate_pfx, full_path).unwrap();
2812 } else if is_ref && with_ref_lifetime {
2814 // If we're concretizing something with a lifetime parameter, we have to pick a
2815 // lifetime, of which the only real available choice is `static`, obviously.
2816 write!(w, "&'static {}", crate_pfx).unwrap();
2818 self.write_rust_path(w, generics, path, with_ref_lifetime, false);
2820 // We shouldn't be mapping references in types, so panic here
2824 write!(w, "&{}{}{}", if is_mut { "mut " } else { "" }, crate_pfx, full_path).unwrap();
2826 write!(w, "{}{}", crate_pfx, full_path).unwrap();
2833 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 {
2834 match generics.resolve_type(t) {
2835 syn::Type::Path(p) => {
2836 if p.qself.is_some() {
2839 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
2840 if self.is_known_container(&full_path, is_ref) || self.is_path_transparent_container(&p.path, generics, is_ref) {
2841 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);
2843 if let Some(aliased_type) = self.crate_types.type_aliases.get(&full_path).cloned() {
2844 return self.write_c_type_intern(w, &aliased_type, None, is_ref, is_mut, ptr_for_ref, with_ref_lifetime, c_ty);
2847 self.write_c_path_intern(w, &p.path, generics, is_ref, is_mut, ptr_for_ref, with_ref_lifetime, c_ty)
2849 syn::Type::Reference(r) => {
2850 self.write_c_type_intern(w, &*r.elem, generics, true, r.mutability.is_some(), ptr_for_ref, with_ref_lifetime, c_ty)
2852 syn::Type::Array(a) => {
2853 if is_ref && is_mut {
2854 write!(w, "*mut [").unwrap();
2855 if !self.write_c_type_intern(w, &a.elem, generics, false, false, ptr_for_ref, with_ref_lifetime, c_ty) { return false; }
2857 write!(w, "*const [").unwrap();
2858 if !self.write_c_type_intern(w, &a.elem, generics, false, false, ptr_for_ref, with_ref_lifetime, c_ty) { return false; }
2860 let mut typecheck = Vec::new();
2861 if !self.write_c_type_intern(&mut typecheck, &a.elem, generics, false, false, ptr_for_ref, with_ref_lifetime, c_ty) { return false; }
2862 if typecheck[..] != ['u' as u8, '8' as u8] { return false; }
2864 if let syn::Expr::Lit(l) = &a.len {
2865 if let syn::Lit::Int(i) = &l.lit {
2867 if let Some(ty) = self.c_type_from_path(&format!("[u8; {}]", i.base10_digits()), false, ptr_for_ref) {
2868 write!(w, "{}", ty).unwrap();
2872 write!(w, "; {}]", i).unwrap();
2878 syn::Type::Slice(s) => {
2879 if !is_ref || is_mut { return false; }
2880 if let syn::Type::Path(p) = &*s.elem {
2881 let resolved = self.resolve_path(&p.path, generics);
2882 if self.is_primitive(&resolved) {
2883 write!(w, "{}::{}slice", Self::container_templ_path(), resolved).unwrap();
2886 let mut inner_c_ty = Vec::new();
2887 assert!(self.write_c_path_intern(&mut inner_c_ty, &p.path, generics, true, false, ptr_for_ref, with_ref_lifetime, c_ty));
2888 if self.is_clonable(&String::from_utf8(inner_c_ty).unwrap()) {
2889 if let Some(id) = p.path.get_ident() {
2890 let mangled_container = format!("CVec_{}Z", id);
2891 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
2892 self.check_create_container(mangled_container, "Vec", vec![&*s.elem], generics, false)
2896 } else if let syn::Type::Reference(r) = &*s.elem {
2897 if let syn::Type::Path(p) = &*r.elem {
2898 // Slices with "real types" inside are mapped as the equivalent non-ref Vec
2899 let resolved = self.resolve_path(&p.path, generics);
2900 let mangled_container = if let Some((ident, _)) = self.crate_types.opaques.get(&resolved) {
2901 format!("CVec_{}Z", ident)
2902 } else if let Some(en) = self.crate_types.mirrored_enums.get(&resolved) {
2903 format!("CVec_{}Z", en.ident)
2904 } else if let Some(id) = p.path.get_ident() {
2905 format!("CVec_{}Z", id)
2906 } else { return false; };
2907 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
2908 self.check_create_container(mangled_container, "Vec", vec![&*r.elem], generics, false)
2909 } else if let syn::Type::Slice(sl2) = &*r.elem {
2910 if let syn::Type::Reference(r2) = &*sl2.elem {
2911 if let syn::Type::Path(p) = &*r2.elem {
2912 // Slices with slices with opaque types (with is_owned flags) are mapped as non-ref Vecs
2913 let resolved = self.resolve_path(&p.path, generics);
2914 let mangled_container = if let Some((ident, _)) = self.crate_types.opaques.get(&resolved) {
2915 format!("CVec_CVec_{}ZZ", ident)
2916 } else { return false; };
2917 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
2918 let inner = &r2.elem;
2919 let vec_ty: syn::Type = syn::parse_quote!(Vec<#inner>);
2920 self.check_create_container(mangled_container, "Vec", vec![&vec_ty], generics, false)
2924 } else if let syn::Type::Tuple(_) = &*s.elem {
2925 let mut args = syn::punctuated::Punctuated::<_, syn::token::Comma>::new();
2926 args.push(syn::GenericArgument::Type((*s.elem).clone()));
2927 let mut segments = syn::punctuated::Punctuated::new();
2928 segments.push(parse_quote!(Vec<#args>));
2929 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)
2930 } else if let syn::Type::Array(a) = &*s.elem {
2931 if let syn::Expr::Lit(l) = &a.len {
2932 if let syn::Lit::Int(i) = &l.lit {
2933 let mut buf = Vec::new();
2934 self.write_rust_type(&mut buf, generics, &*a.elem, false);
2935 let arr_ty = String::from_utf8(buf).unwrap();
2937 let arr_str = format!("[{}; {}]", arr_ty, i.base10_digits());
2938 let ty = self.c_type_from_path(&arr_str, false, ptr_for_ref).unwrap()
2939 .rsplitn(2, "::").next().unwrap();
2941 let mangled_container = format!("CVec_{}Z", ty);
2942 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
2943 self.check_create_container(mangled_container, "Vec", vec![&*s.elem], generics, false)
2948 syn::Type::Tuple(t) => {
2949 if t.elems.len() == 0 {
2952 self.write_c_mangled_container_path(w, t.elems.iter().collect(), generics,
2953 &format!("{}Tuple", t.elems.len()), is_ref, is_mut, ptr_for_ref)
2959 pub fn write_c_type<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, ptr_for_ref: bool) {
2960 assert!(self.write_c_type_intern(w, t, generics, false, false, ptr_for_ref, false, true));
2962 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) {
2963 assert!(self.write_c_type_intern(w, t, generics, false, false, ptr_for_ref, true, false));
2965 pub fn understood_c_path(&self, p: &syn::Path) -> bool {
2966 self.write_c_path_intern(&mut std::io::sink(), p, None, false, false, false, false, true)
2968 pub fn understood_c_type(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> bool {
2969 self.write_c_type_intern(&mut std::io::sink(), t, generics, false, false, false, false, true)