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 #[derive(Debug, PartialEq)]
69 pub enum ExportStatus {
73 /// This is used only for traits to indicate that users should not be able to implement their
74 /// own version of a trait, but we should export Rust implementations of the trait (and the
76 /// Concretly, this means that we do not implement the Rust trait for the C trait struct.
79 /// Gets the ExportStatus of an object (struct, fn, etc) given its attributes.
80 pub fn export_status(attrs: &[syn::Attribute]) -> ExportStatus {
81 for attr in attrs.iter() {
82 let tokens_clone = attr.tokens.clone();
83 let mut token_iter = tokens_clone.into_iter();
84 if let Some(token) = token_iter.next() {
86 TokenTree::Punct(c) if c.as_char() == '=' => {
87 // Really not sure where syn gets '=' from here -
88 // it somehow represents '///' or '//!'
90 TokenTree::Group(g) => {
91 if format!("{}", single_ident_generic_path_to_ident(&attr.path).unwrap()) == "cfg" {
92 let mut iter = g.stream().into_iter();
93 if let TokenTree::Ident(i) = iter.next().unwrap() {
95 // #[cfg(any(test, feature = ""))]
96 if let TokenTree::Group(g) = iter.next().unwrap() {
97 let mut all_test = true;
98 for token in g.stream().into_iter() {
99 if let TokenTree::Ident(i) = token {
100 match format!("{}", i).as_str() {
103 _ => all_test = false,
105 } else if let TokenTree::Literal(lit) = token {
106 if format!("{}", lit) != "fuzztarget" {
111 if all_test { return ExportStatus::TestOnly; }
113 } else if i == "test" || i == "feature" {
114 // If its cfg(feature(...)) we assume its test-only
115 return ExportStatus::TestOnly;
119 continue; // eg #[derive()]
121 _ => unimplemented!(),
124 match token_iter.next().unwrap() {
125 TokenTree::Literal(lit) => {
126 let line = format!("{}", lit);
127 if line.contains("(C-not exported)") {
128 return ExportStatus::NoExport;
129 } else if line.contains("(C-not implementable)") {
130 return ExportStatus::NotImplementable;
133 _ => unimplemented!(),
139 pub fn assert_simple_bound(bound: &syn::TraitBound) {
140 if bound.paren_token.is_some() || bound.lifetimes.is_some() { unimplemented!(); }
141 if let syn::TraitBoundModifier::Maybe(_) = bound.modifier { unimplemented!(); }
144 /// Returns true if the enum will be mapped as an opaue (ie struct with a pointer to the underlying
145 /// type), otherwise it is mapped into a transparent, C-compatible version of itself.
146 pub fn is_enum_opaque(e: &syn::ItemEnum) -> bool {
147 for var in e.variants.iter() {
148 if let syn::Fields::Named(fields) = &var.fields {
149 for field in fields.named.iter() {
150 match export_status(&field.attrs) {
151 ExportStatus::Export|ExportStatus::TestOnly => {},
152 ExportStatus::NotImplementable => panic!("(C-not implementable) should only appear on traits!"),
153 ExportStatus::NoExport => return true,
156 } else if let syn::Fields::Unnamed(fields) = &var.fields {
157 for field in fields.unnamed.iter() {
158 match export_status(&field.attrs) {
159 ExportStatus::Export|ExportStatus::TestOnly => {},
160 ExportStatus::NotImplementable => panic!("(C-not implementable) should only appear on traits!"),
161 ExportStatus::NoExport => return true,
169 /// A stack of sets of generic resolutions.
171 /// This tracks the template parameters for a function, struct, or trait, allowing resolution into
172 /// a concrete type. By pushing a new context onto the stack, this can track a function's template
173 /// parameters inside of a generic struct or trait.
175 /// It maps both direct types as well as Deref<Target = X>, mapping them via the provided
176 /// TypeResolver's resolve_path function (ie traits map to the concrete jump table, structs to the
177 /// concrete C container struct, etc).
179 pub struct GenericTypes<'a, 'b> {
180 self_ty: Option<String>,
181 parent: Option<&'b GenericTypes<'b, 'b>>,
182 typed_generics: HashMap<&'a syn::Ident, String>,
183 default_generics: HashMap<&'a syn::Ident, (syn::Type, syn::Type)>,
185 impl<'a, 'p: 'a> GenericTypes<'a, 'p> {
186 pub fn new(self_ty: Option<String>) -> Self {
187 Self { self_ty, parent: None, typed_generics: HashMap::new(), default_generics: HashMap::new(), }
190 /// push a new context onto the stack, allowing for a new set of generics to be learned which
191 /// will override any lower contexts, but which will still fall back to resoltion via lower
193 pub fn push_ctx<'c>(&'c self) -> GenericTypes<'a, 'c> {
194 GenericTypes { self_ty: None, parent: Some(self), typed_generics: HashMap::new(), default_generics: HashMap::new(), }
197 /// Learn the generics in generics in the current context, given a TypeResolver.
198 pub fn learn_generics<'b, 'c>(&mut self, generics: &'a syn::Generics, types: &'b TypeResolver<'a, 'c>) -> bool {
199 let mut new_typed_generics = HashMap::new();
200 // First learn simple generics...
201 for generic in generics.params.iter() {
203 syn::GenericParam::Type(type_param) => {
204 let mut non_lifetimes_processed = false;
205 'bound_loop: for bound in type_param.bounds.iter() {
206 if let syn::TypeParamBound::Trait(trait_bound) = bound {
207 if let Some(ident) = single_ident_generic_path_to_ident(&trait_bound.path) {
208 match &format!("{}", ident) as &str { "Send" => continue, "Sync" => continue, _ => {} }
210 if path_matches_nongeneric(&trait_bound.path, &["core", "clone", "Clone"]) { continue; }
212 assert_simple_bound(&trait_bound);
213 if let Some(path) = types.maybe_resolve_path(&trait_bound.path, None) {
214 if types.skip_path(&path) { continue; }
215 if path == "Sized" { continue; }
216 if non_lifetimes_processed { return false; }
217 non_lifetimes_processed = true;
218 if path != "std::ops::Deref" && path != "core::ops::Deref" {
219 new_typed_generics.insert(&type_param.ident, Some(path));
220 } else if trait_bound.path.segments.len() == 1 {
221 // If we're templated on Deref<Target = ConcreteThing>, store
222 // the reference type in `default_generics` which handles full
223 // types and not just paths.
224 if let syn::PathArguments::AngleBracketed(ref args) =
225 trait_bound.path.segments[0].arguments {
226 for subargument in args.args.iter() {
228 syn::GenericArgument::Lifetime(_) => {},
229 syn::GenericArgument::Binding(ref b) => {
230 if &format!("{}", b.ident) != "Target" { return false; }
232 self.default_generics.insert(&type_param.ident, (parse_quote!(&#default), parse_quote!(&#default)));
235 _ => unimplemented!(),
239 new_typed_generics.insert(&type_param.ident, None);
245 if let Some(default) = type_param.default.as_ref() {
246 assert!(type_param.bounds.is_empty());
247 self.default_generics.insert(&type_param.ident, (default.clone(), parse_quote!(&#default)));
253 // Then find generics where we are required to pass a Deref<Target=X> and pretend its just X.
254 if let Some(wh) = &generics.where_clause {
255 for pred in wh.predicates.iter() {
256 if let syn::WherePredicate::Type(t) = pred {
257 if let syn::Type::Path(p) = &t.bounded_ty {
258 if p.qself.is_some() { return false; }
259 if p.path.leading_colon.is_some() { return false; }
260 let mut p_iter = p.path.segments.iter();
261 if let Some(gen) = new_typed_generics.get_mut(&p_iter.next().unwrap().ident) {
262 if gen.is_some() { return false; }
263 if &format!("{}", p_iter.next().unwrap().ident) != "Target" {return false; }
265 let mut non_lifetimes_processed = false;
266 for bound in t.bounds.iter() {
267 if let syn::TypeParamBound::Trait(trait_bound) = bound {
268 if let Some(id) = trait_bound.path.get_ident() {
269 if format!("{}", id) == "Sized" { continue; }
271 if non_lifetimes_processed { return false; }
272 non_lifetimes_processed = true;
273 assert_simple_bound(&trait_bound);
274 *gen = Some(types.resolve_path(&trait_bound.path, None));
277 } else { return false; }
278 } else { return false; }
282 for (key, value) in new_typed_generics.drain() {
283 if let Some(v) = value {
284 assert!(self.typed_generics.insert(key, v).is_none());
285 } else { return false; }
290 /// Learn the associated types from the trait in the current context.
291 pub fn learn_associated_types<'b, 'c>(&mut self, t: &'a syn::ItemTrait, types: &'b TypeResolver<'a, 'c>) {
292 for item in t.items.iter() {
294 &syn::TraitItem::Type(ref t) => {
295 if t.default.is_some() || t.generics.lt_token.is_some() { unimplemented!(); }
296 let mut bounds_iter = t.bounds.iter();
298 match bounds_iter.next().unwrap() {
299 syn::TypeParamBound::Trait(tr) => {
300 assert_simple_bound(&tr);
301 if let Some(path) = types.maybe_resolve_path(&tr.path, None) {
302 if types.skip_path(&path) { continue; }
303 // In general we handle Deref<Target=X> as if it were just X (and
304 // implement Deref<Target=Self> for relevant types). We don't
305 // bother to implement it for associated types, however, so we just
306 // ignore such bounds.
307 if path != "std::ops::Deref" && path != "core::ops::Deref" {
308 self.typed_generics.insert(&t.ident, path);
310 } else { unimplemented!(); }
311 for bound in bounds_iter {
312 if let syn::TypeParamBound::Trait(_) = bound { unimplemented!(); }
316 syn::TypeParamBound::Lifetime(_) => {},
325 /// Attempt to resolve a Path as a generic parameter and return the full path. as both a string
327 pub fn maybe_resolve_path<'b>(&'b self, path: &syn::Path) -> Option<&'b String> {
328 if let Some(ident) = path.get_ident() {
329 if let Some(ty) = &self.self_ty {
330 if format!("{}", ident) == "Self" {
334 if let Some(res) = self.typed_generics.get(ident) {
338 // Associated types are usually specified as "Self::Generic", so we check for that
340 let mut it = path.segments.iter();
341 if path.segments.len() == 2 && format!("{}", it.next().unwrap().ident) == "Self" {
342 let ident = &it.next().unwrap().ident;
343 if let Some(res) = self.typed_generics.get(ident) {
348 if let Some(parent) = self.parent {
349 parent.maybe_resolve_path(path)
356 trait ResolveType<'a> { fn resolve_type(&'a self, ty: &'a syn::Type) -> &'a syn::Type; }
357 impl<'a, 'b, 'c: 'a + 'b> ResolveType<'c> for Option<&GenericTypes<'a, 'b>> {
358 fn resolve_type(&'c self, ty: &'c syn::Type) -> &'c syn::Type {
359 if let Some(us) = self {
361 syn::Type::Path(p) => {
362 if let Some(ident) = p.path.get_ident() {
363 if let Some((ty, _)) = us.default_generics.get(ident) {
368 syn::Type::Reference(syn::TypeReference { elem, .. }) => {
369 if let syn::Type::Path(p) = &**elem {
370 if let Some(ident) = p.path.get_ident() {
371 if let Some((_, refty)) = us.default_generics.get(ident) {
379 us.parent.resolve_type(ty)
384 #[derive(Clone, PartialEq)]
385 // The type of declaration and the object itself
386 pub enum DeclType<'a> {
388 Trait(&'a syn::ItemTrait),
389 StructImported { generic_param_count: usize },
391 EnumIgnored { generic_param_count: usize },
394 pub struct ImportResolver<'mod_lifetime, 'crate_lft: 'mod_lifetime> {
395 crate_name: &'mod_lifetime str,
396 dependencies: &'mod_lifetime HashSet<syn::Ident>,
397 module_path: &'mod_lifetime str,
398 imports: HashMap<syn::Ident, (String, syn::Path)>,
399 declared: HashMap<syn::Ident, DeclType<'crate_lft>>,
400 priv_modules: HashSet<syn::Ident>,
402 impl<'mod_lifetime, 'crate_lft: 'mod_lifetime> ImportResolver<'mod_lifetime, 'crate_lft> {
403 fn process_use_intern(crate_name: &str, module_path: &str, dependencies: &HashSet<syn::Ident>, imports: &mut HashMap<syn::Ident, (String, syn::Path)>,
404 u: &syn::UseTree, partial_path: &str, mut path: syn::punctuated::Punctuated<syn::PathSegment, syn::token::Colon2>) {
407 macro_rules! push_path {
408 ($ident: expr, $path_suffix: expr) => {
409 if partial_path == "" && format!("{}", $ident) == "super" {
410 let mut mod_iter = module_path.rsplitn(2, "::");
411 mod_iter.next().unwrap();
412 let super_mod = mod_iter.next().unwrap();
413 new_path = format!("{}{}", super_mod, $path_suffix);
414 assert_eq!(path.len(), 0);
415 for module in super_mod.split("::") {
416 path.push(syn::PathSegment { ident: syn::Ident::new(module, Span::call_site()), arguments: syn::PathArguments::None });
418 } else if partial_path == "" && format!("{}", $ident) == "crate" {
419 new_path = format!("{}{}", crate_name, $path_suffix);
420 let crate_name_ident = format_ident!("{}", crate_name);
421 path.push(parse_quote!(#crate_name_ident));
422 } else if partial_path == "" && !dependencies.contains(&$ident) {
423 new_path = format!("{}::{}{}", crate_name, $ident, $path_suffix);
424 let crate_name_ident = format_ident!("{}", crate_name);
425 path.push(parse_quote!(#crate_name_ident));
427 new_path = format!("{}{}{}", partial_path, $ident, $path_suffix);
430 path.push(parse_quote!(#ident));
434 syn::UseTree::Path(p) => {
435 push_path!(p.ident, "::");
436 Self::process_use_intern(crate_name, module_path, dependencies, imports, &p.tree, &new_path, path);
438 syn::UseTree::Name(n) => {
439 push_path!(n.ident, "");
440 imports.insert(n.ident.clone(), (new_path, syn::Path { leading_colon: Some(syn::Token![::](Span::call_site())), segments: path }));
442 syn::UseTree::Group(g) => {
443 for i in g.items.iter() {
444 Self::process_use_intern(crate_name, module_path, dependencies, imports, i, partial_path, path.clone());
447 syn::UseTree::Rename(r) => {
448 push_path!(r.ident, "");
449 imports.insert(r.rename.clone(), (new_path, syn::Path { leading_colon: Some(syn::Token![::](Span::call_site())), segments: path }));
451 syn::UseTree::Glob(_) => {
452 eprintln!("Ignoring * use for {} - this may result in resolution failures", partial_path);
457 fn process_use(crate_name: &str, module_path: &str, dependencies: &HashSet<syn::Ident>, imports: &mut HashMap<syn::Ident, (String, syn::Path)>, u: &syn::ItemUse) {
458 if let syn::Visibility::Public(_) = u.vis {
459 // We actually only use these for #[cfg(fuzztarget)]
460 eprintln!("Ignoring pub(use) tree!");
463 if u.leading_colon.is_some() { eprintln!("Ignoring leading-colon use!"); return; }
464 Self::process_use_intern(crate_name, module_path, dependencies, imports, &u.tree, "", syn::punctuated::Punctuated::new());
467 fn insert_primitive(imports: &mut HashMap<syn::Ident, (String, syn::Path)>, id: &str) {
468 let ident = format_ident!("{}", id);
469 let path = parse_quote!(#ident);
470 imports.insert(ident, (id.to_owned(), path));
473 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 {
474 Self::from_borrowed_items(crate_name, dependencies, module_path, &contents.iter().map(|a| a).collect::<Vec<_>>())
476 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 {
477 let mut imports = HashMap::new();
478 // Add primitives to the "imports" list:
479 Self::insert_primitive(&mut imports, "bool");
480 Self::insert_primitive(&mut imports, "u64");
481 Self::insert_primitive(&mut imports, "u32");
482 Self::insert_primitive(&mut imports, "u16");
483 Self::insert_primitive(&mut imports, "u8");
484 Self::insert_primitive(&mut imports, "usize");
485 Self::insert_primitive(&mut imports, "str");
486 Self::insert_primitive(&mut imports, "String");
488 // These are here to allow us to print native Rust types in trait fn impls even if we don't
490 Self::insert_primitive(&mut imports, "Result");
491 Self::insert_primitive(&mut imports, "Vec");
492 Self::insert_primitive(&mut imports, "Option");
494 let mut declared = HashMap::new();
495 let mut priv_modules = HashSet::new();
497 for item in contents.iter() {
499 syn::Item::Use(u) => Self::process_use(crate_name, module_path, dependencies, &mut imports, &u),
500 syn::Item::Struct(s) => {
501 if let syn::Visibility::Public(_) = s.vis {
502 match export_status(&s.attrs) {
503 ExportStatus::Export => { declared.insert(s.ident.clone(), DeclType::StructImported { generic_param_count: s.generics.params.len() }); },
504 ExportStatus::NoExport => { declared.insert(s.ident.clone(), DeclType::StructIgnored); },
505 ExportStatus::TestOnly => continue,
506 ExportStatus::NotImplementable => panic!("(C-not implementable) should only appear on traits!"),
510 syn::Item::Type(t) if export_status(&t.attrs) == ExportStatus::Export => {
511 if let syn::Visibility::Public(_) = t.vis {
512 let mut process_alias = true;
513 for tok in t.generics.params.iter() {
514 if let syn::GenericParam::Lifetime(_) = tok {}
515 else { process_alias = false; }
518 declared.insert(t.ident.clone(), DeclType::StructImported { generic_param_count: t.generics.params.len() });
522 syn::Item::Enum(e) => {
523 if let syn::Visibility::Public(_) = e.vis {
524 match export_status(&e.attrs) {
525 ExportStatus::Export if is_enum_opaque(e) => { declared.insert(e.ident.clone(), DeclType::EnumIgnored { generic_param_count: e.generics.params.len() }); },
526 ExportStatus::Export => { declared.insert(e.ident.clone(), DeclType::MirroredEnum); },
527 ExportStatus::NotImplementable => panic!("(C-not implementable) should only appear on traits!"),
532 syn::Item::Trait(t) => {
533 match export_status(&t.attrs) {
534 ExportStatus::Export|ExportStatus::NotImplementable => {
535 if let syn::Visibility::Public(_) = t.vis {
536 declared.insert(t.ident.clone(), DeclType::Trait(t));
542 syn::Item::Mod(m) => {
543 priv_modules.insert(m.ident.clone());
549 Self { crate_name, dependencies, module_path, imports, declared, priv_modules }
552 pub fn get_declared_type(&self, ident: &syn::Ident) -> Option<&DeclType<'crate_lft>> {
553 self.declared.get(ident)
556 pub fn maybe_resolve_declared(&self, id: &syn::Ident) -> Option<&DeclType<'crate_lft>> {
557 self.declared.get(id)
560 pub fn maybe_resolve_ident(&self, id: &syn::Ident) -> Option<String> {
561 if let Some((imp, _)) = self.imports.get(id) {
563 } else if self.declared.get(id).is_some() {
564 Some(self.module_path.to_string() + "::" + &format!("{}", id))
568 pub fn maybe_resolve_non_ignored_ident(&self, id: &syn::Ident) -> Option<String> {
569 if let Some((imp, _)) = self.imports.get(id) {
571 } else if let Some(decl_type) = self.declared.get(id) {
573 DeclType::StructIgnored => None,
574 _ => Some(self.module_path.to_string() + "::" + &format!("{}", id)),
579 pub fn maybe_resolve_path(&self, p: &syn::Path, generics: Option<&GenericTypes>) -> Option<String> {
580 if let Some(gen_types) = generics {
581 if let Some(resp) = gen_types.maybe_resolve_path(p) {
582 return Some(resp.clone());
586 if p.leading_colon.is_some() {
587 let mut res: String = p.segments.iter().enumerate().map(|(idx, seg)| {
588 format!("{}{}", if idx == 0 { "" } else { "::" }, seg.ident)
590 let firstseg = p.segments.iter().next().unwrap();
591 if !self.dependencies.contains(&firstseg.ident) {
592 res = self.crate_name.to_owned() + "::" + &res;
595 } else if let Some(id) = p.get_ident() {
596 self.maybe_resolve_ident(id)
598 if p.segments.len() == 1 {
599 let seg = p.segments.iter().next().unwrap();
600 return self.maybe_resolve_ident(&seg.ident);
602 let mut seg_iter = p.segments.iter();
603 let first_seg = seg_iter.next().unwrap();
604 let remaining: String = seg_iter.map(|seg| {
605 format!("::{}", seg.ident)
607 let first_seg_str = format!("{}", first_seg.ident);
608 if let Some((imp, _)) = self.imports.get(&first_seg.ident) {
610 Some(imp.clone() + &remaining)
614 } else if let Some(_) = self.priv_modules.get(&first_seg.ident) {
615 Some(format!("{}::{}{}", self.module_path, first_seg.ident, remaining))
616 } else if first_seg_is_stdlib(&first_seg_str) || self.dependencies.contains(&first_seg.ident) {
617 Some(first_seg_str + &remaining)
622 /// Map all the Paths in a Type into absolute paths given a set of imports (generated via process_use_intern)
623 pub fn resolve_imported_refs(&self, mut ty: syn::Type) -> syn::Type {
625 syn::Type::Path(p) => {
626 if p.path.segments.len() != 1 { unimplemented!(); }
627 let mut args = p.path.segments[0].arguments.clone();
628 if let syn::PathArguments::AngleBracketed(ref mut generics) = &mut args {
629 for arg in generics.args.iter_mut() {
630 if let syn::GenericArgument::Type(ref mut t) = arg {
631 *t = self.resolve_imported_refs(t.clone());
635 if let Some((_, newpath)) = self.imports.get(single_ident_generic_path_to_ident(&p.path).unwrap()) {
636 p.path = newpath.clone();
638 p.path.segments[0].arguments = args;
640 syn::Type::Reference(r) => {
641 r.elem = Box::new(self.resolve_imported_refs((*r.elem).clone()));
643 syn::Type::Slice(s) => {
644 s.elem = Box::new(self.resolve_imported_refs((*s.elem).clone()));
646 syn::Type::Tuple(t) => {
647 for e in t.elems.iter_mut() {
648 *e = self.resolve_imported_refs(e.clone());
651 _ => unimplemented!(),
657 // templates_defined is walked to write the C++ header, so if we use the default hashing it get
658 // reordered on each genbindings run. Instead, we use SipHasher (which defaults to 0-keys) so that
659 // the sorting is stable across runs. It is deprecated, but the "replacement" doesn't actually
660 // accomplish the same goals, so we just ignore it.
662 pub type NonRandomHash = hash::BuildHasherDefault<hash::SipHasher>;
665 pub struct ASTModule {
666 pub attrs: Vec<syn::Attribute>,
667 pub items: Vec<syn::Item>,
668 pub submods: Vec<String>,
670 /// A struct containing the syn::File AST for each file in the crate.
671 pub struct FullLibraryAST {
672 pub modules: HashMap<String, ASTModule, NonRandomHash>,
673 pub dependencies: HashSet<syn::Ident>,
675 impl FullLibraryAST {
676 fn load_module(&mut self, module: String, attrs: Vec<syn::Attribute>, mut items: Vec<syn::Item>) {
677 let mut non_mod_items = Vec::with_capacity(items.len());
678 let mut submods = Vec::with_capacity(items.len());
679 for item in items.drain(..) {
681 syn::Item::Mod(m) if m.content.is_some() => {
682 if export_status(&m.attrs) == ExportStatus::Export {
683 if let syn::Visibility::Public(_) = m.vis {
684 let modident = format!("{}", m.ident);
685 let modname = if module != "" {
686 module.clone() + "::" + &modident
690 self.load_module(modname, m.attrs, m.content.unwrap().1);
691 submods.push(modident);
693 non_mod_items.push(syn::Item::Mod(m));
697 syn::Item::Mod(_) => panic!("--pretty=expanded output should never have non-body modules"),
698 syn::Item::ExternCrate(c) => {
699 if export_status(&c.attrs) == ExportStatus::Export {
700 self.dependencies.insert(c.ident);
703 _ => { non_mod_items.push(item); }
706 self.modules.insert(module, ASTModule { attrs, items: non_mod_items, submods });
709 pub fn load_lib(lib: syn::File) -> Self {
710 assert_eq!(export_status(&lib.attrs), ExportStatus::Export);
711 let mut res = Self { modules: HashMap::default(), dependencies: HashSet::new() };
712 res.load_module("".to_owned(), lib.attrs, lib.items);
717 /// List of manually-generated types which are clonable
718 fn initial_clonable_types() -> HashSet<String> {
719 let mut res = HashSet::new();
720 res.insert("crate::c_types::u5".to_owned());
721 res.insert("crate::c_types::ThirtyTwoBytes".to_owned());
722 res.insert("crate::c_types::PublicKey".to_owned());
723 res.insert("crate::c_types::Transaction".to_owned());
724 res.insert("crate::c_types::TxOut".to_owned());
725 res.insert("crate::c_types::Signature".to_owned());
726 res.insert("crate::c_types::RecoverableSignature".to_owned());
727 res.insert("crate::c_types::Secp256k1Error".to_owned());
728 res.insert("crate::c_types::IOError".to_owned());
732 /// Top-level struct tracking everything which has been defined while walking the crate.
733 pub struct CrateTypes<'a> {
734 /// This may contain structs or enums, but only when either is mapped as
735 /// struct X { inner: *mut originalX, .. }
736 pub opaques: HashMap<String, (&'a syn::Ident, &'a syn::Generics)>,
737 /// Enums which are mapped as C enums with conversion functions
738 pub mirrored_enums: HashMap<String, &'a syn::ItemEnum>,
739 /// Traits which are mapped as a pointer + jump table
740 pub traits: HashMap<String, &'a syn::ItemTrait>,
741 /// Aliases from paths to some other Type
742 pub type_aliases: HashMap<String, syn::Type>,
743 /// Value is an alias to Key (maybe with some generics)
744 pub reverse_alias_map: HashMap<String, Vec<(syn::Path, syn::PathArguments)>>,
745 /// Template continer types defined, map from mangled type name -> whether a destructor fn
748 /// This is used at the end of processing to make C++ wrapper classes
749 pub templates_defined: RefCell<HashMap<String, bool, NonRandomHash>>,
750 /// The output file for any created template container types, written to as we find new
751 /// template containers which need to be defined.
752 template_file: RefCell<&'a mut File>,
753 /// Set of containers which are clonable
754 clonable_types: RefCell<HashSet<String>>,
756 pub trait_impls: HashMap<String, Vec<String>>,
757 /// The full set of modules in the crate(s)
758 pub lib_ast: &'a FullLibraryAST,
761 impl<'a> CrateTypes<'a> {
762 pub fn new(template_file: &'a mut File, libast: &'a FullLibraryAST) -> Self {
764 opaques: HashMap::new(), mirrored_enums: HashMap::new(), traits: HashMap::new(),
765 type_aliases: HashMap::new(), reverse_alias_map: HashMap::new(),
766 templates_defined: RefCell::new(HashMap::default()),
767 clonable_types: RefCell::new(initial_clonable_types()), trait_impls: HashMap::new(),
768 template_file: RefCell::new(template_file), lib_ast: &libast,
771 pub fn set_clonable(&self, object: String) {
772 self.clonable_types.borrow_mut().insert(object);
774 pub fn is_clonable(&self, object: &str) -> bool {
775 self.clonable_types.borrow().contains(object)
777 pub fn write_new_template(&self, mangled_container: String, has_destructor: bool, created_container: &[u8]) {
778 self.template_file.borrow_mut().write(created_container).unwrap();
779 self.templates_defined.borrow_mut().insert(mangled_container, has_destructor);
783 /// A struct which tracks resolving rust types into C-mapped equivalents, exists for one specific
784 /// module but contains a reference to the overall CrateTypes tracking.
785 pub struct TypeResolver<'mod_lifetime, 'crate_lft: 'mod_lifetime> {
786 pub module_path: &'mod_lifetime str,
787 pub crate_types: &'mod_lifetime CrateTypes<'crate_lft>,
788 types: ImportResolver<'mod_lifetime, 'crate_lft>,
791 /// Returned by write_empty_rust_val_check_suffix to indicate what type of dereferencing needs to
792 /// happen to get the inner value of a generic.
793 enum EmptyValExpectedTy {
794 /// A type which has a flag for being empty (eg an array where we treat all-0s as empty).
796 /// A Option mapped as a COption_*Z
798 /// A pointer which we want to convert to a reference.
803 /// Describes the appropriate place to print a general type-conversion string when converting a
805 enum ContainerPrefixLocation {
806 /// Prints a general type-conversion string prefix and suffix outside of the
807 /// container-conversion strings.
809 /// Prints a general type-conversion string prefix and suffix inside of the
810 /// container-conversion strings.
812 /// Does not print the usual type-conversion string prefix and suffix.
816 impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
817 pub fn new(module_path: &'a str, types: ImportResolver<'a, 'c>, crate_types: &'a CrateTypes<'c>) -> Self {
818 Self { module_path, types, crate_types }
821 // *************************************************
822 // *** Well know type and conversion definitions ***
823 // *************************************************
825 /// Returns true we if can just skip passing this to C entirely
826 fn skip_path(&self, full_path: &str) -> bool {
827 full_path == "bitcoin::secp256k1::Secp256k1" ||
828 full_path == "bitcoin::secp256k1::Signing" ||
829 full_path == "bitcoin::secp256k1::Verification"
831 /// Returns true we if can just skip passing this to C entirely
832 fn no_arg_path_to_rust(&self, full_path: &str) -> &str {
833 if full_path == "bitcoin::secp256k1::Secp256k1" {
834 "secp256k1::SECP256K1"
835 } else { unimplemented!(); }
838 /// Returns true if the object is a primitive and is mapped as-is with no conversion
840 pub fn is_primitive(&self, full_path: &str) -> bool {
851 pub fn is_clonable(&self, ty: &str) -> bool {
852 if self.crate_types.is_clonable(ty) { return true; }
853 if self.is_primitive(ty) { return true; }
859 /// Gets the C-mapped type for types which are outside of the crate, or which are manually
860 /// ignored by for some reason need mapping anyway.
861 fn c_type_from_path<'b>(&self, full_path: &'b str, is_ref: bool, _ptr_for_ref: bool) -> Option<&'b str> {
862 if self.is_primitive(full_path) {
863 return Some(full_path);
866 // Note that no !is_ref types can map to an array because Rust and C's call semantics
867 // for arrays are different (https://github.com/eqrion/cbindgen/issues/528)
869 "[u8; 32]" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
870 "[u8; 20]" if !is_ref => Some("crate::c_types::TwentyBytes"),
871 "[u8; 16]" if !is_ref => Some("crate::c_types::SixteenBytes"),
872 "[u8; 10]" if !is_ref => Some("crate::c_types::TenBytes"),
873 "[u8; 4]" if !is_ref => Some("crate::c_types::FourBytes"),
874 "[u8; 3]" if !is_ref => Some("crate::c_types::ThreeBytes"), // Used for RGB values
876 "str" if is_ref => Some("crate::c_types::Str"),
877 "alloc::string::String"|"String" => Some("crate::c_types::Str"),
879 "std::time::Duration"|"core::time::Duration" => Some("u64"),
880 "std::time::SystemTime" => Some("u64"),
881 "std::io::Error" => Some("crate::c_types::IOError"),
883 "core::convert::Infallible" => Some("crate::c_types::NotConstructable"),
885 "bech32::u5" => Some("crate::c_types::u5"),
886 "core::num::NonZeroU8" => Some("u8"),
888 "bitcoin::secp256k1::key::PublicKey"|"bitcoin::secp256k1::PublicKey"|"secp256k1::key::PublicKey"
889 => Some("crate::c_types::PublicKey"),
890 "bitcoin::secp256k1::Signature" => Some("crate::c_types::Signature"),
891 "bitcoin::secp256k1::recovery::RecoverableSignature" => Some("crate::c_types::RecoverableSignature"),
892 "bitcoin::secp256k1::key::SecretKey"|"bitcoin::secp256k1::SecretKey"
893 if is_ref => Some("*const [u8; 32]"),
894 "bitcoin::secp256k1::key::SecretKey"|"bitcoin::secp256k1::SecretKey"
895 if !is_ref => Some("crate::c_types::SecretKey"),
896 "bitcoin::secp256k1::Error"|"secp256k1::Error"
897 if !is_ref => Some("crate::c_types::Secp256k1Error"),
898 "bitcoin::blockdata::script::Script" if is_ref => Some("crate::c_types::u8slice"),
899 "bitcoin::blockdata::script::Script" if !is_ref => Some("crate::c_types::derived::CVec_u8Z"),
900 "bitcoin::blockdata::transaction::OutPoint" => Some("crate::lightning::chain::transaction::OutPoint"),
901 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some("crate::c_types::Transaction"),
902 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some("crate::c_types::TxOut"),
903 "bitcoin::network::constants::Network" => Some("crate::bitcoin::network::Network"),
904 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some("*const [u8; 80]"),
905 "bitcoin::blockdata::block::Block" if is_ref => Some("crate::c_types::u8slice"),
907 "bitcoin::hash_types::PubkeyHash"|"bitcoin::hash_types::WPubkeyHash"|"bitcoin::hash_types::ScriptHash"
908 if is_ref => Some("*const [u8; 20]"),
909 "bitcoin::hash_types::WScriptHash"
910 if is_ref => Some("*const [u8; 32]"),
912 // Newtypes that we just expose in their original form.
913 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
914 if is_ref => Some("*const [u8; 32]"),
915 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
916 if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
917 "bitcoin::secp256k1::Message" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
918 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"|"lightning::ln::channelmanager::PaymentId"
919 if is_ref => Some("*const [u8; 32]"),
920 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"|"lightning::ln::channelmanager::PaymentId"
921 if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
923 // Override the default since Records contain an fmt with a lifetime:
924 "lightning::util::logger::Record" => Some("*const std::os::raw::c_char"),
926 "lightning::io::Read" => Some("crate::c_types::u8slice"),
932 fn from_c_conversion_new_var_from_path<'b>(&self, _full_path: &str, _is_ref: bool) -> Option<(&'b str, &'b str)> {
935 fn from_c_conversion_prefix_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<String> {
936 if self.is_primitive(full_path) {
937 return Some("".to_owned());
940 "Vec" if !is_ref => Some("local_"),
941 "Result" if !is_ref => Some("local_"),
942 "Option" if is_ref => Some("&local_"),
943 "Option" => Some("local_"),
945 "[u8; 32]" if is_ref => Some("unsafe { &*"),
946 "[u8; 32]" if !is_ref => Some(""),
947 "[u8; 20]" if !is_ref => Some(""),
948 "[u8; 16]" if !is_ref => Some(""),
949 "[u8; 10]" if !is_ref => Some(""),
950 "[u8; 4]" if !is_ref => Some(""),
951 "[u8; 3]" if !is_ref => Some(""),
953 "[u8]" if is_ref => Some(""),
954 "[usize]" if is_ref => Some(""),
956 "str" if is_ref => Some(""),
957 "alloc::string::String"|"String" => Some(""),
958 "std::io::Error" if !is_ref => Some(""),
959 // Note that we'll panic for String if is_ref, as we only have non-owned memory, we
960 // cannot create a &String.
962 "core::convert::Infallible" => Some("panic!(\"You must never construct a NotConstructable! : "),
964 "std::time::Duration"|"core::time::Duration" => Some("std::time::Duration::from_secs("),
965 "std::time::SystemTime" => Some("(::std::time::SystemTime::UNIX_EPOCH + std::time::Duration::from_secs("),
967 "bech32::u5" => Some(""),
968 "core::num::NonZeroU8" => Some("core::num::NonZeroU8::new("),
970 "bitcoin::secp256k1::key::PublicKey"|"bitcoin::secp256k1::PublicKey"|"secp256k1::key::PublicKey"
971 if is_ref => Some("&"),
972 "bitcoin::secp256k1::key::PublicKey"|"bitcoin::secp256k1::PublicKey"|"secp256k1::key::PublicKey"
974 "bitcoin::secp256k1::Signature" if is_ref => Some("&"),
975 "bitcoin::secp256k1::Signature" => Some(""),
976 "bitcoin::secp256k1::recovery::RecoverableSignature" => Some(""),
977 "bitcoin::secp256k1::key::SecretKey"|"bitcoin::secp256k1::SecretKey"
978 if is_ref => Some("&::bitcoin::secp256k1::key::SecretKey::from_slice(&unsafe { *"),
979 "bitcoin::secp256k1::key::SecretKey"|"bitcoin::secp256k1::SecretKey"
980 if !is_ref => Some(""),
981 "bitcoin::blockdata::script::Script" if is_ref => Some("&::bitcoin::blockdata::script::Script::from(Vec::from("),
982 "bitcoin::blockdata::script::Script" if !is_ref => Some("::bitcoin::blockdata::script::Script::from("),
983 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" if is_ref => Some("&"),
984 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(""),
985 "bitcoin::blockdata::transaction::OutPoint" => Some("crate::c_types::C_to_bitcoin_outpoint("),
986 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(""),
987 "bitcoin::network::constants::Network" => Some(""),
988 "bitcoin::blockdata::block::BlockHeader" => Some("&::bitcoin::consensus::encode::deserialize(unsafe { &*"),
989 "bitcoin::blockdata::block::Block" if is_ref => Some("&::bitcoin::consensus::encode::deserialize("),
991 "bitcoin::hash_types::PubkeyHash" if is_ref =>
992 Some("&bitcoin::hash_types::PubkeyHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
993 "bitcoin::hash_types::WPubkeyHash" if is_ref =>
994 Some("&bitcoin::hash_types::WPubkeyHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
995 "bitcoin::hash_types::ScriptHash" if is_ref =>
996 Some("&bitcoin::hash_types::ScriptHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
997 "bitcoin::hash_types::WScriptHash" if is_ref =>
998 Some("&bitcoin::hash_types::WScriptHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
1000 // Newtypes that we just expose in their original form.
1001 "bitcoin::hash_types::Txid" if is_ref => Some("&::bitcoin::hash_types::Txid::from_slice(&unsafe { &*"),
1002 "bitcoin::hash_types::Txid" if !is_ref => Some("::bitcoin::hash_types::Txid::from_slice(&"),
1003 "bitcoin::hash_types::BlockHash" => Some("::bitcoin::hash_types::BlockHash::from_slice(&"),
1004 "lightning::ln::PaymentHash" if !is_ref => Some("::lightning::ln::PaymentHash("),
1005 "lightning::ln::PaymentHash" if is_ref => Some("&::lightning::ln::PaymentHash(unsafe { *"),
1006 "lightning::ln::PaymentPreimage" if !is_ref => Some("::lightning::ln::PaymentPreimage("),
1007 "lightning::ln::PaymentPreimage" if is_ref => Some("&::lightning::ln::PaymentPreimage(unsafe { *"),
1008 "lightning::ln::PaymentSecret" if !is_ref => Some("::lightning::ln::PaymentSecret("),
1009 "lightning::ln::channelmanager::PaymentId" if !is_ref => Some("::lightning::ln::channelmanager::PaymentId("),
1010 "lightning::ln::channelmanager::PaymentId" if is_ref=> Some("&::lightning::ln::channelmanager::PaymentId( unsafe { *"),
1012 // List of traits we map (possibly during processing of other files):
1013 "crate::util::logger::Logger" => Some(""),
1015 "lightning::io::Read" => Some("&mut "),
1018 }.map(|s| s.to_owned())
1020 fn from_c_conversion_suffix_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<String> {
1021 if self.is_primitive(full_path) {
1022 return Some("".to_owned());
1025 "Vec" if !is_ref => Some(""),
1026 "Option" => Some(""),
1027 "Result" if !is_ref => Some(""),
1029 "[u8; 32]" if is_ref => Some("}"),
1030 "[u8; 32]" if !is_ref => Some(".data"),
1031 "[u8; 20]" if !is_ref => Some(".data"),
1032 "[u8; 16]" if !is_ref => Some(".data"),
1033 "[u8; 10]" if !is_ref => Some(".data"),
1034 "[u8; 4]" if !is_ref => Some(".data"),
1035 "[u8; 3]" if !is_ref => Some(".data"),
1037 "[u8]" if is_ref => Some(".to_slice()"),
1038 "[usize]" if is_ref => Some(".to_slice()"),
1040 "str" if is_ref => Some(".into_str()"),
1041 "alloc::string::String"|"String" => Some(".into_string()"),
1042 "std::io::Error" if !is_ref => Some(".to_rust()"),
1044 "core::convert::Infallible" => Some("\")"),
1046 "std::time::Duration"|"core::time::Duration" => Some(")"),
1047 "std::time::SystemTime" => Some("))"),
1049 "bech32::u5" => Some(".into()"),
1050 "core::num::NonZeroU8" => Some(").expect(\"Value must be non-zero\")"),
1052 "bitcoin::secp256k1::key::PublicKey"|"bitcoin::secp256k1::PublicKey"|"secp256k1::key::PublicKey"
1053 => Some(".into_rust()"),
1054 "bitcoin::secp256k1::Signature" => Some(".into_rust()"),
1055 "bitcoin::secp256k1::recovery::RecoverableSignature" => Some(".into_rust()"),
1056 "bitcoin::secp256k1::key::SecretKey"|"bitcoin::secp256k1::SecretKey"
1057 if !is_ref => Some(".into_rust()"),
1058 "bitcoin::secp256k1::key::SecretKey"|"bitcoin::secp256k1::SecretKey"
1059 if is_ref => Some("}[..]).unwrap()"),
1060 "bitcoin::blockdata::script::Script" if is_ref => Some(".to_slice()))"),
1061 "bitcoin::blockdata::script::Script" if !is_ref => Some(".into_rust())"),
1062 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(".into_bitcoin()"),
1063 "bitcoin::blockdata::transaction::OutPoint" => Some(")"),
1064 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(".into_rust()"),
1065 "bitcoin::network::constants::Network" => Some(".into_bitcoin()"),
1066 "bitcoin::blockdata::block::BlockHeader" => Some(" }).unwrap()"),
1067 "bitcoin::blockdata::block::Block" => Some(".to_slice()).unwrap()"),
1069 "bitcoin::hash_types::PubkeyHash"|"bitcoin::hash_types::WPubkeyHash"|
1070 "bitcoin::hash_types::ScriptHash"|"bitcoin::hash_types::WScriptHash"
1071 if is_ref => Some(" }.clone()))"),
1073 // Newtypes that we just expose in their original form.
1074 "bitcoin::hash_types::Txid" if is_ref => Some(" }[..]).unwrap()"),
1075 "bitcoin::hash_types::Txid" => Some(".data[..]).unwrap()"),
1076 "bitcoin::hash_types::BlockHash" if !is_ref => Some(".data[..]).unwrap()"),
1077 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"|"lightning::ln::channelmanager::PaymentId"
1078 if !is_ref => Some(".data)"),
1079 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"|"lightning::ln::channelmanager::PaymentId"
1080 if is_ref => Some(" })"),
1082 // List of traits we map (possibly during processing of other files):
1083 "crate::util::logger::Logger" => Some(""),
1085 "lightning::io::Read" => Some(".to_reader()"),
1088 }.map(|s| s.to_owned())
1091 fn to_c_conversion_new_var_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<(&'b str, &'b str)> {
1092 if self.is_primitive(full_path) {
1096 "[u8]" if is_ref => Some(("crate::c_types::u8slice::from_slice(", ")")),
1097 "[usize]" if is_ref => Some(("crate::c_types::usizeslice::from_slice(", ")")),
1099 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some(("{ let mut s = [0u8; 80]; s[..].copy_from_slice(&::bitcoin::consensus::encode::serialize(", ")); s }")),
1100 "bitcoin::blockdata::block::Block" if is_ref => Some(("::bitcoin::consensus::encode::serialize(", ")")),
1101 "bitcoin::hash_types::Txid" => None,
1103 // Override the default since Records contain an fmt with a lifetime:
1104 // TODO: We should include the other record fields
1105 "lightning::util::logger::Record" => Some(("std::ffi::CString::new(format!(\"{}\", ", ".args)).unwrap()")),
1107 }.map(|s| s.to_owned())
1109 fn to_c_conversion_inline_prefix_from_path(&self, full_path: &str, is_ref: bool, _ptr_for_ref: bool) -> Option<String> {
1110 if self.is_primitive(full_path) {
1111 return Some("".to_owned());
1114 "Result" if !is_ref => Some("local_"),
1115 "Vec" if !is_ref => Some("local_"),
1116 "Option" => Some("local_"),
1118 "[u8; 32]" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1119 "[u8; 32]" if is_ref => Some(""),
1120 "[u8; 20]" if !is_ref => Some("crate::c_types::TwentyBytes { data: "),
1121 "[u8; 16]" if !is_ref => Some("crate::c_types::SixteenBytes { data: "),
1122 "[u8; 10]" if !is_ref => Some("crate::c_types::TenBytes { data: "),
1123 "[u8; 4]" if !is_ref => Some("crate::c_types::FourBytes { data: "),
1124 "[u8; 3]" if is_ref => Some(""),
1126 "[u8]" if is_ref => Some("local_"),
1127 "[usize]" if is_ref => Some("local_"),
1129 "str" if is_ref => Some(""),
1130 "alloc::string::String"|"String" => Some(""),
1132 "std::time::Duration"|"core::time::Duration" => Some(""),
1133 "std::time::SystemTime" => Some(""),
1134 "std::io::Error" if !is_ref => Some("crate::c_types::IOError::from_rust("),
1136 "core::convert::Infallible" => Some("panic!(\"Cannot construct an Infallible: "),
1138 "bech32::u5" => Some(""),
1140 "bitcoin::secp256k1::key::PublicKey"|"bitcoin::secp256k1::PublicKey"|"secp256k1::key::PublicKey"
1141 => Some("crate::c_types::PublicKey::from_rust(&"),
1142 "bitcoin::secp256k1::Signature" => Some("crate::c_types::Signature::from_rust(&"),
1143 "bitcoin::secp256k1::recovery::RecoverableSignature" => Some("crate::c_types::RecoverableSignature::from_rust(&"),
1144 "bitcoin::secp256k1::key::SecretKey"|"bitcoin::secp256k1::SecretKey"
1145 if is_ref => Some(""),
1146 "bitcoin::secp256k1::key::SecretKey"|"bitcoin::secp256k1::SecretKey"
1147 if !is_ref => Some("crate::c_types::SecretKey::from_rust("),
1148 "bitcoin::secp256k1::Error"|"secp256k1::Error"
1149 if !is_ref => Some("crate::c_types::Secp256k1Error::from_rust("),
1150 "bitcoin::blockdata::script::Script" if is_ref => Some("crate::c_types::u8slice::from_slice(&"),
1151 "bitcoin::blockdata::script::Script" if !is_ref => Some(""),
1152 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" if is_ref => Some("crate::c_types::Transaction::from_bitcoin("),
1153 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some("crate::c_types::Transaction::from_bitcoin(&"),
1154 "bitcoin::blockdata::transaction::OutPoint" => Some("crate::c_types::bitcoin_to_C_outpoint("),
1155 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some("crate::c_types::TxOut::from_rust("),
1156 "bitcoin::network::constants::Network" => Some("crate::bitcoin::network::Network::from_bitcoin("),
1157 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some("&local_"),
1158 "bitcoin::blockdata::block::Block" if is_ref => Some("crate::c_types::u8slice::from_slice(&local_"),
1160 "bitcoin::hash_types::Txid" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1162 // Newtypes that we just expose in their original form.
1163 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1164 if is_ref => Some(""),
1165 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1166 if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1167 "bitcoin::secp256k1::Message" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1168 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"|"lightning::ln::channelmanager::PaymentId"
1169 if is_ref => Some("&"),
1170 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"|"lightning::ln::channelmanager::PaymentId"
1171 if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1173 // Override the default since Records contain an fmt with a lifetime:
1174 "lightning::util::logger::Record" => Some("local_"),
1176 "lightning::io::Read" => Some("crate::c_types::u8slice::from_vec(&crate::c_types::reader_to_vec("),
1179 }.map(|s| s.to_owned())
1181 fn to_c_conversion_inline_suffix_from_path(&self, full_path: &str, is_ref: bool, _ptr_for_ref: bool) -> Option<String> {
1182 if self.is_primitive(full_path) {
1183 return Some("".to_owned());
1186 "Result" if !is_ref => Some(""),
1187 "Vec" if !is_ref => Some(".into()"),
1188 "Option" => Some(""),
1190 "[u8; 32]" if !is_ref => Some(" }"),
1191 "[u8; 32]" if is_ref => Some(""),
1192 "[u8; 20]" if !is_ref => Some(" }"),
1193 "[u8; 16]" if !is_ref => Some(" }"),
1194 "[u8; 10]" if !is_ref => Some(" }"),
1195 "[u8; 4]" if !is_ref => Some(" }"),
1196 "[u8; 3]" if is_ref => Some(""),
1198 "[u8]" if is_ref => Some(""),
1199 "[usize]" if is_ref => Some(""),
1201 "str" if is_ref => Some(".into()"),
1202 "alloc::string::String"|"String" if is_ref => Some(".as_str().into()"),
1203 "alloc::string::String"|"String" => Some(".into()"),
1205 "std::time::Duration"|"core::time::Duration" => Some(".as_secs()"),
1206 "std::time::SystemTime" => Some(".duration_since(::std::time::SystemTime::UNIX_EPOCH).expect(\"Times must be post-1970\").as_secs()"),
1207 "std::io::Error" if !is_ref => Some(")"),
1209 "core::convert::Infallible" => Some("\")"),
1211 "bech32::u5" => Some(".into()"),
1213 "bitcoin::secp256k1::key::PublicKey"|"bitcoin::secp256k1::PublicKey"|"secp256k1::key::PublicKey"
1215 "bitcoin::secp256k1::Signature" => Some(")"),
1216 "bitcoin::secp256k1::recovery::RecoverableSignature" => Some(")"),
1217 "bitcoin::secp256k1::key::SecretKey"|"bitcoin::secp256k1::SecretKey"
1218 if !is_ref => Some(")"),
1219 "bitcoin::secp256k1::key::SecretKey"|"bitcoin::secp256k1::SecretKey"
1220 if is_ref => Some(".as_ref()"),
1221 "bitcoin::secp256k1::Error"|"secp256k1::Error"
1222 if !is_ref => Some(")"),
1223 "bitcoin::blockdata::script::Script" if is_ref => Some("[..])"),
1224 "bitcoin::blockdata::script::Script" if !is_ref => Some(".into_bytes().into()"),
1225 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(")"),
1226 "bitcoin::blockdata::transaction::OutPoint" => Some(")"),
1227 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(")"),
1228 "bitcoin::network::constants::Network" => Some(")"),
1229 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some(""),
1230 "bitcoin::blockdata::block::Block" if is_ref => Some(")"),
1232 "bitcoin::hash_types::Txid" if !is_ref => Some(".into_inner() }"),
1234 // Newtypes that we just expose in their original form.
1235 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1236 if is_ref => Some(".as_inner()"),
1237 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1238 if !is_ref => Some(".into_inner() }"),
1239 "bitcoin::secp256k1::Message" if !is_ref => Some(".as_ref().clone() }"),
1240 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"|"lightning::ln::channelmanager::PaymentId"
1241 if is_ref => Some(".0"),
1242 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"|"lightning::ln::channelmanager::PaymentId"
1243 if !is_ref => Some(".0 }"),
1245 // Override the default since Records contain an fmt with a lifetime:
1246 "lightning::util::logger::Record" => Some(".as_ptr()"),
1248 "lightning::io::Read" => Some("))"),
1251 }.map(|s| s.to_owned())
1254 fn empty_val_check_suffix_from_path(&self, full_path: &str) -> Option<&str> {
1256 "lightning::ln::PaymentSecret" => Some(".data == [0; 32]"),
1257 "secp256k1::key::PublicKey"|"bitcoin::secp256k1::key::PublicKey" => Some(".is_null()"),
1258 "bitcoin::secp256k1::Signature" => Some(".is_null()"),
1263 /// When printing a reference to the source crate's rust type, if we need to map it to a
1264 /// different "real" type, it can be done so here.
1265 /// This is useful to work around limitations in the binding type resolver, where we reference
1266 /// a non-public `use` alias.
1267 /// TODO: We should never need to use this!
1268 fn real_rust_type_mapping<'equiv>(&self, thing: &'equiv str) -> &'equiv str {
1270 "lightning::io::Read" => "std::io::Read",
1275 // ****************************
1276 // *** Container Processing ***
1277 // ****************************
1279 /// Returns the module path in the generated mapping crate to the containers which we generate
1280 /// when writing to CrateTypes::template_file.
1281 pub fn generated_container_path() -> &'static str {
1282 "crate::c_types::derived"
1284 /// Returns the module path in the generated mapping crate to the container templates, which
1285 /// are then concretized and put in the generated container path/template_file.
1286 fn container_templ_path() -> &'static str {
1290 /// Returns true if the path containing the given args is a "transparent" container, ie an
1291 /// Option or a container which does not require a generated continer class.
1292 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 {
1293 if full_path == "Option" {
1294 let inner = args.next().unwrap();
1295 assert!(args.next().is_none());
1297 syn::Type::Reference(_) => true,
1298 syn::Type::Path(p) => {
1299 if let Some(resolved) = self.maybe_resolve_path(&p.path, generics) {
1300 if self.c_type_has_inner_from_path(&resolved) { return true; }
1301 if self.is_primitive(&resolved) { return false; }
1302 if self.c_type_from_path(&resolved, false, false).is_some() { true } else { false }
1305 syn::Type::Tuple(_) => false,
1306 _ => unimplemented!(),
1310 /// Returns true if the path is a "transparent" container, ie an Option or a container which does
1311 /// not require a generated continer class.
1312 pub fn is_path_transparent_container(&self, full_path: &syn::Path, generics: Option<&GenericTypes>, is_ref: bool) -> bool {
1313 let inner_iter = match &full_path.segments.last().unwrap().arguments {
1314 syn::PathArguments::None => return false,
1315 syn::PathArguments::AngleBracketed(args) => args.args.iter().map(|arg| {
1316 if let syn::GenericArgument::Type(ref ty) = arg {
1318 } else { unimplemented!() }
1320 syn::PathArguments::Parenthesized(_) => unimplemented!(),
1322 self.is_transparent_container(&self.resolve_path(full_path, generics), is_ref, inner_iter, generics)
1324 /// Returns true if this is a known, supported, non-transparent container.
1325 fn is_known_container(&self, full_path: &str, is_ref: bool) -> bool {
1326 (full_path == "Result" && !is_ref) || (full_path == "Vec" && !is_ref) || full_path.ends_with("Tuple") || full_path == "Option"
1328 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)
1329 // Returns prefix + Vec<(prefix, var-name-to-inline-convert)> + suffix
1330 // expecting one element in the vec per generic type, each of which is inline-converted
1331 -> Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)> {
1333 "Result" if !is_ref => {
1335 vec![(" { Ok(mut o) => crate::c_types::CResultTempl::ok(".to_string(), "o".to_string()),
1336 (").into(), Err(mut e) => crate::c_types::CResultTempl::err(".to_string(), "e".to_string())],
1337 ").into() }", ContainerPrefixLocation::PerConv))
1341 // We should only get here if the single contained has an inner
1342 assert!(self.c_type_has_inner(single_contained.unwrap()));
1344 Some(("Vec::new(); for mut item in ", vec![(format!(".drain(..) {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1347 if let Some(syn::Type::Reference(_)) = single_contained {
1348 Some(("Vec::new(); for item in ", vec![(format!(".iter() {{ local_{}.push(", var_name), "(*item)".to_string())], "); }", ContainerPrefixLocation::PerConv))
1350 Some(("Vec::new(); for item in ", vec![(format!(".iter() {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1354 let contained_struct = if let Some(syn::Type::Path(p)) = single_contained {
1355 Some(self.resolve_path(&p.path, generics))
1356 } else if let Some(syn::Type::Reference(r)) = single_contained {
1357 if let syn::Type::Path(p) = &*r.elem {
1358 Some(self.resolve_path(&p.path, generics))
1361 if let Some(inner_path) = contained_struct {
1362 if self.c_type_has_inner_from_path(&inner_path) {
1363 let is_inner_ref = if let Some(syn::Type::Reference(_)) = single_contained { true } else { false };
1365 return Some(("if ", vec![
1366 (".is_none() { std::ptr::null() } else { ObjOps::nonnull_ptr_to_inner(".to_owned(),
1367 format!("({}{}.unwrap())", var_access, if is_inner_ref { "" } else { ".as_ref()" }))
1368 ], ") }", ContainerPrefixLocation::OutsideConv));
1370 return Some(("if ", vec![
1371 (".is_none() { std::ptr::null_mut() } else { ".to_owned(), format!("({}.unwrap())", var_access))
1372 ], " }", ContainerPrefixLocation::OutsideConv));
1374 } else if self.is_primitive(&inner_path) || self.c_type_from_path(&inner_path, false, false).is_none() {
1375 let inner_name = self.get_c_mangled_container_type(vec![single_contained.unwrap()], generics, "Option").unwrap();
1376 return Some(("if ", vec![
1377 (format!(".is_none() {{ {}::None }} else {{ {}::Some(",
1378 inner_name, inner_name),
1379 format!("{}.unwrap()", var_access))
1380 ], ") }", ContainerPrefixLocation::PerConv));
1382 // If c_type_from_path is some (ie there's a manual mapping for the inner
1383 // type), lean on write_empty_rust_val, below.
1386 if let Some(t) = single_contained {
1387 if let syn::Type::Reference(syn::TypeReference { elem, .. }) = t {
1388 if let syn::Type::Slice(_) = &**elem {
1389 return Some(("if ", vec![
1390 (".is_none() { SmartPtr::null() } else { SmartPtr::from_obj(".to_string(),
1391 format!("({}.unwrap())", var_access))
1392 ], ") }", ContainerPrefixLocation::PerConv));
1395 let mut v = Vec::new();
1396 self.write_empty_rust_val(generics, &mut v, t);
1397 let s = String::from_utf8(v).unwrap();
1398 return Some(("if ", vec![
1399 (format!(".is_none() {{ {} }} else {{ ", s), format!("({}.unwrap())", var_access))
1400 ], " }", ContainerPrefixLocation::PerConv));
1401 } else { unreachable!(); }
1407 /// only_contained_has_inner implies that there is only one contained element in the container
1408 /// and it has an inner field (ie is an "opaque" type we've defined).
1409 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)
1410 // Returns prefix + Vec<(prefix, var-name-to-inline-convert)> + suffix
1411 // expecting one element in the vec per generic type, each of which is inline-converted
1412 -> Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)> {
1414 "Result" if !is_ref => {
1416 vec![(".result_ok { true => Ok(".to_string(), format!("(*unsafe {{ Box::from_raw(<*mut _>::take_ptr(&mut {}.contents.result)) }})", var_access)),
1417 ("), false => Err(".to_string(), format!("(*unsafe {{ Box::from_raw(<*mut _>::take_ptr(&mut {}.contents.err)) }})", var_access))],
1418 ")}", ContainerPrefixLocation::PerConv))
1420 "Slice" if is_ref => {
1421 Some(("Vec::new(); for mut item in ", vec![(format!(".as_slice().iter() {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1424 Some(("Vec::new(); for mut item in ", vec![(format!(".into_rust().drain(..) {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1427 if let Some(syn::Type::Path(p)) = single_contained {
1428 let inner_path = self.resolve_path(&p.path, generics);
1429 if self.is_primitive(&inner_path) {
1430 return Some(("if ", vec![(".is_some() { Some(".to_string(), format!("{}.take()", var_access))], ") } else { None }", ContainerPrefixLocation::NoPrefix))
1431 } else if self.c_type_has_inner_from_path(&inner_path) {
1433 return Some(("if ", vec![(".inner.is_null() { None } else { Some((*".to_string(), format!("{}", var_access))], ").clone()) }", ContainerPrefixLocation::PerConv))
1435 return Some(("if ", vec![(".inner.is_null() { None } else { Some(".to_string(), format!("{}", var_access))], ") }", ContainerPrefixLocation::PerConv));
1440 if let Some(t) = single_contained {
1442 syn::Type::Reference(_)|syn::Type::Path(_)|syn::Type::Slice(_) => {
1443 let mut v = Vec::new();
1444 let ret_ref = self.write_empty_rust_val_check_suffix(generics, &mut v, t);
1445 let s = String::from_utf8(v).unwrap();
1447 EmptyValExpectedTy::ReferenceAsPointer =>
1448 return Some(("if ", vec![
1449 (format!("{} {{ None }} else {{ Some(", s), format!("unsafe {{ &mut *{} }}", var_access))
1450 ], ") }", ContainerPrefixLocation::NoPrefix)),
1451 EmptyValExpectedTy::OptionType =>
1452 return Some(("{ /* ", vec![
1453 (format!("*/ let {}_opt = {};", var_name, var_access),
1454 format!("}} if {}_opt{} {{ None }} else {{ Some({{ {}_opt.take()", var_name, s, var_name))
1455 ], ") } }", ContainerPrefixLocation::PerConv)),
1456 EmptyValExpectedTy::NonPointer =>
1457 return Some(("if ", vec![
1458 (format!("{} {{ None }} else {{ Some(", s), format!("{}", var_access))
1459 ], ") }", ContainerPrefixLocation::PerConv)),
1462 syn::Type::Tuple(_) => {
1463 return Some(("if ", vec![(".is_some() { Some(".to_string(), format!("{}.take()", var_access))], ") } else { None }", ContainerPrefixLocation::PerConv))
1465 _ => unimplemented!(),
1467 } else { unreachable!(); }
1473 /// Constructs a reference to the given type, possibly tweaking the type if relevant to make it
1474 /// convertable to C.
1475 pub fn create_ownable_reference(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> Option<syn::Type> {
1476 let default_value = Some(syn::Type::Reference(syn::TypeReference {
1477 and_token: syn::Token!(&)(Span::call_site()), lifetime: None, mutability: None,
1478 elem: Box::new(t.clone()) }));
1479 match generics.resolve_type(t) {
1480 syn::Type::Path(p) => {
1481 if let Some(resolved_path) = self.maybe_resolve_path(&p.path, generics) {
1482 if resolved_path != "Vec" { return default_value; }
1483 if p.path.segments.len() != 1 { unimplemented!(); }
1484 let only_seg = p.path.segments.iter().next().unwrap();
1485 if let syn::PathArguments::AngleBracketed(args) = &only_seg.arguments {
1486 if args.args.len() != 1 { unimplemented!(); }
1487 let inner_arg = args.args.iter().next().unwrap();
1488 if let syn::GenericArgument::Type(ty) = &inner_arg {
1489 let mut can_create = self.c_type_has_inner(&ty);
1490 if let syn::Type::Path(inner) = ty {
1491 if inner.path.segments.len() == 1 &&
1492 format!("{}", inner.path.segments[0].ident) == "Vec" {
1496 if !can_create { return default_value; }
1497 if let Some(inner_ty) = self.create_ownable_reference(&ty, generics) {
1498 return Some(syn::Type::Reference(syn::TypeReference {
1499 and_token: syn::Token![&](Span::call_site()),
1502 elem: Box::new(syn::Type::Slice(syn::TypeSlice {
1503 bracket_token: syn::token::Bracket { span: Span::call_site() },
1504 elem: Box::new(inner_ty)
1507 } else { return default_value; }
1508 } else { unimplemented!(); }
1509 } else { unimplemented!(); }
1510 } else { return None; }
1516 // *************************************************
1517 // *** Type definition during main.rs processing ***
1518 // *************************************************
1520 pub fn get_declared_type(&'a self, ident: &syn::Ident) -> Option<&'a DeclType<'c>> {
1521 self.types.get_declared_type(ident)
1523 /// Returns true if the object at the given path is mapped as X { inner: *mut origX, .. }.
1524 pub fn c_type_has_inner_from_path(&self, full_path: &str) -> bool {
1525 self.crate_types.opaques.get(full_path).is_some()
1528 /// Returns true if the object at the given path is mapped as X { inner: *mut origX, .. }.
1529 pub fn c_type_has_inner(&self, ty: &syn::Type) -> bool {
1531 syn::Type::Path(p) => {
1532 if let Some(full_path) = self.maybe_resolve_path(&p.path, None) {
1533 self.c_type_has_inner_from_path(&full_path)
1536 syn::Type::Reference(r) => {
1537 self.c_type_has_inner(&*r.elem)
1543 pub fn maybe_resolve_ident(&self, id: &syn::Ident) -> Option<String> {
1544 self.types.maybe_resolve_ident(id)
1547 pub fn maybe_resolve_non_ignored_ident(&self, id: &syn::Ident) -> Option<String> {
1548 self.types.maybe_resolve_non_ignored_ident(id)
1551 pub fn maybe_resolve_path(&self, p_arg: &syn::Path, generics: Option<&GenericTypes>) -> Option<String> {
1552 self.types.maybe_resolve_path(p_arg, generics)
1554 pub fn resolve_path(&self, p: &syn::Path, generics: Option<&GenericTypes>) -> String {
1555 self.maybe_resolve_path(p, generics).unwrap()
1558 // ***********************************
1559 // *** Original Rust Type Printing ***
1560 // ***********************************
1562 fn in_rust_prelude(resolved_path: &str) -> bool {
1563 match resolved_path {
1571 fn write_rust_path<W: std::io::Write>(&self, w: &mut W, generics_resolver: Option<&GenericTypes>, path: &syn::Path) {
1572 if let Some(resolved) = self.maybe_resolve_path(&path, generics_resolver) {
1573 if self.is_primitive(&resolved) {
1574 write!(w, "{}", path.get_ident().unwrap()).unwrap();
1576 // TODO: We should have a generic "is from a dependency" check here instead of
1577 // checking for "bitcoin" explicitly.
1578 if resolved.starts_with("bitcoin::") || Self::in_rust_prelude(&resolved) {
1579 write!(w, "{}", resolved).unwrap();
1580 // If we're printing a generic argument, it needs to reference the crate, otherwise
1581 // the original crate:
1582 } else if self.maybe_resolve_path(&path, None).as_ref() == Some(&resolved) {
1583 write!(w, "{}", self.real_rust_type_mapping(&resolved)).unwrap();
1585 write!(w, "crate::{}", resolved).unwrap();
1588 if let syn::PathArguments::AngleBracketed(args) = &path.segments.iter().last().unwrap().arguments {
1589 self.write_rust_generic_arg(w, generics_resolver, args.args.iter());
1592 if path.leading_colon.is_some() {
1593 write!(w, "::").unwrap();
1595 for (idx, seg) in path.segments.iter().enumerate() {
1596 if idx != 0 { write!(w, "::").unwrap(); }
1597 write!(w, "{}", seg.ident).unwrap();
1598 if let syn::PathArguments::AngleBracketed(args) = &seg.arguments {
1599 self.write_rust_generic_arg(w, generics_resolver, args.args.iter());
1604 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>) {
1605 let mut had_params = false;
1606 for (idx, arg) in generics.enumerate() {
1607 if idx != 0 { write!(w, ", ").unwrap(); } else { write!(w, "<").unwrap(); }
1610 syn::GenericParam::Lifetime(lt) => write!(w, "'{}", lt.lifetime.ident).unwrap(),
1611 syn::GenericParam::Type(t) => {
1612 write!(w, "{}", t.ident).unwrap();
1613 if t.colon_token.is_some() { write!(w, ":").unwrap(); }
1614 for (idx, bound) in t.bounds.iter().enumerate() {
1615 if idx != 0 { write!(w, " + ").unwrap(); }
1617 syn::TypeParamBound::Trait(tb) => {
1618 if tb.paren_token.is_some() || tb.lifetimes.is_some() { unimplemented!(); }
1619 self.write_rust_path(w, generics_resolver, &tb.path);
1621 _ => unimplemented!(),
1624 if t.eq_token.is_some() || t.default.is_some() { unimplemented!(); }
1626 _ => unimplemented!(),
1629 if had_params { write!(w, ">").unwrap(); }
1632 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>) {
1633 write!(w, "<").unwrap();
1634 for (idx, arg) in generics.enumerate() {
1635 if idx != 0 { write!(w, ", ").unwrap(); }
1637 syn::GenericArgument::Type(t) => self.write_rust_type(w, generics_resolver, t),
1638 _ => unimplemented!(),
1641 write!(w, ">").unwrap();
1643 pub fn write_rust_type<W: std::io::Write>(&self, w: &mut W, generics: Option<&GenericTypes>, t: &syn::Type) {
1645 syn::Type::Path(p) => {
1646 if p.qself.is_some() {
1649 self.write_rust_path(w, generics, &p.path);
1651 syn::Type::Reference(r) => {
1652 write!(w, "&").unwrap();
1653 if let Some(lft) = &r.lifetime {
1654 write!(w, "'{} ", lft.ident).unwrap();
1656 if r.mutability.is_some() {
1657 write!(w, "mut ").unwrap();
1659 self.write_rust_type(w, generics, &*r.elem);
1661 syn::Type::Array(a) => {
1662 write!(w, "[").unwrap();
1663 self.write_rust_type(w, generics, &a.elem);
1664 if let syn::Expr::Lit(l) = &a.len {
1665 if let syn::Lit::Int(i) = &l.lit {
1666 write!(w, "; {}]", i).unwrap();
1667 } else { unimplemented!(); }
1668 } else { unimplemented!(); }
1670 syn::Type::Slice(s) => {
1671 write!(w, "[").unwrap();
1672 self.write_rust_type(w, generics, &s.elem);
1673 write!(w, "]").unwrap();
1675 syn::Type::Tuple(s) => {
1676 write!(w, "(").unwrap();
1677 for (idx, t) in s.elems.iter().enumerate() {
1678 if idx != 0 { write!(w, ", ").unwrap(); }
1679 self.write_rust_type(w, generics, &t);
1681 write!(w, ")").unwrap();
1683 _ => unimplemented!(),
1687 /// Prints a constructor for something which is "uninitialized" (but obviously not actually
1688 /// unint'd memory).
1689 pub fn write_empty_rust_val<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type) {
1691 syn::Type::Reference(r) => {
1692 self.write_empty_rust_val(generics, w, &*r.elem)
1694 syn::Type::Path(p) => {
1695 let resolved = self.resolve_path(&p.path, generics);
1696 if self.crate_types.opaques.get(&resolved).is_some() {
1697 write!(w, "crate::{} {{ inner: std::ptr::null_mut(), is_owned: true }}", resolved).unwrap();
1699 // Assume its a manually-mapped C type, where we can just define an null() fn
1700 write!(w, "{}::null()", self.c_type_from_path(&resolved, false, false).unwrap()).unwrap();
1703 syn::Type::Array(a) => {
1704 if let syn::Expr::Lit(l) = &a.len {
1705 if let syn::Lit::Int(i) = &l.lit {
1706 if i.base10_digits().parse::<usize>().unwrap() < 32 {
1707 // Blindly assume that if we're trying to create an empty value for an
1708 // array < 32 entries that all-0s may be a valid state.
1711 let arrty = format!("[u8; {}]", i.base10_digits());
1712 write!(w, "{}", self.to_c_conversion_inline_prefix_from_path(&arrty, false, false).unwrap()).unwrap();
1713 write!(w, "[0; {}]", i.base10_digits()).unwrap();
1714 write!(w, "{}", self.to_c_conversion_inline_suffix_from_path(&arrty, false, false).unwrap()).unwrap();
1715 } else { unimplemented!(); }
1716 } else { unimplemented!(); }
1718 _ => unimplemented!(),
1722 fn is_real_type_array(&self, resolved_type: &str) -> Option<syn::Type> {
1723 if let Some(real_ty) = self.c_type_from_path(&resolved_type, true, false) {
1724 if real_ty.ends_with("]") && real_ty.starts_with("*const [u8; ") {
1725 let mut split = real_ty.split("; ");
1726 split.next().unwrap();
1727 let tail_str = split.next().unwrap();
1728 assert!(split.next().is_none());
1729 let len = usize::from_str_radix(&tail_str[..tail_str.len() - 1], 10).unwrap();
1730 Some(parse_quote!([u8; #len]))
1735 /// Prints a suffix to determine if a variable is empty (ie was set by write_empty_rust_val).
1736 /// See EmptyValExpectedTy for information on return types.
1737 fn write_empty_rust_val_check_suffix<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type) -> EmptyValExpectedTy {
1739 syn::Type::Reference(r) => {
1740 return self.write_empty_rust_val_check_suffix(generics, w, &*r.elem);
1742 syn::Type::Path(p) => {
1743 let resolved = self.resolve_path(&p.path, generics);
1744 if let Some(arr_ty) = self.is_real_type_array(&resolved) {
1745 write!(w, ".data").unwrap();
1746 return self.write_empty_rust_val_check_suffix(generics, w, &arr_ty);
1748 if self.crate_types.opaques.get(&resolved).is_some() {
1749 write!(w, ".inner.is_null()").unwrap();
1750 EmptyValExpectedTy::NonPointer
1752 if let Some(suffix) = self.empty_val_check_suffix_from_path(&resolved) {
1753 write!(w, "{}", suffix).unwrap();
1754 // We may eventually need to allow empty_val_check_suffix_from_path to specify if we need a deref or not
1755 EmptyValExpectedTy::NonPointer
1757 write!(w, ".is_none()").unwrap();
1758 EmptyValExpectedTy::OptionType
1762 syn::Type::Array(a) => {
1763 if let syn::Expr::Lit(l) = &a.len {
1764 if let syn::Lit::Int(i) = &l.lit {
1765 write!(w, " == [0; {}]", i.base10_digits()).unwrap();
1766 EmptyValExpectedTy::NonPointer
1767 } else { unimplemented!(); }
1768 } else { unimplemented!(); }
1770 syn::Type::Slice(_) => {
1771 // Option<[]> always implies that we want to treat len() == 0 differently from
1772 // None, so we always map an Option<[]> into a pointer.
1773 write!(w, " == std::ptr::null_mut()").unwrap();
1774 EmptyValExpectedTy::ReferenceAsPointer
1776 _ => unimplemented!(),
1780 /// Prints a suffix to determine if a variable is empty (ie was set by write_empty_rust_val).
1781 pub fn write_empty_rust_val_check<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type, var_access: &str) {
1783 syn::Type::Reference(r) => {
1784 self.write_empty_rust_val_check(generics, w, &*r.elem, var_access);
1786 syn::Type::Path(_) => {
1787 write!(w, "{}", var_access).unwrap();
1788 self.write_empty_rust_val_check_suffix(generics, w, t);
1790 syn::Type::Array(a) => {
1791 if let syn::Expr::Lit(l) = &a.len {
1792 if let syn::Lit::Int(i) = &l.lit {
1793 let arrty = format!("[u8; {}]", i.base10_digits());
1794 // We don't (yet) support a new-var conversion here.
1795 assert!(self.from_c_conversion_new_var_from_path(&arrty, false).is_none());
1797 self.from_c_conversion_prefix_from_path(&arrty, false).unwrap(),
1799 self.from_c_conversion_suffix_from_path(&arrty, false).unwrap()).unwrap();
1800 self.write_empty_rust_val_check_suffix(generics, w, t);
1801 } else { unimplemented!(); }
1802 } else { unimplemented!(); }
1804 _ => unimplemented!(),
1808 // ********************************
1809 // *** Type conversion printing ***
1810 // ********************************
1812 /// Returns true we if can just skip passing this to C entirely
1813 pub fn skip_arg(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> bool {
1815 syn::Type::Path(p) => {
1816 if p.qself.is_some() { unimplemented!(); }
1817 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
1818 self.skip_path(&full_path)
1821 syn::Type::Reference(r) => {
1822 self.skip_arg(&*r.elem, generics)
1827 pub fn no_arg_to_rust<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
1829 syn::Type::Path(p) => {
1830 if p.qself.is_some() { unimplemented!(); }
1831 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
1832 write!(w, "{}", self.no_arg_path_to_rust(&full_path)).unwrap();
1835 syn::Type::Reference(r) => {
1836 self.no_arg_to_rust(w, &*r.elem, generics);
1842 fn write_conversion_inline_intern<W: std::io::Write,
1843 LP: Fn(&str, bool, bool) -> Option<String>, DL: Fn(&mut W, &DeclType, &str, bool, bool), SC: Fn(bool, Option<&str>) -> String>
1844 (&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, is_ref: bool, is_mut: bool, ptr_for_ref: bool,
1845 tupleconv: &str, prefix: bool, sliceconv: SC, path_lookup: LP, decl_lookup: DL) {
1846 match generics.resolve_type(t) {
1847 syn::Type::Reference(r) => {
1848 self.write_conversion_inline_intern(w, &*r.elem, generics, true, r.mutability.is_some(),
1849 ptr_for_ref, tupleconv, prefix, sliceconv, path_lookup, decl_lookup);
1851 syn::Type::Path(p) => {
1852 if p.qself.is_some() {
1856 let resolved_path = self.resolve_path(&p.path, generics);
1857 if let Some(aliased_type) = self.crate_types.type_aliases.get(&resolved_path) {
1858 return self.write_conversion_inline_intern(w, aliased_type, None, is_ref, is_mut, ptr_for_ref, tupleconv, prefix, sliceconv, path_lookup, decl_lookup);
1859 } else if self.is_primitive(&resolved_path) {
1860 if is_ref && prefix {
1861 write!(w, "*").unwrap();
1863 } else if let Some(c_type) = path_lookup(&resolved_path, is_ref, ptr_for_ref) {
1864 write!(w, "{}", c_type).unwrap();
1865 } else if let Some((_, generics)) = self.crate_types.opaques.get(&resolved_path) {
1866 decl_lookup(w, &DeclType::StructImported { generic_param_count: generics.params.len() }, &resolved_path, is_ref, is_mut);
1867 } else if self.crate_types.mirrored_enums.get(&resolved_path).is_some() {
1868 decl_lookup(w, &DeclType::MirroredEnum, &resolved_path, is_ref, is_mut);
1869 } else if let Some(t) = self.crate_types.traits.get(&resolved_path) {
1870 decl_lookup(w, &DeclType::Trait(t), &resolved_path, is_ref, is_mut);
1871 } else if let Some(ident) = single_ident_generic_path_to_ident(&p.path) {
1872 if let Some(decl_type) = self.types.maybe_resolve_declared(ident) {
1873 decl_lookup(w, decl_type, &self.maybe_resolve_ident(ident).unwrap(), is_ref, is_mut);
1874 } else { unimplemented!(); }
1875 } else { unimplemented!(); }
1877 syn::Type::Array(a) => {
1878 // We assume all arrays contain only [int_literal; X]s.
1879 // This may result in some outputs not compiling.
1880 if let syn::Expr::Lit(l) = &a.len {
1881 if let syn::Lit::Int(i) = &l.lit {
1882 write!(w, "{}", path_lookup(&format!("[u8; {}]", i.base10_digits()), is_ref, ptr_for_ref).unwrap()).unwrap();
1883 } else { unimplemented!(); }
1884 } else { unimplemented!(); }
1886 syn::Type::Slice(s) => {
1887 // We assume all slices contain only literals or references.
1888 // This may result in some outputs not compiling.
1889 if let syn::Type::Path(p) = &*s.elem {
1890 let resolved = self.resolve_path(&p.path, generics);
1891 assert!(self.is_primitive(&resolved));
1892 write!(w, "{}", path_lookup("[u8]", is_ref, ptr_for_ref).unwrap()).unwrap();
1893 } else if let syn::Type::Reference(r) = &*s.elem {
1894 if let syn::Type::Path(p) = &*r.elem {
1895 write!(w, "{}", sliceconv(self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)), None)).unwrap();
1896 } else if let syn::Type::Slice(_) = &*r.elem {
1897 write!(w, "{}", sliceconv(false, None)).unwrap();
1898 } else { unimplemented!(); }
1899 } else if let syn::Type::Tuple(t) = &*s.elem {
1900 assert!(!t.elems.is_empty());
1902 write!(w, "{}", sliceconv(false, None)).unwrap();
1904 let mut needs_map = false;
1905 for e in t.elems.iter() {
1906 if let syn::Type::Reference(_) = e {
1911 let mut map_str = Vec::new();
1912 write!(&mut map_str, ".map(|(").unwrap();
1913 for i in 0..t.elems.len() {
1914 write!(&mut map_str, "{}{}", if i != 0 { ", " } else { "" }, ('a' as u8 + i as u8) as char).unwrap();
1916 write!(&mut map_str, ")| (").unwrap();
1917 for (idx, e) in t.elems.iter().enumerate() {
1918 if let syn::Type::Reference(_) = e {
1919 write!(&mut map_str, "{}{}", if idx != 0 { ", " } else { "" }, (idx as u8 + 'a' as u8) as char).unwrap();
1920 } else if let syn::Type::Path(_) = e {
1921 write!(&mut map_str, "{}*{}", if idx != 0 { ", " } else { "" }, (idx as u8 + 'a' as u8) as char).unwrap();
1922 } else { unimplemented!(); }
1924 write!(&mut map_str, "))").unwrap();
1925 write!(w, "{}", sliceconv(false, Some(&String::from_utf8(map_str).unwrap()))).unwrap();
1927 write!(w, "{}", sliceconv(false, None)).unwrap();
1930 } else { unimplemented!(); }
1932 syn::Type::Tuple(t) => {
1933 if t.elems.is_empty() {
1934 // cbindgen has poor support for (), see, eg https://github.com/eqrion/cbindgen/issues/527
1935 // so work around it by just pretending its a 0u8
1936 write!(w, "{}", tupleconv).unwrap();
1938 if prefix { write!(w, "local_").unwrap(); }
1941 _ => unimplemented!(),
1945 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) {
1946 self.write_conversion_inline_intern(w, t, generics, is_ref, false, ptr_for_ref, "() /*", true, |_, _| "local_".to_owned(),
1947 |a, b, c| self.to_c_conversion_inline_prefix_from_path(a, b, c),
1948 |w, decl_type, decl_path, is_ref, _is_mut| {
1950 DeclType::MirroredEnum if is_ref && ptr_for_ref => write!(w, "crate::{}::from_native(", decl_path).unwrap(),
1951 DeclType::MirroredEnum if is_ref => write!(w, "&crate::{}::from_native(", decl_path).unwrap(),
1952 DeclType::MirroredEnum => write!(w, "crate::{}::native_into(", decl_path).unwrap(),
1953 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if is_ref && from_ptr => {
1954 if !ptr_for_ref { write!(w, "&").unwrap(); }
1955 write!(w, "crate::{} {{ inner: unsafe {{ (", decl_path).unwrap()
1957 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if is_ref => {
1958 if !ptr_for_ref { write!(w, "&").unwrap(); }
1959 write!(w, "crate::{} {{ inner: unsafe {{ ObjOps::nonnull_ptr_to_inner((", decl_path).unwrap()
1961 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref && from_ptr =>
1962 write!(w, "crate::{} {{ inner: ", decl_path).unwrap(),
1963 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref =>
1964 write!(w, "crate::{} {{ inner: ObjOps::heap_alloc(", decl_path).unwrap(),
1965 DeclType::Trait(_) if is_ref => write!(w, "").unwrap(),
1966 DeclType::Trait(_) if !is_ref => write!(w, "Into::into(").unwrap(),
1967 _ => panic!("{:?}", decl_path),
1971 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) {
1972 self.write_to_c_conversion_inline_prefix_inner(w, t, generics, false, ptr_for_ref, false);
1974 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) {
1975 self.write_conversion_inline_intern(w, t, generics, is_ref, false, ptr_for_ref, "*/", false, |_, _| ".into()".to_owned(),
1976 |a, b, c| self.to_c_conversion_inline_suffix_from_path(a, b, c),
1977 |w, decl_type, full_path, is_ref, _is_mut| match decl_type {
1978 DeclType::MirroredEnum => write!(w, ")").unwrap(),
1979 DeclType::EnumIgnored { generic_param_count }|DeclType::StructImported { generic_param_count } if is_ref => {
1980 write!(w, " as *const {}<", full_path).unwrap();
1981 for _ in 0..*generic_param_count { write!(w, "_, ").unwrap(); }
1983 write!(w, ">) as *mut _ }}, is_owned: false }}").unwrap();
1985 write!(w, ">) as *mut _) }}, is_owned: false }}").unwrap();
1988 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref && from_ptr =>
1989 write!(w, ", is_owned: true }}").unwrap(),
1990 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref => write!(w, "), is_owned: true }}").unwrap(),
1991 DeclType::Trait(_) if is_ref => {},
1992 DeclType::Trait(_) => {
1993 // This is used when we're converting a concrete Rust type into a C trait
1994 // for use when a Rust trait method returns an associated type.
1995 // Because all of our C traits implement From<RustTypesImplementingTraits>
1996 // we can just call .into() here and be done.
1997 write!(w, ")").unwrap()
1999 _ => unimplemented!(),
2002 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) {
2003 self.write_to_c_conversion_inline_suffix_inner(w, t, generics, false, ptr_for_ref, false);
2006 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) {
2007 self.write_conversion_inline_intern(w, t, generics, is_ref, false, false, "() /*", true, |_, _| "&local_".to_owned(),
2008 |a, b, _c| self.from_c_conversion_prefix_from_path(a, b),
2009 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
2010 DeclType::StructImported {..} if is_ref => write!(w, "").unwrap(),
2011 DeclType::StructImported {..} if !is_ref => write!(w, "*unsafe {{ Box::from_raw(").unwrap(),
2012 DeclType::MirroredEnum if is_ref => write!(w, "&").unwrap(),
2013 DeclType::MirroredEnum => {},
2014 DeclType::Trait(_) => {},
2015 _ => unimplemented!(),
2018 pub fn write_from_c_conversion_prefix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2019 self.write_from_c_conversion_prefix_inner(w, t, generics, false, false);
2021 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) {
2022 self.write_conversion_inline_intern(w, t, generics, is_ref, false, false, "*/", false,
2023 |has_inner, map_str_opt| match (has_inner, map_str_opt) {
2024 (false, Some(map_str)) => format!(".iter(){}.collect::<Vec<_>>()[..]", map_str),
2025 (false, None) => ".iter().collect::<Vec<_>>()[..]".to_owned(),
2026 (true, None) => "[..]".to_owned(),
2027 (true, Some(_)) => unreachable!(),
2029 |a, b, _c| self.from_c_conversion_suffix_from_path(a, b),
2030 |w, decl_type, _full_path, is_ref, is_mut| match decl_type {
2031 DeclType::StructImported {..} if is_ref && ptr_for_ref => write!(w, "XXX unimplemented").unwrap(),
2032 DeclType::StructImported {..} if is_mut && is_ref => write!(w, ".get_native_mut_ref()").unwrap(),
2033 DeclType::StructImported {..} if is_ref => write!(w, ".get_native_ref()").unwrap(),
2034 DeclType::StructImported {..} if !is_ref => write!(w, ".take_inner()) }}").unwrap(),
2035 DeclType::MirroredEnum if is_ref => write!(w, ".to_native()").unwrap(),
2036 DeclType::MirroredEnum => write!(w, ".into_native()").unwrap(),
2037 DeclType::Trait(_) => {},
2038 _ => unimplemented!(),
2041 pub fn write_from_c_conversion_suffix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2042 self.write_from_c_conversion_suffix_inner(w, t, generics, false, false);
2044 // Note that compared to the above conversion functions, the following two are generally
2045 // significantly undertested:
2046 pub fn write_from_c_conversion_to_ref_prefix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2047 self.write_conversion_inline_intern(w, t, generics, false, false, false, "() /*", true, |_, _| "&local_".to_owned(),
2049 if let Some(conv) = self.from_c_conversion_prefix_from_path(a, b) {
2050 Some(format!("&{}", conv))
2053 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
2054 DeclType::StructImported {..} if !is_ref => write!(w, "").unwrap(),
2055 _ => unimplemented!(),
2058 pub fn write_from_c_conversion_to_ref_suffix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2059 self.write_conversion_inline_intern(w, t, generics, false, false, false, "*/", false,
2060 |has_inner, map_str_opt| match (has_inner, map_str_opt) {
2061 (false, Some(map_str)) => format!(".iter(){}.collect::<Vec<_>>()[..]", map_str),
2062 (false, None) => ".iter().collect::<Vec<_>>()[..]".to_owned(),
2063 (true, None) => "[..]".to_owned(),
2064 (true, Some(_)) => unreachable!(),
2066 |a, b, _c| self.from_c_conversion_suffix_from_path(a, b),
2067 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
2068 DeclType::StructImported {..} if !is_ref => write!(w, ".get_native_ref()").unwrap(),
2069 _ => unimplemented!(),
2073 fn write_conversion_new_var_intern<'b, W: std::io::Write,
2074 LP: Fn(&str, bool) -> Option<(&str, &str)>,
2075 LC: Fn(&str, bool, Option<&syn::Type>, &syn::Ident, &str) -> Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)>,
2076 VP: Fn(&mut W, &syn::Type, Option<&GenericTypes>, bool, bool, bool),
2077 VS: Fn(&mut W, &syn::Type, Option<&GenericTypes>, bool, bool, bool)>
2078 (&self, w: &mut W, ident: &syn::Ident, var: &str, t: &syn::Type, generics: Option<&GenericTypes>,
2079 mut is_ref: bool, mut ptr_for_ref: bool, to_c: bool, from_ownable_ref: bool,
2080 path_lookup: &LP, container_lookup: &LC, var_prefix: &VP, var_suffix: &VS) -> bool {
2082 macro_rules! convert_container {
2083 ($container_type: expr, $args_len: expr, $args_iter: expr) => { {
2084 // For slices (and Options), we refuse to directly map them as is_ref when they
2085 // aren't opaque types containing an inner pointer. This is due to the fact that,
2086 // in both cases, the actual higher-level type is non-is_ref.
2087 let ty_has_inner = if $args_len == 1 {
2088 let ty = $args_iter().next().unwrap();
2089 if $container_type == "Slice" && to_c {
2090 // "To C ptr_for_ref" means "return the regular object with is_owned
2091 // set to false", which is totally what we want in a slice if we're about to
2092 // set ty_has_inner.
2095 if let syn::Type::Reference(t) = ty {
2096 if let syn::Type::Path(p) = &*t.elem {
2097 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
2099 } else if let syn::Type::Path(p) = ty {
2100 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
2104 // Options get a bunch of special handling, since in general we map Option<>al
2105 // types into the same C type as non-Option-wrapped types. This ends up being
2106 // pretty manual here and most of the below special-cases are for Options.
2107 let mut needs_ref_map = false;
2108 let mut only_contained_type = None;
2109 let mut only_contained_type_nonref = None;
2110 let mut only_contained_has_inner = false;
2111 let mut contains_slice = false;
2113 only_contained_has_inner = ty_has_inner;
2114 let arg = $args_iter().next().unwrap();
2115 if let syn::Type::Reference(t) = arg {
2116 only_contained_type = Some(arg);
2117 only_contained_type_nonref = Some(&*t.elem);
2118 if let syn::Type::Path(_) = &*t.elem {
2120 } else if let syn::Type::Slice(_) = &*t.elem {
2121 contains_slice = true;
2122 } else { return false; }
2123 // If the inner element contains an inner pointer, we will just use that,
2124 // avoiding the need to map elements to references. Otherwise we'll need to
2125 // do an extra mapping step.
2126 needs_ref_map = !only_contained_has_inner && $container_type == "Option";
2128 only_contained_type = Some(arg);
2129 only_contained_type_nonref = Some(arg);
2133 if let Some((prefix, conversions, suffix, prefix_location)) = container_lookup(&$container_type, is_ref && ty_has_inner, only_contained_type, ident, var) {
2134 assert_eq!(conversions.len(), $args_len);
2135 write!(w, "let mut local_{}{} = ", ident,
2136 if (!to_c && needs_ref_map) || (to_c && $container_type == "Option" && contains_slice) {"_base"} else { "" }).unwrap();
2137 if prefix_location == ContainerPrefixLocation::OutsideConv {
2138 var_prefix(w, $args_iter().next().unwrap(), generics, is_ref, ptr_for_ref, true);
2140 write!(w, "{}{}", prefix, var).unwrap();
2142 for ((pfx, var_name), (idx, ty)) in conversions.iter().zip($args_iter().enumerate()) {
2143 let mut var = std::io::Cursor::new(Vec::new());
2144 write!(&mut var, "{}", var_name).unwrap();
2145 let var_access = String::from_utf8(var.into_inner()).unwrap();
2147 let conv_ty = if needs_ref_map { only_contained_type_nonref.as_ref().unwrap() } else { ty };
2149 write!(w, "{} {{ ", pfx).unwrap();
2150 let new_var_name = format!("{}_{}", ident, idx);
2151 let new_var = self.write_conversion_new_var_intern(w, &format_ident!("{}", new_var_name),
2152 &var_access, conv_ty, generics, contains_slice || (is_ref && ty_has_inner), ptr_for_ref,
2153 to_c, from_ownable_ref, path_lookup, container_lookup, var_prefix, var_suffix);
2154 if new_var { write!(w, " ").unwrap(); }
2156 if prefix_location == ContainerPrefixLocation::PerConv {
2157 var_prefix(w, conv_ty, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2158 } else if !is_ref && !needs_ref_map && to_c && only_contained_has_inner {
2159 write!(w, "ObjOps::heap_alloc(").unwrap();
2162 write!(w, "{}{}", if contains_slice && !to_c { "local_" } else { "" }, if new_var { new_var_name } else { var_access }).unwrap();
2163 if prefix_location == ContainerPrefixLocation::PerConv {
2164 var_suffix(w, conv_ty, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2165 } else if !is_ref && !needs_ref_map && to_c && only_contained_has_inner {
2166 write!(w, ")").unwrap();
2168 write!(w, " }}").unwrap();
2170 write!(w, "{}", suffix).unwrap();
2171 if prefix_location == ContainerPrefixLocation::OutsideConv {
2172 var_suffix(w, $args_iter().next().unwrap(), generics, is_ref, ptr_for_ref, true);
2174 write!(w, ";").unwrap();
2175 if !to_c && needs_ref_map {
2176 write!(w, " let mut local_{} = local_{}_base.as_ref()", ident, ident).unwrap();
2178 write!(w, ".map(|a| &a[..])").unwrap();
2180 write!(w, ";").unwrap();
2181 } else if to_c && $container_type == "Option" && contains_slice {
2182 write!(w, " let mut local_{} = *local_{}_base;", ident, ident).unwrap();
2189 match generics.resolve_type(t) {
2190 syn::Type::Reference(r) => {
2191 if let syn::Type::Slice(_) = &*r.elem {
2192 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)
2194 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)
2197 syn::Type::Path(p) => {
2198 if p.qself.is_some() {
2201 let resolved_path = self.resolve_path(&p.path, generics);
2202 if let Some(aliased_type) = self.crate_types.type_aliases.get(&resolved_path) {
2203 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);
2205 if self.is_known_container(&resolved_path, is_ref) || self.is_path_transparent_container(&p.path, generics, is_ref) {
2206 if let syn::PathArguments::AngleBracketed(args) = &p.path.segments.iter().next().unwrap().arguments {
2207 convert_container!(resolved_path, args.args.len(), || args.args.iter().map(|arg| {
2208 if let syn::GenericArgument::Type(ty) = arg {
2209 generics.resolve_type(ty)
2210 } else { unimplemented!(); }
2212 } else { unimplemented!(); }
2214 if self.is_primitive(&resolved_path) {
2216 } else if let Some(ty_ident) = single_ident_generic_path_to_ident(&p.path) {
2217 if let Some((prefix, suffix)) = path_lookup(&resolved_path, is_ref) {
2218 write!(w, "let mut local_{} = {}{}{};", ident, prefix, var, suffix).unwrap();
2220 } else if self.types.maybe_resolve_declared(ty_ident).is_some() {
2225 syn::Type::Array(_) => {
2226 // We assume all arrays contain only primitive types.
2227 // This may result in some outputs not compiling.
2230 syn::Type::Slice(s) => {
2231 if let syn::Type::Path(p) = &*s.elem {
2232 let resolved = self.resolve_path(&p.path, generics);
2233 assert!(self.is_primitive(&resolved));
2234 let slice_path = format!("[{}]", resolved);
2235 if let Some((prefix, suffix)) = path_lookup(&slice_path, true) {
2236 write!(w, "let mut local_{} = {}{}{};", ident, prefix, var, suffix).unwrap();
2239 } else if let syn::Type::Reference(ty) = &*s.elem {
2240 let tyref = if from_ownable_ref || !to_c { [&*ty.elem] } else { [&*s.elem] };
2242 convert_container!("Slice", 1, || tyref.iter().map(|t| generics.resolve_type(*t)));
2243 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2244 } else if let syn::Type::Tuple(t) = &*s.elem {
2245 // When mapping into a temporary new var, we need to own all the underlying objects.
2246 // Thus, we drop any references inside the tuple and convert with non-reference types.
2247 let mut elems = syn::punctuated::Punctuated::new();
2248 for elem in t.elems.iter() {
2249 if let syn::Type::Reference(r) = elem {
2250 elems.push((*r.elem).clone());
2252 elems.push(elem.clone());
2255 let ty = [syn::Type::Tuple(syn::TypeTuple {
2256 paren_token: t.paren_token, elems
2260 convert_container!("Slice", 1, || ty.iter());
2261 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2262 } else { unimplemented!() }
2264 syn::Type::Tuple(t) => {
2265 if !t.elems.is_empty() {
2266 // We don't (yet) support tuple elements which cannot be converted inline
2267 write!(w, "let (").unwrap();
2268 for idx in 0..t.elems.len() {
2269 if idx != 0 { write!(w, ", ").unwrap(); }
2270 write!(w, "{} orig_{}_{}", if is_ref { "ref" } else { "mut" }, ident, idx).unwrap();
2272 write!(w, ") = {}{}; ", var, if !to_c { ".to_rust()" } else { "" }).unwrap();
2273 // Like other template types, tuples are always mapped as their non-ref
2274 // versions for types which have different ref mappings. Thus, we convert to
2275 // non-ref versions and handle opaque types with inner pointers manually.
2276 for (idx, elem) in t.elems.iter().enumerate() {
2277 if let syn::Type::Path(p) = elem {
2278 let v_name = format!("orig_{}_{}", ident, idx);
2279 let tuple_elem_ident = format_ident!("{}", &v_name);
2280 if self.write_conversion_new_var_intern(w, &tuple_elem_ident, &v_name, elem, generics,
2281 false, ptr_for_ref, to_c, from_ownable_ref,
2282 path_lookup, container_lookup, var_prefix, var_suffix) {
2283 write!(w, " ").unwrap();
2284 // Opaque types with inner pointers shouldn't ever create new stack
2285 // variables, so we don't handle it and just assert that it doesn't
2287 assert!(!self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)));
2291 write!(w, "let mut local_{} = (", ident).unwrap();
2292 for (idx, elem) in t.elems.iter().enumerate() {
2293 let ty_has_inner = {
2295 // "To C ptr_for_ref" means "return the regular object with
2296 // is_owned set to false", which is totally what we want
2297 // if we're about to set ty_has_inner.
2300 if let syn::Type::Reference(t) = elem {
2301 if let syn::Type::Path(p) = &*t.elem {
2302 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
2304 } else if let syn::Type::Path(p) = elem {
2305 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
2308 if idx != 0 { write!(w, ", ").unwrap(); }
2309 var_prefix(w, elem, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2310 if is_ref && ty_has_inner {
2311 // For ty_has_inner, the regular var_prefix mapping will take a
2312 // reference, so deref once here to make sure we keep the original ref.
2313 write!(w, "*").unwrap();
2315 write!(w, "orig_{}_{}", ident, idx).unwrap();
2316 if is_ref && !ty_has_inner {
2317 // If we don't have an inner variable's reference to maintain, just
2318 // hope the type is Clonable and use that.
2319 write!(w, ".clone()").unwrap();
2321 var_suffix(w, elem, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2323 write!(w, "){};", if to_c { ".into()" } else { "" }).unwrap();
2327 _ => unimplemented!(),
2331 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 {
2332 self.write_conversion_new_var_intern(w, ident, var_access, t, generics, false, ptr_for_ref, true, from_ownable_ref,
2333 &|a, b| self.to_c_conversion_new_var_from_path(a, b),
2334 &|a, b, c, d, e| self.to_c_conversion_container_new_var(generics, a, b, c, d, e),
2335 // We force ptr_for_ref here since we can't generate a ref on one line and use it later
2336 &|a, b, c, d, e, f| self.write_to_c_conversion_inline_prefix_inner(a, b, c, d, e, f),
2337 &|a, b, c, d, e, f| self.write_to_c_conversion_inline_suffix_inner(a, b, c, d, e, f))
2339 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 {
2340 self.write_to_c_conversion_new_var_inner(w, ident, &format!("{}", ident), t, generics, ptr_for_ref, false)
2342 /// Prints new-var conversion for an "ownable_ref" type, ie prints conversion for
2343 /// `create_ownable_reference(t)`, not `t` itself.
2344 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 {
2345 self.write_to_c_conversion_new_var_inner(w, ident, &format!("{}", ident), t, generics, true, true)
2347 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 {
2348 self.write_conversion_new_var_intern(w, ident, &format!("{}", ident), t, generics, false, false, false, false,
2349 &|a, b| self.from_c_conversion_new_var_from_path(a, b),
2350 &|a, b, c, d, e| self.from_c_conversion_container_new_var(generics, a, b, c, d, e),
2351 // We force ptr_for_ref here since we can't generate a ref on one line and use it later
2352 &|a, b, c, d, e, _f| self.write_from_c_conversion_prefix_inner(a, b, c, d, e),
2353 &|a, b, c, d, e, _f| self.write_from_c_conversion_suffix_inner(a, b, c, d, e))
2356 // ******************************************************
2357 // *** C Container Type Equivalent and alias Printing ***
2358 // ******************************************************
2360 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 {
2361 for (idx, t) in args.enumerate() {
2363 write!(w, ", ").unwrap();
2365 if let syn::Type::Reference(r_arg) = t {
2366 assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
2368 if !self.write_c_type_intern(w, &*r_arg.elem, generics, false, false, false, false) { return false; }
2370 // While write_c_type_intern, above is correct, we don't want to blindly convert a
2371 // reference to something stupid, so check that the container is either opaque or a
2372 // predefined type (currently only Transaction).
2373 if let syn::Type::Path(p_arg) = &*r_arg.elem {
2374 let resolved = self.resolve_path(&p_arg.path, generics);
2375 assert!(self.crate_types.opaques.get(&resolved).is_some() ||
2376 self.c_type_from_path(&resolved, true, true).is_some(), "Template generics should be opaque or have a predefined mapping");
2377 } else { unimplemented!(); }
2378 } else if let syn::Type::Path(p_arg) = t {
2379 if let Some(resolved) = self.maybe_resolve_path(&p_arg.path, generics) {
2380 if !self.is_primitive(&resolved) {
2381 assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
2384 assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
2386 if !self.write_c_type_intern(w, t, generics, false, false, false, false) { return false; }
2388 assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
2389 if !self.write_c_type_intern(w, t, generics, false, false, false, false) { return false; }
2394 fn check_create_container(&self, mangled_container: String, container_type: &str, args: Vec<&syn::Type>, generics: Option<&GenericTypes>, is_ref: bool) -> bool {
2395 if !self.crate_types.templates_defined.borrow().get(&mangled_container).is_some() {
2396 let mut created_container: Vec<u8> = Vec::new();
2398 if container_type == "Result" {
2399 let mut a_ty: Vec<u8> = Vec::new();
2400 if let syn::Type::Tuple(tup) = args.iter().next().unwrap() {
2401 if tup.elems.is_empty() {
2402 write!(&mut a_ty, "()").unwrap();
2404 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t).take(1), generics, is_ref) { return false; }
2407 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t).take(1), generics, is_ref) { return false; }
2410 let mut b_ty: Vec<u8> = Vec::new();
2411 if let syn::Type::Tuple(tup) = args.iter().skip(1).next().unwrap() {
2412 if tup.elems.is_empty() {
2413 write!(&mut b_ty, "()").unwrap();
2415 if !self.write_template_generics(&mut b_ty, &mut args.iter().map(|t| *t).skip(1), generics, is_ref) { return false; }
2418 if !self.write_template_generics(&mut b_ty, &mut args.iter().map(|t| *t).skip(1), generics, is_ref) { return false; }
2421 let ok_str = String::from_utf8(a_ty).unwrap();
2422 let err_str = String::from_utf8(b_ty).unwrap();
2423 let is_clonable = self.is_clonable(&ok_str) && self.is_clonable(&err_str);
2424 write_result_block(&mut created_container, &mangled_container, &ok_str, &err_str, is_clonable);
2426 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2428 } else if container_type == "Vec" {
2429 let mut a_ty: Vec<u8> = Vec::new();
2430 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t), generics, is_ref) { return false; }
2431 let ty = String::from_utf8(a_ty).unwrap();
2432 let is_clonable = self.is_clonable(&ty);
2433 write_vec_block(&mut created_container, &mangled_container, &ty, is_clonable);
2435 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2437 } else if container_type.ends_with("Tuple") {
2438 let mut tuple_args = Vec::new();
2439 let mut is_clonable = true;
2440 for arg in args.iter() {
2441 let mut ty: Vec<u8> = Vec::new();
2442 if !self.write_template_generics(&mut ty, &mut [arg].iter().map(|t| **t), generics, is_ref) { return false; }
2443 let ty_str = String::from_utf8(ty).unwrap();
2444 if !self.is_clonable(&ty_str) {
2445 is_clonable = false;
2447 tuple_args.push(ty_str);
2449 write_tuple_block(&mut created_container, &mangled_container, &tuple_args, is_clonable);
2451 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2453 } else if container_type == "Option" {
2454 let mut a_ty: Vec<u8> = Vec::new();
2455 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t), generics, is_ref) { return false; }
2456 let ty = String::from_utf8(a_ty).unwrap();
2457 let is_clonable = self.is_clonable(&ty);
2458 write_option_block(&mut created_container, &mangled_container, &ty, is_clonable);
2460 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2465 self.crate_types.write_new_template(mangled_container.clone(), true, &created_container);
2469 fn path_to_generic_args(path: &syn::Path) -> Vec<&syn::Type> {
2470 if let syn::PathArguments::AngleBracketed(args) = &path.segments.iter().next().unwrap().arguments {
2471 args.args.iter().map(|gen| if let syn::GenericArgument::Type(t) = gen { t } else { unimplemented!() }).collect()
2472 } else { unimplemented!(); }
2474 fn write_c_mangled_container_path_intern<W: std::io::Write>
2475 (&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 {
2476 let mut mangled_type: Vec<u8> = Vec::new();
2477 if !self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) {
2478 write!(w, "C{}_", ident).unwrap();
2479 write!(mangled_type, "C{}_", ident).unwrap();
2480 } else { assert_eq!(args.len(), 1); }
2481 for arg in args.iter() {
2482 macro_rules! write_path {
2483 ($p_arg: expr, $extra_write: expr) => {
2484 if let Some(subtype) = self.maybe_resolve_path(&$p_arg.path, generics) {
2485 if self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) {
2487 if self.c_type_has_inner_from_path(&subtype) {
2488 if !self.write_c_path_intern(w, &$p_arg.path, generics, is_ref, is_mut, ptr_for_ref, false) { return false; }
2490 if let Some(arr_ty) = self.is_real_type_array(&subtype) {
2491 if !self.write_c_type_intern(w, &arr_ty, generics, false, true, false, false) { return false; }
2493 // Option<T> needs to be converted to a *mut T, ie mut ptr-for-ref
2494 if !self.write_c_path_intern(w, &$p_arg.path, generics, true, true, true, false) { return false; }
2498 write!(w, "{}", $p_arg.path.segments.last().unwrap().ident).unwrap();
2500 } else if self.is_known_container(&subtype, is_ref) || self.is_path_transparent_container(&$p_arg.path, generics, is_ref) {
2501 if !self.write_c_mangled_container_path_intern(w, Self::path_to_generic_args(&$p_arg.path), generics,
2502 &subtype, is_ref, is_mut, ptr_for_ref, true) {
2505 self.write_c_mangled_container_path_intern(&mut mangled_type, Self::path_to_generic_args(&$p_arg.path),
2506 generics, &subtype, is_ref, is_mut, ptr_for_ref, true);
2507 if let Some(w2) = $extra_write as Option<&mut Vec<u8>> {
2508 self.write_c_mangled_container_path_intern(w2, Self::path_to_generic_args(&$p_arg.path),
2509 generics, &subtype, is_ref, is_mut, ptr_for_ref, true);
2512 let id = subtype.rsplitn(2, ':').next().unwrap(); // Get the "Base" name of the resolved type
2513 write!(w, "{}", id).unwrap();
2514 write!(mangled_type, "{}", id).unwrap();
2515 if let Some(w2) = $extra_write as Option<&mut Vec<u8>> {
2516 write!(w2, "{}", id).unwrap();
2519 } else { return false; }
2522 match generics.resolve_type(arg) {
2523 syn::Type::Tuple(tuple) => {
2524 if tuple.elems.len() == 0 {
2525 write!(w, "None").unwrap();
2526 write!(mangled_type, "None").unwrap();
2528 let mut mangled_tuple_type: Vec<u8> = Vec::new();
2530 // Figure out what the mangled type should look like. To disambiguate
2531 // ((A, B), C) and (A, B, C) we prefix the generic args with a _ and suffix
2532 // them with a Z. Ideally we wouldn't use Z, but not many special chars are
2533 // available for use in type names.
2534 write!(w, "C{}Tuple_", tuple.elems.len()).unwrap();
2535 write!(mangled_type, "C{}Tuple_", tuple.elems.len()).unwrap();
2536 write!(mangled_tuple_type, "C{}Tuple_", tuple.elems.len()).unwrap();
2537 for elem in tuple.elems.iter() {
2538 if let syn::Type::Path(p) = elem {
2539 write_path!(p, Some(&mut mangled_tuple_type));
2540 } else if let syn::Type::Reference(refelem) = elem {
2541 if let syn::Type::Path(p) = &*refelem.elem {
2542 write_path!(p, Some(&mut mangled_tuple_type));
2543 } else { return false; }
2544 } else { return false; }
2546 write!(w, "Z").unwrap();
2547 write!(mangled_type, "Z").unwrap();
2548 write!(mangled_tuple_type, "Z").unwrap();
2549 if !self.check_create_container(String::from_utf8(mangled_tuple_type).unwrap(),
2550 &format!("{}Tuple", tuple.elems.len()), tuple.elems.iter().collect(), generics, is_ref) {
2555 syn::Type::Path(p_arg) => {
2556 write_path!(p_arg, None);
2558 syn::Type::Reference(refty) => {
2559 if let syn::Type::Path(p_arg) = &*refty.elem {
2560 write_path!(p_arg, None);
2561 } else if let syn::Type::Slice(_) = &*refty.elem {
2562 // write_c_type will actually do exactly what we want here, we just need to
2563 // make it a pointer so that its an option. Note that we cannot always convert
2564 // the Vec-as-slice (ie non-ref types) containers, so sometimes need to be able
2565 // to edit it, hence we use *mut here instead of *const.
2566 if args.len() != 1 { return false; }
2567 write!(w, "*mut ").unwrap();
2568 self.write_c_type(w, arg, None, true);
2569 } else { return false; }
2571 syn::Type::Array(a) => {
2572 if let syn::Type::Path(p_arg) = &*a.elem {
2573 let resolved = self.resolve_path(&p_arg.path, generics);
2574 if !self.is_primitive(&resolved) { return false; }
2575 if let syn::Expr::Lit(syn::ExprLit { lit: syn::Lit::Int(len), .. }) = &a.len {
2576 if self.c_type_from_path(&format!("[{}; {}]", resolved, len.base10_digits()), is_ref, ptr_for_ref).is_none() { return false; }
2577 write!(w, "_{}{}", resolved, len.base10_digits()).unwrap();
2578 write!(mangled_type, "_{}{}", resolved, len.base10_digits()).unwrap();
2579 } else { return false; }
2580 } else { return false; }
2582 _ => { return false; },
2585 if self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) { return true; }
2586 // Push the "end of type" Z
2587 write!(w, "Z").unwrap();
2588 write!(mangled_type, "Z").unwrap();
2590 // Make sure the type is actually defined:
2591 self.check_create_container(String::from_utf8(mangled_type).unwrap(), ident, args, generics, is_ref)
2593 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 {
2594 if !self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) {
2595 write!(w, "{}::", Self::generated_container_path()).unwrap();
2597 self.write_c_mangled_container_path_intern(w, args, generics, ident, is_ref, is_mut, ptr_for_ref, false)
2599 pub fn get_c_mangled_container_type(&self, args: Vec<&syn::Type>, generics: Option<&GenericTypes>, template_name: &str) -> Option<String> {
2600 let mut out = Vec::new();
2601 if !self.write_c_mangled_container_path(&mut out, args, generics, template_name, false, false, false) {
2604 Some(String::from_utf8(out).unwrap())
2607 // **********************************
2608 // *** C Type Equivalent Printing ***
2609 // **********************************
2611 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) -> bool {
2612 let full_path = match self.maybe_resolve_path(&path, generics) {
2613 Some(path) => path, None => return false };
2614 if let Some(c_type) = self.c_type_from_path(&full_path, is_ref, ptr_for_ref) {
2615 write!(w, "{}", c_type).unwrap();
2617 } else if self.crate_types.traits.get(&full_path).is_some() {
2618 if is_ref && ptr_for_ref {
2619 write!(w, "*{} crate::{}", if is_mut { "mut" } else { "const" }, full_path).unwrap();
2621 if with_ref_lifetime { unimplemented!(); }
2622 write!(w, "&{}crate::{}", if is_mut { "mut " } else { "" }, full_path).unwrap();
2624 write!(w, "crate::{}", full_path).unwrap();
2627 } else if self.crate_types.opaques.get(&full_path).is_some() || self.crate_types.mirrored_enums.get(&full_path).is_some() {
2628 if is_ref && ptr_for_ref {
2629 // ptr_for_ref implies we're returning the object, which we can't really do for
2630 // opaque or mirrored types without box'ing them, which is quite a waste, so return
2631 // the actual object itself (for opaque types we'll set the pointer to the actual
2632 // type and note that its a reference).
2633 write!(w, "crate::{}", full_path).unwrap();
2634 } else if is_ref && with_ref_lifetime {
2636 // If we're concretizing something with a lifetime parameter, we have to pick a
2637 // lifetime, of which the only real available choice is `static`, obviously.
2638 write!(w, "&'static ").unwrap();
2639 self.write_rust_path(w, generics, path);
2641 write!(w, "&{}crate::{}", if is_mut { "mut " } else { "" }, full_path).unwrap();
2643 write!(w, "crate::{}", full_path).unwrap();
2650 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) -> bool {
2651 match generics.resolve_type(t) {
2652 syn::Type::Path(p) => {
2653 if p.qself.is_some() {
2656 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
2657 if self.is_known_container(&full_path, is_ref) || self.is_path_transparent_container(&p.path, generics, is_ref) {
2658 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);
2660 if let Some(aliased_type) = self.crate_types.type_aliases.get(&full_path).cloned() {
2661 return self.write_c_type_intern(w, &aliased_type, None, is_ref, is_mut, ptr_for_ref, with_ref_lifetime);
2664 self.write_c_path_intern(w, &p.path, generics, is_ref, is_mut, ptr_for_ref, with_ref_lifetime)
2666 syn::Type::Reference(r) => {
2667 self.write_c_type_intern(w, &*r.elem, generics, true, r.mutability.is_some(), ptr_for_ref, with_ref_lifetime)
2669 syn::Type::Array(a) => {
2670 if is_ref && is_mut {
2671 write!(w, "*mut [").unwrap();
2672 if !self.write_c_type_intern(w, &a.elem, generics, false, false, ptr_for_ref, with_ref_lifetime) { return false; }
2674 write!(w, "*const [").unwrap();
2675 if !self.write_c_type_intern(w, &a.elem, generics, false, false, ptr_for_ref, with_ref_lifetime) { return false; }
2677 let mut typecheck = Vec::new();
2678 if !self.write_c_type_intern(&mut typecheck, &a.elem, generics, false, false, ptr_for_ref, with_ref_lifetime) { return false; }
2679 if typecheck[..] != ['u' as u8, '8' as u8] { return false; }
2681 if let syn::Expr::Lit(l) = &a.len {
2682 if let syn::Lit::Int(i) = &l.lit {
2684 if let Some(ty) = self.c_type_from_path(&format!("[u8; {}]", i.base10_digits()), false, ptr_for_ref) {
2685 write!(w, "{}", ty).unwrap();
2689 write!(w, "; {}]", i).unwrap();
2695 syn::Type::Slice(s) => {
2696 if !is_ref || is_mut { return false; }
2697 if let syn::Type::Path(p) = &*s.elem {
2698 let resolved = self.resolve_path(&p.path, generics);
2699 if self.is_primitive(&resolved) {
2700 write!(w, "{}::{}slice", Self::container_templ_path(), resolved).unwrap();
2703 } else if let syn::Type::Reference(r) = &*s.elem {
2704 if let syn::Type::Path(p) = &*r.elem {
2705 // Slices with "real types" inside are mapped as the equivalent non-ref Vec
2706 let resolved = self.resolve_path(&p.path, generics);
2707 let mangled_container = if let Some((ident, _)) = self.crate_types.opaques.get(&resolved) {
2708 format!("CVec_{}Z", ident)
2709 } else if let Some(en) = self.crate_types.mirrored_enums.get(&resolved) {
2710 format!("CVec_{}Z", en.ident)
2711 } else if let Some(id) = p.path.get_ident() {
2712 format!("CVec_{}Z", id)
2713 } else { return false; };
2714 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
2715 self.check_create_container(mangled_container, "Vec", vec![&*r.elem], generics, false)
2716 } else if let syn::Type::Slice(sl2) = &*r.elem {
2717 if let syn::Type::Reference(r2) = &*sl2.elem {
2718 if let syn::Type::Path(p) = &*r2.elem {
2719 // Slices with slices with opaque types (with is_owned flags) are mapped as non-ref Vecs
2720 let resolved = self.resolve_path(&p.path, generics);
2721 let mangled_container = if let Some((ident, _)) = self.crate_types.opaques.get(&resolved) {
2722 format!("CVec_CVec_{}ZZ", ident)
2723 } else { return false; };
2724 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
2725 let inner = &r2.elem;
2726 let vec_ty: syn::Type = syn::parse_quote!(Vec<#inner>);
2727 self.check_create_container(mangled_container, "Vec", vec![&vec_ty], generics, false)
2731 } else if let syn::Type::Tuple(_) = &*s.elem {
2732 let mut args = syn::punctuated::Punctuated::<_, syn::token::Comma>::new();
2733 args.push(syn::GenericArgument::Type((*s.elem).clone()));
2734 let mut segments = syn::punctuated::Punctuated::new();
2735 segments.push(parse_quote!(Vec<#args>));
2736 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)
2739 syn::Type::Tuple(t) => {
2740 if t.elems.len() == 0 {
2743 self.write_c_mangled_container_path(w, t.elems.iter().collect(), generics,
2744 &format!("{}Tuple", t.elems.len()), is_ref, is_mut, ptr_for_ref)
2750 pub fn write_c_type<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, ptr_for_ref: bool) {
2751 assert!(self.write_c_type_intern(w, t, generics, false, false, ptr_for_ref, false));
2753 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) {
2754 assert!(self.write_c_type_intern(w, t, generics, false, false, ptr_for_ref, true));
2756 pub fn understood_c_path(&self, p: &syn::Path) -> bool {
2757 if p.leading_colon.is_some() { return false; }
2758 self.write_c_path_intern(&mut std::io::sink(), p, None, false, false, false, false)
2760 pub fn understood_c_type(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> bool {
2761 self.write_c_type_intern(&mut std::io::sink(), t, generics, false, false, false, false)