1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE>
5 // or the MIT license <LICENSE-MIT>, at your option.
6 // You may not use this file except in accordance with one or both of these
9 use std::cell::RefCell;
10 use std::collections::{HashMap, HashSet};
17 use proc_macro2::{TokenTree, Span};
18 use quote::format_ident;
21 // The following utils are used purely to build our known types maps - they break down all the
22 // types we need to resolve to include the given object, and no more.
24 pub fn first_seg_self<'a>(t: &'a syn::Type) -> Option<impl Iterator<Item=&syn::PathSegment> + 'a> {
26 syn::Type::Path(p) => {
27 if p.qself.is_some() || p.path.leading_colon.is_some() {
30 let mut segs = p.path.segments.iter();
31 let ty = segs.next().unwrap();
32 if !ty.arguments.is_empty() { return None; }
33 if format!("{}", ty.ident) == "Self" {
41 pub fn get_single_remaining_path_seg<'a, I: Iterator<Item=&'a syn::PathSegment>>(segs: &mut I) -> Option<&'a syn::Ident> {
42 if let Some(ty) = segs.next() {
43 if !ty.arguments.is_empty() { unimplemented!(); }
44 if segs.next().is_some() { return None; }
49 pub fn first_seg_is_stdlib(first_seg_str: &str) -> bool {
50 first_seg_str == "std" || first_seg_str == "core" || first_seg_str == "alloc"
53 pub fn single_ident_generic_path_to_ident(p: &syn::Path) -> Option<&syn::Ident> {
54 if p.segments.len() == 1 {
55 Some(&p.segments.iter().next().unwrap().ident)
59 pub fn path_matches_nongeneric(p: &syn::Path, exp: &[&str]) -> bool {
60 if p.segments.len() != exp.len() { return false; }
61 for (seg, e) in p.segments.iter().zip(exp.iter()) {
62 if seg.arguments != syn::PathArguments::None { return false; }
63 if &format!("{}", seg.ident) != *e { return false; }
68 pub fn string_path_to_syn_path(path: &str) -> syn::Path {
69 let mut segments = syn::punctuated::Punctuated::new();
70 for seg in path.split("::") {
71 segments.push(syn::PathSegment {
72 ident: syn::Ident::new(seg, Span::call_site()),
73 arguments: syn::PathArguments::None,
76 syn::Path { leading_colon: Some(syn::Token![::](Span::call_site())), segments }
79 #[derive(Debug, PartialEq)]
80 pub enum ExportStatus {
84 /// This is used only for traits to indicate that users should not be able to implement their
85 /// own version of a trait, but we should export Rust implementations of the trait (and the
87 /// Concretly, this means that we do not implement the Rust trait for the C trait struct.
90 /// Gets the ExportStatus of an object (struct, fn, etc) given its attributes.
91 pub fn export_status(attrs: &[syn::Attribute]) -> ExportStatus {
92 for attr in attrs.iter() {
93 let tokens_clone = attr.tokens.clone();
94 let mut token_iter = tokens_clone.into_iter();
95 if let Some(token) = token_iter.next() {
97 TokenTree::Punct(c) if c.as_char() == '=' => {
98 // Really not sure where syn gets '=' from here -
99 // it somehow represents '///' or '//!'
101 TokenTree::Group(g) => {
102 if format!("{}", single_ident_generic_path_to_ident(&attr.path).unwrap()) == "cfg" {
103 let mut iter = g.stream().into_iter();
104 if let TokenTree::Ident(i) = iter.next().unwrap() {
106 // #[cfg(any(test, feature = ""))]
107 if let TokenTree::Group(g) = iter.next().unwrap() {
108 let mut all_test = true;
109 for token in g.stream().into_iter() {
110 if let TokenTree::Ident(i) = token {
111 match format!("{}", i).as_str() {
114 _ => all_test = false,
116 } else if let TokenTree::Literal(lit) = token {
117 if format!("{}", lit) != "fuzztarget" {
122 if all_test { return ExportStatus::TestOnly; }
124 } else if i == "test" {
125 return ExportStatus::TestOnly;
129 continue; // eg #[derive()]
131 _ => unimplemented!(),
134 match token_iter.next().unwrap() {
135 TokenTree::Literal(lit) => {
136 let line = format!("{}", lit);
137 if line.contains("(C-not exported)") {
138 return ExportStatus::NoExport;
139 } else if line.contains("(C-not implementable)") {
140 return ExportStatus::NotImplementable;
143 _ => unimplemented!(),
149 pub fn assert_simple_bound(bound: &syn::TraitBound) {
150 if bound.paren_token.is_some() || bound.lifetimes.is_some() { unimplemented!(); }
151 if let syn::TraitBoundModifier::Maybe(_) = bound.modifier { unimplemented!(); }
154 /// Returns true if the enum will be mapped as an opaue (ie struct with a pointer to the underlying
155 /// type), otherwise it is mapped into a transparent, C-compatible version of itself.
156 pub fn is_enum_opaque(e: &syn::ItemEnum) -> bool {
157 for var in e.variants.iter() {
158 if let syn::Fields::Named(fields) = &var.fields {
159 for field in fields.named.iter() {
160 match export_status(&field.attrs) {
161 ExportStatus::Export|ExportStatus::TestOnly => {},
162 ExportStatus::NotImplementable => panic!("(C-not implementable) should only appear on traits!"),
163 ExportStatus::NoExport => return true,
166 } else if let syn::Fields::Unnamed(fields) = &var.fields {
167 for field in fields.unnamed.iter() {
168 match export_status(&field.attrs) {
169 ExportStatus::Export|ExportStatus::TestOnly => {},
170 ExportStatus::NotImplementable => panic!("(C-not implementable) should only appear on traits!"),
171 ExportStatus::NoExport => return true,
179 /// A stack of sets of generic resolutions.
181 /// This tracks the template parameters for a function, struct, or trait, allowing resolution into
182 /// a concrete type. By pushing a new context onto the stack, this can track a function's template
183 /// parameters inside of a generic struct or trait.
185 /// It maps both direct types as well as Deref<Target = X>, mapping them via the provided
186 /// TypeResolver's resolve_path function (ie traits map to the concrete jump table, structs to the
187 /// concrete C container struct, etc).
189 pub struct GenericTypes<'a, 'b> {
190 self_ty: Option<String>,
191 parent: Option<&'b GenericTypes<'b, 'b>>,
192 typed_generics: HashMap<&'a syn::Ident, String>,
193 default_generics: HashMap<&'a syn::Ident, (syn::Type, syn::Type)>,
195 impl<'a, 'p: 'a> GenericTypes<'a, 'p> {
196 pub fn new(self_ty: Option<String>) -> Self {
197 Self { self_ty, parent: None, typed_generics: HashMap::new(), default_generics: HashMap::new(), }
200 /// push a new context onto the stack, allowing for a new set of generics to be learned which
201 /// will override any lower contexts, but which will still fall back to resoltion via lower
203 pub fn push_ctx<'c>(&'c self) -> GenericTypes<'a, 'c> {
204 GenericTypes { self_ty: None, parent: Some(self), typed_generics: HashMap::new(), default_generics: HashMap::new(), }
207 /// Learn the generics in generics in the current context, given a TypeResolver.
208 pub fn learn_generics<'b, 'c>(&mut self, generics: &'a syn::Generics, types: &'b TypeResolver<'a, 'c>) -> bool {
209 let mut new_typed_generics = HashMap::new();
210 // First learn simple generics...
211 for generic in generics.params.iter() {
213 syn::GenericParam::Type(type_param) => {
214 let mut non_lifetimes_processed = false;
215 'bound_loop: for bound in type_param.bounds.iter() {
216 if let syn::TypeParamBound::Trait(trait_bound) = bound {
217 if let Some(ident) = single_ident_generic_path_to_ident(&trait_bound.path) {
218 match &format!("{}", ident) as &str { "Send" => continue, "Sync" => continue, _ => {} }
220 if path_matches_nongeneric(&trait_bound.path, &["core", "clone", "Clone"]) { continue; }
222 assert_simple_bound(&trait_bound);
223 if let Some(path) = types.maybe_resolve_path(&trait_bound.path, None) {
224 if types.skip_path(&path) { continue; }
225 if path == "Sized" { continue; }
226 if non_lifetimes_processed { return false; }
227 non_lifetimes_processed = true;
228 if path != "std::ops::Deref" && path != "core::ops::Deref" {
229 new_typed_generics.insert(&type_param.ident, Some(path));
230 } else if trait_bound.path.segments.len() == 1 {
231 // If we're templated on Deref<Target = ConcreteThing>, store
232 // the reference type in `default_generics` which handles full
233 // types and not just paths.
234 if let syn::PathArguments::AngleBracketed(ref args) =
235 trait_bound.path.segments[0].arguments {
236 for subargument in args.args.iter() {
238 syn::GenericArgument::Lifetime(_) => {},
239 syn::GenericArgument::Binding(ref b) => {
240 if &format!("{}", b.ident) != "Target" { return false; }
242 self.default_generics.insert(&type_param.ident, (parse_quote!(&#default), parse_quote!(&#default)));
245 _ => unimplemented!(),
249 new_typed_generics.insert(&type_param.ident, None);
255 if let Some(default) = type_param.default.as_ref() {
256 assert!(type_param.bounds.is_empty());
257 self.default_generics.insert(&type_param.ident, (default.clone(), parse_quote!(&#default)));
263 // Then find generics where we are required to pass a Deref<Target=X> and pretend its just X.
264 if let Some(wh) = &generics.where_clause {
265 for pred in wh.predicates.iter() {
266 if let syn::WherePredicate::Type(t) = pred {
267 if let syn::Type::Path(p) = &t.bounded_ty {
268 if p.qself.is_some() { return false; }
269 if p.path.leading_colon.is_some() { return false; }
270 let mut p_iter = p.path.segments.iter();
271 if let Some(gen) = new_typed_generics.get_mut(&p_iter.next().unwrap().ident) {
272 if gen.is_some() { return false; }
273 if &format!("{}", p_iter.next().unwrap().ident) != "Target" {return false; }
275 let mut non_lifetimes_processed = false;
276 for bound in t.bounds.iter() {
277 if let syn::TypeParamBound::Trait(trait_bound) = bound {
278 if let Some(id) = trait_bound.path.get_ident() {
279 if format!("{}", id) == "Sized" { continue; }
281 if non_lifetimes_processed { return false; }
282 non_lifetimes_processed = true;
283 assert_simple_bound(&trait_bound);
284 *gen = Some(types.resolve_path(&trait_bound.path, None));
287 } else { return false; }
288 } else { return false; }
292 for (key, value) in new_typed_generics.drain() {
293 if let Some(v) = value {
294 assert!(self.typed_generics.insert(key, v).is_none());
295 } else { return false; }
300 /// Learn the associated types from the trait in the current context.
301 pub fn learn_associated_types<'b, 'c>(&mut self, t: &'a syn::ItemTrait, types: &'b TypeResolver<'a, 'c>) {
302 for item in t.items.iter() {
304 &syn::TraitItem::Type(ref t) => {
305 if t.default.is_some() || t.generics.lt_token.is_some() { unimplemented!(); }
306 let mut bounds_iter = t.bounds.iter();
308 match bounds_iter.next().unwrap() {
309 syn::TypeParamBound::Trait(tr) => {
310 assert_simple_bound(&tr);
311 if let Some(path) = types.maybe_resolve_path(&tr.path, None) {
312 if types.skip_path(&path) { continue; }
313 // In general we handle Deref<Target=X> as if it were just X (and
314 // implement Deref<Target=Self> for relevant types). We don't
315 // bother to implement it for associated types, however, so we just
316 // ignore such bounds.
317 if path != "std::ops::Deref" && path != "core::ops::Deref" {
318 self.typed_generics.insert(&t.ident, path);
320 } else { unimplemented!(); }
321 for bound in bounds_iter {
322 if let syn::TypeParamBound::Trait(_) = bound { unimplemented!(); }
326 syn::TypeParamBound::Lifetime(_) => {},
335 /// Attempt to resolve a Path as a generic parameter and return the full path. as both a string
337 pub fn maybe_resolve_path<'b>(&'b self, path: &syn::Path) -> Option<&'b String> {
338 if let Some(ident) = path.get_ident() {
339 if let Some(ty) = &self.self_ty {
340 if format!("{}", ident) == "Self" {
344 if let Some(res) = self.typed_generics.get(ident) {
348 // Associated types are usually specified as "Self::Generic", so we check for that
350 let mut it = path.segments.iter();
351 if path.segments.len() == 2 && format!("{}", it.next().unwrap().ident) == "Self" {
352 let ident = &it.next().unwrap().ident;
353 if let Some(res) = self.typed_generics.get(ident) {
358 if let Some(parent) = self.parent {
359 parent.maybe_resolve_path(path)
366 pub trait ResolveType<'a> { fn resolve_type(&'a self, ty: &'a syn::Type) -> &'a syn::Type; }
367 impl<'a, 'b, 'c: 'a + 'b> ResolveType<'c> for Option<&GenericTypes<'a, 'b>> {
368 fn resolve_type(&'c self, ty: &'c syn::Type) -> &'c syn::Type {
369 if let Some(us) = self {
371 syn::Type::Path(p) => {
372 if let Some(ident) = p.path.get_ident() {
373 if let Some((ty, _)) = us.default_generics.get(ident) {
378 syn::Type::Reference(syn::TypeReference { elem, .. }) => {
379 if let syn::Type::Path(p) = &**elem {
380 if let Some(ident) = p.path.get_ident() {
381 if let Some((_, refty)) = us.default_generics.get(ident) {
389 us.parent.resolve_type(ty)
394 #[derive(Clone, PartialEq)]
395 // The type of declaration and the object itself
396 pub enum DeclType<'a> {
398 Trait(&'a syn::ItemTrait),
399 StructImported { generics: &'a syn::Generics },
401 EnumIgnored { generics: &'a syn::Generics },
404 pub struct ImportResolver<'mod_lifetime, 'crate_lft: 'mod_lifetime> {
405 pub crate_name: &'mod_lifetime str,
406 dependencies: &'mod_lifetime HashSet<syn::Ident>,
407 module_path: &'mod_lifetime str,
408 imports: HashMap<syn::Ident, (String, syn::Path)>,
409 declared: HashMap<syn::Ident, DeclType<'crate_lft>>,
410 priv_modules: HashSet<syn::Ident>,
412 impl<'mod_lifetime, 'crate_lft: 'mod_lifetime> ImportResolver<'mod_lifetime, 'crate_lft> {
413 fn process_use_intern(crate_name: &str, module_path: &str, dependencies: &HashSet<syn::Ident>, imports: &mut HashMap<syn::Ident, (String, syn::Path)>,
414 u: &syn::UseTree, partial_path: &str, mut path: syn::punctuated::Punctuated<syn::PathSegment, syn::token::Colon2>) {
417 macro_rules! push_path {
418 ($ident: expr, $path_suffix: expr) => {
419 if partial_path == "" && format!("{}", $ident) == "super" {
420 let mut mod_iter = module_path.rsplitn(2, "::");
421 mod_iter.next().unwrap();
422 let super_mod = mod_iter.next().unwrap();
423 new_path = format!("{}{}", super_mod, $path_suffix);
424 assert_eq!(path.len(), 0);
425 for module in super_mod.split("::") {
426 path.push(syn::PathSegment { ident: syn::Ident::new(module, Span::call_site()), arguments: syn::PathArguments::None });
428 } else if partial_path == "" && format!("{}", $ident) == "self" {
429 new_path = format!("{}{}", module_path, $path_suffix);
430 for module in module_path.split("::") {
431 path.push(syn::PathSegment { ident: syn::Ident::new(module, Span::call_site()), arguments: syn::PathArguments::None });
433 } else if partial_path == "" && format!("{}", $ident) == "crate" {
434 new_path = format!("{}{}", crate_name, $path_suffix);
435 let crate_name_ident = format_ident!("{}", crate_name);
436 path.push(parse_quote!(#crate_name_ident));
437 } else if partial_path == "" && !dependencies.contains(&$ident) {
438 new_path = format!("{}::{}{}", crate_name, $ident, $path_suffix);
439 let crate_name_ident = format_ident!("{}", crate_name);
440 path.push(parse_quote!(#crate_name_ident));
442 new_path = format!("{}{}{}", partial_path, $ident, $path_suffix);
445 path.push(parse_quote!(#ident));
449 syn::UseTree::Path(p) => {
450 push_path!(p.ident, "::");
451 Self::process_use_intern(crate_name, module_path, dependencies, imports, &p.tree, &new_path, path);
453 syn::UseTree::Name(n) => {
454 push_path!(n.ident, "");
455 imports.insert(n.ident.clone(), (new_path, syn::Path { leading_colon: Some(syn::Token![::](Span::call_site())), segments: path }));
457 syn::UseTree::Group(g) => {
458 for i in g.items.iter() {
459 Self::process_use_intern(crate_name, module_path, dependencies, imports, i, partial_path, path.clone());
462 syn::UseTree::Rename(r) => {
463 push_path!(r.ident, "");
464 imports.insert(r.rename.clone(), (new_path, syn::Path { leading_colon: Some(syn::Token![::](Span::call_site())), segments: path }));
466 syn::UseTree::Glob(_) => {
467 eprintln!("Ignoring * use for {} - this may result in resolution failures", partial_path);
472 fn process_use(crate_name: &str, module_path: &str, dependencies: &HashSet<syn::Ident>, imports: &mut HashMap<syn::Ident, (String, syn::Path)>, u: &syn::ItemUse) {
473 if let syn::Visibility::Public(_) = u.vis {
474 // We actually only use these for #[cfg(fuzztarget)]
475 eprintln!("Ignoring pub(use) tree!");
478 if u.leading_colon.is_some() { eprintln!("Ignoring leading-colon use!"); return; }
479 Self::process_use_intern(crate_name, module_path, dependencies, imports, &u.tree, "", syn::punctuated::Punctuated::new());
482 fn insert_primitive(imports: &mut HashMap<syn::Ident, (String, syn::Path)>, id: &str) {
483 let ident = format_ident!("{}", id);
484 let path = parse_quote!(#ident);
485 imports.insert(ident, (id.to_owned(), path));
488 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 {
489 Self::from_borrowed_items(crate_name, dependencies, module_path, &contents.iter().map(|a| a).collect::<Vec<_>>())
491 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 {
492 let mut imports = HashMap::new();
493 // Add primitives to the "imports" list:
494 Self::insert_primitive(&mut imports, "bool");
495 Self::insert_primitive(&mut imports, "u64");
496 Self::insert_primitive(&mut imports, "u32");
497 Self::insert_primitive(&mut imports, "u16");
498 Self::insert_primitive(&mut imports, "u8");
499 Self::insert_primitive(&mut imports, "usize");
500 Self::insert_primitive(&mut imports, "str");
501 Self::insert_primitive(&mut imports, "String");
503 // These are here to allow us to print native Rust types in trait fn impls even if we don't
505 Self::insert_primitive(&mut imports, "Result");
506 Self::insert_primitive(&mut imports, "Vec");
507 Self::insert_primitive(&mut imports, "Option");
509 let mut declared = HashMap::new();
510 let mut priv_modules = HashSet::new();
512 for item in contents.iter() {
514 syn::Item::Use(u) => Self::process_use(crate_name, module_path, dependencies, &mut imports, &u),
515 syn::Item::Struct(s) => {
516 if let syn::Visibility::Public(_) = s.vis {
517 match export_status(&s.attrs) {
518 ExportStatus::Export => { declared.insert(s.ident.clone(), DeclType::StructImported { generics: &s.generics }); },
519 ExportStatus::NoExport => { declared.insert(s.ident.clone(), DeclType::StructIgnored); },
520 ExportStatus::TestOnly => continue,
521 ExportStatus::NotImplementable => panic!("(C-not implementable) should only appear on traits!"),
525 syn::Item::Type(t) if export_status(&t.attrs) == ExportStatus::Export => {
526 if let syn::Visibility::Public(_) = t.vis {
527 declared.insert(t.ident.clone(), DeclType::StructImported { generics: &t.generics });
530 syn::Item::Enum(e) => {
531 if let syn::Visibility::Public(_) = e.vis {
532 match export_status(&e.attrs) {
533 ExportStatus::Export if is_enum_opaque(e) => { declared.insert(e.ident.clone(), DeclType::EnumIgnored { generics: &e.generics }); },
534 ExportStatus::Export => { declared.insert(e.ident.clone(), DeclType::MirroredEnum); },
535 ExportStatus::NotImplementable => panic!("(C-not implementable) should only appear on traits!"),
540 syn::Item::Trait(t) => {
541 match export_status(&t.attrs) {
542 ExportStatus::Export|ExportStatus::NotImplementable => {
543 if let syn::Visibility::Public(_) = t.vis {
544 declared.insert(t.ident.clone(), DeclType::Trait(t));
550 syn::Item::Mod(m) => {
551 priv_modules.insert(m.ident.clone());
557 Self { crate_name, dependencies, module_path, imports, declared, priv_modules }
560 pub fn maybe_resolve_declared(&self, id: &syn::Ident) -> Option<&DeclType<'crate_lft>> {
561 self.declared.get(id)
564 pub fn maybe_resolve_ident(&self, id: &syn::Ident) -> Option<String> {
565 if let Some((imp, _)) = self.imports.get(id) {
567 } else if self.declared.get(id).is_some() {
568 Some(self.module_path.to_string() + "::" + &format!("{}", id))
572 pub fn maybe_resolve_path(&self, p: &syn::Path, generics: Option<&GenericTypes>) -> Option<String> {
573 if let Some(gen_types) = generics {
574 if let Some(resp) = gen_types.maybe_resolve_path(p) {
575 return Some(resp.clone());
579 if p.leading_colon.is_some() {
580 let mut res: String = p.segments.iter().enumerate().map(|(idx, seg)| {
581 format!("{}{}", if idx == 0 { "" } else { "::" }, seg.ident)
583 let firstseg = p.segments.iter().next().unwrap();
584 if !self.dependencies.contains(&firstseg.ident) {
585 res = self.crate_name.to_owned() + "::" + &res;
588 } else if let Some(id) = p.get_ident() {
589 self.maybe_resolve_ident(id)
591 if p.segments.len() == 1 {
592 let seg = p.segments.iter().next().unwrap();
593 return self.maybe_resolve_ident(&seg.ident);
595 let mut seg_iter = p.segments.iter();
596 let first_seg = seg_iter.next().unwrap();
597 let remaining: String = seg_iter.map(|seg| {
598 format!("::{}", seg.ident)
600 let first_seg_str = format!("{}", first_seg.ident);
601 if let Some((imp, _)) = self.imports.get(&first_seg.ident) {
603 Some(imp.clone() + &remaining)
607 } else if let Some(_) = self.priv_modules.get(&first_seg.ident) {
608 Some(format!("{}::{}{}", self.module_path, first_seg.ident, remaining))
609 } else if first_seg_is_stdlib(&first_seg_str) || self.dependencies.contains(&first_seg.ident) {
610 Some(first_seg_str + &remaining)
615 /// Map all the Paths in a Type into absolute paths given a set of imports (generated via process_use_intern)
616 pub fn resolve_imported_refs(&self, mut ty: syn::Type) -> syn::Type {
618 syn::Type::Path(p) => {
619 if p.path.segments.len() != 1 { unimplemented!(); }
620 let mut args = p.path.segments[0].arguments.clone();
621 if let syn::PathArguments::AngleBracketed(ref mut generics) = &mut args {
622 for arg in generics.args.iter_mut() {
623 if let syn::GenericArgument::Type(ref mut t) = arg {
624 *t = self.resolve_imported_refs(t.clone());
628 if let Some((_, newpath)) = self.imports.get(single_ident_generic_path_to_ident(&p.path).unwrap()) {
629 p.path = newpath.clone();
631 p.path.segments[0].arguments = args;
633 syn::Type::Reference(r) => {
634 r.elem = Box::new(self.resolve_imported_refs((*r.elem).clone()));
636 syn::Type::Slice(s) => {
637 s.elem = Box::new(self.resolve_imported_refs((*s.elem).clone()));
639 syn::Type::Tuple(t) => {
640 for e in t.elems.iter_mut() {
641 *e = self.resolve_imported_refs(e.clone());
644 _ => unimplemented!(),
650 // templates_defined is walked to write the C++ header, so if we use the default hashing it get
651 // reordered on each genbindings run. Instead, we use SipHasher (which defaults to 0-keys) so that
652 // the sorting is stable across runs. It is deprecated, but the "replacement" doesn't actually
653 // accomplish the same goals, so we just ignore it.
655 pub type NonRandomHash = hash::BuildHasherDefault<hash::SipHasher>;
658 pub struct ASTModule {
659 pub attrs: Vec<syn::Attribute>,
660 pub items: Vec<syn::Item>,
661 pub submods: Vec<String>,
663 /// A struct containing the syn::File AST for each file in the crate.
664 pub struct FullLibraryAST {
665 pub modules: HashMap<String, ASTModule, NonRandomHash>,
666 pub dependencies: HashSet<syn::Ident>,
668 impl FullLibraryAST {
669 fn load_module(&mut self, module: String, attrs: Vec<syn::Attribute>, mut items: Vec<syn::Item>) {
670 let mut non_mod_items = Vec::with_capacity(items.len());
671 let mut submods = Vec::with_capacity(items.len());
672 for item in items.drain(..) {
674 syn::Item::Mod(m) if m.content.is_some() => {
675 if export_status(&m.attrs) == ExportStatus::Export {
676 if let syn::Visibility::Public(_) = m.vis {
677 let modident = format!("{}", m.ident);
678 let modname = if module != "" {
679 module.clone() + "::" + &modident
683 self.load_module(modname, m.attrs, m.content.unwrap().1);
684 submods.push(modident);
686 non_mod_items.push(syn::Item::Mod(m));
690 syn::Item::Mod(_) => panic!("--pretty=expanded output should never have non-body modules"),
691 syn::Item::ExternCrate(c) => {
692 if export_status(&c.attrs) == ExportStatus::Export {
693 self.dependencies.insert(c.ident);
696 _ => { non_mod_items.push(item); }
699 self.modules.insert(module, ASTModule { attrs, items: non_mod_items, submods });
702 pub fn load_lib(lib: syn::File) -> Self {
703 assert_eq!(export_status(&lib.attrs), ExportStatus::Export);
704 let mut res = Self { modules: HashMap::default(), dependencies: HashSet::new() };
705 res.load_module("".to_owned(), lib.attrs, lib.items);
710 /// List of manually-generated types which are clonable
711 fn initial_clonable_types() -> HashSet<String> {
712 let mut res = HashSet::new();
713 res.insert("crate::c_types::u5".to_owned());
714 res.insert("crate::c_types::FourBytes".to_owned());
715 res.insert("crate::c_types::TwelveBytes".to_owned());
716 res.insert("crate::c_types::SixteenBytes".to_owned());
717 res.insert("crate::c_types::TwentyBytes".to_owned());
718 res.insert("crate::c_types::ThirtyTwoBytes".to_owned());
719 res.insert("crate::c_types::SecretKey".to_owned());
720 res.insert("crate::c_types::PublicKey".to_owned());
721 res.insert("crate::c_types::Transaction".to_owned());
722 res.insert("crate::c_types::TxOut".to_owned());
723 res.insert("crate::c_types::Signature".to_owned());
724 res.insert("crate::c_types::RecoverableSignature".to_owned());
725 res.insert("crate::c_types::Bech32Error".to_owned());
726 res.insert("crate::c_types::Secp256k1Error".to_owned());
727 res.insert("crate::c_types::IOError".to_owned());
728 res.insert("crate::c_types::Error".to_owned());
729 res.insert("crate::c_types::Str".to_owned());
731 // Because some types are manually-mapped to CVec_u8Z we may end up checking if its clonable
732 // before we ever get to constructing the type fully via
733 // `write_c_mangled_container_path_intern` (which will add it here too), so we have to manually
734 // add it on startup.
735 res.insert("crate::c_types::derived::CVec_u8Z".to_owned());
739 /// Top-level struct tracking everything which has been defined while walking the crate.
740 pub struct CrateTypes<'a> {
741 /// This may contain structs or enums, but only when either is mapped as
742 /// struct X { inner: *mut originalX, .. }
743 pub opaques: HashMap<String, (&'a syn::Ident, &'a syn::Generics)>,
744 /// structs that weren't exposed
745 pub priv_structs: HashMap<String, &'a syn::Generics>,
746 /// Enums which are mapped as C enums with conversion functions
747 pub mirrored_enums: HashMap<String, &'a syn::ItemEnum>,
748 /// Traits which are mapped as a pointer + jump table
749 pub traits: HashMap<String, &'a syn::ItemTrait>,
750 /// Aliases from paths to some other Type
751 pub type_aliases: HashMap<String, syn::Type>,
752 /// Value is an alias to Key (maybe with some generics)
753 pub reverse_alias_map: HashMap<String, Vec<(String, syn::PathArguments)>>,
754 /// Template continer types defined, map from mangled type name -> whether a destructor fn
757 /// This is used at the end of processing to make C++ wrapper classes
758 pub templates_defined: RefCell<HashMap<String, bool, NonRandomHash>>,
759 /// The output file for any created template container types, written to as we find new
760 /// template containers which need to be defined.
761 template_file: RefCell<&'a mut File>,
762 /// Set of containers which are clonable
763 clonable_types: RefCell<HashSet<String>>,
765 pub trait_impls: HashMap<String, Vec<String>>,
766 /// The full set of modules in the crate(s)
767 pub lib_ast: &'a FullLibraryAST,
770 impl<'a> CrateTypes<'a> {
771 pub fn new(template_file: &'a mut File, libast: &'a FullLibraryAST) -> Self {
773 opaques: HashMap::new(), mirrored_enums: HashMap::new(), traits: HashMap::new(),
774 type_aliases: HashMap::new(), reverse_alias_map: HashMap::new(),
775 templates_defined: RefCell::new(HashMap::default()), priv_structs: HashMap::new(),
776 clonable_types: RefCell::new(initial_clonable_types()), trait_impls: HashMap::new(),
777 template_file: RefCell::new(template_file), lib_ast: &libast,
780 pub fn set_clonable(&self, object: String) {
781 self.clonable_types.borrow_mut().insert(object);
783 pub fn is_clonable(&self, object: &str) -> bool {
784 self.clonable_types.borrow().contains(object)
786 pub fn write_new_template(&self, mangled_container: String, has_destructor: bool, created_container: &[u8]) {
787 self.template_file.borrow_mut().write(created_container).unwrap();
788 self.templates_defined.borrow_mut().insert(mangled_container, has_destructor);
792 /// A struct which tracks resolving rust types into C-mapped equivalents, exists for one specific
793 /// module but contains a reference to the overall CrateTypes tracking.
794 pub struct TypeResolver<'mod_lifetime, 'crate_lft: 'mod_lifetime> {
795 pub module_path: &'mod_lifetime str,
796 pub crate_types: &'mod_lifetime CrateTypes<'crate_lft>,
797 pub types: ImportResolver<'mod_lifetime, 'crate_lft>,
800 /// Returned by write_empty_rust_val_check_suffix to indicate what type of dereferencing needs to
801 /// happen to get the inner value of a generic.
802 enum EmptyValExpectedTy {
803 /// A type which has a flag for being empty (eg an array where we treat all-0s as empty).
805 /// A Option mapped as a COption_*Z
807 /// A pointer which we want to convert to a reference.
812 /// Describes the appropriate place to print a general type-conversion string when converting a
814 enum ContainerPrefixLocation {
815 /// Prints a general type-conversion string prefix and suffix outside of the
816 /// container-conversion strings.
818 /// Prints a general type-conversion string prefix and suffix inside of the
819 /// container-conversion strings.
821 /// Does not print the usual type-conversion string prefix and suffix.
825 impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
826 pub fn new(module_path: &'a str, types: ImportResolver<'a, 'c>, crate_types: &'a CrateTypes<'c>) -> Self {
827 Self { module_path, types, crate_types }
830 // *************************************************
831 // *** Well know type and conversion definitions ***
832 // *************************************************
834 /// Returns true we if can just skip passing this to C entirely
835 pub fn skip_path(&self, full_path: &str) -> bool {
836 full_path == "bitcoin::secp256k1::Secp256k1" ||
837 full_path == "bitcoin::secp256k1::Signing" ||
838 full_path == "bitcoin::secp256k1::Verification"
840 /// Returns true we if can just skip passing this to C entirely
841 fn no_arg_path_to_rust(&self, full_path: &str) -> &str {
842 if full_path == "bitcoin::secp256k1::Secp256k1" {
843 "secp256k1::global::SECP256K1"
844 } else { unimplemented!(); }
847 /// Returns true if the object is a primitive and is mapped as-is with no conversion
849 pub fn is_primitive(&self, full_path: &str) -> bool {
860 pub fn is_clonable(&self, ty: &str) -> bool {
861 if self.crate_types.is_clonable(ty) { return true; }
862 if self.is_primitive(ty) { return true; }
868 /// Gets the C-mapped type for types which are outside of the crate, or which are manually
869 /// ignored by for some reason need mapping anyway.
870 fn c_type_from_path<'b>(&self, full_path: &'b str, is_ref: bool, _ptr_for_ref: bool) -> Option<&'b str> {
871 if self.is_primitive(full_path) {
872 return Some(full_path);
875 // Note that no !is_ref types can map to an array because Rust and C's call semantics
876 // for arrays are different (https://github.com/eqrion/cbindgen/issues/528)
878 "[u8; 32]" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
879 "[u8; 20]" if !is_ref => Some("crate::c_types::TwentyBytes"),
880 "[u8; 16]" if !is_ref => Some("crate::c_types::SixteenBytes"),
881 "[u8; 12]" if !is_ref => Some("crate::c_types::TwelveBytes"),
882 "[u8; 4]" if !is_ref => Some("crate::c_types::FourBytes"),
883 "[u8; 3]" if !is_ref => Some("crate::c_types::ThreeBytes"), // Used for RGB values
885 "str" if is_ref => Some("crate::c_types::Str"),
886 "alloc::string::String"|"String" => Some("crate::c_types::Str"),
888 "std::time::Duration"|"core::time::Duration" => Some("u64"),
889 "std::time::SystemTime" => Some("u64"),
890 "std::io::Error"|"lightning::io::Error" => Some("crate::c_types::IOError"),
891 "core::fmt::Arguments" if is_ref => Some("crate::c_types::Str"),
893 "core::convert::Infallible" => Some("crate::c_types::NotConstructable"),
895 "bitcoin::bech32::Error"|"bech32::Error"
896 if !is_ref => Some("crate::c_types::Bech32Error"),
897 "bitcoin::secp256k1::Error"|"secp256k1::Error"
898 if !is_ref => Some("crate::c_types::Secp256k1Error"),
900 "core::num::ParseIntError" => Some("crate::c_types::Error"),
901 "core::str::Utf8Error" => Some("crate::c_types::Error"),
903 "bitcoin::bech32::u5"|"bech32::u5" => Some("crate::c_types::u5"),
904 "core::num::NonZeroU8" => Some("u8"),
906 "secp256k1::PublicKey"|"bitcoin::secp256k1::PublicKey" => Some("crate::c_types::PublicKey"),
907 "bitcoin::secp256k1::ecdsa::Signature" => Some("crate::c_types::Signature"),
908 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some("crate::c_types::RecoverableSignature"),
909 "bitcoin::secp256k1::SecretKey" if is_ref => Some("*const [u8; 32]"),
910 "bitcoin::secp256k1::SecretKey" if !is_ref => Some("crate::c_types::SecretKey"),
911 "bitcoin::blockdata::script::Script" if is_ref => Some("crate::c_types::u8slice"),
912 "bitcoin::blockdata::script::Script" if !is_ref => Some("crate::c_types::derived::CVec_u8Z"),
913 "bitcoin::blockdata::transaction::OutPoint" => Some("crate::lightning::chain::transaction::OutPoint"),
914 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some("crate::c_types::Transaction"),
915 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some("crate::c_types::TxOut"),
916 "bitcoin::network::constants::Network" => Some("crate::bitcoin::network::Network"),
917 "bitcoin::util::address::WitnessVersion" => Some("crate::c_types::WitnessVersion"),
918 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some("*const [u8; 80]"),
919 "bitcoin::blockdata::block::Block" if is_ref => Some("crate::c_types::u8slice"),
921 "bitcoin::hash_types::PubkeyHash"|"bitcoin::hash_types::WPubkeyHash"|"bitcoin::hash_types::ScriptHash"
922 if is_ref => Some("*const [u8; 20]"),
923 "bitcoin::hash_types::WScriptHash"
924 if is_ref => Some("*const [u8; 32]"),
926 // Newtypes that we just expose in their original form.
927 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
928 if is_ref => Some("*const [u8; 32]"),
929 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
930 if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
931 "bitcoin::secp256k1::Message" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
932 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
933 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
934 if is_ref => Some("*const [u8; 32]"),
935 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
936 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
937 if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
939 "lightning::io::Read" => Some("crate::c_types::u8slice"),
945 fn from_c_conversion_new_var_from_path<'b>(&self, _full_path: &str, _is_ref: bool) -> Option<(&'b str, &'b str)> {
948 fn from_c_conversion_prefix_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<String> {
949 if self.is_primitive(full_path) {
950 return Some("".to_owned());
953 "Vec" if !is_ref => Some("local_"),
954 "Result" if !is_ref => Some("local_"),
955 "Option" if is_ref => Some("&local_"),
956 "Option" => Some("local_"),
958 "[u8; 32]" if is_ref => Some("unsafe { &*"),
959 "[u8; 32]" if !is_ref => Some(""),
960 "[u8; 20]" if !is_ref => Some(""),
961 "[u8; 16]" if !is_ref => Some(""),
962 "[u8; 12]" if !is_ref => Some(""),
963 "[u8; 4]" if !is_ref => Some(""),
964 "[u8; 3]" if !is_ref => Some(""),
966 "[u8]" if is_ref => Some(""),
967 "[usize]" if is_ref => Some(""),
969 "str" if is_ref => Some(""),
970 "alloc::string::String"|"String" => Some(""),
971 "std::io::Error"|"lightning::io::Error" => Some(""),
972 // Note that we'll panic for String if is_ref, as we only have non-owned memory, we
973 // cannot create a &String.
975 "core::convert::Infallible" => Some("panic!(\"You must never construct a NotConstructable! : "),
977 "bitcoin::bech32::Error"|"bech32::Error" if !is_ref => Some(""),
978 "bitcoin::secp256k1::Error"|"secp256k1::Error" if !is_ref => Some(""),
980 "core::num::ParseIntError" => Some("u8::from_str_radix(\" a\", 10).unwrap_err() /*"),
981 "core::str::Utf8Error" => Some("core::str::from_utf8(&[0xff]).unwrap_err() /*"),
983 "std::time::Duration"|"core::time::Duration" => Some("core::time::Duration::from_secs("),
984 "std::time::SystemTime" => Some("(::std::time::SystemTime::UNIX_EPOCH + std::time::Duration::from_secs("),
986 "bitcoin::bech32::u5"|"bech32::u5" => Some(""),
987 "core::num::NonZeroU8" => Some("core::num::NonZeroU8::new("),
989 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" if is_ref => Some("&"),
990 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" => Some(""),
991 "bitcoin::secp256k1::ecdsa::Signature" if is_ref => Some("&"),
992 "bitcoin::secp256k1::ecdsa::Signature" => Some(""),
993 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some(""),
994 "bitcoin::secp256k1::SecretKey" if is_ref => Some("&::bitcoin::secp256k1::SecretKey::from_slice(&unsafe { *"),
995 "bitcoin::secp256k1::SecretKey" if !is_ref => Some(""),
996 "bitcoin::blockdata::script::Script" if is_ref => Some("&::bitcoin::blockdata::script::Script::from(Vec::from("),
997 "bitcoin::blockdata::script::Script" if !is_ref => Some("::bitcoin::blockdata::script::Script::from("),
998 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" if is_ref => Some("&"),
999 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(""),
1000 "bitcoin::blockdata::transaction::OutPoint" => Some("crate::c_types::C_to_bitcoin_outpoint("),
1001 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(""),
1002 "bitcoin::network::constants::Network" => Some(""),
1003 "bitcoin::util::address::WitnessVersion" => Some(""),
1004 "bitcoin::blockdata::block::BlockHeader" => Some("&::bitcoin::consensus::encode::deserialize(unsafe { &*"),
1005 "bitcoin::blockdata::block::Block" if is_ref => Some("&::bitcoin::consensus::encode::deserialize("),
1007 "bitcoin::hash_types::PubkeyHash" if is_ref =>
1008 Some("&bitcoin::hash_types::PubkeyHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
1009 "bitcoin::hash_types::WPubkeyHash" if is_ref =>
1010 Some("&bitcoin::hash_types::WPubkeyHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
1011 "bitcoin::hash_types::ScriptHash" if is_ref =>
1012 Some("&bitcoin::hash_types::ScriptHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
1013 "bitcoin::hash_types::WScriptHash" if is_ref =>
1014 Some("&bitcoin::hash_types::WScriptHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
1016 // Newtypes that we just expose in their original form.
1017 "bitcoin::hash_types::Txid" if is_ref => Some("&::bitcoin::hash_types::Txid::from_slice(&unsafe { &*"),
1018 "bitcoin::hash_types::Txid" if !is_ref => Some("::bitcoin::hash_types::Txid::from_slice(&"),
1019 "bitcoin::hash_types::BlockHash" => Some("::bitcoin::hash_types::BlockHash::from_slice(&"),
1020 "lightning::ln::PaymentHash" if !is_ref => Some("::lightning::ln::PaymentHash("),
1021 "lightning::ln::PaymentHash" if is_ref => Some("&::lightning::ln::PaymentHash(unsafe { *"),
1022 "lightning::ln::PaymentPreimage" if !is_ref => Some("::lightning::ln::PaymentPreimage("),
1023 "lightning::ln::PaymentPreimage" if is_ref => Some("&::lightning::ln::PaymentPreimage(unsafe { *"),
1024 "lightning::ln::PaymentSecret" if !is_ref => Some("::lightning::ln::PaymentSecret("),
1025 "lightning::ln::channelmanager::PaymentId" if !is_ref => Some("::lightning::ln::channelmanager::PaymentId("),
1026 "lightning::ln::channelmanager::PaymentId" if is_ref=> Some("&::lightning::ln::channelmanager::PaymentId( unsafe { *"),
1027 "lightning::chain::keysinterface::KeyMaterial" if !is_ref => Some("::lightning::chain::keysinterface::KeyMaterial("),
1028 "lightning::chain::keysinterface::KeyMaterial" if is_ref=> Some("&::lightning::chain::keysinterface::KeyMaterial( unsafe { *"),
1030 // List of traits we map (possibly during processing of other files):
1031 "lightning::io::Read" => Some("&mut "),
1034 }.map(|s| s.to_owned())
1036 fn from_c_conversion_suffix_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<String> {
1037 if self.is_primitive(full_path) {
1038 return Some("".to_owned());
1041 "Vec" if !is_ref => Some(""),
1042 "Option" => Some(""),
1043 "Result" if !is_ref => Some(""),
1045 "[u8; 32]" if is_ref => Some("}"),
1046 "[u8; 32]" if !is_ref => Some(".data"),
1047 "[u8; 20]" if !is_ref => Some(".data"),
1048 "[u8; 16]" if !is_ref => Some(".data"),
1049 "[u8; 12]" if !is_ref => Some(".data"),
1050 "[u8; 4]" if !is_ref => Some(".data"),
1051 "[u8; 3]" if !is_ref => Some(".data"),
1053 "[u8]" if is_ref => Some(".to_slice()"),
1054 "[usize]" if is_ref => Some(".to_slice()"),
1056 "str" if is_ref => Some(".into_str()"),
1057 "alloc::string::String"|"String" => Some(".into_string()"),
1058 "std::io::Error"|"lightning::io::Error" => Some(".to_rust()"),
1060 "core::convert::Infallible" => Some("\")"),
1062 "bitcoin::bech32::Error"|"bech32::Error" if !is_ref => Some(".into_rust()"),
1063 "bitcoin::secp256k1::Error"|"secp256k1::Error" if !is_ref => Some(".into_rust()"),
1065 "core::num::ParseIntError" => Some("*/"),
1066 "core::str::Utf8Error" => Some("*/"),
1068 "std::time::Duration"|"core::time::Duration" => Some(")"),
1069 "std::time::SystemTime" => Some("))"),
1071 "bitcoin::bech32::u5"|"bech32::u5" => Some(".into()"),
1072 "core::num::NonZeroU8" => Some(").expect(\"Value must be non-zero\")"),
1074 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" => Some(".into_rust()"),
1075 "bitcoin::secp256k1::ecdsa::Signature" => Some(".into_rust()"),
1076 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some(".into_rust()"),
1077 "bitcoin::secp256k1::SecretKey" if !is_ref => Some(".into_rust()"),
1078 "bitcoin::secp256k1::SecretKey" if is_ref => Some("}[..]).unwrap()"),
1079 "bitcoin::blockdata::script::Script" if is_ref => Some(".to_slice()))"),
1080 "bitcoin::blockdata::script::Script" if !is_ref => Some(".into_rust())"),
1081 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(".into_bitcoin()"),
1082 "bitcoin::blockdata::transaction::OutPoint" => Some(")"),
1083 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(".into_rust()"),
1084 "bitcoin::network::constants::Network" => Some(".into_bitcoin()"),
1085 "bitcoin::util::address::WitnessVersion" => Some(".into()"),
1086 "bitcoin::blockdata::block::BlockHeader" => Some(" }).unwrap()"),
1087 "bitcoin::blockdata::block::Block" => Some(".to_slice()).unwrap()"),
1089 "bitcoin::hash_types::PubkeyHash"|"bitcoin::hash_types::WPubkeyHash"|
1090 "bitcoin::hash_types::ScriptHash"|"bitcoin::hash_types::WScriptHash"
1091 if is_ref => Some(" }.clone()))"),
1093 // Newtypes that we just expose in their original form.
1094 "bitcoin::hash_types::Txid" if is_ref => Some(" }[..]).unwrap()"),
1095 "bitcoin::hash_types::Txid" => Some(".data[..]).unwrap()"),
1096 "bitcoin::hash_types::BlockHash" if !is_ref => Some(".data[..]).unwrap()"),
1097 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1098 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1099 if !is_ref => Some(".data)"),
1100 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1101 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1102 if is_ref => Some(" })"),
1104 // List of traits we map (possibly during processing of other files):
1105 "lightning::io::Read" => Some(".to_reader()"),
1108 }.map(|s| s.to_owned())
1111 fn to_c_conversion_new_var_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<(&'b str, &'b str)> {
1112 if self.is_primitive(full_path) {
1116 "[u8]" if is_ref => Some(("crate::c_types::u8slice::from_slice(", ")")),
1117 "[usize]" if is_ref => Some(("crate::c_types::usizeslice::from_slice(", ")")),
1119 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some(("{ let mut s = [0u8; 80]; s[..].copy_from_slice(&::bitcoin::consensus::encode::serialize(", ")); s }")),
1120 "bitcoin::blockdata::block::Block" if is_ref => Some(("::bitcoin::consensus::encode::serialize(", ")")),
1121 "bitcoin::hash_types::Txid" => None,
1124 }.map(|s| s.to_owned())
1126 fn to_c_conversion_inline_prefix_from_path(&self, full_path: &str, is_ref: bool, _ptr_for_ref: bool) -> Option<String> {
1127 if self.is_primitive(full_path) {
1128 return Some("".to_owned());
1131 "Result" if !is_ref => Some("local_"),
1132 "Vec" if !is_ref => Some("local_"),
1133 "Option" => Some("local_"),
1135 "[u8; 32]" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1136 "[u8; 32]" if is_ref => Some(""),
1137 "[u8; 20]" if !is_ref => Some("crate::c_types::TwentyBytes { data: "),
1138 "[u8; 16]" if !is_ref => Some("crate::c_types::SixteenBytes { data: "),
1139 "[u8; 12]" if !is_ref => Some("crate::c_types::TwelveBytes { data: "),
1140 "[u8; 4]" if !is_ref => Some("crate::c_types::FourBytes { data: "),
1141 "[u8; 3]" if is_ref => Some(""),
1143 "[u8]" if is_ref => Some("local_"),
1144 "[usize]" if is_ref => Some("local_"),
1146 "str" if is_ref => Some(""),
1147 "alloc::string::String"|"String" => Some(""),
1149 "std::time::Duration"|"core::time::Duration" => Some(""),
1150 "std::time::SystemTime" => Some(""),
1151 "std::io::Error"|"lightning::io::Error" => Some("crate::c_types::IOError::from_rust("),
1152 "core::fmt::Arguments" => Some("alloc::format!(\"{}\", "),
1154 "core::convert::Infallible" => Some("panic!(\"Cannot construct an Infallible: "),
1156 "bitcoin::bech32::Error"|"bech32::Error"
1157 if !is_ref => Some("crate::c_types::Bech32Error::from_rust("),
1158 "bitcoin::secp256k1::Error"|"secp256k1::Error"
1159 if !is_ref => Some("crate::c_types::Secp256k1Error::from_rust("),
1161 "core::num::ParseIntError" => Some("crate::c_types::Error { _dummy: 0 } /*"),
1162 "core::str::Utf8Error" => Some("crate::c_types::Error { _dummy: 0 } /*"),
1164 "bitcoin::bech32::u5"|"bech32::u5" => Some(""),
1166 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" => Some("crate::c_types::PublicKey::from_rust(&"),
1167 "bitcoin::secp256k1::ecdsa::Signature" => Some("crate::c_types::Signature::from_rust(&"),
1168 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some("crate::c_types::RecoverableSignature::from_rust(&"),
1169 "bitcoin::secp256k1::SecretKey" if is_ref => Some(""),
1170 "bitcoin::secp256k1::SecretKey" if !is_ref => Some("crate::c_types::SecretKey::from_rust("),
1171 "bitcoin::blockdata::script::Script" if is_ref => Some("crate::c_types::u8slice::from_slice(&"),
1172 "bitcoin::blockdata::script::Script" if !is_ref => Some(""),
1173 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" if is_ref => Some("crate::c_types::Transaction::from_bitcoin("),
1174 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some("crate::c_types::Transaction::from_bitcoin(&"),
1175 "bitcoin::blockdata::transaction::OutPoint" => Some("crate::c_types::bitcoin_to_C_outpoint("),
1176 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some("crate::c_types::TxOut::from_rust("),
1177 "bitcoin::network::constants::Network" => Some("crate::bitcoin::network::Network::from_bitcoin("),
1178 "bitcoin::util::address::WitnessVersion" => Some(""),
1179 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some("&local_"),
1180 "bitcoin::blockdata::block::Block" if is_ref => Some("crate::c_types::u8slice::from_slice(&local_"),
1182 "bitcoin::hash_types::Txid" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1184 // Newtypes that we just expose in their original form.
1185 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1186 if is_ref => Some(""),
1187 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1188 if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1189 "bitcoin::secp256k1::Message" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1190 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1191 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1192 if is_ref => Some("&"),
1193 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1194 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1195 if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1197 "lightning::io::Read" => Some("crate::c_types::u8slice::from_vec(&crate::c_types::reader_to_vec("),
1200 }.map(|s| s.to_owned())
1202 fn to_c_conversion_inline_suffix_from_path(&self, full_path: &str, is_ref: bool, _ptr_for_ref: bool) -> Option<String> {
1203 if self.is_primitive(full_path) {
1204 return Some("".to_owned());
1207 "Result" if !is_ref => Some(""),
1208 "Vec" if !is_ref => Some(".into()"),
1209 "Option" => Some(""),
1211 "[u8; 32]" if !is_ref => Some(" }"),
1212 "[u8; 32]" if is_ref => Some(""),
1213 "[u8; 20]" if !is_ref => Some(" }"),
1214 "[u8; 16]" if !is_ref => Some(" }"),
1215 "[u8; 12]" if !is_ref => Some(" }"),
1216 "[u8; 4]" if !is_ref => Some(" }"),
1217 "[u8; 3]" if is_ref => Some(""),
1219 "[u8]" if is_ref => Some(""),
1220 "[usize]" if is_ref => Some(""),
1222 "str" if is_ref => Some(".into()"),
1223 "alloc::string::String"|"String" if is_ref => Some(".as_str().into()"),
1224 "alloc::string::String"|"String" => Some(".into()"),
1226 "std::time::Duration"|"core::time::Duration" => Some(".as_secs()"),
1227 "std::time::SystemTime" => Some(".duration_since(::std::time::SystemTime::UNIX_EPOCH).expect(\"Times must be post-1970\").as_secs()"),
1228 "std::io::Error"|"lightning::io::Error" => Some(")"),
1229 "core::fmt::Arguments" => Some(").into()"),
1231 "core::convert::Infallible" => Some("\")"),
1233 "bitcoin::secp256k1::Error"|"bech32::Error"
1234 if !is_ref => Some(")"),
1235 "bitcoin::secp256k1::Error"|"secp256k1::Error"
1236 if !is_ref => Some(")"),
1238 "core::num::ParseIntError" => Some("*/"),
1239 "core::str::Utf8Error" => Some("*/"),
1241 "bitcoin::bech32::u5"|"bech32::u5" => Some(".into()"),
1243 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" => Some(")"),
1244 "bitcoin::secp256k1::ecdsa::Signature" => Some(")"),
1245 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some(")"),
1246 "bitcoin::secp256k1::SecretKey" if !is_ref => Some(")"),
1247 "bitcoin::secp256k1::SecretKey" if is_ref => Some(".as_ref()"),
1248 "bitcoin::blockdata::script::Script" if is_ref => Some("[..])"),
1249 "bitcoin::blockdata::script::Script" if !is_ref => Some(".into_bytes().into()"),
1250 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(")"),
1251 "bitcoin::blockdata::transaction::OutPoint" => Some(")"),
1252 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(")"),
1253 "bitcoin::network::constants::Network" => Some(")"),
1254 "bitcoin::util::address::WitnessVersion" => Some(".into()"),
1255 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some(""),
1256 "bitcoin::blockdata::block::Block" if is_ref => Some(")"),
1258 "bitcoin::hash_types::Txid" if !is_ref => Some(".into_inner() }"),
1260 // Newtypes that we just expose in their original form.
1261 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1262 if is_ref => Some(".as_inner()"),
1263 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1264 if !is_ref => Some(".into_inner() }"),
1265 "bitcoin::secp256k1::Message" if !is_ref => Some(".as_ref().clone() }"),
1266 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1267 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1268 if is_ref => Some(".0"),
1269 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1270 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1271 if !is_ref => Some(".0 }"),
1273 "lightning::io::Read" => Some("))"),
1276 }.map(|s| s.to_owned())
1279 fn empty_val_check_suffix_from_path(&self, full_path: &str) -> Option<&str> {
1281 "lightning::ln::PaymentSecret" => Some(".data == [0; 32]"),
1282 "secp256k1::PublicKey"|"bitcoin::secp256k1::PublicKey" => Some(".is_null()"),
1283 "bitcoin::secp256k1::ecdsa::Signature" => Some(".is_null()"),
1288 /// When printing a reference to the source crate's rust type, if we need to map it to a
1289 /// different "real" type, it can be done so here.
1290 /// This is useful to work around limitations in the binding type resolver, where we reference
1291 /// a non-public `use` alias.
1292 /// TODO: We should never need to use this!
1293 fn real_rust_type_mapping<'equiv>(&self, thing: &'equiv str) -> &'equiv str {
1295 "lightning::io::Read" => "crate::c_types::io::Read",
1300 // ****************************
1301 // *** Container Processing ***
1302 // ****************************
1304 /// Returns the module path in the generated mapping crate to the containers which we generate
1305 /// when writing to CrateTypes::template_file.
1306 pub fn generated_container_path() -> &'static str {
1307 "crate::c_types::derived"
1309 /// Returns the module path in the generated mapping crate to the container templates, which
1310 /// are then concretized and put in the generated container path/template_file.
1311 fn container_templ_path() -> &'static str {
1315 /// Returns true if the path containing the given args is a "transparent" container, ie an
1316 /// Option or a container which does not require a generated continer class.
1317 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 {
1318 if full_path == "Option" {
1319 let inner = args.next().unwrap();
1320 assert!(args.next().is_none());
1322 syn::Type::Reference(_) => true,
1323 syn::Type::Array(a) => {
1324 if let syn::Expr::Lit(l) = &a.len {
1325 if let syn::Lit::Int(i) = &l.lit {
1326 if i.base10_digits().parse::<usize>().unwrap() >= 32 {
1327 let mut buf = Vec::new();
1328 self.write_rust_type(&mut buf, generics, &a.elem);
1329 let ty = String::from_utf8(buf).unwrap();
1332 // Blindly assume that if we're trying to create an empty value for an
1333 // array < 32 entries that all-0s may be a valid state.
1336 } else { unimplemented!(); }
1337 } else { unimplemented!(); }
1339 syn::Type::Path(p) => {
1340 if let Some(resolved) = self.maybe_resolve_path(&p.path, generics) {
1341 if self.c_type_has_inner_from_path(&resolved) { return true; }
1342 if self.is_primitive(&resolved) { return false; }
1343 if self.c_type_from_path(&resolved, false, false).is_some() { true } else { false }
1346 syn::Type::Tuple(_) => false,
1347 _ => unimplemented!(),
1351 /// Returns true if the path is a "transparent" container, ie an Option or a container which does
1352 /// not require a generated continer class.
1353 pub fn is_path_transparent_container(&self, full_path: &syn::Path, generics: Option<&GenericTypes>, is_ref: bool) -> bool {
1354 let inner_iter = match &full_path.segments.last().unwrap().arguments {
1355 syn::PathArguments::None => return false,
1356 syn::PathArguments::AngleBracketed(args) => args.args.iter().map(|arg| {
1357 if let syn::GenericArgument::Type(ref ty) = arg {
1359 } else { unimplemented!() }
1361 syn::PathArguments::Parenthesized(_) => unimplemented!(),
1363 self.is_transparent_container(&self.resolve_path(full_path, generics), is_ref, inner_iter, generics)
1365 /// Returns true if this is a known, supported, non-transparent container.
1366 fn is_known_container(&self, full_path: &str, is_ref: bool) -> bool {
1367 (full_path == "Result" && !is_ref) || (full_path == "Vec" && !is_ref) || full_path.ends_with("Tuple") || full_path == "Option"
1369 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)
1370 // Returns prefix + Vec<(prefix, var-name-to-inline-convert)> + suffix
1371 // expecting one element in the vec per generic type, each of which is inline-converted
1372 -> Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)> {
1374 "Result" if !is_ref => {
1376 vec![(" { Ok(mut o) => crate::c_types::CResultTempl::ok(".to_string(), "o".to_string()),
1377 (").into(), Err(mut e) => crate::c_types::CResultTempl::err(".to_string(), "e".to_string())],
1378 ").into() }", ContainerPrefixLocation::PerConv))
1382 // We should only get here if the single contained has an inner
1383 assert!(self.c_type_has_inner(single_contained.unwrap()));
1385 Some(("Vec::new(); for mut item in ", vec![(format!(".drain(..) {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1388 if let Some(syn::Type::Reference(_)) = single_contained {
1389 Some(("Vec::new(); for item in ", vec![(format!(".iter() {{ local_{}.push(", var_name), "(*item)".to_string())], "); }", ContainerPrefixLocation::PerConv))
1391 Some(("Vec::new(); for item in ", vec![(format!(".iter() {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1395 let mut is_contained_ref = false;
1396 let contained_struct = if let Some(syn::Type::Path(p)) = single_contained {
1397 Some(self.resolve_path(&p.path, generics))
1398 } else if let Some(syn::Type::Reference(r)) = single_contained {
1399 is_contained_ref = true;
1400 if let syn::Type::Path(p) = &*r.elem {
1401 Some(self.resolve_path(&p.path, generics))
1404 if let Some(inner_path) = contained_struct {
1405 let only_contained_has_inner = self.c_type_has_inner_from_path(&inner_path);
1406 if self.c_type_has_inner_from_path(&inner_path) {
1407 let is_inner_ref = if let Some(syn::Type::Reference(_)) = single_contained { true } else { false };
1409 return Some(("if ", vec![
1410 (".is_none() { core::ptr::null() } else { ObjOps::nonnull_ptr_to_inner(".to_owned(),
1411 format!("({}{}.unwrap())", var_access, if is_inner_ref { "" } else { ".as_ref()" }))
1412 ], ") }", ContainerPrefixLocation::OutsideConv));
1414 return Some(("if ", vec![
1415 (".is_none() { core::ptr::null_mut() } else { ".to_owned(), format!("({}.unwrap())", var_access))
1416 ], " }", ContainerPrefixLocation::OutsideConv));
1418 } else if self.is_primitive(&inner_path) || self.c_type_from_path(&inner_path, false, false).is_none() {
1419 if self.is_primitive(&inner_path) || (!is_contained_ref && !is_ref) || only_contained_has_inner {
1420 let inner_name = self.get_c_mangled_container_type(vec![single_contained.unwrap()], generics, "Option").unwrap();
1421 return Some(("if ", vec![
1422 (format!(".is_none() {{ {}::None }} else {{ {}::Some(", inner_name, inner_name),
1423 format!("{}.unwrap()", var_access))
1424 ], ") }", ContainerPrefixLocation::PerConv));
1426 let inner_name = self.get_c_mangled_container_type(vec![single_contained.unwrap()], generics, "Option").unwrap();
1427 return Some(("if ", vec![
1428 (format!(".is_none() {{ {}::None }} else {{ {}::Some(/* WARNING: CLONING CONVERSION HERE! &Option<Enum> is otherwise un-expressable. */", inner_name, inner_name),
1429 format!("{}.clone().unwrap()", var_access))
1430 ], ") }", ContainerPrefixLocation::PerConv));
1433 // If c_type_from_path is some (ie there's a manual mapping for the inner
1434 // type), lean on write_empty_rust_val, below.
1437 if let Some(t) = single_contained {
1438 if let syn::Type::Tuple(syn::TypeTuple { elems, .. }) = t {
1439 assert!(elems.is_empty());
1440 let inner_name = self.get_c_mangled_container_type(vec![single_contained.unwrap()], generics, "Option").unwrap();
1441 return Some(("if ", vec![
1442 (format!(".is_none() {{ {}::None }} else {{ {}::Some /*",
1443 inner_name, inner_name), format!(""))
1444 ], " */}", ContainerPrefixLocation::PerConv));
1446 if let syn::Type::Reference(syn::TypeReference { elem, .. }) = t {
1447 if let syn::Type::Slice(_) = &**elem {
1448 return Some(("if ", vec![
1449 (".is_none() { SmartPtr::null() } else { SmartPtr::from_obj(".to_string(),
1450 format!("({}.unwrap())", var_access))
1451 ], ") }", ContainerPrefixLocation::PerConv));
1454 let mut v = Vec::new();
1455 self.write_empty_rust_val(generics, &mut v, t);
1456 let s = String::from_utf8(v).unwrap();
1457 return Some(("if ", vec![
1458 (format!(".is_none() {{ {} }} else {{ ", s), format!("({}.unwrap())", var_access))
1459 ], " }", ContainerPrefixLocation::PerConv));
1460 } else { unreachable!(); }
1466 /// only_contained_has_inner implies that there is only one contained element in the container
1467 /// and it has an inner field (ie is an "opaque" type we've defined).
1468 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)
1469 // Returns prefix + Vec<(prefix, var-name-to-inline-convert)> + suffix
1470 // expecting one element in the vec per generic type, each of which is inline-converted
1471 -> Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)> {
1472 let mut only_contained_has_inner = false;
1473 let only_contained_resolved = if let Some(syn::Type::Path(p)) = single_contained {
1474 let res = self.resolve_path(&p.path, generics);
1475 only_contained_has_inner = self.c_type_has_inner_from_path(&res);
1479 "Result" if !is_ref => {
1481 vec![(".result_ok { true => Ok(".to_string(), format!("(*unsafe {{ Box::from_raw(<*mut _>::take_ptr(&mut {}.contents.result)) }})", var_access)),
1482 ("), false => Err(".to_string(), format!("(*unsafe {{ Box::from_raw(<*mut _>::take_ptr(&mut {}.contents.err)) }})", var_access))],
1483 ")}", ContainerPrefixLocation::PerConv))
1485 "Slice" if is_ref && only_contained_has_inner => {
1486 Some(("Vec::new(); for mut item in ", vec![(format!(".as_slice().iter() {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1489 Some(("Vec::new(); for mut item in ", vec![(format!(".into_rust().drain(..) {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1492 if let Some(resolved) = only_contained_resolved {
1493 if self.is_primitive(&resolved) {
1494 return Some(("if ", vec![(".is_some() { Some(".to_string(), format!("{}.take()", var_access))], ") } else { None }", ContainerPrefixLocation::NoPrefix))
1495 } else if only_contained_has_inner {
1497 return Some(("if ", vec![(".inner.is_null() { None } else { Some((*".to_string(), format!("{}", var_access))], ").clone()) }", ContainerPrefixLocation::PerConv))
1499 return Some(("if ", vec![(".inner.is_null() { None } else { Some(".to_string(), format!("{}", var_access))], ") }", ContainerPrefixLocation::PerConv));
1504 if let Some(t) = single_contained {
1506 syn::Type::Reference(_)|syn::Type::Path(_)|syn::Type::Slice(_)|syn::Type::Array(_) => {
1507 let mut v = Vec::new();
1508 let ret_ref = self.write_empty_rust_val_check_suffix(generics, &mut v, t);
1509 let s = String::from_utf8(v).unwrap();
1511 EmptyValExpectedTy::ReferenceAsPointer =>
1512 return Some(("if ", vec![
1513 (format!("{} {{ None }} else {{ Some(", s), format!("unsafe {{ &mut *{} }}", var_access))
1514 ], ") }", ContainerPrefixLocation::NoPrefix)),
1515 EmptyValExpectedTy::OptionType =>
1516 return Some(("{ /* ", vec![
1517 (format!("*/ let {}_opt = {};", var_name, var_access),
1518 format!("}} if {}_opt{} {{ None }} else {{ Some({{ {}_opt.take()", var_name, s, var_name))
1519 ], ") } }", ContainerPrefixLocation::PerConv)),
1520 EmptyValExpectedTy::NonPointer =>
1521 return Some(("if ", vec![
1522 (format!("{} {{ None }} else {{ Some(", s), format!("{}", var_access))
1523 ], ") }", ContainerPrefixLocation::PerConv)),
1526 syn::Type::Tuple(_) => {
1527 return Some(("if ", vec![(".is_some() { Some(".to_string(), format!("{}.take()", var_access))], ") } else { None }", ContainerPrefixLocation::PerConv))
1529 _ => unimplemented!(),
1531 } else { unreachable!(); }
1537 /// Constructs a reference to the given type, possibly tweaking the type if relevant to make it
1538 /// convertable to C.
1539 pub fn create_ownable_reference(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> Option<syn::Type> {
1540 let default_value = Some(syn::Type::Reference(syn::TypeReference {
1541 and_token: syn::Token!(&)(Span::call_site()), lifetime: None, mutability: None,
1542 elem: Box::new(t.clone()) }));
1543 match generics.resolve_type(t) {
1544 syn::Type::Path(p) => {
1545 if let Some(resolved_path) = self.maybe_resolve_path(&p.path, generics) {
1546 if resolved_path != "Vec" { return default_value; }
1547 if p.path.segments.len() != 1 { unimplemented!(); }
1548 let only_seg = p.path.segments.iter().next().unwrap();
1549 if let syn::PathArguments::AngleBracketed(args) = &only_seg.arguments {
1550 if args.args.len() != 1 { unimplemented!(); }
1551 let inner_arg = args.args.iter().next().unwrap();
1552 if let syn::GenericArgument::Type(ty) = &inner_arg {
1553 let mut can_create = self.c_type_has_inner(&ty);
1554 if let syn::Type::Path(inner) = ty {
1555 if inner.path.segments.len() == 1 &&
1556 format!("{}", inner.path.segments[0].ident) == "Vec" {
1560 if !can_create { return default_value; }
1561 if let Some(inner_ty) = self.create_ownable_reference(&ty, generics) {
1562 return Some(syn::Type::Reference(syn::TypeReference {
1563 and_token: syn::Token![&](Span::call_site()),
1566 elem: Box::new(syn::Type::Slice(syn::TypeSlice {
1567 bracket_token: syn::token::Bracket { span: Span::call_site() },
1568 elem: Box::new(inner_ty)
1571 } else { return default_value; }
1572 } else { unimplemented!(); }
1573 } else { unimplemented!(); }
1574 } else { return None; }
1580 // *************************************************
1581 // *** Type definition during main.rs processing ***
1582 // *************************************************
1584 /// Returns true if the object at the given path is mapped as X { inner: *mut origX, .. }.
1585 pub fn c_type_has_inner_from_path(&self, full_path: &str) -> bool {
1586 self.crate_types.opaques.get(full_path).is_some()
1589 /// Returns true if the object at the given path is mapped as X { inner: *mut origX, .. }.
1590 pub fn c_type_has_inner(&self, ty: &syn::Type) -> bool {
1592 syn::Type::Path(p) => {
1593 if let Some(full_path) = self.maybe_resolve_path(&p.path, None) {
1594 self.c_type_has_inner_from_path(&full_path)
1597 syn::Type::Reference(r) => {
1598 self.c_type_has_inner(&*r.elem)
1604 pub fn maybe_resolve_ident(&self, id: &syn::Ident) -> Option<String> {
1605 self.types.maybe_resolve_ident(id)
1608 pub fn maybe_resolve_path(&self, p_arg: &syn::Path, generics: Option<&GenericTypes>) -> Option<String> {
1609 self.types.maybe_resolve_path(p_arg, generics)
1611 pub fn resolve_path(&self, p: &syn::Path, generics: Option<&GenericTypes>) -> String {
1612 self.maybe_resolve_path(p, generics).unwrap()
1615 // ***********************************
1616 // *** Original Rust Type Printing ***
1617 // ***********************************
1619 fn in_rust_prelude(resolved_path: &str) -> bool {
1620 match resolved_path {
1628 fn write_rust_path<W: std::io::Write>(&self, w: &mut W, generics_resolver: Option<&GenericTypes>, path: &syn::Path) {
1629 if let Some(resolved) = self.maybe_resolve_path(&path, generics_resolver) {
1630 if self.is_primitive(&resolved) {
1631 write!(w, "{}", path.get_ident().unwrap()).unwrap();
1633 // TODO: We should have a generic "is from a dependency" check here instead of
1634 // checking for "bitcoin" explicitly.
1635 if resolved.starts_with("bitcoin::") || Self::in_rust_prelude(&resolved) {
1636 write!(w, "{}", resolved).unwrap();
1637 // If we're printing a generic argument, it needs to reference the crate, otherwise
1638 // the original crate:
1639 } else if self.maybe_resolve_path(&path, None).as_ref() == Some(&resolved) {
1640 write!(w, "{}", self.real_rust_type_mapping(&resolved)).unwrap();
1642 write!(w, "crate::{}", resolved).unwrap();
1645 if let syn::PathArguments::AngleBracketed(args) = &path.segments.iter().last().unwrap().arguments {
1646 self.write_rust_generic_arg(w, generics_resolver, args.args.iter());
1649 if path.leading_colon.is_some() {
1650 write!(w, "::").unwrap();
1652 for (idx, seg) in path.segments.iter().enumerate() {
1653 if idx != 0 { write!(w, "::").unwrap(); }
1654 write!(w, "{}", seg.ident).unwrap();
1655 if let syn::PathArguments::AngleBracketed(args) = &seg.arguments {
1656 self.write_rust_generic_arg(w, generics_resolver, args.args.iter());
1661 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>) {
1662 let mut had_params = false;
1663 for (idx, arg) in generics.enumerate() {
1664 if idx != 0 { write!(w, ", ").unwrap(); } else { write!(w, "<").unwrap(); }
1667 syn::GenericParam::Lifetime(lt) => write!(w, "'{}", lt.lifetime.ident).unwrap(),
1668 syn::GenericParam::Type(t) => {
1669 write!(w, "{}", t.ident).unwrap();
1670 if t.colon_token.is_some() { write!(w, ":").unwrap(); }
1671 for (idx, bound) in t.bounds.iter().enumerate() {
1672 if idx != 0 { write!(w, " + ").unwrap(); }
1674 syn::TypeParamBound::Trait(tb) => {
1675 if tb.paren_token.is_some() || tb.lifetimes.is_some() { unimplemented!(); }
1676 self.write_rust_path(w, generics_resolver, &tb.path);
1678 _ => unimplemented!(),
1681 if t.eq_token.is_some() || t.default.is_some() { unimplemented!(); }
1683 _ => unimplemented!(),
1686 if had_params { write!(w, ">").unwrap(); }
1689 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>) {
1690 write!(w, "<").unwrap();
1691 for (idx, arg) in generics.enumerate() {
1692 if idx != 0 { write!(w, ", ").unwrap(); }
1694 syn::GenericArgument::Type(t) => self.write_rust_type(w, generics_resolver, t),
1695 _ => unimplemented!(),
1698 write!(w, ">").unwrap();
1700 pub fn write_rust_type<W: std::io::Write>(&self, w: &mut W, generics: Option<&GenericTypes>, t: &syn::Type) {
1701 match generics.resolve_type(t) {
1702 syn::Type::Path(p) => {
1703 if p.qself.is_some() {
1706 self.write_rust_path(w, generics, &p.path);
1708 syn::Type::Reference(r) => {
1709 write!(w, "&").unwrap();
1710 if let Some(lft) = &r.lifetime {
1711 write!(w, "'{} ", lft.ident).unwrap();
1713 if r.mutability.is_some() {
1714 write!(w, "mut ").unwrap();
1716 self.write_rust_type(w, generics, &*r.elem);
1718 syn::Type::Array(a) => {
1719 write!(w, "[").unwrap();
1720 self.write_rust_type(w, generics, &a.elem);
1721 if let syn::Expr::Lit(l) = &a.len {
1722 if let syn::Lit::Int(i) = &l.lit {
1723 write!(w, "; {}]", i).unwrap();
1724 } else { unimplemented!(); }
1725 } else { unimplemented!(); }
1727 syn::Type::Slice(s) => {
1728 write!(w, "[").unwrap();
1729 self.write_rust_type(w, generics, &s.elem);
1730 write!(w, "]").unwrap();
1732 syn::Type::Tuple(s) => {
1733 write!(w, "(").unwrap();
1734 for (idx, t) in s.elems.iter().enumerate() {
1735 if idx != 0 { write!(w, ", ").unwrap(); }
1736 self.write_rust_type(w, generics, &t);
1738 write!(w, ")").unwrap();
1740 _ => unimplemented!(),
1744 /// Prints a constructor for something which is "uninitialized" (but obviously not actually
1745 /// unint'd memory).
1746 pub fn write_empty_rust_val<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type) {
1748 syn::Type::Reference(r) => {
1749 self.write_empty_rust_val(generics, w, &*r.elem)
1751 syn::Type::Path(p) => {
1752 let resolved = self.resolve_path(&p.path, generics);
1753 if self.crate_types.opaques.get(&resolved).is_some() {
1754 write!(w, "crate::{} {{ inner: core::ptr::null_mut(), is_owned: true }}", resolved).unwrap();
1756 // Assume its a manually-mapped C type, where we can just define an null() fn
1757 write!(w, "{}::null()", self.c_type_from_path(&resolved, false, false).unwrap()).unwrap();
1760 syn::Type::Array(a) => {
1761 if let syn::Expr::Lit(l) = &a.len {
1762 if let syn::Lit::Int(i) = &l.lit {
1763 if i.base10_digits().parse::<usize>().unwrap() < 32 {
1764 // Blindly assume that if we're trying to create an empty value for an
1765 // array < 32 entries that all-0s may be a valid state.
1768 let arrty = format!("[u8; {}]", i.base10_digits());
1769 write!(w, "{}", self.to_c_conversion_inline_prefix_from_path(&arrty, false, false).unwrap()).unwrap();
1770 write!(w, "[0; {}]", i.base10_digits()).unwrap();
1771 write!(w, "{}", self.to_c_conversion_inline_suffix_from_path(&arrty, false, false).unwrap()).unwrap();
1772 } else { unimplemented!(); }
1773 } else { unimplemented!(); }
1775 _ => unimplemented!(),
1779 fn is_real_type_array(&self, resolved_type: &str) -> Option<syn::Type> {
1780 if let Some(real_ty) = self.c_type_from_path(&resolved_type, true, false) {
1781 if real_ty.ends_with("]") && real_ty.starts_with("*const [u8; ") {
1782 let mut split = real_ty.split("; ");
1783 split.next().unwrap();
1784 let tail_str = split.next().unwrap();
1785 assert!(split.next().is_none());
1786 let len = usize::from_str_radix(&tail_str[..tail_str.len() - 1], 10).unwrap();
1787 Some(parse_quote!([u8; #len]))
1792 /// Prints a suffix to determine if a variable is empty (ie was set by write_empty_rust_val).
1793 /// See EmptyValExpectedTy for information on return types.
1794 fn write_empty_rust_val_check_suffix<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type) -> EmptyValExpectedTy {
1796 syn::Type::Reference(r) => {
1797 return self.write_empty_rust_val_check_suffix(generics, w, &*r.elem);
1799 syn::Type::Path(p) => {
1800 let resolved = self.resolve_path(&p.path, generics);
1801 if let Some(arr_ty) = self.is_real_type_array(&resolved) {
1802 return self.write_empty_rust_val_check_suffix(generics, w, &arr_ty);
1804 if self.crate_types.opaques.get(&resolved).is_some() {
1805 write!(w, ".inner.is_null()").unwrap();
1806 EmptyValExpectedTy::NonPointer
1808 if let Some(suffix) = self.empty_val_check_suffix_from_path(&resolved) {
1809 write!(w, "{}", suffix).unwrap();
1810 // We may eventually need to allow empty_val_check_suffix_from_path to specify if we need a deref or not
1811 EmptyValExpectedTy::NonPointer
1813 write!(w, ".is_none()").unwrap();
1814 EmptyValExpectedTy::OptionType
1818 syn::Type::Array(a) => {
1819 if let syn::Expr::Lit(l) = &a.len {
1820 if let syn::Lit::Int(i) = &l.lit {
1821 write!(w, ".data == [0; {}]", i.base10_digits()).unwrap();
1822 EmptyValExpectedTy::NonPointer
1823 } else { unimplemented!(); }
1824 } else { unimplemented!(); }
1826 syn::Type::Slice(_) => {
1827 // Option<[]> always implies that we want to treat len() == 0 differently from
1828 // None, so we always map an Option<[]> into a pointer.
1829 write!(w, " == core::ptr::null_mut()").unwrap();
1830 EmptyValExpectedTy::ReferenceAsPointer
1832 _ => unimplemented!(),
1836 /// Prints a suffix to determine if a variable is empty (ie was set by write_empty_rust_val).
1837 pub fn write_empty_rust_val_check<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type, var_access: &str) {
1839 syn::Type::Reference(r) => {
1840 self.write_empty_rust_val_check(generics, w, &*r.elem, var_access);
1842 syn::Type::Path(_) => {
1843 write!(w, "{}", var_access).unwrap();
1844 self.write_empty_rust_val_check_suffix(generics, w, t);
1846 syn::Type::Array(a) => {
1847 if let syn::Expr::Lit(l) = &a.len {
1848 if let syn::Lit::Int(i) = &l.lit {
1849 let arrty = format!("[u8; {}]", i.base10_digits());
1850 // We don't (yet) support a new-var conversion here.
1851 assert!(self.from_c_conversion_new_var_from_path(&arrty, false).is_none());
1853 self.from_c_conversion_prefix_from_path(&arrty, false).unwrap(),
1855 self.from_c_conversion_suffix_from_path(&arrty, false).unwrap()).unwrap();
1856 self.write_empty_rust_val_check_suffix(generics, w, t);
1857 } else { unimplemented!(); }
1858 } else { unimplemented!(); }
1860 _ => unimplemented!(),
1864 // ********************************
1865 // *** Type conversion printing ***
1866 // ********************************
1868 /// Returns true we if can just skip passing this to C entirely
1869 pub fn skip_arg(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> bool {
1871 syn::Type::Path(p) => {
1872 if p.qself.is_some() { unimplemented!(); }
1873 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
1874 self.skip_path(&full_path)
1877 syn::Type::Reference(r) => {
1878 self.skip_arg(&*r.elem, generics)
1883 pub fn no_arg_to_rust<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
1885 syn::Type::Path(p) => {
1886 if p.qself.is_some() { unimplemented!(); }
1887 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
1888 write!(w, "{}", self.no_arg_path_to_rust(&full_path)).unwrap();
1891 syn::Type::Reference(r) => {
1892 self.no_arg_to_rust(w, &*r.elem, generics);
1898 fn write_conversion_inline_intern<W: std::io::Write,
1899 LP: Fn(&str, bool, bool) -> Option<String>, DL: Fn(&mut W, &DeclType, &str, bool, bool), SC: Fn(bool, Option<&str>) -> String>
1900 (&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, is_ref: bool, is_mut: bool, ptr_for_ref: bool,
1901 tupleconv: &str, prefix: bool, sliceconv: SC, path_lookup: LP, decl_lookup: DL) {
1902 match generics.resolve_type(t) {
1903 syn::Type::Reference(r) => {
1904 self.write_conversion_inline_intern(w, &*r.elem, generics, true, r.mutability.is_some(),
1905 ptr_for_ref, tupleconv, prefix, sliceconv, path_lookup, decl_lookup);
1907 syn::Type::Path(p) => {
1908 if p.qself.is_some() {
1912 let resolved_path = self.resolve_path(&p.path, generics);
1913 if let Some(aliased_type) = self.crate_types.type_aliases.get(&resolved_path) {
1914 return self.write_conversion_inline_intern(w, aliased_type, None, is_ref, is_mut, ptr_for_ref, tupleconv, prefix, sliceconv, path_lookup, decl_lookup);
1915 } else if self.is_primitive(&resolved_path) {
1916 if is_ref && prefix {
1917 write!(w, "*").unwrap();
1919 } else if let Some(c_type) = path_lookup(&resolved_path, is_ref, ptr_for_ref) {
1920 write!(w, "{}", c_type).unwrap();
1921 } else if let Some((_, generics)) = self.crate_types.opaques.get(&resolved_path) {
1922 decl_lookup(w, &DeclType::StructImported { generics: &generics }, &resolved_path, is_ref, is_mut);
1923 } else if self.crate_types.mirrored_enums.get(&resolved_path).is_some() {
1924 decl_lookup(w, &DeclType::MirroredEnum, &resolved_path, is_ref, is_mut);
1925 } else if let Some(t) = self.crate_types.traits.get(&resolved_path) {
1926 decl_lookup(w, &DeclType::Trait(t), &resolved_path, is_ref, is_mut);
1927 } else if let Some(ident) = single_ident_generic_path_to_ident(&p.path) {
1928 if let Some(decl_type) = self.types.maybe_resolve_declared(ident) {
1929 decl_lookup(w, decl_type, &self.maybe_resolve_ident(ident).unwrap(), is_ref, is_mut);
1930 } else { unimplemented!(); }
1931 } else { unimplemented!(); }
1933 syn::Type::Array(a) => {
1934 // We assume all arrays contain only [int_literal; X]s.
1935 // This may result in some outputs not compiling.
1936 if let syn::Expr::Lit(l) = &a.len {
1937 if let syn::Lit::Int(i) = &l.lit {
1938 write!(w, "{}", path_lookup(&format!("[u8; {}]", i.base10_digits()), is_ref, ptr_for_ref).unwrap()).unwrap();
1939 } else { unimplemented!(); }
1940 } else { unimplemented!(); }
1942 syn::Type::Slice(s) => {
1943 // We assume all slices contain only literals or references.
1944 // This may result in some outputs not compiling.
1945 if let syn::Type::Path(p) = &*s.elem {
1946 let resolved = self.resolve_path(&p.path, generics);
1947 if self.is_primitive(&resolved) {
1948 write!(w, "{}", path_lookup("[u8]", is_ref, ptr_for_ref).unwrap()).unwrap();
1950 write!(w, "{}", sliceconv(true, None)).unwrap();
1952 } else if let syn::Type::Reference(r) = &*s.elem {
1953 if let syn::Type::Path(p) = &*r.elem {
1954 write!(w, "{}", sliceconv(self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)), None)).unwrap();
1955 } else if let syn::Type::Slice(_) = &*r.elem {
1956 write!(w, "{}", sliceconv(false, None)).unwrap();
1957 } else { unimplemented!(); }
1958 } else if let syn::Type::Tuple(t) = &*s.elem {
1959 assert!(!t.elems.is_empty());
1961 write!(w, "{}", sliceconv(false, None)).unwrap();
1963 let mut needs_map = false;
1964 for e in t.elems.iter() {
1965 if let syn::Type::Reference(_) = e {
1970 let mut map_str = Vec::new();
1971 write!(&mut map_str, ".map(|(").unwrap();
1972 for i in 0..t.elems.len() {
1973 write!(&mut map_str, "{}{}", if i != 0 { ", " } else { "" }, ('a' as u8 + i as u8) as char).unwrap();
1975 write!(&mut map_str, ")| (").unwrap();
1976 for (idx, e) in t.elems.iter().enumerate() {
1977 if let syn::Type::Reference(_) = e {
1978 write!(&mut map_str, "{}{}", if idx != 0 { ", " } else { "" }, (idx as u8 + 'a' as u8) as char).unwrap();
1979 } else if let syn::Type::Path(_) = e {
1980 write!(&mut map_str, "{}*{}", if idx != 0 { ", " } else { "" }, (idx as u8 + 'a' as u8) as char).unwrap();
1981 } else { unimplemented!(); }
1983 write!(&mut map_str, "))").unwrap();
1984 write!(w, "{}", sliceconv(false, Some(&String::from_utf8(map_str).unwrap()))).unwrap();
1986 write!(w, "{}", sliceconv(false, None)).unwrap();
1989 } else { unimplemented!(); }
1991 syn::Type::Tuple(t) => {
1992 if t.elems.is_empty() {
1993 // cbindgen has poor support for (), see, eg https://github.com/eqrion/cbindgen/issues/527
1994 // so work around it by just pretending its a 0u8
1995 write!(w, "{}", tupleconv).unwrap();
1997 if prefix { write!(w, "local_").unwrap(); }
2000 _ => unimplemented!(),
2004 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) {
2005 self.write_conversion_inline_intern(w, t, generics, is_ref, false, ptr_for_ref, "() /*", true, |_, _| "local_".to_owned(),
2006 |a, b, c| self.to_c_conversion_inline_prefix_from_path(a, b, c),
2007 |w, decl_type, decl_path, is_ref, _is_mut| {
2009 DeclType::MirroredEnum if is_ref && ptr_for_ref => write!(w, "crate::{}::from_native(", decl_path).unwrap(),
2010 DeclType::MirroredEnum if is_ref => write!(w, "&crate::{}::from_native(", decl_path).unwrap(),
2011 DeclType::MirroredEnum => write!(w, "crate::{}::native_into(", decl_path).unwrap(),
2012 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if is_ref && from_ptr => {
2013 if !ptr_for_ref { write!(w, "&").unwrap(); }
2014 write!(w, "crate::{} {{ inner: unsafe {{ (", decl_path).unwrap()
2016 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if is_ref => {
2017 if !ptr_for_ref { write!(w, "&").unwrap(); }
2018 write!(w, "crate::{} {{ inner: unsafe {{ ObjOps::nonnull_ptr_to_inner((", decl_path).unwrap()
2020 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref && from_ptr =>
2021 write!(w, "crate::{} {{ inner: ", decl_path).unwrap(),
2022 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref =>
2023 write!(w, "crate::{} {{ inner: ObjOps::heap_alloc(", decl_path).unwrap(),
2024 DeclType::Trait(_) if is_ref => write!(w, "").unwrap(),
2025 DeclType::Trait(_) if !is_ref => write!(w, "Into::into(").unwrap(),
2026 _ => panic!("{:?}", decl_path),
2030 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) {
2031 self.write_to_c_conversion_inline_prefix_inner(w, t, generics, false, ptr_for_ref, false);
2033 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) {
2034 self.write_conversion_inline_intern(w, t, generics, is_ref, false, ptr_for_ref, "*/", false, |_, _| ".into()".to_owned(),
2035 |a, b, c| self.to_c_conversion_inline_suffix_from_path(a, b, c),
2036 |w, decl_type, full_path, is_ref, _is_mut| match decl_type {
2037 DeclType::MirroredEnum => write!(w, ")").unwrap(),
2038 DeclType::EnumIgnored { generics }|DeclType::StructImported { generics } if is_ref => {
2039 write!(w, " as *const {}<", full_path).unwrap();
2040 for param in generics.params.iter() {
2041 if let syn::GenericParam::Lifetime(_) = param {
2042 write!(w, "'_, ").unwrap();
2044 write!(w, "_, ").unwrap();
2048 write!(w, ">) as *mut _ }}, is_owned: false }}").unwrap();
2050 write!(w, ">) as *mut _) }}, is_owned: false }}").unwrap();
2053 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref && from_ptr =>
2054 write!(w, ", is_owned: true }}").unwrap(),
2055 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref => write!(w, "), is_owned: true }}").unwrap(),
2056 DeclType::Trait(_) if is_ref => {},
2057 DeclType::Trait(_) => {
2058 // This is used when we're converting a concrete Rust type into a C trait
2059 // for use when a Rust trait method returns an associated type.
2060 // Because all of our C traits implement From<RustTypesImplementingTraits>
2061 // we can just call .into() here and be done.
2062 write!(w, ")").unwrap()
2064 _ => unimplemented!(),
2067 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) {
2068 self.write_to_c_conversion_inline_suffix_inner(w, t, generics, false, ptr_for_ref, false);
2071 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) {
2072 self.write_conversion_inline_intern(w, t, generics, is_ref, false, false, "() /*", true, |_, _| "&local_".to_owned(),
2073 |a, b, _c| self.from_c_conversion_prefix_from_path(a, b),
2074 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
2075 DeclType::StructImported {..} if is_ref => write!(w, "").unwrap(),
2076 DeclType::StructImported {..} if !is_ref => write!(w, "*unsafe {{ Box::from_raw(").unwrap(),
2077 DeclType::MirroredEnum if is_ref => write!(w, "&").unwrap(),
2078 DeclType::MirroredEnum => {},
2079 DeclType::Trait(_) => {},
2080 _ => unimplemented!(),
2083 pub fn write_from_c_conversion_prefix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2084 self.write_from_c_conversion_prefix_inner(w, t, generics, false, false);
2086 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) {
2087 self.write_conversion_inline_intern(w, t, generics, is_ref, false, false, "*/", false,
2088 |has_inner, map_str_opt| match (has_inner, map_str_opt) {
2089 (false, Some(map_str)) => format!(".iter(){}.collect::<Vec<_>>()[..]", map_str),
2090 (false, None) => ".iter().collect::<Vec<_>>()[..]".to_owned(),
2091 (true, None) => "[..]".to_owned(),
2092 (true, Some(_)) => unreachable!(),
2094 |a, b, _c| self.from_c_conversion_suffix_from_path(a, b),
2095 |w, decl_type, _full_path, is_ref, is_mut| match decl_type {
2096 DeclType::StructImported {..} if is_ref && ptr_for_ref => write!(w, "XXX unimplemented").unwrap(),
2097 DeclType::StructImported {..} if is_mut && is_ref => write!(w, ".get_native_mut_ref()").unwrap(),
2098 DeclType::StructImported {..} if is_ref => write!(w, ".get_native_ref()").unwrap(),
2099 DeclType::StructImported {..} if !is_ref => write!(w, ".take_inner()) }}").unwrap(),
2100 DeclType::MirroredEnum if is_ref => write!(w, ".to_native()").unwrap(),
2101 DeclType::MirroredEnum => write!(w, ".into_native()").unwrap(),
2102 DeclType::Trait(_) => {},
2103 _ => unimplemented!(),
2106 pub fn write_from_c_conversion_suffix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2107 self.write_from_c_conversion_suffix_inner(w, t, generics, false, false);
2109 // Note that compared to the above conversion functions, the following two are generally
2110 // significantly undertested:
2111 pub fn write_from_c_conversion_to_ref_prefix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2112 self.write_conversion_inline_intern(w, t, generics, false, false, false, "() /*", true, |_, _| "&local_".to_owned(),
2114 if let Some(conv) = self.from_c_conversion_prefix_from_path(a, b) {
2115 Some(format!("&{}", conv))
2118 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
2119 DeclType::StructImported {..} if !is_ref => write!(w, "").unwrap(),
2120 _ => unimplemented!(),
2123 pub fn write_from_c_conversion_to_ref_suffix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2124 self.write_conversion_inline_intern(w, t, generics, false, false, false, "*/", false,
2125 |has_inner, map_str_opt| match (has_inner, map_str_opt) {
2126 (false, Some(map_str)) => format!(".iter(){}.collect::<Vec<_>>()[..]", map_str),
2127 (false, None) => ".iter().collect::<Vec<_>>()[..]".to_owned(),
2128 (true, None) => "[..]".to_owned(),
2129 (true, Some(_)) => unreachable!(),
2131 |a, b, _c| self.from_c_conversion_suffix_from_path(a, b),
2132 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
2133 DeclType::StructImported {..} if !is_ref => write!(w, ".get_native_ref()").unwrap(),
2134 _ => unimplemented!(),
2138 fn write_conversion_new_var_intern<'b, W: std::io::Write,
2139 LP: Fn(&str, bool) -> Option<(&str, &str)>,
2140 LC: Fn(&str, bool, Option<&syn::Type>, &syn::Ident, &str) -> Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)>,
2141 VP: Fn(&mut W, &syn::Type, Option<&GenericTypes>, bool, bool, bool),
2142 VS: Fn(&mut W, &syn::Type, Option<&GenericTypes>, bool, bool, bool)>
2143 (&self, w: &mut W, ident: &syn::Ident, var: &str, t: &syn::Type, generics: Option<&GenericTypes>,
2144 mut is_ref: bool, mut ptr_for_ref: bool, to_c: bool, from_ownable_ref: bool,
2145 path_lookup: &LP, container_lookup: &LC, var_prefix: &VP, var_suffix: &VS) -> bool {
2147 macro_rules! convert_container {
2148 ($container_type: expr, $args_len: expr, $args_iter: expr) => { {
2149 // For slices (and Options), we refuse to directly map them as is_ref when they
2150 // aren't opaque types containing an inner pointer. This is due to the fact that,
2151 // in both cases, the actual higher-level type is non-is_ref.
2152 let ty_has_inner = if $args_len == 1 {
2153 let ty = $args_iter().next().unwrap();
2154 if $container_type == "Slice" && to_c {
2155 // "To C ptr_for_ref" means "return the regular object with is_owned
2156 // set to false", which is totally what we want in a slice if we're about to
2157 // set ty_has_inner.
2160 if let syn::Type::Reference(t) = ty {
2161 if let syn::Type::Path(p) = &*t.elem {
2162 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
2164 } else if let syn::Type::Path(p) = ty {
2165 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
2169 // Options get a bunch of special handling, since in general we map Option<>al
2170 // types into the same C type as non-Option-wrapped types. This ends up being
2171 // pretty manual here and most of the below special-cases are for Options.
2172 let mut needs_ref_map = false;
2173 let mut only_contained_type = None;
2174 let mut only_contained_type_nonref = None;
2175 let mut only_contained_has_inner = false;
2176 let mut contains_slice = false;
2178 only_contained_has_inner = ty_has_inner;
2179 let arg = $args_iter().next().unwrap();
2180 if let syn::Type::Reference(t) = arg {
2181 only_contained_type = Some(arg);
2182 only_contained_type_nonref = Some(&*t.elem);
2183 if let syn::Type::Path(_) = &*t.elem {
2185 } else if let syn::Type::Slice(_) = &*t.elem {
2186 contains_slice = true;
2187 } else { return false; }
2188 // If the inner element contains an inner pointer, we will just use that,
2189 // avoiding the need to map elements to references. Otherwise we'll need to
2190 // do an extra mapping step.
2191 needs_ref_map = !only_contained_has_inner && $container_type == "Option";
2193 only_contained_type = Some(arg);
2194 only_contained_type_nonref = Some(arg);
2198 if let Some((prefix, conversions, suffix, prefix_location)) = container_lookup(&$container_type, is_ref, only_contained_type, ident, var) {
2199 assert_eq!(conversions.len(), $args_len);
2200 write!(w, "let mut local_{}{} = ", ident,
2201 if (!to_c && needs_ref_map) || (to_c && $container_type == "Option" && contains_slice) {"_base"} else { "" }).unwrap();
2202 if prefix_location == ContainerPrefixLocation::OutsideConv {
2203 var_prefix(w, $args_iter().next().unwrap(), generics, is_ref, ptr_for_ref, true);
2205 write!(w, "{}{}", prefix, var).unwrap();
2207 for ((pfx, var_name), (idx, ty)) in conversions.iter().zip($args_iter().enumerate()) {
2208 let mut var = std::io::Cursor::new(Vec::new());
2209 write!(&mut var, "{}", var_name).unwrap();
2210 let var_access = String::from_utf8(var.into_inner()).unwrap();
2212 let conv_ty = if needs_ref_map { only_contained_type_nonref.as_ref().unwrap() } else { ty };
2214 write!(w, "{} {{ ", pfx).unwrap();
2215 let new_var_name = format!("{}_{}", ident, idx);
2216 let new_var = self.write_conversion_new_var_intern(w, &format_ident!("{}", new_var_name),
2217 &var_access, conv_ty, generics, contains_slice || (is_ref && ty_has_inner), ptr_for_ref,
2218 to_c, from_ownable_ref, path_lookup, container_lookup, var_prefix, var_suffix);
2219 if new_var { write!(w, " ").unwrap(); }
2221 if prefix_location == ContainerPrefixLocation::PerConv {
2222 var_prefix(w, conv_ty, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2223 } else if !is_ref && !needs_ref_map && to_c && only_contained_has_inner {
2224 write!(w, "ObjOps::heap_alloc(").unwrap();
2227 write!(w, "{}{}", if contains_slice && !to_c { "local_" } else { "" }, if new_var { new_var_name } else { var_access }).unwrap();
2228 if prefix_location == ContainerPrefixLocation::PerConv {
2229 var_suffix(w, conv_ty, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2230 } else if !is_ref && !needs_ref_map && to_c && only_contained_has_inner {
2231 write!(w, ")").unwrap();
2233 write!(w, " }}").unwrap();
2235 write!(w, "{}", suffix).unwrap();
2236 if prefix_location == ContainerPrefixLocation::OutsideConv {
2237 var_suffix(w, $args_iter().next().unwrap(), generics, is_ref, ptr_for_ref, true);
2239 write!(w, ";").unwrap();
2240 if !to_c && needs_ref_map {
2241 write!(w, " let mut local_{} = local_{}_base.as_ref()", ident, ident).unwrap();
2243 write!(w, ".map(|a| &a[..])").unwrap();
2245 write!(w, ";").unwrap();
2246 } else if to_c && $container_type == "Option" && contains_slice {
2247 write!(w, " let mut local_{} = *local_{}_base;", ident, ident).unwrap();
2254 match generics.resolve_type(t) {
2255 syn::Type::Reference(r) => {
2256 if let syn::Type::Slice(_) = &*r.elem {
2257 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)
2259 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)
2262 syn::Type::Path(p) => {
2263 if p.qself.is_some() {
2266 let resolved_path = self.resolve_path(&p.path, generics);
2267 if let Some(aliased_type) = self.crate_types.type_aliases.get(&resolved_path) {
2268 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);
2270 if self.is_known_container(&resolved_path, is_ref) || self.is_path_transparent_container(&p.path, generics, is_ref) {
2271 if let syn::PathArguments::AngleBracketed(args) = &p.path.segments.iter().next().unwrap().arguments {
2272 convert_container!(resolved_path, args.args.len(), || args.args.iter().map(|arg| {
2273 if let syn::GenericArgument::Type(ty) = arg {
2274 generics.resolve_type(ty)
2275 } else { unimplemented!(); }
2277 } else { unimplemented!(); }
2279 if self.is_primitive(&resolved_path) {
2281 } else if let Some(ty_ident) = single_ident_generic_path_to_ident(&p.path) {
2282 if let Some((prefix, suffix)) = path_lookup(&resolved_path, is_ref) {
2283 write!(w, "let mut local_{} = {}{}{};", ident, prefix, var, suffix).unwrap();
2285 } else if self.types.maybe_resolve_declared(ty_ident).is_some() {
2290 syn::Type::Array(_) => {
2291 // We assume all arrays contain only primitive types.
2292 // This may result in some outputs not compiling.
2295 syn::Type::Slice(s) => {
2296 if let syn::Type::Path(p) = &*s.elem {
2297 let resolved = self.resolve_path(&p.path, generics);
2298 if self.is_primitive(&resolved) {
2299 let slice_path = format!("[{}]", resolved);
2300 if let Some((prefix, suffix)) = path_lookup(&slice_path, true) {
2301 write!(w, "let mut local_{} = {}{}{};", ident, prefix, var, suffix).unwrap();
2305 let tyref = [&*s.elem];
2307 // If we're converting from a slice to a Vec, assume we can clone the
2308 // elements and clone them into a new Vec first. Next we'll walk the
2309 // new Vec here and convert them to C types.
2310 write!(w, "let mut local_{}_clone = Vec::new(); local_{}_clone.extend_from_slice({}); let mut {} = local_{}_clone; ", ident, ident, ident, ident, ident).unwrap();
2313 convert_container!("Vec", 1, || tyref.iter().map(|t| generics.resolve_type(*t)));
2314 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2316 } else if let syn::Type::Reference(ty) = &*s.elem {
2317 let tyref = if from_ownable_ref || !to_c { [&*ty.elem] } else { [&*s.elem] };
2319 convert_container!("Slice", 1, || tyref.iter().map(|t| generics.resolve_type(*t)));
2320 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2321 } else if let syn::Type::Tuple(t) = &*s.elem {
2322 // When mapping into a temporary new var, we need to own all the underlying objects.
2323 // Thus, we drop any references inside the tuple and convert with non-reference types.
2324 let mut elems = syn::punctuated::Punctuated::new();
2325 for elem in t.elems.iter() {
2326 if let syn::Type::Reference(r) = elem {
2327 elems.push((*r.elem).clone());
2329 elems.push(elem.clone());
2332 let ty = [syn::Type::Tuple(syn::TypeTuple {
2333 paren_token: t.paren_token, elems
2337 convert_container!("Slice", 1, || ty.iter());
2338 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2339 } else { unimplemented!() }
2341 syn::Type::Tuple(t) => {
2342 if !t.elems.is_empty() {
2343 // We don't (yet) support tuple elements which cannot be converted inline
2344 write!(w, "let (").unwrap();
2345 for idx in 0..t.elems.len() {
2346 if idx != 0 { write!(w, ", ").unwrap(); }
2347 write!(w, "{} orig_{}_{}", if is_ref { "ref" } else { "mut" }, ident, idx).unwrap();
2349 write!(w, ") = {}{}; ", var, if !to_c { ".to_rust()" } else { "" }).unwrap();
2350 // Like other template types, tuples are always mapped as their non-ref
2351 // versions for types which have different ref mappings. Thus, we convert to
2352 // non-ref versions and handle opaque types with inner pointers manually.
2353 for (idx, elem) in t.elems.iter().enumerate() {
2354 if let syn::Type::Path(p) = elem {
2355 let v_name = format!("orig_{}_{}", ident, idx);
2356 let tuple_elem_ident = format_ident!("{}", &v_name);
2357 if self.write_conversion_new_var_intern(w, &tuple_elem_ident, &v_name, elem, generics,
2358 false, ptr_for_ref, to_c, from_ownable_ref,
2359 path_lookup, container_lookup, var_prefix, var_suffix) {
2360 write!(w, " ").unwrap();
2361 // Opaque types with inner pointers shouldn't ever create new stack
2362 // variables, so we don't handle it and just assert that it doesn't
2364 assert!(!self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)));
2368 write!(w, "let mut local_{} = (", ident).unwrap();
2369 for (idx, elem) in t.elems.iter().enumerate() {
2370 let real_elem = generics.resolve_type(&elem);
2371 let ty_has_inner = {
2373 // "To C ptr_for_ref" means "return the regular object with
2374 // is_owned set to false", which is totally what we want
2375 // if we're about to set ty_has_inner.
2378 if let syn::Type::Reference(t) = real_elem {
2379 if let syn::Type::Path(p) = &*t.elem {
2380 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
2382 } else if let syn::Type::Path(p) = real_elem {
2383 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
2386 if idx != 0 { write!(w, ", ").unwrap(); }
2387 var_prefix(w, real_elem, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2388 if is_ref && ty_has_inner {
2389 // For ty_has_inner, the regular var_prefix mapping will take a
2390 // reference, so deref once here to make sure we keep the original ref.
2391 write!(w, "*").unwrap();
2393 write!(w, "orig_{}_{}", ident, idx).unwrap();
2394 if is_ref && !ty_has_inner {
2395 // If we don't have an inner variable's reference to maintain, just
2396 // hope the type is Clonable and use that.
2397 write!(w, ".clone()").unwrap();
2399 var_suffix(w, real_elem, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2401 write!(w, "){};", if to_c { ".into()" } else { "" }).unwrap();
2405 _ => unimplemented!(),
2409 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 {
2410 self.write_conversion_new_var_intern(w, ident, var_access, t, generics, from_ownable_ref, ptr_for_ref, true, from_ownable_ref,
2411 &|a, b| self.to_c_conversion_new_var_from_path(a, b),
2412 &|a, b, c, d, e| self.to_c_conversion_container_new_var(generics, a, b, c, d, e),
2413 // We force ptr_for_ref here since we can't generate a ref on one line and use it later
2414 &|a, b, c, d, e, f| self.write_to_c_conversion_inline_prefix_inner(a, b, c, d, e, f),
2415 &|a, b, c, d, e, f| self.write_to_c_conversion_inline_suffix_inner(a, b, c, d, e, f))
2417 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 {
2418 self.write_to_c_conversion_new_var_inner(w, ident, &format!("{}", ident), t, generics, ptr_for_ref, false)
2420 /// Prints new-var conversion for an "ownable_ref" type, ie prints conversion for
2421 /// `create_ownable_reference(t)`, not `t` itself.
2422 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 {
2423 self.write_to_c_conversion_new_var_inner(w, ident, &format!("{}", ident), t, generics, true, true)
2425 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 {
2426 self.write_conversion_new_var_intern(w, ident, &format!("{}", ident), t, generics, false, false, false, false,
2427 &|a, b| self.from_c_conversion_new_var_from_path(a, b),
2428 &|a, b, c, d, e| self.from_c_conversion_container_new_var(generics, a, b, c, d, e),
2429 // We force ptr_for_ref here since we can't generate a ref on one line and use it later
2430 &|a, b, c, d, e, _f| self.write_from_c_conversion_prefix_inner(a, b, c, d, e),
2431 &|a, b, c, d, e, _f| self.write_from_c_conversion_suffix_inner(a, b, c, d, e))
2434 // ******************************************************
2435 // *** C Container Type Equivalent and alias Printing ***
2436 // ******************************************************
2438 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 {
2439 for (idx, t) in args.enumerate() {
2441 write!(w, ", ").unwrap();
2443 if let syn::Type::Reference(r_arg) = t {
2444 assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
2446 if !self.write_c_type_intern(w, &*r_arg.elem, generics, false, false, false, true, true) { return false; }
2448 // While write_c_type_intern, above is correct, we don't want to blindly convert a
2449 // reference to something stupid, so check that the container is either opaque or a
2450 // predefined type (currently only Transaction).
2451 if let syn::Type::Path(p_arg) = &*r_arg.elem {
2452 let resolved = self.resolve_path(&p_arg.path, generics);
2453 assert!(self.crate_types.opaques.get(&resolved).is_some() ||
2454 self.c_type_from_path(&resolved, true, true).is_some(), "Template generics should be opaque or have a predefined mapping");
2455 } else { unimplemented!(); }
2456 } else if let syn::Type::Path(p_arg) = t {
2457 if let Some(resolved) = self.maybe_resolve_path(&p_arg.path, generics) {
2458 if !self.is_primitive(&resolved) {
2459 assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
2462 assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
2464 if !self.write_c_type_intern(w, t, generics, false, false, false, true, true) { return false; }
2466 // We don't currently support outer reference types for non-primitive inners,
2467 // except for the empty tuple.
2468 if let syn::Type::Tuple(t_arg) = t {
2469 assert!(t_arg.elems.len() == 0 || !is_ref);
2473 if !self.write_c_type_intern(w, t, generics, false, false, false, true, true) { return false; }
2478 fn check_create_container(&self, mangled_container: String, container_type: &str, args: Vec<&syn::Type>, generics: Option<&GenericTypes>, is_ref: bool) -> bool {
2479 if !self.crate_types.templates_defined.borrow().get(&mangled_container).is_some() {
2480 let mut created_container: Vec<u8> = Vec::new();
2482 if container_type == "Result" {
2483 let mut a_ty: Vec<u8> = Vec::new();
2484 if let syn::Type::Tuple(tup) = args.iter().next().unwrap() {
2485 if tup.elems.is_empty() {
2486 write!(&mut a_ty, "()").unwrap();
2488 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t).take(1), generics, is_ref) { return false; }
2491 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t).take(1), generics, is_ref) { return false; }
2494 let mut b_ty: Vec<u8> = Vec::new();
2495 if let syn::Type::Tuple(tup) = args.iter().skip(1).next().unwrap() {
2496 if tup.elems.is_empty() {
2497 write!(&mut b_ty, "()").unwrap();
2499 if !self.write_template_generics(&mut b_ty, &mut args.iter().map(|t| *t).skip(1), generics, is_ref) { return false; }
2502 if !self.write_template_generics(&mut b_ty, &mut args.iter().map(|t| *t).skip(1), generics, is_ref) { return false; }
2505 let ok_str = String::from_utf8(a_ty).unwrap();
2506 let err_str = String::from_utf8(b_ty).unwrap();
2507 let is_clonable = self.is_clonable(&ok_str) && self.is_clonable(&err_str);
2508 write_result_block(&mut created_container, &mangled_container, &ok_str, &err_str, is_clonable);
2510 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2512 } else if container_type == "Vec" {
2513 let mut a_ty: Vec<u8> = Vec::new();
2514 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t), generics, is_ref) { return false; }
2515 let ty = String::from_utf8(a_ty).unwrap();
2516 let is_clonable = self.is_clonable(&ty);
2517 write_vec_block(&mut created_container, &mangled_container, &ty, is_clonable);
2519 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2521 } else if container_type.ends_with("Tuple") {
2522 let mut tuple_args = Vec::new();
2523 let mut is_clonable = true;
2524 for arg in args.iter() {
2525 let mut ty: Vec<u8> = Vec::new();
2526 if !self.write_template_generics(&mut ty, &mut [arg].iter().map(|t| **t), generics, is_ref) { return false; }
2527 let ty_str = String::from_utf8(ty).unwrap();
2528 if !self.is_clonable(&ty_str) {
2529 is_clonable = false;
2531 tuple_args.push(ty_str);
2533 write_tuple_block(&mut created_container, &mangled_container, &tuple_args, is_clonable);
2535 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2537 } else if container_type == "Option" {
2538 let mut a_ty: Vec<u8> = Vec::new();
2539 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t), generics, is_ref) { return false; }
2540 let ty = String::from_utf8(a_ty).unwrap();
2541 let is_clonable = self.is_clonable(&ty);
2542 write_option_block(&mut created_container, &mangled_container, &ty, is_clonable);
2544 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2549 self.crate_types.write_new_template(mangled_container.clone(), true, &created_container);
2553 fn path_to_generic_args(path: &syn::Path) -> Vec<&syn::Type> {
2554 if let syn::PathArguments::AngleBracketed(args) = &path.segments.iter().next().unwrap().arguments {
2555 args.args.iter().map(|gen| if let syn::GenericArgument::Type(t) = gen { t } else { unimplemented!() }).collect()
2556 } else { unimplemented!(); }
2558 fn write_c_mangled_container_path_intern<W: std::io::Write>
2559 (&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 {
2560 let mut mangled_type: Vec<u8> = Vec::new();
2561 if !self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) {
2562 write!(w, "C{}_", ident).unwrap();
2563 write!(mangled_type, "C{}_", ident).unwrap();
2564 } else { assert_eq!(args.len(), 1); }
2565 for arg in args.iter() {
2566 macro_rules! write_path {
2567 ($p_arg: expr, $extra_write: expr) => {
2568 if let Some(subtype) = self.maybe_resolve_path(&$p_arg.path, generics) {
2569 if self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) {
2571 if self.c_type_has_inner_from_path(&subtype) {
2572 if !self.write_c_path_intern(w, &$p_arg.path, generics, is_ref, is_mut, ptr_for_ref, false, true) { return false; }
2574 if let Some(arr_ty) = self.is_real_type_array(&subtype) {
2575 if !self.write_c_type_intern(w, &arr_ty, generics, false, true, false, false, true) { return false; }
2577 // Option<T> needs to be converted to a *mut T, ie mut ptr-for-ref
2578 if !self.write_c_path_intern(w, &$p_arg.path, generics, true, true, true, false, true) { return false; }
2582 write!(w, "{}", $p_arg.path.segments.last().unwrap().ident).unwrap();
2584 } else if self.is_known_container(&subtype, is_ref) || self.is_path_transparent_container(&$p_arg.path, generics, is_ref) {
2585 if !self.write_c_mangled_container_path_intern(w, Self::path_to_generic_args(&$p_arg.path), generics,
2586 &subtype, is_ref, is_mut, ptr_for_ref, true) {
2589 self.write_c_mangled_container_path_intern(&mut mangled_type, Self::path_to_generic_args(&$p_arg.path),
2590 generics, &subtype, is_ref, is_mut, ptr_for_ref, true);
2591 if let Some(w2) = $extra_write as Option<&mut Vec<u8>> {
2592 self.write_c_mangled_container_path_intern(w2, Self::path_to_generic_args(&$p_arg.path),
2593 generics, &subtype, is_ref, is_mut, ptr_for_ref, true);
2596 let id = subtype.rsplitn(2, ':').next().unwrap(); // Get the "Base" name of the resolved type
2597 write!(w, "{}", id).unwrap();
2598 write!(mangled_type, "{}", id).unwrap();
2599 if let Some(w2) = $extra_write as Option<&mut Vec<u8>> {
2600 write!(w2, "{}", id).unwrap();
2603 } else { return false; }
2606 match generics.resolve_type(arg) {
2607 syn::Type::Tuple(tuple) => {
2608 if tuple.elems.len() == 0 {
2609 write!(w, "None").unwrap();
2610 write!(mangled_type, "None").unwrap();
2612 let mut mangled_tuple_type: Vec<u8> = Vec::new();
2614 // Figure out what the mangled type should look like. To disambiguate
2615 // ((A, B), C) and (A, B, C) we prefix the generic args with a _ and suffix
2616 // them with a Z. Ideally we wouldn't use Z, but not many special chars are
2617 // available for use in type names.
2618 write!(w, "C{}Tuple_", tuple.elems.len()).unwrap();
2619 write!(mangled_type, "C{}Tuple_", tuple.elems.len()).unwrap();
2620 write!(mangled_tuple_type, "C{}Tuple_", tuple.elems.len()).unwrap();
2621 for elem in tuple.elems.iter() {
2622 if let syn::Type::Path(p) = elem {
2623 write_path!(p, Some(&mut mangled_tuple_type));
2624 } else if let syn::Type::Reference(refelem) = elem {
2625 if let syn::Type::Path(p) = &*refelem.elem {
2626 write_path!(p, Some(&mut mangled_tuple_type));
2627 } else { return false; }
2628 } else { return false; }
2630 write!(w, "Z").unwrap();
2631 write!(mangled_type, "Z").unwrap();
2632 write!(mangled_tuple_type, "Z").unwrap();
2633 if !self.check_create_container(String::from_utf8(mangled_tuple_type).unwrap(),
2634 &format!("{}Tuple", tuple.elems.len()), tuple.elems.iter().collect(), generics, is_ref) {
2639 syn::Type::Path(p_arg) => {
2640 write_path!(p_arg, None);
2642 syn::Type::Reference(refty) => {
2643 if let syn::Type::Path(p_arg) = &*refty.elem {
2644 write_path!(p_arg, None);
2645 } else if let syn::Type::Slice(_) = &*refty.elem {
2646 // write_c_type will actually do exactly what we want here, we just need to
2647 // make it a pointer so that its an option. Note that we cannot always convert
2648 // the Vec-as-slice (ie non-ref types) containers, so sometimes need to be able
2649 // to edit it, hence we use *mut here instead of *const.
2650 if args.len() != 1 { return false; }
2651 write!(w, "*mut ").unwrap();
2652 self.write_c_type(w, arg, None, true);
2653 } else { return false; }
2655 syn::Type::Array(a) => {
2656 if let syn::Type::Path(p_arg) = &*a.elem {
2657 let resolved = self.resolve_path(&p_arg.path, generics);
2658 if !self.is_primitive(&resolved) { return false; }
2659 if let syn::Expr::Lit(syn::ExprLit { lit: syn::Lit::Int(len), .. }) = &a.len {
2660 if self.c_type_from_path(&format!("[{}; {}]", resolved, len.base10_digits()), is_ref, ptr_for_ref).is_none() { return false; }
2661 if in_type || args.len() != 1 {
2662 write!(w, "_{}{}", resolved, len.base10_digits()).unwrap();
2663 write!(mangled_type, "_{}{}", resolved, len.base10_digits()).unwrap();
2665 let arrty = format!("[{}; {}]", resolved, len.base10_digits());
2666 let realty = self.c_type_from_path(&arrty, is_ref, ptr_for_ref).unwrap_or(&arrty);
2667 write!(w, "{}", realty).unwrap();
2668 write!(mangled_type, "{}", realty).unwrap();
2670 } else { return false; }
2671 } else { return false; }
2673 _ => { return false; },
2676 if self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) { return true; }
2677 // Push the "end of type" Z
2678 write!(w, "Z").unwrap();
2679 write!(mangled_type, "Z").unwrap();
2681 // Make sure the type is actually defined:
2682 self.check_create_container(String::from_utf8(mangled_type).unwrap(), ident, args, generics, is_ref)
2684 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 {
2685 if !self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) {
2686 write!(w, "{}::", Self::generated_container_path()).unwrap();
2688 self.write_c_mangled_container_path_intern(w, args, generics, ident, is_ref, is_mut, ptr_for_ref, false)
2690 pub fn get_c_mangled_container_type(&self, args: Vec<&syn::Type>, generics: Option<&GenericTypes>, template_name: &str) -> Option<String> {
2691 let mut out = Vec::new();
2692 if !self.write_c_mangled_container_path(&mut out, args, generics, template_name, false, false, false) {
2695 Some(String::from_utf8(out).unwrap())
2698 // **********************************
2699 // *** C Type Equivalent Printing ***
2700 // **********************************
2702 fn write_c_path_intern<W: std::io::Write>(&self, w: &mut W, path: &syn::Path, generics: Option<&GenericTypes>, is_ref: bool, is_mut: bool, ptr_for_ref: bool, with_ref_lifetime: bool, c_ty: bool) -> bool {
2703 let full_path = match self.maybe_resolve_path(&path, generics) {
2704 Some(path) => path, None => return false };
2705 if let Some(c_type) = self.c_type_from_path(&full_path, is_ref, ptr_for_ref) {
2706 write!(w, "{}", c_type).unwrap();
2708 } else if self.crate_types.traits.get(&full_path).is_some() {
2709 // Note that we always use the crate:: prefix here as we are always referring to a
2710 // concrete object which is of the generated type, it just implements the upstream
2712 if is_ref && ptr_for_ref {
2713 write!(w, "*{} crate::{}", if is_mut { "mut" } else { "const" }, full_path).unwrap();
2715 if with_ref_lifetime { unimplemented!(); }
2716 write!(w, "&{}crate::{}", if is_mut { "mut " } else { "" }, full_path).unwrap();
2718 write!(w, "crate::{}", full_path).unwrap();
2721 } else if self.crate_types.opaques.get(&full_path).is_some() || self.crate_types.mirrored_enums.get(&full_path).is_some() {
2722 let crate_pfx = if c_ty { "crate::" } else { "" };
2723 if is_ref && ptr_for_ref {
2724 // ptr_for_ref implies we're returning the object, which we can't really do for
2725 // opaque or mirrored types without box'ing them, which is quite a waste, so return
2726 // the actual object itself (for opaque types we'll set the pointer to the actual
2727 // type and note that its a reference).
2728 write!(w, "{}{}", crate_pfx, full_path).unwrap();
2729 } else if is_ref && with_ref_lifetime {
2731 // If we're concretizing something with a lifetime parameter, we have to pick a
2732 // lifetime, of which the only real available choice is `static`, obviously.
2733 write!(w, "&'static {}", crate_pfx).unwrap();
2735 self.write_rust_path(w, generics, path);
2737 // We shouldn't be mapping references in types, so panic here
2741 write!(w, "&{}{}{}", if is_mut { "mut " } else { "" }, crate_pfx, full_path).unwrap();
2743 write!(w, "{}{}", crate_pfx, full_path).unwrap();
2750 fn write_c_type_intern<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, is_ref: bool, is_mut: bool, ptr_for_ref: bool, with_ref_lifetime: bool, c_ty: bool) -> bool {
2751 match generics.resolve_type(t) {
2752 syn::Type::Path(p) => {
2753 if p.qself.is_some() {
2756 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
2757 if self.is_known_container(&full_path, is_ref) || self.is_path_transparent_container(&p.path, generics, is_ref) {
2758 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);
2760 if let Some(aliased_type) = self.crate_types.type_aliases.get(&full_path).cloned() {
2761 return self.write_c_type_intern(w, &aliased_type, None, is_ref, is_mut, ptr_for_ref, with_ref_lifetime, c_ty);
2764 self.write_c_path_intern(w, &p.path, generics, is_ref, is_mut, ptr_for_ref, with_ref_lifetime, c_ty)
2766 syn::Type::Reference(r) => {
2767 self.write_c_type_intern(w, &*r.elem, generics, true, r.mutability.is_some(), ptr_for_ref, with_ref_lifetime, c_ty)
2769 syn::Type::Array(a) => {
2770 if is_ref && is_mut {
2771 write!(w, "*mut [").unwrap();
2772 if !self.write_c_type_intern(w, &a.elem, generics, false, false, ptr_for_ref, with_ref_lifetime, c_ty) { return false; }
2774 write!(w, "*const [").unwrap();
2775 if !self.write_c_type_intern(w, &a.elem, generics, false, false, ptr_for_ref, with_ref_lifetime, c_ty) { return false; }
2777 let mut typecheck = Vec::new();
2778 if !self.write_c_type_intern(&mut typecheck, &a.elem, generics, false, false, ptr_for_ref, with_ref_lifetime, c_ty) { return false; }
2779 if typecheck[..] != ['u' as u8, '8' as u8] { return false; }
2781 if let syn::Expr::Lit(l) = &a.len {
2782 if let syn::Lit::Int(i) = &l.lit {
2784 if let Some(ty) = self.c_type_from_path(&format!("[u8; {}]", i.base10_digits()), false, ptr_for_ref) {
2785 write!(w, "{}", ty).unwrap();
2789 write!(w, "; {}]", i).unwrap();
2795 syn::Type::Slice(s) => {
2796 if !is_ref || is_mut { return false; }
2797 if let syn::Type::Path(p) = &*s.elem {
2798 let resolved = self.resolve_path(&p.path, generics);
2799 if self.is_primitive(&resolved) {
2800 write!(w, "{}::{}slice", Self::container_templ_path(), resolved).unwrap();
2803 let mut inner_c_ty = Vec::new();
2804 assert!(self.write_c_path_intern(&mut inner_c_ty, &p.path, generics, true, false, ptr_for_ref, with_ref_lifetime, c_ty));
2805 if self.is_clonable(&String::from_utf8(inner_c_ty).unwrap()) {
2806 if let Some(id) = p.path.get_ident() {
2807 let mangled_container = format!("CVec_{}Z", id);
2808 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
2809 self.check_create_container(mangled_container, "Vec", vec![&*s.elem], generics, false)
2813 } else if let syn::Type::Reference(r) = &*s.elem {
2814 if let syn::Type::Path(p) = &*r.elem {
2815 // Slices with "real types" inside are mapped as the equivalent non-ref Vec
2816 let resolved = self.resolve_path(&p.path, generics);
2817 let mangled_container = if let Some((ident, _)) = self.crate_types.opaques.get(&resolved) {
2818 format!("CVec_{}Z", ident)
2819 } else if let Some(en) = self.crate_types.mirrored_enums.get(&resolved) {
2820 format!("CVec_{}Z", en.ident)
2821 } else if let Some(id) = p.path.get_ident() {
2822 format!("CVec_{}Z", id)
2823 } else { return false; };
2824 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
2825 self.check_create_container(mangled_container, "Vec", vec![&*r.elem], generics, false)
2826 } else if let syn::Type::Slice(sl2) = &*r.elem {
2827 if let syn::Type::Reference(r2) = &*sl2.elem {
2828 if let syn::Type::Path(p) = &*r2.elem {
2829 // Slices with slices with opaque types (with is_owned flags) are mapped as non-ref Vecs
2830 let resolved = self.resolve_path(&p.path, generics);
2831 let mangled_container = if let Some((ident, _)) = self.crate_types.opaques.get(&resolved) {
2832 format!("CVec_CVec_{}ZZ", ident)
2833 } else { return false; };
2834 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
2835 let inner = &r2.elem;
2836 let vec_ty: syn::Type = syn::parse_quote!(Vec<#inner>);
2837 self.check_create_container(mangled_container, "Vec", vec![&vec_ty], generics, false)
2841 } else if let syn::Type::Tuple(_) = &*s.elem {
2842 let mut args = syn::punctuated::Punctuated::<_, syn::token::Comma>::new();
2843 args.push(syn::GenericArgument::Type((*s.elem).clone()));
2844 let mut segments = syn::punctuated::Punctuated::new();
2845 segments.push(parse_quote!(Vec<#args>));
2846 self.write_c_type_intern(w, &syn::Type::Path(syn::TypePath { qself: None, path: syn::Path { leading_colon: None, segments } }), generics, false, is_mut, ptr_for_ref, with_ref_lifetime, c_ty)
2849 syn::Type::Tuple(t) => {
2850 if t.elems.len() == 0 {
2853 self.write_c_mangled_container_path(w, t.elems.iter().collect(), generics,
2854 &format!("{}Tuple", t.elems.len()), is_ref, is_mut, ptr_for_ref)
2860 pub fn write_c_type<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, ptr_for_ref: bool) {
2861 assert!(self.write_c_type_intern(w, t, generics, false, false, ptr_for_ref, false, true));
2863 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) {
2864 assert!(self.write_c_type_intern(w, t, generics, false, false, ptr_for_ref, true, false));
2866 pub fn understood_c_path(&self, p: &syn::Path) -> bool {
2867 self.write_c_path_intern(&mut std::io::sink(), p, None, false, false, false, false, true)
2869 pub fn understood_c_type(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> bool {
2870 self.write_c_type_intern(&mut std::io::sink(), t, generics, false, false, false, false, true)