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();
297 match bounds_iter.next().unwrap() {
298 syn::TypeParamBound::Trait(tr) => {
299 assert_simple_bound(&tr);
300 if let Some(path) = types.maybe_resolve_path(&tr.path, None) {
301 if types.skip_path(&path) { continue; }
302 // In general we handle Deref<Target=X> as if it were just X (and
303 // implement Deref<Target=Self> for relevant types). We don't
304 // bother to implement it for associated types, however, so we just
305 // ignore such bounds.
306 if path != "std::ops::Deref" && path != "core::ops::Deref" {
307 self.typed_generics.insert(&t.ident, path);
309 } else { unimplemented!(); }
311 _ => unimplemented!(),
313 if bounds_iter.next().is_some() { unimplemented!(); }
320 /// Attempt to resolve a Path as a generic parameter and return the full path. as both a string
322 pub fn maybe_resolve_path<'b>(&'b self, path: &syn::Path) -> Option<&'b String> {
323 if let Some(ident) = path.get_ident() {
324 if let Some(ty) = &self.self_ty {
325 if format!("{}", ident) == "Self" {
329 if let Some(res) = self.typed_generics.get(ident) {
333 // Associated types are usually specified as "Self::Generic", so we check for that
335 let mut it = path.segments.iter();
336 if path.segments.len() == 2 && format!("{}", it.next().unwrap().ident) == "Self" {
337 let ident = &it.next().unwrap().ident;
338 if let Some(res) = self.typed_generics.get(ident) {
343 if let Some(parent) = self.parent {
344 parent.maybe_resolve_path(path)
351 trait ResolveType<'a> { fn resolve_type(&'a self, ty: &'a syn::Type) -> &'a syn::Type; }
352 impl<'a, 'b, 'c: 'a + 'b> ResolveType<'c> for Option<&GenericTypes<'a, 'b>> {
353 fn resolve_type(&'c self, ty: &'c syn::Type) -> &'c syn::Type {
354 if let Some(us) = self {
356 syn::Type::Path(p) => {
357 if let Some(ident) = p.path.get_ident() {
358 if let Some((ty, _)) = us.default_generics.get(ident) {
363 syn::Type::Reference(syn::TypeReference { elem, .. }) => {
364 if let syn::Type::Path(p) = &**elem {
365 if let Some(ident) = p.path.get_ident() {
366 if let Some((_, refty)) = us.default_generics.get(ident) {
374 us.parent.resolve_type(ty)
379 #[derive(Clone, PartialEq)]
380 // The type of declaration and the object itself
381 pub enum DeclType<'a> {
383 Trait(&'a syn::ItemTrait),
384 StructImported { generic_param_count: usize },
386 EnumIgnored { generic_param_count: usize },
389 pub struct ImportResolver<'mod_lifetime, 'crate_lft: 'mod_lifetime> {
390 crate_name: &'mod_lifetime str,
391 dependencies: &'mod_lifetime HashSet<syn::Ident>,
392 module_path: &'mod_lifetime str,
393 imports: HashMap<syn::Ident, (String, syn::Path)>,
394 declared: HashMap<syn::Ident, DeclType<'crate_lft>>,
395 priv_modules: HashSet<syn::Ident>,
397 impl<'mod_lifetime, 'crate_lft: 'mod_lifetime> ImportResolver<'mod_lifetime, 'crate_lft> {
398 fn process_use_intern(crate_name: &str, module_path: &str, dependencies: &HashSet<syn::Ident>, imports: &mut HashMap<syn::Ident, (String, syn::Path)>,
399 u: &syn::UseTree, partial_path: &str, mut path: syn::punctuated::Punctuated<syn::PathSegment, syn::token::Colon2>) {
402 macro_rules! push_path {
403 ($ident: expr, $path_suffix: expr) => {
404 if partial_path == "" && format!("{}", $ident) == "super" {
405 let mut mod_iter = module_path.rsplitn(2, "::");
406 mod_iter.next().unwrap();
407 let super_mod = mod_iter.next().unwrap();
408 new_path = format!("{}{}", super_mod, $path_suffix);
409 assert_eq!(path.len(), 0);
410 for module in super_mod.split("::") {
411 path.push(syn::PathSegment { ident: syn::Ident::new(module, Span::call_site()), arguments: syn::PathArguments::None });
413 } else if partial_path == "" && format!("{}", $ident) == "crate" {
414 new_path = format!("{}{}", crate_name, $path_suffix);
415 let crate_name_ident = format_ident!("{}", crate_name);
416 path.push(parse_quote!(#crate_name_ident));
417 } else if partial_path == "" && !dependencies.contains(&$ident) {
418 new_path = format!("{}::{}{}", crate_name, $ident, $path_suffix);
419 let crate_name_ident = format_ident!("{}", crate_name);
420 path.push(parse_quote!(#crate_name_ident));
422 new_path = format!("{}{}{}", partial_path, $ident, $path_suffix);
425 path.push(parse_quote!(#ident));
429 syn::UseTree::Path(p) => {
430 push_path!(p.ident, "::");
431 Self::process_use_intern(crate_name, module_path, dependencies, imports, &p.tree, &new_path, path);
433 syn::UseTree::Name(n) => {
434 push_path!(n.ident, "");
435 imports.insert(n.ident.clone(), (new_path, syn::Path { leading_colon: Some(syn::Token![::](Span::call_site())), segments: path }));
437 syn::UseTree::Group(g) => {
438 for i in g.items.iter() {
439 Self::process_use_intern(crate_name, module_path, dependencies, imports, i, partial_path, path.clone());
442 syn::UseTree::Rename(r) => {
443 push_path!(r.ident, "");
444 imports.insert(r.rename.clone(), (new_path, syn::Path { leading_colon: Some(syn::Token![::](Span::call_site())), segments: path }));
446 syn::UseTree::Glob(_) => {
447 eprintln!("Ignoring * use for {} - this may result in resolution failures", partial_path);
452 fn process_use(crate_name: &str, module_path: &str, dependencies: &HashSet<syn::Ident>, imports: &mut HashMap<syn::Ident, (String, syn::Path)>, u: &syn::ItemUse) {
453 if let syn::Visibility::Public(_) = u.vis {
454 // We actually only use these for #[cfg(fuzztarget)]
455 eprintln!("Ignoring pub(use) tree!");
458 if u.leading_colon.is_some() { eprintln!("Ignoring leading-colon use!"); return; }
459 Self::process_use_intern(crate_name, module_path, dependencies, imports, &u.tree, "", syn::punctuated::Punctuated::new());
462 fn insert_primitive(imports: &mut HashMap<syn::Ident, (String, syn::Path)>, id: &str) {
463 let ident = format_ident!("{}", id);
464 let path = parse_quote!(#ident);
465 imports.insert(ident, (id.to_owned(), path));
468 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 {
469 Self::from_borrowed_items(crate_name, dependencies, module_path, &contents.iter().map(|a| a).collect::<Vec<_>>())
471 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 {
472 let mut imports = HashMap::new();
473 // Add primitives to the "imports" list:
474 Self::insert_primitive(&mut imports, "bool");
475 Self::insert_primitive(&mut imports, "u64");
476 Self::insert_primitive(&mut imports, "u32");
477 Self::insert_primitive(&mut imports, "u16");
478 Self::insert_primitive(&mut imports, "u8");
479 Self::insert_primitive(&mut imports, "usize");
480 Self::insert_primitive(&mut imports, "str");
481 Self::insert_primitive(&mut imports, "String");
483 // These are here to allow us to print native Rust types in trait fn impls even if we don't
485 Self::insert_primitive(&mut imports, "Result");
486 Self::insert_primitive(&mut imports, "Vec");
487 Self::insert_primitive(&mut imports, "Option");
489 let mut declared = HashMap::new();
490 let mut priv_modules = HashSet::new();
492 for item in contents.iter() {
494 syn::Item::Use(u) => Self::process_use(crate_name, module_path, dependencies, &mut imports, &u),
495 syn::Item::Struct(s) => {
496 if let syn::Visibility::Public(_) = s.vis {
497 match export_status(&s.attrs) {
498 ExportStatus::Export => { declared.insert(s.ident.clone(), DeclType::StructImported { generic_param_count: s.generics.params.len() }); },
499 ExportStatus::NoExport => { declared.insert(s.ident.clone(), DeclType::StructIgnored); },
500 ExportStatus::TestOnly => continue,
501 ExportStatus::NotImplementable => panic!("(C-not implementable) should only appear on traits!"),
505 syn::Item::Type(t) if export_status(&t.attrs) == ExportStatus::Export => {
506 if let syn::Visibility::Public(_) = t.vis {
507 let mut process_alias = true;
508 for tok in t.generics.params.iter() {
509 if let syn::GenericParam::Lifetime(_) = tok {}
510 else { process_alias = false; }
513 declared.insert(t.ident.clone(), DeclType::StructImported { generic_param_count: t.generics.params.len() });
517 syn::Item::Enum(e) => {
518 if let syn::Visibility::Public(_) = e.vis {
519 match export_status(&e.attrs) {
520 ExportStatus::Export if is_enum_opaque(e) => { declared.insert(e.ident.clone(), DeclType::EnumIgnored { generic_param_count: e.generics.params.len() }); },
521 ExportStatus::Export => { declared.insert(e.ident.clone(), DeclType::MirroredEnum); },
522 ExportStatus::NotImplementable => panic!("(C-not implementable) should only appear on traits!"),
527 syn::Item::Trait(t) => {
528 match export_status(&t.attrs) {
529 ExportStatus::Export|ExportStatus::NotImplementable => {
530 if let syn::Visibility::Public(_) = t.vis {
531 declared.insert(t.ident.clone(), DeclType::Trait(t));
537 syn::Item::Mod(m) => {
538 priv_modules.insert(m.ident.clone());
544 Self { crate_name, dependencies, module_path, imports, declared, priv_modules }
547 pub fn get_declared_type(&self, ident: &syn::Ident) -> Option<&DeclType<'crate_lft>> {
548 self.declared.get(ident)
551 pub fn maybe_resolve_declared(&self, id: &syn::Ident) -> Option<&DeclType<'crate_lft>> {
552 self.declared.get(id)
555 pub fn maybe_resolve_ident(&self, id: &syn::Ident) -> Option<String> {
556 if let Some((imp, _)) = self.imports.get(id) {
558 } else if self.declared.get(id).is_some() {
559 Some(self.module_path.to_string() + "::" + &format!("{}", id))
563 pub fn maybe_resolve_non_ignored_ident(&self, id: &syn::Ident) -> Option<String> {
564 if let Some((imp, _)) = self.imports.get(id) {
566 } else if let Some(decl_type) = self.declared.get(id) {
568 DeclType::StructIgnored => None,
569 _ => Some(self.module_path.to_string() + "::" + &format!("{}", id)),
574 pub fn maybe_resolve_path(&self, p: &syn::Path, generics: Option<&GenericTypes>) -> Option<String> {
575 if let Some(gen_types) = generics {
576 if let Some(resp) = gen_types.maybe_resolve_path(p) {
577 return Some(resp.clone());
581 if p.leading_colon.is_some() {
582 let mut res: String = p.segments.iter().enumerate().map(|(idx, seg)| {
583 format!("{}{}", if idx == 0 { "" } else { "::" }, seg.ident)
585 let firstseg = p.segments.iter().next().unwrap();
586 if !self.dependencies.contains(&firstseg.ident) {
587 res = self.crate_name.to_owned() + "::" + &res;
590 } else if let Some(id) = p.get_ident() {
591 self.maybe_resolve_ident(id)
593 if p.segments.len() == 1 {
594 let seg = p.segments.iter().next().unwrap();
595 return self.maybe_resolve_ident(&seg.ident);
597 let mut seg_iter = p.segments.iter();
598 let first_seg = seg_iter.next().unwrap();
599 let remaining: String = seg_iter.map(|seg| {
600 format!("::{}", seg.ident)
602 let first_seg_str = format!("{}", first_seg.ident);
603 if let Some((imp, _)) = self.imports.get(&first_seg.ident) {
605 Some(imp.clone() + &remaining)
609 } else if let Some(_) = self.priv_modules.get(&first_seg.ident) {
610 Some(format!("{}::{}{}", self.module_path, first_seg.ident, remaining))
611 } else if first_seg_is_stdlib(&first_seg_str) || self.dependencies.contains(&first_seg.ident) {
612 Some(first_seg_str + &remaining)
617 /// Map all the Paths in a Type into absolute paths given a set of imports (generated via process_use_intern)
618 pub fn resolve_imported_refs(&self, mut ty: syn::Type) -> syn::Type {
620 syn::Type::Path(p) => {
621 if p.path.segments.len() != 1 { unimplemented!(); }
622 let mut args = p.path.segments[0].arguments.clone();
623 if let syn::PathArguments::AngleBracketed(ref mut generics) = &mut args {
624 for arg in generics.args.iter_mut() {
625 if let syn::GenericArgument::Type(ref mut t) = arg {
626 *t = self.resolve_imported_refs(t.clone());
630 if let Some((_, newpath)) = self.imports.get(single_ident_generic_path_to_ident(&p.path).unwrap()) {
631 p.path = newpath.clone();
633 p.path.segments[0].arguments = args;
635 syn::Type::Reference(r) => {
636 r.elem = Box::new(self.resolve_imported_refs((*r.elem).clone()));
638 syn::Type::Slice(s) => {
639 s.elem = Box::new(self.resolve_imported_refs((*s.elem).clone()));
641 syn::Type::Tuple(t) => {
642 for e in t.elems.iter_mut() {
643 *e = self.resolve_imported_refs(e.clone());
646 _ => unimplemented!(),
652 // templates_defined is walked to write the C++ header, so if we use the default hashing it get
653 // reordered on each genbindings run. Instead, we use SipHasher (which defaults to 0-keys) so that
654 // the sorting is stable across runs. It is deprecated, but the "replacement" doesn't actually
655 // accomplish the same goals, so we just ignore it.
657 pub type NonRandomHash = hash::BuildHasherDefault<hash::SipHasher>;
660 pub struct ASTModule {
661 pub attrs: Vec<syn::Attribute>,
662 pub items: Vec<syn::Item>,
663 pub submods: Vec<String>,
665 /// A struct containing the syn::File AST for each file in the crate.
666 pub struct FullLibraryAST {
667 pub modules: HashMap<String, ASTModule, NonRandomHash>,
668 pub dependencies: HashSet<syn::Ident>,
670 impl FullLibraryAST {
671 fn load_module(&mut self, module: String, attrs: Vec<syn::Attribute>, mut items: Vec<syn::Item>) {
672 let mut non_mod_items = Vec::with_capacity(items.len());
673 let mut submods = Vec::with_capacity(items.len());
674 for item in items.drain(..) {
676 syn::Item::Mod(m) if m.content.is_some() => {
677 if export_status(&m.attrs) == ExportStatus::Export {
678 if let syn::Visibility::Public(_) = m.vis {
679 let modident = format!("{}", m.ident);
680 let modname = if module != "" {
681 module.clone() + "::" + &modident
685 self.load_module(modname, m.attrs, m.content.unwrap().1);
686 submods.push(modident);
688 non_mod_items.push(syn::Item::Mod(m));
692 syn::Item::Mod(_) => panic!("--pretty=expanded output should never have non-body modules"),
693 syn::Item::ExternCrate(c) => {
694 if export_status(&c.attrs) == ExportStatus::Export {
695 self.dependencies.insert(c.ident);
698 _ => { non_mod_items.push(item); }
701 self.modules.insert(module, ASTModule { attrs, items: non_mod_items, submods });
704 pub fn load_lib(lib: syn::File) -> Self {
705 assert_eq!(export_status(&lib.attrs), ExportStatus::Export);
706 let mut res = Self { modules: HashMap::default(), dependencies: HashSet::new() };
707 res.load_module("".to_owned(), lib.attrs, lib.items);
712 /// List of manually-generated types which are clonable
713 fn initial_clonable_types() -> HashSet<String> {
714 let mut res = HashSet::new();
715 res.insert("crate::c_types::u5".to_owned());
716 res.insert("crate::c_types::ThirtyTwoBytes".to_owned());
717 res.insert("crate::c_types::PublicKey".to_owned());
718 res.insert("crate::c_types::Transaction".to_owned());
719 res.insert("crate::c_types::TxOut".to_owned());
720 res.insert("crate::c_types::Signature".to_owned());
721 res.insert("crate::c_types::RecoverableSignature".to_owned());
722 res.insert("crate::c_types::Secp256k1Error".to_owned());
723 res.insert("crate::c_types::IOError".to_owned());
727 /// Top-level struct tracking everything which has been defined while walking the crate.
728 pub struct CrateTypes<'a> {
729 /// This may contain structs or enums, but only when either is mapped as
730 /// struct X { inner: *mut originalX, .. }
731 pub opaques: HashMap<String, (&'a syn::Ident, &'a syn::Generics)>,
732 /// Enums which are mapped as C enums with conversion functions
733 pub mirrored_enums: HashMap<String, &'a syn::ItemEnum>,
734 /// Traits which are mapped as a pointer + jump table
735 pub traits: HashMap<String, &'a syn::ItemTrait>,
736 /// Aliases from paths to some other Type
737 pub type_aliases: HashMap<String, syn::Type>,
738 /// Value is an alias to Key (maybe with some generics)
739 pub reverse_alias_map: HashMap<String, Vec<(syn::Path, syn::PathArguments)>>,
740 /// Template continer types defined, map from mangled type name -> whether a destructor fn
743 /// This is used at the end of processing to make C++ wrapper classes
744 pub templates_defined: RefCell<HashMap<String, bool, NonRandomHash>>,
745 /// The output file for any created template container types, written to as we find new
746 /// template containers which need to be defined.
747 template_file: RefCell<&'a mut File>,
748 /// Set of containers which are clonable
749 clonable_types: RefCell<HashSet<String>>,
751 pub trait_impls: HashMap<String, Vec<String>>,
752 /// The full set of modules in the crate(s)
753 pub lib_ast: &'a FullLibraryAST,
756 impl<'a> CrateTypes<'a> {
757 pub fn new(template_file: &'a mut File, libast: &'a FullLibraryAST) -> Self {
759 opaques: HashMap::new(), mirrored_enums: HashMap::new(), traits: HashMap::new(),
760 type_aliases: HashMap::new(), reverse_alias_map: HashMap::new(),
761 templates_defined: RefCell::new(HashMap::default()),
762 clonable_types: RefCell::new(initial_clonable_types()), trait_impls: HashMap::new(),
763 template_file: RefCell::new(template_file), lib_ast: &libast,
766 pub fn set_clonable(&self, object: String) {
767 self.clonable_types.borrow_mut().insert(object);
769 pub fn is_clonable(&self, object: &str) -> bool {
770 self.clonable_types.borrow().contains(object)
772 pub fn write_new_template(&self, mangled_container: String, has_destructor: bool, created_container: &[u8]) {
773 self.template_file.borrow_mut().write(created_container).unwrap();
774 self.templates_defined.borrow_mut().insert(mangled_container, has_destructor);
778 /// A struct which tracks resolving rust types into C-mapped equivalents, exists for one specific
779 /// module but contains a reference to the overall CrateTypes tracking.
780 pub struct TypeResolver<'mod_lifetime, 'crate_lft: 'mod_lifetime> {
781 pub module_path: &'mod_lifetime str,
782 pub crate_types: &'mod_lifetime CrateTypes<'crate_lft>,
783 types: ImportResolver<'mod_lifetime, 'crate_lft>,
786 /// Returned by write_empty_rust_val_check_suffix to indicate what type of dereferencing needs to
787 /// happen to get the inner value of a generic.
788 enum EmptyValExpectedTy {
789 /// A type which has a flag for being empty (eg an array where we treat all-0s as empty).
791 /// A Option mapped as a COption_*Z
793 /// A pointer which we want to convert to a reference.
798 /// Describes the appropriate place to print a general type-conversion string when converting a
800 enum ContainerPrefixLocation {
801 /// Prints a general type-conversion string prefix and suffix outside of the
802 /// container-conversion strings.
804 /// Prints a general type-conversion string prefix and suffix inside of the
805 /// container-conversion strings.
807 /// Does not print the usual type-conversion string prefix and suffix.
811 impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
812 pub fn new(module_path: &'a str, types: ImportResolver<'a, 'c>, crate_types: &'a CrateTypes<'c>) -> Self {
813 Self { module_path, types, crate_types }
816 // *************************************************
817 // *** Well know type and conversion definitions ***
818 // *************************************************
820 /// Returns true we if can just skip passing this to C entirely
821 fn skip_path(&self, full_path: &str) -> bool {
822 full_path == "bitcoin::secp256k1::Secp256k1" ||
823 full_path == "bitcoin::secp256k1::Signing" ||
824 full_path == "bitcoin::secp256k1::Verification"
826 /// Returns true we if can just skip passing this to C entirely
827 fn no_arg_path_to_rust(&self, full_path: &str) -> &str {
828 if full_path == "bitcoin::secp256k1::Secp256k1" {
829 "secp256k1::SECP256K1"
830 } else { unimplemented!(); }
833 /// Returns true if the object is a primitive and is mapped as-is with no conversion
835 pub fn is_primitive(&self, full_path: &str) -> bool {
846 pub fn is_clonable(&self, ty: &str) -> bool {
847 if self.crate_types.is_clonable(ty) { return true; }
848 if self.is_primitive(ty) { return true; }
854 /// Gets the C-mapped type for types which are outside of the crate, or which are manually
855 /// ignored by for some reason need mapping anyway.
856 fn c_type_from_path<'b>(&self, full_path: &'b str, is_ref: bool, _ptr_for_ref: bool) -> Option<&'b str> {
857 if self.is_primitive(full_path) {
858 return Some(full_path);
861 // Note that no !is_ref types can map to an array because Rust and C's call semantics
862 // for arrays are different (https://github.com/eqrion/cbindgen/issues/528)
864 "[u8; 32]" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
865 "[u8; 20]" if !is_ref => Some("crate::c_types::TwentyBytes"),
866 "[u8; 16]" if !is_ref => Some("crate::c_types::SixteenBytes"),
867 "[u8; 10]" if !is_ref => Some("crate::c_types::TenBytes"),
868 "[u8; 4]" if !is_ref => Some("crate::c_types::FourBytes"),
869 "[u8; 3]" if !is_ref => Some("crate::c_types::ThreeBytes"), // Used for RGB values
871 "str" if is_ref => Some("crate::c_types::Str"),
872 "alloc::string::String"|"String" => Some("crate::c_types::Str"),
874 "std::time::Duration"|"core::time::Duration" => Some("u64"),
875 "std::time::SystemTime" => Some("u64"),
876 "std::io::Error" => Some("crate::c_types::IOError"),
878 "core::convert::Infallible" => Some("crate::c_types::NotConstructable"),
880 "bech32::u5" => Some("crate::c_types::u5"),
881 "core::num::NonZeroU8" => Some("u8"),
883 "bitcoin::secp256k1::key::PublicKey"|"bitcoin::secp256k1::PublicKey"|"secp256k1::key::PublicKey"
884 => Some("crate::c_types::PublicKey"),
885 "bitcoin::secp256k1::Signature" => Some("crate::c_types::Signature"),
886 "bitcoin::secp256k1::recovery::RecoverableSignature" => Some("crate::c_types::RecoverableSignature"),
887 "bitcoin::secp256k1::key::SecretKey"|"bitcoin::secp256k1::SecretKey"
888 if is_ref => Some("*const [u8; 32]"),
889 "bitcoin::secp256k1::key::SecretKey"|"bitcoin::secp256k1::SecretKey"
890 if !is_ref => Some("crate::c_types::SecretKey"),
891 "bitcoin::secp256k1::Error"|"secp256k1::Error"
892 if !is_ref => Some("crate::c_types::Secp256k1Error"),
893 "bitcoin::blockdata::script::Script" if is_ref => Some("crate::c_types::u8slice"),
894 "bitcoin::blockdata::script::Script" if !is_ref => Some("crate::c_types::derived::CVec_u8Z"),
895 "bitcoin::blockdata::transaction::OutPoint" => Some("crate::lightning::chain::transaction::OutPoint"),
896 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some("crate::c_types::Transaction"),
897 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some("crate::c_types::TxOut"),
898 "bitcoin::network::constants::Network" => Some("crate::bitcoin::network::Network"),
899 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some("*const [u8; 80]"),
900 "bitcoin::blockdata::block::Block" if is_ref => Some("crate::c_types::u8slice"),
902 "bitcoin::hash_types::PubkeyHash"|"bitcoin::hash_types::WPubkeyHash"|"bitcoin::hash_types::ScriptHash"
903 if is_ref => Some("*const [u8; 20]"),
904 "bitcoin::hash_types::WScriptHash"
905 if is_ref => Some("*const [u8; 32]"),
907 // Newtypes that we just expose in their original form.
908 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
909 if is_ref => Some("*const [u8; 32]"),
910 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
911 if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
912 "bitcoin::secp256k1::Message" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
913 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"|"lightning::ln::channelmanager::PaymentId"
914 if is_ref => Some("*const [u8; 32]"),
915 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"|"lightning::ln::channelmanager::PaymentId"
916 if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
918 // Override the default since Records contain an fmt with a lifetime:
919 "lightning::util::logger::Record" => Some("*const std::os::raw::c_char"),
921 "lightning::io::Read" => Some("crate::c_types::u8slice"),
927 fn from_c_conversion_new_var_from_path<'b>(&self, _full_path: &str, _is_ref: bool) -> Option<(&'b str, &'b str)> {
930 fn from_c_conversion_prefix_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<String> {
931 if self.is_primitive(full_path) {
932 return Some("".to_owned());
935 "Vec" if !is_ref => Some("local_"),
936 "Result" if !is_ref => Some("local_"),
937 "Option" if is_ref => Some("&local_"),
938 "Option" => Some("local_"),
940 "[u8; 32]" if is_ref => Some("unsafe { &*"),
941 "[u8; 32]" if !is_ref => Some(""),
942 "[u8; 20]" if !is_ref => Some(""),
943 "[u8; 16]" if !is_ref => Some(""),
944 "[u8; 10]" if !is_ref => Some(""),
945 "[u8; 4]" if !is_ref => Some(""),
946 "[u8; 3]" if !is_ref => Some(""),
948 "[u8]" if is_ref => Some(""),
949 "[usize]" if is_ref => Some(""),
951 "str" if is_ref => Some(""),
952 "alloc::string::String"|"String" => Some(""),
953 "std::io::Error" if !is_ref => Some(""),
954 // Note that we'll panic for String if is_ref, as we only have non-owned memory, we
955 // cannot create a &String.
957 "core::convert::Infallible" => Some("panic!(\"You must never construct a NotConstructable! : "),
959 "std::time::Duration"|"core::time::Duration" => Some("std::time::Duration::from_secs("),
960 "std::time::SystemTime" => Some("(::std::time::SystemTime::UNIX_EPOCH + std::time::Duration::from_secs("),
962 "bech32::u5" => Some(""),
963 "core::num::NonZeroU8" => Some("core::num::NonZeroU8::new("),
965 "bitcoin::secp256k1::key::PublicKey"|"bitcoin::secp256k1::PublicKey"|"secp256k1::key::PublicKey"
966 if is_ref => Some("&"),
967 "bitcoin::secp256k1::key::PublicKey"|"bitcoin::secp256k1::PublicKey"|"secp256k1::key::PublicKey"
969 "bitcoin::secp256k1::Signature" if is_ref => Some("&"),
970 "bitcoin::secp256k1::Signature" => Some(""),
971 "bitcoin::secp256k1::recovery::RecoverableSignature" => Some(""),
972 "bitcoin::secp256k1::key::SecretKey"|"bitcoin::secp256k1::SecretKey"
973 if is_ref => Some("&::bitcoin::secp256k1::key::SecretKey::from_slice(&unsafe { *"),
974 "bitcoin::secp256k1::key::SecretKey"|"bitcoin::secp256k1::SecretKey"
975 if !is_ref => Some(""),
976 "bitcoin::blockdata::script::Script" if is_ref => Some("&::bitcoin::blockdata::script::Script::from(Vec::from("),
977 "bitcoin::blockdata::script::Script" if !is_ref => Some("::bitcoin::blockdata::script::Script::from("),
978 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" if is_ref => Some("&"),
979 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(""),
980 "bitcoin::blockdata::transaction::OutPoint" => Some("crate::c_types::C_to_bitcoin_outpoint("),
981 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(""),
982 "bitcoin::network::constants::Network" => Some(""),
983 "bitcoin::blockdata::block::BlockHeader" => Some("&::bitcoin::consensus::encode::deserialize(unsafe { &*"),
984 "bitcoin::blockdata::block::Block" if is_ref => Some("&::bitcoin::consensus::encode::deserialize("),
986 "bitcoin::hash_types::PubkeyHash" if is_ref =>
987 Some("&bitcoin::hash_types::PubkeyHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
988 "bitcoin::hash_types::WPubkeyHash" if is_ref =>
989 Some("&bitcoin::hash_types::WPubkeyHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
990 "bitcoin::hash_types::ScriptHash" if is_ref =>
991 Some("&bitcoin::hash_types::ScriptHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
992 "bitcoin::hash_types::WScriptHash" if is_ref =>
993 Some("&bitcoin::hash_types::WScriptHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
995 // Newtypes that we just expose in their original form.
996 "bitcoin::hash_types::Txid" if is_ref => Some("&::bitcoin::hash_types::Txid::from_slice(&unsafe { &*"),
997 "bitcoin::hash_types::Txid" if !is_ref => Some("::bitcoin::hash_types::Txid::from_slice(&"),
998 "bitcoin::hash_types::BlockHash" => Some("::bitcoin::hash_types::BlockHash::from_slice(&"),
999 "lightning::ln::PaymentHash" if !is_ref => Some("::lightning::ln::PaymentHash("),
1000 "lightning::ln::PaymentHash" if is_ref => Some("&::lightning::ln::PaymentHash(unsafe { *"),
1001 "lightning::ln::PaymentPreimage" if !is_ref => Some("::lightning::ln::PaymentPreimage("),
1002 "lightning::ln::PaymentPreimage" if is_ref => Some("&::lightning::ln::PaymentPreimage(unsafe { *"),
1003 "lightning::ln::PaymentSecret" if !is_ref => Some("::lightning::ln::PaymentSecret("),
1004 "lightning::ln::channelmanager::PaymentId" if !is_ref => Some("::lightning::ln::channelmanager::PaymentId("),
1005 "lightning::ln::channelmanager::PaymentId" if is_ref=> Some("&::lightning::ln::channelmanager::PaymentId( unsafe { *"),
1007 // List of traits we map (possibly during processing of other files):
1008 "crate::util::logger::Logger" => Some(""),
1010 "lightning::io::Read" => Some("&mut "),
1013 }.map(|s| s.to_owned())
1015 fn from_c_conversion_suffix_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<String> {
1016 if self.is_primitive(full_path) {
1017 return Some("".to_owned());
1020 "Vec" if !is_ref => Some(""),
1021 "Option" => Some(""),
1022 "Result" if !is_ref => Some(""),
1024 "[u8; 32]" if is_ref => Some("}"),
1025 "[u8; 32]" if !is_ref => Some(".data"),
1026 "[u8; 20]" if !is_ref => Some(".data"),
1027 "[u8; 16]" if !is_ref => Some(".data"),
1028 "[u8; 10]" if !is_ref => Some(".data"),
1029 "[u8; 4]" if !is_ref => Some(".data"),
1030 "[u8; 3]" if !is_ref => Some(".data"),
1032 "[u8]" if is_ref => Some(".to_slice()"),
1033 "[usize]" if is_ref => Some(".to_slice()"),
1035 "str" if is_ref => Some(".into_str()"),
1036 "alloc::string::String"|"String" => Some(".into_string()"),
1037 "std::io::Error" if !is_ref => Some(".to_rust()"),
1039 "core::convert::Infallible" => Some("\")"),
1041 "std::time::Duration"|"core::time::Duration" => Some(")"),
1042 "std::time::SystemTime" => Some("))"),
1044 "bech32::u5" => Some(".into()"),
1045 "core::num::NonZeroU8" => Some(").expect(\"Value must be non-zero\")"),
1047 "bitcoin::secp256k1::key::PublicKey"|"bitcoin::secp256k1::PublicKey"|"secp256k1::key::PublicKey"
1048 => Some(".into_rust()"),
1049 "bitcoin::secp256k1::Signature" => Some(".into_rust()"),
1050 "bitcoin::secp256k1::recovery::RecoverableSignature" => Some(".into_rust()"),
1051 "bitcoin::secp256k1::key::SecretKey"|"bitcoin::secp256k1::SecretKey"
1052 if !is_ref => Some(".into_rust()"),
1053 "bitcoin::secp256k1::key::SecretKey"|"bitcoin::secp256k1::SecretKey"
1054 if is_ref => Some("}[..]).unwrap()"),
1055 "bitcoin::blockdata::script::Script" if is_ref => Some(".to_slice()))"),
1056 "bitcoin::blockdata::script::Script" if !is_ref => Some(".into_rust())"),
1057 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(".into_bitcoin()"),
1058 "bitcoin::blockdata::transaction::OutPoint" => Some(")"),
1059 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(".into_rust()"),
1060 "bitcoin::network::constants::Network" => Some(".into_bitcoin()"),
1061 "bitcoin::blockdata::block::BlockHeader" => Some(" }).unwrap()"),
1062 "bitcoin::blockdata::block::Block" => Some(".to_slice()).unwrap()"),
1064 "bitcoin::hash_types::PubkeyHash"|"bitcoin::hash_types::WPubkeyHash"|
1065 "bitcoin::hash_types::ScriptHash"|"bitcoin::hash_types::WScriptHash"
1066 if is_ref => Some(" }.clone()))"),
1068 // Newtypes that we just expose in their original form.
1069 "bitcoin::hash_types::Txid" if is_ref => Some(" }[..]).unwrap()"),
1070 "bitcoin::hash_types::Txid" => Some(".data[..]).unwrap()"),
1071 "bitcoin::hash_types::BlockHash" if !is_ref => Some(".data[..]).unwrap()"),
1072 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"|"lightning::ln::channelmanager::PaymentId"
1073 if !is_ref => Some(".data)"),
1074 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"|"lightning::ln::channelmanager::PaymentId"
1075 if is_ref => Some(" })"),
1077 // List of traits we map (possibly during processing of other files):
1078 "crate::util::logger::Logger" => Some(""),
1080 "lightning::io::Read" => Some(".to_reader()"),
1083 }.map(|s| s.to_owned())
1086 fn to_c_conversion_new_var_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<(&'b str, &'b str)> {
1087 if self.is_primitive(full_path) {
1091 "[u8]" if is_ref => Some(("crate::c_types::u8slice::from_slice(", ")")),
1092 "[usize]" if is_ref => Some(("crate::c_types::usizeslice::from_slice(", ")")),
1094 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some(("{ let mut s = [0u8; 80]; s[..].copy_from_slice(&::bitcoin::consensus::encode::serialize(", ")); s }")),
1095 "bitcoin::blockdata::block::Block" if is_ref => Some(("::bitcoin::consensus::encode::serialize(", ")")),
1096 "bitcoin::hash_types::Txid" => None,
1098 // Override the default since Records contain an fmt with a lifetime:
1099 // TODO: We should include the other record fields
1100 "lightning::util::logger::Record" => Some(("std::ffi::CString::new(format!(\"{}\", ", ".args)).unwrap()")),
1102 }.map(|s| s.to_owned())
1104 fn to_c_conversion_inline_prefix_from_path(&self, full_path: &str, is_ref: bool, _ptr_for_ref: bool) -> Option<String> {
1105 if self.is_primitive(full_path) {
1106 return Some("".to_owned());
1109 "Result" if !is_ref => Some("local_"),
1110 "Vec" if !is_ref => Some("local_"),
1111 "Option" => Some("local_"),
1113 "[u8; 32]" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1114 "[u8; 32]" if is_ref => Some(""),
1115 "[u8; 20]" if !is_ref => Some("crate::c_types::TwentyBytes { data: "),
1116 "[u8; 16]" if !is_ref => Some("crate::c_types::SixteenBytes { data: "),
1117 "[u8; 10]" if !is_ref => Some("crate::c_types::TenBytes { data: "),
1118 "[u8; 4]" if !is_ref => Some("crate::c_types::FourBytes { data: "),
1119 "[u8; 3]" if is_ref => Some(""),
1121 "[u8]" if is_ref => Some("local_"),
1122 "[usize]" if is_ref => Some("local_"),
1124 "str" if is_ref => Some(""),
1125 "alloc::string::String"|"String" => Some(""),
1127 "std::time::Duration"|"core::time::Duration" => Some(""),
1128 "std::time::SystemTime" => Some(""),
1129 "std::io::Error" if !is_ref => Some("crate::c_types::IOError::from_rust("),
1131 "core::convert::Infallible" => Some("panic!(\"Cannot construct an Infallible: "),
1133 "bech32::u5" => Some(""),
1135 "bitcoin::secp256k1::key::PublicKey"|"bitcoin::secp256k1::PublicKey"|"secp256k1::key::PublicKey"
1136 => Some("crate::c_types::PublicKey::from_rust(&"),
1137 "bitcoin::secp256k1::Signature" => Some("crate::c_types::Signature::from_rust(&"),
1138 "bitcoin::secp256k1::recovery::RecoverableSignature" => Some("crate::c_types::RecoverableSignature::from_rust(&"),
1139 "bitcoin::secp256k1::key::SecretKey"|"bitcoin::secp256k1::SecretKey"
1140 if is_ref => Some(""),
1141 "bitcoin::secp256k1::key::SecretKey"|"bitcoin::secp256k1::SecretKey"
1142 if !is_ref => Some("crate::c_types::SecretKey::from_rust("),
1143 "bitcoin::secp256k1::Error"|"secp256k1::Error"
1144 if !is_ref => Some("crate::c_types::Secp256k1Error::from_rust("),
1145 "bitcoin::blockdata::script::Script" if is_ref => Some("crate::c_types::u8slice::from_slice(&"),
1146 "bitcoin::blockdata::script::Script" if !is_ref => Some(""),
1147 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" if is_ref => Some("crate::c_types::Transaction::from_bitcoin("),
1148 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some("crate::c_types::Transaction::from_bitcoin(&"),
1149 "bitcoin::blockdata::transaction::OutPoint" => Some("crate::c_types::bitcoin_to_C_outpoint("),
1150 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some("crate::c_types::TxOut::from_rust("),
1151 "bitcoin::network::constants::Network" => Some("crate::bitcoin::network::Network::from_bitcoin("),
1152 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some("&local_"),
1153 "bitcoin::blockdata::block::Block" if is_ref => Some("crate::c_types::u8slice::from_slice(&local_"),
1155 "bitcoin::hash_types::Txid" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1157 // Newtypes that we just expose in their original form.
1158 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1159 if is_ref => Some(""),
1160 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1161 if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1162 "bitcoin::secp256k1::Message" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1163 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"|"lightning::ln::channelmanager::PaymentId"
1164 if is_ref => Some("&"),
1165 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"|"lightning::ln::channelmanager::PaymentId"
1166 if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1168 // Override the default since Records contain an fmt with a lifetime:
1169 "lightning::util::logger::Record" => Some("local_"),
1171 "lightning::io::Read" => Some("crate::c_types::u8slice::from_vec(&crate::c_types::reader_to_vec("),
1174 }.map(|s| s.to_owned())
1176 fn to_c_conversion_inline_suffix_from_path(&self, full_path: &str, is_ref: bool, _ptr_for_ref: bool) -> Option<String> {
1177 if self.is_primitive(full_path) {
1178 return Some("".to_owned());
1181 "Result" if !is_ref => Some(""),
1182 "Vec" if !is_ref => Some(".into()"),
1183 "Option" => Some(""),
1185 "[u8; 32]" if !is_ref => Some(" }"),
1186 "[u8; 32]" if is_ref => Some(""),
1187 "[u8; 20]" if !is_ref => Some(" }"),
1188 "[u8; 16]" if !is_ref => Some(" }"),
1189 "[u8; 10]" if !is_ref => Some(" }"),
1190 "[u8; 4]" if !is_ref => Some(" }"),
1191 "[u8; 3]" if is_ref => Some(""),
1193 "[u8]" if is_ref => Some(""),
1194 "[usize]" if is_ref => Some(""),
1196 "str" if is_ref => Some(".into()"),
1197 "alloc::string::String"|"String" if is_ref => Some(".as_str().into()"),
1198 "alloc::string::String"|"String" => Some(".into()"),
1200 "std::time::Duration"|"core::time::Duration" => Some(".as_secs()"),
1201 "std::time::SystemTime" => Some(".duration_since(::std::time::SystemTime::UNIX_EPOCH).expect(\"Times must be post-1970\").as_secs()"),
1202 "std::io::Error" if !is_ref => Some(")"),
1204 "core::convert::Infallible" => Some("\")"),
1206 "bech32::u5" => Some(".into()"),
1208 "bitcoin::secp256k1::key::PublicKey"|"bitcoin::secp256k1::PublicKey"|"secp256k1::key::PublicKey"
1210 "bitcoin::secp256k1::Signature" => Some(")"),
1211 "bitcoin::secp256k1::recovery::RecoverableSignature" => Some(")"),
1212 "bitcoin::secp256k1::key::SecretKey"|"bitcoin::secp256k1::SecretKey"
1213 if !is_ref => Some(")"),
1214 "bitcoin::secp256k1::key::SecretKey"|"bitcoin::secp256k1::SecretKey"
1215 if is_ref => Some(".as_ref()"),
1216 "bitcoin::secp256k1::Error"|"secp256k1::Error"
1217 if !is_ref => Some(")"),
1218 "bitcoin::blockdata::script::Script" if is_ref => Some("[..])"),
1219 "bitcoin::blockdata::script::Script" if !is_ref => Some(".into_bytes().into()"),
1220 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(")"),
1221 "bitcoin::blockdata::transaction::OutPoint" => Some(")"),
1222 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(")"),
1223 "bitcoin::network::constants::Network" => Some(")"),
1224 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some(""),
1225 "bitcoin::blockdata::block::Block" if is_ref => Some(")"),
1227 "bitcoin::hash_types::Txid" if !is_ref => Some(".into_inner() }"),
1229 // Newtypes that we just expose in their original form.
1230 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1231 if is_ref => Some(".as_inner()"),
1232 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1233 if !is_ref => Some(".into_inner() }"),
1234 "bitcoin::secp256k1::Message" if !is_ref => Some(".as_ref().clone() }"),
1235 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"|"lightning::ln::channelmanager::PaymentId"
1236 if is_ref => Some(".0"),
1237 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"|"lightning::ln::channelmanager::PaymentId"
1238 if !is_ref => Some(".0 }"),
1240 // Override the default since Records contain an fmt with a lifetime:
1241 "lightning::util::logger::Record" => Some(".as_ptr()"),
1243 "lightning::io::Read" => Some("))"),
1246 }.map(|s| s.to_owned())
1249 fn empty_val_check_suffix_from_path(&self, full_path: &str) -> Option<&str> {
1251 "lightning::ln::PaymentSecret" => Some(".data == [0; 32]"),
1252 "secp256k1::key::PublicKey"|"bitcoin::secp256k1::key::PublicKey" => Some(".is_null()"),
1253 "bitcoin::secp256k1::Signature" => Some(".is_null()"),
1258 /// When printing a reference to the source crate's rust type, if we need to map it to a
1259 /// different "real" type, it can be done so here.
1260 /// This is useful to work around limitations in the binding type resolver, where we reference
1261 /// a non-public `use` alias.
1262 /// TODO: We should never need to use this!
1263 fn real_rust_type_mapping<'equiv>(&self, thing: &'equiv str) -> &'equiv str {
1265 "lightning::io::Read" => "std::io::Read",
1270 // ****************************
1271 // *** Container Processing ***
1272 // ****************************
1274 /// Returns the module path in the generated mapping crate to the containers which we generate
1275 /// when writing to CrateTypes::template_file.
1276 pub fn generated_container_path() -> &'static str {
1277 "crate::c_types::derived"
1279 /// Returns the module path in the generated mapping crate to the container templates, which
1280 /// are then concretized and put in the generated container path/template_file.
1281 fn container_templ_path() -> &'static str {
1285 /// Returns true if the path containing the given args is a "transparent" container, ie an
1286 /// Option or a container which does not require a generated continer class.
1287 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 {
1288 if full_path == "Option" {
1289 let inner = args.next().unwrap();
1290 assert!(args.next().is_none());
1292 syn::Type::Reference(_) => true,
1293 syn::Type::Path(p) => {
1294 if let Some(resolved) = self.maybe_resolve_path(&p.path, generics) {
1295 if self.c_type_has_inner_from_path(&resolved) { return true; }
1296 if self.is_primitive(&resolved) { return false; }
1297 if self.c_type_from_path(&resolved, false, false).is_some() { true } else { false }
1300 syn::Type::Tuple(_) => false,
1301 _ => unimplemented!(),
1305 /// Returns true if the path is a "transparent" container, ie an Option or a container which does
1306 /// not require a generated continer class.
1307 pub fn is_path_transparent_container(&self, full_path: &syn::Path, generics: Option<&GenericTypes>, is_ref: bool) -> bool {
1308 let inner_iter = match &full_path.segments.last().unwrap().arguments {
1309 syn::PathArguments::None => return false,
1310 syn::PathArguments::AngleBracketed(args) => args.args.iter().map(|arg| {
1311 if let syn::GenericArgument::Type(ref ty) = arg {
1313 } else { unimplemented!() }
1315 syn::PathArguments::Parenthesized(_) => unimplemented!(),
1317 self.is_transparent_container(&self.resolve_path(full_path, generics), is_ref, inner_iter, generics)
1319 /// Returns true if this is a known, supported, non-transparent container.
1320 fn is_known_container(&self, full_path: &str, is_ref: bool) -> bool {
1321 (full_path == "Result" && !is_ref) || (full_path == "Vec" && !is_ref) || full_path.ends_with("Tuple") || full_path == "Option"
1323 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)
1324 // Returns prefix + Vec<(prefix, var-name-to-inline-convert)> + suffix
1325 // expecting one element in the vec per generic type, each of which is inline-converted
1326 -> Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)> {
1328 "Result" if !is_ref => {
1330 vec![(" { Ok(mut o) => crate::c_types::CResultTempl::ok(".to_string(), "o".to_string()),
1331 (").into(), Err(mut e) => crate::c_types::CResultTempl::err(".to_string(), "e".to_string())],
1332 ").into() }", ContainerPrefixLocation::PerConv))
1336 // We should only get here if the single contained has an inner
1337 assert!(self.c_type_has_inner(single_contained.unwrap()));
1339 Some(("Vec::new(); for mut item in ", vec![(format!(".drain(..) {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1342 if let Some(syn::Type::Reference(_)) = single_contained {
1343 Some(("Vec::new(); for item in ", vec![(format!(".iter() {{ local_{}.push(", var_name), "(*item)".to_string())], "); }", ContainerPrefixLocation::PerConv))
1345 Some(("Vec::new(); for item in ", vec![(format!(".iter() {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1349 let contained_struct = if let Some(syn::Type::Path(p)) = single_contained {
1350 Some(self.resolve_path(&p.path, generics))
1351 } else if let Some(syn::Type::Reference(r)) = single_contained {
1352 if let syn::Type::Path(p) = &*r.elem {
1353 Some(self.resolve_path(&p.path, generics))
1356 if let Some(inner_path) = contained_struct {
1357 if self.c_type_has_inner_from_path(&inner_path) {
1358 let is_inner_ref = if let Some(syn::Type::Reference(_)) = single_contained { true } else { false };
1360 return Some(("if ", vec![
1361 (".is_none() { std::ptr::null() } else { ObjOps::nonnull_ptr_to_inner(".to_owned(),
1362 format!("({}{}.unwrap())", var_access, if is_inner_ref { "" } else { ".as_ref()" }))
1363 ], ") }", ContainerPrefixLocation::OutsideConv));
1365 return Some(("if ", vec![
1366 (".is_none() { std::ptr::null_mut() } else { ".to_owned(), format!("({}.unwrap())", var_access))
1367 ], " }", ContainerPrefixLocation::OutsideConv));
1369 } else if self.is_primitive(&inner_path) || self.c_type_from_path(&inner_path, false, false).is_none() {
1370 let inner_name = self.get_c_mangled_container_type(vec![single_contained.unwrap()], generics, "Option").unwrap();
1371 return Some(("if ", vec![
1372 (format!(".is_none() {{ {}::None }} else {{ {}::Some(",
1373 inner_name, inner_name),
1374 format!("{}.unwrap()", var_access))
1375 ], ") }", ContainerPrefixLocation::PerConv));
1377 // If c_type_from_path is some (ie there's a manual mapping for the inner
1378 // type), lean on write_empty_rust_val, below.
1381 if let Some(t) = single_contained {
1382 if let syn::Type::Reference(syn::TypeReference { elem, .. }) = t {
1383 if let syn::Type::Slice(_) = &**elem {
1384 return Some(("if ", vec![
1385 (".is_none() { SmartPtr::null() } else { SmartPtr::from_obj(".to_string(),
1386 format!("({}.unwrap())", var_access))
1387 ], ") }", ContainerPrefixLocation::PerConv));
1390 let mut v = Vec::new();
1391 self.write_empty_rust_val(generics, &mut v, t);
1392 let s = String::from_utf8(v).unwrap();
1393 return Some(("if ", vec![
1394 (format!(".is_none() {{ {} }} else {{ ", s), format!("({}.unwrap())", var_access))
1395 ], " }", ContainerPrefixLocation::PerConv));
1396 } else { unreachable!(); }
1402 /// only_contained_has_inner implies that there is only one contained element in the container
1403 /// and it has an inner field (ie is an "opaque" type we've defined).
1404 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)
1405 // Returns prefix + Vec<(prefix, var-name-to-inline-convert)> + suffix
1406 // expecting one element in the vec per generic type, each of which is inline-converted
1407 -> Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)> {
1409 "Result" if !is_ref => {
1411 vec![(".result_ok { true => Ok(".to_string(), format!("(*unsafe {{ Box::from_raw(<*mut _>::take_ptr(&mut {}.contents.result)) }})", var_access)),
1412 ("), false => Err(".to_string(), format!("(*unsafe {{ Box::from_raw(<*mut _>::take_ptr(&mut {}.contents.err)) }})", var_access))],
1413 ")}", ContainerPrefixLocation::PerConv))
1415 "Slice" if is_ref => {
1416 Some(("Vec::new(); for mut item in ", vec![(format!(".as_slice().iter() {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1419 Some(("Vec::new(); for mut item in ", vec![(format!(".into_rust().drain(..) {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1422 if let Some(syn::Type::Path(p)) = single_contained {
1423 let inner_path = self.resolve_path(&p.path, generics);
1424 if self.is_primitive(&inner_path) {
1425 return Some(("if ", vec![(".is_some() { Some(".to_string(), format!("{}.take()", var_access))], ") } else { None }", ContainerPrefixLocation::NoPrefix))
1426 } else if self.c_type_has_inner_from_path(&inner_path) {
1428 return Some(("if ", vec![(".inner.is_null() { None } else { Some((*".to_string(), format!("{}", var_access))], ").clone()) }", ContainerPrefixLocation::PerConv))
1430 return Some(("if ", vec![(".inner.is_null() { None } else { Some(".to_string(), format!("{}", var_access))], ") }", ContainerPrefixLocation::PerConv));
1435 if let Some(t) = single_contained {
1437 syn::Type::Reference(_)|syn::Type::Path(_)|syn::Type::Slice(_) => {
1438 let mut v = Vec::new();
1439 let ret_ref = self.write_empty_rust_val_check_suffix(generics, &mut v, t);
1440 let s = String::from_utf8(v).unwrap();
1442 EmptyValExpectedTy::ReferenceAsPointer =>
1443 return Some(("if ", vec![
1444 (format!("{} {{ None }} else {{ Some(", s), format!("unsafe {{ &mut *{} }}", var_access))
1445 ], ") }", ContainerPrefixLocation::NoPrefix)),
1446 EmptyValExpectedTy::OptionType =>
1447 return Some(("{ /* ", vec![
1448 (format!("*/ let {}_opt = {};", var_name, var_access),
1449 format!("}} if {}_opt{} {{ None }} else {{ Some({{ {}_opt.take()", var_name, s, var_name))
1450 ], ") } }", ContainerPrefixLocation::PerConv)),
1451 EmptyValExpectedTy::NonPointer =>
1452 return Some(("if ", vec![
1453 (format!("{} {{ None }} else {{ Some(", s), format!("{}", var_access))
1454 ], ") }", ContainerPrefixLocation::PerConv)),
1457 syn::Type::Tuple(_) => {
1458 return Some(("if ", vec![(".is_some() { Some(".to_string(), format!("{}.take()", var_access))], ") } else { None }", ContainerPrefixLocation::PerConv))
1460 _ => unimplemented!(),
1462 } else { unreachable!(); }
1468 /// Constructs a reference to the given type, possibly tweaking the type if relevant to make it
1469 /// convertable to C.
1470 pub fn create_ownable_reference(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> Option<syn::Type> {
1471 let default_value = Some(syn::Type::Reference(syn::TypeReference {
1472 and_token: syn::Token!(&)(Span::call_site()), lifetime: None, mutability: None,
1473 elem: Box::new(t.clone()) }));
1474 match generics.resolve_type(t) {
1475 syn::Type::Path(p) => {
1476 if let Some(resolved_path) = self.maybe_resolve_path(&p.path, generics) {
1477 if resolved_path != "Vec" { return default_value; }
1478 if p.path.segments.len() != 1 { unimplemented!(); }
1479 let only_seg = p.path.segments.iter().next().unwrap();
1480 if let syn::PathArguments::AngleBracketed(args) = &only_seg.arguments {
1481 if args.args.len() != 1 { unimplemented!(); }
1482 let inner_arg = args.args.iter().next().unwrap();
1483 if let syn::GenericArgument::Type(ty) = &inner_arg {
1484 let mut can_create = self.c_type_has_inner(&ty);
1485 if let syn::Type::Path(inner) = ty {
1486 if inner.path.segments.len() == 1 &&
1487 format!("{}", inner.path.segments[0].ident) == "Vec" {
1491 if !can_create { return default_value; }
1492 if let Some(inner_ty) = self.create_ownable_reference(&ty, generics) {
1493 return Some(syn::Type::Reference(syn::TypeReference {
1494 and_token: syn::Token![&](Span::call_site()),
1497 elem: Box::new(syn::Type::Slice(syn::TypeSlice {
1498 bracket_token: syn::token::Bracket { span: Span::call_site() },
1499 elem: Box::new(inner_ty)
1502 } else { return default_value; }
1503 } else { unimplemented!(); }
1504 } else { unimplemented!(); }
1505 } else { return None; }
1511 // *************************************************
1512 // *** Type definition during main.rs processing ***
1513 // *************************************************
1515 pub fn get_declared_type(&'a self, ident: &syn::Ident) -> Option<&'a DeclType<'c>> {
1516 self.types.get_declared_type(ident)
1518 /// Returns true if the object at the given path is mapped as X { inner: *mut origX, .. }.
1519 pub fn c_type_has_inner_from_path(&self, full_path: &str) -> bool {
1520 self.crate_types.opaques.get(full_path).is_some()
1523 /// Returns true if the object at the given path is mapped as X { inner: *mut origX, .. }.
1524 pub fn c_type_has_inner(&self, ty: &syn::Type) -> bool {
1526 syn::Type::Path(p) => {
1527 if let Some(full_path) = self.maybe_resolve_path(&p.path, None) {
1528 self.c_type_has_inner_from_path(&full_path)
1531 syn::Type::Reference(r) => {
1532 self.c_type_has_inner(&*r.elem)
1538 pub fn maybe_resolve_ident(&self, id: &syn::Ident) -> Option<String> {
1539 self.types.maybe_resolve_ident(id)
1542 pub fn maybe_resolve_non_ignored_ident(&self, id: &syn::Ident) -> Option<String> {
1543 self.types.maybe_resolve_non_ignored_ident(id)
1546 pub fn maybe_resolve_path(&self, p_arg: &syn::Path, generics: Option<&GenericTypes>) -> Option<String> {
1547 self.types.maybe_resolve_path(p_arg, generics)
1549 pub fn resolve_path(&self, p: &syn::Path, generics: Option<&GenericTypes>) -> String {
1550 self.maybe_resolve_path(p, generics).unwrap()
1553 // ***********************************
1554 // *** Original Rust Type Printing ***
1555 // ***********************************
1557 fn in_rust_prelude(resolved_path: &str) -> bool {
1558 match resolved_path {
1566 fn write_rust_path<W: std::io::Write>(&self, w: &mut W, generics_resolver: Option<&GenericTypes>, path: &syn::Path) {
1567 if let Some(resolved) = self.maybe_resolve_path(&path, generics_resolver) {
1568 if self.is_primitive(&resolved) {
1569 write!(w, "{}", path.get_ident().unwrap()).unwrap();
1571 // TODO: We should have a generic "is from a dependency" check here instead of
1572 // checking for "bitcoin" explicitly.
1573 if resolved.starts_with("bitcoin::") || Self::in_rust_prelude(&resolved) {
1574 write!(w, "{}", resolved).unwrap();
1575 // If we're printing a generic argument, it needs to reference the crate, otherwise
1576 // the original crate:
1577 } else if self.maybe_resolve_path(&path, None).as_ref() == Some(&resolved) {
1578 write!(w, "{}", self.real_rust_type_mapping(&resolved)).unwrap();
1580 write!(w, "crate::{}", resolved).unwrap();
1583 if let syn::PathArguments::AngleBracketed(args) = &path.segments.iter().last().unwrap().arguments {
1584 self.write_rust_generic_arg(w, generics_resolver, args.args.iter());
1587 if path.leading_colon.is_some() {
1588 write!(w, "::").unwrap();
1590 for (idx, seg) in path.segments.iter().enumerate() {
1591 if idx != 0 { write!(w, "::").unwrap(); }
1592 write!(w, "{}", seg.ident).unwrap();
1593 if let syn::PathArguments::AngleBracketed(args) = &seg.arguments {
1594 self.write_rust_generic_arg(w, generics_resolver, args.args.iter());
1599 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>) {
1600 let mut had_params = false;
1601 for (idx, arg) in generics.enumerate() {
1602 if idx != 0 { write!(w, ", ").unwrap(); } else { write!(w, "<").unwrap(); }
1605 syn::GenericParam::Lifetime(lt) => write!(w, "'{}", lt.lifetime.ident).unwrap(),
1606 syn::GenericParam::Type(t) => {
1607 write!(w, "{}", t.ident).unwrap();
1608 if t.colon_token.is_some() { write!(w, ":").unwrap(); }
1609 for (idx, bound) in t.bounds.iter().enumerate() {
1610 if idx != 0 { write!(w, " + ").unwrap(); }
1612 syn::TypeParamBound::Trait(tb) => {
1613 if tb.paren_token.is_some() || tb.lifetimes.is_some() { unimplemented!(); }
1614 self.write_rust_path(w, generics_resolver, &tb.path);
1616 _ => unimplemented!(),
1619 if t.eq_token.is_some() || t.default.is_some() { unimplemented!(); }
1621 _ => unimplemented!(),
1624 if had_params { write!(w, ">").unwrap(); }
1627 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>) {
1628 write!(w, "<").unwrap();
1629 for (idx, arg) in generics.enumerate() {
1630 if idx != 0 { write!(w, ", ").unwrap(); }
1632 syn::GenericArgument::Type(t) => self.write_rust_type(w, generics_resolver, t),
1633 _ => unimplemented!(),
1636 write!(w, ">").unwrap();
1638 pub fn write_rust_type<W: std::io::Write>(&self, w: &mut W, generics: Option<&GenericTypes>, t: &syn::Type) {
1640 syn::Type::Path(p) => {
1641 if p.qself.is_some() {
1644 self.write_rust_path(w, generics, &p.path);
1646 syn::Type::Reference(r) => {
1647 write!(w, "&").unwrap();
1648 if let Some(lft) = &r.lifetime {
1649 write!(w, "'{} ", lft.ident).unwrap();
1651 if r.mutability.is_some() {
1652 write!(w, "mut ").unwrap();
1654 self.write_rust_type(w, generics, &*r.elem);
1656 syn::Type::Array(a) => {
1657 write!(w, "[").unwrap();
1658 self.write_rust_type(w, generics, &a.elem);
1659 if let syn::Expr::Lit(l) = &a.len {
1660 if let syn::Lit::Int(i) = &l.lit {
1661 write!(w, "; {}]", i).unwrap();
1662 } else { unimplemented!(); }
1663 } else { unimplemented!(); }
1665 syn::Type::Slice(s) => {
1666 write!(w, "[").unwrap();
1667 self.write_rust_type(w, generics, &s.elem);
1668 write!(w, "]").unwrap();
1670 syn::Type::Tuple(s) => {
1671 write!(w, "(").unwrap();
1672 for (idx, t) in s.elems.iter().enumerate() {
1673 if idx != 0 { write!(w, ", ").unwrap(); }
1674 self.write_rust_type(w, generics, &t);
1676 write!(w, ")").unwrap();
1678 _ => unimplemented!(),
1682 /// Prints a constructor for something which is "uninitialized" (but obviously not actually
1683 /// unint'd memory).
1684 pub fn write_empty_rust_val<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type) {
1686 syn::Type::Reference(r) => {
1687 self.write_empty_rust_val(generics, w, &*r.elem)
1689 syn::Type::Path(p) => {
1690 let resolved = self.resolve_path(&p.path, generics);
1691 if self.crate_types.opaques.get(&resolved).is_some() {
1692 write!(w, "crate::{} {{ inner: std::ptr::null_mut(), is_owned: true }}", resolved).unwrap();
1694 // Assume its a manually-mapped C type, where we can just define an null() fn
1695 write!(w, "{}::null()", self.c_type_from_path(&resolved, false, false).unwrap()).unwrap();
1698 syn::Type::Array(a) => {
1699 if let syn::Expr::Lit(l) = &a.len {
1700 if let syn::Lit::Int(i) = &l.lit {
1701 if i.base10_digits().parse::<usize>().unwrap() < 32 {
1702 // Blindly assume that if we're trying to create an empty value for an
1703 // array < 32 entries that all-0s may be a valid state.
1706 let arrty = format!("[u8; {}]", i.base10_digits());
1707 write!(w, "{}", self.to_c_conversion_inline_prefix_from_path(&arrty, false, false).unwrap()).unwrap();
1708 write!(w, "[0; {}]", i.base10_digits()).unwrap();
1709 write!(w, "{}", self.to_c_conversion_inline_suffix_from_path(&arrty, false, false).unwrap()).unwrap();
1710 } else { unimplemented!(); }
1711 } else { unimplemented!(); }
1713 _ => unimplemented!(),
1717 fn is_real_type_array(&self, resolved_type: &str) -> Option<syn::Type> {
1718 if let Some(real_ty) = self.c_type_from_path(&resolved_type, true, false) {
1719 if real_ty.ends_with("]") && real_ty.starts_with("*const [u8; ") {
1720 let mut split = real_ty.split("; ");
1721 split.next().unwrap();
1722 let tail_str = split.next().unwrap();
1723 assert!(split.next().is_none());
1724 let len = usize::from_str_radix(&tail_str[..tail_str.len() - 1], 10).unwrap();
1725 Some(parse_quote!([u8; #len]))
1730 /// Prints a suffix to determine if a variable is empty (ie was set by write_empty_rust_val).
1731 /// See EmptyValExpectedTy for information on return types.
1732 fn write_empty_rust_val_check_suffix<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type) -> EmptyValExpectedTy {
1734 syn::Type::Reference(r) => {
1735 return self.write_empty_rust_val_check_suffix(generics, w, &*r.elem);
1737 syn::Type::Path(p) => {
1738 let resolved = self.resolve_path(&p.path, generics);
1739 if let Some(arr_ty) = self.is_real_type_array(&resolved) {
1740 write!(w, ".data").unwrap();
1741 return self.write_empty_rust_val_check_suffix(generics, w, &arr_ty);
1743 if self.crate_types.opaques.get(&resolved).is_some() {
1744 write!(w, ".inner.is_null()").unwrap();
1745 EmptyValExpectedTy::NonPointer
1747 if let Some(suffix) = self.empty_val_check_suffix_from_path(&resolved) {
1748 write!(w, "{}", suffix).unwrap();
1749 // We may eventually need to allow empty_val_check_suffix_from_path to specify if we need a deref or not
1750 EmptyValExpectedTy::NonPointer
1752 write!(w, ".is_none()").unwrap();
1753 EmptyValExpectedTy::OptionType
1757 syn::Type::Array(a) => {
1758 if let syn::Expr::Lit(l) = &a.len {
1759 if let syn::Lit::Int(i) = &l.lit {
1760 write!(w, " == [0; {}]", i.base10_digits()).unwrap();
1761 EmptyValExpectedTy::NonPointer
1762 } else { unimplemented!(); }
1763 } else { unimplemented!(); }
1765 syn::Type::Slice(_) => {
1766 // Option<[]> always implies that we want to treat len() == 0 differently from
1767 // None, so we always map an Option<[]> into a pointer.
1768 write!(w, " == std::ptr::null_mut()").unwrap();
1769 EmptyValExpectedTy::ReferenceAsPointer
1771 _ => unimplemented!(),
1775 /// Prints a suffix to determine if a variable is empty (ie was set by write_empty_rust_val).
1776 pub fn write_empty_rust_val_check<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type, var_access: &str) {
1778 syn::Type::Reference(r) => {
1779 self.write_empty_rust_val_check(generics, w, &*r.elem, var_access);
1781 syn::Type::Path(_) => {
1782 write!(w, "{}", var_access).unwrap();
1783 self.write_empty_rust_val_check_suffix(generics, w, t);
1785 syn::Type::Array(a) => {
1786 if let syn::Expr::Lit(l) = &a.len {
1787 if let syn::Lit::Int(i) = &l.lit {
1788 let arrty = format!("[u8; {}]", i.base10_digits());
1789 // We don't (yet) support a new-var conversion here.
1790 assert!(self.from_c_conversion_new_var_from_path(&arrty, false).is_none());
1792 self.from_c_conversion_prefix_from_path(&arrty, false).unwrap(),
1794 self.from_c_conversion_suffix_from_path(&arrty, false).unwrap()).unwrap();
1795 self.write_empty_rust_val_check_suffix(generics, w, t);
1796 } else { unimplemented!(); }
1797 } else { unimplemented!(); }
1799 _ => unimplemented!(),
1803 // ********************************
1804 // *** Type conversion printing ***
1805 // ********************************
1807 /// Returns true we if can just skip passing this to C entirely
1808 pub fn skip_arg(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> bool {
1810 syn::Type::Path(p) => {
1811 if p.qself.is_some() { unimplemented!(); }
1812 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
1813 self.skip_path(&full_path)
1816 syn::Type::Reference(r) => {
1817 self.skip_arg(&*r.elem, generics)
1822 pub fn no_arg_to_rust<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
1824 syn::Type::Path(p) => {
1825 if p.qself.is_some() { unimplemented!(); }
1826 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
1827 write!(w, "{}", self.no_arg_path_to_rust(&full_path)).unwrap();
1830 syn::Type::Reference(r) => {
1831 self.no_arg_to_rust(w, &*r.elem, generics);
1837 fn write_conversion_inline_intern<W: std::io::Write,
1838 LP: Fn(&str, bool, bool) -> Option<String>, DL: Fn(&mut W, &DeclType, &str, bool, bool), SC: Fn(bool, Option<&str>) -> String>
1839 (&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, is_ref: bool, is_mut: bool, ptr_for_ref: bool,
1840 tupleconv: &str, prefix: bool, sliceconv: SC, path_lookup: LP, decl_lookup: DL) {
1841 match generics.resolve_type(t) {
1842 syn::Type::Reference(r) => {
1843 self.write_conversion_inline_intern(w, &*r.elem, generics, true, r.mutability.is_some(),
1844 ptr_for_ref, tupleconv, prefix, sliceconv, path_lookup, decl_lookup);
1846 syn::Type::Path(p) => {
1847 if p.qself.is_some() {
1851 let resolved_path = self.resolve_path(&p.path, generics);
1852 if let Some(aliased_type) = self.crate_types.type_aliases.get(&resolved_path) {
1853 return self.write_conversion_inline_intern(w, aliased_type, None, is_ref, is_mut, ptr_for_ref, tupleconv, prefix, sliceconv, path_lookup, decl_lookup);
1854 } else if self.is_primitive(&resolved_path) {
1855 if is_ref && prefix {
1856 write!(w, "*").unwrap();
1858 } else if let Some(c_type) = path_lookup(&resolved_path, is_ref, ptr_for_ref) {
1859 write!(w, "{}", c_type).unwrap();
1860 } else if let Some((_, generics)) = self.crate_types.opaques.get(&resolved_path) {
1861 decl_lookup(w, &DeclType::StructImported { generic_param_count: generics.params.len() }, &resolved_path, is_ref, is_mut);
1862 } else if self.crate_types.mirrored_enums.get(&resolved_path).is_some() {
1863 decl_lookup(w, &DeclType::MirroredEnum, &resolved_path, is_ref, is_mut);
1864 } else if let Some(t) = self.crate_types.traits.get(&resolved_path) {
1865 decl_lookup(w, &DeclType::Trait(t), &resolved_path, is_ref, is_mut);
1866 } else if let Some(ident) = single_ident_generic_path_to_ident(&p.path) {
1867 if let Some(decl_type) = self.types.maybe_resolve_declared(ident) {
1868 decl_lookup(w, decl_type, &self.maybe_resolve_ident(ident).unwrap(), is_ref, is_mut);
1869 } else { unimplemented!(); }
1870 } else { unimplemented!(); }
1872 syn::Type::Array(a) => {
1873 // We assume all arrays contain only [int_literal; X]s.
1874 // This may result in some outputs not compiling.
1875 if let syn::Expr::Lit(l) = &a.len {
1876 if let syn::Lit::Int(i) = &l.lit {
1877 write!(w, "{}", path_lookup(&format!("[u8; {}]", i.base10_digits()), is_ref, ptr_for_ref).unwrap()).unwrap();
1878 } else { unimplemented!(); }
1879 } else { unimplemented!(); }
1881 syn::Type::Slice(s) => {
1882 // We assume all slices contain only literals or references.
1883 // This may result in some outputs not compiling.
1884 if let syn::Type::Path(p) = &*s.elem {
1885 let resolved = self.resolve_path(&p.path, generics);
1886 assert!(self.is_primitive(&resolved));
1887 write!(w, "{}", path_lookup("[u8]", is_ref, ptr_for_ref).unwrap()).unwrap();
1888 } else if let syn::Type::Reference(r) = &*s.elem {
1889 if let syn::Type::Path(p) = &*r.elem {
1890 write!(w, "{}", sliceconv(self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)), None)).unwrap();
1891 } else if let syn::Type::Slice(_) = &*r.elem {
1892 write!(w, "{}", sliceconv(false, None)).unwrap();
1893 } else { unimplemented!(); }
1894 } else if let syn::Type::Tuple(t) = &*s.elem {
1895 assert!(!t.elems.is_empty());
1897 write!(w, "{}", sliceconv(false, None)).unwrap();
1899 let mut needs_map = false;
1900 for e in t.elems.iter() {
1901 if let syn::Type::Reference(_) = e {
1906 let mut map_str = Vec::new();
1907 write!(&mut map_str, ".map(|(").unwrap();
1908 for i in 0..t.elems.len() {
1909 write!(&mut map_str, "{}{}", if i != 0 { ", " } else { "" }, ('a' as u8 + i as u8) as char).unwrap();
1911 write!(&mut map_str, ")| (").unwrap();
1912 for (idx, e) in t.elems.iter().enumerate() {
1913 if let syn::Type::Reference(_) = e {
1914 write!(&mut map_str, "{}{}", if idx != 0 { ", " } else { "" }, (idx as u8 + 'a' as u8) as char).unwrap();
1915 } else if let syn::Type::Path(_) = e {
1916 write!(&mut map_str, "{}*{}", if idx != 0 { ", " } else { "" }, (idx as u8 + 'a' as u8) as char).unwrap();
1917 } else { unimplemented!(); }
1919 write!(&mut map_str, "))").unwrap();
1920 write!(w, "{}", sliceconv(false, Some(&String::from_utf8(map_str).unwrap()))).unwrap();
1922 write!(w, "{}", sliceconv(false, None)).unwrap();
1925 } else { unimplemented!(); }
1927 syn::Type::Tuple(t) => {
1928 if t.elems.is_empty() {
1929 // cbindgen has poor support for (), see, eg https://github.com/eqrion/cbindgen/issues/527
1930 // so work around it by just pretending its a 0u8
1931 write!(w, "{}", tupleconv).unwrap();
1933 if prefix { write!(w, "local_").unwrap(); }
1936 _ => unimplemented!(),
1940 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) {
1941 self.write_conversion_inline_intern(w, t, generics, is_ref, false, ptr_for_ref, "() /*", true, |_, _| "local_".to_owned(),
1942 |a, b, c| self.to_c_conversion_inline_prefix_from_path(a, b, c),
1943 |w, decl_type, decl_path, is_ref, _is_mut| {
1945 DeclType::MirroredEnum if is_ref && ptr_for_ref => write!(w, "crate::{}::from_native(", decl_path).unwrap(),
1946 DeclType::MirroredEnum if is_ref => write!(w, "&crate::{}::from_native(", decl_path).unwrap(),
1947 DeclType::MirroredEnum => write!(w, "crate::{}::native_into(", decl_path).unwrap(),
1948 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if is_ref && from_ptr => {
1949 if !ptr_for_ref { write!(w, "&").unwrap(); }
1950 write!(w, "crate::{} {{ inner: unsafe {{ (", decl_path).unwrap()
1952 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if is_ref => {
1953 if !ptr_for_ref { write!(w, "&").unwrap(); }
1954 write!(w, "crate::{} {{ inner: unsafe {{ ObjOps::nonnull_ptr_to_inner((", decl_path).unwrap()
1956 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref && from_ptr =>
1957 write!(w, "crate::{} {{ inner: ", decl_path).unwrap(),
1958 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref =>
1959 write!(w, "crate::{} {{ inner: ObjOps::heap_alloc(", decl_path).unwrap(),
1960 DeclType::Trait(_) if is_ref => write!(w, "").unwrap(),
1961 DeclType::Trait(_) if !is_ref => write!(w, "Into::into(").unwrap(),
1962 _ => panic!("{:?}", decl_path),
1966 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) {
1967 self.write_to_c_conversion_inline_prefix_inner(w, t, generics, false, ptr_for_ref, false);
1969 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) {
1970 self.write_conversion_inline_intern(w, t, generics, is_ref, false, ptr_for_ref, "*/", false, |_, _| ".into()".to_owned(),
1971 |a, b, c| self.to_c_conversion_inline_suffix_from_path(a, b, c),
1972 |w, decl_type, full_path, is_ref, _is_mut| match decl_type {
1973 DeclType::MirroredEnum => write!(w, ")").unwrap(),
1974 DeclType::EnumIgnored { generic_param_count }|DeclType::StructImported { generic_param_count } if is_ref => {
1975 write!(w, " as *const {}<", full_path).unwrap();
1976 for _ in 0..*generic_param_count { write!(w, "_, ").unwrap(); }
1978 write!(w, ">) as *mut _ }}, is_owned: false }}").unwrap();
1980 write!(w, ">) as *mut _) }}, is_owned: false }}").unwrap();
1983 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref && from_ptr =>
1984 write!(w, ", is_owned: true }}").unwrap(),
1985 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref => write!(w, "), is_owned: true }}").unwrap(),
1986 DeclType::Trait(_) if is_ref => {},
1987 DeclType::Trait(_) => {
1988 // This is used when we're converting a concrete Rust type into a C trait
1989 // for use when a Rust trait method returns an associated type.
1990 // Because all of our C traits implement From<RustTypesImplementingTraits>
1991 // we can just call .into() here and be done.
1992 write!(w, ")").unwrap()
1994 _ => unimplemented!(),
1997 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) {
1998 self.write_to_c_conversion_inline_suffix_inner(w, t, generics, false, ptr_for_ref, false);
2001 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) {
2002 self.write_conversion_inline_intern(w, t, generics, is_ref, false, false, "() /*", true, |_, _| "&local_".to_owned(),
2003 |a, b, _c| self.from_c_conversion_prefix_from_path(a, b),
2004 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
2005 DeclType::StructImported {..} if is_ref => write!(w, "").unwrap(),
2006 DeclType::StructImported {..} if !is_ref => write!(w, "*unsafe {{ Box::from_raw(").unwrap(),
2007 DeclType::MirroredEnum if is_ref => write!(w, "&").unwrap(),
2008 DeclType::MirroredEnum => {},
2009 DeclType::Trait(_) => {},
2010 _ => unimplemented!(),
2013 pub fn write_from_c_conversion_prefix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2014 self.write_from_c_conversion_prefix_inner(w, t, generics, false, false);
2016 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) {
2017 self.write_conversion_inline_intern(w, t, generics, is_ref, false, false, "*/", false,
2018 |has_inner, map_str_opt| match (has_inner, map_str_opt) {
2019 (false, Some(map_str)) => format!(".iter(){}.collect::<Vec<_>>()[..]", map_str),
2020 (false, None) => ".iter().collect::<Vec<_>>()[..]".to_owned(),
2021 (true, None) => "[..]".to_owned(),
2022 (true, Some(_)) => unreachable!(),
2024 |a, b, _c| self.from_c_conversion_suffix_from_path(a, b),
2025 |w, decl_type, _full_path, is_ref, is_mut| match decl_type {
2026 DeclType::StructImported {..} if is_ref && ptr_for_ref => write!(w, "XXX unimplemented").unwrap(),
2027 DeclType::StructImported {..} if is_mut && is_ref => write!(w, ".get_native_mut_ref()").unwrap(),
2028 DeclType::StructImported {..} if is_ref => write!(w, ".get_native_ref()").unwrap(),
2029 DeclType::StructImported {..} if !is_ref => write!(w, ".take_inner()) }}").unwrap(),
2030 DeclType::MirroredEnum if is_ref => write!(w, ".to_native()").unwrap(),
2031 DeclType::MirroredEnum => write!(w, ".into_native()").unwrap(),
2032 DeclType::Trait(_) => {},
2033 _ => unimplemented!(),
2036 pub fn write_from_c_conversion_suffix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2037 self.write_from_c_conversion_suffix_inner(w, t, generics, false, false);
2039 // Note that compared to the above conversion functions, the following two are generally
2040 // significantly undertested:
2041 pub fn write_from_c_conversion_to_ref_prefix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2042 self.write_conversion_inline_intern(w, t, generics, false, false, false, "() /*", true, |_, _| "&local_".to_owned(),
2044 if let Some(conv) = self.from_c_conversion_prefix_from_path(a, b) {
2045 Some(format!("&{}", conv))
2048 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
2049 DeclType::StructImported {..} if !is_ref => write!(w, "").unwrap(),
2050 _ => unimplemented!(),
2053 pub fn write_from_c_conversion_to_ref_suffix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2054 self.write_conversion_inline_intern(w, t, generics, false, false, false, "*/", false,
2055 |has_inner, map_str_opt| match (has_inner, map_str_opt) {
2056 (false, Some(map_str)) => format!(".iter(){}.collect::<Vec<_>>()[..]", map_str),
2057 (false, None) => ".iter().collect::<Vec<_>>()[..]".to_owned(),
2058 (true, None) => "[..]".to_owned(),
2059 (true, Some(_)) => unreachable!(),
2061 |a, b, _c| self.from_c_conversion_suffix_from_path(a, b),
2062 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
2063 DeclType::StructImported {..} if !is_ref => write!(w, ".get_native_ref()").unwrap(),
2064 _ => unimplemented!(),
2068 fn write_conversion_new_var_intern<'b, W: std::io::Write,
2069 LP: Fn(&str, bool) -> Option<(&str, &str)>,
2070 LC: Fn(&str, bool, Option<&syn::Type>, &syn::Ident, &str) -> Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)>,
2071 VP: Fn(&mut W, &syn::Type, Option<&GenericTypes>, bool, bool, bool),
2072 VS: Fn(&mut W, &syn::Type, Option<&GenericTypes>, bool, bool, bool)>
2073 (&self, w: &mut W, ident: &syn::Ident, var: &str, t: &syn::Type, generics: Option<&GenericTypes>,
2074 mut is_ref: bool, mut ptr_for_ref: bool, to_c: bool, from_ownable_ref: bool,
2075 path_lookup: &LP, container_lookup: &LC, var_prefix: &VP, var_suffix: &VS) -> bool {
2077 macro_rules! convert_container {
2078 ($container_type: expr, $args_len: expr, $args_iter: expr) => { {
2079 // For slices (and Options), we refuse to directly map them as is_ref when they
2080 // aren't opaque types containing an inner pointer. This is due to the fact that,
2081 // in both cases, the actual higher-level type is non-is_ref.
2082 let ty_has_inner = if $args_len == 1 {
2083 let ty = $args_iter().next().unwrap();
2084 if $container_type == "Slice" && to_c {
2085 // "To C ptr_for_ref" means "return the regular object with is_owned
2086 // set to false", which is totally what we want in a slice if we're about to
2087 // set ty_has_inner.
2090 if let syn::Type::Reference(t) = ty {
2091 if let syn::Type::Path(p) = &*t.elem {
2092 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
2094 } else if let syn::Type::Path(p) = ty {
2095 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
2099 // Options get a bunch of special handling, since in general we map Option<>al
2100 // types into the same C type as non-Option-wrapped types. This ends up being
2101 // pretty manual here and most of the below special-cases are for Options.
2102 let mut needs_ref_map = false;
2103 let mut only_contained_type = None;
2104 let mut only_contained_type_nonref = None;
2105 let mut only_contained_has_inner = false;
2106 let mut contains_slice = false;
2108 only_contained_has_inner = ty_has_inner;
2109 let arg = $args_iter().next().unwrap();
2110 if let syn::Type::Reference(t) = arg {
2111 only_contained_type = Some(arg);
2112 only_contained_type_nonref = Some(&*t.elem);
2113 if let syn::Type::Path(_) = &*t.elem {
2115 } else if let syn::Type::Slice(_) = &*t.elem {
2116 contains_slice = true;
2117 } else { return false; }
2118 // If the inner element contains an inner pointer, we will just use that,
2119 // avoiding the need to map elements to references. Otherwise we'll need to
2120 // do an extra mapping step.
2121 needs_ref_map = !only_contained_has_inner && $container_type == "Option";
2123 only_contained_type = Some(arg);
2124 only_contained_type_nonref = Some(arg);
2128 if let Some((prefix, conversions, suffix, prefix_location)) = container_lookup(&$container_type, is_ref && ty_has_inner, only_contained_type, ident, var) {
2129 assert_eq!(conversions.len(), $args_len);
2130 write!(w, "let mut local_{}{} = ", ident,
2131 if (!to_c && needs_ref_map) || (to_c && $container_type == "Option" && contains_slice) {"_base"} else { "" }).unwrap();
2132 if prefix_location == ContainerPrefixLocation::OutsideConv {
2133 var_prefix(w, $args_iter().next().unwrap(), generics, is_ref, ptr_for_ref, true);
2135 write!(w, "{}{}", prefix, var).unwrap();
2137 for ((pfx, var_name), (idx, ty)) in conversions.iter().zip($args_iter().enumerate()) {
2138 let mut var = std::io::Cursor::new(Vec::new());
2139 write!(&mut var, "{}", var_name).unwrap();
2140 let var_access = String::from_utf8(var.into_inner()).unwrap();
2142 let conv_ty = if needs_ref_map { only_contained_type_nonref.as_ref().unwrap() } else { ty };
2144 write!(w, "{} {{ ", pfx).unwrap();
2145 let new_var_name = format!("{}_{}", ident, idx);
2146 let new_var = self.write_conversion_new_var_intern(w, &format_ident!("{}", new_var_name),
2147 &var_access, conv_ty, generics, contains_slice || (is_ref && ty_has_inner), ptr_for_ref,
2148 to_c, from_ownable_ref, path_lookup, container_lookup, var_prefix, var_suffix);
2149 if new_var { write!(w, " ").unwrap(); }
2151 if prefix_location == ContainerPrefixLocation::PerConv {
2152 var_prefix(w, conv_ty, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2153 } else if !is_ref && !needs_ref_map && to_c && only_contained_has_inner {
2154 write!(w, "ObjOps::heap_alloc(").unwrap();
2157 write!(w, "{}{}", if contains_slice && !to_c { "local_" } else { "" }, if new_var { new_var_name } else { var_access }).unwrap();
2158 if prefix_location == ContainerPrefixLocation::PerConv {
2159 var_suffix(w, conv_ty, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2160 } else if !is_ref && !needs_ref_map && to_c && only_contained_has_inner {
2161 write!(w, ")").unwrap();
2163 write!(w, " }}").unwrap();
2165 write!(w, "{}", suffix).unwrap();
2166 if prefix_location == ContainerPrefixLocation::OutsideConv {
2167 var_suffix(w, $args_iter().next().unwrap(), generics, is_ref, ptr_for_ref, true);
2169 write!(w, ";").unwrap();
2170 if !to_c && needs_ref_map {
2171 write!(w, " let mut local_{} = local_{}_base.as_ref()", ident, ident).unwrap();
2173 write!(w, ".map(|a| &a[..])").unwrap();
2175 write!(w, ";").unwrap();
2176 } else if to_c && $container_type == "Option" && contains_slice {
2177 write!(w, " let mut local_{} = *local_{}_base;", ident, ident).unwrap();
2184 match generics.resolve_type(t) {
2185 syn::Type::Reference(r) => {
2186 if let syn::Type::Slice(_) = &*r.elem {
2187 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)
2189 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)
2192 syn::Type::Path(p) => {
2193 if p.qself.is_some() {
2196 let resolved_path = self.resolve_path(&p.path, generics);
2197 if let Some(aliased_type) = self.crate_types.type_aliases.get(&resolved_path) {
2198 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);
2200 if self.is_known_container(&resolved_path, is_ref) || self.is_path_transparent_container(&p.path, generics, is_ref) {
2201 if let syn::PathArguments::AngleBracketed(args) = &p.path.segments.iter().next().unwrap().arguments {
2202 convert_container!(resolved_path, args.args.len(), || args.args.iter().map(|arg| {
2203 if let syn::GenericArgument::Type(ty) = arg {
2204 generics.resolve_type(ty)
2205 } else { unimplemented!(); }
2207 } else { unimplemented!(); }
2209 if self.is_primitive(&resolved_path) {
2211 } else if let Some(ty_ident) = single_ident_generic_path_to_ident(&p.path) {
2212 if let Some((prefix, suffix)) = path_lookup(&resolved_path, is_ref) {
2213 write!(w, "let mut local_{} = {}{}{};", ident, prefix, var, suffix).unwrap();
2215 } else if self.types.maybe_resolve_declared(ty_ident).is_some() {
2220 syn::Type::Array(_) => {
2221 // We assume all arrays contain only primitive types.
2222 // This may result in some outputs not compiling.
2225 syn::Type::Slice(s) => {
2226 if let syn::Type::Path(p) = &*s.elem {
2227 let resolved = self.resolve_path(&p.path, generics);
2228 assert!(self.is_primitive(&resolved));
2229 let slice_path = format!("[{}]", resolved);
2230 if let Some((prefix, suffix)) = path_lookup(&slice_path, true) {
2231 write!(w, "let mut local_{} = {}{}{};", ident, prefix, var, suffix).unwrap();
2234 } else if let syn::Type::Reference(ty) = &*s.elem {
2235 let tyref = if from_ownable_ref || !to_c { [&*ty.elem] } else { [&*s.elem] };
2237 convert_container!("Slice", 1, || tyref.iter().map(|t| generics.resolve_type(*t)));
2238 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2239 } else if let syn::Type::Tuple(t) = &*s.elem {
2240 // When mapping into a temporary new var, we need to own all the underlying objects.
2241 // Thus, we drop any references inside the tuple and convert with non-reference types.
2242 let mut elems = syn::punctuated::Punctuated::new();
2243 for elem in t.elems.iter() {
2244 if let syn::Type::Reference(r) = elem {
2245 elems.push((*r.elem).clone());
2247 elems.push(elem.clone());
2250 let ty = [syn::Type::Tuple(syn::TypeTuple {
2251 paren_token: t.paren_token, elems
2255 convert_container!("Slice", 1, || ty.iter());
2256 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2257 } else { unimplemented!() }
2259 syn::Type::Tuple(t) => {
2260 if !t.elems.is_empty() {
2261 // We don't (yet) support tuple elements which cannot be converted inline
2262 write!(w, "let (").unwrap();
2263 for idx in 0..t.elems.len() {
2264 if idx != 0 { write!(w, ", ").unwrap(); }
2265 write!(w, "{} orig_{}_{}", if is_ref { "ref" } else { "mut" }, ident, idx).unwrap();
2267 write!(w, ") = {}{}; ", var, if !to_c { ".to_rust()" } else { "" }).unwrap();
2268 // Like other template types, tuples are always mapped as their non-ref
2269 // versions for types which have different ref mappings. Thus, we convert to
2270 // non-ref versions and handle opaque types with inner pointers manually.
2271 for (idx, elem) in t.elems.iter().enumerate() {
2272 if let syn::Type::Path(p) = elem {
2273 let v_name = format!("orig_{}_{}", ident, idx);
2274 let tuple_elem_ident = format_ident!("{}", &v_name);
2275 if self.write_conversion_new_var_intern(w, &tuple_elem_ident, &v_name, elem, generics,
2276 false, ptr_for_ref, to_c, from_ownable_ref,
2277 path_lookup, container_lookup, var_prefix, var_suffix) {
2278 write!(w, " ").unwrap();
2279 // Opaque types with inner pointers shouldn't ever create new stack
2280 // variables, so we don't handle it and just assert that it doesn't
2282 assert!(!self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)));
2286 write!(w, "let mut local_{} = (", ident).unwrap();
2287 for (idx, elem) in t.elems.iter().enumerate() {
2288 let ty_has_inner = {
2290 // "To C ptr_for_ref" means "return the regular object with
2291 // is_owned set to false", which is totally what we want
2292 // if we're about to set ty_has_inner.
2295 if let syn::Type::Reference(t) = elem {
2296 if let syn::Type::Path(p) = &*t.elem {
2297 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
2299 } else if let syn::Type::Path(p) = elem {
2300 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
2303 if idx != 0 { write!(w, ", ").unwrap(); }
2304 var_prefix(w, elem, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2305 if is_ref && ty_has_inner {
2306 // For ty_has_inner, the regular var_prefix mapping will take a
2307 // reference, so deref once here to make sure we keep the original ref.
2308 write!(w, "*").unwrap();
2310 write!(w, "orig_{}_{}", ident, idx).unwrap();
2311 if is_ref && !ty_has_inner {
2312 // If we don't have an inner variable's reference to maintain, just
2313 // hope the type is Clonable and use that.
2314 write!(w, ".clone()").unwrap();
2316 var_suffix(w, elem, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2318 write!(w, "){};", if to_c { ".into()" } else { "" }).unwrap();
2322 _ => unimplemented!(),
2326 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 {
2327 self.write_conversion_new_var_intern(w, ident, var_access, t, generics, false, ptr_for_ref, true, from_ownable_ref,
2328 &|a, b| self.to_c_conversion_new_var_from_path(a, b),
2329 &|a, b, c, d, e| self.to_c_conversion_container_new_var(generics, a, b, c, d, e),
2330 // We force ptr_for_ref here since we can't generate a ref on one line and use it later
2331 &|a, b, c, d, e, f| self.write_to_c_conversion_inline_prefix_inner(a, b, c, d, e, f),
2332 &|a, b, c, d, e, f| self.write_to_c_conversion_inline_suffix_inner(a, b, c, d, e, f))
2334 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 {
2335 self.write_to_c_conversion_new_var_inner(w, ident, &format!("{}", ident), t, generics, ptr_for_ref, false)
2337 /// Prints new-var conversion for an "ownable_ref" type, ie prints conversion for
2338 /// `create_ownable_reference(t)`, not `t` itself.
2339 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 {
2340 self.write_to_c_conversion_new_var_inner(w, ident, &format!("{}", ident), t, generics, true, true)
2342 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 {
2343 self.write_conversion_new_var_intern(w, ident, &format!("{}", ident), t, generics, false, false, false, false,
2344 &|a, b| self.from_c_conversion_new_var_from_path(a, b),
2345 &|a, b, c, d, e| self.from_c_conversion_container_new_var(generics, a, b, c, d, e),
2346 // We force ptr_for_ref here since we can't generate a ref on one line and use it later
2347 &|a, b, c, d, e, _f| self.write_from_c_conversion_prefix_inner(a, b, c, d, e),
2348 &|a, b, c, d, e, _f| self.write_from_c_conversion_suffix_inner(a, b, c, d, e))
2351 // ******************************************************
2352 // *** C Container Type Equivalent and alias Printing ***
2353 // ******************************************************
2355 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 {
2356 for (idx, t) in args.enumerate() {
2358 write!(w, ", ").unwrap();
2360 if let syn::Type::Reference(r_arg) = t {
2361 assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
2363 if !self.write_c_type_intern(w, &*r_arg.elem, generics, false, false, false, false) { return false; }
2365 // While write_c_type_intern, above is correct, we don't want to blindly convert a
2366 // reference to something stupid, so check that the container is either opaque or a
2367 // predefined type (currently only Transaction).
2368 if let syn::Type::Path(p_arg) = &*r_arg.elem {
2369 let resolved = self.resolve_path(&p_arg.path, generics);
2370 assert!(self.crate_types.opaques.get(&resolved).is_some() ||
2371 self.c_type_from_path(&resolved, true, true).is_some(), "Template generics should be opaque or have a predefined mapping");
2372 } else { unimplemented!(); }
2373 } else if let syn::Type::Path(p_arg) = t {
2374 if let Some(resolved) = self.maybe_resolve_path(&p_arg.path, generics) {
2375 if !self.is_primitive(&resolved) {
2376 assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
2379 assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
2381 if !self.write_c_type_intern(w, t, generics, false, false, false, false) { return false; }
2383 assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
2384 if !self.write_c_type_intern(w, t, generics, false, false, false, false) { return false; }
2389 fn check_create_container(&self, mangled_container: String, container_type: &str, args: Vec<&syn::Type>, generics: Option<&GenericTypes>, is_ref: bool) -> bool {
2390 if !self.crate_types.templates_defined.borrow().get(&mangled_container).is_some() {
2391 let mut created_container: Vec<u8> = Vec::new();
2393 if container_type == "Result" {
2394 let mut a_ty: Vec<u8> = Vec::new();
2395 if let syn::Type::Tuple(tup) = args.iter().next().unwrap() {
2396 if tup.elems.is_empty() {
2397 write!(&mut a_ty, "()").unwrap();
2399 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t).take(1), generics, is_ref) { return false; }
2402 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t).take(1), generics, is_ref) { return false; }
2405 let mut b_ty: Vec<u8> = Vec::new();
2406 if let syn::Type::Tuple(tup) = args.iter().skip(1).next().unwrap() {
2407 if tup.elems.is_empty() {
2408 write!(&mut b_ty, "()").unwrap();
2410 if !self.write_template_generics(&mut b_ty, &mut args.iter().map(|t| *t).skip(1), generics, is_ref) { return false; }
2413 if !self.write_template_generics(&mut b_ty, &mut args.iter().map(|t| *t).skip(1), generics, is_ref) { return false; }
2416 let ok_str = String::from_utf8(a_ty).unwrap();
2417 let err_str = String::from_utf8(b_ty).unwrap();
2418 let is_clonable = self.is_clonable(&ok_str) && self.is_clonable(&err_str);
2419 write_result_block(&mut created_container, &mangled_container, &ok_str, &err_str, is_clonable);
2421 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2423 } else if container_type == "Vec" {
2424 let mut a_ty: Vec<u8> = Vec::new();
2425 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t), generics, is_ref) { return false; }
2426 let ty = String::from_utf8(a_ty).unwrap();
2427 let is_clonable = self.is_clonable(&ty);
2428 write_vec_block(&mut created_container, &mangled_container, &ty, is_clonable);
2430 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2432 } else if container_type.ends_with("Tuple") {
2433 let mut tuple_args = Vec::new();
2434 let mut is_clonable = true;
2435 for arg in args.iter() {
2436 let mut ty: Vec<u8> = Vec::new();
2437 if !self.write_template_generics(&mut ty, &mut [arg].iter().map(|t| **t), generics, is_ref) { return false; }
2438 let ty_str = String::from_utf8(ty).unwrap();
2439 if !self.is_clonable(&ty_str) {
2440 is_clonable = false;
2442 tuple_args.push(ty_str);
2444 write_tuple_block(&mut created_container, &mangled_container, &tuple_args, is_clonable);
2446 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2448 } else if container_type == "Option" {
2449 let mut a_ty: Vec<u8> = Vec::new();
2450 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t), generics, is_ref) { return false; }
2451 let ty = String::from_utf8(a_ty).unwrap();
2452 let is_clonable = self.is_clonable(&ty);
2453 write_option_block(&mut created_container, &mangled_container, &ty, is_clonable);
2455 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2460 self.crate_types.write_new_template(mangled_container.clone(), true, &created_container);
2464 fn path_to_generic_args(path: &syn::Path) -> Vec<&syn::Type> {
2465 if let syn::PathArguments::AngleBracketed(args) = &path.segments.iter().next().unwrap().arguments {
2466 args.args.iter().map(|gen| if let syn::GenericArgument::Type(t) = gen { t } else { unimplemented!() }).collect()
2467 } else { unimplemented!(); }
2469 fn write_c_mangled_container_path_intern<W: std::io::Write>
2470 (&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 {
2471 let mut mangled_type: Vec<u8> = Vec::new();
2472 if !self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) {
2473 write!(w, "C{}_", ident).unwrap();
2474 write!(mangled_type, "C{}_", ident).unwrap();
2475 } else { assert_eq!(args.len(), 1); }
2476 for arg in args.iter() {
2477 macro_rules! write_path {
2478 ($p_arg: expr, $extra_write: expr) => {
2479 if let Some(subtype) = self.maybe_resolve_path(&$p_arg.path, generics) {
2480 if self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) {
2482 if self.c_type_has_inner_from_path(&subtype) {
2483 if !self.write_c_path_intern(w, &$p_arg.path, generics, is_ref, is_mut, ptr_for_ref, false) { return false; }
2485 if let Some(arr_ty) = self.is_real_type_array(&subtype) {
2486 if !self.write_c_type_intern(w, &arr_ty, generics, false, true, false, false) { return false; }
2488 // Option<T> needs to be converted to a *mut T, ie mut ptr-for-ref
2489 if !self.write_c_path_intern(w, &$p_arg.path, generics, true, true, true, false) { return false; }
2493 write!(w, "{}", $p_arg.path.segments.last().unwrap().ident).unwrap();
2495 } else if self.is_known_container(&subtype, is_ref) || self.is_path_transparent_container(&$p_arg.path, generics, is_ref) {
2496 if !self.write_c_mangled_container_path_intern(w, Self::path_to_generic_args(&$p_arg.path), generics,
2497 &subtype, is_ref, is_mut, ptr_for_ref, true) {
2500 self.write_c_mangled_container_path_intern(&mut mangled_type, Self::path_to_generic_args(&$p_arg.path),
2501 generics, &subtype, is_ref, is_mut, ptr_for_ref, true);
2502 if let Some(w2) = $extra_write as Option<&mut Vec<u8>> {
2503 self.write_c_mangled_container_path_intern(w2, Self::path_to_generic_args(&$p_arg.path),
2504 generics, &subtype, is_ref, is_mut, ptr_for_ref, true);
2507 let id = subtype.rsplitn(2, ':').next().unwrap(); // Get the "Base" name of the resolved type
2508 write!(w, "{}", id).unwrap();
2509 write!(mangled_type, "{}", id).unwrap();
2510 if let Some(w2) = $extra_write as Option<&mut Vec<u8>> {
2511 write!(w2, "{}", id).unwrap();
2514 } else { return false; }
2517 match generics.resolve_type(arg) {
2518 syn::Type::Tuple(tuple) => {
2519 if tuple.elems.len() == 0 {
2520 write!(w, "None").unwrap();
2521 write!(mangled_type, "None").unwrap();
2523 let mut mangled_tuple_type: Vec<u8> = Vec::new();
2525 // Figure out what the mangled type should look like. To disambiguate
2526 // ((A, B), C) and (A, B, C) we prefix the generic args with a _ and suffix
2527 // them with a Z. Ideally we wouldn't use Z, but not many special chars are
2528 // available for use in type names.
2529 write!(w, "C{}Tuple_", tuple.elems.len()).unwrap();
2530 write!(mangled_type, "C{}Tuple_", tuple.elems.len()).unwrap();
2531 write!(mangled_tuple_type, "C{}Tuple_", tuple.elems.len()).unwrap();
2532 for elem in tuple.elems.iter() {
2533 if let syn::Type::Path(p) = elem {
2534 write_path!(p, Some(&mut mangled_tuple_type));
2535 } else if let syn::Type::Reference(refelem) = elem {
2536 if let syn::Type::Path(p) = &*refelem.elem {
2537 write_path!(p, Some(&mut mangled_tuple_type));
2538 } else { return false; }
2539 } else { return false; }
2541 write!(w, "Z").unwrap();
2542 write!(mangled_type, "Z").unwrap();
2543 write!(mangled_tuple_type, "Z").unwrap();
2544 if !self.check_create_container(String::from_utf8(mangled_tuple_type).unwrap(),
2545 &format!("{}Tuple", tuple.elems.len()), tuple.elems.iter().collect(), generics, is_ref) {
2550 syn::Type::Path(p_arg) => {
2551 write_path!(p_arg, None);
2553 syn::Type::Reference(refty) => {
2554 if let syn::Type::Path(p_arg) = &*refty.elem {
2555 write_path!(p_arg, None);
2556 } else if let syn::Type::Slice(_) = &*refty.elem {
2557 // write_c_type will actually do exactly what we want here, we just need to
2558 // make it a pointer so that its an option. Note that we cannot always convert
2559 // the Vec-as-slice (ie non-ref types) containers, so sometimes need to be able
2560 // to edit it, hence we use *mut here instead of *const.
2561 if args.len() != 1 { return false; }
2562 write!(w, "*mut ").unwrap();
2563 self.write_c_type(w, arg, None, true);
2564 } else { return false; }
2566 syn::Type::Array(a) => {
2567 if let syn::Type::Path(p_arg) = &*a.elem {
2568 let resolved = self.resolve_path(&p_arg.path, generics);
2569 if !self.is_primitive(&resolved) { return false; }
2570 if let syn::Expr::Lit(syn::ExprLit { lit: syn::Lit::Int(len), .. }) = &a.len {
2571 if self.c_type_from_path(&format!("[{}; {}]", resolved, len.base10_digits()), is_ref, ptr_for_ref).is_none() { return false; }
2572 write!(w, "_{}{}", resolved, len.base10_digits()).unwrap();
2573 write!(mangled_type, "_{}{}", resolved, len.base10_digits()).unwrap();
2574 } else { return false; }
2575 } else { return false; }
2577 _ => { return false; },
2580 if self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) { return true; }
2581 // Push the "end of type" Z
2582 write!(w, "Z").unwrap();
2583 write!(mangled_type, "Z").unwrap();
2585 // Make sure the type is actually defined:
2586 self.check_create_container(String::from_utf8(mangled_type).unwrap(), ident, args, generics, is_ref)
2588 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 {
2589 if !self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) {
2590 write!(w, "{}::", Self::generated_container_path()).unwrap();
2592 self.write_c_mangled_container_path_intern(w, args, generics, ident, is_ref, is_mut, ptr_for_ref, false)
2594 pub fn get_c_mangled_container_type(&self, args: Vec<&syn::Type>, generics: Option<&GenericTypes>, template_name: &str) -> Option<String> {
2595 let mut out = Vec::new();
2596 if !self.write_c_mangled_container_path(&mut out, args, generics, template_name, false, false, false) {
2599 Some(String::from_utf8(out).unwrap())
2602 // **********************************
2603 // *** C Type Equivalent Printing ***
2604 // **********************************
2606 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 {
2607 let full_path = match self.maybe_resolve_path(&path, generics) {
2608 Some(path) => path, None => return false };
2609 if let Some(c_type) = self.c_type_from_path(&full_path, is_ref, ptr_for_ref) {
2610 write!(w, "{}", c_type).unwrap();
2612 } else if self.crate_types.traits.get(&full_path).is_some() {
2613 if is_ref && ptr_for_ref {
2614 write!(w, "*{} crate::{}", if is_mut { "mut" } else { "const" }, full_path).unwrap();
2616 if with_ref_lifetime { unimplemented!(); }
2617 write!(w, "&{}crate::{}", if is_mut { "mut " } else { "" }, full_path).unwrap();
2619 write!(w, "crate::{}", full_path).unwrap();
2622 } else if self.crate_types.opaques.get(&full_path).is_some() || self.crate_types.mirrored_enums.get(&full_path).is_some() {
2623 if is_ref && ptr_for_ref {
2624 // ptr_for_ref implies we're returning the object, which we can't really do for
2625 // opaque or mirrored types without box'ing them, which is quite a waste, so return
2626 // the actual object itself (for opaque types we'll set the pointer to the actual
2627 // type and note that its a reference).
2628 write!(w, "crate::{}", full_path).unwrap();
2629 } else if is_ref && with_ref_lifetime {
2631 // If we're concretizing something with a lifetime parameter, we have to pick a
2632 // lifetime, of which the only real available choice is `static`, obviously.
2633 write!(w, "&'static ").unwrap();
2634 self.write_rust_path(w, generics, path);
2636 write!(w, "&{}crate::{}", if is_mut { "mut " } else { "" }, full_path).unwrap();
2638 write!(w, "crate::{}", full_path).unwrap();
2645 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 {
2646 match generics.resolve_type(t) {
2647 syn::Type::Path(p) => {
2648 if p.qself.is_some() {
2651 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
2652 if self.is_known_container(&full_path, is_ref) || self.is_path_transparent_container(&p.path, generics, is_ref) {
2653 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);
2655 if let Some(aliased_type) = self.crate_types.type_aliases.get(&full_path).cloned() {
2656 return self.write_c_type_intern(w, &aliased_type, None, is_ref, is_mut, ptr_for_ref, with_ref_lifetime);
2659 self.write_c_path_intern(w, &p.path, generics, is_ref, is_mut, ptr_for_ref, with_ref_lifetime)
2661 syn::Type::Reference(r) => {
2662 self.write_c_type_intern(w, &*r.elem, generics, true, r.mutability.is_some(), ptr_for_ref, with_ref_lifetime)
2664 syn::Type::Array(a) => {
2665 if is_ref && is_mut {
2666 write!(w, "*mut [").unwrap();
2667 if !self.write_c_type_intern(w, &a.elem, generics, false, false, ptr_for_ref, with_ref_lifetime) { return false; }
2669 write!(w, "*const [").unwrap();
2670 if !self.write_c_type_intern(w, &a.elem, generics, false, false, ptr_for_ref, with_ref_lifetime) { return false; }
2672 let mut typecheck = Vec::new();
2673 if !self.write_c_type_intern(&mut typecheck, &a.elem, generics, false, false, ptr_for_ref, with_ref_lifetime) { return false; }
2674 if typecheck[..] != ['u' as u8, '8' as u8] { return false; }
2676 if let syn::Expr::Lit(l) = &a.len {
2677 if let syn::Lit::Int(i) = &l.lit {
2679 if let Some(ty) = self.c_type_from_path(&format!("[u8; {}]", i.base10_digits()), false, ptr_for_ref) {
2680 write!(w, "{}", ty).unwrap();
2684 write!(w, "; {}]", i).unwrap();
2690 syn::Type::Slice(s) => {
2691 if !is_ref || is_mut { return false; }
2692 if let syn::Type::Path(p) = &*s.elem {
2693 let resolved = self.resolve_path(&p.path, generics);
2694 if self.is_primitive(&resolved) {
2695 write!(w, "{}::{}slice", Self::container_templ_path(), resolved).unwrap();
2698 } else if let syn::Type::Reference(r) = &*s.elem {
2699 if let syn::Type::Path(p) = &*r.elem {
2700 // Slices with "real types" inside are mapped as the equivalent non-ref Vec
2701 let resolved = self.resolve_path(&p.path, generics);
2702 let mangled_container = if let Some((ident, _)) = self.crate_types.opaques.get(&resolved) {
2703 format!("CVec_{}Z", ident)
2704 } else if let Some(en) = self.crate_types.mirrored_enums.get(&resolved) {
2705 format!("CVec_{}Z", en.ident)
2706 } else if let Some(id) = p.path.get_ident() {
2707 format!("CVec_{}Z", id)
2708 } else { return false; };
2709 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
2710 self.check_create_container(mangled_container, "Vec", vec![&*r.elem], generics, false)
2711 } else if let syn::Type::Slice(sl2) = &*r.elem {
2712 if let syn::Type::Reference(r2) = &*sl2.elem {
2713 if let syn::Type::Path(p) = &*r2.elem {
2714 // Slices with slices with opaque types (with is_owned flags) are mapped as non-ref Vecs
2715 let resolved = self.resolve_path(&p.path, generics);
2716 let mangled_container = if let Some((ident, _)) = self.crate_types.opaques.get(&resolved) {
2717 format!("CVec_CVec_{}ZZ", ident)
2718 } else { return false; };
2719 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
2720 let inner = &r2.elem;
2721 let vec_ty: syn::Type = syn::parse_quote!(Vec<#inner>);
2722 self.check_create_container(mangled_container, "Vec", vec![&vec_ty], generics, false)
2726 } else if let syn::Type::Tuple(_) = &*s.elem {
2727 let mut args = syn::punctuated::Punctuated::<_, syn::token::Comma>::new();
2728 args.push(syn::GenericArgument::Type((*s.elem).clone()));
2729 let mut segments = syn::punctuated::Punctuated::new();
2730 segments.push(parse_quote!(Vec<#args>));
2731 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)
2734 syn::Type::Tuple(t) => {
2735 if t.elems.len() == 0 {
2738 self.write_c_mangled_container_path(w, t.elems.iter().collect(), generics,
2739 &format!("{}Tuple", t.elems.len()), is_ref, is_mut, ptr_for_ref)
2745 pub fn write_c_type<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, ptr_for_ref: bool) {
2746 assert!(self.write_c_type_intern(w, t, generics, false, false, ptr_for_ref, false));
2748 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) {
2749 assert!(self.write_c_type_intern(w, t, generics, false, false, ptr_for_ref, true));
2751 pub fn understood_c_path(&self, p: &syn::Path) -> bool {
2752 if p.leading_colon.is_some() { return false; }
2753 self.write_c_path_intern(&mut std::io::sink(), p, None, false, false, false, false)
2755 pub fn understood_c_type(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> bool {
2756 self.write_c_type_intern(&mut std::io::sink(), t, generics, false, false, false, false)