1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE>
5 // or the MIT license <LICENSE-MIT>, at your option.
6 // You may not use this file except in accordance with one or both of these
9 use std::cell::RefCell;
10 use std::collections::{HashMap, HashSet};
17 use proc_macro2::{TokenTree, Span};
18 use quote::format_ident;
21 // The following utils are used purely to build our known types maps - they break down all the
22 // types we need to resolve to include the given object, and no more.
24 pub fn first_seg_self<'a>(t: &'a syn::Type) -> Option<impl Iterator<Item=&syn::PathSegment> + 'a> {
26 syn::Type::Path(p) => {
27 if p.qself.is_some() || p.path.leading_colon.is_some() {
30 let mut segs = p.path.segments.iter();
31 let ty = segs.next().unwrap();
32 if !ty.arguments.is_empty() { return None; }
33 if format!("{}", ty.ident) == "Self" {
41 pub fn get_single_remaining_path_seg<'a, I: Iterator<Item=&'a syn::PathSegment>>(segs: &mut I) -> Option<&'a syn::Ident> {
42 if let Some(ty) = segs.next() {
43 if !ty.arguments.is_empty() { unimplemented!(); }
44 if segs.next().is_some() { return None; }
49 pub fn first_seg_is_stdlib(first_seg_str: &str) -> bool {
50 first_seg_str == "std" || first_seg_str == "core" || first_seg_str == "alloc"
53 pub fn single_ident_generic_path_to_ident(p: &syn::Path) -> Option<&syn::Ident> {
54 if p.segments.len() == 1 {
55 Some(&p.segments.iter().next().unwrap().ident)
59 pub fn path_matches_nongeneric(p: &syn::Path, exp: &[&str]) -> bool {
60 if p.segments.len() != exp.len() { return false; }
61 for (seg, e) in p.segments.iter().zip(exp.iter()) {
62 if seg.arguments != syn::PathArguments::None { return false; }
63 if &format!("{}", seg.ident) != *e { return false; }
68 #[derive(Debug, PartialEq)]
69 pub enum ExportStatus {
73 /// This is used only for traits to indicate that users should not be able to implement their
74 /// own version of a trait, but we should export Rust implementations of the trait (and the
76 /// Concretly, this means that we do not implement the Rust trait for the C trait struct.
79 /// Gets the ExportStatus of an object (struct, fn, etc) given its attributes.
80 pub fn export_status(attrs: &[syn::Attribute]) -> ExportStatus {
81 for attr in attrs.iter() {
82 let tokens_clone = attr.tokens.clone();
83 let mut token_iter = tokens_clone.into_iter();
84 if let Some(token) = token_iter.next() {
86 TokenTree::Punct(c) if c.as_char() == '=' => {
87 // Really not sure where syn gets '=' from here -
88 // it somehow represents '///' or '//!'
90 TokenTree::Group(g) => {
91 if format!("{}", single_ident_generic_path_to_ident(&attr.path).unwrap()) == "cfg" {
92 let mut iter = g.stream().into_iter();
93 if let TokenTree::Ident(i) = iter.next().unwrap() {
95 // #[cfg(any(test, feature = ""))]
96 if let TokenTree::Group(g) = iter.next().unwrap() {
97 let mut all_test = true;
98 for token in g.stream().into_iter() {
99 if let TokenTree::Ident(i) = token {
100 match format!("{}", i).as_str() {
103 _ => all_test = false,
105 } else if let TokenTree::Literal(lit) = token {
106 if format!("{}", lit) != "fuzztarget" {
111 if all_test { return ExportStatus::TestOnly; }
113 } else if i == "test" {
114 return ExportStatus::TestOnly;
118 continue; // eg #[derive()]
120 _ => unimplemented!(),
123 match token_iter.next().unwrap() {
124 TokenTree::Literal(lit) => {
125 let line = format!("{}", lit);
126 if line.contains("(C-not exported)") {
127 return ExportStatus::NoExport;
128 } else if line.contains("(C-not implementable)") {
129 return ExportStatus::NotImplementable;
132 _ => unimplemented!(),
138 pub fn assert_simple_bound(bound: &syn::TraitBound) {
139 if bound.paren_token.is_some() || bound.lifetimes.is_some() { unimplemented!(); }
140 if let syn::TraitBoundModifier::Maybe(_) = bound.modifier { unimplemented!(); }
143 /// Returns true if the enum will be mapped as an opaue (ie struct with a pointer to the underlying
144 /// type), otherwise it is mapped into a transparent, C-compatible version of itself.
145 pub fn is_enum_opaque(e: &syn::ItemEnum) -> bool {
146 for var in e.variants.iter() {
147 if let syn::Fields::Named(fields) = &var.fields {
148 for field in fields.named.iter() {
149 match export_status(&field.attrs) {
150 ExportStatus::Export|ExportStatus::TestOnly => {},
151 ExportStatus::NotImplementable => panic!("(C-not implementable) should only appear on traits!"),
152 ExportStatus::NoExport => return true,
155 } else if let syn::Fields::Unnamed(fields) = &var.fields {
156 for field in fields.unnamed.iter() {
157 match export_status(&field.attrs) {
158 ExportStatus::Export|ExportStatus::TestOnly => {},
159 ExportStatus::NotImplementable => panic!("(C-not implementable) should only appear on traits!"),
160 ExportStatus::NoExport => return true,
168 /// A stack of sets of generic resolutions.
170 /// This tracks the template parameters for a function, struct, or trait, allowing resolution into
171 /// a concrete type. By pushing a new context onto the stack, this can track a function's template
172 /// parameters inside of a generic struct or trait.
174 /// It maps both direct types as well as Deref<Target = X>, mapping them via the provided
175 /// TypeResolver's resolve_path function (ie traits map to the concrete jump table, structs to the
176 /// concrete C container struct, etc).
178 pub struct GenericTypes<'a, 'b> {
179 self_ty: Option<String>,
180 parent: Option<&'b GenericTypes<'b, 'b>>,
181 typed_generics: HashMap<&'a syn::Ident, String>,
182 default_generics: HashMap<&'a syn::Ident, (syn::Type, syn::Type)>,
184 impl<'a, 'p: 'a> GenericTypes<'a, 'p> {
185 pub fn new(self_ty: Option<String>) -> Self {
186 Self { self_ty, parent: None, typed_generics: HashMap::new(), default_generics: HashMap::new(), }
189 /// push a new context onto the stack, allowing for a new set of generics to be learned which
190 /// will override any lower contexts, but which will still fall back to resoltion via lower
192 pub fn push_ctx<'c>(&'c self) -> GenericTypes<'a, 'c> {
193 GenericTypes { self_ty: None, parent: Some(self), typed_generics: HashMap::new(), default_generics: HashMap::new(), }
196 /// Learn the generics in generics in the current context, given a TypeResolver.
197 pub fn learn_generics<'b, 'c>(&mut self, generics: &'a syn::Generics, types: &'b TypeResolver<'a, 'c>) -> bool {
198 let mut new_typed_generics = HashMap::new();
199 // First learn simple generics...
200 for generic in generics.params.iter() {
202 syn::GenericParam::Type(type_param) => {
203 let mut non_lifetimes_processed = false;
204 'bound_loop: for bound in type_param.bounds.iter() {
205 if let syn::TypeParamBound::Trait(trait_bound) = bound {
206 if let Some(ident) = single_ident_generic_path_to_ident(&trait_bound.path) {
207 match &format!("{}", ident) as &str { "Send" => continue, "Sync" => continue, _ => {} }
209 if path_matches_nongeneric(&trait_bound.path, &["core", "clone", "Clone"]) { continue; }
211 assert_simple_bound(&trait_bound);
212 if let Some(path) = types.maybe_resolve_path(&trait_bound.path, None) {
213 if types.skip_path(&path) { continue; }
214 if path == "Sized" { continue; }
215 if non_lifetimes_processed { return false; }
216 non_lifetimes_processed = true;
217 if path != "std::ops::Deref" && path != "core::ops::Deref" {
218 new_typed_generics.insert(&type_param.ident, Some(path));
219 } else if trait_bound.path.segments.len() == 1 {
220 // If we're templated on Deref<Target = ConcreteThing>, store
221 // the reference type in `default_generics` which handles full
222 // types and not just paths.
223 if let syn::PathArguments::AngleBracketed(ref args) =
224 trait_bound.path.segments[0].arguments {
225 for subargument in args.args.iter() {
227 syn::GenericArgument::Lifetime(_) => {},
228 syn::GenericArgument::Binding(ref b) => {
229 if &format!("{}", b.ident) != "Target" { return false; }
231 self.default_generics.insert(&type_param.ident, (parse_quote!(&#default), parse_quote!(&#default)));
234 _ => unimplemented!(),
238 new_typed_generics.insert(&type_param.ident, None);
244 if let Some(default) = type_param.default.as_ref() {
245 assert!(type_param.bounds.is_empty());
246 self.default_generics.insert(&type_param.ident, (default.clone(), parse_quote!(&#default)));
252 // Then find generics where we are required to pass a Deref<Target=X> and pretend its just X.
253 if let Some(wh) = &generics.where_clause {
254 for pred in wh.predicates.iter() {
255 if let syn::WherePredicate::Type(t) = pred {
256 if let syn::Type::Path(p) = &t.bounded_ty {
257 if p.qself.is_some() { return false; }
258 if p.path.leading_colon.is_some() { return false; }
259 let mut p_iter = p.path.segments.iter();
260 if let Some(gen) = new_typed_generics.get_mut(&p_iter.next().unwrap().ident) {
261 if gen.is_some() { return false; }
262 if &format!("{}", p_iter.next().unwrap().ident) != "Target" {return false; }
264 let mut non_lifetimes_processed = false;
265 for bound in t.bounds.iter() {
266 if let syn::TypeParamBound::Trait(trait_bound) = bound {
267 if let Some(id) = trait_bound.path.get_ident() {
268 if format!("{}", id) == "Sized" { continue; }
270 if non_lifetimes_processed { return false; }
271 non_lifetimes_processed = true;
272 assert_simple_bound(&trait_bound);
273 *gen = Some(types.resolve_path(&trait_bound.path, None));
276 } else { return false; }
277 } else { return false; }
281 for (key, value) in new_typed_generics.drain() {
282 if let Some(v) = value {
283 assert!(self.typed_generics.insert(key, v).is_none());
284 } else { return false; }
289 /// Learn the associated types from the trait in the current context.
290 pub fn learn_associated_types<'b, 'c>(&mut self, t: &'a syn::ItemTrait, types: &'b TypeResolver<'a, 'c>) {
291 for item in t.items.iter() {
293 &syn::TraitItem::Type(ref t) => {
294 if t.default.is_some() || t.generics.lt_token.is_some() { unimplemented!(); }
295 let mut bounds_iter = t.bounds.iter();
297 match bounds_iter.next().unwrap() {
298 syn::TypeParamBound::Trait(tr) => {
299 assert_simple_bound(&tr);
300 if let Some(path) = types.maybe_resolve_path(&tr.path, None) {
301 if types.skip_path(&path) { continue; }
302 // In general we handle Deref<Target=X> as if it were just X (and
303 // implement Deref<Target=Self> for relevant types). We don't
304 // bother to implement it for associated types, however, so we just
305 // ignore such bounds.
306 if path != "std::ops::Deref" && path != "core::ops::Deref" {
307 self.typed_generics.insert(&t.ident, path);
309 } else { unimplemented!(); }
310 for bound in bounds_iter {
311 if let syn::TypeParamBound::Trait(_) = bound { unimplemented!(); }
315 syn::TypeParamBound::Lifetime(_) => {},
324 /// Attempt to resolve a Path as a generic parameter and return the full path. as both a string
326 pub fn maybe_resolve_path<'b>(&'b self, path: &syn::Path) -> Option<&'b String> {
327 if let Some(ident) = path.get_ident() {
328 if let Some(ty) = &self.self_ty {
329 if format!("{}", ident) == "Self" {
333 if let Some(res) = self.typed_generics.get(ident) {
337 // Associated types are usually specified as "Self::Generic", so we check for that
339 let mut it = path.segments.iter();
340 if path.segments.len() == 2 && format!("{}", it.next().unwrap().ident) == "Self" {
341 let ident = &it.next().unwrap().ident;
342 if let Some(res) = self.typed_generics.get(ident) {
347 if let Some(parent) = self.parent {
348 parent.maybe_resolve_path(path)
355 pub trait ResolveType<'a> { fn resolve_type(&'a self, ty: &'a syn::Type) -> &'a syn::Type; }
356 impl<'a, 'b, 'c: 'a + 'b> ResolveType<'c> for Option<&GenericTypes<'a, 'b>> {
357 fn resolve_type(&'c self, ty: &'c syn::Type) -> &'c syn::Type {
358 if let Some(us) = self {
360 syn::Type::Path(p) => {
361 if let Some(ident) = p.path.get_ident() {
362 if let Some((ty, _)) = us.default_generics.get(ident) {
367 syn::Type::Reference(syn::TypeReference { elem, .. }) => {
368 if let syn::Type::Path(p) = &**elem {
369 if let Some(ident) = p.path.get_ident() {
370 if let Some((_, refty)) = us.default_generics.get(ident) {
378 us.parent.resolve_type(ty)
383 #[derive(Clone, PartialEq)]
384 // The type of declaration and the object itself
385 pub enum DeclType<'a> {
387 Trait(&'a syn::ItemTrait),
388 StructImported { generics: &'a syn::Generics },
390 EnumIgnored { generics: &'a syn::Generics },
393 pub struct ImportResolver<'mod_lifetime, 'crate_lft: 'mod_lifetime> {
394 crate_name: &'mod_lifetime str,
395 dependencies: &'mod_lifetime HashSet<syn::Ident>,
396 module_path: &'mod_lifetime str,
397 imports: HashMap<syn::Ident, (String, syn::Path)>,
398 declared: HashMap<syn::Ident, DeclType<'crate_lft>>,
399 priv_modules: HashSet<syn::Ident>,
401 impl<'mod_lifetime, 'crate_lft: 'mod_lifetime> ImportResolver<'mod_lifetime, 'crate_lft> {
402 fn process_use_intern(crate_name: &str, module_path: &str, dependencies: &HashSet<syn::Ident>, imports: &mut HashMap<syn::Ident, (String, syn::Path)>,
403 u: &syn::UseTree, partial_path: &str, mut path: syn::punctuated::Punctuated<syn::PathSegment, syn::token::Colon2>) {
406 macro_rules! push_path {
407 ($ident: expr, $path_suffix: expr) => {
408 if partial_path == "" && format!("{}", $ident) == "super" {
409 let mut mod_iter = module_path.rsplitn(2, "::");
410 mod_iter.next().unwrap();
411 let super_mod = mod_iter.next().unwrap();
412 new_path = format!("{}{}", super_mod, $path_suffix);
413 assert_eq!(path.len(), 0);
414 for module in super_mod.split("::") {
415 path.push(syn::PathSegment { ident: syn::Ident::new(module, Span::call_site()), arguments: syn::PathArguments::None });
417 } else if partial_path == "" && format!("{}", $ident) == "self" {
418 new_path = format!("{}{}", module_path, $path_suffix);
419 for module in module_path.split("::") {
420 path.push(syn::PathSegment { ident: syn::Ident::new(module, Span::call_site()), arguments: syn::PathArguments::None });
422 } else if partial_path == "" && format!("{}", $ident) == "crate" {
423 new_path = format!("{}{}", crate_name, $path_suffix);
424 let crate_name_ident = format_ident!("{}", crate_name);
425 path.push(parse_quote!(#crate_name_ident));
426 } else if partial_path == "" && !dependencies.contains(&$ident) {
427 new_path = format!("{}::{}{}", crate_name, $ident, $path_suffix);
428 let crate_name_ident = format_ident!("{}", crate_name);
429 path.push(parse_quote!(#crate_name_ident));
431 new_path = format!("{}{}{}", partial_path, $ident, $path_suffix);
434 path.push(parse_quote!(#ident));
438 syn::UseTree::Path(p) => {
439 push_path!(p.ident, "::");
440 Self::process_use_intern(crate_name, module_path, dependencies, imports, &p.tree, &new_path, path);
442 syn::UseTree::Name(n) => {
443 push_path!(n.ident, "");
444 imports.insert(n.ident.clone(), (new_path, syn::Path { leading_colon: Some(syn::Token![::](Span::call_site())), segments: path }));
446 syn::UseTree::Group(g) => {
447 for i in g.items.iter() {
448 Self::process_use_intern(crate_name, module_path, dependencies, imports, i, partial_path, path.clone());
451 syn::UseTree::Rename(r) => {
452 push_path!(r.ident, "");
453 imports.insert(r.rename.clone(), (new_path, syn::Path { leading_colon: Some(syn::Token![::](Span::call_site())), segments: path }));
455 syn::UseTree::Glob(_) => {
456 eprintln!("Ignoring * use for {} - this may result in resolution failures", partial_path);
461 fn process_use(crate_name: &str, module_path: &str, dependencies: &HashSet<syn::Ident>, imports: &mut HashMap<syn::Ident, (String, syn::Path)>, u: &syn::ItemUse) {
462 if let syn::Visibility::Public(_) = u.vis {
463 // We actually only use these for #[cfg(fuzztarget)]
464 eprintln!("Ignoring pub(use) tree!");
467 if u.leading_colon.is_some() { eprintln!("Ignoring leading-colon use!"); return; }
468 Self::process_use_intern(crate_name, module_path, dependencies, imports, &u.tree, "", syn::punctuated::Punctuated::new());
471 fn insert_primitive(imports: &mut HashMap<syn::Ident, (String, syn::Path)>, id: &str) {
472 let ident = format_ident!("{}", id);
473 let path = parse_quote!(#ident);
474 imports.insert(ident, (id.to_owned(), path));
477 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 {
478 Self::from_borrowed_items(crate_name, dependencies, module_path, &contents.iter().map(|a| a).collect::<Vec<_>>())
480 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 {
481 let mut imports = HashMap::new();
482 // Add primitives to the "imports" list:
483 Self::insert_primitive(&mut imports, "bool");
484 Self::insert_primitive(&mut imports, "u64");
485 Self::insert_primitive(&mut imports, "u32");
486 Self::insert_primitive(&mut imports, "u16");
487 Self::insert_primitive(&mut imports, "u8");
488 Self::insert_primitive(&mut imports, "usize");
489 Self::insert_primitive(&mut imports, "str");
490 Self::insert_primitive(&mut imports, "String");
492 // These are here to allow us to print native Rust types in trait fn impls even if we don't
494 Self::insert_primitive(&mut imports, "Result");
495 Self::insert_primitive(&mut imports, "Vec");
496 Self::insert_primitive(&mut imports, "Option");
498 let mut declared = HashMap::new();
499 let mut priv_modules = HashSet::new();
501 for item in contents.iter() {
503 syn::Item::Use(u) => Self::process_use(crate_name, module_path, dependencies, &mut imports, &u),
504 syn::Item::Struct(s) => {
505 if let syn::Visibility::Public(_) = s.vis {
506 match export_status(&s.attrs) {
507 ExportStatus::Export => { declared.insert(s.ident.clone(), DeclType::StructImported { generics: &s.generics }); },
508 ExportStatus::NoExport => { declared.insert(s.ident.clone(), DeclType::StructIgnored); },
509 ExportStatus::TestOnly => continue,
510 ExportStatus::NotImplementable => panic!("(C-not implementable) should only appear on traits!"),
514 syn::Item::Type(t) if export_status(&t.attrs) == ExportStatus::Export => {
515 if let syn::Visibility::Public(_) = t.vis {
516 declared.insert(t.ident.clone(), DeclType::StructImported { generics: &t.generics });
519 syn::Item::Enum(e) => {
520 if let syn::Visibility::Public(_) = e.vis {
521 match export_status(&e.attrs) {
522 ExportStatus::Export if is_enum_opaque(e) => { declared.insert(e.ident.clone(), DeclType::EnumIgnored { generics: &e.generics }); },
523 ExportStatus::Export => { declared.insert(e.ident.clone(), DeclType::MirroredEnum); },
524 ExportStatus::NotImplementable => panic!("(C-not implementable) should only appear on traits!"),
529 syn::Item::Trait(t) => {
530 match export_status(&t.attrs) {
531 ExportStatus::Export|ExportStatus::NotImplementable => {
532 if let syn::Visibility::Public(_) = t.vis {
533 declared.insert(t.ident.clone(), DeclType::Trait(t));
539 syn::Item::Mod(m) => {
540 priv_modules.insert(m.ident.clone());
546 Self { crate_name, dependencies, module_path, imports, declared, priv_modules }
549 pub fn get_declared_type(&self, ident: &syn::Ident) -> Option<&DeclType<'crate_lft>> {
550 self.declared.get(ident)
553 pub fn maybe_resolve_declared(&self, id: &syn::Ident) -> Option<&DeclType<'crate_lft>> {
554 self.declared.get(id)
557 pub fn maybe_resolve_ident(&self, id: &syn::Ident) -> Option<String> {
558 if let Some((imp, _)) = self.imports.get(id) {
560 } else if self.declared.get(id).is_some() {
561 Some(self.module_path.to_string() + "::" + &format!("{}", id))
565 pub fn maybe_resolve_non_ignored_ident(&self, id: &syn::Ident) -> Option<String> {
566 if let Some((imp, _)) = self.imports.get(id) {
568 } else if let Some(decl_type) = self.declared.get(id) {
570 DeclType::StructIgnored => None,
571 _ => Some(self.module_path.to_string() + "::" + &format!("{}", id)),
576 pub fn maybe_resolve_path(&self, p: &syn::Path, generics: Option<&GenericTypes>) -> Option<String> {
577 if let Some(gen_types) = generics {
578 if let Some(resp) = gen_types.maybe_resolve_path(p) {
579 return Some(resp.clone());
583 if p.leading_colon.is_some() {
584 let mut res: String = p.segments.iter().enumerate().map(|(idx, seg)| {
585 format!("{}{}", if idx == 0 { "" } else { "::" }, seg.ident)
587 let firstseg = p.segments.iter().next().unwrap();
588 if !self.dependencies.contains(&firstseg.ident) {
589 res = self.crate_name.to_owned() + "::" + &res;
592 } else if let Some(id) = p.get_ident() {
593 self.maybe_resolve_ident(id)
595 if p.segments.len() == 1 {
596 let seg = p.segments.iter().next().unwrap();
597 return self.maybe_resolve_ident(&seg.ident);
599 let mut seg_iter = p.segments.iter();
600 let first_seg = seg_iter.next().unwrap();
601 let remaining: String = seg_iter.map(|seg| {
602 format!("::{}", seg.ident)
604 let first_seg_str = format!("{}", first_seg.ident);
605 if let Some((imp, _)) = self.imports.get(&first_seg.ident) {
607 Some(imp.clone() + &remaining)
611 } else if let Some(_) = self.priv_modules.get(&first_seg.ident) {
612 Some(format!("{}::{}{}", self.module_path, first_seg.ident, remaining))
613 } else if first_seg_is_stdlib(&first_seg_str) || self.dependencies.contains(&first_seg.ident) {
614 Some(first_seg_str + &remaining)
619 /// Map all the Paths in a Type into absolute paths given a set of imports (generated via process_use_intern)
620 pub fn resolve_imported_refs(&self, mut ty: syn::Type) -> syn::Type {
622 syn::Type::Path(p) => {
623 if p.path.segments.len() != 1 { unimplemented!(); }
624 let mut args = p.path.segments[0].arguments.clone();
625 if let syn::PathArguments::AngleBracketed(ref mut generics) = &mut args {
626 for arg in generics.args.iter_mut() {
627 if let syn::GenericArgument::Type(ref mut t) = arg {
628 *t = self.resolve_imported_refs(t.clone());
632 if let Some((_, newpath)) = self.imports.get(single_ident_generic_path_to_ident(&p.path).unwrap()) {
633 p.path = newpath.clone();
635 p.path.segments[0].arguments = args;
637 syn::Type::Reference(r) => {
638 r.elem = Box::new(self.resolve_imported_refs((*r.elem).clone()));
640 syn::Type::Slice(s) => {
641 s.elem = Box::new(self.resolve_imported_refs((*s.elem).clone()));
643 syn::Type::Tuple(t) => {
644 for e in t.elems.iter_mut() {
645 *e = self.resolve_imported_refs(e.clone());
648 _ => unimplemented!(),
654 // templates_defined is walked to write the C++ header, so if we use the default hashing it get
655 // reordered on each genbindings run. Instead, we use SipHasher (which defaults to 0-keys) so that
656 // the sorting is stable across runs. It is deprecated, but the "replacement" doesn't actually
657 // accomplish the same goals, so we just ignore it.
659 pub type NonRandomHash = hash::BuildHasherDefault<hash::SipHasher>;
662 pub struct ASTModule {
663 pub attrs: Vec<syn::Attribute>,
664 pub items: Vec<syn::Item>,
665 pub submods: Vec<String>,
667 /// A struct containing the syn::File AST for each file in the crate.
668 pub struct FullLibraryAST {
669 pub modules: HashMap<String, ASTModule, NonRandomHash>,
670 pub dependencies: HashSet<syn::Ident>,
672 impl FullLibraryAST {
673 fn load_module(&mut self, module: String, attrs: Vec<syn::Attribute>, mut items: Vec<syn::Item>) {
674 let mut non_mod_items = Vec::with_capacity(items.len());
675 let mut submods = Vec::with_capacity(items.len());
676 for item in items.drain(..) {
678 syn::Item::Mod(m) if m.content.is_some() => {
679 if export_status(&m.attrs) == ExportStatus::Export {
680 if let syn::Visibility::Public(_) = m.vis {
681 let modident = format!("{}", m.ident);
682 let modname = if module != "" {
683 module.clone() + "::" + &modident
687 self.load_module(modname, m.attrs, m.content.unwrap().1);
688 submods.push(modident);
690 non_mod_items.push(syn::Item::Mod(m));
694 syn::Item::Mod(_) => panic!("--pretty=expanded output should never have non-body modules"),
695 syn::Item::ExternCrate(c) => {
696 if export_status(&c.attrs) == ExportStatus::Export {
697 self.dependencies.insert(c.ident);
700 _ => { non_mod_items.push(item); }
703 self.modules.insert(module, ASTModule { attrs, items: non_mod_items, submods });
706 pub fn load_lib(lib: syn::File) -> Self {
707 assert_eq!(export_status(&lib.attrs), ExportStatus::Export);
708 let mut res = Self { modules: HashMap::default(), dependencies: HashSet::new() };
709 res.load_module("".to_owned(), lib.attrs, lib.items);
714 /// List of manually-generated types which are clonable
715 fn initial_clonable_types() -> HashSet<String> {
716 let mut res = HashSet::new();
717 res.insert("crate::c_types::u5".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::Secp256k1Error".to_owned());
726 res.insert("crate::c_types::IOError".to_owned());
730 /// Top-level struct tracking everything which has been defined while walking the crate.
731 pub struct CrateTypes<'a> {
732 /// This may contain structs or enums, but only when either is mapped as
733 /// struct X { inner: *mut originalX, .. }
734 pub opaques: HashMap<String, (&'a syn::Ident, &'a syn::Generics)>,
735 /// structs that weren't exposed
736 pub priv_structs: HashMap<String, &'a syn::Generics>,
737 /// Enums which are mapped as C enums with conversion functions
738 pub mirrored_enums: HashMap<String, &'a syn::ItemEnum>,
739 /// Traits which are mapped as a pointer + jump table
740 pub traits: HashMap<String, &'a syn::ItemTrait>,
741 /// Aliases from paths to some other Type
742 pub type_aliases: HashMap<String, syn::Type>,
743 /// Value is an alias to Key (maybe with some generics)
744 pub reverse_alias_map: HashMap<String, Vec<(syn::Path, syn::PathArguments)>>,
745 /// Template continer types defined, map from mangled type name -> whether a destructor fn
748 /// This is used at the end of processing to make C++ wrapper classes
749 pub templates_defined: RefCell<HashMap<String, bool, NonRandomHash>>,
750 /// The output file for any created template container types, written to as we find new
751 /// template containers which need to be defined.
752 template_file: RefCell<&'a mut File>,
753 /// Set of containers which are clonable
754 clonable_types: RefCell<HashSet<String>>,
756 pub trait_impls: HashMap<String, Vec<String>>,
757 /// The full set of modules in the crate(s)
758 pub lib_ast: &'a FullLibraryAST,
761 impl<'a> CrateTypes<'a> {
762 pub fn new(template_file: &'a mut File, libast: &'a FullLibraryAST) -> Self {
764 opaques: HashMap::new(), mirrored_enums: HashMap::new(), traits: HashMap::new(),
765 type_aliases: HashMap::new(), reverse_alias_map: HashMap::new(),
766 templates_defined: RefCell::new(HashMap::default()), priv_structs: HashMap::new(),
767 clonable_types: RefCell::new(initial_clonable_types()), trait_impls: HashMap::new(),
768 template_file: RefCell::new(template_file), lib_ast: &libast,
771 pub fn set_clonable(&self, object: String) {
772 self.clonable_types.borrow_mut().insert(object);
774 pub fn is_clonable(&self, object: &str) -> bool {
775 object.starts_with("&'static ") ||
776 self.clonable_types.borrow().contains(object)
778 pub fn write_new_template(&self, mangled_container: String, has_destructor: bool, created_container: &[u8]) {
779 self.template_file.borrow_mut().write(created_container).unwrap();
780 self.templates_defined.borrow_mut().insert(mangled_container, has_destructor);
784 /// A struct which tracks resolving rust types into C-mapped equivalents, exists for one specific
785 /// module but contains a reference to the overall CrateTypes tracking.
786 pub struct TypeResolver<'mod_lifetime, 'crate_lft: 'mod_lifetime> {
787 pub module_path: &'mod_lifetime str,
788 pub crate_types: &'mod_lifetime CrateTypes<'crate_lft>,
789 types: ImportResolver<'mod_lifetime, 'crate_lft>,
792 /// Returned by write_empty_rust_val_check_suffix to indicate what type of dereferencing needs to
793 /// happen to get the inner value of a generic.
794 enum EmptyValExpectedTy {
795 /// A type which has a flag for being empty (eg an array where we treat all-0s as empty).
797 /// A Option mapped as a COption_*Z
799 /// A pointer which we want to convert to a reference.
804 /// Describes the appropriate place to print a general type-conversion string when converting a
806 enum ContainerPrefixLocation {
807 /// Prints a general type-conversion string prefix and suffix outside of the
808 /// container-conversion strings.
810 /// Prints a general type-conversion string prefix and suffix inside of the
811 /// container-conversion strings.
813 /// Does not print the usual type-conversion string prefix and suffix.
817 impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
818 pub fn new(module_path: &'a str, types: ImportResolver<'a, 'c>, crate_types: &'a CrateTypes<'c>) -> Self {
819 Self { module_path, types, crate_types }
822 // *************************************************
823 // *** Well know type and conversion definitions ***
824 // *************************************************
826 /// Returns true we if can just skip passing this to C entirely
827 pub fn skip_path(&self, full_path: &str) -> bool {
828 full_path == "bitcoin::secp256k1::Secp256k1" ||
829 full_path == "bitcoin::secp256k1::Signing" ||
830 full_path == "bitcoin::secp256k1::Verification"
832 /// Returns true we if can just skip passing this to C entirely
833 fn no_arg_path_to_rust(&self, full_path: &str) -> &str {
834 if full_path == "bitcoin::secp256k1::Secp256k1" {
835 "secp256k1::SECP256K1"
836 } else { unimplemented!(); }
839 /// Returns true if the object is a primitive and is mapped as-is with no conversion
841 pub fn is_primitive(&self, full_path: &str) -> bool {
852 pub fn is_clonable(&self, ty: &str) -> bool {
853 if self.crate_types.is_clonable(ty) { return true; }
854 if self.is_primitive(ty) { return true; }
860 /// Gets the C-mapped type for types which are outside of the crate, or which are manually
861 /// ignored by for some reason need mapping anyway.
862 fn c_type_from_path<'b>(&self, full_path: &'b str, is_ref: bool, _ptr_for_ref: bool) -> Option<&'b str> {
863 if self.is_primitive(full_path) {
864 return Some(full_path);
867 // Note that no !is_ref types can map to an array because Rust and C's call semantics
868 // for arrays are different (https://github.com/eqrion/cbindgen/issues/528)
870 "[u8; 32]" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
871 "[u8; 20]" if !is_ref => Some("crate::c_types::TwentyBytes"),
872 "[u8; 16]" if !is_ref => Some("crate::c_types::SixteenBytes"),
873 "[u8; 12]" if !is_ref => Some("crate::c_types::TwelveBytes"),
874 "[u8; 4]" if !is_ref => Some("crate::c_types::FourBytes"),
875 "[u8; 3]" if !is_ref => Some("crate::c_types::ThreeBytes"), // Used for RGB values
877 "str" if is_ref => Some("crate::c_types::Str"),
878 "alloc::string::String"|"String" => Some("crate::c_types::Str"),
880 "std::time::Duration"|"core::time::Duration" => Some("u64"),
881 "std::time::SystemTime" => Some("u64"),
882 "std::io::Error" => Some("crate::c_types::IOError"),
883 "core::fmt::Arguments" if is_ref => Some("crate::c_types::Str"),
885 "core::convert::Infallible" => Some("crate::c_types::NotConstructable"),
887 "bitcoin::bech32::u5"|"bech32::u5" => Some("crate::c_types::u5"),
888 "core::num::NonZeroU8" => Some("u8"),
890 "bitcoin::secp256k1::key::PublicKey"|"bitcoin::secp256k1::PublicKey"|"secp256k1::key::PublicKey"
891 => Some("crate::c_types::PublicKey"),
892 "bitcoin::secp256k1::Signature" => Some("crate::c_types::Signature"),
893 "bitcoin::secp256k1::recovery::RecoverableSignature" => Some("crate::c_types::RecoverableSignature"),
894 "bitcoin::secp256k1::key::SecretKey"|"bitcoin::secp256k1::SecretKey"
895 if is_ref => Some("*const [u8; 32]"),
896 "bitcoin::secp256k1::key::SecretKey"|"bitcoin::secp256k1::SecretKey"
897 if !is_ref => Some("crate::c_types::SecretKey"),
898 "bitcoin::secp256k1::Error"|"secp256k1::Error"
899 if !is_ref => Some("crate::c_types::Secp256k1Error"),
900 "bitcoin::blockdata::script::Script" if is_ref => Some("crate::c_types::u8slice"),
901 "bitcoin::blockdata::script::Script" if !is_ref => Some("crate::c_types::derived::CVec_u8Z"),
902 "bitcoin::blockdata::transaction::OutPoint" => Some("crate::lightning::chain::transaction::OutPoint"),
903 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some("crate::c_types::Transaction"),
904 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some("crate::c_types::TxOut"),
905 "bitcoin::network::constants::Network" => Some("crate::bitcoin::network::Network"),
906 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some("*const [u8; 80]"),
907 "bitcoin::blockdata::block::Block" if is_ref => Some("crate::c_types::u8slice"),
909 "bitcoin::hash_types::PubkeyHash"|"bitcoin::hash_types::WPubkeyHash"|"bitcoin::hash_types::ScriptHash"
910 if is_ref => Some("*const [u8; 20]"),
911 "bitcoin::hash_types::WScriptHash"
912 if is_ref => Some("*const [u8; 32]"),
914 // Newtypes that we just expose in their original form.
915 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
916 if is_ref => Some("*const [u8; 32]"),
917 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
918 if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
919 "bitcoin::secp256k1::Message" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
920 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
921 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
922 if is_ref => Some("*const [u8; 32]"),
923 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
924 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
925 if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
927 "lightning::io::Read" => Some("crate::c_types::u8slice"),
933 fn from_c_conversion_new_var_from_path<'b>(&self, _full_path: &str, _is_ref: bool) -> Option<(&'b str, &'b str)> {
936 fn from_c_conversion_prefix_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<String> {
937 if self.is_primitive(full_path) {
938 return Some("".to_owned());
941 "Vec" if !is_ref => Some("local_"),
942 "Result" if !is_ref => Some("local_"),
943 "Option" if is_ref => Some("&local_"),
944 "Option" => Some("local_"),
946 "[u8; 32]" if is_ref => Some("unsafe { &*"),
947 "[u8; 32]" if !is_ref => Some(""),
948 "[u8; 20]" if !is_ref => Some(""),
949 "[u8; 16]" if !is_ref => Some(""),
950 "[u8; 12]" if !is_ref => Some(""),
951 "[u8; 4]" if !is_ref => Some(""),
952 "[u8; 3]" if !is_ref => Some(""),
954 "[u8]" if is_ref => Some(""),
955 "[usize]" if is_ref => Some(""),
957 "str" if is_ref => Some(""),
958 "alloc::string::String"|"String" => Some(""),
959 "std::io::Error" if !is_ref => Some(""),
960 // Note that we'll panic for String if is_ref, as we only have non-owned memory, we
961 // cannot create a &String.
963 "core::convert::Infallible" => Some("panic!(\"You must never construct a NotConstructable! : "),
965 "std::time::Duration"|"core::time::Duration" => Some("core::time::Duration::from_secs("),
966 "std::time::SystemTime" => Some("(::std::time::SystemTime::UNIX_EPOCH + std::time::Duration::from_secs("),
968 "bitcoin::bech32::u5"|"bech32::u5" => Some(""),
969 "core::num::NonZeroU8" => Some("core::num::NonZeroU8::new("),
971 "bitcoin::secp256k1::key::PublicKey"|"bitcoin::secp256k1::PublicKey"|"secp256k1::key::PublicKey"
972 if is_ref => Some("&"),
973 "bitcoin::secp256k1::key::PublicKey"|"bitcoin::secp256k1::PublicKey"|"secp256k1::key::PublicKey"
975 "bitcoin::secp256k1::Signature" if is_ref => Some("&"),
976 "bitcoin::secp256k1::Signature" => Some(""),
977 "bitcoin::secp256k1::recovery::RecoverableSignature" => Some(""),
978 "bitcoin::secp256k1::key::SecretKey"|"bitcoin::secp256k1::SecretKey"
979 if is_ref => Some("&::bitcoin::secp256k1::key::SecretKey::from_slice(&unsafe { *"),
980 "bitcoin::secp256k1::key::SecretKey"|"bitcoin::secp256k1::SecretKey"
981 if !is_ref => Some(""),
982 "bitcoin::blockdata::script::Script" if is_ref => Some("&::bitcoin::blockdata::script::Script::from(Vec::from("),
983 "bitcoin::blockdata::script::Script" if !is_ref => Some("::bitcoin::blockdata::script::Script::from("),
984 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" if is_ref => Some("&"),
985 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(""),
986 "bitcoin::blockdata::transaction::OutPoint" => Some("crate::c_types::C_to_bitcoin_outpoint("),
987 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(""),
988 "bitcoin::network::constants::Network" => Some(""),
989 "bitcoin::blockdata::block::BlockHeader" => Some("&::bitcoin::consensus::encode::deserialize(unsafe { &*"),
990 "bitcoin::blockdata::block::Block" if is_ref => Some("&::bitcoin::consensus::encode::deserialize("),
992 "bitcoin::hash_types::PubkeyHash" if is_ref =>
993 Some("&bitcoin::hash_types::PubkeyHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
994 "bitcoin::hash_types::WPubkeyHash" if is_ref =>
995 Some("&bitcoin::hash_types::WPubkeyHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
996 "bitcoin::hash_types::ScriptHash" if is_ref =>
997 Some("&bitcoin::hash_types::ScriptHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
998 "bitcoin::hash_types::WScriptHash" if is_ref =>
999 Some("&bitcoin::hash_types::WScriptHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
1001 // Newtypes that we just expose in their original form.
1002 "bitcoin::hash_types::Txid" if is_ref => Some("&::bitcoin::hash_types::Txid::from_slice(&unsafe { &*"),
1003 "bitcoin::hash_types::Txid" if !is_ref => Some("::bitcoin::hash_types::Txid::from_slice(&"),
1004 "bitcoin::hash_types::BlockHash" => Some("::bitcoin::hash_types::BlockHash::from_slice(&"),
1005 "lightning::ln::PaymentHash" if !is_ref => Some("::lightning::ln::PaymentHash("),
1006 "lightning::ln::PaymentHash" if is_ref => Some("&::lightning::ln::PaymentHash(unsafe { *"),
1007 "lightning::ln::PaymentPreimage" if !is_ref => Some("::lightning::ln::PaymentPreimage("),
1008 "lightning::ln::PaymentPreimage" if is_ref => Some("&::lightning::ln::PaymentPreimage(unsafe { *"),
1009 "lightning::ln::PaymentSecret" if !is_ref => Some("::lightning::ln::PaymentSecret("),
1010 "lightning::ln::channelmanager::PaymentId" if !is_ref => Some("::lightning::ln::channelmanager::PaymentId("),
1011 "lightning::ln::channelmanager::PaymentId" if is_ref=> Some("&::lightning::ln::channelmanager::PaymentId( unsafe { *"),
1012 "lightning::chain::keysinterface::KeyMaterial" if !is_ref => Some("::lightning::chain::keysinterface::KeyMaterial("),
1013 "lightning::chain::keysinterface::KeyMaterial" if is_ref=> Some("&::lightning::chain::keysinterface::KeyMaterial( unsafe { *"),
1015 // List of traits we map (possibly during processing of other files):
1016 "lightning::io::Read" => Some("&mut "),
1019 }.map(|s| s.to_owned())
1021 fn from_c_conversion_suffix_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<String> {
1022 if self.is_primitive(full_path) {
1023 return Some("".to_owned());
1026 "Vec" if !is_ref => Some(""),
1027 "Option" => Some(""),
1028 "Result" if !is_ref => Some(""),
1030 "[u8; 32]" if is_ref => Some("}"),
1031 "[u8; 32]" if !is_ref => Some(".data"),
1032 "[u8; 20]" if !is_ref => Some(".data"),
1033 "[u8; 16]" if !is_ref => Some(".data"),
1034 "[u8; 12]" if !is_ref => Some(".data"),
1035 "[u8; 4]" if !is_ref => Some(".data"),
1036 "[u8; 3]" if !is_ref => Some(".data"),
1038 "[u8]" if is_ref => Some(".to_slice()"),
1039 "[usize]" if is_ref => Some(".to_slice()"),
1041 "str" if is_ref => Some(".into_str()"),
1042 "alloc::string::String"|"String" => Some(".into_string()"),
1043 "std::io::Error" if !is_ref => Some(".to_rust()"),
1045 "core::convert::Infallible" => Some("\")"),
1047 "std::time::Duration"|"core::time::Duration" => Some(")"),
1048 "std::time::SystemTime" => Some("))"),
1050 "bitcoin::bech32::u5"|"bech32::u5" => Some(".into()"),
1051 "core::num::NonZeroU8" => Some(").expect(\"Value must be non-zero\")"),
1053 "bitcoin::secp256k1::key::PublicKey"|"bitcoin::secp256k1::PublicKey"|"secp256k1::key::PublicKey"
1054 => Some(".into_rust()"),
1055 "bitcoin::secp256k1::Signature" => Some(".into_rust()"),
1056 "bitcoin::secp256k1::recovery::RecoverableSignature" => Some(".into_rust()"),
1057 "bitcoin::secp256k1::key::SecretKey"|"bitcoin::secp256k1::SecretKey"
1058 if !is_ref => Some(".into_rust()"),
1059 "bitcoin::secp256k1::key::SecretKey"|"bitcoin::secp256k1::SecretKey"
1060 if is_ref => Some("}[..]).unwrap()"),
1061 "bitcoin::blockdata::script::Script" if is_ref => Some(".to_slice()))"),
1062 "bitcoin::blockdata::script::Script" if !is_ref => Some(".into_rust())"),
1063 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(".into_bitcoin()"),
1064 "bitcoin::blockdata::transaction::OutPoint" => Some(")"),
1065 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(".into_rust()"),
1066 "bitcoin::network::constants::Network" => Some(".into_bitcoin()"),
1067 "bitcoin::blockdata::block::BlockHeader" => Some(" }).unwrap()"),
1068 "bitcoin::blockdata::block::Block" => Some(".to_slice()).unwrap()"),
1070 "bitcoin::hash_types::PubkeyHash"|"bitcoin::hash_types::WPubkeyHash"|
1071 "bitcoin::hash_types::ScriptHash"|"bitcoin::hash_types::WScriptHash"
1072 if is_ref => Some(" }.clone()))"),
1074 // Newtypes that we just expose in their original form.
1075 "bitcoin::hash_types::Txid" if is_ref => Some(" }[..]).unwrap()"),
1076 "bitcoin::hash_types::Txid" => Some(".data[..]).unwrap()"),
1077 "bitcoin::hash_types::BlockHash" if !is_ref => Some(".data[..]).unwrap()"),
1078 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1079 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1080 if !is_ref => Some(".data)"),
1081 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1082 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1083 if is_ref => Some(" })"),
1085 // List of traits we map (possibly during processing of other files):
1086 "lightning::io::Read" => Some(".to_reader()"),
1089 }.map(|s| s.to_owned())
1092 fn to_c_conversion_new_var_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<(&'b str, &'b str)> {
1093 if self.is_primitive(full_path) {
1097 "[u8]" if is_ref => Some(("crate::c_types::u8slice::from_slice(", ")")),
1098 "[usize]" if is_ref => Some(("crate::c_types::usizeslice::from_slice(", ")")),
1100 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some(("{ let mut s = [0u8; 80]; s[..].copy_from_slice(&::bitcoin::consensus::encode::serialize(", ")); s }")),
1101 "bitcoin::blockdata::block::Block" if is_ref => Some(("::bitcoin::consensus::encode::serialize(", ")")),
1102 "bitcoin::hash_types::Txid" => None,
1105 }.map(|s| s.to_owned())
1107 fn to_c_conversion_inline_prefix_from_path(&self, full_path: &str, is_ref: bool, _ptr_for_ref: bool) -> Option<String> {
1108 if self.is_primitive(full_path) {
1109 return Some("".to_owned());
1112 "Result" if !is_ref => Some("local_"),
1113 "Vec" if !is_ref => Some("local_"),
1114 "Option" => Some("local_"),
1116 "[u8; 32]" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1117 "[u8; 32]" if is_ref => Some(""),
1118 "[u8; 20]" if !is_ref => Some("crate::c_types::TwentyBytes { data: "),
1119 "[u8; 16]" if !is_ref => Some("crate::c_types::SixteenBytes { data: "),
1120 "[u8; 12]" if !is_ref => Some("crate::c_types::TwelveBytes { data: "),
1121 "[u8; 4]" if !is_ref => Some("crate::c_types::FourBytes { data: "),
1122 "[u8; 3]" if is_ref => Some(""),
1124 "[u8]" if is_ref => Some("local_"),
1125 "[usize]" if is_ref => Some("local_"),
1127 "str" if is_ref => Some(""),
1128 "alloc::string::String"|"String" => Some(""),
1130 "std::time::Duration"|"core::time::Duration" => Some(""),
1131 "std::time::SystemTime" => Some(""),
1132 "std::io::Error" if !is_ref => Some("crate::c_types::IOError::from_rust("),
1133 "core::fmt::Arguments" => Some("alloc::format!(\"{}\", "),
1135 "core::convert::Infallible" => Some("panic!(\"Cannot construct an Infallible: "),
1137 "bitcoin::bech32::u5"|"bech32::u5" => Some(""),
1139 "bitcoin::secp256k1::key::PublicKey"|"bitcoin::secp256k1::PublicKey"|"secp256k1::key::PublicKey"
1140 => Some("crate::c_types::PublicKey::from_rust(&"),
1141 "bitcoin::secp256k1::Signature" => Some("crate::c_types::Signature::from_rust(&"),
1142 "bitcoin::secp256k1::recovery::RecoverableSignature" => Some("crate::c_types::RecoverableSignature::from_rust(&"),
1143 "bitcoin::secp256k1::key::SecretKey"|"bitcoin::secp256k1::SecretKey"
1144 if is_ref => Some(""),
1145 "bitcoin::secp256k1::key::SecretKey"|"bitcoin::secp256k1::SecretKey"
1146 if !is_ref => Some("crate::c_types::SecretKey::from_rust("),
1147 "bitcoin::secp256k1::Error"|"secp256k1::Error"
1148 if !is_ref => Some("crate::c_types::Secp256k1Error::from_rust("),
1149 "bitcoin::blockdata::script::Script" if is_ref => Some("crate::c_types::u8slice::from_slice(&"),
1150 "bitcoin::blockdata::script::Script" if !is_ref => Some(""),
1151 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" if is_ref => Some("crate::c_types::Transaction::from_bitcoin("),
1152 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some("crate::c_types::Transaction::from_bitcoin(&"),
1153 "bitcoin::blockdata::transaction::OutPoint" => Some("crate::c_types::bitcoin_to_C_outpoint("),
1154 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some("crate::c_types::TxOut::from_rust("),
1155 "bitcoin::network::constants::Network" => Some("crate::bitcoin::network::Network::from_bitcoin("),
1156 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some("&local_"),
1157 "bitcoin::blockdata::block::Block" if is_ref => Some("crate::c_types::u8slice::from_slice(&local_"),
1159 "bitcoin::hash_types::Txid" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1161 // Newtypes that we just expose in their original form.
1162 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1163 if is_ref => Some(""),
1164 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1165 if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1166 "bitcoin::secp256k1::Message" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1167 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1168 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1169 if is_ref => Some("&"),
1170 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1171 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1172 if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1174 "lightning::io::Read" => Some("crate::c_types::u8slice::from_vec(&crate::c_types::reader_to_vec("),
1177 }.map(|s| s.to_owned())
1179 fn to_c_conversion_inline_suffix_from_path(&self, full_path: &str, is_ref: bool, _ptr_for_ref: bool) -> Option<String> {
1180 if self.is_primitive(full_path) {
1181 return Some("".to_owned());
1184 "Result" if !is_ref => Some(""),
1185 "Vec" if !is_ref => Some(".into()"),
1186 "Option" => Some(""),
1188 "[u8; 32]" if !is_ref => Some(" }"),
1189 "[u8; 32]" if is_ref => Some(""),
1190 "[u8; 20]" if !is_ref => Some(" }"),
1191 "[u8; 16]" if !is_ref => Some(" }"),
1192 "[u8; 12]" if !is_ref => Some(" }"),
1193 "[u8; 4]" if !is_ref => Some(" }"),
1194 "[u8; 3]" if is_ref => Some(""),
1196 "[u8]" if is_ref => Some(""),
1197 "[usize]" if is_ref => Some(""),
1199 "str" if is_ref => Some(".into()"),
1200 "alloc::string::String"|"String" if is_ref => Some(".as_str().into()"),
1201 "alloc::string::String"|"String" => Some(".into()"),
1203 "std::time::Duration"|"core::time::Duration" => Some(".as_secs()"),
1204 "std::time::SystemTime" => Some(".duration_since(::std::time::SystemTime::UNIX_EPOCH).expect(\"Times must be post-1970\").as_secs()"),
1205 "std::io::Error" if !is_ref => Some(")"),
1206 "core::fmt::Arguments" => Some(").into()"),
1208 "core::convert::Infallible" => Some("\")"),
1210 "bitcoin::bech32::u5"|"bech32::u5" => Some(".into()"),
1212 "bitcoin::secp256k1::key::PublicKey"|"bitcoin::secp256k1::PublicKey"|"secp256k1::key::PublicKey"
1214 "bitcoin::secp256k1::Signature" => Some(")"),
1215 "bitcoin::secp256k1::recovery::RecoverableSignature" => Some(")"),
1216 "bitcoin::secp256k1::key::SecretKey"|"bitcoin::secp256k1::SecretKey"
1217 if !is_ref => Some(")"),
1218 "bitcoin::secp256k1::key::SecretKey"|"bitcoin::secp256k1::SecretKey"
1219 if is_ref => Some(".as_ref()"),
1220 "bitcoin::secp256k1::Error"|"secp256k1::Error"
1221 if !is_ref => Some(")"),
1222 "bitcoin::blockdata::script::Script" if is_ref => Some("[..])"),
1223 "bitcoin::blockdata::script::Script" if !is_ref => Some(".into_bytes().into()"),
1224 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(")"),
1225 "bitcoin::blockdata::transaction::OutPoint" => Some(")"),
1226 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(")"),
1227 "bitcoin::network::constants::Network" => Some(")"),
1228 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some(""),
1229 "bitcoin::blockdata::block::Block" if is_ref => Some(")"),
1231 "bitcoin::hash_types::Txid" if !is_ref => Some(".into_inner() }"),
1233 // Newtypes that we just expose in their original form.
1234 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1235 if is_ref => Some(".as_inner()"),
1236 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1237 if !is_ref => Some(".into_inner() }"),
1238 "bitcoin::secp256k1::Message" if !is_ref => Some(".as_ref().clone() }"),
1239 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1240 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1241 if is_ref => Some(".0"),
1242 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1243 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1244 if !is_ref => Some(".0 }"),
1246 "lightning::io::Read" => Some("))"),
1249 }.map(|s| s.to_owned())
1252 fn empty_val_check_suffix_from_path(&self, full_path: &str) -> Option<&str> {
1254 "lightning::ln::PaymentSecret" => Some(".data == [0; 32]"),
1255 "secp256k1::key::PublicKey"|"bitcoin::secp256k1::key::PublicKey" => Some(".is_null()"),
1256 "bitcoin::secp256k1::Signature" => Some(".is_null()"),
1261 /// When printing a reference to the source crate's rust type, if we need to map it to a
1262 /// different "real" type, it can be done so here.
1263 /// This is useful to work around limitations in the binding type resolver, where we reference
1264 /// a non-public `use` alias.
1265 /// TODO: We should never need to use this!
1266 fn real_rust_type_mapping<'equiv>(&self, thing: &'equiv str) -> &'equiv str {
1268 "lightning::io::Read" => "crate::c_types::io::Read",
1273 // ****************************
1274 // *** Container Processing ***
1275 // ****************************
1277 /// Returns the module path in the generated mapping crate to the containers which we generate
1278 /// when writing to CrateTypes::template_file.
1279 pub fn generated_container_path() -> &'static str {
1280 "crate::c_types::derived"
1282 /// Returns the module path in the generated mapping crate to the container templates, which
1283 /// are then concretized and put in the generated container path/template_file.
1284 fn container_templ_path() -> &'static str {
1288 /// Returns true if the path containing the given args is a "transparent" container, ie an
1289 /// Option or a container which does not require a generated continer class.
1290 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 {
1291 if full_path == "Option" {
1292 let inner = args.next().unwrap();
1293 assert!(args.next().is_none());
1295 syn::Type::Reference(_) => true,
1296 syn::Type::Array(a) => {
1297 if let syn::Expr::Lit(l) = &a.len {
1298 if let syn::Lit::Int(i) = &l.lit {
1299 if i.base10_digits().parse::<usize>().unwrap() >= 32 {
1300 let mut buf = Vec::new();
1301 self.write_rust_type(&mut buf, generics, &a.elem);
1302 let ty = String::from_utf8(buf).unwrap();
1305 // Blindly assume that if we're trying to create an empty value for an
1306 // array < 32 entries that all-0s may be a valid state.
1309 } else { unimplemented!(); }
1310 } else { unimplemented!(); }
1312 syn::Type::Path(p) => {
1313 if let Some(resolved) = self.maybe_resolve_path(&p.path, generics) {
1314 if self.c_type_has_inner_from_path(&resolved) { return true; }
1315 if self.is_primitive(&resolved) { return false; }
1316 if self.c_type_from_path(&resolved, false, false).is_some() { true } else { false }
1319 syn::Type::Tuple(_) => false,
1320 _ => unimplemented!(),
1324 /// Returns true if the path is a "transparent" container, ie an Option or a container which does
1325 /// not require a generated continer class.
1326 pub fn is_path_transparent_container(&self, full_path: &syn::Path, generics: Option<&GenericTypes>, is_ref: bool) -> bool {
1327 let inner_iter = match &full_path.segments.last().unwrap().arguments {
1328 syn::PathArguments::None => return false,
1329 syn::PathArguments::AngleBracketed(args) => args.args.iter().map(|arg| {
1330 if let syn::GenericArgument::Type(ref ty) = arg {
1332 } else { unimplemented!() }
1334 syn::PathArguments::Parenthesized(_) => unimplemented!(),
1336 self.is_transparent_container(&self.resolve_path(full_path, generics), is_ref, inner_iter, generics)
1338 /// Returns true if this is a known, supported, non-transparent container.
1339 fn is_known_container(&self, full_path: &str, is_ref: bool) -> bool {
1340 (full_path == "Result" && !is_ref) || (full_path == "Vec" && !is_ref) || full_path.ends_with("Tuple") || full_path == "Option"
1342 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)
1343 // Returns prefix + Vec<(prefix, var-name-to-inline-convert)> + suffix
1344 // expecting one element in the vec per generic type, each of which is inline-converted
1345 -> Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)> {
1347 "Result" if !is_ref => {
1349 vec![(" { Ok(mut o) => crate::c_types::CResultTempl::ok(".to_string(), "o".to_string()),
1350 (").into(), Err(mut e) => crate::c_types::CResultTempl::err(".to_string(), "e".to_string())],
1351 ").into() }", ContainerPrefixLocation::PerConv))
1355 // We should only get here if the single contained has an inner
1356 assert!(self.c_type_has_inner(single_contained.unwrap()));
1358 Some(("Vec::new(); for mut item in ", vec![(format!(".drain(..) {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1361 if let Some(syn::Type::Reference(_)) = single_contained {
1362 Some(("Vec::new(); for item in ", vec![(format!(".iter() {{ local_{}.push(", var_name), "(*item)".to_string())], "); }", ContainerPrefixLocation::PerConv))
1364 Some(("Vec::new(); for item in ", vec![(format!(".iter() {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1368 let contained_struct = if let Some(syn::Type::Path(p)) = single_contained {
1369 Some(self.resolve_path(&p.path, generics))
1370 } else if let Some(syn::Type::Reference(r)) = single_contained {
1371 if let syn::Type::Path(p) = &*r.elem {
1372 Some(self.resolve_path(&p.path, generics))
1375 if let Some(inner_path) = contained_struct {
1376 if self.c_type_has_inner_from_path(&inner_path) {
1377 let is_inner_ref = if let Some(syn::Type::Reference(_)) = single_contained { true } else { false };
1379 return Some(("if ", vec![
1380 (".is_none() { core::ptr::null() } else { ObjOps::nonnull_ptr_to_inner(".to_owned(),
1381 format!("({}{}.unwrap())", var_access, if is_inner_ref { "" } else { ".as_ref()" }))
1382 ], ") }", ContainerPrefixLocation::OutsideConv));
1384 return Some(("if ", vec![
1385 (".is_none() { core::ptr::null_mut() } else { ".to_owned(), format!("({}.unwrap())", var_access))
1386 ], " }", ContainerPrefixLocation::OutsideConv));
1388 } else if self.is_primitive(&inner_path) || self.c_type_from_path(&inner_path, false, false).is_none() {
1389 let inner_name = self.get_c_mangled_container_type(vec![single_contained.unwrap()], generics, "Option").unwrap();
1390 return Some(("if ", vec![
1391 (format!(".is_none() {{ {}::None }} else {{ {}::Some(",
1392 inner_name, inner_name),
1393 format!("{}.unwrap()", var_access))
1394 ], ") }", ContainerPrefixLocation::PerConv));
1396 // If c_type_from_path is some (ie there's a manual mapping for the inner
1397 // type), lean on write_empty_rust_val, below.
1400 if let Some(t) = single_contained {
1401 if let syn::Type::Tuple(syn::TypeTuple { elems, .. }) = t {
1402 assert!(elems.is_empty());
1403 let inner_name = self.get_c_mangled_container_type(vec![single_contained.unwrap()], generics, "Option").unwrap();
1404 return Some(("if ", vec![
1405 (format!(".is_none() {{ {}::None }} else {{ {}::Some /*",
1406 inner_name, inner_name), format!(""))
1407 ], " */}", ContainerPrefixLocation::PerConv));
1409 if let syn::Type::Reference(syn::TypeReference { elem, .. }) = t {
1410 if let syn::Type::Slice(_) = &**elem {
1411 return Some(("if ", vec![
1412 (".is_none() { SmartPtr::null() } else { SmartPtr::from_obj(".to_string(),
1413 format!("({}.unwrap())", var_access))
1414 ], ") }", ContainerPrefixLocation::PerConv));
1417 let mut v = Vec::new();
1418 self.write_empty_rust_val(generics, &mut v, t);
1419 let s = String::from_utf8(v).unwrap();
1420 return Some(("if ", vec![
1421 (format!(".is_none() {{ {} }} else {{ ", s), format!("({}.unwrap())", var_access))
1422 ], " }", ContainerPrefixLocation::PerConv));
1423 } else { unreachable!(); }
1429 /// only_contained_has_inner implies that there is only one contained element in the container
1430 /// and it has an inner field (ie is an "opaque" type we've defined).
1431 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)
1432 // Returns prefix + Vec<(prefix, var-name-to-inline-convert)> + suffix
1433 // expecting one element in the vec per generic type, each of which is inline-converted
1434 -> Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)> {
1435 let mut only_contained_has_inner = false;
1436 let only_contained_resolved = if let Some(syn::Type::Path(p)) = single_contained {
1437 let res = self.resolve_path(&p.path, generics);
1438 only_contained_has_inner = self.c_type_has_inner_from_path(&res);
1442 "Result" if !is_ref => {
1444 vec![(".result_ok { true => Ok(".to_string(), format!("(*unsafe {{ Box::from_raw(<*mut _>::take_ptr(&mut {}.contents.result)) }})", var_access)),
1445 ("), false => Err(".to_string(), format!("(*unsafe {{ Box::from_raw(<*mut _>::take_ptr(&mut {}.contents.err)) }})", var_access))],
1446 ")}", ContainerPrefixLocation::PerConv))
1448 "Slice" if is_ref && only_contained_has_inner => {
1449 Some(("Vec::new(); for mut item in ", vec![(format!(".as_slice().iter() {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1452 Some(("Vec::new(); for mut item in ", vec![(format!(".into_rust().drain(..) {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1455 if let Some(resolved) = only_contained_resolved {
1456 if self.is_primitive(&resolved) {
1457 return Some(("if ", vec![(".is_some() { Some(".to_string(), format!("{}.take()", var_access))], ") } else { None }", ContainerPrefixLocation::NoPrefix))
1458 } else if only_contained_has_inner {
1460 return Some(("if ", vec![(".inner.is_null() { None } else { Some((*".to_string(), format!("{}", var_access))], ").clone()) }", ContainerPrefixLocation::PerConv))
1462 return Some(("if ", vec![(".inner.is_null() { None } else { Some(".to_string(), format!("{}", var_access))], ") }", ContainerPrefixLocation::PerConv));
1467 if let Some(t) = single_contained {
1469 syn::Type::Reference(_)|syn::Type::Path(_)|syn::Type::Slice(_) => {
1470 let mut v = Vec::new();
1471 let ret_ref = self.write_empty_rust_val_check_suffix(generics, &mut v, t);
1472 let s = String::from_utf8(v).unwrap();
1474 EmptyValExpectedTy::ReferenceAsPointer =>
1475 return Some(("if ", vec![
1476 (format!("{} {{ None }} else {{ Some(", s), format!("unsafe {{ &mut *{} }}", var_access))
1477 ], ") }", ContainerPrefixLocation::NoPrefix)),
1478 EmptyValExpectedTy::OptionType =>
1479 return Some(("{ /* ", vec![
1480 (format!("*/ let {}_opt = {};", var_name, var_access),
1481 format!("}} if {}_opt{} {{ None }} else {{ Some({{ {}_opt.take()", var_name, s, var_name))
1482 ], ") } }", ContainerPrefixLocation::PerConv)),
1483 EmptyValExpectedTy::NonPointer =>
1484 return Some(("if ", vec![
1485 (format!("{} {{ None }} else {{ Some(", s), format!("{}", var_access))
1486 ], ") }", ContainerPrefixLocation::PerConv)),
1489 syn::Type::Tuple(_) => {
1490 return Some(("if ", vec![(".is_some() { Some(".to_string(), format!("{}.take()", var_access))], ") } else { None }", ContainerPrefixLocation::PerConv))
1492 _ => unimplemented!(),
1494 } else { unreachable!(); }
1500 /// Constructs a reference to the given type, possibly tweaking the type if relevant to make it
1501 /// convertable to C.
1502 pub fn create_ownable_reference(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> Option<syn::Type> {
1503 let default_value = Some(syn::Type::Reference(syn::TypeReference {
1504 and_token: syn::Token!(&)(Span::call_site()), lifetime: None, mutability: None,
1505 elem: Box::new(t.clone()) }));
1506 match generics.resolve_type(t) {
1507 syn::Type::Path(p) => {
1508 if let Some(resolved_path) = self.maybe_resolve_path(&p.path, generics) {
1509 if resolved_path != "Vec" { return default_value; }
1510 if p.path.segments.len() != 1 { unimplemented!(); }
1511 let only_seg = p.path.segments.iter().next().unwrap();
1512 if let syn::PathArguments::AngleBracketed(args) = &only_seg.arguments {
1513 if args.args.len() != 1 { unimplemented!(); }
1514 let inner_arg = args.args.iter().next().unwrap();
1515 if let syn::GenericArgument::Type(ty) = &inner_arg {
1516 let mut can_create = self.c_type_has_inner(&ty);
1517 if let syn::Type::Path(inner) = ty {
1518 if inner.path.segments.len() == 1 &&
1519 format!("{}", inner.path.segments[0].ident) == "Vec" {
1523 if !can_create { return default_value; }
1524 if let Some(inner_ty) = self.create_ownable_reference(&ty, generics) {
1525 return Some(syn::Type::Reference(syn::TypeReference {
1526 and_token: syn::Token![&](Span::call_site()),
1529 elem: Box::new(syn::Type::Slice(syn::TypeSlice {
1530 bracket_token: syn::token::Bracket { span: Span::call_site() },
1531 elem: Box::new(inner_ty)
1534 } else { return default_value; }
1535 } else { unimplemented!(); }
1536 } else { unimplemented!(); }
1537 } else { return None; }
1543 // *************************************************
1544 // *** Type definition during main.rs processing ***
1545 // *************************************************
1547 pub fn get_declared_type(&'a self, ident: &syn::Ident) -> Option<&'a DeclType<'c>> {
1548 self.types.get_declared_type(ident)
1550 /// Returns true if the object at the given path is mapped as X { inner: *mut origX, .. }.
1551 pub fn c_type_has_inner_from_path(&self, full_path: &str) -> bool {
1552 self.crate_types.opaques.get(full_path).is_some()
1555 /// Returns true if the object at the given path is mapped as X { inner: *mut origX, .. }.
1556 pub fn c_type_has_inner(&self, ty: &syn::Type) -> bool {
1558 syn::Type::Path(p) => {
1559 if let Some(full_path) = self.maybe_resolve_path(&p.path, None) {
1560 self.c_type_has_inner_from_path(&full_path)
1563 syn::Type::Reference(r) => {
1564 self.c_type_has_inner(&*r.elem)
1570 pub fn maybe_resolve_ident(&self, id: &syn::Ident) -> Option<String> {
1571 self.types.maybe_resolve_ident(id)
1574 pub fn maybe_resolve_non_ignored_ident(&self, id: &syn::Ident) -> Option<String> {
1575 self.types.maybe_resolve_non_ignored_ident(id)
1578 pub fn maybe_resolve_path(&self, p_arg: &syn::Path, generics: Option<&GenericTypes>) -> Option<String> {
1579 self.types.maybe_resolve_path(p_arg, generics)
1581 pub fn resolve_path(&self, p: &syn::Path, generics: Option<&GenericTypes>) -> String {
1582 self.maybe_resolve_path(p, generics).unwrap()
1585 // ***********************************
1586 // *** Original Rust Type Printing ***
1587 // ***********************************
1589 fn in_rust_prelude(resolved_path: &str) -> bool {
1590 match resolved_path {
1598 fn write_rust_path<W: std::io::Write>(&self, w: &mut W, generics_resolver: Option<&GenericTypes>, path: &syn::Path) {
1599 if let Some(resolved) = self.maybe_resolve_path(&path, generics_resolver) {
1600 if self.is_primitive(&resolved) {
1601 write!(w, "{}", path.get_ident().unwrap()).unwrap();
1603 // TODO: We should have a generic "is from a dependency" check here instead of
1604 // checking for "bitcoin" explicitly.
1605 if resolved.starts_with("bitcoin::") || Self::in_rust_prelude(&resolved) {
1606 write!(w, "{}", resolved).unwrap();
1607 // If we're printing a generic argument, it needs to reference the crate, otherwise
1608 // the original crate:
1609 } else if self.maybe_resolve_path(&path, None).as_ref() == Some(&resolved) {
1610 write!(w, "{}", self.real_rust_type_mapping(&resolved)).unwrap();
1612 write!(w, "crate::{}", resolved).unwrap();
1615 if let syn::PathArguments::AngleBracketed(args) = &path.segments.iter().last().unwrap().arguments {
1616 self.write_rust_generic_arg(w, generics_resolver, args.args.iter());
1619 if path.leading_colon.is_some() {
1620 write!(w, "::").unwrap();
1622 for (idx, seg) in path.segments.iter().enumerate() {
1623 if idx != 0 { write!(w, "::").unwrap(); }
1624 write!(w, "{}", seg.ident).unwrap();
1625 if let syn::PathArguments::AngleBracketed(args) = &seg.arguments {
1626 self.write_rust_generic_arg(w, generics_resolver, args.args.iter());
1631 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>) {
1632 let mut had_params = false;
1633 for (idx, arg) in generics.enumerate() {
1634 if idx != 0 { write!(w, ", ").unwrap(); } else { write!(w, "<").unwrap(); }
1637 syn::GenericParam::Lifetime(lt) => write!(w, "'{}", lt.lifetime.ident).unwrap(),
1638 syn::GenericParam::Type(t) => {
1639 write!(w, "{}", t.ident).unwrap();
1640 if t.colon_token.is_some() { write!(w, ":").unwrap(); }
1641 for (idx, bound) in t.bounds.iter().enumerate() {
1642 if idx != 0 { write!(w, " + ").unwrap(); }
1644 syn::TypeParamBound::Trait(tb) => {
1645 if tb.paren_token.is_some() || tb.lifetimes.is_some() { unimplemented!(); }
1646 self.write_rust_path(w, generics_resolver, &tb.path);
1648 _ => unimplemented!(),
1651 if t.eq_token.is_some() || t.default.is_some() { unimplemented!(); }
1653 _ => unimplemented!(),
1656 if had_params { write!(w, ">").unwrap(); }
1659 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>) {
1660 write!(w, "<").unwrap();
1661 for (idx, arg) in generics.enumerate() {
1662 if idx != 0 { write!(w, ", ").unwrap(); }
1664 syn::GenericArgument::Type(t) => self.write_rust_type(w, generics_resolver, t),
1665 _ => unimplemented!(),
1668 write!(w, ">").unwrap();
1670 pub fn write_rust_type<W: std::io::Write>(&self, w: &mut W, generics: Option<&GenericTypes>, t: &syn::Type) {
1671 match generics.resolve_type(t) {
1672 syn::Type::Path(p) => {
1673 if p.qself.is_some() {
1676 self.write_rust_path(w, generics, &p.path);
1678 syn::Type::Reference(r) => {
1679 write!(w, "&").unwrap();
1680 if let Some(lft) = &r.lifetime {
1681 write!(w, "'{} ", lft.ident).unwrap();
1683 if r.mutability.is_some() {
1684 write!(w, "mut ").unwrap();
1686 self.write_rust_type(w, generics, &*r.elem);
1688 syn::Type::Array(a) => {
1689 write!(w, "[").unwrap();
1690 self.write_rust_type(w, generics, &a.elem);
1691 if let syn::Expr::Lit(l) = &a.len {
1692 if let syn::Lit::Int(i) = &l.lit {
1693 write!(w, "; {}]", i).unwrap();
1694 } else { unimplemented!(); }
1695 } else { unimplemented!(); }
1697 syn::Type::Slice(s) => {
1698 write!(w, "[").unwrap();
1699 self.write_rust_type(w, generics, &s.elem);
1700 write!(w, "]").unwrap();
1702 syn::Type::Tuple(s) => {
1703 write!(w, "(").unwrap();
1704 for (idx, t) in s.elems.iter().enumerate() {
1705 if idx != 0 { write!(w, ", ").unwrap(); }
1706 self.write_rust_type(w, generics, &t);
1708 write!(w, ")").unwrap();
1710 _ => unimplemented!(),
1714 /// Prints a constructor for something which is "uninitialized" (but obviously not actually
1715 /// unint'd memory).
1716 pub fn write_empty_rust_val<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type) {
1718 syn::Type::Reference(r) => {
1719 self.write_empty_rust_val(generics, w, &*r.elem)
1721 syn::Type::Path(p) => {
1722 let resolved = self.resolve_path(&p.path, generics);
1723 if self.crate_types.opaques.get(&resolved).is_some() {
1724 write!(w, "crate::{} {{ inner: core::ptr::null_mut(), is_owned: true }}", resolved).unwrap();
1726 // Assume its a manually-mapped C type, where we can just define an null() fn
1727 write!(w, "{}::null()", self.c_type_from_path(&resolved, false, false).unwrap()).unwrap();
1730 syn::Type::Array(a) => {
1731 if let syn::Expr::Lit(l) = &a.len {
1732 if let syn::Lit::Int(i) = &l.lit {
1733 if i.base10_digits().parse::<usize>().unwrap() < 32 {
1734 // Blindly assume that if we're trying to create an empty value for an
1735 // array < 32 entries that all-0s may be a valid state.
1738 let arrty = format!("[u8; {}]", i.base10_digits());
1739 write!(w, "{}", self.to_c_conversion_inline_prefix_from_path(&arrty, false, false).unwrap()).unwrap();
1740 write!(w, "[0; {}]", i.base10_digits()).unwrap();
1741 write!(w, "{}", self.to_c_conversion_inline_suffix_from_path(&arrty, false, false).unwrap()).unwrap();
1742 } else { unimplemented!(); }
1743 } else { unimplemented!(); }
1745 _ => unimplemented!(),
1749 fn is_real_type_array(&self, resolved_type: &str) -> Option<syn::Type> {
1750 if let Some(real_ty) = self.c_type_from_path(&resolved_type, true, false) {
1751 if real_ty.ends_with("]") && real_ty.starts_with("*const [u8; ") {
1752 let mut split = real_ty.split("; ");
1753 split.next().unwrap();
1754 let tail_str = split.next().unwrap();
1755 assert!(split.next().is_none());
1756 let len = usize::from_str_radix(&tail_str[..tail_str.len() - 1], 10).unwrap();
1757 Some(parse_quote!([u8; #len]))
1762 /// Prints a suffix to determine if a variable is empty (ie was set by write_empty_rust_val).
1763 /// See EmptyValExpectedTy for information on return types.
1764 fn write_empty_rust_val_check_suffix<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type) -> EmptyValExpectedTy {
1766 syn::Type::Reference(r) => {
1767 return self.write_empty_rust_val_check_suffix(generics, w, &*r.elem);
1769 syn::Type::Path(p) => {
1770 let resolved = self.resolve_path(&p.path, generics);
1771 if let Some(arr_ty) = self.is_real_type_array(&resolved) {
1772 write!(w, ".data").unwrap();
1773 return self.write_empty_rust_val_check_suffix(generics, w, &arr_ty);
1775 if self.crate_types.opaques.get(&resolved).is_some() {
1776 write!(w, ".inner.is_null()").unwrap();
1777 EmptyValExpectedTy::NonPointer
1779 if let Some(suffix) = self.empty_val_check_suffix_from_path(&resolved) {
1780 write!(w, "{}", suffix).unwrap();
1781 // We may eventually need to allow empty_val_check_suffix_from_path to specify if we need a deref or not
1782 EmptyValExpectedTy::NonPointer
1784 write!(w, ".is_none()").unwrap();
1785 EmptyValExpectedTy::OptionType
1789 syn::Type::Array(a) => {
1790 if let syn::Expr::Lit(l) = &a.len {
1791 if let syn::Lit::Int(i) = &l.lit {
1792 write!(w, " == [0; {}]", i.base10_digits()).unwrap();
1793 EmptyValExpectedTy::NonPointer
1794 } else { unimplemented!(); }
1795 } else { unimplemented!(); }
1797 syn::Type::Slice(_) => {
1798 // Option<[]> always implies that we want to treat len() == 0 differently from
1799 // None, so we always map an Option<[]> into a pointer.
1800 write!(w, " == core::ptr::null_mut()").unwrap();
1801 EmptyValExpectedTy::ReferenceAsPointer
1803 _ => unimplemented!(),
1807 /// Prints a suffix to determine if a variable is empty (ie was set by write_empty_rust_val).
1808 pub fn write_empty_rust_val_check<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type, var_access: &str) {
1810 syn::Type::Reference(r) => {
1811 self.write_empty_rust_val_check(generics, w, &*r.elem, var_access);
1813 syn::Type::Path(_) => {
1814 write!(w, "{}", var_access).unwrap();
1815 self.write_empty_rust_val_check_suffix(generics, w, t);
1817 syn::Type::Array(a) => {
1818 if let syn::Expr::Lit(l) = &a.len {
1819 if let syn::Lit::Int(i) = &l.lit {
1820 let arrty = format!("[u8; {}]", i.base10_digits());
1821 // We don't (yet) support a new-var conversion here.
1822 assert!(self.from_c_conversion_new_var_from_path(&arrty, false).is_none());
1824 self.from_c_conversion_prefix_from_path(&arrty, false).unwrap(),
1826 self.from_c_conversion_suffix_from_path(&arrty, false).unwrap()).unwrap();
1827 self.write_empty_rust_val_check_suffix(generics, w, t);
1828 } else { unimplemented!(); }
1829 } else { unimplemented!(); }
1831 _ => unimplemented!(),
1835 // ********************************
1836 // *** Type conversion printing ***
1837 // ********************************
1839 /// Returns true we if can just skip passing this to C entirely
1840 pub fn skip_arg(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> bool {
1842 syn::Type::Path(p) => {
1843 if p.qself.is_some() { unimplemented!(); }
1844 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
1845 self.skip_path(&full_path)
1848 syn::Type::Reference(r) => {
1849 self.skip_arg(&*r.elem, generics)
1854 pub fn no_arg_to_rust<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
1856 syn::Type::Path(p) => {
1857 if p.qself.is_some() { unimplemented!(); }
1858 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
1859 write!(w, "{}", self.no_arg_path_to_rust(&full_path)).unwrap();
1862 syn::Type::Reference(r) => {
1863 self.no_arg_to_rust(w, &*r.elem, generics);
1869 fn write_conversion_inline_intern<W: std::io::Write,
1870 LP: Fn(&str, bool, bool) -> Option<String>, DL: Fn(&mut W, &DeclType, &str, bool, bool), SC: Fn(bool, Option<&str>) -> String>
1871 (&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, is_ref: bool, is_mut: bool, ptr_for_ref: bool,
1872 tupleconv: &str, prefix: bool, sliceconv: SC, path_lookup: LP, decl_lookup: DL) {
1873 match generics.resolve_type(t) {
1874 syn::Type::Reference(r) => {
1875 self.write_conversion_inline_intern(w, &*r.elem, generics, true, r.mutability.is_some(),
1876 ptr_for_ref, tupleconv, prefix, sliceconv, path_lookup, decl_lookup);
1878 syn::Type::Path(p) => {
1879 if p.qself.is_some() {
1883 let resolved_path = self.resolve_path(&p.path, generics);
1884 if let Some(aliased_type) = self.crate_types.type_aliases.get(&resolved_path) {
1885 return self.write_conversion_inline_intern(w, aliased_type, None, is_ref, is_mut, ptr_for_ref, tupleconv, prefix, sliceconv, path_lookup, decl_lookup);
1886 } else if self.is_primitive(&resolved_path) {
1887 if is_ref && prefix {
1888 write!(w, "*").unwrap();
1890 } else if let Some(c_type) = path_lookup(&resolved_path, is_ref, ptr_for_ref) {
1891 write!(w, "{}", c_type).unwrap();
1892 } else if let Some((_, generics)) = self.crate_types.opaques.get(&resolved_path) {
1893 decl_lookup(w, &DeclType::StructImported { generics: &generics }, &resolved_path, is_ref, is_mut);
1894 } else if self.crate_types.mirrored_enums.get(&resolved_path).is_some() {
1895 decl_lookup(w, &DeclType::MirroredEnum, &resolved_path, is_ref, is_mut);
1896 } else if let Some(t) = self.crate_types.traits.get(&resolved_path) {
1897 decl_lookup(w, &DeclType::Trait(t), &resolved_path, is_ref, is_mut);
1898 } else if let Some(ident) = single_ident_generic_path_to_ident(&p.path) {
1899 if let Some(decl_type) = self.types.maybe_resolve_declared(ident) {
1900 decl_lookup(w, decl_type, &self.maybe_resolve_ident(ident).unwrap(), is_ref, is_mut);
1901 } else { unimplemented!(); }
1902 } else { unimplemented!(); }
1904 syn::Type::Array(a) => {
1905 // We assume all arrays contain only [int_literal; X]s.
1906 // This may result in some outputs not compiling.
1907 if let syn::Expr::Lit(l) = &a.len {
1908 if let syn::Lit::Int(i) = &l.lit {
1909 write!(w, "{}", path_lookup(&format!("[u8; {}]", i.base10_digits()), is_ref, ptr_for_ref).unwrap()).unwrap();
1910 } else { unimplemented!(); }
1911 } else { unimplemented!(); }
1913 syn::Type::Slice(s) => {
1914 // We assume all slices contain only literals or references.
1915 // This may result in some outputs not compiling.
1916 if let syn::Type::Path(p) = &*s.elem {
1917 let resolved = self.resolve_path(&p.path, generics);
1918 if self.is_primitive(&resolved) {
1919 write!(w, "{}", path_lookup("[u8]", is_ref, ptr_for_ref).unwrap()).unwrap();
1921 write!(w, "{}", sliceconv(true, None)).unwrap();
1923 } else if let syn::Type::Reference(r) = &*s.elem {
1924 if let syn::Type::Path(p) = &*r.elem {
1925 write!(w, "{}", sliceconv(self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)), None)).unwrap();
1926 } else if let syn::Type::Slice(_) = &*r.elem {
1927 write!(w, "{}", sliceconv(false, None)).unwrap();
1928 } else { unimplemented!(); }
1929 } else if let syn::Type::Tuple(t) = &*s.elem {
1930 assert!(!t.elems.is_empty());
1932 write!(w, "{}", sliceconv(false, None)).unwrap();
1934 let mut needs_map = false;
1935 for e in t.elems.iter() {
1936 if let syn::Type::Reference(_) = e {
1941 let mut map_str = Vec::new();
1942 write!(&mut map_str, ".map(|(").unwrap();
1943 for i in 0..t.elems.len() {
1944 write!(&mut map_str, "{}{}", if i != 0 { ", " } else { "" }, ('a' as u8 + i as u8) as char).unwrap();
1946 write!(&mut map_str, ")| (").unwrap();
1947 for (idx, e) in t.elems.iter().enumerate() {
1948 if let syn::Type::Reference(_) = e {
1949 write!(&mut map_str, "{}{}", if idx != 0 { ", " } else { "" }, (idx as u8 + 'a' as u8) as char).unwrap();
1950 } else if let syn::Type::Path(_) = e {
1951 write!(&mut map_str, "{}*{}", if idx != 0 { ", " } else { "" }, (idx as u8 + 'a' as u8) as char).unwrap();
1952 } else { unimplemented!(); }
1954 write!(&mut map_str, "))").unwrap();
1955 write!(w, "{}", sliceconv(false, Some(&String::from_utf8(map_str).unwrap()))).unwrap();
1957 write!(w, "{}", sliceconv(false, None)).unwrap();
1960 } else { unimplemented!(); }
1962 syn::Type::Tuple(t) => {
1963 if t.elems.is_empty() {
1964 // cbindgen has poor support for (), see, eg https://github.com/eqrion/cbindgen/issues/527
1965 // so work around it by just pretending its a 0u8
1966 write!(w, "{}", tupleconv).unwrap();
1968 if prefix { write!(w, "local_").unwrap(); }
1971 _ => unimplemented!(),
1975 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) {
1976 self.write_conversion_inline_intern(w, t, generics, is_ref, false, ptr_for_ref, "() /*", true, |_, _| "local_".to_owned(),
1977 |a, b, c| self.to_c_conversion_inline_prefix_from_path(a, b, c),
1978 |w, decl_type, decl_path, is_ref, _is_mut| {
1980 DeclType::MirroredEnum if is_ref && ptr_for_ref => write!(w, "crate::{}::from_native(", decl_path).unwrap(),
1981 DeclType::MirroredEnum if is_ref => write!(w, "&crate::{}::from_native(", decl_path).unwrap(),
1982 DeclType::MirroredEnum => write!(w, "crate::{}::native_into(", decl_path).unwrap(),
1983 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if is_ref && from_ptr => {
1984 if !ptr_for_ref { write!(w, "&").unwrap(); }
1985 write!(w, "crate::{} {{ inner: unsafe {{ (", decl_path).unwrap()
1987 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if is_ref => {
1988 if !ptr_for_ref { write!(w, "&").unwrap(); }
1989 write!(w, "crate::{} {{ inner: unsafe {{ ObjOps::nonnull_ptr_to_inner((", decl_path).unwrap()
1991 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref && from_ptr =>
1992 write!(w, "crate::{} {{ inner: ", decl_path).unwrap(),
1993 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref =>
1994 write!(w, "crate::{} {{ inner: ObjOps::heap_alloc(", decl_path).unwrap(),
1995 DeclType::Trait(_) if is_ref => write!(w, "").unwrap(),
1996 DeclType::Trait(_) if !is_ref => write!(w, "Into::into(").unwrap(),
1997 _ => panic!("{:?}", decl_path),
2001 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) {
2002 self.write_to_c_conversion_inline_prefix_inner(w, t, generics, false, ptr_for_ref, false);
2004 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) {
2005 self.write_conversion_inline_intern(w, t, generics, is_ref, false, ptr_for_ref, "*/", false, |_, _| ".into()".to_owned(),
2006 |a, b, c| self.to_c_conversion_inline_suffix_from_path(a, b, c),
2007 |w, decl_type, full_path, is_ref, _is_mut| match decl_type {
2008 DeclType::MirroredEnum => write!(w, ")").unwrap(),
2009 DeclType::EnumIgnored { generics }|DeclType::StructImported { generics } if is_ref => {
2010 write!(w, " as *const {}<", full_path).unwrap();
2011 for param in generics.params.iter() {
2012 if let syn::GenericParam::Lifetime(_) = param {
2013 write!(w, "'_, ").unwrap();
2015 write!(w, "_, ").unwrap();
2019 write!(w, ">) as *mut _ }}, is_owned: false }}").unwrap();
2021 write!(w, ">) as *mut _) }}, is_owned: false }}").unwrap();
2024 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref && from_ptr =>
2025 write!(w, ", is_owned: true }}").unwrap(),
2026 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref => write!(w, "), is_owned: true }}").unwrap(),
2027 DeclType::Trait(_) if is_ref => {},
2028 DeclType::Trait(_) => {
2029 // This is used when we're converting a concrete Rust type into a C trait
2030 // for use when a Rust trait method returns an associated type.
2031 // Because all of our C traits implement From<RustTypesImplementingTraits>
2032 // we can just call .into() here and be done.
2033 write!(w, ")").unwrap()
2035 _ => unimplemented!(),
2038 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) {
2039 self.write_to_c_conversion_inline_suffix_inner(w, t, generics, false, ptr_for_ref, false);
2042 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) {
2043 self.write_conversion_inline_intern(w, t, generics, is_ref, false, false, "() /*", true, |_, _| "&local_".to_owned(),
2044 |a, b, _c| self.from_c_conversion_prefix_from_path(a, b),
2045 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
2046 DeclType::StructImported {..} if is_ref => write!(w, "").unwrap(),
2047 DeclType::StructImported {..} if !is_ref => write!(w, "*unsafe {{ Box::from_raw(").unwrap(),
2048 DeclType::MirroredEnum if is_ref => write!(w, "&").unwrap(),
2049 DeclType::MirroredEnum => {},
2050 DeclType::Trait(_) => {},
2051 _ => unimplemented!(),
2054 pub fn write_from_c_conversion_prefix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2055 self.write_from_c_conversion_prefix_inner(w, t, generics, false, false);
2057 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) {
2058 self.write_conversion_inline_intern(w, t, generics, is_ref, false, false, "*/", false,
2059 |has_inner, map_str_opt| match (has_inner, map_str_opt) {
2060 (false, Some(map_str)) => format!(".iter(){}.collect::<Vec<_>>()[..]", map_str),
2061 (false, None) => ".iter().collect::<Vec<_>>()[..]".to_owned(),
2062 (true, None) => "[..]".to_owned(),
2063 (true, Some(_)) => unreachable!(),
2065 |a, b, _c| self.from_c_conversion_suffix_from_path(a, b),
2066 |w, decl_type, _full_path, is_ref, is_mut| match decl_type {
2067 DeclType::StructImported {..} if is_ref && ptr_for_ref => write!(w, "XXX unimplemented").unwrap(),
2068 DeclType::StructImported {..} if is_mut && is_ref => write!(w, ".get_native_mut_ref()").unwrap(),
2069 DeclType::StructImported {..} if is_ref => write!(w, ".get_native_ref()").unwrap(),
2070 DeclType::StructImported {..} if !is_ref => write!(w, ".take_inner()) }}").unwrap(),
2071 DeclType::MirroredEnum if is_ref => write!(w, ".to_native()").unwrap(),
2072 DeclType::MirroredEnum => write!(w, ".into_native()").unwrap(),
2073 DeclType::Trait(_) => {},
2074 _ => unimplemented!(),
2077 pub fn write_from_c_conversion_suffix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2078 self.write_from_c_conversion_suffix_inner(w, t, generics, false, false);
2080 // Note that compared to the above conversion functions, the following two are generally
2081 // significantly undertested:
2082 pub fn write_from_c_conversion_to_ref_prefix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2083 self.write_conversion_inline_intern(w, t, generics, false, false, false, "() /*", true, |_, _| "&local_".to_owned(),
2085 if let Some(conv) = self.from_c_conversion_prefix_from_path(a, b) {
2086 Some(format!("&{}", conv))
2089 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
2090 DeclType::StructImported {..} if !is_ref => write!(w, "").unwrap(),
2091 _ => unimplemented!(),
2094 pub fn write_from_c_conversion_to_ref_suffix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2095 self.write_conversion_inline_intern(w, t, generics, false, false, false, "*/", false,
2096 |has_inner, map_str_opt| match (has_inner, map_str_opt) {
2097 (false, Some(map_str)) => format!(".iter(){}.collect::<Vec<_>>()[..]", map_str),
2098 (false, None) => ".iter().collect::<Vec<_>>()[..]".to_owned(),
2099 (true, None) => "[..]".to_owned(),
2100 (true, Some(_)) => unreachable!(),
2102 |a, b, _c| self.from_c_conversion_suffix_from_path(a, b),
2103 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
2104 DeclType::StructImported {..} if !is_ref => write!(w, ".get_native_ref()").unwrap(),
2105 _ => unimplemented!(),
2109 fn write_conversion_new_var_intern<'b, W: std::io::Write,
2110 LP: Fn(&str, bool) -> Option<(&str, &str)>,
2111 LC: Fn(&str, bool, Option<&syn::Type>, &syn::Ident, &str) -> Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)>,
2112 VP: Fn(&mut W, &syn::Type, Option<&GenericTypes>, bool, bool, bool),
2113 VS: Fn(&mut W, &syn::Type, Option<&GenericTypes>, bool, bool, bool)>
2114 (&self, w: &mut W, ident: &syn::Ident, var: &str, t: &syn::Type, generics: Option<&GenericTypes>,
2115 mut is_ref: bool, mut ptr_for_ref: bool, to_c: bool, from_ownable_ref: bool,
2116 path_lookup: &LP, container_lookup: &LC, var_prefix: &VP, var_suffix: &VS) -> bool {
2118 macro_rules! convert_container {
2119 ($container_type: expr, $args_len: expr, $args_iter: expr) => { {
2120 // For slices (and Options), we refuse to directly map them as is_ref when they
2121 // aren't opaque types containing an inner pointer. This is due to the fact that,
2122 // in both cases, the actual higher-level type is non-is_ref.
2123 let ty_has_inner = if $args_len == 1 {
2124 let ty = $args_iter().next().unwrap();
2125 if $container_type == "Slice" && to_c {
2126 // "To C ptr_for_ref" means "return the regular object with is_owned
2127 // set to false", which is totally what we want in a slice if we're about to
2128 // set ty_has_inner.
2131 if let syn::Type::Reference(t) = ty {
2132 if let syn::Type::Path(p) = &*t.elem {
2133 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
2135 } else if let syn::Type::Path(p) = ty {
2136 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
2140 // Options get a bunch of special handling, since in general we map Option<>al
2141 // types into the same C type as non-Option-wrapped types. This ends up being
2142 // pretty manual here and most of the below special-cases are for Options.
2143 let mut needs_ref_map = false;
2144 let mut only_contained_type = None;
2145 let mut only_contained_type_nonref = None;
2146 let mut only_contained_has_inner = false;
2147 let mut contains_slice = false;
2149 only_contained_has_inner = ty_has_inner;
2150 let arg = $args_iter().next().unwrap();
2151 if let syn::Type::Reference(t) = arg {
2152 only_contained_type = Some(arg);
2153 only_contained_type_nonref = Some(&*t.elem);
2154 if let syn::Type::Path(_) = &*t.elem {
2156 } else if let syn::Type::Slice(_) = &*t.elem {
2157 contains_slice = true;
2158 } else { return false; }
2159 // If the inner element contains an inner pointer, we will just use that,
2160 // avoiding the need to map elements to references. Otherwise we'll need to
2161 // do an extra mapping step.
2162 needs_ref_map = !only_contained_has_inner && $container_type == "Option";
2164 only_contained_type = Some(arg);
2165 only_contained_type_nonref = Some(arg);
2169 if let Some((prefix, conversions, suffix, prefix_location)) = container_lookup(&$container_type, is_ref, only_contained_type, ident, var) {
2170 assert_eq!(conversions.len(), $args_len);
2171 write!(w, "let mut local_{}{} = ", ident,
2172 if (!to_c && needs_ref_map) || (to_c && $container_type == "Option" && contains_slice) {"_base"} else { "" }).unwrap();
2173 if prefix_location == ContainerPrefixLocation::OutsideConv {
2174 var_prefix(w, $args_iter().next().unwrap(), generics, is_ref, ptr_for_ref, true);
2176 write!(w, "{}{}", prefix, var).unwrap();
2178 for ((pfx, var_name), (idx, ty)) in conversions.iter().zip($args_iter().enumerate()) {
2179 let mut var = std::io::Cursor::new(Vec::new());
2180 write!(&mut var, "{}", var_name).unwrap();
2181 let var_access = String::from_utf8(var.into_inner()).unwrap();
2183 let conv_ty = if needs_ref_map { only_contained_type_nonref.as_ref().unwrap() } else { ty };
2185 write!(w, "{} {{ ", pfx).unwrap();
2186 let new_var_name = format!("{}_{}", ident, idx);
2187 let new_var = self.write_conversion_new_var_intern(w, &format_ident!("{}", new_var_name),
2188 &var_access, conv_ty, generics, contains_slice || (is_ref && ty_has_inner), ptr_for_ref,
2189 to_c, from_ownable_ref, path_lookup, container_lookup, var_prefix, var_suffix);
2190 if new_var { write!(w, " ").unwrap(); }
2192 if prefix_location == ContainerPrefixLocation::PerConv {
2193 var_prefix(w, conv_ty, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2194 } else if !is_ref && !needs_ref_map && to_c && only_contained_has_inner {
2195 write!(w, "ObjOps::heap_alloc(").unwrap();
2198 write!(w, "{}{}", if contains_slice && !to_c { "local_" } else { "" }, if new_var { new_var_name } else { var_access }).unwrap();
2199 if prefix_location == ContainerPrefixLocation::PerConv {
2200 var_suffix(w, conv_ty, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2201 } else if !is_ref && !needs_ref_map && to_c && only_contained_has_inner {
2202 write!(w, ")").unwrap();
2204 write!(w, " }}").unwrap();
2206 write!(w, "{}", suffix).unwrap();
2207 if prefix_location == ContainerPrefixLocation::OutsideConv {
2208 var_suffix(w, $args_iter().next().unwrap(), generics, is_ref, ptr_for_ref, true);
2210 write!(w, ";").unwrap();
2211 if !to_c && needs_ref_map {
2212 write!(w, " let mut local_{} = local_{}_base.as_ref()", ident, ident).unwrap();
2214 write!(w, ".map(|a| &a[..])").unwrap();
2216 write!(w, ";").unwrap();
2217 } else if to_c && $container_type == "Option" && contains_slice {
2218 write!(w, " let mut local_{} = *local_{}_base;", ident, ident).unwrap();
2225 match generics.resolve_type(t) {
2226 syn::Type::Reference(r) => {
2227 if let syn::Type::Slice(_) = &*r.elem {
2228 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)
2230 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)
2233 syn::Type::Path(p) => {
2234 if p.qself.is_some() {
2237 let resolved_path = self.resolve_path(&p.path, generics);
2238 if let Some(aliased_type) = self.crate_types.type_aliases.get(&resolved_path) {
2239 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);
2241 if self.is_known_container(&resolved_path, is_ref) || self.is_path_transparent_container(&p.path, generics, is_ref) {
2242 if let syn::PathArguments::AngleBracketed(args) = &p.path.segments.iter().next().unwrap().arguments {
2243 convert_container!(resolved_path, args.args.len(), || args.args.iter().map(|arg| {
2244 if let syn::GenericArgument::Type(ty) = arg {
2245 generics.resolve_type(ty)
2246 } else { unimplemented!(); }
2248 } else { unimplemented!(); }
2250 if self.is_primitive(&resolved_path) {
2252 } else if let Some(ty_ident) = single_ident_generic_path_to_ident(&p.path) {
2253 if let Some((prefix, suffix)) = path_lookup(&resolved_path, is_ref) {
2254 write!(w, "let mut local_{} = {}{}{};", ident, prefix, var, suffix).unwrap();
2256 } else if self.types.maybe_resolve_declared(ty_ident).is_some() {
2261 syn::Type::Array(_) => {
2262 // We assume all arrays contain only primitive types.
2263 // This may result in some outputs not compiling.
2266 syn::Type::Slice(s) => {
2267 if let syn::Type::Path(p) = &*s.elem {
2268 let resolved = self.resolve_path(&p.path, generics);
2269 if self.is_primitive(&resolved) {
2270 let slice_path = format!("[{}]", resolved);
2271 if let Some((prefix, suffix)) = path_lookup(&slice_path, true) {
2272 write!(w, "let mut local_{} = {}{}{};", ident, prefix, var, suffix).unwrap();
2276 let tyref = [&*s.elem];
2278 // If we're converting from a slice to a Vec, assume we can clone the
2279 // elements and clone them into a new Vec first. Next we'll walk the
2280 // new Vec here and convert them to C types.
2281 write!(w, "let mut local_{}_clone = Vec::new(); local_{}_clone.extend_from_slice({}); let mut {} = local_{}_clone; ", ident, ident, ident, ident, ident).unwrap();
2284 convert_container!("Vec", 1, || tyref.iter().map(|t| generics.resolve_type(*t)));
2285 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2287 } else if let syn::Type::Reference(ty) = &*s.elem {
2288 let tyref = if from_ownable_ref || !to_c { [&*ty.elem] } else { [&*s.elem] };
2290 convert_container!("Slice", 1, || tyref.iter().map(|t| generics.resolve_type(*t)));
2291 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2292 } else if let syn::Type::Tuple(t) = &*s.elem {
2293 // When mapping into a temporary new var, we need to own all the underlying objects.
2294 // Thus, we drop any references inside the tuple and convert with non-reference types.
2295 let mut elems = syn::punctuated::Punctuated::new();
2296 for elem in t.elems.iter() {
2297 if let syn::Type::Reference(r) = elem {
2298 elems.push((*r.elem).clone());
2300 elems.push(elem.clone());
2303 let ty = [syn::Type::Tuple(syn::TypeTuple {
2304 paren_token: t.paren_token, elems
2308 convert_container!("Slice", 1, || ty.iter());
2309 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2310 } else { unimplemented!() }
2312 syn::Type::Tuple(t) => {
2313 if !t.elems.is_empty() {
2314 // We don't (yet) support tuple elements which cannot be converted inline
2315 write!(w, "let (").unwrap();
2316 for idx in 0..t.elems.len() {
2317 if idx != 0 { write!(w, ", ").unwrap(); }
2318 write!(w, "{} orig_{}_{}", if is_ref { "ref" } else { "mut" }, ident, idx).unwrap();
2320 write!(w, ") = {}{}; ", var, if !to_c { ".to_rust()" } else { "" }).unwrap();
2321 // Like other template types, tuples are always mapped as their non-ref
2322 // versions for types which have different ref mappings. Thus, we convert to
2323 // non-ref versions and handle opaque types with inner pointers manually.
2324 for (idx, elem) in t.elems.iter().enumerate() {
2325 if let syn::Type::Path(p) = elem {
2326 let v_name = format!("orig_{}_{}", ident, idx);
2327 let tuple_elem_ident = format_ident!("{}", &v_name);
2328 if self.write_conversion_new_var_intern(w, &tuple_elem_ident, &v_name, elem, generics,
2329 false, ptr_for_ref, to_c, from_ownable_ref,
2330 path_lookup, container_lookup, var_prefix, var_suffix) {
2331 write!(w, " ").unwrap();
2332 // Opaque types with inner pointers shouldn't ever create new stack
2333 // variables, so we don't handle it and just assert that it doesn't
2335 assert!(!self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)));
2339 write!(w, "let mut local_{} = (", ident).unwrap();
2340 for (idx, elem) in t.elems.iter().enumerate() {
2341 let real_elem = generics.resolve_type(&elem);
2342 let ty_has_inner = {
2344 // "To C ptr_for_ref" means "return the regular object with
2345 // is_owned set to false", which is totally what we want
2346 // if we're about to set ty_has_inner.
2349 if let syn::Type::Reference(t) = real_elem {
2350 if let syn::Type::Path(p) = &*t.elem {
2351 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
2353 } else if let syn::Type::Path(p) = real_elem {
2354 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
2357 if idx != 0 { write!(w, ", ").unwrap(); }
2358 var_prefix(w, real_elem, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2359 if is_ref && ty_has_inner {
2360 // For ty_has_inner, the regular var_prefix mapping will take a
2361 // reference, so deref once here to make sure we keep the original ref.
2362 write!(w, "*").unwrap();
2364 write!(w, "orig_{}_{}", ident, idx).unwrap();
2365 if is_ref && !ty_has_inner {
2366 // If we don't have an inner variable's reference to maintain, just
2367 // hope the type is Clonable and use that.
2368 write!(w, ".clone()").unwrap();
2370 var_suffix(w, real_elem, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2372 write!(w, "){};", if to_c { ".into()" } else { "" }).unwrap();
2376 _ => unimplemented!(),
2380 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 {
2381 self.write_conversion_new_var_intern(w, ident, var_access, t, generics, false, ptr_for_ref, true, from_ownable_ref,
2382 &|a, b| self.to_c_conversion_new_var_from_path(a, b),
2383 &|a, b, c, d, e| self.to_c_conversion_container_new_var(generics, a, b, c, d, e),
2384 // We force ptr_for_ref here since we can't generate a ref on one line and use it later
2385 &|a, b, c, d, e, f| self.write_to_c_conversion_inline_prefix_inner(a, b, c, d, e, f),
2386 &|a, b, c, d, e, f| self.write_to_c_conversion_inline_suffix_inner(a, b, c, d, e, f))
2388 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 {
2389 self.write_to_c_conversion_new_var_inner(w, ident, &format!("{}", ident), t, generics, ptr_for_ref, false)
2391 /// Prints new-var conversion for an "ownable_ref" type, ie prints conversion for
2392 /// `create_ownable_reference(t)`, not `t` itself.
2393 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 {
2394 self.write_to_c_conversion_new_var_inner(w, ident, &format!("{}", ident), t, generics, true, true)
2396 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 {
2397 self.write_conversion_new_var_intern(w, ident, &format!("{}", ident), t, generics, false, false, false, false,
2398 &|a, b| self.from_c_conversion_new_var_from_path(a, b),
2399 &|a, b, c, d, e| self.from_c_conversion_container_new_var(generics, a, b, c, d, e),
2400 // We force ptr_for_ref here since we can't generate a ref on one line and use it later
2401 &|a, b, c, d, e, _f| self.write_from_c_conversion_prefix_inner(a, b, c, d, e),
2402 &|a, b, c, d, e, _f| self.write_from_c_conversion_suffix_inner(a, b, c, d, e))
2405 // ******************************************************
2406 // *** C Container Type Equivalent and alias Printing ***
2407 // ******************************************************
2409 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 {
2410 for (idx, t) in args.enumerate() {
2412 write!(w, ", ").unwrap();
2414 if let syn::Type::Reference(r_arg) = t {
2415 assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
2417 if !self.write_c_type_intern(w, &*r_arg.elem, generics, false, false, false, true, true) { return false; }
2419 // While write_c_type_intern, above is correct, we don't want to blindly convert a
2420 // reference to something stupid, so check that the container is either opaque or a
2421 // predefined type (currently only Transaction).
2422 if let syn::Type::Path(p_arg) = &*r_arg.elem {
2423 let resolved = self.resolve_path(&p_arg.path, generics);
2424 assert!(self.crate_types.opaques.get(&resolved).is_some() ||
2425 self.c_type_from_path(&resolved, true, true).is_some(), "Template generics should be opaque or have a predefined mapping");
2426 } else { unimplemented!(); }
2427 } else if let syn::Type::Path(p_arg) = t {
2428 if let Some(resolved) = self.maybe_resolve_path(&p_arg.path, generics) {
2429 if !self.is_primitive(&resolved) {
2430 assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
2433 assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
2435 if !self.write_c_type_intern(w, t, generics, false, false, false, true, true) { return false; }
2437 // We don't currently support outer reference types for non-primitive inners,
2438 // except for the empty tuple.
2439 if let syn::Type::Tuple(t_arg) = t {
2440 assert!(t_arg.elems.len() == 0 || !is_ref);
2444 if !self.write_c_type_intern(w, t, generics, false, false, false, true, true) { return false; }
2449 fn check_create_container(&self, mangled_container: String, container_type: &str, args: Vec<&syn::Type>, generics: Option<&GenericTypes>, is_ref: bool) -> bool {
2450 if !self.crate_types.templates_defined.borrow().get(&mangled_container).is_some() {
2451 let mut created_container: Vec<u8> = Vec::new();
2453 if container_type == "Result" {
2454 let mut a_ty: Vec<u8> = Vec::new();
2455 if let syn::Type::Tuple(tup) = args.iter().next().unwrap() {
2456 if tup.elems.is_empty() {
2457 write!(&mut a_ty, "()").unwrap();
2459 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t).take(1), generics, is_ref) { return false; }
2462 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t).take(1), generics, is_ref) { return false; }
2465 let mut b_ty: Vec<u8> = Vec::new();
2466 if let syn::Type::Tuple(tup) = args.iter().skip(1).next().unwrap() {
2467 if tup.elems.is_empty() {
2468 write!(&mut b_ty, "()").unwrap();
2470 if !self.write_template_generics(&mut b_ty, &mut args.iter().map(|t| *t).skip(1), generics, is_ref) { return false; }
2473 if !self.write_template_generics(&mut b_ty, &mut args.iter().map(|t| *t).skip(1), generics, is_ref) { return false; }
2476 let ok_str = String::from_utf8(a_ty).unwrap();
2477 let err_str = String::from_utf8(b_ty).unwrap();
2478 let is_clonable = self.is_clonable(&ok_str) && self.is_clonable(&err_str);
2479 write_result_block(&mut created_container, &mangled_container, &ok_str, &err_str, is_clonable);
2481 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2483 } else if container_type == "Vec" {
2484 let mut a_ty: Vec<u8> = Vec::new();
2485 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t), generics, is_ref) { return false; }
2486 let ty = String::from_utf8(a_ty).unwrap();
2487 let is_clonable = self.is_clonable(&ty);
2488 write_vec_block(&mut created_container, &mangled_container, &ty, is_clonable);
2490 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2492 } else if container_type.ends_with("Tuple") {
2493 let mut tuple_args = Vec::new();
2494 let mut is_clonable = true;
2495 for arg in args.iter() {
2496 let mut ty: Vec<u8> = Vec::new();
2497 if !self.write_template_generics(&mut ty, &mut [arg].iter().map(|t| **t), generics, is_ref) { return false; }
2498 let ty_str = String::from_utf8(ty).unwrap();
2499 if !self.is_clonable(&ty_str) {
2500 is_clonable = false;
2502 tuple_args.push(ty_str);
2504 write_tuple_block(&mut created_container, &mangled_container, &tuple_args, is_clonable);
2506 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2508 } else if container_type == "Option" {
2509 let mut a_ty: Vec<u8> = Vec::new();
2510 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t), generics, is_ref) { return false; }
2511 let ty = String::from_utf8(a_ty).unwrap();
2512 let is_clonable = self.is_clonable(&ty);
2513 write_option_block(&mut created_container, &mangled_container, &ty, is_clonable);
2515 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2520 self.crate_types.write_new_template(mangled_container.clone(), true, &created_container);
2524 fn path_to_generic_args(path: &syn::Path) -> Vec<&syn::Type> {
2525 if let syn::PathArguments::AngleBracketed(args) = &path.segments.iter().next().unwrap().arguments {
2526 args.args.iter().map(|gen| if let syn::GenericArgument::Type(t) = gen { t } else { unimplemented!() }).collect()
2527 } else { unimplemented!(); }
2529 fn write_c_mangled_container_path_intern<W: std::io::Write>
2530 (&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 {
2531 let mut mangled_type: Vec<u8> = Vec::new();
2532 if !self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) {
2533 write!(w, "C{}_", ident).unwrap();
2534 write!(mangled_type, "C{}_", ident).unwrap();
2535 } else { assert_eq!(args.len(), 1); }
2536 for arg in args.iter() {
2537 macro_rules! write_path {
2538 ($p_arg: expr, $extra_write: expr) => {
2539 if let Some(subtype) = self.maybe_resolve_path(&$p_arg.path, generics) {
2540 if self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) {
2542 if self.c_type_has_inner_from_path(&subtype) {
2543 if !self.write_c_path_intern(w, &$p_arg.path, generics, is_ref, is_mut, ptr_for_ref, false, true) { return false; }
2545 if let Some(arr_ty) = self.is_real_type_array(&subtype) {
2546 if !self.write_c_type_intern(w, &arr_ty, generics, false, true, false, false, true) { return false; }
2548 // Option<T> needs to be converted to a *mut T, ie mut ptr-for-ref
2549 if !self.write_c_path_intern(w, &$p_arg.path, generics, true, true, true, false, true) { return false; }
2553 write!(w, "{}", $p_arg.path.segments.last().unwrap().ident).unwrap();
2555 } else if self.is_known_container(&subtype, is_ref) || self.is_path_transparent_container(&$p_arg.path, generics, is_ref) {
2556 if !self.write_c_mangled_container_path_intern(w, Self::path_to_generic_args(&$p_arg.path), generics,
2557 &subtype, is_ref, is_mut, ptr_for_ref, true) {
2560 self.write_c_mangled_container_path_intern(&mut mangled_type, Self::path_to_generic_args(&$p_arg.path),
2561 generics, &subtype, is_ref, is_mut, ptr_for_ref, true);
2562 if let Some(w2) = $extra_write as Option<&mut Vec<u8>> {
2563 self.write_c_mangled_container_path_intern(w2, Self::path_to_generic_args(&$p_arg.path),
2564 generics, &subtype, is_ref, is_mut, ptr_for_ref, true);
2567 let id = subtype.rsplitn(2, ':').next().unwrap(); // Get the "Base" name of the resolved type
2568 write!(w, "{}", id).unwrap();
2569 write!(mangled_type, "{}", id).unwrap();
2570 if let Some(w2) = $extra_write as Option<&mut Vec<u8>> {
2571 write!(w2, "{}", id).unwrap();
2574 } else { return false; }
2577 match generics.resolve_type(arg) {
2578 syn::Type::Tuple(tuple) => {
2579 if tuple.elems.len() == 0 {
2580 write!(w, "None").unwrap();
2581 write!(mangled_type, "None").unwrap();
2583 let mut mangled_tuple_type: Vec<u8> = Vec::new();
2585 // Figure out what the mangled type should look like. To disambiguate
2586 // ((A, B), C) and (A, B, C) we prefix the generic args with a _ and suffix
2587 // them with a Z. Ideally we wouldn't use Z, but not many special chars are
2588 // available for use in type names.
2589 write!(w, "C{}Tuple_", tuple.elems.len()).unwrap();
2590 write!(mangled_type, "C{}Tuple_", tuple.elems.len()).unwrap();
2591 write!(mangled_tuple_type, "C{}Tuple_", tuple.elems.len()).unwrap();
2592 for elem in tuple.elems.iter() {
2593 if let syn::Type::Path(p) = elem {
2594 write_path!(p, Some(&mut mangled_tuple_type));
2595 } else if let syn::Type::Reference(refelem) = elem {
2596 if let syn::Type::Path(p) = &*refelem.elem {
2597 write_path!(p, Some(&mut mangled_tuple_type));
2598 } else { return false; }
2599 } else { return false; }
2601 write!(w, "Z").unwrap();
2602 write!(mangled_type, "Z").unwrap();
2603 write!(mangled_tuple_type, "Z").unwrap();
2604 if !self.check_create_container(String::from_utf8(mangled_tuple_type).unwrap(),
2605 &format!("{}Tuple", tuple.elems.len()), tuple.elems.iter().collect(), generics, is_ref) {
2610 syn::Type::Path(p_arg) => {
2611 write_path!(p_arg, None);
2613 syn::Type::Reference(refty) => {
2614 if let syn::Type::Path(p_arg) = &*refty.elem {
2615 write_path!(p_arg, None);
2616 } else if let syn::Type::Slice(_) = &*refty.elem {
2617 // write_c_type will actually do exactly what we want here, we just need to
2618 // make it a pointer so that its an option. Note that we cannot always convert
2619 // the Vec-as-slice (ie non-ref types) containers, so sometimes need to be able
2620 // to edit it, hence we use *mut here instead of *const.
2621 if args.len() != 1 { return false; }
2622 write!(w, "*mut ").unwrap();
2623 self.write_c_type(w, arg, None, true);
2624 } else { return false; }
2626 syn::Type::Array(a) => {
2627 if let syn::Type::Path(p_arg) = &*a.elem {
2628 let resolved = self.resolve_path(&p_arg.path, generics);
2629 if !self.is_primitive(&resolved) { return false; }
2630 if let syn::Expr::Lit(syn::ExprLit { lit: syn::Lit::Int(len), .. }) = &a.len {
2631 if self.c_type_from_path(&format!("[{}; {}]", resolved, len.base10_digits()), is_ref, ptr_for_ref).is_none() { return false; }
2632 if in_type || args.len() != 1 {
2633 write!(w, "_{}{}", resolved, len.base10_digits()).unwrap();
2634 write!(mangled_type, "_{}{}", resolved, len.base10_digits()).unwrap();
2636 let arrty = format!("[{}; {}]", resolved, len.base10_digits());
2637 let realty = self.c_type_from_path(&arrty, is_ref, ptr_for_ref).unwrap_or(&arrty);
2638 write!(w, "{}", realty).unwrap();
2639 write!(mangled_type, "{}", realty).unwrap();
2641 } else { return false; }
2642 } else { return false; }
2644 _ => { return false; },
2647 if self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) { return true; }
2648 // Push the "end of type" Z
2649 write!(w, "Z").unwrap();
2650 write!(mangled_type, "Z").unwrap();
2652 // Make sure the type is actually defined:
2653 self.check_create_container(String::from_utf8(mangled_type).unwrap(), ident, args, generics, is_ref)
2655 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 {
2656 if !self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) {
2657 write!(w, "{}::", Self::generated_container_path()).unwrap();
2659 self.write_c_mangled_container_path_intern(w, args, generics, ident, is_ref, is_mut, ptr_for_ref, false)
2661 pub fn get_c_mangled_container_type(&self, args: Vec<&syn::Type>, generics: Option<&GenericTypes>, template_name: &str) -> Option<String> {
2662 let mut out = Vec::new();
2663 if !self.write_c_mangled_container_path(&mut out, args, generics, template_name, false, false, false) {
2666 Some(String::from_utf8(out).unwrap())
2669 // **********************************
2670 // *** C Type Equivalent Printing ***
2671 // **********************************
2673 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 {
2674 let full_path = match self.maybe_resolve_path(&path, generics) {
2675 Some(path) => path, None => return false };
2676 if let Some(c_type) = self.c_type_from_path(&full_path, is_ref, ptr_for_ref) {
2677 write!(w, "{}", c_type).unwrap();
2679 } else if self.crate_types.traits.get(&full_path).is_some() {
2680 // Note that we always use the crate:: prefix here as we are always referring to a
2681 // concrete object which is of the generated type, it just implements the upstream
2683 if is_ref && ptr_for_ref {
2684 write!(w, "*{} crate::{}", if is_mut { "mut" } else { "const" }, full_path).unwrap();
2686 if with_ref_lifetime { unimplemented!(); }
2687 write!(w, "&{}crate::{}", if is_mut { "mut " } else { "" }, full_path).unwrap();
2689 write!(w, "crate::{}", full_path).unwrap();
2692 } else if self.crate_types.opaques.get(&full_path).is_some() || self.crate_types.mirrored_enums.get(&full_path).is_some() {
2693 let crate_pfx = if c_ty { "crate::" } else { "" };
2694 if is_ref && ptr_for_ref {
2695 // ptr_for_ref implies we're returning the object, which we can't really do for
2696 // opaque or mirrored types without box'ing them, which is quite a waste, so return
2697 // the actual object itself (for opaque types we'll set the pointer to the actual
2698 // type and note that its a reference).
2699 write!(w, "{}{}", crate_pfx, full_path).unwrap();
2700 } else if is_ref && with_ref_lifetime {
2702 // If we're concretizing something with a lifetime parameter, we have to pick a
2703 // lifetime, of which the only real available choice is `static`, obviously.
2704 write!(w, "&'static {}", crate_pfx).unwrap();
2706 self.write_rust_path(w, generics, path);
2708 write!(w, "{}", full_path).unwrap();
2711 write!(w, "&{}{}{}", if is_mut { "mut " } else { "" }, crate_pfx, full_path).unwrap();
2713 write!(w, "{}{}", crate_pfx, full_path).unwrap();
2720 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 {
2721 match generics.resolve_type(t) {
2722 syn::Type::Path(p) => {
2723 if p.qself.is_some() {
2726 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
2727 if self.is_known_container(&full_path, is_ref) || self.is_path_transparent_container(&p.path, generics, is_ref) {
2728 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);
2730 if let Some(aliased_type) = self.crate_types.type_aliases.get(&full_path).cloned() {
2731 return self.write_c_type_intern(w, &aliased_type, None, is_ref, is_mut, ptr_for_ref, with_ref_lifetime, c_ty);
2734 self.write_c_path_intern(w, &p.path, generics, is_ref, is_mut, ptr_for_ref, with_ref_lifetime, c_ty)
2736 syn::Type::Reference(r) => {
2737 self.write_c_type_intern(w, &*r.elem, generics, true, r.mutability.is_some(), ptr_for_ref, with_ref_lifetime, c_ty)
2739 syn::Type::Array(a) => {
2740 if is_ref && is_mut {
2741 write!(w, "*mut [").unwrap();
2742 if !self.write_c_type_intern(w, &a.elem, generics, false, false, ptr_for_ref, with_ref_lifetime, c_ty) { return false; }
2744 write!(w, "*const [").unwrap();
2745 if !self.write_c_type_intern(w, &a.elem, generics, false, false, ptr_for_ref, with_ref_lifetime, c_ty) { return false; }
2747 let mut typecheck = Vec::new();
2748 if !self.write_c_type_intern(&mut typecheck, &a.elem, generics, false, false, ptr_for_ref, with_ref_lifetime, c_ty) { return false; }
2749 if typecheck[..] != ['u' as u8, '8' as u8] { return false; }
2751 if let syn::Expr::Lit(l) = &a.len {
2752 if let syn::Lit::Int(i) = &l.lit {
2754 if let Some(ty) = self.c_type_from_path(&format!("[u8; {}]", i.base10_digits()), false, ptr_for_ref) {
2755 write!(w, "{}", ty).unwrap();
2759 write!(w, "; {}]", i).unwrap();
2765 syn::Type::Slice(s) => {
2766 if !is_ref || is_mut { return false; }
2767 if let syn::Type::Path(p) = &*s.elem {
2768 let resolved = self.resolve_path(&p.path, generics);
2769 if self.is_primitive(&resolved) {
2770 write!(w, "{}::{}slice", Self::container_templ_path(), resolved).unwrap();
2773 let mut inner_c_ty = Vec::new();
2774 assert!(self.write_c_path_intern(&mut inner_c_ty, &p.path, generics, true, false, ptr_for_ref, with_ref_lifetime, c_ty));
2775 if self.is_clonable(&String::from_utf8(inner_c_ty).unwrap()) {
2776 if let Some(id) = p.path.get_ident() {
2777 let mangled_container = format!("CVec_{}Z", id);
2778 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
2779 self.check_create_container(mangled_container, "Vec", vec![&*s.elem], generics, false)
2783 } else if let syn::Type::Reference(r) = &*s.elem {
2784 if let syn::Type::Path(p) = &*r.elem {
2785 // Slices with "real types" inside are mapped as the equivalent non-ref Vec
2786 let resolved = self.resolve_path(&p.path, generics);
2787 let mangled_container = if let Some((ident, _)) = self.crate_types.opaques.get(&resolved) {
2788 format!("CVec_{}Z", ident)
2789 } else if let Some(en) = self.crate_types.mirrored_enums.get(&resolved) {
2790 format!("CVec_{}Z", en.ident)
2791 } else if let Some(id) = p.path.get_ident() {
2792 format!("CVec_{}Z", id)
2793 } else { return false; };
2794 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
2795 self.check_create_container(mangled_container, "Vec", vec![&*r.elem], generics, false)
2796 } else if let syn::Type::Slice(sl2) = &*r.elem {
2797 if let syn::Type::Reference(r2) = &*sl2.elem {
2798 if let syn::Type::Path(p) = &*r2.elem {
2799 // Slices with slices with opaque types (with is_owned flags) are mapped as non-ref Vecs
2800 let resolved = self.resolve_path(&p.path, generics);
2801 let mangled_container = if let Some((ident, _)) = self.crate_types.opaques.get(&resolved) {
2802 format!("CVec_CVec_{}ZZ", ident)
2803 } else { return false; };
2804 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
2805 let inner = &r2.elem;
2806 let vec_ty: syn::Type = syn::parse_quote!(Vec<#inner>);
2807 self.check_create_container(mangled_container, "Vec", vec![&vec_ty], generics, false)
2811 } else if let syn::Type::Tuple(_) = &*s.elem {
2812 let mut args = syn::punctuated::Punctuated::<_, syn::token::Comma>::new();
2813 args.push(syn::GenericArgument::Type((*s.elem).clone()));
2814 let mut segments = syn::punctuated::Punctuated::new();
2815 segments.push(parse_quote!(Vec<#args>));
2816 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)
2819 syn::Type::Tuple(t) => {
2820 if t.elems.len() == 0 {
2823 self.write_c_mangled_container_path(w, t.elems.iter().collect(), generics,
2824 &format!("{}Tuple", t.elems.len()), is_ref, is_mut, ptr_for_ref)
2830 pub fn write_c_type<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, ptr_for_ref: bool) {
2831 assert!(self.write_c_type_intern(w, t, generics, false, false, ptr_for_ref, false, true));
2833 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) {
2834 assert!(self.write_c_type_intern(w, t, generics, false, false, ptr_for_ref, true, false));
2836 pub fn understood_c_path(&self, p: &syn::Path) -> bool {
2837 if p.leading_colon.is_some() { return false; }
2838 self.write_c_path_intern(&mut std::io::sink(), p, None, false, false, false, false, true)
2840 pub fn understood_c_type(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> bool {
2841 self.write_c_type_intern(&mut std::io::sink(), t, generics, false, false, false, false, true)