1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE>
5 // or the MIT license <LICENSE-MIT>, at your option.
6 // You may not use this file except in accordance with one or both of these
9 use std::cell::RefCell;
10 use std::collections::{HashMap, HashSet};
17 use proc_macro2::{TokenTree, Span};
18 use quote::format_ident;
21 // The following utils are used purely to build our known types maps - they break down all the
22 // types we need to resolve to include the given object, and no more.
24 pub fn first_seg_self<'a>(t: &'a syn::Type) -> Option<impl Iterator<Item=&syn::PathSegment> + 'a> {
26 syn::Type::Path(p) => {
27 if p.qself.is_some() || p.path.leading_colon.is_some() {
30 let mut segs = p.path.segments.iter();
31 let ty = segs.next().unwrap();
32 if !ty.arguments.is_empty() { return None; }
33 if format!("{}", ty.ident) == "Self" {
41 pub fn get_single_remaining_path_seg<'a, I: Iterator<Item=&'a syn::PathSegment>>(segs: &mut I) -> Option<&'a syn::Ident> {
42 if let Some(ty) = segs.next() {
43 if !ty.arguments.is_empty() { unimplemented!(); }
44 if segs.next().is_some() { return None; }
49 pub fn first_seg_is_stdlib(first_seg_str: &str) -> bool {
50 first_seg_str == "std" || first_seg_str == "core" || first_seg_str == "alloc"
53 pub fn single_ident_generic_path_to_ident(p: &syn::Path) -> Option<&syn::Ident> {
54 if p.segments.len() == 1 {
55 Some(&p.segments.iter().next().unwrap().ident)
59 pub fn path_matches_nongeneric(p: &syn::Path, exp: &[&str]) -> bool {
60 if p.segments.len() != exp.len() { return false; }
61 for (seg, e) in p.segments.iter().zip(exp.iter()) {
62 if seg.arguments != syn::PathArguments::None { return false; }
63 if &format!("{}", seg.ident) != *e { return false; }
68 pub fn string_path_to_syn_path(path: &str) -> syn::Path {
69 let mut segments = syn::punctuated::Punctuated::new();
70 for seg in path.split("::") {
71 segments.push(syn::PathSegment {
72 ident: syn::Ident::new(seg, Span::call_site()),
73 arguments: syn::PathArguments::None,
76 syn::Path { leading_colon: Some(syn::Token![::](Span::call_site())), segments }
79 #[derive(Debug, PartialEq)]
80 pub enum ExportStatus {
84 /// This is used only for traits to indicate that users should not be able to implement their
85 /// own version of a trait, but we should export Rust implementations of the trait (and the
87 /// Concretly, this means that we do not implement the Rust trait for the C trait struct.
90 /// Gets the ExportStatus of an object (struct, fn, etc) given its attributes.
91 pub fn export_status(attrs: &[syn::Attribute]) -> ExportStatus {
92 for attr in attrs.iter() {
93 let tokens_clone = attr.tokens.clone();
94 let mut token_iter = tokens_clone.into_iter();
95 if let Some(token) = token_iter.next() {
97 TokenTree::Punct(c) if c.as_char() == '=' => {
98 // Really not sure where syn gets '=' from here -
99 // it somehow represents '///' or '//!'
101 TokenTree::Group(g) => {
102 if format!("{}", single_ident_generic_path_to_ident(&attr.path).unwrap()) == "cfg" {
103 let mut iter = g.stream().into_iter();
104 if let TokenTree::Ident(i) = iter.next().unwrap() {
106 // #[cfg(any(test, feature = ""))]
107 if let TokenTree::Group(g) = iter.next().unwrap() {
108 let mut all_test = true;
109 for token in g.stream().into_iter() {
110 if let TokenTree::Ident(i) = token {
111 match format!("{}", i).as_str() {
114 _ => all_test = false,
116 } else if let TokenTree::Literal(lit) = token {
117 if format!("{}", lit) != "fuzztarget" {
122 if all_test { return ExportStatus::TestOnly; }
124 } else if i == "test" {
125 return ExportStatus::TestOnly;
129 continue; // eg #[derive()]
131 _ => unimplemented!(),
134 match token_iter.next().unwrap() {
135 TokenTree::Literal(lit) => {
136 let line = format!("{}", lit);
137 if line.contains("(C-not exported)") {
138 return ExportStatus::NoExport;
139 } else if line.contains("(C-not implementable)") {
140 return ExportStatus::NotImplementable;
143 _ => unimplemented!(),
149 pub fn assert_simple_bound(bound: &syn::TraitBound) {
150 if bound.paren_token.is_some() || bound.lifetimes.is_some() { unimplemented!(); }
151 if let syn::TraitBoundModifier::Maybe(_) = bound.modifier { unimplemented!(); }
154 /// Returns true if the enum will be mapped as an opaue (ie struct with a pointer to the underlying
155 /// type), otherwise it is mapped into a transparent, C-compatible version of itself.
156 pub fn is_enum_opaque(e: &syn::ItemEnum) -> bool {
157 for var in e.variants.iter() {
158 if let syn::Fields::Named(fields) = &var.fields {
159 for field in fields.named.iter() {
160 match export_status(&field.attrs) {
161 ExportStatus::Export|ExportStatus::TestOnly => {},
162 ExportStatus::NotImplementable => panic!("(C-not implementable) should only appear on traits!"),
163 ExportStatus::NoExport => return true,
166 } else if let syn::Fields::Unnamed(fields) = &var.fields {
167 for field in fields.unnamed.iter() {
168 match export_status(&field.attrs) {
169 ExportStatus::Export|ExportStatus::TestOnly => {},
170 ExportStatus::NotImplementable => panic!("(C-not implementable) should only appear on traits!"),
171 ExportStatus::NoExport => return true,
179 /// A stack of sets of generic resolutions.
181 /// This tracks the template parameters for a function, struct, or trait, allowing resolution into
182 /// a concrete type. By pushing a new context onto the stack, this can track a function's template
183 /// parameters inside of a generic struct or trait.
185 /// It maps both direct types as well as Deref<Target = X>, mapping them via the provided
186 /// TypeResolver's resolve_path function (ie traits map to the concrete jump table, structs to the
187 /// concrete C container struct, etc).
189 pub struct GenericTypes<'a, 'b> {
190 self_ty: Option<String>,
191 parent: Option<&'b GenericTypes<'b, 'b>>,
192 typed_generics: HashMap<&'a syn::Ident, String>,
193 default_generics: HashMap<&'a syn::Ident, (syn::Type, syn::Type, syn::Type)>,
195 impl<'a, 'p: 'a> GenericTypes<'a, 'p> {
196 pub fn new(self_ty: Option<String>) -> Self {
197 Self { self_ty, parent: None, typed_generics: HashMap::new(), default_generics: HashMap::new(), }
200 /// push a new context onto the stack, allowing for a new set of generics to be learned which
201 /// will override any lower contexts, but which will still fall back to resoltion via lower
203 pub fn push_ctx<'c>(&'c self) -> GenericTypes<'a, 'c> {
204 GenericTypes { self_ty: None, parent: Some(self), typed_generics: HashMap::new(), default_generics: HashMap::new(), }
207 /// Learn the generics in generics in the current context, given a TypeResolver.
208 pub fn learn_generics<'b, 'c>(&mut self, generics: &'a syn::Generics, types: &'b TypeResolver<'a, 'c>) -> bool {
209 let mut new_typed_generics = HashMap::new();
210 // First learn simple generics...
211 for generic in generics.params.iter() {
213 syn::GenericParam::Type(type_param) => {
214 let mut non_lifetimes_processed = false;
215 'bound_loop: for bound in type_param.bounds.iter() {
216 if let syn::TypeParamBound::Trait(trait_bound) = bound {
217 if let Some(ident) = single_ident_generic_path_to_ident(&trait_bound.path) {
218 match &format!("{}", ident) as &str { "Send" => continue, "Sync" => continue, _ => {} }
220 if path_matches_nongeneric(&trait_bound.path, &["core", "clone", "Clone"]) { continue; }
222 assert_simple_bound(&trait_bound);
223 if let Some(path) = types.maybe_resolve_path(&trait_bound.path, None) {
224 if types.skip_path(&path) { continue; }
225 if path == "Sized" { continue; }
226 if non_lifetimes_processed { return false; }
227 non_lifetimes_processed = true;
228 if path != "std::ops::Deref" && path != "core::ops::Deref" {
229 let p = string_path_to_syn_path(&path);
230 let ref_ty = parse_quote!(&#p);
231 let mut_ref_ty = parse_quote!(&mut #p);
232 self.default_generics.insert(&type_param.ident, (syn::Type::Path(syn::TypePath { qself: None, path: p }), ref_ty, mut_ref_ty));
233 new_typed_generics.insert(&type_param.ident, Some(path));
235 // If we're templated on Deref<Target = ConcreteThing>, store
236 // the reference type in `default_generics` which handles full
237 // types and not just paths.
238 if let syn::PathArguments::AngleBracketed(ref args) =
239 trait_bound.path.segments[0].arguments {
240 assert_eq!(trait_bound.path.segments.len(), 1);
241 for subargument in args.args.iter() {
243 syn::GenericArgument::Lifetime(_) => {},
244 syn::GenericArgument::Binding(ref b) => {
245 if &format!("{}", b.ident) != "Target" { return false; }
247 self.default_generics.insert(&type_param.ident, (parse_quote!(&#default), parse_quote!(&#default), parse_quote!(&mut #default)));
250 _ => unimplemented!(),
254 new_typed_generics.insert(&type_param.ident, None);
260 if let Some(default) = type_param.default.as_ref() {
261 assert!(type_param.bounds.is_empty());
262 self.default_generics.insert(&type_param.ident, (default.clone(), parse_quote!(&#default), parse_quote!(&mut #default)));
268 // Then find generics where we are required to pass a Deref<Target=X> and pretend its just X.
269 if let Some(wh) = &generics.where_clause {
270 for pred in wh.predicates.iter() {
271 if let syn::WherePredicate::Type(t) = pred {
272 if let syn::Type::Path(p) = &t.bounded_ty {
273 if p.qself.is_some() { return false; }
274 if p.path.leading_colon.is_some() { return false; }
275 let mut p_iter = p.path.segments.iter();
276 let p_ident = &p_iter.next().unwrap().ident;
277 if let Some(gen) = new_typed_generics.get_mut(p_ident) {
278 if gen.is_some() { return false; }
279 if &format!("{}", p_iter.next().unwrap().ident) != "Target" {return false; }
281 let mut non_lifetimes_processed = false;
282 for bound in t.bounds.iter() {
283 if let syn::TypeParamBound::Trait(trait_bound) = bound {
284 if let Some(id) = trait_bound.path.get_ident() {
285 if format!("{}", id) == "Sized" { continue; }
287 if non_lifetimes_processed { return false; }
288 non_lifetimes_processed = true;
289 assert_simple_bound(&trait_bound);
290 let resolved = types.resolve_path(&trait_bound.path, None);
291 let ty = syn::Type::Path(syn::TypePath {
292 qself: None, path: string_path_to_syn_path(&resolved)
294 let ref_ty = parse_quote!(&#ty);
295 let mut_ref_ty = parse_quote!(&mut #ty);
296 self.default_generics.insert(p_ident, (ty, ref_ty, mut_ref_ty));
298 *gen = Some(resolved);
301 } else { return false; }
302 } else { return false; }
306 for (key, value) in new_typed_generics.drain() {
307 if let Some(v) = value {
308 assert!(self.typed_generics.insert(key, v).is_none());
309 } else { return false; }
314 /// Learn the associated types from the trait in the current context.
315 pub fn learn_associated_types<'b, 'c>(&mut self, t: &'a syn::ItemTrait, types: &'b TypeResolver<'a, 'c>) {
316 for item in t.items.iter() {
318 &syn::TraitItem::Type(ref t) => {
319 if t.default.is_some() || t.generics.lt_token.is_some() { unimplemented!(); }
320 let mut bounds_iter = t.bounds.iter();
322 match bounds_iter.next().unwrap() {
323 syn::TypeParamBound::Trait(tr) => {
324 assert_simple_bound(&tr);
325 if let Some(path) = types.maybe_resolve_path(&tr.path, None) {
326 if types.skip_path(&path) { continue; }
327 // In general we handle Deref<Target=X> as if it were just X (and
328 // implement Deref<Target=Self> for relevant types). We don't
329 // bother to implement it for associated types, however, so we just
330 // ignore such bounds.
331 if path != "std::ops::Deref" && path != "core::ops::Deref" {
332 self.typed_generics.insert(&t.ident, path);
334 } else { unimplemented!(); }
335 for bound in bounds_iter {
336 if let syn::TypeParamBound::Trait(_) = bound { unimplemented!(); }
340 syn::TypeParamBound::Lifetime(_) => {},
349 /// Attempt to resolve a Path as a generic parameter and return the full path. as both a string
351 pub fn maybe_resolve_path<'b>(&'b self, path: &syn::Path) -> Option<&'b String> {
352 if let Some(ident) = path.get_ident() {
353 if let Some(ty) = &self.self_ty {
354 if format!("{}", ident) == "Self" {
358 if let Some(res) = self.typed_generics.get(ident) {
362 // Associated types are usually specified as "Self::Generic", so we check for that
364 let mut it = path.segments.iter();
365 if path.segments.len() == 2 && format!("{}", it.next().unwrap().ident) == "Self" {
366 let ident = &it.next().unwrap().ident;
367 if let Some(res) = self.typed_generics.get(ident) {
372 if let Some(parent) = self.parent {
373 parent.maybe_resolve_path(path)
380 pub trait ResolveType<'a> { fn resolve_type(&'a self, ty: &'a syn::Type) -> &'a syn::Type; }
381 impl<'a, 'b, 'c: 'a + 'b> ResolveType<'c> for Option<&GenericTypes<'a, 'b>> {
382 fn resolve_type(&'c self, ty: &'c syn::Type) -> &'c syn::Type {
383 if let Some(us) = self {
385 syn::Type::Path(p) => {
386 if let Some(ident) = p.path.get_ident() {
387 if let Some((ty, _, _)) = us.default_generics.get(ident) {
388 return self.resolve_type(ty);
392 syn::Type::Reference(syn::TypeReference { elem, mutability, .. }) => {
393 if let syn::Type::Path(p) = &**elem {
394 if let Some(ident) = p.path.get_ident() {
395 if let Some((_, refty, mut_ref_ty)) = us.default_generics.get(ident) {
396 if mutability.is_some() {
397 return self.resolve_type(mut_ref_ty);
399 return self.resolve_type(refty);
407 us.parent.resolve_type(ty)
412 #[derive(Clone, PartialEq)]
413 // The type of declaration and the object itself
414 pub enum DeclType<'a> {
416 Trait(&'a syn::ItemTrait),
417 StructImported { generics: &'a syn::Generics },
419 EnumIgnored { generics: &'a syn::Generics },
422 pub struct ImportResolver<'mod_lifetime, 'crate_lft: 'mod_lifetime> {
423 pub crate_name: &'mod_lifetime str,
424 dependencies: &'mod_lifetime HashSet<syn::Ident>,
425 module_path: &'mod_lifetime str,
426 imports: HashMap<syn::Ident, (String, syn::Path)>,
427 declared: HashMap<syn::Ident, DeclType<'crate_lft>>,
428 priv_modules: HashSet<syn::Ident>,
430 impl<'mod_lifetime, 'crate_lft: 'mod_lifetime> ImportResolver<'mod_lifetime, 'crate_lft> {
431 fn process_use_intern(crate_name: &str, module_path: &str, dependencies: &HashSet<syn::Ident>, imports: &mut HashMap<syn::Ident, (String, syn::Path)>,
432 u: &syn::UseTree, partial_path: &str, mut path: syn::punctuated::Punctuated<syn::PathSegment, syn::token::Colon2>) {
435 macro_rules! push_path {
436 ($ident: expr, $path_suffix: expr) => {
437 if partial_path == "" && format!("{}", $ident) == "super" {
438 let mut mod_iter = module_path.rsplitn(2, "::");
439 mod_iter.next().unwrap();
440 let super_mod = mod_iter.next().unwrap();
441 new_path = format!("{}{}", super_mod, $path_suffix);
442 assert_eq!(path.len(), 0);
443 for module in super_mod.split("::") {
444 path.push(syn::PathSegment { ident: syn::Ident::new(module, Span::call_site()), arguments: syn::PathArguments::None });
446 } else if partial_path == "" && format!("{}", $ident) == "self" {
447 new_path = format!("{}{}", module_path, $path_suffix);
448 for module in module_path.split("::") {
449 path.push(syn::PathSegment { ident: syn::Ident::new(module, Span::call_site()), arguments: syn::PathArguments::None });
451 } else if partial_path == "" && format!("{}", $ident) == "crate" {
452 new_path = format!("{}{}", crate_name, $path_suffix);
453 let crate_name_ident = format_ident!("{}", crate_name);
454 path.push(parse_quote!(#crate_name_ident));
455 } else if partial_path == "" && !dependencies.contains(&$ident) {
456 new_path = format!("{}::{}{}", crate_name, $ident, $path_suffix);
457 let crate_name_ident = format_ident!("{}", crate_name);
458 path.push(parse_quote!(#crate_name_ident));
459 } else if format!("{}", $ident) == "self" {
460 let mut path_iter = partial_path.rsplitn(2, "::");
461 path_iter.next().unwrap();
462 new_path = path_iter.next().unwrap().to_owned();
464 new_path = format!("{}{}{}", partial_path, $ident, $path_suffix);
467 path.push(parse_quote!(#ident));
471 syn::UseTree::Path(p) => {
472 push_path!(p.ident, "::");
473 Self::process_use_intern(crate_name, module_path, dependencies, imports, &p.tree, &new_path, path);
475 syn::UseTree::Name(n) => {
476 push_path!(n.ident, "");
477 let imported_ident = syn::Ident::new(new_path.rsplitn(2, "::").next().unwrap(), Span::call_site());
478 imports.insert(imported_ident, (new_path, syn::Path { leading_colon: Some(syn::Token![::](Span::call_site())), segments: path }));
480 syn::UseTree::Group(g) => {
481 for i in g.items.iter() {
482 Self::process_use_intern(crate_name, module_path, dependencies, imports, i, partial_path, path.clone());
485 syn::UseTree::Rename(r) => {
486 push_path!(r.ident, "");
487 imports.insert(r.rename.clone(), (new_path, syn::Path { leading_colon: Some(syn::Token![::](Span::call_site())), segments: path }));
489 syn::UseTree::Glob(_) => {
490 eprintln!("Ignoring * use for {} - this may result in resolution failures", partial_path);
495 fn process_use(crate_name: &str, module_path: &str, dependencies: &HashSet<syn::Ident>, imports: &mut HashMap<syn::Ident, (String, syn::Path)>, u: &syn::ItemUse) {
496 if let syn::Visibility::Public(_) = u.vis {
497 // We actually only use these for #[cfg(fuzztarget)]
498 eprintln!("Ignoring pub(use) tree!");
501 if u.leading_colon.is_some() { eprintln!("Ignoring leading-colon use!"); return; }
502 Self::process_use_intern(crate_name, module_path, dependencies, imports, &u.tree, "", syn::punctuated::Punctuated::new());
505 fn insert_primitive(imports: &mut HashMap<syn::Ident, (String, syn::Path)>, id: &str) {
506 let ident = format_ident!("{}", id);
507 let path = parse_quote!(#ident);
508 imports.insert(ident, (id.to_owned(), path));
511 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 {
512 Self::from_borrowed_items(crate_name, dependencies, module_path, &contents.iter().map(|a| a).collect::<Vec<_>>())
514 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 {
515 let mut imports = HashMap::new();
516 // Add primitives to the "imports" list:
517 Self::insert_primitive(&mut imports, "bool");
518 Self::insert_primitive(&mut imports, "u64");
519 Self::insert_primitive(&mut imports, "u32");
520 Self::insert_primitive(&mut imports, "u16");
521 Self::insert_primitive(&mut imports, "u8");
522 Self::insert_primitive(&mut imports, "usize");
523 Self::insert_primitive(&mut imports, "str");
524 Self::insert_primitive(&mut imports, "String");
526 // These are here to allow us to print native Rust types in trait fn impls even if we don't
528 Self::insert_primitive(&mut imports, "Result");
529 Self::insert_primitive(&mut imports, "Vec");
530 Self::insert_primitive(&mut imports, "Option");
532 let mut declared = HashMap::new();
533 let mut priv_modules = HashSet::new();
535 for item in contents.iter() {
537 syn::Item::Use(u) => Self::process_use(crate_name, module_path, dependencies, &mut imports, &u),
538 syn::Item::Struct(s) => {
539 if let syn::Visibility::Public(_) = s.vis {
540 match export_status(&s.attrs) {
541 ExportStatus::Export => { declared.insert(s.ident.clone(), DeclType::StructImported { generics: &s.generics }); },
542 ExportStatus::NoExport => { declared.insert(s.ident.clone(), DeclType::StructIgnored); },
543 ExportStatus::TestOnly => continue,
544 ExportStatus::NotImplementable => panic!("(C-not implementable) should only appear on traits!"),
548 syn::Item::Type(t) if export_status(&t.attrs) == ExportStatus::Export => {
549 if let syn::Visibility::Public(_) = t.vis {
550 declared.insert(t.ident.clone(), DeclType::StructImported { generics: &t.generics });
553 syn::Item::Enum(e) => {
554 if let syn::Visibility::Public(_) = e.vis {
555 match export_status(&e.attrs) {
556 ExportStatus::Export if is_enum_opaque(e) => { declared.insert(e.ident.clone(), DeclType::EnumIgnored { generics: &e.generics }); },
557 ExportStatus::Export => { declared.insert(e.ident.clone(), DeclType::MirroredEnum); },
558 ExportStatus::NotImplementable => panic!("(C-not implementable) should only appear on traits!"),
563 syn::Item::Trait(t) => {
564 match export_status(&t.attrs) {
565 ExportStatus::Export|ExportStatus::NotImplementable => {
566 if let syn::Visibility::Public(_) = t.vis {
567 declared.insert(t.ident.clone(), DeclType::Trait(t));
573 syn::Item::Mod(m) => {
574 priv_modules.insert(m.ident.clone());
580 Self { crate_name, dependencies, module_path, imports, declared, priv_modules }
583 pub fn maybe_resolve_declared(&self, id: &syn::Ident) -> Option<&DeclType<'crate_lft>> {
584 self.declared.get(id)
587 pub fn maybe_resolve_ident(&self, id: &syn::Ident) -> Option<String> {
588 if let Some((imp, _)) = self.imports.get(id) {
590 } else if self.declared.get(id).is_some() {
591 Some(self.module_path.to_string() + "::" + &format!("{}", id))
595 pub fn maybe_resolve_path(&self, p: &syn::Path, generics: Option<&GenericTypes>) -> Option<String> {
596 if let Some(gen_types) = generics {
597 if let Some(resp) = gen_types.maybe_resolve_path(p) {
598 return Some(resp.clone());
602 if p.leading_colon.is_some() {
603 let mut res: String = p.segments.iter().enumerate().map(|(idx, seg)| {
604 format!("{}{}", if idx == 0 { "" } else { "::" }, seg.ident)
606 let firstseg = p.segments.iter().next().unwrap();
607 if !self.dependencies.contains(&firstseg.ident) {
608 res = self.crate_name.to_owned() + "::" + &res;
611 } else if let Some(id) = p.get_ident() {
612 self.maybe_resolve_ident(id)
614 if p.segments.len() == 1 {
615 let seg = p.segments.iter().next().unwrap();
616 return self.maybe_resolve_ident(&seg.ident);
618 let mut seg_iter = p.segments.iter();
619 let first_seg = seg_iter.next().unwrap();
620 let remaining: String = seg_iter.map(|seg| {
621 format!("::{}", seg.ident)
623 let first_seg_str = format!("{}", first_seg.ident);
624 if let Some((imp, _)) = self.imports.get(&first_seg.ident) {
626 Some(imp.clone() + &remaining)
630 } else if let Some(_) = self.priv_modules.get(&first_seg.ident) {
631 Some(format!("{}::{}{}", self.module_path, first_seg.ident, remaining))
632 } else if first_seg_is_stdlib(&first_seg_str) || self.dependencies.contains(&first_seg.ident) {
633 Some(first_seg_str + &remaining)
638 /// Map all the Paths in a Type into absolute paths given a set of imports (generated via process_use_intern)
639 pub fn resolve_imported_refs(&self, mut ty: syn::Type) -> syn::Type {
641 syn::Type::Path(p) => {
642 if p.path.segments.len() != 1 { unimplemented!(); }
643 let mut args = p.path.segments[0].arguments.clone();
644 if let syn::PathArguments::AngleBracketed(ref mut generics) = &mut args {
645 for arg in generics.args.iter_mut() {
646 if let syn::GenericArgument::Type(ref mut t) = arg {
647 *t = self.resolve_imported_refs(t.clone());
651 if let Some((_, newpath)) = self.imports.get(single_ident_generic_path_to_ident(&p.path).unwrap()) {
652 p.path = newpath.clone();
654 p.path.segments[0].arguments = args;
656 syn::Type::Reference(r) => {
657 r.elem = Box::new(self.resolve_imported_refs((*r.elem).clone()));
659 syn::Type::Slice(s) => {
660 s.elem = Box::new(self.resolve_imported_refs((*s.elem).clone()));
662 syn::Type::Tuple(t) => {
663 for e in t.elems.iter_mut() {
664 *e = self.resolve_imported_refs(e.clone());
667 _ => unimplemented!(),
673 // templates_defined is walked to write the C++ header, so if we use the default hashing it get
674 // reordered on each genbindings run. Instead, we use SipHasher (which defaults to 0-keys) so that
675 // the sorting is stable across runs. It is deprecated, but the "replacement" doesn't actually
676 // accomplish the same goals, so we just ignore it.
678 pub type NonRandomHash = hash::BuildHasherDefault<hash::SipHasher>;
681 pub struct ASTModule {
682 pub attrs: Vec<syn::Attribute>,
683 pub items: Vec<syn::Item>,
684 pub submods: Vec<String>,
686 /// A struct containing the syn::File AST for each file in the crate.
687 pub struct FullLibraryAST {
688 pub modules: HashMap<String, ASTModule, NonRandomHash>,
689 pub dependencies: HashSet<syn::Ident>,
691 impl FullLibraryAST {
692 fn load_module(&mut self, module: String, attrs: Vec<syn::Attribute>, mut items: Vec<syn::Item>) {
693 let mut non_mod_items = Vec::with_capacity(items.len());
694 let mut submods = Vec::with_capacity(items.len());
695 for item in items.drain(..) {
697 syn::Item::Mod(m) if m.content.is_some() => {
698 if export_status(&m.attrs) == ExportStatus::Export {
699 if let syn::Visibility::Public(_) = m.vis {
700 let modident = format!("{}", m.ident);
701 let modname = if module != "" {
702 module.clone() + "::" + &modident
706 self.load_module(modname, m.attrs, m.content.unwrap().1);
707 submods.push(modident);
709 non_mod_items.push(syn::Item::Mod(m));
713 syn::Item::Mod(_) => panic!("--pretty=expanded output should never have non-body modules"),
714 syn::Item::ExternCrate(c) => {
715 if export_status(&c.attrs) == ExportStatus::Export {
716 self.dependencies.insert(c.ident);
719 _ => { non_mod_items.push(item); }
722 self.modules.insert(module, ASTModule { attrs, items: non_mod_items, submods });
725 pub fn load_lib(lib: syn::File) -> Self {
726 assert_eq!(export_status(&lib.attrs), ExportStatus::Export);
727 let mut res = Self { modules: HashMap::default(), dependencies: HashSet::new() };
728 res.load_module("".to_owned(), lib.attrs, lib.items);
733 /// List of manually-generated types which are clonable
734 fn initial_clonable_types() -> HashSet<String> {
735 let mut res = HashSet::new();
736 res.insert("crate::c_types::u5".to_owned());
737 res.insert("crate::c_types::FourBytes".to_owned());
738 res.insert("crate::c_types::TwelveBytes".to_owned());
739 res.insert("crate::c_types::SixteenBytes".to_owned());
740 res.insert("crate::c_types::TwentyBytes".to_owned());
741 res.insert("crate::c_types::ThirtyTwoBytes".to_owned());
742 res.insert("crate::c_types::SecretKey".to_owned());
743 res.insert("crate::c_types::PublicKey".to_owned());
744 res.insert("crate::c_types::Transaction".to_owned());
745 res.insert("crate::c_types::TxOut".to_owned());
746 res.insert("crate::c_types::Signature".to_owned());
747 res.insert("crate::c_types::RecoverableSignature".to_owned());
748 res.insert("crate::c_types::Bech32Error".to_owned());
749 res.insert("crate::c_types::Secp256k1Error".to_owned());
750 res.insert("crate::c_types::IOError".to_owned());
751 res.insert("crate::c_types::Error".to_owned());
752 res.insert("crate::c_types::Str".to_owned());
754 // Because some types are manually-mapped to CVec_u8Z we may end up checking if its clonable
755 // before we ever get to constructing the type fully via
756 // `write_c_mangled_container_path_intern` (which will add it here too), so we have to manually
757 // add it on startup.
758 res.insert("crate::c_types::derived::CVec_u8Z".to_owned());
762 /// Top-level struct tracking everything which has been defined while walking the crate.
763 pub struct CrateTypes<'a> {
764 /// This may contain structs or enums, but only when either is mapped as
765 /// struct X { inner: *mut originalX, .. }
766 pub opaques: HashMap<String, (&'a syn::Ident, &'a syn::Generics)>,
767 /// structs that weren't exposed
768 pub priv_structs: HashMap<String, &'a syn::Generics>,
769 /// Enums which are mapped as C enums with conversion functions
770 pub mirrored_enums: HashMap<String, &'a syn::ItemEnum>,
771 /// Traits which are mapped as a pointer + jump table
772 pub traits: HashMap<String, &'a syn::ItemTrait>,
773 /// Aliases from paths to some other Type
774 pub type_aliases: HashMap<String, syn::Type>,
775 /// Value is an alias to Key (maybe with some generics)
776 pub reverse_alias_map: HashMap<String, Vec<(String, syn::PathArguments)>>,
777 /// Template continer types defined, map from mangled type name -> whether a destructor fn
780 /// This is used at the end of processing to make C++ wrapper classes
781 pub templates_defined: RefCell<HashMap<String, bool, NonRandomHash>>,
782 /// The output file for any created template container types, written to as we find new
783 /// template containers which need to be defined.
784 template_file: RefCell<&'a mut File>,
785 /// Set of containers which are clonable
786 clonable_types: RefCell<HashSet<String>>,
788 pub trait_impls: HashMap<String, Vec<String>>,
789 /// The full set of modules in the crate(s)
790 pub lib_ast: &'a FullLibraryAST,
793 impl<'a> CrateTypes<'a> {
794 pub fn new(template_file: &'a mut File, libast: &'a FullLibraryAST) -> Self {
796 opaques: HashMap::new(), mirrored_enums: HashMap::new(), traits: HashMap::new(),
797 type_aliases: HashMap::new(), reverse_alias_map: HashMap::new(),
798 templates_defined: RefCell::new(HashMap::default()), priv_structs: HashMap::new(),
799 clonable_types: RefCell::new(initial_clonable_types()), trait_impls: HashMap::new(),
800 template_file: RefCell::new(template_file), lib_ast: &libast,
803 pub fn set_clonable(&self, object: String) {
804 self.clonable_types.borrow_mut().insert(object);
806 pub fn is_clonable(&self, object: &str) -> bool {
807 self.clonable_types.borrow().contains(object)
809 pub fn write_new_template(&self, mangled_container: String, has_destructor: bool, created_container: &[u8]) {
810 self.template_file.borrow_mut().write(created_container).unwrap();
811 self.templates_defined.borrow_mut().insert(mangled_container, has_destructor);
815 /// A struct which tracks resolving rust types into C-mapped equivalents, exists for one specific
816 /// module but contains a reference to the overall CrateTypes tracking.
817 pub struct TypeResolver<'mod_lifetime, 'crate_lft: 'mod_lifetime> {
818 pub module_path: &'mod_lifetime str,
819 pub crate_types: &'mod_lifetime CrateTypes<'crate_lft>,
820 pub types: ImportResolver<'mod_lifetime, 'crate_lft>,
823 /// Returned by write_empty_rust_val_check_suffix to indicate what type of dereferencing needs to
824 /// happen to get the inner value of a generic.
825 enum EmptyValExpectedTy {
826 /// A type which has a flag for being empty (eg an array where we treat all-0s as empty).
828 /// A Option mapped as a COption_*Z
830 /// A pointer which we want to convert to a reference.
835 /// Describes the appropriate place to print a general type-conversion string when converting a
837 enum ContainerPrefixLocation {
838 /// Prints a general type-conversion string prefix and suffix outside of the
839 /// container-conversion strings.
841 /// Prints a general type-conversion string prefix and suffix inside of the
842 /// container-conversion strings.
844 /// Does not print the usual type-conversion string prefix and suffix.
848 impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
849 pub fn new(module_path: &'a str, types: ImportResolver<'a, 'c>, crate_types: &'a CrateTypes<'c>) -> Self {
850 Self { module_path, types, crate_types }
853 // *************************************************
854 // *** Well know type and conversion definitions ***
855 // *************************************************
857 /// Returns true we if can just skip passing this to C entirely
858 pub fn skip_path(&self, full_path: &str) -> bool {
859 full_path == "bitcoin::secp256k1::Secp256k1" ||
860 full_path == "bitcoin::secp256k1::Signing" ||
861 full_path == "bitcoin::secp256k1::Verification"
863 /// Returns true we if can just skip passing this to C entirely
864 fn no_arg_path_to_rust(&self, full_path: &str) -> &str {
865 if full_path == "bitcoin::secp256k1::Secp256k1" {
866 "secp256k1::global::SECP256K1"
867 } else { unimplemented!(); }
870 /// Returns true if the object is a primitive and is mapped as-is with no conversion
872 pub fn is_primitive(&self, full_path: &str) -> bool {
883 pub fn is_clonable(&self, ty: &str) -> bool {
884 if self.crate_types.is_clonable(ty) { return true; }
885 if self.is_primitive(ty) { return true; }
891 /// Gets the C-mapped type for types which are outside of the crate, or which are manually
892 /// ignored by for some reason need mapping anyway.
893 fn c_type_from_path<'b>(&self, full_path: &'b str, is_ref: bool, _ptr_for_ref: bool) -> Option<&'b str> {
894 if self.is_primitive(full_path) {
895 return Some(full_path);
898 // Note that no !is_ref types can map to an array because Rust and C's call semantics
899 // for arrays are different (https://github.com/eqrion/cbindgen/issues/528)
901 "[u8; 32]" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
902 "[u8; 20]" if !is_ref => Some("crate::c_types::TwentyBytes"),
903 "[u8; 16]" if !is_ref => Some("crate::c_types::SixteenBytes"),
904 "[u8; 12]" if !is_ref => Some("crate::c_types::TwelveBytes"),
905 "[u8; 4]" if !is_ref => Some("crate::c_types::FourBytes"),
906 "[u8; 3]" if !is_ref => Some("crate::c_types::ThreeBytes"), // Used for RGB values
908 "str" if is_ref => Some("crate::c_types::Str"),
909 "alloc::string::String"|"String" => Some("crate::c_types::Str"),
911 "std::time::Duration"|"core::time::Duration" => Some("u64"),
912 "std::time::SystemTime" => Some("u64"),
913 "std::io::Error"|"lightning::io::Error" => Some("crate::c_types::IOError"),
914 "core::fmt::Arguments" if is_ref => Some("crate::c_types::Str"),
916 "core::convert::Infallible" => Some("crate::c_types::NotConstructable"),
918 "bitcoin::bech32::Error"|"bech32::Error"
919 if !is_ref => Some("crate::c_types::Bech32Error"),
920 "bitcoin::secp256k1::Error"|"secp256k1::Error"
921 if !is_ref => Some("crate::c_types::Secp256k1Error"),
923 "core::num::ParseIntError" => Some("crate::c_types::Error"),
924 "core::str::Utf8Error" => Some("crate::c_types::Error"),
926 "bitcoin::bech32::u5"|"bech32::u5" => Some("crate::c_types::u5"),
927 "core::num::NonZeroU8" => Some("u8"),
929 "secp256k1::PublicKey"|"bitcoin::secp256k1::PublicKey" => Some("crate::c_types::PublicKey"),
930 "bitcoin::secp256k1::ecdsa::Signature" => Some("crate::c_types::Signature"),
931 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some("crate::c_types::RecoverableSignature"),
932 "bitcoin::secp256k1::SecretKey" if is_ref => Some("*const [u8; 32]"),
933 "bitcoin::secp256k1::SecretKey" if !is_ref => Some("crate::c_types::SecretKey"),
934 "bitcoin::blockdata::script::Script" if is_ref => Some("crate::c_types::u8slice"),
935 "bitcoin::blockdata::script::Script" if !is_ref => Some("crate::c_types::derived::CVec_u8Z"),
936 "bitcoin::blockdata::transaction::OutPoint" => Some("crate::lightning::chain::transaction::OutPoint"),
937 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some("crate::c_types::Transaction"),
938 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some("crate::c_types::TxOut"),
939 "bitcoin::network::constants::Network" => Some("crate::bitcoin::network::Network"),
940 "bitcoin::util::address::WitnessVersion" => Some("crate::c_types::WitnessVersion"),
941 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some("*const [u8; 80]"),
942 "bitcoin::blockdata::block::Block" if is_ref => Some("crate::c_types::u8slice"),
944 "bitcoin::hash_types::PubkeyHash"|"bitcoin::hash_types::WPubkeyHash"|"bitcoin::hash_types::ScriptHash"
945 if is_ref => Some("*const [u8; 20]"),
946 "bitcoin::hash_types::WScriptHash"
947 if is_ref => Some("*const [u8; 32]"),
949 // Newtypes that we just expose in their original form.
950 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
951 if is_ref => Some("*const [u8; 32]"),
952 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
953 if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
954 "bitcoin::secp256k1::Message" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
955 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
956 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
957 if is_ref => Some("*const [u8; 32]"),
958 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
959 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
960 if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
962 "lightning::io::Read" => Some("crate::c_types::u8slice"),
968 fn from_c_conversion_new_var_from_path<'b>(&self, _full_path: &str, _is_ref: bool) -> Option<(&'b str, &'b str)> {
971 fn from_c_conversion_prefix_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<String> {
972 if self.is_primitive(full_path) {
973 return Some("".to_owned());
976 "Vec" if !is_ref => Some("local_"),
977 "Result" if !is_ref => Some("local_"),
978 "Option" if is_ref => Some("&local_"),
979 "Option" => Some("local_"),
981 "[u8; 32]" if is_ref => Some("unsafe { &*"),
982 "[u8; 32]" if !is_ref => Some(""),
983 "[u8; 20]" if !is_ref => Some(""),
984 "[u8; 16]" if !is_ref => Some(""),
985 "[u8; 12]" if !is_ref => Some(""),
986 "[u8; 4]" if !is_ref => Some(""),
987 "[u8; 3]" if !is_ref => Some(""),
989 "[u8]" if is_ref => Some(""),
990 "[usize]" if is_ref => Some(""),
992 "str" if is_ref => Some(""),
993 "alloc::string::String"|"String" => Some(""),
994 "std::io::Error"|"lightning::io::Error" => Some(""),
995 // Note that we'll panic for String if is_ref, as we only have non-owned memory, we
996 // cannot create a &String.
998 "core::convert::Infallible" => Some("panic!(\"You must never construct a NotConstructable! : "),
1000 "bitcoin::bech32::Error"|"bech32::Error" if !is_ref => Some(""),
1001 "bitcoin::secp256k1::Error"|"secp256k1::Error" if !is_ref => Some(""),
1003 "core::num::ParseIntError" => Some("u8::from_str_radix(\" a\", 10).unwrap_err() /*"),
1004 "core::str::Utf8Error" => Some("core::str::from_utf8(&[0xff]).unwrap_err() /*"),
1006 "std::time::Duration"|"core::time::Duration" => Some("core::time::Duration::from_secs("),
1007 "std::time::SystemTime" => Some("(::std::time::SystemTime::UNIX_EPOCH + std::time::Duration::from_secs("),
1009 "bitcoin::bech32::u5"|"bech32::u5" => Some(""),
1010 "core::num::NonZeroU8" => Some("core::num::NonZeroU8::new("),
1012 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" if is_ref => Some("&"),
1013 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" => Some(""),
1014 "bitcoin::secp256k1::ecdsa::Signature" if is_ref => Some("&"),
1015 "bitcoin::secp256k1::ecdsa::Signature" => Some(""),
1016 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some(""),
1017 "bitcoin::secp256k1::SecretKey" if is_ref => Some("&::bitcoin::secp256k1::SecretKey::from_slice(&unsafe { *"),
1018 "bitcoin::secp256k1::SecretKey" if !is_ref => Some(""),
1019 "bitcoin::blockdata::script::Script" if is_ref => Some("&::bitcoin::blockdata::script::Script::from(Vec::from("),
1020 "bitcoin::blockdata::script::Script" if !is_ref => Some("::bitcoin::blockdata::script::Script::from("),
1021 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" if is_ref => Some("&"),
1022 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(""),
1023 "bitcoin::blockdata::transaction::OutPoint" => Some("crate::c_types::C_to_bitcoin_outpoint("),
1024 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(""),
1025 "bitcoin::network::constants::Network" => Some(""),
1026 "bitcoin::util::address::WitnessVersion" => Some(""),
1027 "bitcoin::blockdata::block::BlockHeader" => Some("&::bitcoin::consensus::encode::deserialize(unsafe { &*"),
1028 "bitcoin::blockdata::block::Block" if is_ref => Some("&::bitcoin::consensus::encode::deserialize("),
1030 "bitcoin::hash_types::PubkeyHash" if is_ref =>
1031 Some("&bitcoin::hash_types::PubkeyHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
1032 "bitcoin::hash_types::WPubkeyHash" if is_ref =>
1033 Some("&bitcoin::hash_types::WPubkeyHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
1034 "bitcoin::hash_types::ScriptHash" if is_ref =>
1035 Some("&bitcoin::hash_types::ScriptHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
1036 "bitcoin::hash_types::WScriptHash" if is_ref =>
1037 Some("&bitcoin::hash_types::WScriptHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
1039 // Newtypes that we just expose in their original form.
1040 "bitcoin::hash_types::Txid" if is_ref => Some("&::bitcoin::hash_types::Txid::from_slice(&unsafe { &*"),
1041 "bitcoin::hash_types::Txid" if !is_ref => Some("::bitcoin::hash_types::Txid::from_slice(&"),
1042 "bitcoin::hash_types::BlockHash" => Some("::bitcoin::hash_types::BlockHash::from_slice(&"),
1043 "lightning::ln::PaymentHash" if !is_ref => Some("::lightning::ln::PaymentHash("),
1044 "lightning::ln::PaymentHash" if is_ref => Some("&::lightning::ln::PaymentHash(unsafe { *"),
1045 "lightning::ln::PaymentPreimage" if !is_ref => Some("::lightning::ln::PaymentPreimage("),
1046 "lightning::ln::PaymentPreimage" if is_ref => Some("&::lightning::ln::PaymentPreimage(unsafe { *"),
1047 "lightning::ln::PaymentSecret" if !is_ref => Some("::lightning::ln::PaymentSecret("),
1048 "lightning::ln::channelmanager::PaymentId" if !is_ref => Some("::lightning::ln::channelmanager::PaymentId("),
1049 "lightning::ln::channelmanager::PaymentId" if is_ref=> Some("&::lightning::ln::channelmanager::PaymentId( unsafe { *"),
1050 "lightning::chain::keysinterface::KeyMaterial" if !is_ref => Some("::lightning::chain::keysinterface::KeyMaterial("),
1051 "lightning::chain::keysinterface::KeyMaterial" if is_ref=> Some("&::lightning::chain::keysinterface::KeyMaterial( unsafe { *"),
1053 // List of traits we map (possibly during processing of other files):
1054 "lightning::io::Read" => Some("&mut "),
1057 }.map(|s| s.to_owned())
1059 fn from_c_conversion_suffix_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<String> {
1060 if self.is_primitive(full_path) {
1061 return Some("".to_owned());
1064 "Vec" if !is_ref => Some(""),
1065 "Option" => Some(""),
1066 "Result" if !is_ref => Some(""),
1068 "[u8; 32]" if is_ref => Some("}"),
1069 "[u8; 32]" if !is_ref => Some(".data"),
1070 "[u8; 20]" if !is_ref => Some(".data"),
1071 "[u8; 16]" if !is_ref => Some(".data"),
1072 "[u8; 12]" if !is_ref => Some(".data"),
1073 "[u8; 4]" if !is_ref => Some(".data"),
1074 "[u8; 3]" if !is_ref => Some(".data"),
1076 "[u8]" if is_ref => Some(".to_slice()"),
1077 "[usize]" if is_ref => Some(".to_slice()"),
1079 "str" if is_ref => Some(".into_str()"),
1080 "alloc::string::String"|"String" => Some(".into_string()"),
1081 "std::io::Error"|"lightning::io::Error" => Some(".to_rust()"),
1083 "core::convert::Infallible" => Some("\")"),
1085 "bitcoin::bech32::Error"|"bech32::Error" if !is_ref => Some(".into_rust()"),
1086 "bitcoin::secp256k1::Error"|"secp256k1::Error" if !is_ref => Some(".into_rust()"),
1088 "core::num::ParseIntError" => Some("*/"),
1089 "core::str::Utf8Error" => Some("*/"),
1091 "std::time::Duration"|"core::time::Duration" => Some(")"),
1092 "std::time::SystemTime" => Some("))"),
1094 "bitcoin::bech32::u5"|"bech32::u5" => Some(".into()"),
1095 "core::num::NonZeroU8" => Some(").expect(\"Value must be non-zero\")"),
1097 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" => Some(".into_rust()"),
1098 "bitcoin::secp256k1::ecdsa::Signature" => Some(".into_rust()"),
1099 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some(".into_rust()"),
1100 "bitcoin::secp256k1::SecretKey" if !is_ref => Some(".into_rust()"),
1101 "bitcoin::secp256k1::SecretKey" if is_ref => Some("}[..]).unwrap()"),
1102 "bitcoin::blockdata::script::Script" if is_ref => Some(".to_slice()))"),
1103 "bitcoin::blockdata::script::Script" if !is_ref => Some(".into_rust())"),
1104 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(".into_bitcoin()"),
1105 "bitcoin::blockdata::transaction::OutPoint" => Some(")"),
1106 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(".into_rust()"),
1107 "bitcoin::network::constants::Network" => Some(".into_bitcoin()"),
1108 "bitcoin::util::address::WitnessVersion" => Some(".into()"),
1109 "bitcoin::blockdata::block::BlockHeader" => Some(" }).unwrap()"),
1110 "bitcoin::blockdata::block::Block" => Some(".to_slice()).unwrap()"),
1112 "bitcoin::hash_types::PubkeyHash"|"bitcoin::hash_types::WPubkeyHash"|
1113 "bitcoin::hash_types::ScriptHash"|"bitcoin::hash_types::WScriptHash"
1114 if is_ref => Some(" }.clone()))"),
1116 // Newtypes that we just expose in their original form.
1117 "bitcoin::hash_types::Txid" if is_ref => Some(" }[..]).unwrap()"),
1118 "bitcoin::hash_types::Txid" => Some(".data[..]).unwrap()"),
1119 "bitcoin::hash_types::BlockHash" if !is_ref => Some(".data[..]).unwrap()"),
1120 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1121 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1122 if !is_ref => Some(".data)"),
1123 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1124 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1125 if is_ref => Some(" })"),
1127 // List of traits we map (possibly during processing of other files):
1128 "lightning::io::Read" => Some(".to_reader()"),
1131 }.map(|s| s.to_owned())
1134 fn to_c_conversion_new_var_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<(&'b str, &'b str)> {
1135 if self.is_primitive(full_path) {
1139 "[u8]" if is_ref => Some(("crate::c_types::u8slice::from_slice(", ")")),
1140 "[usize]" if is_ref => Some(("crate::c_types::usizeslice::from_slice(", ")")),
1142 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some(("{ let mut s = [0u8; 80]; s[..].copy_from_slice(&::bitcoin::consensus::encode::serialize(", ")); s }")),
1143 "bitcoin::blockdata::block::Block" if is_ref => Some(("::bitcoin::consensus::encode::serialize(", ")")),
1144 "bitcoin::hash_types::Txid" => None,
1147 }.map(|s| s.to_owned())
1149 fn to_c_conversion_inline_prefix_from_path(&self, full_path: &str, is_ref: bool, _ptr_for_ref: bool) -> Option<String> {
1150 if self.is_primitive(full_path) {
1151 return Some("".to_owned());
1154 "Result" if !is_ref => Some("local_"),
1155 "Vec" if !is_ref => Some("local_"),
1156 "Option" => Some("local_"),
1158 "[u8; 32]" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1159 "[u8; 32]" if is_ref => Some(""),
1160 "[u8; 20]" if !is_ref => Some("crate::c_types::TwentyBytes { data: "),
1161 "[u8; 16]" if !is_ref => Some("crate::c_types::SixteenBytes { data: "),
1162 "[u8; 12]" if !is_ref => Some("crate::c_types::TwelveBytes { data: "),
1163 "[u8; 4]" if !is_ref => Some("crate::c_types::FourBytes { data: "),
1164 "[u8; 3]" if is_ref => Some(""),
1166 "[u8]" if is_ref => Some("local_"),
1167 "[usize]" if is_ref => Some("local_"),
1169 "str" if is_ref => Some(""),
1170 "alloc::string::String"|"String" => Some(""),
1172 "std::time::Duration"|"core::time::Duration" => Some(""),
1173 "std::time::SystemTime" => Some(""),
1174 "std::io::Error"|"lightning::io::Error" => Some("crate::c_types::IOError::from_rust("),
1175 "core::fmt::Arguments" => Some("alloc::format!(\"{}\", "),
1177 "core::convert::Infallible" => Some("panic!(\"Cannot construct an Infallible: "),
1179 "bitcoin::bech32::Error"|"bech32::Error"
1180 if !is_ref => Some("crate::c_types::Bech32Error::from_rust("),
1181 "bitcoin::secp256k1::Error"|"secp256k1::Error"
1182 if !is_ref => Some("crate::c_types::Secp256k1Error::from_rust("),
1184 "core::num::ParseIntError" => Some("crate::c_types::Error { _dummy: 0 } /*"),
1185 "core::str::Utf8Error" => Some("crate::c_types::Error { _dummy: 0 } /*"),
1187 "bitcoin::bech32::u5"|"bech32::u5" => Some(""),
1189 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" => Some("crate::c_types::PublicKey::from_rust(&"),
1190 "bitcoin::secp256k1::ecdsa::Signature" => Some("crate::c_types::Signature::from_rust(&"),
1191 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some("crate::c_types::RecoverableSignature::from_rust(&"),
1192 "bitcoin::secp256k1::SecretKey" if is_ref => Some(""),
1193 "bitcoin::secp256k1::SecretKey" if !is_ref => Some("crate::c_types::SecretKey::from_rust("),
1194 "bitcoin::blockdata::script::Script" if is_ref => Some("crate::c_types::u8slice::from_slice(&"),
1195 "bitcoin::blockdata::script::Script" if !is_ref => Some(""),
1196 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" if is_ref => Some("crate::c_types::Transaction::from_bitcoin("),
1197 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some("crate::c_types::Transaction::from_bitcoin(&"),
1198 "bitcoin::blockdata::transaction::OutPoint" => Some("crate::c_types::bitcoin_to_C_outpoint("),
1199 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some("crate::c_types::TxOut::from_rust("),
1200 "bitcoin::network::constants::Network" => Some("crate::bitcoin::network::Network::from_bitcoin("),
1201 "bitcoin::util::address::WitnessVersion" => Some(""),
1202 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some("&local_"),
1203 "bitcoin::blockdata::block::Block" if is_ref => Some("crate::c_types::u8slice::from_slice(&local_"),
1205 "bitcoin::hash_types::Txid" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1207 // Newtypes that we just expose in their original form.
1208 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1209 if is_ref => Some(""),
1210 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1211 if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1212 "bitcoin::secp256k1::Message" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1213 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1214 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1215 if is_ref => Some("&"),
1216 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1217 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1218 if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1220 "lightning::io::Read" => Some("crate::c_types::u8slice::from_vec(&crate::c_types::reader_to_vec("),
1223 }.map(|s| s.to_owned())
1225 fn to_c_conversion_inline_suffix_from_path(&self, full_path: &str, is_ref: bool, _ptr_for_ref: bool) -> Option<String> {
1226 if self.is_primitive(full_path) {
1227 return Some("".to_owned());
1230 "Result" if !is_ref => Some(""),
1231 "Vec" if !is_ref => Some(".into()"),
1232 "Option" => Some(""),
1234 "[u8; 32]" if !is_ref => Some(" }"),
1235 "[u8; 32]" if is_ref => Some(""),
1236 "[u8; 20]" if !is_ref => Some(" }"),
1237 "[u8; 16]" if !is_ref => Some(" }"),
1238 "[u8; 12]" if !is_ref => Some(" }"),
1239 "[u8; 4]" if !is_ref => Some(" }"),
1240 "[u8; 3]" if is_ref => Some(""),
1242 "[u8]" if is_ref => Some(""),
1243 "[usize]" if is_ref => Some(""),
1245 "str" if is_ref => Some(".into()"),
1246 "alloc::string::String"|"String" if is_ref => Some(".as_str().into()"),
1247 "alloc::string::String"|"String" => Some(".into()"),
1249 "std::time::Duration"|"core::time::Duration" => Some(".as_secs()"),
1250 "std::time::SystemTime" => Some(".duration_since(::std::time::SystemTime::UNIX_EPOCH).expect(\"Times must be post-1970\").as_secs()"),
1251 "std::io::Error"|"lightning::io::Error" => Some(")"),
1252 "core::fmt::Arguments" => Some(").into()"),
1254 "core::convert::Infallible" => Some("\")"),
1256 "bitcoin::secp256k1::Error"|"bech32::Error"
1257 if !is_ref => Some(")"),
1258 "bitcoin::secp256k1::Error"|"secp256k1::Error"
1259 if !is_ref => Some(")"),
1261 "core::num::ParseIntError" => Some("*/"),
1262 "core::str::Utf8Error" => Some("*/"),
1264 "bitcoin::bech32::u5"|"bech32::u5" => Some(".into()"),
1266 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" => Some(")"),
1267 "bitcoin::secp256k1::ecdsa::Signature" => Some(")"),
1268 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some(")"),
1269 "bitcoin::secp256k1::SecretKey" if !is_ref => Some(")"),
1270 "bitcoin::secp256k1::SecretKey" if is_ref => Some(".as_ref()"),
1271 "bitcoin::blockdata::script::Script" if is_ref => Some("[..])"),
1272 "bitcoin::blockdata::script::Script" if !is_ref => Some(".into_bytes().into()"),
1273 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(")"),
1274 "bitcoin::blockdata::transaction::OutPoint" => Some(")"),
1275 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(")"),
1276 "bitcoin::network::constants::Network" => Some(")"),
1277 "bitcoin::util::address::WitnessVersion" => Some(".into()"),
1278 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some(""),
1279 "bitcoin::blockdata::block::Block" if is_ref => Some(")"),
1281 "bitcoin::hash_types::Txid" if !is_ref => Some(".into_inner() }"),
1283 // Newtypes that we just expose in their original form.
1284 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1285 if is_ref => Some(".as_inner()"),
1286 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1287 if !is_ref => Some(".into_inner() }"),
1288 "bitcoin::secp256k1::Message" if !is_ref => Some(".as_ref().clone() }"),
1289 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1290 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1291 if is_ref => Some(".0"),
1292 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1293 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1294 if !is_ref => Some(".0 }"),
1296 "lightning::io::Read" => Some("))"),
1299 }.map(|s| s.to_owned())
1302 fn empty_val_check_suffix_from_path(&self, full_path: &str) -> Option<&str> {
1304 "lightning::ln::PaymentSecret" => Some(".data == [0; 32]"),
1305 "secp256k1::PublicKey"|"bitcoin::secp256k1::PublicKey" => Some(".is_null()"),
1306 "bitcoin::secp256k1::ecdsa::Signature" => Some(".is_null()"),
1311 /// When printing a reference to the source crate's rust type, if we need to map it to a
1312 /// different "real" type, it can be done so here.
1313 /// This is useful to work around limitations in the binding type resolver, where we reference
1314 /// a non-public `use` alias.
1315 /// TODO: We should never need to use this!
1316 fn real_rust_type_mapping<'equiv>(&self, thing: &'equiv str) -> &'equiv str {
1318 "lightning::io::Read" => "crate::c_types::io::Read",
1323 // ****************************
1324 // *** Container Processing ***
1325 // ****************************
1327 /// Returns the module path in the generated mapping crate to the containers which we generate
1328 /// when writing to CrateTypes::template_file.
1329 pub fn generated_container_path() -> &'static str {
1330 "crate::c_types::derived"
1332 /// Returns the module path in the generated mapping crate to the container templates, which
1333 /// are then concretized and put in the generated container path/template_file.
1334 fn container_templ_path() -> &'static str {
1338 /// Returns true if the path containing the given args is a "transparent" container, ie an
1339 /// Option or a container which does not require a generated continer class.
1340 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 {
1341 if full_path == "Option" {
1342 let inner = args.next().unwrap();
1343 assert!(args.next().is_none());
1345 syn::Type::Reference(_) => true,
1346 syn::Type::Array(a) => {
1347 if let syn::Expr::Lit(l) = &a.len {
1348 if let syn::Lit::Int(i) = &l.lit {
1349 if i.base10_digits().parse::<usize>().unwrap() >= 32 {
1350 let mut buf = Vec::new();
1351 self.write_rust_type(&mut buf, generics, &a.elem, false);
1352 let ty = String::from_utf8(buf).unwrap();
1355 // Blindly assume that if we're trying to create an empty value for an
1356 // array < 32 entries that all-0s may be a valid state.
1359 } else { unimplemented!(); }
1360 } else { unimplemented!(); }
1362 syn::Type::Path(p) => {
1363 if let Some(resolved) = self.maybe_resolve_path(&p.path, generics) {
1364 if self.c_type_has_inner_from_path(&resolved) { return true; }
1365 if self.is_primitive(&resolved) { return false; }
1366 if self.c_type_from_path(&resolved, false, false).is_some() { true } else { false }
1369 syn::Type::Tuple(_) => false,
1370 _ => unimplemented!(),
1374 /// Returns true if the path is a "transparent" container, ie an Option or a container which does
1375 /// not require a generated continer class.
1376 pub fn is_path_transparent_container(&self, full_path: &syn::Path, generics: Option<&GenericTypes>, is_ref: bool) -> bool {
1377 let inner_iter = match &full_path.segments.last().unwrap().arguments {
1378 syn::PathArguments::None => return false,
1379 syn::PathArguments::AngleBracketed(args) => args.args.iter().map(|arg| {
1380 if let syn::GenericArgument::Type(ref ty) = arg {
1382 } else { unimplemented!() }
1384 syn::PathArguments::Parenthesized(_) => unimplemented!(),
1386 self.is_transparent_container(&self.resolve_path(full_path, generics), is_ref, inner_iter, generics)
1388 /// Returns true if this is a known, supported, non-transparent container.
1389 fn is_known_container(&self, full_path: &str, is_ref: bool) -> bool {
1390 (full_path == "Result" && !is_ref) || (full_path == "Vec" && !is_ref) || full_path.ends_with("Tuple") || full_path == "Option"
1392 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)
1393 // Returns prefix + Vec<(prefix, var-name-to-inline-convert)> + suffix
1394 // expecting one element in the vec per generic type, each of which is inline-converted
1395 -> Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)> {
1397 "Result" if !is_ref => {
1399 vec![(" { Ok(mut o) => crate::c_types::CResultTempl::ok(".to_string(), "o".to_string()),
1400 (").into(), Err(mut e) => crate::c_types::CResultTempl::err(".to_string(), "e".to_string())],
1401 ").into() }", ContainerPrefixLocation::PerConv))
1405 // We should only get here if the single contained has an inner
1406 assert!(self.c_type_has_inner(single_contained.unwrap()));
1408 Some(("Vec::new(); for mut item in ", vec![(format!(".drain(..) {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1411 if let Some(syn::Type::Reference(_)) = single_contained {
1412 Some(("Vec::new(); for item in ", vec![(format!(".iter() {{ local_{}.push(", var_name), "(*item)".to_string())], "); }", ContainerPrefixLocation::PerConv))
1414 Some(("Vec::new(); for item in ", vec![(format!(".iter() {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1418 let mut is_contained_ref = false;
1419 let contained_struct = if let Some(syn::Type::Path(p)) = single_contained {
1420 Some(self.resolve_path(&p.path, generics))
1421 } else if let Some(syn::Type::Reference(r)) = single_contained {
1422 is_contained_ref = true;
1423 if let syn::Type::Path(p) = &*r.elem {
1424 Some(self.resolve_path(&p.path, generics))
1427 if let Some(inner_path) = contained_struct {
1428 let only_contained_has_inner = self.c_type_has_inner_from_path(&inner_path);
1429 if self.c_type_has_inner_from_path(&inner_path) {
1430 let is_inner_ref = if let Some(syn::Type::Reference(_)) = single_contained { true } else { false };
1432 return Some(("if ", vec![
1433 (".is_none() { core::ptr::null() } else { ObjOps::nonnull_ptr_to_inner(".to_owned(),
1434 format!("({}{}.unwrap())", var_access, if is_inner_ref { "" } else { ".as_ref()" }))
1435 ], ") }", ContainerPrefixLocation::OutsideConv));
1437 return Some(("if ", vec![
1438 (".is_none() { core::ptr::null_mut() } else { ".to_owned(), format!("({}.unwrap())", var_access))
1439 ], " }", ContainerPrefixLocation::OutsideConv));
1441 } else if self.is_primitive(&inner_path) || self.c_type_from_path(&inner_path, false, false).is_none() {
1442 if self.is_primitive(&inner_path) || (!is_contained_ref && !is_ref) || only_contained_has_inner {
1443 let inner_name = self.get_c_mangled_container_type(vec![single_contained.unwrap()], generics, "Option").unwrap();
1444 return Some(("if ", vec![
1445 (format!(".is_none() {{ {}::None }} else {{ {}::Some(", inner_name, inner_name),
1446 format!("{}.unwrap()", var_access))
1447 ], ") }", ContainerPrefixLocation::PerConv));
1449 let inner_name = self.get_c_mangled_container_type(vec![single_contained.unwrap()], generics, "Option").unwrap();
1450 return Some(("if ", vec![
1451 (format!(".is_none() {{ {}::None }} else {{ {}::Some(/* WARNING: CLONING CONVERSION HERE! &Option<Enum> is otherwise un-expressable. */", inner_name, inner_name),
1452 format!("{}.clone().unwrap()", var_access))
1453 ], ") }", ContainerPrefixLocation::PerConv));
1456 // If c_type_from_path is some (ie there's a manual mapping for the inner
1457 // type), lean on write_empty_rust_val, below.
1460 if let Some(t) = single_contained {
1461 if let syn::Type::Tuple(syn::TypeTuple { elems, .. }) = t {
1462 assert!(elems.is_empty());
1463 let inner_name = self.get_c_mangled_container_type(vec![single_contained.unwrap()], generics, "Option").unwrap();
1464 return Some(("if ", vec![
1465 (format!(".is_none() {{ {}::None }} else {{ {}::Some /*",
1466 inner_name, inner_name), format!(""))
1467 ], " */}", ContainerPrefixLocation::PerConv));
1469 if let syn::Type::Reference(syn::TypeReference { elem, .. }) = t {
1470 if let syn::Type::Slice(_) = &**elem {
1471 return Some(("if ", vec![
1472 (".is_none() { SmartPtr::null() } else { SmartPtr::from_obj(".to_string(),
1473 format!("({}.unwrap())", var_access))
1474 ], ") }", ContainerPrefixLocation::PerConv));
1477 let mut v = Vec::new();
1478 self.write_empty_rust_val(generics, &mut v, t);
1479 let s = String::from_utf8(v).unwrap();
1480 return Some(("if ", vec![
1481 (format!(".is_none() {{ {} }} else {{ ", s), format!("({}.unwrap())", var_access))
1482 ], " }", ContainerPrefixLocation::PerConv));
1483 } else { unreachable!(); }
1489 /// only_contained_has_inner implies that there is only one contained element in the container
1490 /// and it has an inner field (ie is an "opaque" type we've defined).
1491 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)
1492 // Returns prefix + Vec<(prefix, var-name-to-inline-convert)> + suffix
1493 // expecting one element in the vec per generic type, each of which is inline-converted
1494 -> Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)> {
1495 let mut only_contained_has_inner = false;
1496 let only_contained_resolved = if let Some(syn::Type::Path(p)) = single_contained {
1497 let res = self.resolve_path(&p.path, generics);
1498 only_contained_has_inner = self.c_type_has_inner_from_path(&res);
1502 "Result" if !is_ref => {
1504 vec![(".result_ok { true => Ok(".to_string(), format!("(*unsafe {{ Box::from_raw(<*mut _>::take_ptr(&mut {}.contents.result)) }})", var_access)),
1505 ("), false => Err(".to_string(), format!("(*unsafe {{ Box::from_raw(<*mut _>::take_ptr(&mut {}.contents.err)) }})", var_access))],
1506 ")}", ContainerPrefixLocation::PerConv))
1508 "Slice" if is_ref && only_contained_has_inner => {
1509 Some(("Vec::new(); for mut item in ", vec![(format!(".as_slice().iter() {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1512 Some(("Vec::new(); for mut item in ", vec![(format!(".into_rust().drain(..) {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1515 if let Some(resolved) = only_contained_resolved {
1516 if self.is_primitive(&resolved) {
1517 return Some(("if ", vec![(".is_some() { Some(".to_string(), format!("{}.take()", var_access))], ") } else { None }", ContainerPrefixLocation::NoPrefix))
1518 } else if only_contained_has_inner {
1520 return Some(("if ", vec![(".inner.is_null() { None } else { Some((*".to_string(), format!("{}", var_access))], ").clone()) }", ContainerPrefixLocation::PerConv))
1522 return Some(("if ", vec![(".inner.is_null() { None } else { Some(".to_string(), format!("{}", var_access))], ") }", ContainerPrefixLocation::PerConv));
1527 if let Some(t) = single_contained {
1529 syn::Type::Reference(_)|syn::Type::Path(_)|syn::Type::Slice(_)|syn::Type::Array(_) => {
1530 let mut v = Vec::new();
1531 let ret_ref = self.write_empty_rust_val_check_suffix(generics, &mut v, t);
1532 let s = String::from_utf8(v).unwrap();
1534 EmptyValExpectedTy::ReferenceAsPointer =>
1535 return Some(("if ", vec![
1536 (format!("{} {{ None }} else {{ Some(", s), format!("unsafe {{ &mut *{} }}", var_access))
1537 ], ") }", ContainerPrefixLocation::NoPrefix)),
1538 EmptyValExpectedTy::OptionType =>
1539 return Some(("{ /* ", vec![
1540 (format!("*/ let {}_opt = {};", var_name, var_access),
1541 format!("}} if {}_opt{} {{ None }} else {{ Some({{ {}_opt.take()", var_name, s, var_name))
1542 ], ") } }", ContainerPrefixLocation::PerConv)),
1543 EmptyValExpectedTy::NonPointer =>
1544 return Some(("if ", vec![
1545 (format!("{} {{ None }} else {{ Some(", s), format!("{}", var_access))
1546 ], ") }", ContainerPrefixLocation::PerConv)),
1549 syn::Type::Tuple(_) => {
1550 return Some(("if ", vec![(".is_some() { Some(".to_string(), format!("{}.take()", var_access))], ") } else { None }", ContainerPrefixLocation::PerConv))
1552 _ => unimplemented!(),
1554 } else { unreachable!(); }
1560 /// Constructs a reference to the given type, possibly tweaking the type if relevant to make it
1561 /// convertable to C.
1562 pub fn create_ownable_reference(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> Option<syn::Type> {
1563 let default_value = Some(syn::Type::Reference(syn::TypeReference {
1564 and_token: syn::Token!(&)(Span::call_site()), lifetime: None, mutability: None,
1565 elem: Box::new(t.clone()) }));
1566 match generics.resolve_type(t) {
1567 syn::Type::Path(p) => {
1568 if let Some(resolved_path) = self.maybe_resolve_path(&p.path, generics) {
1569 if resolved_path != "Vec" { return default_value; }
1570 if p.path.segments.len() != 1 { unimplemented!(); }
1571 let only_seg = p.path.segments.iter().next().unwrap();
1572 if let syn::PathArguments::AngleBracketed(args) = &only_seg.arguments {
1573 if args.args.len() != 1 { unimplemented!(); }
1574 let inner_arg = args.args.iter().next().unwrap();
1575 if let syn::GenericArgument::Type(ty) = &inner_arg {
1576 let mut can_create = self.c_type_has_inner(&ty);
1577 if let syn::Type::Path(inner) = ty {
1578 if inner.path.segments.len() == 1 &&
1579 format!("{}", inner.path.segments[0].ident) == "Vec" {
1583 if !can_create { return default_value; }
1584 if let Some(inner_ty) = self.create_ownable_reference(&ty, generics) {
1585 return Some(syn::Type::Reference(syn::TypeReference {
1586 and_token: syn::Token![&](Span::call_site()),
1589 elem: Box::new(syn::Type::Slice(syn::TypeSlice {
1590 bracket_token: syn::token::Bracket { span: Span::call_site() },
1591 elem: Box::new(inner_ty)
1594 } else { return default_value; }
1595 } else { unimplemented!(); }
1596 } else { unimplemented!(); }
1597 } else { return None; }
1603 // *************************************************
1604 // *** Type definition during main.rs processing ***
1605 // *************************************************
1607 /// Returns true if the object at the given path is mapped as X { inner: *mut origX, .. }.
1608 pub fn c_type_has_inner_from_path(&self, full_path: &str) -> bool {
1609 self.crate_types.opaques.get(full_path).is_some()
1612 /// Returns true if the object at the given path is mapped as X { inner: *mut origX, .. }.
1613 pub fn c_type_has_inner(&self, ty: &syn::Type) -> bool {
1615 syn::Type::Path(p) => {
1616 if let Some(full_path) = self.maybe_resolve_path(&p.path, None) {
1617 self.c_type_has_inner_from_path(&full_path)
1620 syn::Type::Reference(r) => {
1621 self.c_type_has_inner(&*r.elem)
1627 pub fn maybe_resolve_ident(&self, id: &syn::Ident) -> Option<String> {
1628 self.types.maybe_resolve_ident(id)
1631 pub fn maybe_resolve_path(&self, p_arg: &syn::Path, generics: Option<&GenericTypes>) -> Option<String> {
1632 self.types.maybe_resolve_path(p_arg, generics)
1634 pub fn resolve_path(&self, p: &syn::Path, generics: Option<&GenericTypes>) -> String {
1635 self.maybe_resolve_path(p, generics).unwrap()
1638 // ***********************************
1639 // *** Original Rust Type Printing ***
1640 // ***********************************
1642 fn in_rust_prelude(resolved_path: &str) -> bool {
1643 match resolved_path {
1651 fn write_rust_path<W: std::io::Write>(&self, w: &mut W, generics_resolver: Option<&GenericTypes>, path: &syn::Path, with_ref_lifetime: bool, generated_crate_ref: bool) {
1652 if let Some(resolved) = self.maybe_resolve_path(&path, generics_resolver) {
1653 if self.is_primitive(&resolved) {
1654 write!(w, "{}", path.get_ident().unwrap()).unwrap();
1656 // TODO: We should have a generic "is from a dependency" check here instead of
1657 // checking for "bitcoin" explicitly.
1658 if resolved.starts_with("bitcoin::") || Self::in_rust_prelude(&resolved) {
1659 write!(w, "{}", resolved).unwrap();
1660 } else if !generated_crate_ref {
1661 // If we're printing a generic argument, it needs to reference the crate, otherwise
1662 // the original crate.
1663 write!(w, "{}", self.real_rust_type_mapping(&resolved)).unwrap();
1665 write!(w, "crate::{}", resolved).unwrap();
1668 if let syn::PathArguments::AngleBracketed(args) = &path.segments.iter().last().unwrap().arguments {
1669 self.write_rust_generic_arg(w, generics_resolver, args.args.iter(), with_ref_lifetime);
1672 if path.leading_colon.is_some() {
1673 write!(w, "::").unwrap();
1675 for (idx, seg) in path.segments.iter().enumerate() {
1676 if idx != 0 { write!(w, "::").unwrap(); }
1677 write!(w, "{}", seg.ident).unwrap();
1678 if let syn::PathArguments::AngleBracketed(args) = &seg.arguments {
1679 self.write_rust_generic_arg(w, generics_resolver, args.args.iter(), with_ref_lifetime);
1684 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>) {
1685 let mut had_params = false;
1686 for (idx, arg) in generics.enumerate() {
1687 if idx != 0 { write!(w, ", ").unwrap(); } else { write!(w, "<").unwrap(); }
1690 syn::GenericParam::Lifetime(lt) => write!(w, "'{}", lt.lifetime.ident).unwrap(),
1691 syn::GenericParam::Type(t) => {
1692 write!(w, "{}", t.ident).unwrap();
1693 if t.colon_token.is_some() { write!(w, ":").unwrap(); }
1694 for (idx, bound) in t.bounds.iter().enumerate() {
1695 if idx != 0 { write!(w, " + ").unwrap(); }
1697 syn::TypeParamBound::Trait(tb) => {
1698 if tb.paren_token.is_some() || tb.lifetimes.is_some() { unimplemented!(); }
1699 self.write_rust_path(w, generics_resolver, &tb.path, false, false);
1701 _ => unimplemented!(),
1704 if t.eq_token.is_some() || t.default.is_some() { unimplemented!(); }
1706 _ => unimplemented!(),
1709 if had_params { write!(w, ">").unwrap(); }
1712 pub fn write_rust_generic_arg<'b, W: std::io::Write>(&self, w: &mut W, generics_resolver: Option<&GenericTypes>, generics: impl Iterator<Item=&'b syn::GenericArgument>, with_ref_lifetime: bool) {
1713 write!(w, "<").unwrap();
1714 for (idx, arg) in generics.enumerate() {
1715 if idx != 0 { write!(w, ", ").unwrap(); }
1717 syn::GenericArgument::Type(t) => self.write_rust_type(w, generics_resolver, t, with_ref_lifetime),
1718 _ => unimplemented!(),
1721 write!(w, ">").unwrap();
1723 fn do_write_rust_type<W: std::io::Write>(&self, w: &mut W, generics: Option<&GenericTypes>, t: &syn::Type, with_ref_lifetime: bool, force_crate_ref: bool) {
1724 let real_ty = generics.resolve_type(t);
1725 let mut generate_crate_ref = force_crate_ref || t != real_ty;
1727 syn::Type::Path(p) => {
1728 if p.qself.is_some() {
1731 if let Some(resolved_ty) = self.maybe_resolve_path(&p.path, generics) {
1732 generate_crate_ref |= self.maybe_resolve_path(&p.path, None).as_ref() != Some(&resolved_ty);
1733 if self.crate_types.traits.get(&resolved_ty).is_none() { generate_crate_ref = false; }
1735 self.write_rust_path(w, generics, &p.path, with_ref_lifetime, generate_crate_ref);
1737 syn::Type::Reference(r) => {
1738 write!(w, "&").unwrap();
1739 if let Some(lft) = &r.lifetime {
1740 write!(w, "'{} ", lft.ident).unwrap();
1741 } else if with_ref_lifetime {
1742 write!(w, "'static ").unwrap();
1744 if r.mutability.is_some() {
1745 write!(w, "mut ").unwrap();
1747 self.do_write_rust_type(w, generics, &*r.elem, with_ref_lifetime, generate_crate_ref);
1749 syn::Type::Array(a) => {
1750 write!(w, "[").unwrap();
1751 self.do_write_rust_type(w, generics, &a.elem, with_ref_lifetime, generate_crate_ref);
1752 if let syn::Expr::Lit(l) = &a.len {
1753 if let syn::Lit::Int(i) = &l.lit {
1754 write!(w, "; {}]", i).unwrap();
1755 } else { unimplemented!(); }
1756 } else { unimplemented!(); }
1758 syn::Type::Slice(s) => {
1759 write!(w, "[").unwrap();
1760 self.do_write_rust_type(w, generics, &s.elem, with_ref_lifetime, generate_crate_ref);
1761 write!(w, "]").unwrap();
1763 syn::Type::Tuple(s) => {
1764 write!(w, "(").unwrap();
1765 for (idx, t) in s.elems.iter().enumerate() {
1766 if idx != 0 { write!(w, ", ").unwrap(); }
1767 self.do_write_rust_type(w, generics, &t, with_ref_lifetime, generate_crate_ref);
1769 write!(w, ")").unwrap();
1771 _ => unimplemented!(),
1774 pub fn write_rust_type<W: std::io::Write>(&self, w: &mut W, generics: Option<&GenericTypes>, t: &syn::Type, with_ref_lifetime: bool) {
1775 self.do_write_rust_type(w, generics, t, with_ref_lifetime, false);
1779 /// Prints a constructor for something which is "uninitialized" (but obviously not actually
1780 /// unint'd memory).
1781 pub fn write_empty_rust_val<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type) {
1783 syn::Type::Reference(r) => {
1784 self.write_empty_rust_val(generics, w, &*r.elem)
1786 syn::Type::Path(p) => {
1787 let resolved = self.resolve_path(&p.path, generics);
1788 if self.crate_types.opaques.get(&resolved).is_some() {
1789 write!(w, "crate::{} {{ inner: core::ptr::null_mut(), is_owned: true }}", resolved).unwrap();
1791 // Assume its a manually-mapped C type, where we can just define an null() fn
1792 write!(w, "{}::null()", self.c_type_from_path(&resolved, false, false).unwrap()).unwrap();
1795 syn::Type::Array(a) => {
1796 if let syn::Expr::Lit(l) = &a.len {
1797 if let syn::Lit::Int(i) = &l.lit {
1798 if i.base10_digits().parse::<usize>().unwrap() < 32 {
1799 // Blindly assume that if we're trying to create an empty value for an
1800 // array < 32 entries that all-0s may be a valid state.
1803 let arrty = format!("[u8; {}]", i.base10_digits());
1804 write!(w, "{}", self.to_c_conversion_inline_prefix_from_path(&arrty, false, false).unwrap()).unwrap();
1805 write!(w, "[0; {}]", i.base10_digits()).unwrap();
1806 write!(w, "{}", self.to_c_conversion_inline_suffix_from_path(&arrty, false, false).unwrap()).unwrap();
1807 } else { unimplemented!(); }
1808 } else { unimplemented!(); }
1810 _ => unimplemented!(),
1814 fn is_real_type_array(&self, resolved_type: &str) -> Option<syn::Type> {
1815 if let Some(real_ty) = self.c_type_from_path(&resolved_type, true, false) {
1816 if real_ty.ends_with("]") && real_ty.starts_with("*const [u8; ") {
1817 let mut split = real_ty.split("; ");
1818 split.next().unwrap();
1819 let tail_str = split.next().unwrap();
1820 assert!(split.next().is_none());
1821 let len = usize::from_str_radix(&tail_str[..tail_str.len() - 1], 10).unwrap();
1822 Some(parse_quote!([u8; #len]))
1827 /// Prints a suffix to determine if a variable is empty (ie was set by write_empty_rust_val).
1828 /// See EmptyValExpectedTy for information on return types.
1829 fn write_empty_rust_val_check_suffix<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type) -> EmptyValExpectedTy {
1831 syn::Type::Reference(r) => {
1832 return self.write_empty_rust_val_check_suffix(generics, w, &*r.elem);
1834 syn::Type::Path(p) => {
1835 let resolved = self.resolve_path(&p.path, generics);
1836 if let Some(arr_ty) = self.is_real_type_array(&resolved) {
1837 return self.write_empty_rust_val_check_suffix(generics, w, &arr_ty);
1839 if self.crate_types.opaques.get(&resolved).is_some() {
1840 write!(w, ".inner.is_null()").unwrap();
1841 EmptyValExpectedTy::NonPointer
1843 if let Some(suffix) = self.empty_val_check_suffix_from_path(&resolved) {
1844 write!(w, "{}", suffix).unwrap();
1845 // We may eventually need to allow empty_val_check_suffix_from_path to specify if we need a deref or not
1846 EmptyValExpectedTy::NonPointer
1848 write!(w, ".is_none()").unwrap();
1849 EmptyValExpectedTy::OptionType
1853 syn::Type::Array(a) => {
1854 if let syn::Expr::Lit(l) = &a.len {
1855 if let syn::Lit::Int(i) = &l.lit {
1856 write!(w, ".data == [0; {}]", i.base10_digits()).unwrap();
1857 EmptyValExpectedTy::NonPointer
1858 } else { unimplemented!(); }
1859 } else { unimplemented!(); }
1861 syn::Type::Slice(_) => {
1862 // Option<[]> always implies that we want to treat len() == 0 differently from
1863 // None, so we always map an Option<[]> into a pointer.
1864 write!(w, " == core::ptr::null_mut()").unwrap();
1865 EmptyValExpectedTy::ReferenceAsPointer
1867 _ => unimplemented!(),
1871 /// Prints a suffix to determine if a variable is empty (ie was set by write_empty_rust_val).
1872 pub fn write_empty_rust_val_check<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type, var_access: &str) {
1874 syn::Type::Reference(r) => {
1875 self.write_empty_rust_val_check(generics, w, &*r.elem, var_access);
1877 syn::Type::Path(_) => {
1878 write!(w, "{}", var_access).unwrap();
1879 self.write_empty_rust_val_check_suffix(generics, w, t);
1881 syn::Type::Array(a) => {
1882 if let syn::Expr::Lit(l) = &a.len {
1883 if let syn::Lit::Int(i) = &l.lit {
1884 let arrty = format!("[u8; {}]", i.base10_digits());
1885 // We don't (yet) support a new-var conversion here.
1886 assert!(self.from_c_conversion_new_var_from_path(&arrty, false).is_none());
1888 self.from_c_conversion_prefix_from_path(&arrty, false).unwrap(),
1890 self.from_c_conversion_suffix_from_path(&arrty, false).unwrap()).unwrap();
1891 self.write_empty_rust_val_check_suffix(generics, w, t);
1892 } else { unimplemented!(); }
1893 } else { unimplemented!(); }
1895 _ => unimplemented!(),
1899 // ********************************
1900 // *** Type conversion printing ***
1901 // ********************************
1903 /// Returns true we if can just skip passing this to C entirely
1904 pub fn skip_arg(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> bool {
1906 syn::Type::Path(p) => {
1907 if p.qself.is_some() { unimplemented!(); }
1908 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
1909 self.skip_path(&full_path)
1912 syn::Type::Reference(r) => {
1913 self.skip_arg(&*r.elem, generics)
1918 pub fn no_arg_to_rust<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
1920 syn::Type::Path(p) => {
1921 if p.qself.is_some() { unimplemented!(); }
1922 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
1923 write!(w, "{}", self.no_arg_path_to_rust(&full_path)).unwrap();
1926 syn::Type::Reference(r) => {
1927 self.no_arg_to_rust(w, &*r.elem, generics);
1933 fn write_conversion_inline_intern<W: std::io::Write,
1934 LP: Fn(&str, bool, bool) -> Option<String>, DL: Fn(&mut W, &DeclType, &str, bool, bool), SC: Fn(bool, Option<&str>) -> String>
1935 (&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, is_ref: bool, is_mut: bool, ptr_for_ref: bool,
1936 tupleconv: &str, prefix: bool, sliceconv: SC, path_lookup: LP, decl_lookup: DL) {
1937 match generics.resolve_type(t) {
1938 syn::Type::Reference(r) => {
1939 self.write_conversion_inline_intern(w, &*r.elem, generics, true, r.mutability.is_some(),
1940 ptr_for_ref, tupleconv, prefix, sliceconv, path_lookup, decl_lookup);
1942 syn::Type::Path(p) => {
1943 if p.qself.is_some() {
1947 let resolved_path = self.resolve_path(&p.path, generics);
1948 if let Some(aliased_type) = self.crate_types.type_aliases.get(&resolved_path) {
1949 return self.write_conversion_inline_intern(w, aliased_type, None, is_ref, is_mut, ptr_for_ref, tupleconv, prefix, sliceconv, path_lookup, decl_lookup);
1950 } else if self.is_primitive(&resolved_path) {
1951 if is_ref && prefix {
1952 write!(w, "*").unwrap();
1954 } else if let Some(c_type) = path_lookup(&resolved_path, is_ref, ptr_for_ref) {
1955 write!(w, "{}", c_type).unwrap();
1956 } else if let Some((_, generics)) = self.crate_types.opaques.get(&resolved_path) {
1957 decl_lookup(w, &DeclType::StructImported { generics: &generics }, &resolved_path, is_ref, is_mut);
1958 } else if self.crate_types.mirrored_enums.get(&resolved_path).is_some() {
1959 decl_lookup(w, &DeclType::MirroredEnum, &resolved_path, is_ref, is_mut);
1960 } else if let Some(t) = self.crate_types.traits.get(&resolved_path) {
1961 decl_lookup(w, &DeclType::Trait(t), &resolved_path, is_ref, is_mut);
1962 } else if let Some(ident) = single_ident_generic_path_to_ident(&p.path) {
1963 if let Some(decl_type) = self.types.maybe_resolve_declared(ident) {
1964 decl_lookup(w, decl_type, &self.maybe_resolve_ident(ident).unwrap(), is_ref, is_mut);
1965 } else { unimplemented!(); }
1966 } else { unimplemented!(); }
1968 syn::Type::Array(a) => {
1969 // We assume all arrays contain only [int_literal; X]s.
1970 // This may result in some outputs not compiling.
1971 if let syn::Expr::Lit(l) = &a.len {
1972 if let syn::Lit::Int(i) = &l.lit {
1973 write!(w, "{}", path_lookup(&format!("[u8; {}]", i.base10_digits()), is_ref, ptr_for_ref).unwrap()).unwrap();
1974 } else { unimplemented!(); }
1975 } else { unimplemented!(); }
1977 syn::Type::Slice(s) => {
1978 // We assume all slices contain only literals or references.
1979 // This may result in some outputs not compiling.
1980 if let syn::Type::Path(p) = &*s.elem {
1981 let resolved = self.resolve_path(&p.path, generics);
1982 if self.is_primitive(&resolved) {
1983 write!(w, "{}", path_lookup("[u8]", is_ref, ptr_for_ref).unwrap()).unwrap();
1985 write!(w, "{}", sliceconv(true, None)).unwrap();
1987 } else if let syn::Type::Reference(r) = &*s.elem {
1988 if let syn::Type::Path(p) = &*r.elem {
1989 write!(w, "{}", sliceconv(self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)), None)).unwrap();
1990 } else if let syn::Type::Slice(_) = &*r.elem {
1991 write!(w, "{}", sliceconv(false, None)).unwrap();
1992 } else { unimplemented!(); }
1993 } else if let syn::Type::Tuple(t) = &*s.elem {
1994 assert!(!t.elems.is_empty());
1996 write!(w, "{}", sliceconv(false, None)).unwrap();
1998 let mut needs_map = false;
1999 for e in t.elems.iter() {
2000 if let syn::Type::Reference(_) = e {
2005 let mut map_str = Vec::new();
2006 write!(&mut map_str, ".map(|(").unwrap();
2007 for i in 0..t.elems.len() {
2008 write!(&mut map_str, "{}{}", if i != 0 { ", " } else { "" }, ('a' as u8 + i as u8) as char).unwrap();
2010 write!(&mut map_str, ")| (").unwrap();
2011 for (idx, e) in t.elems.iter().enumerate() {
2012 if let syn::Type::Reference(_) = e {
2013 write!(&mut map_str, "{}{}", if idx != 0 { ", " } else { "" }, (idx as u8 + 'a' as u8) as char).unwrap();
2014 } else if let syn::Type::Path(_) = e {
2015 write!(&mut map_str, "{}*{}", if idx != 0 { ", " } else { "" }, (idx as u8 + 'a' as u8) as char).unwrap();
2016 } else { unimplemented!(); }
2018 write!(&mut map_str, "))").unwrap();
2019 write!(w, "{}", sliceconv(false, Some(&String::from_utf8(map_str).unwrap()))).unwrap();
2021 write!(w, "{}", sliceconv(false, None)).unwrap();
2024 } else { unimplemented!(); }
2026 syn::Type::Tuple(t) => {
2027 if t.elems.is_empty() {
2028 // cbindgen has poor support for (), see, eg https://github.com/eqrion/cbindgen/issues/527
2029 // so work around it by just pretending its a 0u8
2030 write!(w, "{}", tupleconv).unwrap();
2032 if prefix { write!(w, "local_").unwrap(); }
2035 _ => unimplemented!(),
2039 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) {
2040 self.write_conversion_inline_intern(w, t, generics, is_ref, false, ptr_for_ref, "() /*", true, |_, _| "local_".to_owned(),
2041 |a, b, c| self.to_c_conversion_inline_prefix_from_path(a, b, c),
2042 |w, decl_type, decl_path, is_ref, _is_mut| {
2044 DeclType::MirroredEnum if is_ref && ptr_for_ref => write!(w, "crate::{}::from_native(", decl_path).unwrap(),
2045 DeclType::MirroredEnum if is_ref => write!(w, "&crate::{}::from_native(", decl_path).unwrap(),
2046 DeclType::MirroredEnum => write!(w, "crate::{}::native_into(", decl_path).unwrap(),
2047 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if is_ref && from_ptr => {
2048 if !ptr_for_ref { write!(w, "&").unwrap(); }
2049 write!(w, "crate::{} {{ inner: unsafe {{ (", decl_path).unwrap()
2051 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if is_ref => {
2052 if !ptr_for_ref { write!(w, "&").unwrap(); }
2053 write!(w, "crate::{} {{ inner: unsafe {{ ObjOps::nonnull_ptr_to_inner((", decl_path).unwrap()
2055 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref && from_ptr =>
2056 write!(w, "crate::{} {{ inner: ", decl_path).unwrap(),
2057 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref =>
2058 write!(w, "crate::{} {{ inner: ObjOps::heap_alloc(", decl_path).unwrap(),
2059 DeclType::Trait(_) if is_ref => write!(w, "").unwrap(),
2060 DeclType::Trait(_) if !is_ref => write!(w, "Into::into(").unwrap(),
2061 _ => panic!("{:?}", decl_path),
2065 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) {
2066 self.write_to_c_conversion_inline_prefix_inner(w, t, generics, false, ptr_for_ref, false);
2068 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) {
2069 self.write_conversion_inline_intern(w, t, generics, is_ref, false, ptr_for_ref, "*/", false, |_, _| ".into()".to_owned(),
2070 |a, b, c| self.to_c_conversion_inline_suffix_from_path(a, b, c),
2071 |w, decl_type, full_path, is_ref, _is_mut| match decl_type {
2072 DeclType::MirroredEnum => write!(w, ")").unwrap(),
2073 DeclType::EnumIgnored { generics }|DeclType::StructImported { generics } if is_ref => {
2074 write!(w, " as *const {}<", full_path).unwrap();
2075 for param in generics.params.iter() {
2076 if let syn::GenericParam::Lifetime(_) = param {
2077 write!(w, "'_, ").unwrap();
2079 write!(w, "_, ").unwrap();
2083 write!(w, ">) as *mut _ }}, is_owned: false }}").unwrap();
2085 write!(w, ">) as *mut _) }}, is_owned: false }}").unwrap();
2088 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref && from_ptr =>
2089 write!(w, ", is_owned: true }}").unwrap(),
2090 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref => write!(w, "), is_owned: true }}").unwrap(),
2091 DeclType::Trait(_) if is_ref => {},
2092 DeclType::Trait(_) => {
2093 // This is used when we're converting a concrete Rust type into a C trait
2094 // for use when a Rust trait method returns an associated type.
2095 // Because all of our C traits implement From<RustTypesImplementingTraits>
2096 // we can just call .into() here and be done.
2097 write!(w, ")").unwrap()
2099 _ => unimplemented!(),
2102 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) {
2103 self.write_to_c_conversion_inline_suffix_inner(w, t, generics, false, ptr_for_ref, false);
2106 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) {
2107 self.write_conversion_inline_intern(w, t, generics, is_ref, false, false, "() /*", true, |_, _| "&local_".to_owned(),
2108 |a, b, _c| self.from_c_conversion_prefix_from_path(a, b),
2109 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
2110 DeclType::StructImported {..} if is_ref => write!(w, "").unwrap(),
2111 DeclType::StructImported {..} if !is_ref => write!(w, "*unsafe {{ Box::from_raw(").unwrap(),
2112 DeclType::MirroredEnum if is_ref => write!(w, "&").unwrap(),
2113 DeclType::MirroredEnum => {},
2114 DeclType::Trait(_) => {},
2115 _ => unimplemented!(),
2118 pub fn write_from_c_conversion_prefix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2119 self.write_from_c_conversion_prefix_inner(w, t, generics, false, false);
2121 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) {
2122 self.write_conversion_inline_intern(w, t, generics, is_ref, false, false, "*/", false,
2123 |has_inner, map_str_opt| match (has_inner, map_str_opt) {
2124 (false, Some(map_str)) => format!(".iter(){}.collect::<Vec<_>>()[..]", map_str),
2125 (false, None) => ".iter().collect::<Vec<_>>()[..]".to_owned(),
2126 (true, None) => "[..]".to_owned(),
2127 (true, Some(_)) => unreachable!(),
2129 |a, b, _c| self.from_c_conversion_suffix_from_path(a, b),
2130 |w, decl_type, _full_path, is_ref, is_mut| match decl_type {
2131 DeclType::StructImported {..} if is_ref && ptr_for_ref => write!(w, "XXX unimplemented").unwrap(),
2132 DeclType::StructImported {..} if is_mut && is_ref => write!(w, ".get_native_mut_ref()").unwrap(),
2133 DeclType::StructImported {..} if is_ref => write!(w, ".get_native_ref()").unwrap(),
2134 DeclType::StructImported {..} if !is_ref => write!(w, ".take_inner()) }}").unwrap(),
2135 DeclType::MirroredEnum if is_ref => write!(w, ".to_native()").unwrap(),
2136 DeclType::MirroredEnum => write!(w, ".into_native()").unwrap(),
2137 DeclType::Trait(_) => {},
2138 _ => unimplemented!(),
2141 pub fn write_from_c_conversion_suffix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2142 self.write_from_c_conversion_suffix_inner(w, t, generics, false, false);
2144 // Note that compared to the above conversion functions, the following two are generally
2145 // significantly undertested:
2146 pub fn write_from_c_conversion_to_ref_prefix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2147 self.write_conversion_inline_intern(w, t, generics, false, false, false, "() /*", true, |_, _| "&local_".to_owned(),
2149 if let Some(conv) = self.from_c_conversion_prefix_from_path(a, b) {
2150 Some(format!("&{}", conv))
2153 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
2154 DeclType::StructImported {..} if !is_ref => write!(w, "").unwrap(),
2155 _ => unimplemented!(),
2158 pub fn write_from_c_conversion_to_ref_suffix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2159 self.write_conversion_inline_intern(w, t, generics, false, false, false, "*/", false,
2160 |has_inner, map_str_opt| match (has_inner, map_str_opt) {
2161 (false, Some(map_str)) => format!(".iter(){}.collect::<Vec<_>>()[..]", map_str),
2162 (false, None) => ".iter().collect::<Vec<_>>()[..]".to_owned(),
2163 (true, None) => "[..]".to_owned(),
2164 (true, Some(_)) => unreachable!(),
2166 |a, b, _c| self.from_c_conversion_suffix_from_path(a, b),
2167 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
2168 DeclType::StructImported {..} if !is_ref => write!(w, ".get_native_ref()").unwrap(),
2169 _ => unimplemented!(),
2173 fn write_conversion_new_var_intern<'b, W: std::io::Write,
2174 LP: Fn(&str, bool) -> Option<(&str, &str)>,
2175 LC: Fn(&str, bool, Option<&syn::Type>, &syn::Ident, &str) -> Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)>,
2176 VP: Fn(&mut W, &syn::Type, Option<&GenericTypes>, bool, bool, bool),
2177 VS: Fn(&mut W, &syn::Type, Option<&GenericTypes>, bool, bool, bool)>
2178 (&self, w: &mut W, ident: &syn::Ident, var: &str, t: &syn::Type, generics: Option<&GenericTypes>,
2179 mut is_ref: bool, mut ptr_for_ref: bool, to_c: bool, from_ownable_ref: bool,
2180 path_lookup: &LP, container_lookup: &LC, var_prefix: &VP, var_suffix: &VS) -> bool {
2182 macro_rules! convert_container {
2183 ($container_type: expr, $args_len: expr, $args_iter: expr) => { {
2184 // For slices (and Options), we refuse to directly map them as is_ref when they
2185 // aren't opaque types containing an inner pointer. This is due to the fact that,
2186 // in both cases, the actual higher-level type is non-is_ref.
2187 let ty_has_inner = if $args_len == 1 {
2188 let ty = $args_iter().next().unwrap();
2189 if $container_type == "Slice" && to_c {
2190 // "To C ptr_for_ref" means "return the regular object with is_owned
2191 // set to false", which is totally what we want in a slice if we're about to
2192 // set ty_has_inner.
2195 if let syn::Type::Reference(t) = ty {
2196 if let syn::Type::Path(p) = &*t.elem {
2197 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
2199 } else if let syn::Type::Path(p) = ty {
2200 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
2204 // Options get a bunch of special handling, since in general we map Option<>al
2205 // types into the same C type as non-Option-wrapped types. This ends up being
2206 // pretty manual here and most of the below special-cases are for Options.
2207 let mut needs_ref_map = false;
2208 let mut only_contained_type = None;
2209 let mut only_contained_type_nonref = None;
2210 let mut only_contained_has_inner = false;
2211 let mut contains_slice = false;
2213 only_contained_has_inner = ty_has_inner;
2214 let arg = $args_iter().next().unwrap();
2215 if let syn::Type::Reference(t) = arg {
2216 only_contained_type = Some(arg);
2217 only_contained_type_nonref = Some(&*t.elem);
2218 if let syn::Type::Path(_) = &*t.elem {
2220 } else if let syn::Type::Slice(_) = &*t.elem {
2221 contains_slice = true;
2222 } else { return false; }
2223 // If the inner element contains an inner pointer, we will just use that,
2224 // avoiding the need to map elements to references. Otherwise we'll need to
2225 // do an extra mapping step.
2226 needs_ref_map = !only_contained_has_inner && $container_type == "Option";
2228 only_contained_type = Some(arg);
2229 only_contained_type_nonref = Some(arg);
2233 if let Some((prefix, conversions, suffix, prefix_location)) = container_lookup(&$container_type, is_ref, only_contained_type, ident, var) {
2234 assert_eq!(conversions.len(), $args_len);
2235 write!(w, "let mut local_{}{} = ", ident,
2236 if (!to_c && needs_ref_map) || (to_c && $container_type == "Option" && contains_slice) {"_base"} else { "" }).unwrap();
2237 if prefix_location == ContainerPrefixLocation::OutsideConv {
2238 var_prefix(w, $args_iter().next().unwrap(), generics, is_ref, ptr_for_ref, true);
2240 write!(w, "{}{}", prefix, var).unwrap();
2242 for ((pfx, var_name), (idx, ty)) in conversions.iter().zip($args_iter().enumerate()) {
2243 let mut var = std::io::Cursor::new(Vec::new());
2244 write!(&mut var, "{}", var_name).unwrap();
2245 let var_access = String::from_utf8(var.into_inner()).unwrap();
2247 let conv_ty = if needs_ref_map { only_contained_type_nonref.as_ref().unwrap() } else { ty };
2249 write!(w, "{} {{ ", pfx).unwrap();
2250 let new_var_name = format!("{}_{}", ident, idx);
2251 let new_var = self.write_conversion_new_var_intern(w, &format_ident!("{}", new_var_name),
2252 &var_access, conv_ty, generics, contains_slice || (is_ref && ty_has_inner), ptr_for_ref,
2253 to_c, from_ownable_ref, path_lookup, container_lookup, var_prefix, var_suffix);
2254 if new_var { write!(w, " ").unwrap(); }
2256 if prefix_location == ContainerPrefixLocation::PerConv {
2257 var_prefix(w, conv_ty, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2258 } else if !is_ref && !needs_ref_map && to_c && only_contained_has_inner {
2259 write!(w, "ObjOps::heap_alloc(").unwrap();
2262 write!(w, "{}{}", if contains_slice && !to_c { "local_" } else { "" }, if new_var { new_var_name } else { var_access }).unwrap();
2263 if prefix_location == ContainerPrefixLocation::PerConv {
2264 var_suffix(w, conv_ty, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2265 } else if !is_ref && !needs_ref_map && to_c && only_contained_has_inner {
2266 write!(w, ")").unwrap();
2268 write!(w, " }}").unwrap();
2270 write!(w, "{}", suffix).unwrap();
2271 if prefix_location == ContainerPrefixLocation::OutsideConv {
2272 var_suffix(w, $args_iter().next().unwrap(), generics, is_ref, ptr_for_ref, true);
2274 write!(w, ";").unwrap();
2275 if !to_c && needs_ref_map {
2276 write!(w, " let mut local_{} = local_{}_base.as_ref()", ident, ident).unwrap();
2278 write!(w, ".map(|a| &a[..])").unwrap();
2280 write!(w, ";").unwrap();
2281 } else if to_c && $container_type == "Option" && contains_slice {
2282 write!(w, " let mut local_{} = *local_{}_base;", ident, ident).unwrap();
2289 match generics.resolve_type(t) {
2290 syn::Type::Reference(r) => {
2291 if let syn::Type::Slice(_) = &*r.elem {
2292 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)
2294 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)
2297 syn::Type::Path(p) => {
2298 if p.qself.is_some() {
2301 let resolved_path = self.resolve_path(&p.path, generics);
2302 if let Some(aliased_type) = self.crate_types.type_aliases.get(&resolved_path) {
2303 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);
2305 if self.is_known_container(&resolved_path, is_ref) || self.is_path_transparent_container(&p.path, generics, is_ref) {
2306 if let syn::PathArguments::AngleBracketed(args) = &p.path.segments.iter().next().unwrap().arguments {
2307 convert_container!(resolved_path, args.args.len(), || args.args.iter().map(|arg| {
2308 if let syn::GenericArgument::Type(ty) = arg {
2309 generics.resolve_type(ty)
2310 } else { unimplemented!(); }
2312 } else { unimplemented!(); }
2314 if self.is_primitive(&resolved_path) {
2316 } else if let Some(ty_ident) = single_ident_generic_path_to_ident(&p.path) {
2317 if let Some((prefix, suffix)) = path_lookup(&resolved_path, is_ref) {
2318 write!(w, "let mut local_{} = {}{}{};", ident, prefix, var, suffix).unwrap();
2320 } else if self.types.maybe_resolve_declared(ty_ident).is_some() {
2325 syn::Type::Array(_) => {
2326 // We assume all arrays contain only primitive types.
2327 // This may result in some outputs not compiling.
2330 syn::Type::Slice(s) => {
2331 if let syn::Type::Path(p) = &*s.elem {
2332 let resolved = self.resolve_path(&p.path, generics);
2333 if self.is_primitive(&resolved) {
2334 let slice_path = format!("[{}]", resolved);
2335 if let Some((prefix, suffix)) = path_lookup(&slice_path, true) {
2336 write!(w, "let mut local_{} = {}{}{};", ident, prefix, var, suffix).unwrap();
2340 let tyref = [&*s.elem];
2342 // If we're converting from a slice to a Vec, assume we can clone the
2343 // elements and clone them into a new Vec first. Next we'll walk the
2344 // new Vec here and convert them to C types.
2345 write!(w, "let mut local_{}_clone = Vec::new(); local_{}_clone.extend_from_slice({}); let mut {} = local_{}_clone; ", ident, ident, ident, ident, ident).unwrap();
2348 convert_container!("Vec", 1, || tyref.iter().map(|t| generics.resolve_type(*t)));
2349 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2351 } else if let syn::Type::Reference(ty) = &*s.elem {
2352 let tyref = if from_ownable_ref || !to_c { [&*ty.elem] } else { [&*s.elem] };
2354 convert_container!("Slice", 1, || tyref.iter().map(|t| generics.resolve_type(*t)));
2355 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2356 } else if let syn::Type::Tuple(t) = &*s.elem {
2357 // When mapping into a temporary new var, we need to own all the underlying objects.
2358 // Thus, we drop any references inside the tuple and convert with non-reference types.
2359 let mut elems = syn::punctuated::Punctuated::new();
2360 for elem in t.elems.iter() {
2361 if let syn::Type::Reference(r) = elem {
2362 elems.push((*r.elem).clone());
2364 elems.push(elem.clone());
2367 let ty = [syn::Type::Tuple(syn::TypeTuple {
2368 paren_token: t.paren_token, elems
2372 convert_container!("Slice", 1, || ty.iter());
2373 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2374 } else { unimplemented!() }
2376 syn::Type::Tuple(t) => {
2377 if !t.elems.is_empty() {
2378 // We don't (yet) support tuple elements which cannot be converted inline
2379 write!(w, "let (").unwrap();
2380 for idx in 0..t.elems.len() {
2381 if idx != 0 { write!(w, ", ").unwrap(); }
2382 write!(w, "{} orig_{}_{}", if is_ref { "ref" } else { "mut" }, ident, idx).unwrap();
2384 write!(w, ") = {}{}; ", var, if !to_c { ".to_rust()" } else { "" }).unwrap();
2385 // Like other template types, tuples are always mapped as their non-ref
2386 // versions for types which have different ref mappings. Thus, we convert to
2387 // non-ref versions and handle opaque types with inner pointers manually.
2388 for (idx, elem) in t.elems.iter().enumerate() {
2389 if let syn::Type::Path(p) = elem {
2390 let v_name = format!("orig_{}_{}", ident, idx);
2391 let tuple_elem_ident = format_ident!("{}", &v_name);
2392 if self.write_conversion_new_var_intern(w, &tuple_elem_ident, &v_name, elem, generics,
2393 false, ptr_for_ref, to_c, from_ownable_ref,
2394 path_lookup, container_lookup, var_prefix, var_suffix) {
2395 write!(w, " ").unwrap();
2396 // Opaque types with inner pointers shouldn't ever create new stack
2397 // variables, so we don't handle it and just assert that it doesn't
2399 assert!(!self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)));
2403 write!(w, "let mut local_{} = (", ident).unwrap();
2404 for (idx, elem) in t.elems.iter().enumerate() {
2405 let real_elem = generics.resolve_type(&elem);
2406 let ty_has_inner = {
2408 // "To C ptr_for_ref" means "return the regular object with
2409 // is_owned set to false", which is totally what we want
2410 // if we're about to set ty_has_inner.
2413 if let syn::Type::Reference(t) = real_elem {
2414 if let syn::Type::Path(p) = &*t.elem {
2415 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
2417 } else if let syn::Type::Path(p) = real_elem {
2418 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
2421 if idx != 0 { write!(w, ", ").unwrap(); }
2422 var_prefix(w, real_elem, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2423 if is_ref && ty_has_inner {
2424 // For ty_has_inner, the regular var_prefix mapping will take a
2425 // reference, so deref once here to make sure we keep the original ref.
2426 write!(w, "*").unwrap();
2428 write!(w, "orig_{}_{}", ident, idx).unwrap();
2429 if is_ref && !ty_has_inner {
2430 // If we don't have an inner variable's reference to maintain, just
2431 // hope the type is Clonable and use that.
2432 write!(w, ".clone()").unwrap();
2434 var_suffix(w, real_elem, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2436 write!(w, "){};", if to_c { ".into()" } else { "" }).unwrap();
2440 _ => unimplemented!(),
2444 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 {
2445 self.write_conversion_new_var_intern(w, ident, var_access, t, generics, from_ownable_ref, ptr_for_ref, true, from_ownable_ref,
2446 &|a, b| self.to_c_conversion_new_var_from_path(a, b),
2447 &|a, b, c, d, e| self.to_c_conversion_container_new_var(generics, a, b, c, d, e),
2448 // We force ptr_for_ref here since we can't generate a ref on one line and use it later
2449 &|a, b, c, d, e, f| self.write_to_c_conversion_inline_prefix_inner(a, b, c, d, e, f),
2450 &|a, b, c, d, e, f| self.write_to_c_conversion_inline_suffix_inner(a, b, c, d, e, f))
2452 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 {
2453 self.write_to_c_conversion_new_var_inner(w, ident, &format!("{}", ident), t, generics, ptr_for_ref, false)
2455 /// Prints new-var conversion for an "ownable_ref" type, ie prints conversion for
2456 /// `create_ownable_reference(t)`, not `t` itself.
2457 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 {
2458 self.write_to_c_conversion_new_var_inner(w, ident, &format!("{}", ident), t, generics, true, true)
2460 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 {
2461 self.write_conversion_new_var_intern(w, ident, &format!("{}", ident), t, generics, false, false, false, false,
2462 &|a, b| self.from_c_conversion_new_var_from_path(a, b),
2463 &|a, b, c, d, e| self.from_c_conversion_container_new_var(generics, a, b, c, d, e),
2464 // We force ptr_for_ref here since we can't generate a ref on one line and use it later
2465 &|a, b, c, d, e, _f| self.write_from_c_conversion_prefix_inner(a, b, c, d, e),
2466 &|a, b, c, d, e, _f| self.write_from_c_conversion_suffix_inner(a, b, c, d, e))
2469 // ******************************************************
2470 // *** C Container Type Equivalent and alias Printing ***
2471 // ******************************************************
2473 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 {
2474 for (idx, t) in args.enumerate() {
2476 write!(w, ", ").unwrap();
2478 if let syn::Type::Reference(r_arg) = t {
2479 assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
2481 if !self.write_c_type_intern(w, &*r_arg.elem, generics, false, false, false, true, true) { return false; }
2483 // While write_c_type_intern, above is correct, we don't want to blindly convert a
2484 // reference to something stupid, so check that the container is either opaque or a
2485 // predefined type (currently only Transaction).
2486 if let syn::Type::Path(p_arg) = &*r_arg.elem {
2487 let resolved = self.resolve_path(&p_arg.path, generics);
2488 assert!(self.crate_types.opaques.get(&resolved).is_some() ||
2489 self.c_type_from_path(&resolved, true, true).is_some(), "Template generics should be opaque or have a predefined mapping");
2490 } else { unimplemented!(); }
2491 } else if let syn::Type::Path(p_arg) = t {
2492 if let Some(resolved) = self.maybe_resolve_path(&p_arg.path, generics) {
2493 if !self.is_primitive(&resolved) {
2494 assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
2497 assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
2499 if !self.write_c_type_intern(w, t, generics, false, false, false, true, true) { return false; }
2501 // We don't currently support outer reference types for non-primitive inners,
2502 // except for the empty tuple.
2503 if let syn::Type::Tuple(t_arg) = t {
2504 assert!(t_arg.elems.len() == 0 || !is_ref);
2508 if !self.write_c_type_intern(w, t, generics, false, false, false, true, true) { return false; }
2513 fn check_create_container(&self, mangled_container: String, container_type: &str, args: Vec<&syn::Type>, generics: Option<&GenericTypes>, is_ref: bool) -> bool {
2514 if !self.crate_types.templates_defined.borrow().get(&mangled_container).is_some() {
2515 let mut created_container: Vec<u8> = Vec::new();
2517 if container_type == "Result" {
2518 let mut a_ty: Vec<u8> = Vec::new();
2519 if let syn::Type::Tuple(tup) = args.iter().next().unwrap() {
2520 if tup.elems.is_empty() {
2521 write!(&mut a_ty, "()").unwrap();
2523 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t).take(1), generics, is_ref) { return false; }
2526 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t).take(1), generics, is_ref) { return false; }
2529 let mut b_ty: Vec<u8> = Vec::new();
2530 if let syn::Type::Tuple(tup) = args.iter().skip(1).next().unwrap() {
2531 if tup.elems.is_empty() {
2532 write!(&mut b_ty, "()").unwrap();
2534 if !self.write_template_generics(&mut b_ty, &mut args.iter().map(|t| *t).skip(1), generics, is_ref) { return false; }
2537 if !self.write_template_generics(&mut b_ty, &mut args.iter().map(|t| *t).skip(1), generics, is_ref) { return false; }
2540 let ok_str = String::from_utf8(a_ty).unwrap();
2541 let err_str = String::from_utf8(b_ty).unwrap();
2542 let is_clonable = self.is_clonable(&ok_str) && self.is_clonable(&err_str);
2543 write_result_block(&mut created_container, &mangled_container, &ok_str, &err_str, is_clonable);
2545 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2547 } else if container_type == "Vec" {
2548 let mut a_ty: Vec<u8> = Vec::new();
2549 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t), generics, is_ref) { return false; }
2550 let ty = String::from_utf8(a_ty).unwrap();
2551 let is_clonable = self.is_clonable(&ty);
2552 write_vec_block(&mut created_container, &mangled_container, &ty, is_clonable);
2554 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2556 } else if container_type.ends_with("Tuple") {
2557 let mut tuple_args = Vec::new();
2558 let mut is_clonable = true;
2559 for arg in args.iter() {
2560 let mut ty: Vec<u8> = Vec::new();
2561 if !self.write_template_generics(&mut ty, &mut [arg].iter().map(|t| **t), generics, is_ref) { return false; }
2562 let ty_str = String::from_utf8(ty).unwrap();
2563 if !self.is_clonable(&ty_str) {
2564 is_clonable = false;
2566 tuple_args.push(ty_str);
2568 write_tuple_block(&mut created_container, &mangled_container, &tuple_args, is_clonable);
2570 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2572 } else if container_type == "Option" {
2573 let mut a_ty: Vec<u8> = Vec::new();
2574 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t), generics, is_ref) { return false; }
2575 let ty = String::from_utf8(a_ty).unwrap();
2576 let is_clonable = self.is_clonable(&ty);
2577 write_option_block(&mut created_container, &mangled_container, &ty, is_clonable);
2579 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2584 self.crate_types.write_new_template(mangled_container.clone(), true, &created_container);
2588 fn path_to_generic_args(path: &syn::Path) -> Vec<&syn::Type> {
2589 if let syn::PathArguments::AngleBracketed(args) = &path.segments.iter().next().unwrap().arguments {
2590 args.args.iter().map(|gen| if let syn::GenericArgument::Type(t) = gen { t } else { unimplemented!() }).collect()
2591 } else { unimplemented!(); }
2593 fn write_c_mangled_container_path_intern<W: std::io::Write>
2594 (&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 {
2595 let mut mangled_type: Vec<u8> = Vec::new();
2596 if !self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) {
2597 write!(w, "C{}_", ident).unwrap();
2598 write!(mangled_type, "C{}_", ident).unwrap();
2599 } else { assert_eq!(args.len(), 1); }
2600 for arg in args.iter() {
2601 macro_rules! write_path {
2602 ($p_arg: expr, $extra_write: expr) => {
2603 if let Some(subtype) = self.maybe_resolve_path(&$p_arg.path, generics) {
2604 if self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) {
2606 if self.c_type_has_inner_from_path(&subtype) {
2607 if !self.write_c_path_intern(w, &$p_arg.path, generics, is_ref, is_mut, ptr_for_ref, false, true) { return false; }
2609 if let Some(arr_ty) = self.is_real_type_array(&subtype) {
2610 if !self.write_c_type_intern(w, &arr_ty, generics, false, true, false, false, true) { return false; }
2612 // Option<T> needs to be converted to a *mut T, ie mut ptr-for-ref
2613 if !self.write_c_path_intern(w, &$p_arg.path, generics, true, true, true, false, true) { return false; }
2617 write!(w, "{}", $p_arg.path.segments.last().unwrap().ident).unwrap();
2619 } else if self.is_known_container(&subtype, is_ref) || self.is_path_transparent_container(&$p_arg.path, generics, is_ref) {
2620 if !self.write_c_mangled_container_path_intern(w, Self::path_to_generic_args(&$p_arg.path), generics,
2621 &subtype, is_ref, is_mut, ptr_for_ref, true) {
2624 self.write_c_mangled_container_path_intern(&mut mangled_type, Self::path_to_generic_args(&$p_arg.path),
2625 generics, &subtype, is_ref, is_mut, ptr_for_ref, true);
2626 if let Some(w2) = $extra_write as Option<&mut Vec<u8>> {
2627 self.write_c_mangled_container_path_intern(w2, Self::path_to_generic_args(&$p_arg.path),
2628 generics, &subtype, is_ref, is_mut, ptr_for_ref, true);
2631 let id = subtype.rsplitn(2, ':').next().unwrap(); // Get the "Base" name of the resolved type
2632 write!(w, "{}", id).unwrap();
2633 write!(mangled_type, "{}", id).unwrap();
2634 if let Some(w2) = $extra_write as Option<&mut Vec<u8>> {
2635 write!(w2, "{}", id).unwrap();
2638 } else { return false; }
2641 match generics.resolve_type(arg) {
2642 syn::Type::Tuple(tuple) => {
2643 if tuple.elems.len() == 0 {
2644 write!(w, "None").unwrap();
2645 write!(mangled_type, "None").unwrap();
2647 let mut mangled_tuple_type: Vec<u8> = Vec::new();
2649 // Figure out what the mangled type should look like. To disambiguate
2650 // ((A, B), C) and (A, B, C) we prefix the generic args with a _ and suffix
2651 // them with a Z. Ideally we wouldn't use Z, but not many special chars are
2652 // available for use in type names.
2653 write!(w, "C{}Tuple_", tuple.elems.len()).unwrap();
2654 write!(mangled_type, "C{}Tuple_", tuple.elems.len()).unwrap();
2655 write!(mangled_tuple_type, "C{}Tuple_", tuple.elems.len()).unwrap();
2656 for elem in tuple.elems.iter() {
2657 if let syn::Type::Path(p) = elem {
2658 write_path!(p, Some(&mut mangled_tuple_type));
2659 } else if let syn::Type::Reference(refelem) = elem {
2660 if let syn::Type::Path(p) = &*refelem.elem {
2661 write_path!(p, Some(&mut mangled_tuple_type));
2662 } else { return false; }
2663 } else { return false; }
2665 write!(w, "Z").unwrap();
2666 write!(mangled_type, "Z").unwrap();
2667 write!(mangled_tuple_type, "Z").unwrap();
2668 if !self.check_create_container(String::from_utf8(mangled_tuple_type).unwrap(),
2669 &format!("{}Tuple", tuple.elems.len()), tuple.elems.iter().collect(), generics, is_ref) {
2674 syn::Type::Path(p_arg) => {
2675 write_path!(p_arg, None);
2677 syn::Type::Reference(refty) => {
2678 if let syn::Type::Path(p_arg) = &*refty.elem {
2679 write_path!(p_arg, None);
2680 } else if let syn::Type::Slice(_) = &*refty.elem {
2681 // write_c_type will actually do exactly what we want here, we just need to
2682 // make it a pointer so that its an option. Note that we cannot always convert
2683 // the Vec-as-slice (ie non-ref types) containers, so sometimes need to be able
2684 // to edit it, hence we use *mut here instead of *const.
2685 if args.len() != 1 { return false; }
2686 write!(w, "*mut ").unwrap();
2687 self.write_c_type(w, arg, None, true);
2688 } else { return false; }
2690 syn::Type::Array(a) => {
2691 if let syn::Type::Path(p_arg) = &*a.elem {
2692 let resolved = self.resolve_path(&p_arg.path, generics);
2693 if !self.is_primitive(&resolved) { return false; }
2694 if let syn::Expr::Lit(syn::ExprLit { lit: syn::Lit::Int(len), .. }) = &a.len {
2695 if self.c_type_from_path(&format!("[{}; {}]", resolved, len.base10_digits()), is_ref, ptr_for_ref).is_none() { return false; }
2696 if in_type || args.len() != 1 {
2697 write!(w, "_{}{}", resolved, len.base10_digits()).unwrap();
2698 write!(mangled_type, "_{}{}", resolved, len.base10_digits()).unwrap();
2700 let arrty = format!("[{}; {}]", resolved, len.base10_digits());
2701 let realty = self.c_type_from_path(&arrty, is_ref, ptr_for_ref).unwrap_or(&arrty);
2702 write!(w, "{}", realty).unwrap();
2703 write!(mangled_type, "{}", realty).unwrap();
2705 } else { return false; }
2706 } else { return false; }
2708 _ => { return false; },
2711 if self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) { return true; }
2712 // Push the "end of type" Z
2713 write!(w, "Z").unwrap();
2714 write!(mangled_type, "Z").unwrap();
2716 // Make sure the type is actually defined:
2717 self.check_create_container(String::from_utf8(mangled_type).unwrap(), ident, args, generics, is_ref)
2719 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 {
2720 if !self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) {
2721 write!(w, "{}::", Self::generated_container_path()).unwrap();
2723 self.write_c_mangled_container_path_intern(w, args, generics, ident, is_ref, is_mut, ptr_for_ref, false)
2725 pub fn get_c_mangled_container_type(&self, args: Vec<&syn::Type>, generics: Option<&GenericTypes>, template_name: &str) -> Option<String> {
2726 let mut out = Vec::new();
2727 if !self.write_c_mangled_container_path(&mut out, args, generics, template_name, false, false, false) {
2730 Some(String::from_utf8(out).unwrap())
2733 // **********************************
2734 // *** C Type Equivalent Printing ***
2735 // **********************************
2737 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 {
2738 let full_path = match self.maybe_resolve_path(&path, generics) {
2739 Some(path) => path, None => return false };
2740 if let Some(c_type) = self.c_type_from_path(&full_path, is_ref, ptr_for_ref) {
2741 write!(w, "{}", c_type).unwrap();
2743 } else if self.crate_types.traits.get(&full_path).is_some() {
2744 // Note that we always use the crate:: prefix here as we are always referring to a
2745 // concrete object which is of the generated type, it just implements the upstream
2747 if is_ref && ptr_for_ref {
2748 write!(w, "*{} crate::{}", if is_mut { "mut" } else { "const" }, full_path).unwrap();
2750 if with_ref_lifetime { unimplemented!(); }
2751 write!(w, "&{}crate::{}", if is_mut { "mut " } else { "" }, full_path).unwrap();
2753 write!(w, "crate::{}", full_path).unwrap();
2756 } else if self.crate_types.opaques.get(&full_path).is_some() || self.crate_types.mirrored_enums.get(&full_path).is_some() {
2757 let crate_pfx = if c_ty { "crate::" } else { "" };
2758 if is_ref && ptr_for_ref {
2759 // ptr_for_ref implies we're returning the object, which we can't really do for
2760 // opaque or mirrored types without box'ing them, which is quite a waste, so return
2761 // the actual object itself (for opaque types we'll set the pointer to the actual
2762 // type and note that its a reference).
2763 write!(w, "{}{}", crate_pfx, full_path).unwrap();
2764 } else if is_ref && with_ref_lifetime {
2766 // If we're concretizing something with a lifetime parameter, we have to pick a
2767 // lifetime, of which the only real available choice is `static`, obviously.
2768 write!(w, "&'static {}", crate_pfx).unwrap();
2770 self.write_rust_path(w, generics, path, with_ref_lifetime, false);
2772 // We shouldn't be mapping references in types, so panic here
2776 write!(w, "&{}{}{}", if is_mut { "mut " } else { "" }, crate_pfx, full_path).unwrap();
2778 write!(w, "{}{}", crate_pfx, full_path).unwrap();
2785 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 {
2786 match generics.resolve_type(t) {
2787 syn::Type::Path(p) => {
2788 if p.qself.is_some() {
2791 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
2792 if self.is_known_container(&full_path, is_ref) || self.is_path_transparent_container(&p.path, generics, is_ref) {
2793 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);
2795 if let Some(aliased_type) = self.crate_types.type_aliases.get(&full_path).cloned() {
2796 return self.write_c_type_intern(w, &aliased_type, None, is_ref, is_mut, ptr_for_ref, with_ref_lifetime, c_ty);
2799 self.write_c_path_intern(w, &p.path, generics, is_ref, is_mut, ptr_for_ref, with_ref_lifetime, c_ty)
2801 syn::Type::Reference(r) => {
2802 self.write_c_type_intern(w, &*r.elem, generics, true, r.mutability.is_some(), ptr_for_ref, with_ref_lifetime, c_ty)
2804 syn::Type::Array(a) => {
2805 if is_ref && is_mut {
2806 write!(w, "*mut [").unwrap();
2807 if !self.write_c_type_intern(w, &a.elem, generics, false, false, ptr_for_ref, with_ref_lifetime, c_ty) { return false; }
2809 write!(w, "*const [").unwrap();
2810 if !self.write_c_type_intern(w, &a.elem, generics, false, false, ptr_for_ref, with_ref_lifetime, c_ty) { return false; }
2812 let mut typecheck = Vec::new();
2813 if !self.write_c_type_intern(&mut typecheck, &a.elem, generics, false, false, ptr_for_ref, with_ref_lifetime, c_ty) { return false; }
2814 if typecheck[..] != ['u' as u8, '8' as u8] { return false; }
2816 if let syn::Expr::Lit(l) = &a.len {
2817 if let syn::Lit::Int(i) = &l.lit {
2819 if let Some(ty) = self.c_type_from_path(&format!("[u8; {}]", i.base10_digits()), false, ptr_for_ref) {
2820 write!(w, "{}", ty).unwrap();
2824 write!(w, "; {}]", i).unwrap();
2830 syn::Type::Slice(s) => {
2831 if !is_ref || is_mut { return false; }
2832 if let syn::Type::Path(p) = &*s.elem {
2833 let resolved = self.resolve_path(&p.path, generics);
2834 if self.is_primitive(&resolved) {
2835 write!(w, "{}::{}slice", Self::container_templ_path(), resolved).unwrap();
2838 let mut inner_c_ty = Vec::new();
2839 assert!(self.write_c_path_intern(&mut inner_c_ty, &p.path, generics, true, false, ptr_for_ref, with_ref_lifetime, c_ty));
2840 if self.is_clonable(&String::from_utf8(inner_c_ty).unwrap()) {
2841 if let Some(id) = p.path.get_ident() {
2842 let mangled_container = format!("CVec_{}Z", id);
2843 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
2844 self.check_create_container(mangled_container, "Vec", vec![&*s.elem], generics, false)
2848 } else if let syn::Type::Reference(r) = &*s.elem {
2849 if let syn::Type::Path(p) = &*r.elem {
2850 // Slices with "real types" inside are mapped as the equivalent non-ref Vec
2851 let resolved = self.resolve_path(&p.path, generics);
2852 let mangled_container = if let Some((ident, _)) = self.crate_types.opaques.get(&resolved) {
2853 format!("CVec_{}Z", ident)
2854 } else if let Some(en) = self.crate_types.mirrored_enums.get(&resolved) {
2855 format!("CVec_{}Z", en.ident)
2856 } else if let Some(id) = p.path.get_ident() {
2857 format!("CVec_{}Z", id)
2858 } else { return false; };
2859 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
2860 self.check_create_container(mangled_container, "Vec", vec![&*r.elem], generics, false)
2861 } else if let syn::Type::Slice(sl2) = &*r.elem {
2862 if let syn::Type::Reference(r2) = &*sl2.elem {
2863 if let syn::Type::Path(p) = &*r2.elem {
2864 // Slices with slices with opaque types (with is_owned flags) are mapped as non-ref Vecs
2865 let resolved = self.resolve_path(&p.path, generics);
2866 let mangled_container = if let Some((ident, _)) = self.crate_types.opaques.get(&resolved) {
2867 format!("CVec_CVec_{}ZZ", ident)
2868 } else { return false; };
2869 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
2870 let inner = &r2.elem;
2871 let vec_ty: syn::Type = syn::parse_quote!(Vec<#inner>);
2872 self.check_create_container(mangled_container, "Vec", vec![&vec_ty], generics, false)
2876 } else if let syn::Type::Tuple(_) = &*s.elem {
2877 let mut args = syn::punctuated::Punctuated::<_, syn::token::Comma>::new();
2878 args.push(syn::GenericArgument::Type((*s.elem).clone()));
2879 let mut segments = syn::punctuated::Punctuated::new();
2880 segments.push(parse_quote!(Vec<#args>));
2881 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)
2884 syn::Type::Tuple(t) => {
2885 if t.elems.len() == 0 {
2888 self.write_c_mangled_container_path(w, t.elems.iter().collect(), generics,
2889 &format!("{}Tuple", t.elems.len()), is_ref, is_mut, ptr_for_ref)
2895 pub fn write_c_type<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, ptr_for_ref: bool) {
2896 assert!(self.write_c_type_intern(w, t, generics, false, false, ptr_for_ref, false, true));
2898 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) {
2899 assert!(self.write_c_type_intern(w, t, generics, false, false, ptr_for_ref, true, false));
2901 pub fn understood_c_path(&self, p: &syn::Path) -> bool {
2902 self.write_c_path_intern(&mut std::io::sink(), p, None, false, false, false, false, true)
2904 pub fn understood_c_type(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> bool {
2905 self.write_c_type_intern(&mut std::io::sink(), t, generics, false, false, false, false, true)