1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE>
5 // or the MIT license <LICENSE-MIT>, at your option.
6 // You may not use this file except in accordance with one or both of these
9 use std::cell::RefCell;
10 use std::collections::{HashMap, HashSet};
17 use proc_macro2::{TokenTree, Span};
18 use quote::format_ident;
21 // The following utils are used purely to build our known types maps - they break down all the
22 // types we need to resolve to include the given object, and no more.
24 pub fn first_seg_self<'a>(t: &'a syn::Type) -> Option<impl Iterator<Item=&syn::PathSegment> + 'a> {
26 syn::Type::Path(p) => {
27 if p.qself.is_some() || p.path.leading_colon.is_some() {
30 let mut segs = p.path.segments.iter();
31 let ty = segs.next().unwrap();
32 if !ty.arguments.is_empty() { return None; }
33 if format!("{}", ty.ident) == "Self" {
41 pub fn get_single_remaining_path_seg<'a, I: Iterator<Item=&'a syn::PathSegment>>(segs: &mut I) -> Option<&'a syn::Ident> {
42 if let Some(ty) = segs.next() {
43 if !ty.arguments.is_empty() { unimplemented!(); }
44 if segs.next().is_some() { return None; }
49 pub fn first_seg_is_stdlib(first_seg_str: &str) -> bool {
50 first_seg_str == "std" || first_seg_str == "core" || first_seg_str == "alloc"
53 pub fn single_ident_generic_path_to_ident(p: &syn::Path) -> Option<&syn::Ident> {
54 if p.segments.len() == 1 {
55 Some(&p.segments.iter().next().unwrap().ident)
59 pub fn path_matches_nongeneric(p: &syn::Path, exp: &[&str]) -> bool {
60 if p.segments.len() != exp.len() { return false; }
61 for (seg, e) in p.segments.iter().zip(exp.iter()) {
62 if seg.arguments != syn::PathArguments::None { return false; }
63 if &format!("{}", seg.ident) != *e { return false; }
68 pub fn string_path_to_syn_path(path: &str) -> syn::Path {
69 let mut segments = syn::punctuated::Punctuated::new();
70 for seg in path.split("::") {
71 segments.push(syn::PathSegment {
72 ident: syn::Ident::new(seg, Span::call_site()),
73 arguments: syn::PathArguments::None,
76 syn::Path { leading_colon: Some(syn::Token![::](Span::call_site())), segments }
79 #[derive(Debug, PartialEq)]
80 pub enum ExportStatus {
84 /// This is used only for traits to indicate that users should not be able to implement their
85 /// own version of a trait, but we should export Rust implementations of the trait (and the
87 /// Concretly, this means that we do not implement the Rust trait for the C trait struct.
90 /// Gets the ExportStatus of an object (struct, fn, etc) given its attributes.
91 pub fn export_status(attrs: &[syn::Attribute]) -> ExportStatus {
92 for attr in attrs.iter() {
93 let tokens_clone = attr.tokens.clone();
94 let mut token_iter = tokens_clone.into_iter();
95 if let Some(token) = token_iter.next() {
97 TokenTree::Punct(c) if c.as_char() == '=' => {
98 // Really not sure where syn gets '=' from here -
99 // it somehow represents '///' or '//!'
101 TokenTree::Group(g) => {
102 if format!("{}", single_ident_generic_path_to_ident(&attr.path).unwrap()) == "cfg" {
103 let mut iter = g.stream().into_iter();
104 if let TokenTree::Ident(i) = iter.next().unwrap() {
106 // #[cfg(any(test, feature = ""))]
107 if let TokenTree::Group(g) = iter.next().unwrap() {
108 let mut all_test = true;
109 for token in g.stream().into_iter() {
110 if let TokenTree::Ident(i) = token {
111 match format!("{}", i).as_str() {
114 _ => all_test = false,
116 } else if let TokenTree::Literal(lit) = token {
117 if format!("{}", lit) != "fuzztarget" {
122 if all_test { return ExportStatus::TestOnly; }
124 } else if i == "test" {
125 return ExportStatus::TestOnly;
129 continue; // eg #[derive()]
131 _ => unimplemented!(),
134 match token_iter.next().unwrap() {
135 TokenTree::Literal(lit) => {
136 let line = format!("{}", lit);
137 if line.contains("(C-not exported)") {
138 return ExportStatus::NoExport;
139 } else if line.contains("(C-not implementable)") {
140 return ExportStatus::NotImplementable;
143 _ => unimplemented!(),
149 pub fn assert_simple_bound(bound: &syn::TraitBound) {
150 if bound.paren_token.is_some() || bound.lifetimes.is_some() { unimplemented!(); }
151 if let syn::TraitBoundModifier::Maybe(_) = bound.modifier { unimplemented!(); }
154 /// Returns true if the enum will be mapped as an opaue (ie struct with a pointer to the underlying
155 /// type), otherwise it is mapped into a transparent, C-compatible version of itself.
156 pub fn is_enum_opaque(e: &syn::ItemEnum) -> bool {
157 for var in e.variants.iter() {
158 if let syn::Fields::Named(fields) = &var.fields {
159 for field in fields.named.iter() {
160 match export_status(&field.attrs) {
161 ExportStatus::Export|ExportStatus::TestOnly => {},
162 ExportStatus::NotImplementable => panic!("(C-not implementable) should only appear on traits!"),
163 ExportStatus::NoExport => return true,
166 } else if let syn::Fields::Unnamed(fields) = &var.fields {
167 for field in fields.unnamed.iter() {
168 match export_status(&field.attrs) {
169 ExportStatus::Export|ExportStatus::TestOnly => {},
170 ExportStatus::NotImplementable => panic!("(C-not implementable) should only appear on traits!"),
171 ExportStatus::NoExport => return true,
179 /// A stack of sets of generic resolutions.
181 /// This tracks the template parameters for a function, struct, or trait, allowing resolution into
182 /// a concrete type. By pushing a new context onto the stack, this can track a function's template
183 /// parameters inside of a generic struct or trait.
185 /// It maps both direct types as well as Deref<Target = X>, mapping them via the provided
186 /// TypeResolver's resolve_path function (ie traits map to the concrete jump table, structs to the
187 /// concrete C container struct, etc).
189 pub struct GenericTypes<'a, 'b> {
190 self_ty: Option<String>,
191 parent: Option<&'b GenericTypes<'b, 'b>>,
192 typed_generics: HashMap<&'a syn::Ident, String>,
193 default_generics: HashMap<&'a syn::Ident, (syn::Type, syn::Type)>,
195 impl<'a, 'p: 'a> GenericTypes<'a, 'p> {
196 pub fn new(self_ty: Option<String>) -> Self {
197 Self { self_ty, parent: None, typed_generics: HashMap::new(), default_generics: HashMap::new(), }
200 /// push a new context onto the stack, allowing for a new set of generics to be learned which
201 /// will override any lower contexts, but which will still fall back to resoltion via lower
203 pub fn push_ctx<'c>(&'c self) -> GenericTypes<'a, 'c> {
204 GenericTypes { self_ty: None, parent: Some(self), typed_generics: HashMap::new(), default_generics: HashMap::new(), }
207 /// Learn the generics in generics in the current context, given a TypeResolver.
208 pub fn learn_generics<'b, 'c>(&mut self, generics: &'a syn::Generics, types: &'b TypeResolver<'a, 'c>) -> bool {
209 let mut new_typed_generics = HashMap::new();
210 // First learn simple generics...
211 for generic in generics.params.iter() {
213 syn::GenericParam::Type(type_param) => {
214 let mut non_lifetimes_processed = false;
215 'bound_loop: for bound in type_param.bounds.iter() {
216 if let syn::TypeParamBound::Trait(trait_bound) = bound {
217 if let Some(ident) = single_ident_generic_path_to_ident(&trait_bound.path) {
218 match &format!("{}", ident) as &str { "Send" => continue, "Sync" => continue, _ => {} }
220 if path_matches_nongeneric(&trait_bound.path, &["core", "clone", "Clone"]) { continue; }
222 assert_simple_bound(&trait_bound);
223 if let Some(path) = types.maybe_resolve_path(&trait_bound.path, None) {
224 if types.skip_path(&path) { continue; }
225 if path == "Sized" { continue; }
226 if non_lifetimes_processed { return false; }
227 non_lifetimes_processed = true;
228 if path != "std::ops::Deref" && path != "core::ops::Deref" {
229 new_typed_generics.insert(&type_param.ident, Some(path));
230 } else if trait_bound.path.segments.len() == 1 {
231 // If we're templated on Deref<Target = ConcreteThing>, store
232 // the reference type in `default_generics` which handles full
233 // types and not just paths.
234 if let syn::PathArguments::AngleBracketed(ref args) =
235 trait_bound.path.segments[0].arguments {
236 for subargument in args.args.iter() {
238 syn::GenericArgument::Lifetime(_) => {},
239 syn::GenericArgument::Binding(ref b) => {
240 if &format!("{}", b.ident) != "Target" { return false; }
242 self.default_generics.insert(&type_param.ident, (parse_quote!(&#default), parse_quote!(&#default)));
245 _ => unimplemented!(),
249 new_typed_generics.insert(&type_param.ident, None);
255 if let Some(default) = type_param.default.as_ref() {
256 assert!(type_param.bounds.is_empty());
257 self.default_generics.insert(&type_param.ident, (default.clone(), parse_quote!(&#default)));
263 // Then find generics where we are required to pass a Deref<Target=X> and pretend its just X.
264 if let Some(wh) = &generics.where_clause {
265 for pred in wh.predicates.iter() {
266 if let syn::WherePredicate::Type(t) = pred {
267 if let syn::Type::Path(p) = &t.bounded_ty {
268 if p.qself.is_some() { return false; }
269 if p.path.leading_colon.is_some() { return false; }
270 let mut p_iter = p.path.segments.iter();
271 if let Some(gen) = new_typed_generics.get_mut(&p_iter.next().unwrap().ident) {
272 if gen.is_some() { return false; }
273 if &format!("{}", p_iter.next().unwrap().ident) != "Target" {return false; }
275 let mut non_lifetimes_processed = false;
276 for bound in t.bounds.iter() {
277 if let syn::TypeParamBound::Trait(trait_bound) = bound {
278 if let Some(id) = trait_bound.path.get_ident() {
279 if format!("{}", id) == "Sized" { continue; }
281 if non_lifetimes_processed { return false; }
282 non_lifetimes_processed = true;
283 assert_simple_bound(&trait_bound);
284 *gen = Some(types.resolve_path(&trait_bound.path, None));
287 } else { return false; }
288 } else { return false; }
292 for (key, value) in new_typed_generics.drain() {
293 if let Some(v) = value {
294 assert!(self.typed_generics.insert(key, v).is_none());
295 } else { return false; }
300 /// Learn the associated types from the trait in the current context.
301 pub fn learn_associated_types<'b, 'c>(&mut self, t: &'a syn::ItemTrait, types: &'b TypeResolver<'a, 'c>) {
302 for item in t.items.iter() {
304 &syn::TraitItem::Type(ref t) => {
305 if t.default.is_some() || t.generics.lt_token.is_some() { unimplemented!(); }
306 let mut bounds_iter = t.bounds.iter();
308 match bounds_iter.next().unwrap() {
309 syn::TypeParamBound::Trait(tr) => {
310 assert_simple_bound(&tr);
311 if let Some(path) = types.maybe_resolve_path(&tr.path, None) {
312 if types.skip_path(&path) { continue; }
313 // In general we handle Deref<Target=X> as if it were just X (and
314 // implement Deref<Target=Self> for relevant types). We don't
315 // bother to implement it for associated types, however, so we just
316 // ignore such bounds.
317 if path != "std::ops::Deref" && path != "core::ops::Deref" {
318 self.typed_generics.insert(&t.ident, path);
320 } else { unimplemented!(); }
321 for bound in bounds_iter {
322 if let syn::TypeParamBound::Trait(_) = bound { unimplemented!(); }
326 syn::TypeParamBound::Lifetime(_) => {},
335 /// Attempt to resolve a Path as a generic parameter and return the full path. as both a string
337 pub fn maybe_resolve_path<'b>(&'b self, path: &syn::Path) -> Option<&'b String> {
338 if let Some(ident) = path.get_ident() {
339 if let Some(ty) = &self.self_ty {
340 if format!("{}", ident) == "Self" {
344 if let Some(res) = self.typed_generics.get(ident) {
348 // Associated types are usually specified as "Self::Generic", so we check for that
350 let mut it = path.segments.iter();
351 if path.segments.len() == 2 && format!("{}", it.next().unwrap().ident) == "Self" {
352 let ident = &it.next().unwrap().ident;
353 if let Some(res) = self.typed_generics.get(ident) {
358 if let Some(parent) = self.parent {
359 parent.maybe_resolve_path(path)
366 pub trait ResolveType<'a> { fn resolve_type(&'a self, ty: &'a syn::Type) -> &'a syn::Type; }
367 impl<'a, 'b, 'c: 'a + 'b> ResolveType<'c> for Option<&GenericTypes<'a, 'b>> {
368 fn resolve_type(&'c self, ty: &'c syn::Type) -> &'c syn::Type {
369 if let Some(us) = self {
371 syn::Type::Path(p) => {
372 if let Some(ident) = p.path.get_ident() {
373 if let Some((ty, _)) = us.default_generics.get(ident) {
378 syn::Type::Reference(syn::TypeReference { elem, .. }) => {
379 if let syn::Type::Path(p) = &**elem {
380 if let Some(ident) = p.path.get_ident() {
381 if let Some((_, refty)) = us.default_generics.get(ident) {
389 us.parent.resolve_type(ty)
394 #[derive(Clone, PartialEq)]
395 // The type of declaration and the object itself
396 pub enum DeclType<'a> {
398 Trait(&'a syn::ItemTrait),
399 StructImported { generics: &'a syn::Generics },
401 EnumIgnored { generics: &'a syn::Generics },
404 pub struct ImportResolver<'mod_lifetime, 'crate_lft: 'mod_lifetime> {
405 pub crate_name: &'mod_lifetime str,
406 dependencies: &'mod_lifetime HashSet<syn::Ident>,
407 module_path: &'mod_lifetime str,
408 imports: HashMap<syn::Ident, (String, syn::Path)>,
409 declared: HashMap<syn::Ident, DeclType<'crate_lft>>,
410 priv_modules: HashSet<syn::Ident>,
412 impl<'mod_lifetime, 'crate_lft: 'mod_lifetime> ImportResolver<'mod_lifetime, 'crate_lft> {
413 fn process_use_intern(crate_name: &str, module_path: &str, dependencies: &HashSet<syn::Ident>, imports: &mut HashMap<syn::Ident, (String, syn::Path)>,
414 u: &syn::UseTree, partial_path: &str, mut path: syn::punctuated::Punctuated<syn::PathSegment, syn::token::Colon2>) {
417 macro_rules! push_path {
418 ($ident: expr, $path_suffix: expr) => {
419 if partial_path == "" && format!("{}", $ident) == "super" {
420 let mut mod_iter = module_path.rsplitn(2, "::");
421 mod_iter.next().unwrap();
422 let super_mod = mod_iter.next().unwrap();
423 new_path = format!("{}{}", super_mod, $path_suffix);
424 assert_eq!(path.len(), 0);
425 for module in super_mod.split("::") {
426 path.push(syn::PathSegment { ident: syn::Ident::new(module, Span::call_site()), arguments: syn::PathArguments::None });
428 } else if partial_path == "" && format!("{}", $ident) == "self" {
429 new_path = format!("{}{}", module_path, $path_suffix);
430 for module in module_path.split("::") {
431 path.push(syn::PathSegment { ident: syn::Ident::new(module, Span::call_site()), arguments: syn::PathArguments::None });
433 } else if partial_path == "" && format!("{}", $ident) == "crate" {
434 new_path = format!("{}{}", crate_name, $path_suffix);
435 let crate_name_ident = format_ident!("{}", crate_name);
436 path.push(parse_quote!(#crate_name_ident));
437 } else if partial_path == "" && !dependencies.contains(&$ident) {
438 new_path = format!("{}::{}{}", crate_name, $ident, $path_suffix);
439 let crate_name_ident = format_ident!("{}", crate_name);
440 path.push(parse_quote!(#crate_name_ident));
441 } else if format!("{}", $ident) == "self" {
442 let mut path_iter = partial_path.rsplitn(2, "::");
443 path_iter.next().unwrap();
444 new_path = path_iter.next().unwrap().to_owned();
446 new_path = format!("{}{}{}", partial_path, $ident, $path_suffix);
449 path.push(parse_quote!(#ident));
453 syn::UseTree::Path(p) => {
454 push_path!(p.ident, "::");
455 Self::process_use_intern(crate_name, module_path, dependencies, imports, &p.tree, &new_path, path);
457 syn::UseTree::Name(n) => {
458 push_path!(n.ident, "");
459 let imported_ident = syn::Ident::new(new_path.rsplitn(2, "::").next().unwrap(), Span::call_site());
460 imports.insert(imported_ident, (new_path, syn::Path { leading_colon: Some(syn::Token![::](Span::call_site())), segments: path }));
462 syn::UseTree::Group(g) => {
463 for i in g.items.iter() {
464 Self::process_use_intern(crate_name, module_path, dependencies, imports, i, partial_path, path.clone());
467 syn::UseTree::Rename(r) => {
468 push_path!(r.ident, "");
469 imports.insert(r.rename.clone(), (new_path, syn::Path { leading_colon: Some(syn::Token![::](Span::call_site())), segments: path }));
471 syn::UseTree::Glob(_) => {
472 eprintln!("Ignoring * use for {} - this may result in resolution failures", partial_path);
477 fn process_use(crate_name: &str, module_path: &str, dependencies: &HashSet<syn::Ident>, imports: &mut HashMap<syn::Ident, (String, syn::Path)>, u: &syn::ItemUse) {
478 if let syn::Visibility::Public(_) = u.vis {
479 // We actually only use these for #[cfg(fuzztarget)]
480 eprintln!("Ignoring pub(use) tree!");
483 if u.leading_colon.is_some() { eprintln!("Ignoring leading-colon use!"); return; }
484 Self::process_use_intern(crate_name, module_path, dependencies, imports, &u.tree, "", syn::punctuated::Punctuated::new());
487 fn insert_primitive(imports: &mut HashMap<syn::Ident, (String, syn::Path)>, id: &str) {
488 let ident = format_ident!("{}", id);
489 let path = parse_quote!(#ident);
490 imports.insert(ident, (id.to_owned(), path));
493 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 {
494 Self::from_borrowed_items(crate_name, dependencies, module_path, &contents.iter().map(|a| a).collect::<Vec<_>>())
496 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 {
497 let mut imports = HashMap::new();
498 // Add primitives to the "imports" list:
499 Self::insert_primitive(&mut imports, "bool");
500 Self::insert_primitive(&mut imports, "u64");
501 Self::insert_primitive(&mut imports, "u32");
502 Self::insert_primitive(&mut imports, "u16");
503 Self::insert_primitive(&mut imports, "u8");
504 Self::insert_primitive(&mut imports, "usize");
505 Self::insert_primitive(&mut imports, "str");
506 Self::insert_primitive(&mut imports, "String");
508 // These are here to allow us to print native Rust types in trait fn impls even if we don't
510 Self::insert_primitive(&mut imports, "Result");
511 Self::insert_primitive(&mut imports, "Vec");
512 Self::insert_primitive(&mut imports, "Option");
514 let mut declared = HashMap::new();
515 let mut priv_modules = HashSet::new();
517 for item in contents.iter() {
519 syn::Item::Use(u) => Self::process_use(crate_name, module_path, dependencies, &mut imports, &u),
520 syn::Item::Struct(s) => {
521 if let syn::Visibility::Public(_) = s.vis {
522 match export_status(&s.attrs) {
523 ExportStatus::Export => { declared.insert(s.ident.clone(), DeclType::StructImported { generics: &s.generics }); },
524 ExportStatus::NoExport => { declared.insert(s.ident.clone(), DeclType::StructIgnored); },
525 ExportStatus::TestOnly => continue,
526 ExportStatus::NotImplementable => panic!("(C-not implementable) should only appear on traits!"),
530 syn::Item::Type(t) if export_status(&t.attrs) == ExportStatus::Export => {
531 if let syn::Visibility::Public(_) = t.vis {
532 declared.insert(t.ident.clone(), DeclType::StructImported { generics: &t.generics });
535 syn::Item::Enum(e) => {
536 if let syn::Visibility::Public(_) = e.vis {
537 match export_status(&e.attrs) {
538 ExportStatus::Export if is_enum_opaque(e) => { declared.insert(e.ident.clone(), DeclType::EnumIgnored { generics: &e.generics }); },
539 ExportStatus::Export => { declared.insert(e.ident.clone(), DeclType::MirroredEnum); },
540 ExportStatus::NotImplementable => panic!("(C-not implementable) should only appear on traits!"),
545 syn::Item::Trait(t) => {
546 match export_status(&t.attrs) {
547 ExportStatus::Export|ExportStatus::NotImplementable => {
548 if let syn::Visibility::Public(_) = t.vis {
549 declared.insert(t.ident.clone(), DeclType::Trait(t));
555 syn::Item::Mod(m) => {
556 priv_modules.insert(m.ident.clone());
562 Self { crate_name, dependencies, module_path, imports, declared, priv_modules }
565 pub fn maybe_resolve_declared(&self, id: &syn::Ident) -> Option<&DeclType<'crate_lft>> {
566 self.declared.get(id)
569 pub fn maybe_resolve_ident(&self, id: &syn::Ident) -> Option<String> {
570 if let Some((imp, _)) = self.imports.get(id) {
572 } else if self.declared.get(id).is_some() {
573 Some(self.module_path.to_string() + "::" + &format!("{}", id))
577 pub fn maybe_resolve_path(&self, p: &syn::Path, generics: Option<&GenericTypes>) -> Option<String> {
578 if let Some(gen_types) = generics {
579 if let Some(resp) = gen_types.maybe_resolve_path(p) {
580 return Some(resp.clone());
584 if p.leading_colon.is_some() {
585 let mut res: String = p.segments.iter().enumerate().map(|(idx, seg)| {
586 format!("{}{}", if idx == 0 { "" } else { "::" }, seg.ident)
588 let firstseg = p.segments.iter().next().unwrap();
589 if !self.dependencies.contains(&firstseg.ident) {
590 res = self.crate_name.to_owned() + "::" + &res;
593 } else if let Some(id) = p.get_ident() {
594 self.maybe_resolve_ident(id)
596 if p.segments.len() == 1 {
597 let seg = p.segments.iter().next().unwrap();
598 return self.maybe_resolve_ident(&seg.ident);
600 let mut seg_iter = p.segments.iter();
601 let first_seg = seg_iter.next().unwrap();
602 let remaining: String = seg_iter.map(|seg| {
603 format!("::{}", seg.ident)
605 let first_seg_str = format!("{}", first_seg.ident);
606 if let Some((imp, _)) = self.imports.get(&first_seg.ident) {
608 Some(imp.clone() + &remaining)
612 } else if let Some(_) = self.priv_modules.get(&first_seg.ident) {
613 Some(format!("{}::{}{}", self.module_path, first_seg.ident, remaining))
614 } else if first_seg_is_stdlib(&first_seg_str) || self.dependencies.contains(&first_seg.ident) {
615 Some(first_seg_str + &remaining)
620 /// Map all the Paths in a Type into absolute paths given a set of imports (generated via process_use_intern)
621 pub fn resolve_imported_refs(&self, mut ty: syn::Type) -> syn::Type {
623 syn::Type::Path(p) => {
624 if p.path.segments.len() != 1 { unimplemented!(); }
625 let mut args = p.path.segments[0].arguments.clone();
626 if let syn::PathArguments::AngleBracketed(ref mut generics) = &mut args {
627 for arg in generics.args.iter_mut() {
628 if let syn::GenericArgument::Type(ref mut t) = arg {
629 *t = self.resolve_imported_refs(t.clone());
633 if let Some((_, newpath)) = self.imports.get(single_ident_generic_path_to_ident(&p.path).unwrap()) {
634 p.path = newpath.clone();
636 p.path.segments[0].arguments = args;
638 syn::Type::Reference(r) => {
639 r.elem = Box::new(self.resolve_imported_refs((*r.elem).clone()));
641 syn::Type::Slice(s) => {
642 s.elem = Box::new(self.resolve_imported_refs((*s.elem).clone()));
644 syn::Type::Tuple(t) => {
645 for e in t.elems.iter_mut() {
646 *e = self.resolve_imported_refs(e.clone());
649 _ => unimplemented!(),
655 // templates_defined is walked to write the C++ header, so if we use the default hashing it get
656 // reordered on each genbindings run. Instead, we use SipHasher (which defaults to 0-keys) so that
657 // the sorting is stable across runs. It is deprecated, but the "replacement" doesn't actually
658 // accomplish the same goals, so we just ignore it.
660 pub type NonRandomHash = hash::BuildHasherDefault<hash::SipHasher>;
663 pub struct ASTModule {
664 pub attrs: Vec<syn::Attribute>,
665 pub items: Vec<syn::Item>,
666 pub submods: Vec<String>,
668 /// A struct containing the syn::File AST for each file in the crate.
669 pub struct FullLibraryAST {
670 pub modules: HashMap<String, ASTModule, NonRandomHash>,
671 pub dependencies: HashSet<syn::Ident>,
673 impl FullLibraryAST {
674 fn load_module(&mut self, module: String, attrs: Vec<syn::Attribute>, mut items: Vec<syn::Item>) {
675 let mut non_mod_items = Vec::with_capacity(items.len());
676 let mut submods = Vec::with_capacity(items.len());
677 for item in items.drain(..) {
679 syn::Item::Mod(m) if m.content.is_some() => {
680 if export_status(&m.attrs) == ExportStatus::Export {
681 if let syn::Visibility::Public(_) = m.vis {
682 let modident = format!("{}", m.ident);
683 let modname = if module != "" {
684 module.clone() + "::" + &modident
688 self.load_module(modname, m.attrs, m.content.unwrap().1);
689 submods.push(modident);
691 non_mod_items.push(syn::Item::Mod(m));
695 syn::Item::Mod(_) => panic!("--pretty=expanded output should never have non-body modules"),
696 syn::Item::ExternCrate(c) => {
697 if export_status(&c.attrs) == ExportStatus::Export {
698 self.dependencies.insert(c.ident);
701 _ => { non_mod_items.push(item); }
704 self.modules.insert(module, ASTModule { attrs, items: non_mod_items, submods });
707 pub fn load_lib(lib: syn::File) -> Self {
708 assert_eq!(export_status(&lib.attrs), ExportStatus::Export);
709 let mut res = Self { modules: HashMap::default(), dependencies: HashSet::new() };
710 res.load_module("".to_owned(), lib.attrs, lib.items);
715 /// List of manually-generated types which are clonable
716 fn initial_clonable_types() -> HashSet<String> {
717 let mut res = HashSet::new();
718 res.insert("crate::c_types::u5".to_owned());
719 res.insert("crate::c_types::FourBytes".to_owned());
720 res.insert("crate::c_types::TwelveBytes".to_owned());
721 res.insert("crate::c_types::SixteenBytes".to_owned());
722 res.insert("crate::c_types::TwentyBytes".to_owned());
723 res.insert("crate::c_types::ThirtyTwoBytes".to_owned());
724 res.insert("crate::c_types::SecretKey".to_owned());
725 res.insert("crate::c_types::PublicKey".to_owned());
726 res.insert("crate::c_types::Transaction".to_owned());
727 res.insert("crate::c_types::TxOut".to_owned());
728 res.insert("crate::c_types::Signature".to_owned());
729 res.insert("crate::c_types::RecoverableSignature".to_owned());
730 res.insert("crate::c_types::Bech32Error".to_owned());
731 res.insert("crate::c_types::Secp256k1Error".to_owned());
732 res.insert("crate::c_types::IOError".to_owned());
733 res.insert("crate::c_types::Error".to_owned());
734 res.insert("crate::c_types::Str".to_owned());
736 // Because some types are manually-mapped to CVec_u8Z we may end up checking if its clonable
737 // before we ever get to constructing the type fully via
738 // `write_c_mangled_container_path_intern` (which will add it here too), so we have to manually
739 // add it on startup.
740 res.insert("crate::c_types::derived::CVec_u8Z".to_owned());
744 /// Top-level struct tracking everything which has been defined while walking the crate.
745 pub struct CrateTypes<'a> {
746 /// This may contain structs or enums, but only when either is mapped as
747 /// struct X { inner: *mut originalX, .. }
748 pub opaques: HashMap<String, (&'a syn::Ident, &'a syn::Generics)>,
749 /// structs that weren't exposed
750 pub priv_structs: HashMap<String, &'a syn::Generics>,
751 /// Enums which are mapped as C enums with conversion functions
752 pub mirrored_enums: HashMap<String, &'a syn::ItemEnum>,
753 /// Traits which are mapped as a pointer + jump table
754 pub traits: HashMap<String, &'a syn::ItemTrait>,
755 /// Aliases from paths to some other Type
756 pub type_aliases: HashMap<String, syn::Type>,
757 /// Value is an alias to Key (maybe with some generics)
758 pub reverse_alias_map: HashMap<String, Vec<(String, syn::PathArguments)>>,
759 /// Template continer types defined, map from mangled type name -> whether a destructor fn
762 /// This is used at the end of processing to make C++ wrapper classes
763 pub templates_defined: RefCell<HashMap<String, bool, NonRandomHash>>,
764 /// The output file for any created template container types, written to as we find new
765 /// template containers which need to be defined.
766 template_file: RefCell<&'a mut File>,
767 /// Set of containers which are clonable
768 clonable_types: RefCell<HashSet<String>>,
770 pub trait_impls: HashMap<String, Vec<String>>,
771 /// The full set of modules in the crate(s)
772 pub lib_ast: &'a FullLibraryAST,
775 impl<'a> CrateTypes<'a> {
776 pub fn new(template_file: &'a mut File, libast: &'a FullLibraryAST) -> Self {
778 opaques: HashMap::new(), mirrored_enums: HashMap::new(), traits: HashMap::new(),
779 type_aliases: HashMap::new(), reverse_alias_map: HashMap::new(),
780 templates_defined: RefCell::new(HashMap::default()), priv_structs: HashMap::new(),
781 clonable_types: RefCell::new(initial_clonable_types()), trait_impls: HashMap::new(),
782 template_file: RefCell::new(template_file), lib_ast: &libast,
785 pub fn set_clonable(&self, object: String) {
786 self.clonable_types.borrow_mut().insert(object);
788 pub fn is_clonable(&self, object: &str) -> bool {
789 self.clonable_types.borrow().contains(object)
791 pub fn write_new_template(&self, mangled_container: String, has_destructor: bool, created_container: &[u8]) {
792 self.template_file.borrow_mut().write(created_container).unwrap();
793 self.templates_defined.borrow_mut().insert(mangled_container, has_destructor);
797 /// A struct which tracks resolving rust types into C-mapped equivalents, exists for one specific
798 /// module but contains a reference to the overall CrateTypes tracking.
799 pub struct TypeResolver<'mod_lifetime, 'crate_lft: 'mod_lifetime> {
800 pub module_path: &'mod_lifetime str,
801 pub crate_types: &'mod_lifetime CrateTypes<'crate_lft>,
802 pub types: ImportResolver<'mod_lifetime, 'crate_lft>,
805 /// Returned by write_empty_rust_val_check_suffix to indicate what type of dereferencing needs to
806 /// happen to get the inner value of a generic.
807 enum EmptyValExpectedTy {
808 /// A type which has a flag for being empty (eg an array where we treat all-0s as empty).
810 /// A Option mapped as a COption_*Z
812 /// A pointer which we want to convert to a reference.
817 /// Describes the appropriate place to print a general type-conversion string when converting a
819 enum ContainerPrefixLocation {
820 /// Prints a general type-conversion string prefix and suffix outside of the
821 /// container-conversion strings.
823 /// Prints a general type-conversion string prefix and suffix inside of the
824 /// container-conversion strings.
826 /// Does not print the usual type-conversion string prefix and suffix.
830 impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
831 pub fn new(module_path: &'a str, types: ImportResolver<'a, 'c>, crate_types: &'a CrateTypes<'c>) -> Self {
832 Self { module_path, types, crate_types }
835 // *************************************************
836 // *** Well know type and conversion definitions ***
837 // *************************************************
839 /// Returns true we if can just skip passing this to C entirely
840 pub fn skip_path(&self, full_path: &str) -> bool {
841 full_path == "bitcoin::secp256k1::Secp256k1" ||
842 full_path == "bitcoin::secp256k1::Signing" ||
843 full_path == "bitcoin::secp256k1::Verification"
845 /// Returns true we if can just skip passing this to C entirely
846 fn no_arg_path_to_rust(&self, full_path: &str) -> &str {
847 if full_path == "bitcoin::secp256k1::Secp256k1" {
848 "secp256k1::global::SECP256K1"
849 } else { unimplemented!(); }
852 /// Returns true if the object is a primitive and is mapped as-is with no conversion
854 pub fn is_primitive(&self, full_path: &str) -> bool {
865 pub fn is_clonable(&self, ty: &str) -> bool {
866 if self.crate_types.is_clonable(ty) { return true; }
867 if self.is_primitive(ty) { return true; }
873 /// Gets the C-mapped type for types which are outside of the crate, or which are manually
874 /// ignored by for some reason need mapping anyway.
875 fn c_type_from_path<'b>(&self, full_path: &'b str, is_ref: bool, _ptr_for_ref: bool) -> Option<&'b str> {
876 if self.is_primitive(full_path) {
877 return Some(full_path);
880 // Note that no !is_ref types can map to an array because Rust and C's call semantics
881 // for arrays are different (https://github.com/eqrion/cbindgen/issues/528)
883 "[u8; 32]" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
884 "[u8; 20]" if !is_ref => Some("crate::c_types::TwentyBytes"),
885 "[u8; 16]" if !is_ref => Some("crate::c_types::SixteenBytes"),
886 "[u8; 12]" if !is_ref => Some("crate::c_types::TwelveBytes"),
887 "[u8; 4]" if !is_ref => Some("crate::c_types::FourBytes"),
888 "[u8; 3]" if !is_ref => Some("crate::c_types::ThreeBytes"), // Used for RGB values
890 "str" if is_ref => Some("crate::c_types::Str"),
891 "alloc::string::String"|"String" => Some("crate::c_types::Str"),
893 "std::time::Duration"|"core::time::Duration" => Some("u64"),
894 "std::time::SystemTime" => Some("u64"),
895 "std::io::Error"|"lightning::io::Error" => Some("crate::c_types::IOError"),
896 "core::fmt::Arguments" if is_ref => Some("crate::c_types::Str"),
898 "core::convert::Infallible" => Some("crate::c_types::NotConstructable"),
900 "bitcoin::bech32::Error"|"bech32::Error"
901 if !is_ref => Some("crate::c_types::Bech32Error"),
902 "bitcoin::secp256k1::Error"|"secp256k1::Error"
903 if !is_ref => Some("crate::c_types::Secp256k1Error"),
905 "core::num::ParseIntError" => Some("crate::c_types::Error"),
906 "core::str::Utf8Error" => Some("crate::c_types::Error"),
908 "bitcoin::bech32::u5"|"bech32::u5" => Some("crate::c_types::u5"),
909 "core::num::NonZeroU8" => Some("u8"),
911 "secp256k1::PublicKey"|"bitcoin::secp256k1::PublicKey" => Some("crate::c_types::PublicKey"),
912 "bitcoin::secp256k1::ecdsa::Signature" => Some("crate::c_types::Signature"),
913 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some("crate::c_types::RecoverableSignature"),
914 "bitcoin::secp256k1::SecretKey" if is_ref => Some("*const [u8; 32]"),
915 "bitcoin::secp256k1::SecretKey" if !is_ref => Some("crate::c_types::SecretKey"),
916 "bitcoin::blockdata::script::Script" if is_ref => Some("crate::c_types::u8slice"),
917 "bitcoin::blockdata::script::Script" if !is_ref => Some("crate::c_types::derived::CVec_u8Z"),
918 "bitcoin::blockdata::transaction::OutPoint" => Some("crate::lightning::chain::transaction::OutPoint"),
919 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some("crate::c_types::Transaction"),
920 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some("crate::c_types::TxOut"),
921 "bitcoin::network::constants::Network" => Some("crate::bitcoin::network::Network"),
922 "bitcoin::util::address::WitnessVersion" => Some("crate::c_types::WitnessVersion"),
923 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some("*const [u8; 80]"),
924 "bitcoin::blockdata::block::Block" if is_ref => Some("crate::c_types::u8slice"),
926 "bitcoin::hash_types::PubkeyHash"|"bitcoin::hash_types::WPubkeyHash"|"bitcoin::hash_types::ScriptHash"
927 if is_ref => Some("*const [u8; 20]"),
928 "bitcoin::hash_types::WScriptHash"
929 if is_ref => Some("*const [u8; 32]"),
931 // Newtypes that we just expose in their original form.
932 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
933 if is_ref => Some("*const [u8; 32]"),
934 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
935 if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
936 "bitcoin::secp256k1::Message" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
937 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
938 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
939 if is_ref => Some("*const [u8; 32]"),
940 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
941 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
942 if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
944 "lightning::io::Read" => Some("crate::c_types::u8slice"),
950 fn from_c_conversion_new_var_from_path<'b>(&self, _full_path: &str, _is_ref: bool) -> Option<(&'b str, &'b str)> {
953 fn from_c_conversion_prefix_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<String> {
954 if self.is_primitive(full_path) {
955 return Some("".to_owned());
958 "Vec" if !is_ref => Some("local_"),
959 "Result" if !is_ref => Some("local_"),
960 "Option" if is_ref => Some("&local_"),
961 "Option" => Some("local_"),
963 "[u8; 32]" if is_ref => Some("unsafe { &*"),
964 "[u8; 32]" if !is_ref => Some(""),
965 "[u8; 20]" if !is_ref => Some(""),
966 "[u8; 16]" if !is_ref => Some(""),
967 "[u8; 12]" if !is_ref => Some(""),
968 "[u8; 4]" if !is_ref => Some(""),
969 "[u8; 3]" if !is_ref => Some(""),
971 "[u8]" if is_ref => Some(""),
972 "[usize]" if is_ref => Some(""),
974 "str" if is_ref => Some(""),
975 "alloc::string::String"|"String" => Some(""),
976 "std::io::Error"|"lightning::io::Error" => Some(""),
977 // Note that we'll panic for String if is_ref, as we only have non-owned memory, we
978 // cannot create a &String.
980 "core::convert::Infallible" => Some("panic!(\"You must never construct a NotConstructable! : "),
982 "bitcoin::bech32::Error"|"bech32::Error" if !is_ref => Some(""),
983 "bitcoin::secp256k1::Error"|"secp256k1::Error" if !is_ref => Some(""),
985 "core::num::ParseIntError" => Some("u8::from_str_radix(\" a\", 10).unwrap_err() /*"),
986 "core::str::Utf8Error" => Some("core::str::from_utf8(&[0xff]).unwrap_err() /*"),
988 "std::time::Duration"|"core::time::Duration" => Some("core::time::Duration::from_secs("),
989 "std::time::SystemTime" => Some("(::std::time::SystemTime::UNIX_EPOCH + std::time::Duration::from_secs("),
991 "bitcoin::bech32::u5"|"bech32::u5" => Some(""),
992 "core::num::NonZeroU8" => Some("core::num::NonZeroU8::new("),
994 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" if is_ref => Some("&"),
995 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" => Some(""),
996 "bitcoin::secp256k1::ecdsa::Signature" if is_ref => Some("&"),
997 "bitcoin::secp256k1::ecdsa::Signature" => Some(""),
998 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some(""),
999 "bitcoin::secp256k1::SecretKey" if is_ref => Some("&::bitcoin::secp256k1::SecretKey::from_slice(&unsafe { *"),
1000 "bitcoin::secp256k1::SecretKey" if !is_ref => Some(""),
1001 "bitcoin::blockdata::script::Script" if is_ref => Some("&::bitcoin::blockdata::script::Script::from(Vec::from("),
1002 "bitcoin::blockdata::script::Script" if !is_ref => Some("::bitcoin::blockdata::script::Script::from("),
1003 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" if is_ref => Some("&"),
1004 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(""),
1005 "bitcoin::blockdata::transaction::OutPoint" => Some("crate::c_types::C_to_bitcoin_outpoint("),
1006 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(""),
1007 "bitcoin::network::constants::Network" => Some(""),
1008 "bitcoin::util::address::WitnessVersion" => Some(""),
1009 "bitcoin::blockdata::block::BlockHeader" => Some("&::bitcoin::consensus::encode::deserialize(unsafe { &*"),
1010 "bitcoin::blockdata::block::Block" if is_ref => Some("&::bitcoin::consensus::encode::deserialize("),
1012 "bitcoin::hash_types::PubkeyHash" if is_ref =>
1013 Some("&bitcoin::hash_types::PubkeyHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
1014 "bitcoin::hash_types::WPubkeyHash" if is_ref =>
1015 Some("&bitcoin::hash_types::WPubkeyHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
1016 "bitcoin::hash_types::ScriptHash" if is_ref =>
1017 Some("&bitcoin::hash_types::ScriptHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
1018 "bitcoin::hash_types::WScriptHash" if is_ref =>
1019 Some("&bitcoin::hash_types::WScriptHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
1021 // Newtypes that we just expose in their original form.
1022 "bitcoin::hash_types::Txid" if is_ref => Some("&::bitcoin::hash_types::Txid::from_slice(&unsafe { &*"),
1023 "bitcoin::hash_types::Txid" if !is_ref => Some("::bitcoin::hash_types::Txid::from_slice(&"),
1024 "bitcoin::hash_types::BlockHash" => Some("::bitcoin::hash_types::BlockHash::from_slice(&"),
1025 "lightning::ln::PaymentHash" if !is_ref => Some("::lightning::ln::PaymentHash("),
1026 "lightning::ln::PaymentHash" if is_ref => Some("&::lightning::ln::PaymentHash(unsafe { *"),
1027 "lightning::ln::PaymentPreimage" if !is_ref => Some("::lightning::ln::PaymentPreimage("),
1028 "lightning::ln::PaymentPreimage" if is_ref => Some("&::lightning::ln::PaymentPreimage(unsafe { *"),
1029 "lightning::ln::PaymentSecret" if !is_ref => Some("::lightning::ln::PaymentSecret("),
1030 "lightning::ln::channelmanager::PaymentId" if !is_ref => Some("::lightning::ln::channelmanager::PaymentId("),
1031 "lightning::ln::channelmanager::PaymentId" if is_ref=> Some("&::lightning::ln::channelmanager::PaymentId( unsafe { *"),
1032 "lightning::chain::keysinterface::KeyMaterial" if !is_ref => Some("::lightning::chain::keysinterface::KeyMaterial("),
1033 "lightning::chain::keysinterface::KeyMaterial" if is_ref=> Some("&::lightning::chain::keysinterface::KeyMaterial( unsafe { *"),
1035 // List of traits we map (possibly during processing of other files):
1036 "lightning::io::Read" => Some("&mut "),
1039 }.map(|s| s.to_owned())
1041 fn from_c_conversion_suffix_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<String> {
1042 if self.is_primitive(full_path) {
1043 return Some("".to_owned());
1046 "Vec" if !is_ref => Some(""),
1047 "Option" => Some(""),
1048 "Result" if !is_ref => Some(""),
1050 "[u8; 32]" if is_ref => Some("}"),
1051 "[u8; 32]" if !is_ref => Some(".data"),
1052 "[u8; 20]" if !is_ref => Some(".data"),
1053 "[u8; 16]" if !is_ref => Some(".data"),
1054 "[u8; 12]" if !is_ref => Some(".data"),
1055 "[u8; 4]" if !is_ref => Some(".data"),
1056 "[u8; 3]" if !is_ref => Some(".data"),
1058 "[u8]" if is_ref => Some(".to_slice()"),
1059 "[usize]" if is_ref => Some(".to_slice()"),
1061 "str" if is_ref => Some(".into_str()"),
1062 "alloc::string::String"|"String" => Some(".into_string()"),
1063 "std::io::Error"|"lightning::io::Error" => Some(".to_rust()"),
1065 "core::convert::Infallible" => Some("\")"),
1067 "bitcoin::bech32::Error"|"bech32::Error" if !is_ref => Some(".into_rust()"),
1068 "bitcoin::secp256k1::Error"|"secp256k1::Error" if !is_ref => Some(".into_rust()"),
1070 "core::num::ParseIntError" => Some("*/"),
1071 "core::str::Utf8Error" => Some("*/"),
1073 "std::time::Duration"|"core::time::Duration" => Some(")"),
1074 "std::time::SystemTime" => Some("))"),
1076 "bitcoin::bech32::u5"|"bech32::u5" => Some(".into()"),
1077 "core::num::NonZeroU8" => Some(").expect(\"Value must be non-zero\")"),
1079 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" => Some(".into_rust()"),
1080 "bitcoin::secp256k1::ecdsa::Signature" => Some(".into_rust()"),
1081 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some(".into_rust()"),
1082 "bitcoin::secp256k1::SecretKey" if !is_ref => Some(".into_rust()"),
1083 "bitcoin::secp256k1::SecretKey" if is_ref => Some("}[..]).unwrap()"),
1084 "bitcoin::blockdata::script::Script" if is_ref => Some(".to_slice()))"),
1085 "bitcoin::blockdata::script::Script" if !is_ref => Some(".into_rust())"),
1086 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(".into_bitcoin()"),
1087 "bitcoin::blockdata::transaction::OutPoint" => Some(")"),
1088 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(".into_rust()"),
1089 "bitcoin::network::constants::Network" => Some(".into_bitcoin()"),
1090 "bitcoin::util::address::WitnessVersion" => Some(".into()"),
1091 "bitcoin::blockdata::block::BlockHeader" => Some(" }).unwrap()"),
1092 "bitcoin::blockdata::block::Block" => Some(".to_slice()).unwrap()"),
1094 "bitcoin::hash_types::PubkeyHash"|"bitcoin::hash_types::WPubkeyHash"|
1095 "bitcoin::hash_types::ScriptHash"|"bitcoin::hash_types::WScriptHash"
1096 if is_ref => Some(" }.clone()))"),
1098 // Newtypes that we just expose in their original form.
1099 "bitcoin::hash_types::Txid" if is_ref => Some(" }[..]).unwrap()"),
1100 "bitcoin::hash_types::Txid" => Some(".data[..]).unwrap()"),
1101 "bitcoin::hash_types::BlockHash" if !is_ref => Some(".data[..]).unwrap()"),
1102 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1103 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1104 if !is_ref => Some(".data)"),
1105 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1106 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1107 if is_ref => Some(" })"),
1109 // List of traits we map (possibly during processing of other files):
1110 "lightning::io::Read" => Some(".to_reader()"),
1113 }.map(|s| s.to_owned())
1116 fn to_c_conversion_new_var_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<(&'b str, &'b str)> {
1117 if self.is_primitive(full_path) {
1121 "[u8]" if is_ref => Some(("crate::c_types::u8slice::from_slice(", ")")),
1122 "[usize]" if is_ref => Some(("crate::c_types::usizeslice::from_slice(", ")")),
1124 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some(("{ let mut s = [0u8; 80]; s[..].copy_from_slice(&::bitcoin::consensus::encode::serialize(", ")); s }")),
1125 "bitcoin::blockdata::block::Block" if is_ref => Some(("::bitcoin::consensus::encode::serialize(", ")")),
1126 "bitcoin::hash_types::Txid" => None,
1129 }.map(|s| s.to_owned())
1131 fn to_c_conversion_inline_prefix_from_path(&self, full_path: &str, is_ref: bool, _ptr_for_ref: bool) -> Option<String> {
1132 if self.is_primitive(full_path) {
1133 return Some("".to_owned());
1136 "Result" if !is_ref => Some("local_"),
1137 "Vec" if !is_ref => Some("local_"),
1138 "Option" => Some("local_"),
1140 "[u8; 32]" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1141 "[u8; 32]" if is_ref => Some(""),
1142 "[u8; 20]" if !is_ref => Some("crate::c_types::TwentyBytes { data: "),
1143 "[u8; 16]" if !is_ref => Some("crate::c_types::SixteenBytes { data: "),
1144 "[u8; 12]" if !is_ref => Some("crate::c_types::TwelveBytes { data: "),
1145 "[u8; 4]" if !is_ref => Some("crate::c_types::FourBytes { data: "),
1146 "[u8; 3]" if is_ref => Some(""),
1148 "[u8]" if is_ref => Some("local_"),
1149 "[usize]" if is_ref => Some("local_"),
1151 "str" if is_ref => Some(""),
1152 "alloc::string::String"|"String" => Some(""),
1154 "std::time::Duration"|"core::time::Duration" => Some(""),
1155 "std::time::SystemTime" => Some(""),
1156 "std::io::Error"|"lightning::io::Error" => Some("crate::c_types::IOError::from_rust("),
1157 "core::fmt::Arguments" => Some("alloc::format!(\"{}\", "),
1159 "core::convert::Infallible" => Some("panic!(\"Cannot construct an Infallible: "),
1161 "bitcoin::bech32::Error"|"bech32::Error"
1162 if !is_ref => Some("crate::c_types::Bech32Error::from_rust("),
1163 "bitcoin::secp256k1::Error"|"secp256k1::Error"
1164 if !is_ref => Some("crate::c_types::Secp256k1Error::from_rust("),
1166 "core::num::ParseIntError" => Some("crate::c_types::Error { _dummy: 0 } /*"),
1167 "core::str::Utf8Error" => Some("crate::c_types::Error { _dummy: 0 } /*"),
1169 "bitcoin::bech32::u5"|"bech32::u5" => Some(""),
1171 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" => Some("crate::c_types::PublicKey::from_rust(&"),
1172 "bitcoin::secp256k1::ecdsa::Signature" => Some("crate::c_types::Signature::from_rust(&"),
1173 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some("crate::c_types::RecoverableSignature::from_rust(&"),
1174 "bitcoin::secp256k1::SecretKey" if is_ref => Some(""),
1175 "bitcoin::secp256k1::SecretKey" if !is_ref => Some("crate::c_types::SecretKey::from_rust("),
1176 "bitcoin::blockdata::script::Script" if is_ref => Some("crate::c_types::u8slice::from_slice(&"),
1177 "bitcoin::blockdata::script::Script" if !is_ref => Some(""),
1178 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" if is_ref => Some("crate::c_types::Transaction::from_bitcoin("),
1179 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some("crate::c_types::Transaction::from_bitcoin(&"),
1180 "bitcoin::blockdata::transaction::OutPoint" => Some("crate::c_types::bitcoin_to_C_outpoint("),
1181 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some("crate::c_types::TxOut::from_rust("),
1182 "bitcoin::network::constants::Network" => Some("crate::bitcoin::network::Network::from_bitcoin("),
1183 "bitcoin::util::address::WitnessVersion" => Some(""),
1184 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some("&local_"),
1185 "bitcoin::blockdata::block::Block" if is_ref => Some("crate::c_types::u8slice::from_slice(&local_"),
1187 "bitcoin::hash_types::Txid" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1189 // Newtypes that we just expose in their original form.
1190 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1191 if is_ref => Some(""),
1192 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1193 if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1194 "bitcoin::secp256k1::Message" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1195 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1196 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1197 if is_ref => Some("&"),
1198 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1199 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1200 if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
1202 "lightning::io::Read" => Some("crate::c_types::u8slice::from_vec(&crate::c_types::reader_to_vec("),
1205 }.map(|s| s.to_owned())
1207 fn to_c_conversion_inline_suffix_from_path(&self, full_path: &str, is_ref: bool, _ptr_for_ref: bool) -> Option<String> {
1208 if self.is_primitive(full_path) {
1209 return Some("".to_owned());
1212 "Result" if !is_ref => Some(""),
1213 "Vec" if !is_ref => Some(".into()"),
1214 "Option" => Some(""),
1216 "[u8; 32]" if !is_ref => Some(" }"),
1217 "[u8; 32]" if is_ref => Some(""),
1218 "[u8; 20]" if !is_ref => Some(" }"),
1219 "[u8; 16]" if !is_ref => Some(" }"),
1220 "[u8; 12]" if !is_ref => Some(" }"),
1221 "[u8; 4]" if !is_ref => Some(" }"),
1222 "[u8; 3]" if is_ref => Some(""),
1224 "[u8]" if is_ref => Some(""),
1225 "[usize]" if is_ref => Some(""),
1227 "str" if is_ref => Some(".into()"),
1228 "alloc::string::String"|"String" if is_ref => Some(".as_str().into()"),
1229 "alloc::string::String"|"String" => Some(".into()"),
1231 "std::time::Duration"|"core::time::Duration" => Some(".as_secs()"),
1232 "std::time::SystemTime" => Some(".duration_since(::std::time::SystemTime::UNIX_EPOCH).expect(\"Times must be post-1970\").as_secs()"),
1233 "std::io::Error"|"lightning::io::Error" => Some(")"),
1234 "core::fmt::Arguments" => Some(").into()"),
1236 "core::convert::Infallible" => Some("\")"),
1238 "bitcoin::secp256k1::Error"|"bech32::Error"
1239 if !is_ref => Some(")"),
1240 "bitcoin::secp256k1::Error"|"secp256k1::Error"
1241 if !is_ref => Some(")"),
1243 "core::num::ParseIntError" => Some("*/"),
1244 "core::str::Utf8Error" => Some("*/"),
1246 "bitcoin::bech32::u5"|"bech32::u5" => Some(".into()"),
1248 "bitcoin::secp256k1::PublicKey"|"secp256k1::PublicKey" => Some(")"),
1249 "bitcoin::secp256k1::ecdsa::Signature" => Some(")"),
1250 "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some(")"),
1251 "bitcoin::secp256k1::SecretKey" if !is_ref => Some(")"),
1252 "bitcoin::secp256k1::SecretKey" if is_ref => Some(".as_ref()"),
1253 "bitcoin::blockdata::script::Script" if is_ref => Some("[..])"),
1254 "bitcoin::blockdata::script::Script" if !is_ref => Some(".into_bytes().into()"),
1255 "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(")"),
1256 "bitcoin::blockdata::transaction::OutPoint" => Some(")"),
1257 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(")"),
1258 "bitcoin::network::constants::Network" => Some(")"),
1259 "bitcoin::util::address::WitnessVersion" => Some(".into()"),
1260 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some(""),
1261 "bitcoin::blockdata::block::Block" if is_ref => Some(")"),
1263 "bitcoin::hash_types::Txid" if !is_ref => Some(".into_inner() }"),
1265 // Newtypes that we just expose in their original form.
1266 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1267 if is_ref => Some(".as_inner()"),
1268 "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
1269 if !is_ref => Some(".into_inner() }"),
1270 "bitcoin::secp256k1::Message" if !is_ref => Some(".as_ref().clone() }"),
1271 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1272 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1273 if is_ref => Some(".0"),
1274 "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
1275 |"lightning::ln::channelmanager::PaymentId"|"lightning::chain::keysinterface::KeyMaterial"
1276 if !is_ref => Some(".0 }"),
1278 "lightning::io::Read" => Some("))"),
1281 }.map(|s| s.to_owned())
1284 fn empty_val_check_suffix_from_path(&self, full_path: &str) -> Option<&str> {
1286 "lightning::ln::PaymentSecret" => Some(".data == [0; 32]"),
1287 "secp256k1::PublicKey"|"bitcoin::secp256k1::PublicKey" => Some(".is_null()"),
1288 "bitcoin::secp256k1::ecdsa::Signature" => Some(".is_null()"),
1293 /// When printing a reference to the source crate's rust type, if we need to map it to a
1294 /// different "real" type, it can be done so here.
1295 /// This is useful to work around limitations in the binding type resolver, where we reference
1296 /// a non-public `use` alias.
1297 /// TODO: We should never need to use this!
1298 fn real_rust_type_mapping<'equiv>(&self, thing: &'equiv str) -> &'equiv str {
1300 "lightning::io::Read" => "crate::c_types::io::Read",
1305 // ****************************
1306 // *** Container Processing ***
1307 // ****************************
1309 /// Returns the module path in the generated mapping crate to the containers which we generate
1310 /// when writing to CrateTypes::template_file.
1311 pub fn generated_container_path() -> &'static str {
1312 "crate::c_types::derived"
1314 /// Returns the module path in the generated mapping crate to the container templates, which
1315 /// are then concretized and put in the generated container path/template_file.
1316 fn container_templ_path() -> &'static str {
1320 /// Returns true if the path containing the given args is a "transparent" container, ie an
1321 /// Option or a container which does not require a generated continer class.
1322 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 {
1323 if full_path == "Option" {
1324 let inner = args.next().unwrap();
1325 assert!(args.next().is_none());
1327 syn::Type::Reference(_) => true,
1328 syn::Type::Array(a) => {
1329 if let syn::Expr::Lit(l) = &a.len {
1330 if let syn::Lit::Int(i) = &l.lit {
1331 if i.base10_digits().parse::<usize>().unwrap() >= 32 {
1332 let mut buf = Vec::new();
1333 self.write_rust_type(&mut buf, generics, &a.elem);
1334 let ty = String::from_utf8(buf).unwrap();
1337 // Blindly assume that if we're trying to create an empty value for an
1338 // array < 32 entries that all-0s may be a valid state.
1341 } else { unimplemented!(); }
1342 } else { unimplemented!(); }
1344 syn::Type::Path(p) => {
1345 if let Some(resolved) = self.maybe_resolve_path(&p.path, generics) {
1346 if self.c_type_has_inner_from_path(&resolved) { return true; }
1347 if self.is_primitive(&resolved) { return false; }
1348 if self.c_type_from_path(&resolved, false, false).is_some() { true } else { false }
1351 syn::Type::Tuple(_) => false,
1352 _ => unimplemented!(),
1356 /// Returns true if the path is a "transparent" container, ie an Option or a container which does
1357 /// not require a generated continer class.
1358 pub fn is_path_transparent_container(&self, full_path: &syn::Path, generics: Option<&GenericTypes>, is_ref: bool) -> bool {
1359 let inner_iter = match &full_path.segments.last().unwrap().arguments {
1360 syn::PathArguments::None => return false,
1361 syn::PathArguments::AngleBracketed(args) => args.args.iter().map(|arg| {
1362 if let syn::GenericArgument::Type(ref ty) = arg {
1364 } else { unimplemented!() }
1366 syn::PathArguments::Parenthesized(_) => unimplemented!(),
1368 self.is_transparent_container(&self.resolve_path(full_path, generics), is_ref, inner_iter, generics)
1370 /// Returns true if this is a known, supported, non-transparent container.
1371 fn is_known_container(&self, full_path: &str, is_ref: bool) -> bool {
1372 (full_path == "Result" && !is_ref) || (full_path == "Vec" && !is_ref) || full_path.ends_with("Tuple") || full_path == "Option"
1374 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)
1375 // Returns prefix + Vec<(prefix, var-name-to-inline-convert)> + suffix
1376 // expecting one element in the vec per generic type, each of which is inline-converted
1377 -> Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)> {
1379 "Result" if !is_ref => {
1381 vec![(" { Ok(mut o) => crate::c_types::CResultTempl::ok(".to_string(), "o".to_string()),
1382 (").into(), Err(mut e) => crate::c_types::CResultTempl::err(".to_string(), "e".to_string())],
1383 ").into() }", ContainerPrefixLocation::PerConv))
1387 // We should only get here if the single contained has an inner
1388 assert!(self.c_type_has_inner(single_contained.unwrap()));
1390 Some(("Vec::new(); for mut item in ", vec![(format!(".drain(..) {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1393 if let Some(syn::Type::Reference(_)) = single_contained {
1394 Some(("Vec::new(); for item in ", vec![(format!(".iter() {{ local_{}.push(", var_name), "(*item)".to_string())], "); }", ContainerPrefixLocation::PerConv))
1396 Some(("Vec::new(); for item in ", vec![(format!(".iter() {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1400 let mut is_contained_ref = false;
1401 let contained_struct = if let Some(syn::Type::Path(p)) = single_contained {
1402 Some(self.resolve_path(&p.path, generics))
1403 } else if let Some(syn::Type::Reference(r)) = single_contained {
1404 is_contained_ref = true;
1405 if let syn::Type::Path(p) = &*r.elem {
1406 Some(self.resolve_path(&p.path, generics))
1409 if let Some(inner_path) = contained_struct {
1410 let only_contained_has_inner = self.c_type_has_inner_from_path(&inner_path);
1411 if self.c_type_has_inner_from_path(&inner_path) {
1412 let is_inner_ref = if let Some(syn::Type::Reference(_)) = single_contained { true } else { false };
1414 return Some(("if ", vec![
1415 (".is_none() { core::ptr::null() } else { ObjOps::nonnull_ptr_to_inner(".to_owned(),
1416 format!("({}{}.unwrap())", var_access, if is_inner_ref { "" } else { ".as_ref()" }))
1417 ], ") }", ContainerPrefixLocation::OutsideConv));
1419 return Some(("if ", vec![
1420 (".is_none() { core::ptr::null_mut() } else { ".to_owned(), format!("({}.unwrap())", var_access))
1421 ], " }", ContainerPrefixLocation::OutsideConv));
1423 } else if self.is_primitive(&inner_path) || self.c_type_from_path(&inner_path, false, false).is_none() {
1424 if self.is_primitive(&inner_path) || (!is_contained_ref && !is_ref) || only_contained_has_inner {
1425 let inner_name = self.get_c_mangled_container_type(vec![single_contained.unwrap()], generics, "Option").unwrap();
1426 return Some(("if ", vec![
1427 (format!(".is_none() {{ {}::None }} else {{ {}::Some(", inner_name, inner_name),
1428 format!("{}.unwrap()", var_access))
1429 ], ") }", ContainerPrefixLocation::PerConv));
1431 let inner_name = self.get_c_mangled_container_type(vec![single_contained.unwrap()], generics, "Option").unwrap();
1432 return Some(("if ", vec![
1433 (format!(".is_none() {{ {}::None }} else {{ {}::Some(/* WARNING: CLONING CONVERSION HERE! &Option<Enum> is otherwise un-expressable. */", inner_name, inner_name),
1434 format!("{}.clone().unwrap()", var_access))
1435 ], ") }", ContainerPrefixLocation::PerConv));
1438 // If c_type_from_path is some (ie there's a manual mapping for the inner
1439 // type), lean on write_empty_rust_val, below.
1442 if let Some(t) = single_contained {
1443 if let syn::Type::Tuple(syn::TypeTuple { elems, .. }) = t {
1444 assert!(elems.is_empty());
1445 let inner_name = self.get_c_mangled_container_type(vec![single_contained.unwrap()], generics, "Option").unwrap();
1446 return Some(("if ", vec![
1447 (format!(".is_none() {{ {}::None }} else {{ {}::Some /*",
1448 inner_name, inner_name), format!(""))
1449 ], " */}", ContainerPrefixLocation::PerConv));
1451 if let syn::Type::Reference(syn::TypeReference { elem, .. }) = t {
1452 if let syn::Type::Slice(_) = &**elem {
1453 return Some(("if ", vec![
1454 (".is_none() { SmartPtr::null() } else { SmartPtr::from_obj(".to_string(),
1455 format!("({}.unwrap())", var_access))
1456 ], ") }", ContainerPrefixLocation::PerConv));
1459 let mut v = Vec::new();
1460 self.write_empty_rust_val(generics, &mut v, t);
1461 let s = String::from_utf8(v).unwrap();
1462 return Some(("if ", vec![
1463 (format!(".is_none() {{ {} }} else {{ ", s), format!("({}.unwrap())", var_access))
1464 ], " }", ContainerPrefixLocation::PerConv));
1465 } else { unreachable!(); }
1471 /// only_contained_has_inner implies that there is only one contained element in the container
1472 /// and it has an inner field (ie is an "opaque" type we've defined).
1473 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)
1474 // Returns prefix + Vec<(prefix, var-name-to-inline-convert)> + suffix
1475 // expecting one element in the vec per generic type, each of which is inline-converted
1476 -> Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)> {
1477 let mut only_contained_has_inner = false;
1478 let only_contained_resolved = if let Some(syn::Type::Path(p)) = single_contained {
1479 let res = self.resolve_path(&p.path, generics);
1480 only_contained_has_inner = self.c_type_has_inner_from_path(&res);
1484 "Result" if !is_ref => {
1486 vec![(".result_ok { true => Ok(".to_string(), format!("(*unsafe {{ Box::from_raw(<*mut _>::take_ptr(&mut {}.contents.result)) }})", var_access)),
1487 ("), false => Err(".to_string(), format!("(*unsafe {{ Box::from_raw(<*mut _>::take_ptr(&mut {}.contents.err)) }})", var_access))],
1488 ")}", ContainerPrefixLocation::PerConv))
1490 "Slice" if is_ref && only_contained_has_inner => {
1491 Some(("Vec::new(); for mut item in ", vec![(format!(".as_slice().iter() {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1494 Some(("Vec::new(); for mut item in ", vec![(format!(".into_rust().drain(..) {{ local_{}.push(", var_name), "item".to_string())], "); }", ContainerPrefixLocation::PerConv))
1497 if let Some(resolved) = only_contained_resolved {
1498 if self.is_primitive(&resolved) {
1499 return Some(("if ", vec![(".is_some() { Some(".to_string(), format!("{}.take()", var_access))], ") } else { None }", ContainerPrefixLocation::NoPrefix))
1500 } else if only_contained_has_inner {
1502 return Some(("if ", vec![(".inner.is_null() { None } else { Some((*".to_string(), format!("{}", var_access))], ").clone()) }", ContainerPrefixLocation::PerConv))
1504 return Some(("if ", vec![(".inner.is_null() { None } else { Some(".to_string(), format!("{}", var_access))], ") }", ContainerPrefixLocation::PerConv));
1509 if let Some(t) = single_contained {
1511 syn::Type::Reference(_)|syn::Type::Path(_)|syn::Type::Slice(_)|syn::Type::Array(_) => {
1512 let mut v = Vec::new();
1513 let ret_ref = self.write_empty_rust_val_check_suffix(generics, &mut v, t);
1514 let s = String::from_utf8(v).unwrap();
1516 EmptyValExpectedTy::ReferenceAsPointer =>
1517 return Some(("if ", vec![
1518 (format!("{} {{ None }} else {{ Some(", s), format!("unsafe {{ &mut *{} }}", var_access))
1519 ], ") }", ContainerPrefixLocation::NoPrefix)),
1520 EmptyValExpectedTy::OptionType =>
1521 return Some(("{ /* ", vec![
1522 (format!("*/ let {}_opt = {};", var_name, var_access),
1523 format!("}} if {}_opt{} {{ None }} else {{ Some({{ {}_opt.take()", var_name, s, var_name))
1524 ], ") } }", ContainerPrefixLocation::PerConv)),
1525 EmptyValExpectedTy::NonPointer =>
1526 return Some(("if ", vec![
1527 (format!("{} {{ None }} else {{ Some(", s), format!("{}", var_access))
1528 ], ") }", ContainerPrefixLocation::PerConv)),
1531 syn::Type::Tuple(_) => {
1532 return Some(("if ", vec![(".is_some() { Some(".to_string(), format!("{}.take()", var_access))], ") } else { None }", ContainerPrefixLocation::PerConv))
1534 _ => unimplemented!(),
1536 } else { unreachable!(); }
1542 /// Constructs a reference to the given type, possibly tweaking the type if relevant to make it
1543 /// convertable to C.
1544 pub fn create_ownable_reference(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> Option<syn::Type> {
1545 let default_value = Some(syn::Type::Reference(syn::TypeReference {
1546 and_token: syn::Token!(&)(Span::call_site()), lifetime: None, mutability: None,
1547 elem: Box::new(t.clone()) }));
1548 match generics.resolve_type(t) {
1549 syn::Type::Path(p) => {
1550 if let Some(resolved_path) = self.maybe_resolve_path(&p.path, generics) {
1551 if resolved_path != "Vec" { return default_value; }
1552 if p.path.segments.len() != 1 { unimplemented!(); }
1553 let only_seg = p.path.segments.iter().next().unwrap();
1554 if let syn::PathArguments::AngleBracketed(args) = &only_seg.arguments {
1555 if args.args.len() != 1 { unimplemented!(); }
1556 let inner_arg = args.args.iter().next().unwrap();
1557 if let syn::GenericArgument::Type(ty) = &inner_arg {
1558 let mut can_create = self.c_type_has_inner(&ty);
1559 if let syn::Type::Path(inner) = ty {
1560 if inner.path.segments.len() == 1 &&
1561 format!("{}", inner.path.segments[0].ident) == "Vec" {
1565 if !can_create { return default_value; }
1566 if let Some(inner_ty) = self.create_ownable_reference(&ty, generics) {
1567 return Some(syn::Type::Reference(syn::TypeReference {
1568 and_token: syn::Token![&](Span::call_site()),
1571 elem: Box::new(syn::Type::Slice(syn::TypeSlice {
1572 bracket_token: syn::token::Bracket { span: Span::call_site() },
1573 elem: Box::new(inner_ty)
1576 } else { return default_value; }
1577 } else { unimplemented!(); }
1578 } else { unimplemented!(); }
1579 } else { return None; }
1585 // *************************************************
1586 // *** Type definition during main.rs processing ***
1587 // *************************************************
1589 /// Returns true if the object at the given path is mapped as X { inner: *mut origX, .. }.
1590 pub fn c_type_has_inner_from_path(&self, full_path: &str) -> bool {
1591 self.crate_types.opaques.get(full_path).is_some()
1594 /// Returns true if the object at the given path is mapped as X { inner: *mut origX, .. }.
1595 pub fn c_type_has_inner(&self, ty: &syn::Type) -> bool {
1597 syn::Type::Path(p) => {
1598 if let Some(full_path) = self.maybe_resolve_path(&p.path, None) {
1599 self.c_type_has_inner_from_path(&full_path)
1602 syn::Type::Reference(r) => {
1603 self.c_type_has_inner(&*r.elem)
1609 pub fn maybe_resolve_ident(&self, id: &syn::Ident) -> Option<String> {
1610 self.types.maybe_resolve_ident(id)
1613 pub fn maybe_resolve_path(&self, p_arg: &syn::Path, generics: Option<&GenericTypes>) -> Option<String> {
1614 self.types.maybe_resolve_path(p_arg, generics)
1616 pub fn resolve_path(&self, p: &syn::Path, generics: Option<&GenericTypes>) -> String {
1617 self.maybe_resolve_path(p, generics).unwrap()
1620 // ***********************************
1621 // *** Original Rust Type Printing ***
1622 // ***********************************
1624 fn in_rust_prelude(resolved_path: &str) -> bool {
1625 match resolved_path {
1633 fn write_rust_path<W: std::io::Write>(&self, w: &mut W, generics_resolver: Option<&GenericTypes>, path: &syn::Path) {
1634 if let Some(resolved) = self.maybe_resolve_path(&path, generics_resolver) {
1635 if self.is_primitive(&resolved) {
1636 write!(w, "{}", path.get_ident().unwrap()).unwrap();
1638 // TODO: We should have a generic "is from a dependency" check here instead of
1639 // checking for "bitcoin" explicitly.
1640 if resolved.starts_with("bitcoin::") || Self::in_rust_prelude(&resolved) {
1641 write!(w, "{}", resolved).unwrap();
1642 // If we're printing a generic argument, it needs to reference the crate, otherwise
1643 // the original crate:
1644 } else if self.maybe_resolve_path(&path, None).as_ref() == Some(&resolved) {
1645 write!(w, "{}", self.real_rust_type_mapping(&resolved)).unwrap();
1647 write!(w, "crate::{}", resolved).unwrap();
1650 if let syn::PathArguments::AngleBracketed(args) = &path.segments.iter().last().unwrap().arguments {
1651 self.write_rust_generic_arg(w, generics_resolver, args.args.iter());
1654 if path.leading_colon.is_some() {
1655 write!(w, "::").unwrap();
1657 for (idx, seg) in path.segments.iter().enumerate() {
1658 if idx != 0 { write!(w, "::").unwrap(); }
1659 write!(w, "{}", seg.ident).unwrap();
1660 if let syn::PathArguments::AngleBracketed(args) = &seg.arguments {
1661 self.write_rust_generic_arg(w, generics_resolver, args.args.iter());
1666 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>) {
1667 let mut had_params = false;
1668 for (idx, arg) in generics.enumerate() {
1669 if idx != 0 { write!(w, ", ").unwrap(); } else { write!(w, "<").unwrap(); }
1672 syn::GenericParam::Lifetime(lt) => write!(w, "'{}", lt.lifetime.ident).unwrap(),
1673 syn::GenericParam::Type(t) => {
1674 write!(w, "{}", t.ident).unwrap();
1675 if t.colon_token.is_some() { write!(w, ":").unwrap(); }
1676 for (idx, bound) in t.bounds.iter().enumerate() {
1677 if idx != 0 { write!(w, " + ").unwrap(); }
1679 syn::TypeParamBound::Trait(tb) => {
1680 if tb.paren_token.is_some() || tb.lifetimes.is_some() { unimplemented!(); }
1681 self.write_rust_path(w, generics_resolver, &tb.path);
1683 _ => unimplemented!(),
1686 if t.eq_token.is_some() || t.default.is_some() { unimplemented!(); }
1688 _ => unimplemented!(),
1691 if had_params { write!(w, ">").unwrap(); }
1694 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>) {
1695 write!(w, "<").unwrap();
1696 for (idx, arg) in generics.enumerate() {
1697 if idx != 0 { write!(w, ", ").unwrap(); }
1699 syn::GenericArgument::Type(t) => self.write_rust_type(w, generics_resolver, t),
1700 _ => unimplemented!(),
1703 write!(w, ">").unwrap();
1705 pub fn write_rust_type<W: std::io::Write>(&self, w: &mut W, generics: Option<&GenericTypes>, t: &syn::Type) {
1706 match generics.resolve_type(t) {
1707 syn::Type::Path(p) => {
1708 if p.qself.is_some() {
1711 self.write_rust_path(w, generics, &p.path);
1713 syn::Type::Reference(r) => {
1714 write!(w, "&").unwrap();
1715 if let Some(lft) = &r.lifetime {
1716 write!(w, "'{} ", lft.ident).unwrap();
1718 if r.mutability.is_some() {
1719 write!(w, "mut ").unwrap();
1721 self.write_rust_type(w, generics, &*r.elem);
1723 syn::Type::Array(a) => {
1724 write!(w, "[").unwrap();
1725 self.write_rust_type(w, generics, &a.elem);
1726 if let syn::Expr::Lit(l) = &a.len {
1727 if let syn::Lit::Int(i) = &l.lit {
1728 write!(w, "; {}]", i).unwrap();
1729 } else { unimplemented!(); }
1730 } else { unimplemented!(); }
1732 syn::Type::Slice(s) => {
1733 write!(w, "[").unwrap();
1734 self.write_rust_type(w, generics, &s.elem);
1735 write!(w, "]").unwrap();
1737 syn::Type::Tuple(s) => {
1738 write!(w, "(").unwrap();
1739 for (idx, t) in s.elems.iter().enumerate() {
1740 if idx != 0 { write!(w, ", ").unwrap(); }
1741 self.write_rust_type(w, generics, &t);
1743 write!(w, ")").unwrap();
1745 _ => unimplemented!(),
1749 /// Prints a constructor for something which is "uninitialized" (but obviously not actually
1750 /// unint'd memory).
1751 pub fn write_empty_rust_val<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type) {
1753 syn::Type::Reference(r) => {
1754 self.write_empty_rust_val(generics, w, &*r.elem)
1756 syn::Type::Path(p) => {
1757 let resolved = self.resolve_path(&p.path, generics);
1758 if self.crate_types.opaques.get(&resolved).is_some() {
1759 write!(w, "crate::{} {{ inner: core::ptr::null_mut(), is_owned: true }}", resolved).unwrap();
1761 // Assume its a manually-mapped C type, where we can just define an null() fn
1762 write!(w, "{}::null()", self.c_type_from_path(&resolved, false, false).unwrap()).unwrap();
1765 syn::Type::Array(a) => {
1766 if let syn::Expr::Lit(l) = &a.len {
1767 if let syn::Lit::Int(i) = &l.lit {
1768 if i.base10_digits().parse::<usize>().unwrap() < 32 {
1769 // Blindly assume that if we're trying to create an empty value for an
1770 // array < 32 entries that all-0s may be a valid state.
1773 let arrty = format!("[u8; {}]", i.base10_digits());
1774 write!(w, "{}", self.to_c_conversion_inline_prefix_from_path(&arrty, false, false).unwrap()).unwrap();
1775 write!(w, "[0; {}]", i.base10_digits()).unwrap();
1776 write!(w, "{}", self.to_c_conversion_inline_suffix_from_path(&arrty, false, false).unwrap()).unwrap();
1777 } else { unimplemented!(); }
1778 } else { unimplemented!(); }
1780 _ => unimplemented!(),
1784 fn is_real_type_array(&self, resolved_type: &str) -> Option<syn::Type> {
1785 if let Some(real_ty) = self.c_type_from_path(&resolved_type, true, false) {
1786 if real_ty.ends_with("]") && real_ty.starts_with("*const [u8; ") {
1787 let mut split = real_ty.split("; ");
1788 split.next().unwrap();
1789 let tail_str = split.next().unwrap();
1790 assert!(split.next().is_none());
1791 let len = usize::from_str_radix(&tail_str[..tail_str.len() - 1], 10).unwrap();
1792 Some(parse_quote!([u8; #len]))
1797 /// Prints a suffix to determine if a variable is empty (ie was set by write_empty_rust_val).
1798 /// See EmptyValExpectedTy for information on return types.
1799 fn write_empty_rust_val_check_suffix<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type) -> EmptyValExpectedTy {
1801 syn::Type::Reference(r) => {
1802 return self.write_empty_rust_val_check_suffix(generics, w, &*r.elem);
1804 syn::Type::Path(p) => {
1805 let resolved = self.resolve_path(&p.path, generics);
1806 if let Some(arr_ty) = self.is_real_type_array(&resolved) {
1807 return self.write_empty_rust_val_check_suffix(generics, w, &arr_ty);
1809 if self.crate_types.opaques.get(&resolved).is_some() {
1810 write!(w, ".inner.is_null()").unwrap();
1811 EmptyValExpectedTy::NonPointer
1813 if let Some(suffix) = self.empty_val_check_suffix_from_path(&resolved) {
1814 write!(w, "{}", suffix).unwrap();
1815 // We may eventually need to allow empty_val_check_suffix_from_path to specify if we need a deref or not
1816 EmptyValExpectedTy::NonPointer
1818 write!(w, ".is_none()").unwrap();
1819 EmptyValExpectedTy::OptionType
1823 syn::Type::Array(a) => {
1824 if let syn::Expr::Lit(l) = &a.len {
1825 if let syn::Lit::Int(i) = &l.lit {
1826 write!(w, ".data == [0; {}]", i.base10_digits()).unwrap();
1827 EmptyValExpectedTy::NonPointer
1828 } else { unimplemented!(); }
1829 } else { unimplemented!(); }
1831 syn::Type::Slice(_) => {
1832 // Option<[]> always implies that we want to treat len() == 0 differently from
1833 // None, so we always map an Option<[]> into a pointer.
1834 write!(w, " == core::ptr::null_mut()").unwrap();
1835 EmptyValExpectedTy::ReferenceAsPointer
1837 _ => unimplemented!(),
1841 /// Prints a suffix to determine if a variable is empty (ie was set by write_empty_rust_val).
1842 pub fn write_empty_rust_val_check<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type, var_access: &str) {
1844 syn::Type::Reference(r) => {
1845 self.write_empty_rust_val_check(generics, w, &*r.elem, var_access);
1847 syn::Type::Path(_) => {
1848 write!(w, "{}", var_access).unwrap();
1849 self.write_empty_rust_val_check_suffix(generics, w, t);
1851 syn::Type::Array(a) => {
1852 if let syn::Expr::Lit(l) = &a.len {
1853 if let syn::Lit::Int(i) = &l.lit {
1854 let arrty = format!("[u8; {}]", i.base10_digits());
1855 // We don't (yet) support a new-var conversion here.
1856 assert!(self.from_c_conversion_new_var_from_path(&arrty, false).is_none());
1858 self.from_c_conversion_prefix_from_path(&arrty, false).unwrap(),
1860 self.from_c_conversion_suffix_from_path(&arrty, false).unwrap()).unwrap();
1861 self.write_empty_rust_val_check_suffix(generics, w, t);
1862 } else { unimplemented!(); }
1863 } else { unimplemented!(); }
1865 _ => unimplemented!(),
1869 // ********************************
1870 // *** Type conversion printing ***
1871 // ********************************
1873 /// Returns true we if can just skip passing this to C entirely
1874 pub fn skip_arg(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> bool {
1876 syn::Type::Path(p) => {
1877 if p.qself.is_some() { unimplemented!(); }
1878 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
1879 self.skip_path(&full_path)
1882 syn::Type::Reference(r) => {
1883 self.skip_arg(&*r.elem, generics)
1888 pub fn no_arg_to_rust<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
1890 syn::Type::Path(p) => {
1891 if p.qself.is_some() { unimplemented!(); }
1892 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
1893 write!(w, "{}", self.no_arg_path_to_rust(&full_path)).unwrap();
1896 syn::Type::Reference(r) => {
1897 self.no_arg_to_rust(w, &*r.elem, generics);
1903 fn write_conversion_inline_intern<W: std::io::Write,
1904 LP: Fn(&str, bool, bool) -> Option<String>, DL: Fn(&mut W, &DeclType, &str, bool, bool), SC: Fn(bool, Option<&str>) -> String>
1905 (&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, is_ref: bool, is_mut: bool, ptr_for_ref: bool,
1906 tupleconv: &str, prefix: bool, sliceconv: SC, path_lookup: LP, decl_lookup: DL) {
1907 match generics.resolve_type(t) {
1908 syn::Type::Reference(r) => {
1909 self.write_conversion_inline_intern(w, &*r.elem, generics, true, r.mutability.is_some(),
1910 ptr_for_ref, tupleconv, prefix, sliceconv, path_lookup, decl_lookup);
1912 syn::Type::Path(p) => {
1913 if p.qself.is_some() {
1917 let resolved_path = self.resolve_path(&p.path, generics);
1918 if let Some(aliased_type) = self.crate_types.type_aliases.get(&resolved_path) {
1919 return self.write_conversion_inline_intern(w, aliased_type, None, is_ref, is_mut, ptr_for_ref, tupleconv, prefix, sliceconv, path_lookup, decl_lookup);
1920 } else if self.is_primitive(&resolved_path) {
1921 if is_ref && prefix {
1922 write!(w, "*").unwrap();
1924 } else if let Some(c_type) = path_lookup(&resolved_path, is_ref, ptr_for_ref) {
1925 write!(w, "{}", c_type).unwrap();
1926 } else if let Some((_, generics)) = self.crate_types.opaques.get(&resolved_path) {
1927 decl_lookup(w, &DeclType::StructImported { generics: &generics }, &resolved_path, is_ref, is_mut);
1928 } else if self.crate_types.mirrored_enums.get(&resolved_path).is_some() {
1929 decl_lookup(w, &DeclType::MirroredEnum, &resolved_path, is_ref, is_mut);
1930 } else if let Some(t) = self.crate_types.traits.get(&resolved_path) {
1931 decl_lookup(w, &DeclType::Trait(t), &resolved_path, is_ref, is_mut);
1932 } else if let Some(ident) = single_ident_generic_path_to_ident(&p.path) {
1933 if let Some(decl_type) = self.types.maybe_resolve_declared(ident) {
1934 decl_lookup(w, decl_type, &self.maybe_resolve_ident(ident).unwrap(), is_ref, is_mut);
1935 } else { unimplemented!(); }
1936 } else { unimplemented!(); }
1938 syn::Type::Array(a) => {
1939 // We assume all arrays contain only [int_literal; X]s.
1940 // This may result in some outputs not compiling.
1941 if let syn::Expr::Lit(l) = &a.len {
1942 if let syn::Lit::Int(i) = &l.lit {
1943 write!(w, "{}", path_lookup(&format!("[u8; {}]", i.base10_digits()), is_ref, ptr_for_ref).unwrap()).unwrap();
1944 } else { unimplemented!(); }
1945 } else { unimplemented!(); }
1947 syn::Type::Slice(s) => {
1948 // We assume all slices contain only literals or references.
1949 // This may result in some outputs not compiling.
1950 if let syn::Type::Path(p) = &*s.elem {
1951 let resolved = self.resolve_path(&p.path, generics);
1952 if self.is_primitive(&resolved) {
1953 write!(w, "{}", path_lookup("[u8]", is_ref, ptr_for_ref).unwrap()).unwrap();
1955 write!(w, "{}", sliceconv(true, None)).unwrap();
1957 } else if let syn::Type::Reference(r) = &*s.elem {
1958 if let syn::Type::Path(p) = &*r.elem {
1959 write!(w, "{}", sliceconv(self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)), None)).unwrap();
1960 } else if let syn::Type::Slice(_) = &*r.elem {
1961 write!(w, "{}", sliceconv(false, None)).unwrap();
1962 } else { unimplemented!(); }
1963 } else if let syn::Type::Tuple(t) = &*s.elem {
1964 assert!(!t.elems.is_empty());
1966 write!(w, "{}", sliceconv(false, None)).unwrap();
1968 let mut needs_map = false;
1969 for e in t.elems.iter() {
1970 if let syn::Type::Reference(_) = e {
1975 let mut map_str = Vec::new();
1976 write!(&mut map_str, ".map(|(").unwrap();
1977 for i in 0..t.elems.len() {
1978 write!(&mut map_str, "{}{}", if i != 0 { ", " } else { "" }, ('a' as u8 + i as u8) as char).unwrap();
1980 write!(&mut map_str, ")| (").unwrap();
1981 for (idx, e) in t.elems.iter().enumerate() {
1982 if let syn::Type::Reference(_) = e {
1983 write!(&mut map_str, "{}{}", if idx != 0 { ", " } else { "" }, (idx as u8 + 'a' as u8) as char).unwrap();
1984 } else if let syn::Type::Path(_) = e {
1985 write!(&mut map_str, "{}*{}", if idx != 0 { ", " } else { "" }, (idx as u8 + 'a' as u8) as char).unwrap();
1986 } else { unimplemented!(); }
1988 write!(&mut map_str, "))").unwrap();
1989 write!(w, "{}", sliceconv(false, Some(&String::from_utf8(map_str).unwrap()))).unwrap();
1991 write!(w, "{}", sliceconv(false, None)).unwrap();
1994 } else { unimplemented!(); }
1996 syn::Type::Tuple(t) => {
1997 if t.elems.is_empty() {
1998 // cbindgen has poor support for (), see, eg https://github.com/eqrion/cbindgen/issues/527
1999 // so work around it by just pretending its a 0u8
2000 write!(w, "{}", tupleconv).unwrap();
2002 if prefix { write!(w, "local_").unwrap(); }
2005 _ => unimplemented!(),
2009 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) {
2010 self.write_conversion_inline_intern(w, t, generics, is_ref, false, ptr_for_ref, "() /*", true, |_, _| "local_".to_owned(),
2011 |a, b, c| self.to_c_conversion_inline_prefix_from_path(a, b, c),
2012 |w, decl_type, decl_path, is_ref, _is_mut| {
2014 DeclType::MirroredEnum if is_ref && ptr_for_ref => write!(w, "crate::{}::from_native(", decl_path).unwrap(),
2015 DeclType::MirroredEnum if is_ref => write!(w, "&crate::{}::from_native(", decl_path).unwrap(),
2016 DeclType::MirroredEnum => write!(w, "crate::{}::native_into(", decl_path).unwrap(),
2017 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if is_ref && from_ptr => {
2018 if !ptr_for_ref { write!(w, "&").unwrap(); }
2019 write!(w, "crate::{} {{ inner: unsafe {{ (", decl_path).unwrap()
2021 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if is_ref => {
2022 if !ptr_for_ref { write!(w, "&").unwrap(); }
2023 write!(w, "crate::{} {{ inner: unsafe {{ ObjOps::nonnull_ptr_to_inner((", decl_path).unwrap()
2025 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref && from_ptr =>
2026 write!(w, "crate::{} {{ inner: ", decl_path).unwrap(),
2027 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref =>
2028 write!(w, "crate::{} {{ inner: ObjOps::heap_alloc(", decl_path).unwrap(),
2029 DeclType::Trait(_) if is_ref => write!(w, "").unwrap(),
2030 DeclType::Trait(_) if !is_ref => write!(w, "Into::into(").unwrap(),
2031 _ => panic!("{:?}", decl_path),
2035 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) {
2036 self.write_to_c_conversion_inline_prefix_inner(w, t, generics, false, ptr_for_ref, false);
2038 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) {
2039 self.write_conversion_inline_intern(w, t, generics, is_ref, false, ptr_for_ref, "*/", false, |_, _| ".into()".to_owned(),
2040 |a, b, c| self.to_c_conversion_inline_suffix_from_path(a, b, c),
2041 |w, decl_type, full_path, is_ref, _is_mut| match decl_type {
2042 DeclType::MirroredEnum => write!(w, ")").unwrap(),
2043 DeclType::EnumIgnored { generics }|DeclType::StructImported { generics } if is_ref => {
2044 write!(w, " as *const {}<", full_path).unwrap();
2045 for param in generics.params.iter() {
2046 if let syn::GenericParam::Lifetime(_) = param {
2047 write!(w, "'_, ").unwrap();
2049 write!(w, "_, ").unwrap();
2053 write!(w, ">) as *mut _ }}, is_owned: false }}").unwrap();
2055 write!(w, ">) as *mut _) }}, is_owned: false }}").unwrap();
2058 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref && from_ptr =>
2059 write!(w, ", is_owned: true }}").unwrap(),
2060 DeclType::EnumIgnored {..}|DeclType::StructImported {..} if !is_ref => write!(w, "), is_owned: true }}").unwrap(),
2061 DeclType::Trait(_) if is_ref => {},
2062 DeclType::Trait(_) => {
2063 // This is used when we're converting a concrete Rust type into a C trait
2064 // for use when a Rust trait method returns an associated type.
2065 // Because all of our C traits implement From<RustTypesImplementingTraits>
2066 // we can just call .into() here and be done.
2067 write!(w, ")").unwrap()
2069 _ => unimplemented!(),
2072 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) {
2073 self.write_to_c_conversion_inline_suffix_inner(w, t, generics, false, ptr_for_ref, false);
2076 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) {
2077 self.write_conversion_inline_intern(w, t, generics, is_ref, false, false, "() /*", true, |_, _| "&local_".to_owned(),
2078 |a, b, _c| self.from_c_conversion_prefix_from_path(a, b),
2079 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
2080 DeclType::StructImported {..} if is_ref => write!(w, "").unwrap(),
2081 DeclType::StructImported {..} if !is_ref => write!(w, "*unsafe {{ Box::from_raw(").unwrap(),
2082 DeclType::MirroredEnum if is_ref => write!(w, "&").unwrap(),
2083 DeclType::MirroredEnum => {},
2084 DeclType::Trait(_) => {},
2085 _ => unimplemented!(),
2088 pub fn write_from_c_conversion_prefix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2089 self.write_from_c_conversion_prefix_inner(w, t, generics, false, false);
2091 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) {
2092 self.write_conversion_inline_intern(w, t, generics, is_ref, false, false, "*/", false,
2093 |has_inner, map_str_opt| match (has_inner, map_str_opt) {
2094 (false, Some(map_str)) => format!(".iter(){}.collect::<Vec<_>>()[..]", map_str),
2095 (false, None) => ".iter().collect::<Vec<_>>()[..]".to_owned(),
2096 (true, None) => "[..]".to_owned(),
2097 (true, Some(_)) => unreachable!(),
2099 |a, b, _c| self.from_c_conversion_suffix_from_path(a, b),
2100 |w, decl_type, _full_path, is_ref, is_mut| match decl_type {
2101 DeclType::StructImported {..} if is_ref && ptr_for_ref => write!(w, "XXX unimplemented").unwrap(),
2102 DeclType::StructImported {..} if is_mut && is_ref => write!(w, ".get_native_mut_ref()").unwrap(),
2103 DeclType::StructImported {..} if is_ref => write!(w, ".get_native_ref()").unwrap(),
2104 DeclType::StructImported {..} if !is_ref => write!(w, ".take_inner()) }}").unwrap(),
2105 DeclType::MirroredEnum if is_ref => write!(w, ".to_native()").unwrap(),
2106 DeclType::MirroredEnum => write!(w, ".into_native()").unwrap(),
2107 DeclType::Trait(_) => {},
2108 _ => unimplemented!(),
2111 pub fn write_from_c_conversion_suffix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2112 self.write_from_c_conversion_suffix_inner(w, t, generics, false, false);
2114 // Note that compared to the above conversion functions, the following two are generally
2115 // significantly undertested:
2116 pub fn write_from_c_conversion_to_ref_prefix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2117 self.write_conversion_inline_intern(w, t, generics, false, false, false, "() /*", true, |_, _| "&local_".to_owned(),
2119 if let Some(conv) = self.from_c_conversion_prefix_from_path(a, b) {
2120 Some(format!("&{}", conv))
2123 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
2124 DeclType::StructImported {..} if !is_ref => write!(w, "").unwrap(),
2125 _ => unimplemented!(),
2128 pub fn write_from_c_conversion_to_ref_suffix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
2129 self.write_conversion_inline_intern(w, t, generics, false, false, false, "*/", false,
2130 |has_inner, map_str_opt| match (has_inner, map_str_opt) {
2131 (false, Some(map_str)) => format!(".iter(){}.collect::<Vec<_>>()[..]", map_str),
2132 (false, None) => ".iter().collect::<Vec<_>>()[..]".to_owned(),
2133 (true, None) => "[..]".to_owned(),
2134 (true, Some(_)) => unreachable!(),
2136 |a, b, _c| self.from_c_conversion_suffix_from_path(a, b),
2137 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
2138 DeclType::StructImported {..} if !is_ref => write!(w, ".get_native_ref()").unwrap(),
2139 _ => unimplemented!(),
2143 fn write_conversion_new_var_intern<'b, W: std::io::Write,
2144 LP: Fn(&str, bool) -> Option<(&str, &str)>,
2145 LC: Fn(&str, bool, Option<&syn::Type>, &syn::Ident, &str) -> Option<(&'b str, Vec<(String, String)>, &'b str, ContainerPrefixLocation)>,
2146 VP: Fn(&mut W, &syn::Type, Option<&GenericTypes>, bool, bool, bool),
2147 VS: Fn(&mut W, &syn::Type, Option<&GenericTypes>, bool, bool, bool)>
2148 (&self, w: &mut W, ident: &syn::Ident, var: &str, t: &syn::Type, generics: Option<&GenericTypes>,
2149 mut is_ref: bool, mut ptr_for_ref: bool, to_c: bool, from_ownable_ref: bool,
2150 path_lookup: &LP, container_lookup: &LC, var_prefix: &VP, var_suffix: &VS) -> bool {
2152 macro_rules! convert_container {
2153 ($container_type: expr, $args_len: expr, $args_iter: expr) => { {
2154 // For slices (and Options), we refuse to directly map them as is_ref when they
2155 // aren't opaque types containing an inner pointer. This is due to the fact that,
2156 // in both cases, the actual higher-level type is non-is_ref.
2157 let ty_has_inner = if $args_len == 1 {
2158 let ty = $args_iter().next().unwrap();
2159 if $container_type == "Slice" && to_c {
2160 // "To C ptr_for_ref" means "return the regular object with is_owned
2161 // set to false", which is totally what we want in a slice if we're about to
2162 // set ty_has_inner.
2165 if let syn::Type::Reference(t) = ty {
2166 if let syn::Type::Path(p) = &*t.elem {
2167 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
2169 } else if let syn::Type::Path(p) = ty {
2170 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
2174 // Options get a bunch of special handling, since in general we map Option<>al
2175 // types into the same C type as non-Option-wrapped types. This ends up being
2176 // pretty manual here and most of the below special-cases are for Options.
2177 let mut needs_ref_map = false;
2178 let mut only_contained_type = None;
2179 let mut only_contained_type_nonref = None;
2180 let mut only_contained_has_inner = false;
2181 let mut contains_slice = false;
2183 only_contained_has_inner = ty_has_inner;
2184 let arg = $args_iter().next().unwrap();
2185 if let syn::Type::Reference(t) = arg {
2186 only_contained_type = Some(arg);
2187 only_contained_type_nonref = Some(&*t.elem);
2188 if let syn::Type::Path(_) = &*t.elem {
2190 } else if let syn::Type::Slice(_) = &*t.elem {
2191 contains_slice = true;
2192 } else { return false; }
2193 // If the inner element contains an inner pointer, we will just use that,
2194 // avoiding the need to map elements to references. Otherwise we'll need to
2195 // do an extra mapping step.
2196 needs_ref_map = !only_contained_has_inner && $container_type == "Option";
2198 only_contained_type = Some(arg);
2199 only_contained_type_nonref = Some(arg);
2203 if let Some((prefix, conversions, suffix, prefix_location)) = container_lookup(&$container_type, is_ref, only_contained_type, ident, var) {
2204 assert_eq!(conversions.len(), $args_len);
2205 write!(w, "let mut local_{}{} = ", ident,
2206 if (!to_c && needs_ref_map) || (to_c && $container_type == "Option" && contains_slice) {"_base"} else { "" }).unwrap();
2207 if prefix_location == ContainerPrefixLocation::OutsideConv {
2208 var_prefix(w, $args_iter().next().unwrap(), generics, is_ref, ptr_for_ref, true);
2210 write!(w, "{}{}", prefix, var).unwrap();
2212 for ((pfx, var_name), (idx, ty)) in conversions.iter().zip($args_iter().enumerate()) {
2213 let mut var = std::io::Cursor::new(Vec::new());
2214 write!(&mut var, "{}", var_name).unwrap();
2215 let var_access = String::from_utf8(var.into_inner()).unwrap();
2217 let conv_ty = if needs_ref_map { only_contained_type_nonref.as_ref().unwrap() } else { ty };
2219 write!(w, "{} {{ ", pfx).unwrap();
2220 let new_var_name = format!("{}_{}", ident, idx);
2221 let new_var = self.write_conversion_new_var_intern(w, &format_ident!("{}", new_var_name),
2222 &var_access, conv_ty, generics, contains_slice || (is_ref && ty_has_inner), ptr_for_ref,
2223 to_c, from_ownable_ref, path_lookup, container_lookup, var_prefix, var_suffix);
2224 if new_var { write!(w, " ").unwrap(); }
2226 if prefix_location == ContainerPrefixLocation::PerConv {
2227 var_prefix(w, conv_ty, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2228 } else if !is_ref && !needs_ref_map && to_c && only_contained_has_inner {
2229 write!(w, "ObjOps::heap_alloc(").unwrap();
2232 write!(w, "{}{}", if contains_slice && !to_c { "local_" } else { "" }, if new_var { new_var_name } else { var_access }).unwrap();
2233 if prefix_location == ContainerPrefixLocation::PerConv {
2234 var_suffix(w, conv_ty, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2235 } else if !is_ref && !needs_ref_map && to_c && only_contained_has_inner {
2236 write!(w, ")").unwrap();
2238 write!(w, " }}").unwrap();
2240 write!(w, "{}", suffix).unwrap();
2241 if prefix_location == ContainerPrefixLocation::OutsideConv {
2242 var_suffix(w, $args_iter().next().unwrap(), generics, is_ref, ptr_for_ref, true);
2244 write!(w, ";").unwrap();
2245 if !to_c && needs_ref_map {
2246 write!(w, " let mut local_{} = local_{}_base.as_ref()", ident, ident).unwrap();
2248 write!(w, ".map(|a| &a[..])").unwrap();
2250 write!(w, ";").unwrap();
2251 } else if to_c && $container_type == "Option" && contains_slice {
2252 write!(w, " let mut local_{} = *local_{}_base;", ident, ident).unwrap();
2259 match generics.resolve_type(t) {
2260 syn::Type::Reference(r) => {
2261 if let syn::Type::Slice(_) = &*r.elem {
2262 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)
2264 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)
2267 syn::Type::Path(p) => {
2268 if p.qself.is_some() {
2271 let resolved_path = self.resolve_path(&p.path, generics);
2272 if let Some(aliased_type) = self.crate_types.type_aliases.get(&resolved_path) {
2273 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);
2275 if self.is_known_container(&resolved_path, is_ref) || self.is_path_transparent_container(&p.path, generics, is_ref) {
2276 if let syn::PathArguments::AngleBracketed(args) = &p.path.segments.iter().next().unwrap().arguments {
2277 convert_container!(resolved_path, args.args.len(), || args.args.iter().map(|arg| {
2278 if let syn::GenericArgument::Type(ty) = arg {
2279 generics.resolve_type(ty)
2280 } else { unimplemented!(); }
2282 } else { unimplemented!(); }
2284 if self.is_primitive(&resolved_path) {
2286 } else if let Some(ty_ident) = single_ident_generic_path_to_ident(&p.path) {
2287 if let Some((prefix, suffix)) = path_lookup(&resolved_path, is_ref) {
2288 write!(w, "let mut local_{} = {}{}{};", ident, prefix, var, suffix).unwrap();
2290 } else if self.types.maybe_resolve_declared(ty_ident).is_some() {
2295 syn::Type::Array(_) => {
2296 // We assume all arrays contain only primitive types.
2297 // This may result in some outputs not compiling.
2300 syn::Type::Slice(s) => {
2301 if let syn::Type::Path(p) = &*s.elem {
2302 let resolved = self.resolve_path(&p.path, generics);
2303 if self.is_primitive(&resolved) {
2304 let slice_path = format!("[{}]", resolved);
2305 if let Some((prefix, suffix)) = path_lookup(&slice_path, true) {
2306 write!(w, "let mut local_{} = {}{}{};", ident, prefix, var, suffix).unwrap();
2310 let tyref = [&*s.elem];
2312 // If we're converting from a slice to a Vec, assume we can clone the
2313 // elements and clone them into a new Vec first. Next we'll walk the
2314 // new Vec here and convert them to C types.
2315 write!(w, "let mut local_{}_clone = Vec::new(); local_{}_clone.extend_from_slice({}); let mut {} = local_{}_clone; ", ident, ident, ident, ident, ident).unwrap();
2318 convert_container!("Vec", 1, || tyref.iter().map(|t| generics.resolve_type(*t)));
2319 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2321 } else if let syn::Type::Reference(ty) = &*s.elem {
2322 let tyref = if from_ownable_ref || !to_c { [&*ty.elem] } else { [&*s.elem] };
2324 convert_container!("Slice", 1, || tyref.iter().map(|t| generics.resolve_type(*t)));
2325 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2326 } else if let syn::Type::Tuple(t) = &*s.elem {
2327 // When mapping into a temporary new var, we need to own all the underlying objects.
2328 // Thus, we drop any references inside the tuple and convert with non-reference types.
2329 let mut elems = syn::punctuated::Punctuated::new();
2330 for elem in t.elems.iter() {
2331 if let syn::Type::Reference(r) = elem {
2332 elems.push((*r.elem).clone());
2334 elems.push(elem.clone());
2337 let ty = [syn::Type::Tuple(syn::TypeTuple {
2338 paren_token: t.paren_token, elems
2342 convert_container!("Slice", 1, || ty.iter());
2343 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
2344 } else { unimplemented!() }
2346 syn::Type::Tuple(t) => {
2347 if !t.elems.is_empty() {
2348 // We don't (yet) support tuple elements which cannot be converted inline
2349 write!(w, "let (").unwrap();
2350 for idx in 0..t.elems.len() {
2351 if idx != 0 { write!(w, ", ").unwrap(); }
2352 write!(w, "{} orig_{}_{}", if is_ref { "ref" } else { "mut" }, ident, idx).unwrap();
2354 write!(w, ") = {}{}; ", var, if !to_c { ".to_rust()" } else { "" }).unwrap();
2355 // Like other template types, tuples are always mapped as their non-ref
2356 // versions for types which have different ref mappings. Thus, we convert to
2357 // non-ref versions and handle opaque types with inner pointers manually.
2358 for (idx, elem) in t.elems.iter().enumerate() {
2359 if let syn::Type::Path(p) = elem {
2360 let v_name = format!("orig_{}_{}", ident, idx);
2361 let tuple_elem_ident = format_ident!("{}", &v_name);
2362 if self.write_conversion_new_var_intern(w, &tuple_elem_ident, &v_name, elem, generics,
2363 false, ptr_for_ref, to_c, from_ownable_ref,
2364 path_lookup, container_lookup, var_prefix, var_suffix) {
2365 write!(w, " ").unwrap();
2366 // Opaque types with inner pointers shouldn't ever create new stack
2367 // variables, so we don't handle it and just assert that it doesn't
2369 assert!(!self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)));
2373 write!(w, "let mut local_{} = (", ident).unwrap();
2374 for (idx, elem) in t.elems.iter().enumerate() {
2375 let real_elem = generics.resolve_type(&elem);
2376 let ty_has_inner = {
2378 // "To C ptr_for_ref" means "return the regular object with
2379 // is_owned set to false", which is totally what we want
2380 // if we're about to set ty_has_inner.
2383 if let syn::Type::Reference(t) = real_elem {
2384 if let syn::Type::Path(p) = &*t.elem {
2385 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
2387 } else if let syn::Type::Path(p) = real_elem {
2388 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
2391 if idx != 0 { write!(w, ", ").unwrap(); }
2392 var_prefix(w, real_elem, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2393 if is_ref && ty_has_inner {
2394 // For ty_has_inner, the regular var_prefix mapping will take a
2395 // reference, so deref once here to make sure we keep the original ref.
2396 write!(w, "*").unwrap();
2398 write!(w, "orig_{}_{}", ident, idx).unwrap();
2399 if is_ref && !ty_has_inner {
2400 // If we don't have an inner variable's reference to maintain, just
2401 // hope the type is Clonable and use that.
2402 write!(w, ".clone()").unwrap();
2404 var_suffix(w, real_elem, generics, is_ref && ty_has_inner, ptr_for_ref, false);
2406 write!(w, "){};", if to_c { ".into()" } else { "" }).unwrap();
2410 _ => unimplemented!(),
2414 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 {
2415 self.write_conversion_new_var_intern(w, ident, var_access, t, generics, from_ownable_ref, ptr_for_ref, true, from_ownable_ref,
2416 &|a, b| self.to_c_conversion_new_var_from_path(a, b),
2417 &|a, b, c, d, e| self.to_c_conversion_container_new_var(generics, a, b, c, d, e),
2418 // We force ptr_for_ref here since we can't generate a ref on one line and use it later
2419 &|a, b, c, d, e, f| self.write_to_c_conversion_inline_prefix_inner(a, b, c, d, e, f),
2420 &|a, b, c, d, e, f| self.write_to_c_conversion_inline_suffix_inner(a, b, c, d, e, f))
2422 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 {
2423 self.write_to_c_conversion_new_var_inner(w, ident, &format!("{}", ident), t, generics, ptr_for_ref, false)
2425 /// Prints new-var conversion for an "ownable_ref" type, ie prints conversion for
2426 /// `create_ownable_reference(t)`, not `t` itself.
2427 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 {
2428 self.write_to_c_conversion_new_var_inner(w, ident, &format!("{}", ident), t, generics, true, true)
2430 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 {
2431 self.write_conversion_new_var_intern(w, ident, &format!("{}", ident), t, generics, false, false, false, false,
2432 &|a, b| self.from_c_conversion_new_var_from_path(a, b),
2433 &|a, b, c, d, e| self.from_c_conversion_container_new_var(generics, a, b, c, d, e),
2434 // We force ptr_for_ref here since we can't generate a ref on one line and use it later
2435 &|a, b, c, d, e, _f| self.write_from_c_conversion_prefix_inner(a, b, c, d, e),
2436 &|a, b, c, d, e, _f| self.write_from_c_conversion_suffix_inner(a, b, c, d, e))
2439 // ******************************************************
2440 // *** C Container Type Equivalent and alias Printing ***
2441 // ******************************************************
2443 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 {
2444 for (idx, t) in args.enumerate() {
2446 write!(w, ", ").unwrap();
2448 if let syn::Type::Reference(r_arg) = t {
2449 assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
2451 if !self.write_c_type_intern(w, &*r_arg.elem, generics, false, false, false, true, true) { return false; }
2453 // While write_c_type_intern, above is correct, we don't want to blindly convert a
2454 // reference to something stupid, so check that the container is either opaque or a
2455 // predefined type (currently only Transaction).
2456 if let syn::Type::Path(p_arg) = &*r_arg.elem {
2457 let resolved = self.resolve_path(&p_arg.path, generics);
2458 assert!(self.crate_types.opaques.get(&resolved).is_some() ||
2459 self.c_type_from_path(&resolved, true, true).is_some(), "Template generics should be opaque or have a predefined mapping");
2460 } else { unimplemented!(); }
2461 } else if let syn::Type::Path(p_arg) = t {
2462 if let Some(resolved) = self.maybe_resolve_path(&p_arg.path, generics) {
2463 if !self.is_primitive(&resolved) {
2464 assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
2467 assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
2469 if !self.write_c_type_intern(w, t, generics, false, false, false, true, true) { return false; }
2471 // We don't currently support outer reference types for non-primitive inners,
2472 // except for the empty tuple.
2473 if let syn::Type::Tuple(t_arg) = t {
2474 assert!(t_arg.elems.len() == 0 || !is_ref);
2478 if !self.write_c_type_intern(w, t, generics, false, false, false, true, true) { return false; }
2483 fn check_create_container(&self, mangled_container: String, container_type: &str, args: Vec<&syn::Type>, generics: Option<&GenericTypes>, is_ref: bool) -> bool {
2484 if !self.crate_types.templates_defined.borrow().get(&mangled_container).is_some() {
2485 let mut created_container: Vec<u8> = Vec::new();
2487 if container_type == "Result" {
2488 let mut a_ty: Vec<u8> = Vec::new();
2489 if let syn::Type::Tuple(tup) = args.iter().next().unwrap() {
2490 if tup.elems.is_empty() {
2491 write!(&mut a_ty, "()").unwrap();
2493 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t).take(1), generics, is_ref) { return false; }
2496 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t).take(1), generics, is_ref) { return false; }
2499 let mut b_ty: Vec<u8> = Vec::new();
2500 if let syn::Type::Tuple(tup) = args.iter().skip(1).next().unwrap() {
2501 if tup.elems.is_empty() {
2502 write!(&mut b_ty, "()").unwrap();
2504 if !self.write_template_generics(&mut b_ty, &mut args.iter().map(|t| *t).skip(1), generics, is_ref) { return false; }
2507 if !self.write_template_generics(&mut b_ty, &mut args.iter().map(|t| *t).skip(1), generics, is_ref) { return false; }
2510 let ok_str = String::from_utf8(a_ty).unwrap();
2511 let err_str = String::from_utf8(b_ty).unwrap();
2512 let is_clonable = self.is_clonable(&ok_str) && self.is_clonable(&err_str);
2513 write_result_block(&mut created_container, &mangled_container, &ok_str, &err_str, is_clonable);
2515 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2517 } else if container_type == "Vec" {
2518 let mut a_ty: Vec<u8> = Vec::new();
2519 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t), generics, is_ref) { return false; }
2520 let ty = String::from_utf8(a_ty).unwrap();
2521 let is_clonable = self.is_clonable(&ty);
2522 write_vec_block(&mut created_container, &mangled_container, &ty, is_clonable);
2524 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2526 } else if container_type.ends_with("Tuple") {
2527 let mut tuple_args = Vec::new();
2528 let mut is_clonable = true;
2529 for arg in args.iter() {
2530 let mut ty: Vec<u8> = Vec::new();
2531 if !self.write_template_generics(&mut ty, &mut [arg].iter().map(|t| **t), generics, is_ref) { return false; }
2532 let ty_str = String::from_utf8(ty).unwrap();
2533 if !self.is_clonable(&ty_str) {
2534 is_clonable = false;
2536 tuple_args.push(ty_str);
2538 write_tuple_block(&mut created_container, &mangled_container, &tuple_args, is_clonable);
2540 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2542 } else if container_type == "Option" {
2543 let mut a_ty: Vec<u8> = Vec::new();
2544 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t), generics, is_ref) { return false; }
2545 let ty = String::from_utf8(a_ty).unwrap();
2546 let is_clonable = self.is_clonable(&ty);
2547 write_option_block(&mut created_container, &mangled_container, &ty, is_clonable);
2549 self.crate_types.set_clonable(Self::generated_container_path().to_owned() + "::" + &mangled_container);
2554 self.crate_types.write_new_template(mangled_container.clone(), true, &created_container);
2558 fn path_to_generic_args(path: &syn::Path) -> Vec<&syn::Type> {
2559 if let syn::PathArguments::AngleBracketed(args) = &path.segments.iter().next().unwrap().arguments {
2560 args.args.iter().map(|gen| if let syn::GenericArgument::Type(t) = gen { t } else { unimplemented!() }).collect()
2561 } else { unimplemented!(); }
2563 fn write_c_mangled_container_path_intern<W: std::io::Write>
2564 (&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 {
2565 let mut mangled_type: Vec<u8> = Vec::new();
2566 if !self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) {
2567 write!(w, "C{}_", ident).unwrap();
2568 write!(mangled_type, "C{}_", ident).unwrap();
2569 } else { assert_eq!(args.len(), 1); }
2570 for arg in args.iter() {
2571 macro_rules! write_path {
2572 ($p_arg: expr, $extra_write: expr) => {
2573 if let Some(subtype) = self.maybe_resolve_path(&$p_arg.path, generics) {
2574 if self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) {
2576 if self.c_type_has_inner_from_path(&subtype) {
2577 if !self.write_c_path_intern(w, &$p_arg.path, generics, is_ref, is_mut, ptr_for_ref, false, true) { return false; }
2579 if let Some(arr_ty) = self.is_real_type_array(&subtype) {
2580 if !self.write_c_type_intern(w, &arr_ty, generics, false, true, false, false, true) { return false; }
2582 // Option<T> needs to be converted to a *mut T, ie mut ptr-for-ref
2583 if !self.write_c_path_intern(w, &$p_arg.path, generics, true, true, true, false, true) { return false; }
2587 write!(w, "{}", $p_arg.path.segments.last().unwrap().ident).unwrap();
2589 } else if self.is_known_container(&subtype, is_ref) || self.is_path_transparent_container(&$p_arg.path, generics, is_ref) {
2590 if !self.write_c_mangled_container_path_intern(w, Self::path_to_generic_args(&$p_arg.path), generics,
2591 &subtype, is_ref, is_mut, ptr_for_ref, true) {
2594 self.write_c_mangled_container_path_intern(&mut mangled_type, Self::path_to_generic_args(&$p_arg.path),
2595 generics, &subtype, is_ref, is_mut, ptr_for_ref, true);
2596 if let Some(w2) = $extra_write as Option<&mut Vec<u8>> {
2597 self.write_c_mangled_container_path_intern(w2, Self::path_to_generic_args(&$p_arg.path),
2598 generics, &subtype, is_ref, is_mut, ptr_for_ref, true);
2601 let id = subtype.rsplitn(2, ':').next().unwrap(); // Get the "Base" name of the resolved type
2602 write!(w, "{}", id).unwrap();
2603 write!(mangled_type, "{}", id).unwrap();
2604 if let Some(w2) = $extra_write as Option<&mut Vec<u8>> {
2605 write!(w2, "{}", id).unwrap();
2608 } else { return false; }
2611 match generics.resolve_type(arg) {
2612 syn::Type::Tuple(tuple) => {
2613 if tuple.elems.len() == 0 {
2614 write!(w, "None").unwrap();
2615 write!(mangled_type, "None").unwrap();
2617 let mut mangled_tuple_type: Vec<u8> = Vec::new();
2619 // Figure out what the mangled type should look like. To disambiguate
2620 // ((A, B), C) and (A, B, C) we prefix the generic args with a _ and suffix
2621 // them with a Z. Ideally we wouldn't use Z, but not many special chars are
2622 // available for use in type names.
2623 write!(w, "C{}Tuple_", tuple.elems.len()).unwrap();
2624 write!(mangled_type, "C{}Tuple_", tuple.elems.len()).unwrap();
2625 write!(mangled_tuple_type, "C{}Tuple_", tuple.elems.len()).unwrap();
2626 for elem in tuple.elems.iter() {
2627 if let syn::Type::Path(p) = elem {
2628 write_path!(p, Some(&mut mangled_tuple_type));
2629 } else if let syn::Type::Reference(refelem) = elem {
2630 if let syn::Type::Path(p) = &*refelem.elem {
2631 write_path!(p, Some(&mut mangled_tuple_type));
2632 } else { return false; }
2633 } else { return false; }
2635 write!(w, "Z").unwrap();
2636 write!(mangled_type, "Z").unwrap();
2637 write!(mangled_tuple_type, "Z").unwrap();
2638 if !self.check_create_container(String::from_utf8(mangled_tuple_type).unwrap(),
2639 &format!("{}Tuple", tuple.elems.len()), tuple.elems.iter().collect(), generics, is_ref) {
2644 syn::Type::Path(p_arg) => {
2645 write_path!(p_arg, None);
2647 syn::Type::Reference(refty) => {
2648 if let syn::Type::Path(p_arg) = &*refty.elem {
2649 write_path!(p_arg, None);
2650 } else if let syn::Type::Slice(_) = &*refty.elem {
2651 // write_c_type will actually do exactly what we want here, we just need to
2652 // make it a pointer so that its an option. Note that we cannot always convert
2653 // the Vec-as-slice (ie non-ref types) containers, so sometimes need to be able
2654 // to edit it, hence we use *mut here instead of *const.
2655 if args.len() != 1 { return false; }
2656 write!(w, "*mut ").unwrap();
2657 self.write_c_type(w, arg, None, true);
2658 } else { return false; }
2660 syn::Type::Array(a) => {
2661 if let syn::Type::Path(p_arg) = &*a.elem {
2662 let resolved = self.resolve_path(&p_arg.path, generics);
2663 if !self.is_primitive(&resolved) { return false; }
2664 if let syn::Expr::Lit(syn::ExprLit { lit: syn::Lit::Int(len), .. }) = &a.len {
2665 if self.c_type_from_path(&format!("[{}; {}]", resolved, len.base10_digits()), is_ref, ptr_for_ref).is_none() { return false; }
2666 if in_type || args.len() != 1 {
2667 write!(w, "_{}{}", resolved, len.base10_digits()).unwrap();
2668 write!(mangled_type, "_{}{}", resolved, len.base10_digits()).unwrap();
2670 let arrty = format!("[{}; {}]", resolved, len.base10_digits());
2671 let realty = self.c_type_from_path(&arrty, is_ref, ptr_for_ref).unwrap_or(&arrty);
2672 write!(w, "{}", realty).unwrap();
2673 write!(mangled_type, "{}", realty).unwrap();
2675 } else { return false; }
2676 } else { return false; }
2678 _ => { return false; },
2681 if self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) { return true; }
2682 // Push the "end of type" Z
2683 write!(w, "Z").unwrap();
2684 write!(mangled_type, "Z").unwrap();
2686 // Make sure the type is actually defined:
2687 self.check_create_container(String::from_utf8(mangled_type).unwrap(), ident, args, generics, is_ref)
2689 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 {
2690 if !self.is_transparent_container(ident, is_ref, args.iter().map(|a| *a), generics) {
2691 write!(w, "{}::", Self::generated_container_path()).unwrap();
2693 self.write_c_mangled_container_path_intern(w, args, generics, ident, is_ref, is_mut, ptr_for_ref, false)
2695 pub fn get_c_mangled_container_type(&self, args: Vec<&syn::Type>, generics: Option<&GenericTypes>, template_name: &str) -> Option<String> {
2696 let mut out = Vec::new();
2697 if !self.write_c_mangled_container_path(&mut out, args, generics, template_name, false, false, false) {
2700 Some(String::from_utf8(out).unwrap())
2703 // **********************************
2704 // *** C Type Equivalent Printing ***
2705 // **********************************
2707 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 {
2708 let full_path = match self.maybe_resolve_path(&path, generics) {
2709 Some(path) => path, None => return false };
2710 if let Some(c_type) = self.c_type_from_path(&full_path, is_ref, ptr_for_ref) {
2711 write!(w, "{}", c_type).unwrap();
2713 } else if self.crate_types.traits.get(&full_path).is_some() {
2714 // Note that we always use the crate:: prefix here as we are always referring to a
2715 // concrete object which is of the generated type, it just implements the upstream
2717 if is_ref && ptr_for_ref {
2718 write!(w, "*{} crate::{}", if is_mut { "mut" } else { "const" }, full_path).unwrap();
2720 if with_ref_lifetime { unimplemented!(); }
2721 write!(w, "&{}crate::{}", if is_mut { "mut " } else { "" }, full_path).unwrap();
2723 write!(w, "crate::{}", full_path).unwrap();
2726 } else if self.crate_types.opaques.get(&full_path).is_some() || self.crate_types.mirrored_enums.get(&full_path).is_some() {
2727 let crate_pfx = if c_ty { "crate::" } else { "" };
2728 if is_ref && ptr_for_ref {
2729 // ptr_for_ref implies we're returning the object, which we can't really do for
2730 // opaque or mirrored types without box'ing them, which is quite a waste, so return
2731 // the actual object itself (for opaque types we'll set the pointer to the actual
2732 // type and note that its a reference).
2733 write!(w, "{}{}", crate_pfx, full_path).unwrap();
2734 } else if is_ref && with_ref_lifetime {
2736 // If we're concretizing something with a lifetime parameter, we have to pick a
2737 // lifetime, of which the only real available choice is `static`, obviously.
2738 write!(w, "&'static {}", crate_pfx).unwrap();
2740 self.write_rust_path(w, generics, path);
2742 // We shouldn't be mapping references in types, so panic here
2746 write!(w, "&{}{}{}", if is_mut { "mut " } else { "" }, crate_pfx, full_path).unwrap();
2748 write!(w, "{}{}", crate_pfx, full_path).unwrap();
2755 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 {
2756 match generics.resolve_type(t) {
2757 syn::Type::Path(p) => {
2758 if p.qself.is_some() {
2761 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
2762 if self.is_known_container(&full_path, is_ref) || self.is_path_transparent_container(&p.path, generics, is_ref) {
2763 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);
2765 if let Some(aliased_type) = self.crate_types.type_aliases.get(&full_path).cloned() {
2766 return self.write_c_type_intern(w, &aliased_type, None, is_ref, is_mut, ptr_for_ref, with_ref_lifetime, c_ty);
2769 self.write_c_path_intern(w, &p.path, generics, is_ref, is_mut, ptr_for_ref, with_ref_lifetime, c_ty)
2771 syn::Type::Reference(r) => {
2772 self.write_c_type_intern(w, &*r.elem, generics, true, r.mutability.is_some(), ptr_for_ref, with_ref_lifetime, c_ty)
2774 syn::Type::Array(a) => {
2775 if is_ref && is_mut {
2776 write!(w, "*mut [").unwrap();
2777 if !self.write_c_type_intern(w, &a.elem, generics, false, false, ptr_for_ref, with_ref_lifetime, c_ty) { return false; }
2779 write!(w, "*const [").unwrap();
2780 if !self.write_c_type_intern(w, &a.elem, generics, false, false, ptr_for_ref, with_ref_lifetime, c_ty) { return false; }
2782 let mut typecheck = Vec::new();
2783 if !self.write_c_type_intern(&mut typecheck, &a.elem, generics, false, false, ptr_for_ref, with_ref_lifetime, c_ty) { return false; }
2784 if typecheck[..] != ['u' as u8, '8' as u8] { return false; }
2786 if let syn::Expr::Lit(l) = &a.len {
2787 if let syn::Lit::Int(i) = &l.lit {
2789 if let Some(ty) = self.c_type_from_path(&format!("[u8; {}]", i.base10_digits()), false, ptr_for_ref) {
2790 write!(w, "{}", ty).unwrap();
2794 write!(w, "; {}]", i).unwrap();
2800 syn::Type::Slice(s) => {
2801 if !is_ref || is_mut { return false; }
2802 if let syn::Type::Path(p) = &*s.elem {
2803 let resolved = self.resolve_path(&p.path, generics);
2804 if self.is_primitive(&resolved) {
2805 write!(w, "{}::{}slice", Self::container_templ_path(), resolved).unwrap();
2808 let mut inner_c_ty = Vec::new();
2809 assert!(self.write_c_path_intern(&mut inner_c_ty, &p.path, generics, true, false, ptr_for_ref, with_ref_lifetime, c_ty));
2810 if self.is_clonable(&String::from_utf8(inner_c_ty).unwrap()) {
2811 if let Some(id) = p.path.get_ident() {
2812 let mangled_container = format!("CVec_{}Z", id);
2813 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
2814 self.check_create_container(mangled_container, "Vec", vec![&*s.elem], generics, false)
2818 } else if let syn::Type::Reference(r) = &*s.elem {
2819 if let syn::Type::Path(p) = &*r.elem {
2820 // Slices with "real types" inside are mapped as the equivalent non-ref Vec
2821 let resolved = self.resolve_path(&p.path, generics);
2822 let mangled_container = if let Some((ident, _)) = self.crate_types.opaques.get(&resolved) {
2823 format!("CVec_{}Z", ident)
2824 } else if let Some(en) = self.crate_types.mirrored_enums.get(&resolved) {
2825 format!("CVec_{}Z", en.ident)
2826 } else if let Some(id) = p.path.get_ident() {
2827 format!("CVec_{}Z", id)
2828 } else { return false; };
2829 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
2830 self.check_create_container(mangled_container, "Vec", vec![&*r.elem], generics, false)
2831 } else if let syn::Type::Slice(sl2) = &*r.elem {
2832 if let syn::Type::Reference(r2) = &*sl2.elem {
2833 if let syn::Type::Path(p) = &*r2.elem {
2834 // Slices with slices with opaque types (with is_owned flags) are mapped as non-ref Vecs
2835 let resolved = self.resolve_path(&p.path, generics);
2836 let mangled_container = if let Some((ident, _)) = self.crate_types.opaques.get(&resolved) {
2837 format!("CVec_CVec_{}ZZ", ident)
2838 } else { return false; };
2839 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
2840 let inner = &r2.elem;
2841 let vec_ty: syn::Type = syn::parse_quote!(Vec<#inner>);
2842 self.check_create_container(mangled_container, "Vec", vec![&vec_ty], generics, false)
2846 } else if let syn::Type::Tuple(_) = &*s.elem {
2847 let mut args = syn::punctuated::Punctuated::<_, syn::token::Comma>::new();
2848 args.push(syn::GenericArgument::Type((*s.elem).clone()));
2849 let mut segments = syn::punctuated::Punctuated::new();
2850 segments.push(parse_quote!(Vec<#args>));
2851 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)
2854 syn::Type::Tuple(t) => {
2855 if t.elems.len() == 0 {
2858 self.write_c_mangled_container_path(w, t.elems.iter().collect(), generics,
2859 &format!("{}Tuple", t.elems.len()), is_ref, is_mut, ptr_for_ref)
2865 pub fn write_c_type<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, ptr_for_ref: bool) {
2866 assert!(self.write_c_type_intern(w, t, generics, false, false, ptr_for_ref, false, true));
2868 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) {
2869 assert!(self.write_c_type_intern(w, t, generics, false, false, ptr_for_ref, true, false));
2871 pub fn understood_c_path(&self, p: &syn::Path) -> bool {
2872 self.write_c_path_intern(&mut std::io::sink(), p, None, false, false, false, false, true)
2874 pub fn understood_c_type(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> bool {
2875 self.write_c_type_intern(&mut std::io::sink(), t, generics, false, false, false, false, true)