1 use std::collections::{HashMap, HashSet};
8 use proc_macro2::{TokenTree, Span};
10 // The following utils are used purely to build our known types maps - they break down all the
11 // types we need to resolve to include the given object, and no more.
13 pub fn first_seg_self<'a>(t: &'a syn::Type) -> Option<impl Iterator<Item=&syn::PathSegment> + 'a> {
15 syn::Type::Path(p) => {
16 if p.qself.is_some() || p.path.leading_colon.is_some() {
19 let mut segs = p.path.segments.iter();
20 let ty = segs.next().unwrap();
21 if !ty.arguments.is_empty() { return None; }
22 if format!("{}", ty.ident) == "Self" {
30 pub fn get_single_remaining_path_seg<'a, I: Iterator<Item=&'a syn::PathSegment>>(segs: &mut I) -> Option<&'a syn::Ident> {
31 if let Some(ty) = segs.next() {
32 if !ty.arguments.is_empty() { unimplemented!(); }
33 if segs.next().is_some() { return None; }
38 pub fn single_ident_generic_path_to_ident(p: &syn::Path) -> Option<&syn::Ident> {
39 if p.segments.len() == 1 {
40 Some(&p.segments.iter().next().unwrap().ident)
44 pub fn path_matches_nongeneric(p: &syn::Path, exp: &[&str]) -> bool {
45 if p.segments.len() != exp.len() { return false; }
46 for (seg, e) in p.segments.iter().zip(exp.iter()) {
47 if seg.arguments != syn::PathArguments::None { return false; }
48 if &format!("{}", seg.ident) != *e { return false; }
53 #[derive(Debug, PartialEq)]
54 pub enum ExportStatus {
59 /// Gets the ExportStatus of an object (struct, fn, etc) given its attributes.
60 pub fn export_status(attrs: &[syn::Attribute]) -> ExportStatus {
61 for attr in attrs.iter() {
62 let tokens_clone = attr.tokens.clone();
63 let mut token_iter = tokens_clone.into_iter();
64 if let Some(token) = token_iter.next() {
66 TokenTree::Punct(c) if c.as_char() == '=' => {
67 // Really not sure where syn gets '=' from here -
68 // it somehow represents '///' or '//!'
70 TokenTree::Group(g) => {
71 if format!("{}", single_ident_generic_path_to_ident(&attr.path).unwrap()) == "cfg" {
72 let mut iter = g.stream().into_iter();
73 if let TokenTree::Ident(i) = iter.next().unwrap() {
75 // #[cfg(any(test, feature = ""))]
76 if let TokenTree::Group(g) = iter.next().unwrap() {
77 if let TokenTree::Ident(i) = g.stream().into_iter().next().unwrap() {
78 if i == "test" || i == "feature" {
79 // If its cfg(feature(...)) we assume its test-only
80 return ExportStatus::TestOnly;
84 } else if i == "test" || i == "feature" {
85 // If its cfg(feature(...)) we assume its test-only
86 return ExportStatus::TestOnly;
90 continue; // eg #[derive()]
92 _ => unimplemented!(),
95 match token_iter.next().unwrap() {
96 TokenTree::Literal(lit) => {
97 let line = format!("{}", lit);
98 if line.contains("(C-not exported)") {
99 return ExportStatus::NoExport;
102 _ => unimplemented!(),
108 pub fn assert_simple_bound(bound: &syn::TraitBound) {
109 if bound.paren_token.is_some() || bound.lifetimes.is_some() { unimplemented!(); }
110 if let syn::TraitBoundModifier::Maybe(_) = bound.modifier { unimplemented!(); }
113 /// Returns true if the enum will be mapped as an opaue (ie struct with a pointer to the underlying
114 /// type), otherwise it is mapped into a transparent, C-compatible version of itself.
115 pub fn is_enum_opaque(e: &syn::ItemEnum) -> bool {
116 for var in e.variants.iter() {
117 if let syn::Fields::Named(fields) = &var.fields {
118 for field in fields.named.iter() {
119 match export_status(&field.attrs) {
120 ExportStatus::Export|ExportStatus::TestOnly => {},
121 ExportStatus::NoExport => return true,
124 } else if let syn::Fields::Unnamed(fields) = &var.fields {
125 for field in fields.unnamed.iter() {
126 match export_status(&field.attrs) {
127 ExportStatus::Export|ExportStatus::TestOnly => {},
128 ExportStatus::NoExport => return true,
136 /// A stack of sets of generic resolutions.
138 /// This tracks the template parameters for a function, struct, or trait, allowing resolution into
139 /// a concrete type. By pushing a new context onto the stack, this can track a function's template
140 /// parameters inside of a generic struct or trait.
142 /// It maps both direct types as well as Deref<Target = X>, mapping them via the provided
143 /// TypeResolver's resolve_path function (ie traits map to the concrete jump table, structs to the
144 /// concrete C container struct, etc).
145 pub struct GenericTypes<'a> {
146 typed_generics: Vec<HashMap<&'a syn::Ident, (String, Option<&'a syn::Path>)>>,
148 impl<'a> GenericTypes<'a> {
149 pub fn new() -> Self {
150 Self { typed_generics: vec![HashMap::new()], }
153 /// push a new context onto the stack, allowing for a new set of generics to be learned which
154 /// will override any lower contexts, but which will still fall back to resoltion via lower
156 pub fn push_ctx(&mut self) {
157 self.typed_generics.push(HashMap::new());
159 /// pop the latest context off the stack.
160 pub fn pop_ctx(&mut self) {
161 self.typed_generics.pop();
164 /// Learn the generics in generics in the current context, given a TypeResolver.
165 pub fn learn_generics<'b, 'c>(&mut self, generics: &'a syn::Generics, types: &'b TypeResolver<'a, 'c>) -> bool {
166 // First learn simple generics...
167 for generic in generics.params.iter() {
169 syn::GenericParam::Type(type_param) => {
170 let mut non_lifetimes_processed = false;
171 for bound in type_param.bounds.iter() {
172 if let syn::TypeParamBound::Trait(trait_bound) = bound {
173 if let Some(ident) = single_ident_generic_path_to_ident(&trait_bound.path) {
174 match &format!("{}", ident) as &str { "Send" => continue, "Sync" => continue, _ => {} }
176 if path_matches_nongeneric(&trait_bound.path, &["core", "clone", "Clone"]) { continue; }
178 assert_simple_bound(&trait_bound);
179 if let Some(mut path) = types.maybe_resolve_path(&trait_bound.path, None) {
180 if types.skip_path(&path) { continue; }
181 if non_lifetimes_processed { return false; }
182 non_lifetimes_processed = true;
183 let new_ident = if path != "std::ops::Deref" {
184 path = "crate::".to_string() + &path;
185 Some(&trait_bound.path)
187 self.typed_generics.last_mut().unwrap().insert(&type_param.ident, (path, new_ident));
188 } else { return false; }
195 // Then find generics where we are required to pass a Deref<Target=X> and pretend its just X.
196 if let Some(wh) = &generics.where_clause {
197 for pred in wh.predicates.iter() {
198 if let syn::WherePredicate::Type(t) = pred {
199 if let syn::Type::Path(p) = &t.bounded_ty {
200 if p.qself.is_some() { return false; }
201 if p.path.leading_colon.is_some() { return false; }
202 let mut p_iter = p.path.segments.iter();
203 if let Some(gen) = self.typed_generics.last_mut().unwrap().get_mut(&p_iter.next().unwrap().ident) {
204 if gen.0 != "std::ops::Deref" { return false; }
205 if &format!("{}", p_iter.next().unwrap().ident) != "Target" { return false; }
207 let mut non_lifetimes_processed = false;
208 for bound in t.bounds.iter() {
209 if let syn::TypeParamBound::Trait(trait_bound) = bound {
210 if non_lifetimes_processed { return false; }
211 non_lifetimes_processed = true;
212 assert_simple_bound(&trait_bound);
213 *gen = ("crate::".to_string() + &types.resolve_path(&trait_bound.path, None),
214 Some(&trait_bound.path));
217 } else { return false; }
218 } else { return false; }
222 for (_, (_, ident)) in self.typed_generics.last().unwrap().iter() {
223 if ident.is_none() { return false; }
228 /// Learn the associated types from the trait in the current context.
229 pub fn learn_associated_types<'b, 'c>(&mut self, t: &'a syn::ItemTrait, types: &'b TypeResolver<'a, 'c>) {
230 for item in t.items.iter() {
232 &syn::TraitItem::Type(ref t) => {
233 if t.default.is_some() || t.generics.lt_token.is_some() { unimplemented!(); }
234 let mut bounds_iter = t.bounds.iter();
235 match bounds_iter.next().unwrap() {
236 syn::TypeParamBound::Trait(tr) => {
237 assert_simple_bound(&tr);
238 if let Some(mut path) = types.maybe_resolve_path(&tr.path, None) {
239 if types.skip_path(&path) { continue; }
240 // In general we handle Deref<Target=X> as if it were just X (and
241 // implement Deref<Target=Self> for relevant types). We don't
242 // bother to implement it for associated types, however, so we just
243 // ignore such bounds.
244 let new_ident = if path != "std::ops::Deref" {
245 path = "crate::".to_string() + &path;
248 self.typed_generics.last_mut().unwrap().insert(&t.ident, (path, new_ident));
249 } else { unimplemented!(); }
251 _ => unimplemented!(),
253 if bounds_iter.next().is_some() { unimplemented!(); }
260 /// Attempt to resolve an Ident as a generic parameter and return the full path.
261 pub fn maybe_resolve_ident<'b>(&'b self, ident: &syn::Ident) -> Option<&'b String> {
262 for gen in self.typed_generics.iter().rev() {
263 if let Some(res) = gen.get(ident).map(|(a, _)| a) {
269 /// Attempt to resolve a Path as a generic parameter and return the full path. as both a string
271 pub fn maybe_resolve_path<'b>(&'b self, path: &syn::Path) -> Option<(&'b String, &'a syn::Path)> {
272 if let Some(ident) = path.get_ident() {
273 for gen in self.typed_generics.iter().rev() {
274 if let Some(res) = gen.get(ident).map(|(a, b)| (a, b.unwrap())) {
279 // Associated types are usually specified as "Self::Generic", so we check for that
281 let mut it = path.segments.iter();
282 if path.segments.len() == 2 && format!("{}", it.next().unwrap().ident) == "Self" {
283 let ident = &it.next().unwrap().ident;
284 for gen in self.typed_generics.iter().rev() {
285 if let Some(res) = gen.get(ident).map(|(a, b)| (a, b.unwrap())) {
295 #[derive(Clone, PartialEq)]
296 // The type of declaration and the object itself
297 pub enum DeclType<'a> {
299 Trait(&'a syn::ItemTrait),
305 pub struct ImportResolver<'mod_lifetime, 'crate_lft: 'mod_lifetime> {
306 module_path: &'mod_lifetime str,
307 imports: HashMap<syn::Ident, (String, syn::Path)>,
308 declared: HashMap<syn::Ident, DeclType<'crate_lft>>,
309 priv_modules: HashSet<syn::Ident>,
311 impl<'mod_lifetime, 'crate_lft: 'mod_lifetime> ImportResolver<'mod_lifetime, 'crate_lft> {
312 fn process_use_intern(imports: &mut HashMap<syn::Ident, (String, syn::Path)>, u: &syn::UseTree, partial_path: &str, mut path: syn::punctuated::Punctuated<syn::PathSegment, syn::token::Colon2>) {
314 syn::UseTree::Path(p) => {
315 let new_path = format!("{}{}::", partial_path, p.ident);
316 path.push(syn::PathSegment { ident: p.ident.clone(), arguments: syn::PathArguments::None });
317 Self::process_use_intern(imports, &p.tree, &new_path, path);
319 syn::UseTree::Name(n) => {
320 let full_path = format!("{}{}", partial_path, n.ident);
321 path.push(syn::PathSegment { ident: n.ident.clone(), arguments: syn::PathArguments::None });
322 imports.insert(n.ident.clone(), (full_path, syn::Path { leading_colon: Some(syn::Token![::](Span::call_site())), segments: path }));
324 syn::UseTree::Group(g) => {
325 for i in g.items.iter() {
326 Self::process_use_intern(imports, i, partial_path, path.clone());
329 syn::UseTree::Rename(r) => {
330 let full_path = format!("{}{}", partial_path, r.ident);
331 path.push(syn::PathSegment { ident: r.ident.clone(), arguments: syn::PathArguments::None });
332 imports.insert(r.rename.clone(), (full_path, syn::Path { leading_colon: Some(syn::Token![::](Span::call_site())), segments: path }));
334 syn::UseTree::Glob(_) => {
335 eprintln!("Ignoring * use for {} - this may result in resolution failures", partial_path);
340 fn process_use(imports: &mut HashMap<syn::Ident, (String, syn::Path)>, u: &syn::ItemUse) {
341 if let syn::Visibility::Public(_) = u.vis {
342 // We actually only use these for #[cfg(fuzztarget)]
343 eprintln!("Ignoring pub(use) tree!");
346 if u.leading_colon.is_some() { eprintln!("Ignoring leading-colon use!"); return; }
347 Self::process_use_intern(imports, &u.tree, "", syn::punctuated::Punctuated::new());
350 fn insert_primitive(imports: &mut HashMap<syn::Ident, (String, syn::Path)>, id: &str) {
351 let ident = syn::Ident::new(id, Span::call_site());
352 let mut path = syn::punctuated::Punctuated::new();
353 path.push(syn::PathSegment { ident: ident.clone(), arguments: syn::PathArguments::None });
354 imports.insert(ident, (id.to_owned(), syn::Path { leading_colon: Some(syn::Token![::](Span::call_site())), segments: path }));
357 pub fn new(module_path: &'mod_lifetime str, contents: &'crate_lft [syn::Item]) -> Self {
358 let mut imports = HashMap::new();
359 // Add primitives to the "imports" list:
360 Self::insert_primitive(&mut imports, "bool");
361 Self::insert_primitive(&mut imports, "u64");
362 Self::insert_primitive(&mut imports, "u32");
363 Self::insert_primitive(&mut imports, "u16");
364 Self::insert_primitive(&mut imports, "u8");
365 Self::insert_primitive(&mut imports, "usize");
366 Self::insert_primitive(&mut imports, "str");
367 Self::insert_primitive(&mut imports, "String");
369 // These are here to allow us to print native Rust types in trait fn impls even if we don't
371 Self::insert_primitive(&mut imports, "Result");
372 Self::insert_primitive(&mut imports, "Vec");
373 Self::insert_primitive(&mut imports, "Option");
375 let mut declared = HashMap::new();
376 let mut priv_modules = HashSet::new();
378 for item in contents.iter() {
380 syn::Item::Use(u) => Self::process_use(&mut imports, &u),
381 syn::Item::Struct(s) => {
382 if let syn::Visibility::Public(_) = s.vis {
383 match export_status(&s.attrs) {
384 ExportStatus::Export => { declared.insert(s.ident.clone(), DeclType::StructImported); },
385 ExportStatus::NoExport => { declared.insert(s.ident.clone(), DeclType::StructIgnored); },
386 ExportStatus::TestOnly => continue,
390 syn::Item::Type(t) if export_status(&t.attrs) == ExportStatus::Export => {
391 if let syn::Visibility::Public(_) = t.vis {
392 let mut process_alias = true;
393 for tok in t.generics.params.iter() {
394 if let syn::GenericParam::Lifetime(_) = tok {}
395 else { process_alias = false; }
399 syn::Type::Path(_) => { declared.insert(t.ident.clone(), DeclType::StructImported); },
405 syn::Item::Enum(e) => {
406 if let syn::Visibility::Public(_) = e.vis {
407 match export_status(&e.attrs) {
408 ExportStatus::Export if is_enum_opaque(e) => { declared.insert(e.ident.clone(), DeclType::EnumIgnored); },
409 ExportStatus::Export => { declared.insert(e.ident.clone(), DeclType::MirroredEnum); },
414 syn::Item::Trait(t) if export_status(&t.attrs) == ExportStatus::Export => {
415 if let syn::Visibility::Public(_) = t.vis {
416 declared.insert(t.ident.clone(), DeclType::Trait(t));
419 syn::Item::Mod(m) => {
420 priv_modules.insert(m.ident.clone());
426 Self { module_path, imports, declared, priv_modules }
429 pub fn get_declared_type(&self, ident: &syn::Ident) -> Option<&DeclType<'crate_lft>> {
430 self.declared.get(ident)
433 pub fn maybe_resolve_declared(&self, id: &syn::Ident) -> Option<&DeclType<'crate_lft>> {
434 self.declared.get(id)
437 pub fn maybe_resolve_ident(&self, id: &syn::Ident) -> Option<String> {
438 if let Some((imp, _)) = self.imports.get(id) {
440 } else if self.declared.get(id).is_some() {
441 Some(self.module_path.to_string() + "::" + &format!("{}", id))
445 pub fn maybe_resolve_non_ignored_ident(&self, id: &syn::Ident) -> Option<String> {
446 if let Some((imp, _)) = self.imports.get(id) {
448 } else if let Some(decl_type) = self.declared.get(id) {
450 DeclType::StructIgnored => None,
451 _ => Some(self.module_path.to_string() + "::" + &format!("{}", id)),
456 pub fn maybe_resolve_path(&self, p_arg: &syn::Path, generics: Option<&GenericTypes>) -> Option<String> {
457 let p = if let Some(gen_types) = generics {
458 if let Some((_, synpath)) = gen_types.maybe_resolve_path(p_arg) {
463 if p.leading_colon.is_some() {
464 Some(p.segments.iter().enumerate().map(|(idx, seg)| {
465 format!("{}{}", if idx == 0 { "" } else { "::" }, seg.ident)
467 } else if let Some(id) = p.get_ident() {
468 self.maybe_resolve_ident(id)
470 if p.segments.len() == 1 {
471 let seg = p.segments.iter().next().unwrap();
472 return self.maybe_resolve_ident(&seg.ident);
474 let mut seg_iter = p.segments.iter();
475 let first_seg = seg_iter.next().unwrap();
476 let remaining: String = seg_iter.map(|seg| {
477 format!("::{}", seg.ident)
479 if let Some((imp, _)) = self.imports.get(&first_seg.ident) {
481 Some(imp.clone() + &remaining)
485 } else if let Some(_) = self.priv_modules.get(&first_seg.ident) {
486 Some(format!("{}::{}{}", self.module_path, first_seg.ident, remaining))
491 /// Map all the Paths in a Type into absolute paths given a set of imports (generated via process_use_intern)
492 pub fn resolve_imported_refs(&self, mut ty: syn::Type) -> syn::Type {
494 syn::Type::Path(p) => {
495 if let Some(ident) = p.path.get_ident() {
496 if let Some((_, newpath)) = self.imports.get(ident) {
497 p.path = newpath.clone();
499 } else { unimplemented!(); }
501 syn::Type::Reference(r) => {
502 r.elem = Box::new(self.resolve_imported_refs((*r.elem).clone()));
504 syn::Type::Slice(s) => {
505 s.elem = Box::new(self.resolve_imported_refs((*s.elem).clone()));
507 syn::Type::Tuple(t) => {
508 for e in t.elems.iter_mut() {
509 *e = self.resolve_imported_refs(e.clone());
512 _ => unimplemented!(),
518 // templates_defined is walked to write the C++ header, so if we use the default hashing it get
519 // reordered on each genbindings run. Instead, we use SipHasher (which defaults to 0-keys) so that
520 // the sorting is stable across runs. It is deprecated, but the "replacement" doesn't actually
521 // accomplish the same goals, so we just ignore it.
523 pub type NonRandomHash = hash::BuildHasherDefault<hash::SipHasher>;
525 /// Top-level struct tracking everything which has been defined while walking the crate.
526 pub struct CrateTypes<'a> {
527 /// This may contain structs or enums, but only when either is mapped as
528 /// struct X { inner: *mut originalX, .. }
529 pub opaques: HashMap<String, &'a syn::Ident>,
530 /// Enums which are mapped as C enums with conversion functions
531 pub mirrored_enums: HashMap<String, &'a syn::ItemEnum>,
532 /// Traits which are mapped as a pointer + jump table
533 pub traits: HashMap<String, &'a syn::ItemTrait>,
534 /// Aliases from paths to some other Type
535 pub type_aliases: HashMap<String, syn::Type>,
536 /// Value is an alias to Key (maybe with some generics)
537 pub reverse_alias_map: HashMap<String, Vec<(syn::Path, syn::PathArguments)>>,
538 /// Template continer types defined, map from mangled type name -> whether a destructor fn
541 /// This is used at the end of processing to make C++ wrapper classes
542 pub templates_defined: HashMap<String, bool, NonRandomHash>,
543 /// The output file for any created template container types, written to as we find new
544 /// template containers which need to be defined.
545 pub template_file: &'a mut File,
546 /// Set of containers which are clonable
547 pub clonable_types: HashSet<String>,
549 pub trait_impls: HashMap<String, Vec<String>>,
552 /// A struct which tracks resolving rust types into C-mapped equivalents, exists for one specific
553 /// module but contains a reference to the overall CrateTypes tracking.
554 pub struct TypeResolver<'mod_lifetime, 'crate_lft: 'mod_lifetime> {
555 pub orig_crate: &'mod_lifetime str,
556 pub module_path: &'mod_lifetime str,
557 pub crate_types: &'mod_lifetime mut CrateTypes<'crate_lft>,
558 types: ImportResolver<'mod_lifetime, 'crate_lft>,
561 /// Returned by write_empty_rust_val_check_suffix to indicate what type of dereferencing needs to
562 /// happen to get the inner value of a generic.
563 enum EmptyValExpectedTy {
564 /// A type which has a flag for being empty (eg an array where we treat all-0s as empty).
566 /// A pointer that we want to dereference and move out of.
568 /// A pointer which we want to convert to a reference.
572 impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
573 pub fn new(orig_crate: &'a str, module_path: &'a str, types: ImportResolver<'a, 'c>, crate_types: &'a mut CrateTypes<'c>) -> Self {
574 Self { orig_crate, module_path, types, crate_types }
577 // *************************************************
578 // *** Well know type and conversion definitions ***
579 // *************************************************
581 /// Returns true we if can just skip passing this to C entirely
582 fn skip_path(&self, full_path: &str) -> bool {
583 full_path == "bitcoin::secp256k1::Secp256k1" ||
584 full_path == "bitcoin::secp256k1::Signing" ||
585 full_path == "bitcoin::secp256k1::Verification"
587 /// Returns true we if can just skip passing this to C entirely
588 fn no_arg_path_to_rust(&self, full_path: &str) -> &str {
589 if full_path == "bitcoin::secp256k1::Secp256k1" {
590 "secp256k1::SECP256K1"
591 } else { unimplemented!(); }
594 /// Returns true if the object is a primitive and is mapped as-is with no conversion
596 pub fn is_primitive(&self, full_path: &str) -> bool {
607 pub fn is_clonable(&self, ty: &str) -> bool {
608 if self.crate_types.clonable_types.contains(ty) { return true; }
609 if self.is_primitive(ty) { return true; }
612 "crate::c_types::Signature" => true,
613 "crate::c_types::TxOut" => true,
617 /// Gets the C-mapped type for types which are outside of the crate, or which are manually
618 /// ignored by for some reason need mapping anyway.
619 fn c_type_from_path<'b>(&self, full_path: &'b str, is_ref: bool, _ptr_for_ref: bool) -> Option<&'b str> {
620 if self.is_primitive(full_path) {
621 return Some(full_path);
624 "Result" => Some("crate::c_types::derived::CResult"),
625 "Vec" if !is_ref => Some("crate::c_types::derived::CVec"),
626 "Option" => Some(""),
628 // Note that no !is_ref types can map to an array because Rust and C's call semantics
629 // for arrays are different (https://github.com/eqrion/cbindgen/issues/528)
631 "[u8; 32]" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
632 "[u8; 16]" if !is_ref => Some("crate::c_types::SixteenBytes"),
633 "[u8; 10]" if !is_ref => Some("crate::c_types::TenBytes"),
634 "[u8; 4]" if !is_ref => Some("crate::c_types::FourBytes"),
635 "[u8; 3]" if !is_ref => Some("crate::c_types::ThreeBytes"), // Used for RGB values
637 "str" if is_ref => Some("crate::c_types::Str"),
638 "String" if !is_ref => Some("crate::c_types::derived::CVec_u8Z"),
639 "String" if is_ref => Some("crate::c_types::Str"),
641 "std::time::Duration" => Some("u64"),
643 "bitcoin::secp256k1::key::PublicKey" => Some("crate::c_types::PublicKey"),
644 "bitcoin::secp256k1::Signature" => Some("crate::c_types::Signature"),
645 "bitcoin::secp256k1::key::SecretKey" if is_ref => Some("*const [u8; 32]"),
646 "bitcoin::secp256k1::key::SecretKey" if !is_ref => Some("crate::c_types::SecretKey"),
647 "bitcoin::secp256k1::Error" if !is_ref => Some("crate::c_types::Secp256k1Error"),
648 "bitcoin::blockdata::script::Script" if is_ref => Some("crate::c_types::u8slice"),
649 "bitcoin::blockdata::script::Script" if !is_ref => Some("crate::c_types::derived::CVec_u8Z"),
650 "bitcoin::blockdata::transaction::OutPoint" => Some("crate::chain::transaction::OutPoint"),
651 "bitcoin::blockdata::transaction::Transaction" => Some("crate::c_types::Transaction"),
652 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some("crate::c_types::TxOut"),
653 "bitcoin::network::constants::Network" => Some("crate::bitcoin::network::Network"),
654 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some("*const [u8; 80]"),
655 "bitcoin::blockdata::block::Block" if is_ref => Some("crate::c_types::u8slice"),
657 // Newtypes that we just expose in their original form.
658 "bitcoin::hash_types::Txid" if is_ref => Some("*const [u8; 32]"),
659 "bitcoin::hash_types::Txid" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
660 "bitcoin::hash_types::BlockHash" if is_ref => Some("*const [u8; 32]"),
661 "bitcoin::hash_types::BlockHash" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
662 "bitcoin::secp256k1::Message" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
663 "ln::channelmanager::PaymentHash" if is_ref => Some("*const [u8; 32]"),
664 "ln::channelmanager::PaymentHash" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
665 "ln::channelmanager::PaymentPreimage" if is_ref => Some("*const [u8; 32]"),
666 "ln::channelmanager::PaymentPreimage" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
667 "ln::channelmanager::PaymentSecret" if is_ref => Some("crate::c_types::ThirtyTwoBytes"),
668 "ln::channelmanager::PaymentSecret" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
670 // Override the default since Records contain an fmt with a lifetime:
671 "util::logger::Record" => Some("*const std::os::raw::c_char"),
677 fn from_c_conversion_new_var_from_path<'b>(&self, _full_path: &str, _is_ref: bool) -> Option<(&'b str, &'b str)> {
680 fn from_c_conversion_prefix_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<String> {
681 if self.is_primitive(full_path) {
682 return Some("".to_owned());
685 "Vec" if !is_ref => Some("local_"),
686 "Result" if !is_ref => Some("local_"),
687 "Option" if is_ref => Some("&local_"),
688 "Option" => Some("local_"),
690 "[u8; 32]" if is_ref => Some("unsafe { &*"),
691 "[u8; 32]" if !is_ref => Some(""),
692 "[u8; 16]" if !is_ref => Some(""),
693 "[u8; 10]" if !is_ref => Some(""),
694 "[u8; 4]" if !is_ref => Some(""),
695 "[u8; 3]" if !is_ref => Some(""),
697 "[u8]" if is_ref => Some(""),
698 "[usize]" if is_ref => Some(""),
700 "str" if is_ref => Some(""),
701 "String" if !is_ref => Some("String::from_utf8("),
702 // Note that we'll panic for String if is_ref, as we only have non-owned memory, we
703 // cannot create a &String.
705 "std::time::Duration" => Some("std::time::Duration::from_secs("),
707 "bitcoin::secp256k1::key::PublicKey" if is_ref => Some("&"),
708 "bitcoin::secp256k1::key::PublicKey" => Some(""),
709 "bitcoin::secp256k1::Signature" if is_ref => Some("&"),
710 "bitcoin::secp256k1::Signature" => Some(""),
711 "bitcoin::secp256k1::key::SecretKey" if is_ref => Some("&::bitcoin::secp256k1::key::SecretKey::from_slice(&unsafe { *"),
712 "bitcoin::secp256k1::key::SecretKey" if !is_ref => Some(""),
713 "bitcoin::blockdata::script::Script" if is_ref => Some("&::bitcoin::blockdata::script::Script::from(Vec::from("),
714 "bitcoin::blockdata::script::Script" if !is_ref => Some("::bitcoin::blockdata::script::Script::from("),
715 "bitcoin::blockdata::transaction::Transaction" if is_ref => Some("&"),
716 "bitcoin::blockdata::transaction::Transaction" => Some(""),
717 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(""),
718 "bitcoin::network::constants::Network" => Some(""),
719 "bitcoin::blockdata::block::BlockHeader" => Some("&::bitcoin::consensus::encode::deserialize(unsafe { &*"),
720 "bitcoin::blockdata::block::Block" if is_ref => Some("&::bitcoin::consensus::encode::deserialize("),
722 // Newtypes that we just expose in their original form.
723 "bitcoin::hash_types::Txid" if is_ref => Some("&::bitcoin::hash_types::Txid::from_slice(&unsafe { &*"),
724 "bitcoin::hash_types::Txid" if !is_ref => Some("::bitcoin::hash_types::Txid::from_slice(&"),
725 "bitcoin::hash_types::BlockHash" => Some("::bitcoin::hash_types::BlockHash::from_slice(&"),
726 "ln::channelmanager::PaymentHash" if !is_ref => Some("::lightning::ln::channelmanager::PaymentHash("),
727 "ln::channelmanager::PaymentHash" if is_ref => Some("&::lightning::ln::channelmanager::PaymentHash(unsafe { *"),
728 "ln::channelmanager::PaymentPreimage" if !is_ref => Some("::lightning::ln::channelmanager::PaymentPreimage("),
729 "ln::channelmanager::PaymentPreimage" if is_ref => Some("&::lightning::ln::channelmanager::PaymentPreimage(unsafe { *"),
730 "ln::channelmanager::PaymentSecret" => Some("::lightning::ln::channelmanager::PaymentSecret("),
732 // List of traits we map (possibly during processing of other files):
733 "crate::util::logger::Logger" => Some(""),
736 }.map(|s| s.to_owned())
738 fn from_c_conversion_suffix_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<String> {
739 if self.is_primitive(full_path) {
740 return Some("".to_owned());
743 "Vec" if !is_ref => Some(""),
744 "Option" => Some(""),
745 "Result" if !is_ref => Some(""),
747 "[u8; 32]" if is_ref => Some("}"),
748 "[u8; 32]" if !is_ref => Some(".data"),
749 "[u8; 16]" if !is_ref => Some(".data"),
750 "[u8; 10]" if !is_ref => Some(".data"),
751 "[u8; 4]" if !is_ref => Some(".data"),
752 "[u8; 3]" if !is_ref => Some(".data"),
754 "[u8]" if is_ref => Some(".to_slice()"),
755 "[usize]" if is_ref => Some(".to_slice()"),
757 "str" if is_ref => Some(".into()"),
758 "String" if !is_ref => Some(".into_rust()).unwrap()"),
760 "std::time::Duration" => Some(")"),
762 "bitcoin::secp256k1::key::PublicKey" => Some(".into_rust()"),
763 "bitcoin::secp256k1::Signature" => Some(".into_rust()"),
764 "bitcoin::secp256k1::key::SecretKey" if !is_ref => Some(".into_rust()"),
765 "bitcoin::secp256k1::key::SecretKey" if is_ref => Some("}[..]).unwrap()"),
766 "bitcoin::blockdata::script::Script" if is_ref => Some(".to_slice()))"),
767 "bitcoin::blockdata::script::Script" if !is_ref => Some(".into_rust())"),
768 "bitcoin::blockdata::transaction::Transaction" => Some(".into_bitcoin()"),
769 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(".into_rust()"),
770 "bitcoin::network::constants::Network" => Some(".into_bitcoin()"),
771 "bitcoin::blockdata::block::BlockHeader" => Some(" }).unwrap()"),
772 "bitcoin::blockdata::block::Block" => Some(".to_slice()).unwrap()"),
774 // Newtypes that we just expose in their original form.
775 "bitcoin::hash_types::Txid" if is_ref => Some(" }[..]).unwrap()"),
776 "bitcoin::hash_types::Txid" => Some(".data[..]).unwrap()"),
777 "bitcoin::hash_types::BlockHash" if !is_ref => Some(".data[..]).unwrap()"),
778 "ln::channelmanager::PaymentHash" if !is_ref => Some(".data)"),
779 "ln::channelmanager::PaymentHash" if is_ref => Some(" })"),
780 "ln::channelmanager::PaymentPreimage" if !is_ref => Some(".data)"),
781 "ln::channelmanager::PaymentPreimage" if is_ref => Some(" })"),
782 "ln::channelmanager::PaymentSecret" => Some(".data)"),
784 // List of traits we map (possibly during processing of other files):
785 "crate::util::logger::Logger" => Some(""),
788 }.map(|s| s.to_owned())
791 fn to_c_conversion_new_var_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<(&'b str, &'b str)> {
792 if self.is_primitive(full_path) {
796 "[u8]" if is_ref => Some(("crate::c_types::u8slice::from_slice(", ")")),
797 "[usize]" if is_ref => Some(("crate::c_types::usizeslice::from_slice(", ")")),
799 "bitcoin::blockdata::transaction::Transaction" if is_ref => Some(("::bitcoin::consensus::encode::serialize(", ")")),
800 "bitcoin::blockdata::transaction::Transaction" if !is_ref => Some(("::bitcoin::consensus::encode::serialize(&", ")")),
801 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some(("{ let mut s = [0u8; 80]; s[..].copy_from_slice(&::bitcoin::consensus::encode::serialize(", ")); s }")),
802 "bitcoin::blockdata::block::Block" if is_ref => Some(("::bitcoin::consensus::encode::serialize(", ")")),
803 "bitcoin::hash_types::Txid" => None,
805 // Override the default since Records contain an fmt with a lifetime:
806 // TODO: We should include the other record fields
807 "util::logger::Record" => Some(("std::ffi::CString::new(format!(\"{}\", ", ".args)).unwrap()")),
809 }.map(|s| s.to_owned())
811 fn to_c_conversion_inline_prefix_from_path(&self, full_path: &str, is_ref: bool, _ptr_for_ref: bool) -> Option<String> {
812 if self.is_primitive(full_path) {
813 return Some("".to_owned());
816 "Result" if !is_ref => Some("local_"),
817 "Vec" if !is_ref => Some("local_"),
818 "Option" => Some("local_"),
820 "[u8; 32]" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
821 "[u8; 32]" if is_ref => Some("&"),
822 "[u8; 16]" if !is_ref => Some("crate::c_types::SixteenBytes { data: "),
823 "[u8; 10]" if !is_ref => Some("crate::c_types::TenBytes { data: "),
824 "[u8; 4]" if !is_ref => Some("crate::c_types::FourBytes { data: "),
825 "[u8; 3]" if is_ref => Some("&"),
827 "[u8]" if is_ref => Some("local_"),
828 "[usize]" if is_ref => Some("local_"),
830 "str" if is_ref => Some(""),
831 "String" => Some(""),
833 "std::time::Duration" => Some(""),
835 "bitcoin::secp256k1::key::PublicKey" => Some("crate::c_types::PublicKey::from_rust(&"),
836 "bitcoin::secp256k1::Signature" => Some("crate::c_types::Signature::from_rust(&"),
837 "bitcoin::secp256k1::key::SecretKey" if is_ref => Some(""),
838 "bitcoin::secp256k1::key::SecretKey" if !is_ref => Some("crate::c_types::SecretKey::from_rust("),
839 "bitcoin::secp256k1::Error" if !is_ref => Some("crate::c_types::Secp256k1Error::from_rust("),
840 "bitcoin::blockdata::script::Script" if is_ref => Some("crate::c_types::u8slice::from_slice(&"),
841 "bitcoin::blockdata::script::Script" if !is_ref => Some(""),
842 "bitcoin::blockdata::transaction::Transaction" => Some("crate::c_types::Transaction::from_vec(local_"),
843 "bitcoin::blockdata::transaction::OutPoint" => Some("crate::c_types::bitcoin_to_C_outpoint("),
844 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some("crate::c_types::TxOut::from_rust("),
845 "bitcoin::network::constants::Network" => Some("crate::bitcoin::network::Network::from_bitcoin("),
846 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some("&local_"),
847 "bitcoin::blockdata::block::Block" if is_ref => Some("crate::c_types::u8slice::from_slice(&local_"),
849 "bitcoin::hash_types::Txid" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
851 // Newtypes that we just expose in their original form.
852 "bitcoin::hash_types::Txid" if is_ref => Some(""),
853 "bitcoin::hash_types::BlockHash" if is_ref => Some(""),
854 "bitcoin::hash_types::BlockHash" => Some("crate::c_types::ThirtyTwoBytes { data: "),
855 "bitcoin::secp256k1::Message" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
856 "ln::channelmanager::PaymentHash" if is_ref => Some("&"),
857 "ln::channelmanager::PaymentHash" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
858 "ln::channelmanager::PaymentPreimage" if is_ref => Some("&"),
859 "ln::channelmanager::PaymentPreimage" => Some("crate::c_types::ThirtyTwoBytes { data: "),
860 "ln::channelmanager::PaymentSecret" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
862 // Override the default since Records contain an fmt with a lifetime:
863 "util::logger::Record" => Some("local_"),
866 }.map(|s| s.to_owned())
868 fn to_c_conversion_inline_suffix_from_path(&self, full_path: &str, is_ref: bool, _ptr_for_ref: bool) -> Option<String> {
869 if self.is_primitive(full_path) {
870 return Some("".to_owned());
873 "Result" if !is_ref => Some(""),
874 "Vec" if !is_ref => Some(".into()"),
875 "Option" => Some(""),
877 "[u8; 32]" if !is_ref => Some(" }"),
878 "[u8; 32]" if is_ref => Some(""),
879 "[u8; 16]" if !is_ref => Some(" }"),
880 "[u8; 10]" if !is_ref => Some(" }"),
881 "[u8; 4]" if !is_ref => Some(" }"),
882 "[u8; 3]" if is_ref => Some(""),
884 "[u8]" if is_ref => Some(""),
885 "[usize]" if is_ref => Some(""),
887 "str" if is_ref => Some(".into()"),
888 "String" if !is_ref => Some(".into_bytes().into()"),
889 "String" if is_ref => Some(".as_str().into()"),
891 "std::time::Duration" => Some(".as_secs()"),
893 "bitcoin::secp256k1::key::PublicKey" => Some(")"),
894 "bitcoin::secp256k1::Signature" => Some(")"),
895 "bitcoin::secp256k1::key::SecretKey" if !is_ref => Some(")"),
896 "bitcoin::secp256k1::key::SecretKey" if is_ref => Some(".as_ref()"),
897 "bitcoin::secp256k1::Error" if !is_ref => Some(")"),
898 "bitcoin::blockdata::script::Script" if is_ref => Some("[..])"),
899 "bitcoin::blockdata::script::Script" if !is_ref => Some(".into_bytes().into()"),
900 "bitcoin::blockdata::transaction::Transaction" => Some(")"),
901 "bitcoin::blockdata::transaction::OutPoint" => Some(")"),
902 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(")"),
903 "bitcoin::network::constants::Network" => Some(")"),
904 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some(""),
905 "bitcoin::blockdata::block::Block" if is_ref => Some(")"),
907 "bitcoin::hash_types::Txid" if !is_ref => Some(".into_inner() }"),
909 // Newtypes that we just expose in their original form.
910 "bitcoin::hash_types::Txid" if is_ref => Some(".as_inner()"),
911 "bitcoin::hash_types::BlockHash" if is_ref => Some(".as_inner()"),
912 "bitcoin::hash_types::BlockHash" => Some(".into_inner() }"),
913 "bitcoin::secp256k1::Message" if !is_ref => Some(".as_ref().clone() }"),
914 "ln::channelmanager::PaymentHash" if is_ref => Some(".0"),
915 "ln::channelmanager::PaymentHash" => Some(".0 }"),
916 "ln::channelmanager::PaymentPreimage" if is_ref => Some(".0"),
917 "ln::channelmanager::PaymentPreimage" => Some(".0 }"),
918 "ln::channelmanager::PaymentSecret" if !is_ref => Some(".0 }"),
920 // Override the default since Records contain an fmt with a lifetime:
921 "util::logger::Record" => Some(".as_ptr()"),
924 }.map(|s| s.to_owned())
927 fn empty_val_check_suffix_from_path(&self, full_path: &str) -> Option<&str> {
929 "ln::channelmanager::PaymentSecret" => Some(".data == [0; 32]"),
930 "bitcoin::secp256k1::key::PublicKey" => Some(".is_null()"),
931 "bitcoin::secp256k1::Signature" => Some(".is_null()"),
936 // ****************************
937 // *** Container Processing ***
938 // ****************************
940 /// Returns the module path in the generated mapping crate to the containers which we generate
941 /// when writing to CrateTypes::template_file.
942 pub fn generated_container_path() -> &'static str {
943 "crate::c_types::derived"
945 /// Returns the module path in the generated mapping crate to the container templates, which
946 /// are then concretized and put in the generated container path/template_file.
947 fn container_templ_path() -> &'static str {
951 /// Returns true if this is a "transparent" container, ie an Option or a container which does
952 /// not require a generated continer class.
953 fn is_transparent_container(&self, full_path: &str, _is_ref: bool) -> bool {
954 full_path == "Option"
956 /// Returns true if this is a known, supported, non-transparent container.
957 fn is_known_container(&self, full_path: &str, is_ref: bool) -> bool {
958 (full_path == "Result" && !is_ref) || (full_path == "Vec" && !is_ref) || full_path.ends_with("Tuple")
960 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)
961 // Returns prefix + Vec<(prefix, var-name-to-inline-convert)> + suffix
962 // expecting one element in the vec per generic type, each of which is inline-converted
963 -> Option<(&'b str, Vec<(String, String)>, &'b str)> {
965 "Result" if !is_ref => {
967 vec![(" { Ok(mut o) => crate::c_types::CResultTempl::ok(".to_string(), "o".to_string()),
968 (").into(), Err(mut e) => crate::c_types::CResultTempl::err(".to_string(), "e".to_string())],
971 "Vec" if !is_ref => {
972 Some(("Vec::new(); for mut item in ", vec![(format!(".drain(..) {{ local_{}.push(", var_name), "item".to_string())], "); }"))
975 Some(("Vec::new(); for item in ", vec![(format!(".iter() {{ local_{}.push(", var_name), "**item".to_string())], "); }"))
978 if let Some(syn::Type::Path(p)) = single_contained {
979 if self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)) {
981 return Some(("if ", vec![
982 (".is_none() { std::ptr::null() } else { ".to_owned(), format!("({}.as_ref().unwrap())", var_access))
985 return Some(("if ", vec![
986 (".is_none() { std::ptr::null_mut() } else { ".to_owned(), format!("({}.unwrap())", var_access))
991 if let Some(t) = single_contained {
992 let mut v = Vec::new();
993 self.write_empty_rust_val(generics, &mut v, t);
994 let s = String::from_utf8(v).unwrap();
995 return Some(("if ", vec![
996 (format!(".is_none() {{ {} }} else {{ ", s), format!("({}.unwrap())", var_access))
998 } else { unreachable!(); }
1004 /// only_contained_has_inner implies that there is only one contained element in the container
1005 /// and it has an inner field (ie is an "opaque" type we've defined).
1006 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)
1007 // Returns prefix + Vec<(prefix, var-name-to-inline-convert)> + suffix
1008 // expecting one element in the vec per generic type, each of which is inline-converted
1009 -> Option<(&'b str, Vec<(String, String)>, &'b str)> {
1011 "Result" if !is_ref => {
1013 vec![(".result_ok { true => Ok(".to_string(), format!("(*unsafe {{ Box::from_raw(<*mut _>::take_ptr(&mut {}.contents.result)) }})", var_access)),
1014 ("), false => Err(".to_string(), format!("(*unsafe {{ Box::from_raw(<*mut _>::take_ptr(&mut {}.contents.err)) }})", var_access))],
1017 "Vec"|"Slice" if !is_ref => {
1018 Some(("Vec::new(); for mut item in ", vec![(format!(".into_rust().drain(..) {{ local_{}.push(", var_name), "item".to_string())], "); }"))
1020 "Slice" if is_ref => {
1021 Some(("Vec::new(); for mut item in ", vec![(format!(".as_slice().iter() {{ local_{}.push(", var_name), "item".to_string())], "); }"))
1024 if let Some(syn::Type::Path(p)) = single_contained {
1025 if self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)) {
1027 return Some(("if ", vec![(".inner.is_null() { None } else { Some((*".to_string(), format!("{}", var_access))], ").clone()) }"))
1029 return Some(("if ", vec![(".inner.is_null() { None } else { Some(".to_string(), format!("{}", var_access))], ") }"));
1034 if let Some(t) = single_contained {
1035 let mut v = Vec::new();
1036 let ret_ref = self.write_empty_rust_val_check_suffix(generics, &mut v, t);
1037 let s = String::from_utf8(v).unwrap();
1039 EmptyValExpectedTy::ReferenceAsPointer =>
1040 return Some(("if ", vec![
1041 (format!("{} {{ None }} else {{ Some(", s), format!("unsafe {{ &mut *{} }}", var_access))
1043 EmptyValExpectedTy::OwnedPointer =>
1044 return Some(("if ", vec![
1045 (format!("{} {{ None }} else {{ Some(", s), format!("unsafe {{ *Box::from_raw({}) }}", var_access))
1047 EmptyValExpectedTy::NonPointer =>
1048 return Some(("if ", vec![
1049 (format!("{} {{ None }} else {{ Some(", s), format!("{}", var_access))
1052 } else { unreachable!(); }
1058 // *************************************************
1059 // *** Type definition during main.rs processing ***
1060 // *************************************************
1062 pub fn get_declared_type(&'a self, ident: &syn::Ident) -> Option<&'a DeclType<'c>> {
1063 self.types.get_declared_type(ident)
1065 /// Returns true if the object at the given path is mapped as X { inner: *mut origX, .. }.
1066 pub fn c_type_has_inner_from_path(&self, full_path: &str) -> bool{
1067 self.crate_types.opaques.get(full_path).is_some()
1070 pub fn maybe_resolve_ident(&self, id: &syn::Ident) -> Option<String> {
1071 self.types.maybe_resolve_ident(id)
1074 pub fn maybe_resolve_non_ignored_ident(&self, id: &syn::Ident) -> Option<String> {
1075 self.types.maybe_resolve_non_ignored_ident(id)
1078 pub fn maybe_resolve_path(&self, p_arg: &syn::Path, generics: Option<&GenericTypes>) -> Option<String> {
1079 self.types.maybe_resolve_path(p_arg, generics)
1081 pub fn resolve_path(&self, p: &syn::Path, generics: Option<&GenericTypes>) -> String {
1082 self.maybe_resolve_path(p, generics).unwrap()
1085 // ***********************************
1086 // *** Original Rust Type Printing ***
1087 // ***********************************
1089 fn in_rust_prelude(resolved_path: &str) -> bool {
1090 match resolved_path {
1098 fn write_rust_path<W: std::io::Write>(&self, w: &mut W, generics_resolver: Option<&GenericTypes>, path: &syn::Path) {
1099 if let Some(resolved) = self.maybe_resolve_path(&path, generics_resolver) {
1100 if self.is_primitive(&resolved) {
1101 write!(w, "{}", path.get_ident().unwrap()).unwrap();
1103 // TODO: We should have a generic "is from a dependency" check here instead of
1104 // checking for "bitcoin" explicitly.
1105 if resolved.starts_with("bitcoin::") || Self::in_rust_prelude(&resolved) {
1106 write!(w, "{}", resolved).unwrap();
1107 // If we're printing a generic argument, it needs to reference the crate, otherwise
1108 // the original crate:
1109 } else if self.maybe_resolve_path(&path, None).as_ref() == Some(&resolved) {
1110 write!(w, "{}::{}", self.orig_crate, resolved).unwrap();
1112 write!(w, "crate::{}", resolved).unwrap();
1115 if let syn::PathArguments::AngleBracketed(args) = &path.segments.iter().last().unwrap().arguments {
1116 self.write_rust_generic_arg(w, generics_resolver, args.args.iter());
1119 if path.leading_colon.is_some() {
1120 write!(w, "::").unwrap();
1122 for (idx, seg) in path.segments.iter().enumerate() {
1123 if idx != 0 { write!(w, "::").unwrap(); }
1124 write!(w, "{}", seg.ident).unwrap();
1125 if let syn::PathArguments::AngleBracketed(args) = &seg.arguments {
1126 self.write_rust_generic_arg(w, generics_resolver, args.args.iter());
1131 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>) {
1132 let mut had_params = false;
1133 for (idx, arg) in generics.enumerate() {
1134 if idx != 0 { write!(w, ", ").unwrap(); } else { write!(w, "<").unwrap(); }
1137 syn::GenericParam::Lifetime(lt) => write!(w, "'{}", lt.lifetime.ident).unwrap(),
1138 syn::GenericParam::Type(t) => {
1139 write!(w, "{}", t.ident).unwrap();
1140 if t.colon_token.is_some() { write!(w, ":").unwrap(); }
1141 for (idx, bound) in t.bounds.iter().enumerate() {
1142 if idx != 0 { write!(w, " + ").unwrap(); }
1144 syn::TypeParamBound::Trait(tb) => {
1145 if tb.paren_token.is_some() || tb.lifetimes.is_some() { unimplemented!(); }
1146 self.write_rust_path(w, generics_resolver, &tb.path);
1148 _ => unimplemented!(),
1151 if t.eq_token.is_some() || t.default.is_some() { unimplemented!(); }
1153 _ => unimplemented!(),
1156 if had_params { write!(w, ">").unwrap(); }
1159 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>) {
1160 write!(w, "<").unwrap();
1161 for (idx, arg) in generics.enumerate() {
1162 if idx != 0 { write!(w, ", ").unwrap(); }
1164 syn::GenericArgument::Type(t) => self.write_rust_type(w, generics_resolver, t),
1165 _ => unimplemented!(),
1168 write!(w, ">").unwrap();
1170 pub fn write_rust_type<W: std::io::Write>(&self, w: &mut W, generics: Option<&GenericTypes>, t: &syn::Type) {
1172 syn::Type::Path(p) => {
1173 if p.qself.is_some() {
1176 self.write_rust_path(w, generics, &p.path);
1178 syn::Type::Reference(r) => {
1179 write!(w, "&").unwrap();
1180 if let Some(lft) = &r.lifetime {
1181 write!(w, "'{} ", lft.ident).unwrap();
1183 if r.mutability.is_some() {
1184 write!(w, "mut ").unwrap();
1186 self.write_rust_type(w, generics, &*r.elem);
1188 syn::Type::Array(a) => {
1189 write!(w, "[").unwrap();
1190 self.write_rust_type(w, generics, &a.elem);
1191 if let syn::Expr::Lit(l) = &a.len {
1192 if let syn::Lit::Int(i) = &l.lit {
1193 write!(w, "; {}]", i).unwrap();
1194 } else { unimplemented!(); }
1195 } else { unimplemented!(); }
1197 syn::Type::Slice(s) => {
1198 write!(w, "[").unwrap();
1199 self.write_rust_type(w, generics, &s.elem);
1200 write!(w, "]").unwrap();
1202 syn::Type::Tuple(s) => {
1203 write!(w, "(").unwrap();
1204 for (idx, t) in s.elems.iter().enumerate() {
1205 if idx != 0 { write!(w, ", ").unwrap(); }
1206 self.write_rust_type(w, generics, &t);
1208 write!(w, ")").unwrap();
1210 _ => unimplemented!(),
1214 /// Prints a constructor for something which is "uninitialized" (but obviously not actually
1215 /// unint'd memory).
1216 pub fn write_empty_rust_val<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type) {
1218 syn::Type::Path(p) => {
1219 let resolved = self.resolve_path(&p.path, generics);
1220 if self.crate_types.opaques.get(&resolved).is_some() {
1221 write!(w, "crate::{} {{ inner: std::ptr::null_mut(), is_owned: true }}", resolved).unwrap();
1223 // Assume its a manually-mapped C type, where we can just define an null() fn
1224 write!(w, "{}::null()", self.c_type_from_path(&resolved, false, false).unwrap()).unwrap();
1227 syn::Type::Array(a) => {
1228 if let syn::Expr::Lit(l) = &a.len {
1229 if let syn::Lit::Int(i) = &l.lit {
1230 if i.base10_digits().parse::<usize>().unwrap() < 32 {
1231 // Blindly assume that if we're trying to create an empty value for an
1232 // array < 32 entries that all-0s may be a valid state.
1235 let arrty = format!("[u8; {}]", i.base10_digits());
1236 write!(w, "{}", self.to_c_conversion_inline_prefix_from_path(&arrty, false, false).unwrap()).unwrap();
1237 write!(w, "[0; {}]", i.base10_digits()).unwrap();
1238 write!(w, "{}", self.to_c_conversion_inline_suffix_from_path(&arrty, false, false).unwrap()).unwrap();
1239 } else { unimplemented!(); }
1240 } else { unimplemented!(); }
1242 _ => unimplemented!(),
1246 /// Prints a suffix to determine if a variable is empty (ie was set by write_empty_rust_val).
1247 /// See EmptyValExpectedTy for information on return types.
1248 fn write_empty_rust_val_check_suffix<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type) -> EmptyValExpectedTy {
1250 syn::Type::Path(p) => {
1251 let resolved = self.resolve_path(&p.path, generics);
1252 if self.crate_types.opaques.get(&resolved).is_some() {
1253 write!(w, ".inner.is_null()").unwrap();
1254 EmptyValExpectedTy::NonPointer
1256 if let Some(suffix) = self.empty_val_check_suffix_from_path(&resolved) {
1257 write!(w, "{}", suffix).unwrap();
1258 // We may eventually need to allow empty_val_check_suffix_from_path to specify if we need a deref or not
1259 EmptyValExpectedTy::NonPointer
1261 write!(w, " == std::ptr::null_mut()").unwrap();
1262 EmptyValExpectedTy::OwnedPointer
1266 syn::Type::Array(a) => {
1267 if let syn::Expr::Lit(l) = &a.len {
1268 if let syn::Lit::Int(i) = &l.lit {
1269 write!(w, " == [0; {}]", i.base10_digits()).unwrap();
1270 EmptyValExpectedTy::NonPointer
1271 } else { unimplemented!(); }
1272 } else { unimplemented!(); }
1274 syn::Type::Slice(_) => {
1275 // Option<[]> always implies that we want to treat len() == 0 differently from
1276 // None, so we always map an Option<[]> into a pointer.
1277 write!(w, " == std::ptr::null_mut()").unwrap();
1278 EmptyValExpectedTy::ReferenceAsPointer
1280 _ => unimplemented!(),
1284 /// Prints a suffix to determine if a variable is empty (ie was set by write_empty_rust_val).
1285 pub fn write_empty_rust_val_check<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type, var_access: &str) {
1287 syn::Type::Path(_) => {
1288 write!(w, "{}", var_access).unwrap();
1289 self.write_empty_rust_val_check_suffix(generics, w, t);
1291 syn::Type::Array(a) => {
1292 if let syn::Expr::Lit(l) = &a.len {
1293 if let syn::Lit::Int(i) = &l.lit {
1294 let arrty = format!("[u8; {}]", i.base10_digits());
1295 // We don't (yet) support a new-var conversion here.
1296 assert!(self.from_c_conversion_new_var_from_path(&arrty, false).is_none());
1298 self.from_c_conversion_prefix_from_path(&arrty, false).unwrap(),
1300 self.from_c_conversion_suffix_from_path(&arrty, false).unwrap()).unwrap();
1301 self.write_empty_rust_val_check_suffix(generics, w, t);
1302 } else { unimplemented!(); }
1303 } else { unimplemented!(); }
1305 _ => unimplemented!(),
1309 // ********************************
1310 // *** Type conversion printing ***
1311 // ********************************
1313 /// Returns true we if can just skip passing this to C entirely
1314 pub fn skip_arg(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> bool {
1316 syn::Type::Path(p) => {
1317 if p.qself.is_some() { unimplemented!(); }
1318 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
1319 self.skip_path(&full_path)
1322 syn::Type::Reference(r) => {
1323 self.skip_arg(&*r.elem, generics)
1328 pub fn no_arg_to_rust<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
1330 syn::Type::Path(p) => {
1331 if p.qself.is_some() { unimplemented!(); }
1332 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
1333 write!(w, "{}", self.no_arg_path_to_rust(&full_path)).unwrap();
1336 syn::Type::Reference(r) => {
1337 self.no_arg_to_rust(w, &*r.elem, generics);
1343 fn write_conversion_inline_intern<W: std::io::Write,
1344 LP: Fn(&str, bool, bool) -> Option<String>, DL: Fn(&mut W, &DeclType, &str, bool, bool), SC: Fn(bool) -> &'static str>
1345 (&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, is_ref: bool, is_mut: bool, ptr_for_ref: bool,
1346 tupleconv: &str, prefix: bool, sliceconv: SC, path_lookup: LP, decl_lookup: DL) {
1348 syn::Type::Reference(r) => {
1349 self.write_conversion_inline_intern(w, &*r.elem, generics, true, r.mutability.is_some(),
1350 ptr_for_ref, tupleconv, prefix, sliceconv, path_lookup, decl_lookup);
1352 syn::Type::Path(p) => {
1353 if p.qself.is_some() {
1357 let resolved_path = self.resolve_path(&p.path, generics);
1358 if let Some(aliased_type) = self.crate_types.type_aliases.get(&resolved_path) {
1359 return self.write_conversion_inline_intern(w, aliased_type, None, is_ref, is_mut, ptr_for_ref, tupleconv, prefix, sliceconv, path_lookup, decl_lookup);
1360 } else if let Some(c_type) = path_lookup(&resolved_path, is_ref, ptr_for_ref) {
1361 write!(w, "{}", c_type).unwrap();
1362 } else if self.crate_types.opaques.get(&resolved_path).is_some() {
1363 decl_lookup(w, &DeclType::StructImported, &resolved_path, is_ref, is_mut);
1364 } else if self.crate_types.mirrored_enums.get(&resolved_path).is_some() {
1365 decl_lookup(w, &DeclType::MirroredEnum, &resolved_path, is_ref, is_mut);
1366 } else if let Some(t) = self.crate_types.traits.get(&resolved_path) {
1367 decl_lookup(w, &DeclType::Trait(t), &resolved_path, is_ref, is_mut);
1368 } else if let Some(ident) = single_ident_generic_path_to_ident(&p.path) {
1369 if let Some(decl_type) = self.types.maybe_resolve_declared(ident) {
1370 decl_lookup(w, decl_type, &self.maybe_resolve_ident(ident).unwrap(), is_ref, is_mut);
1371 } else { unimplemented!(); }
1372 } else { unimplemented!(); }
1374 syn::Type::Array(a) => {
1375 // We assume all arrays contain only [int_literal; X]s.
1376 // This may result in some outputs not compiling.
1377 if let syn::Expr::Lit(l) = &a.len {
1378 if let syn::Lit::Int(i) = &l.lit {
1379 write!(w, "{}", path_lookup(&format!("[u8; {}]", i.base10_digits()), is_ref, ptr_for_ref).unwrap()).unwrap();
1380 } else { unimplemented!(); }
1381 } else { unimplemented!(); }
1383 syn::Type::Slice(s) => {
1384 // We assume all slices contain only literals or references.
1385 // This may result in some outputs not compiling.
1386 if let syn::Type::Path(p) = &*s.elem {
1387 let resolved = self.resolve_path(&p.path, generics);
1388 assert!(self.is_primitive(&resolved));
1389 write!(w, "{}", path_lookup("[u8]", is_ref, ptr_for_ref).unwrap()).unwrap();
1390 } else if let syn::Type::Reference(r) = &*s.elem {
1391 if let syn::Type::Path(p) = &*r.elem {
1392 write!(w, "{}", sliceconv(self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)))).unwrap();
1393 } else { unimplemented!(); }
1394 } else if let syn::Type::Tuple(t) = &*s.elem {
1395 assert!(!t.elems.is_empty());
1397 write!(w, "&local_").unwrap();
1399 let mut needs_map = false;
1400 for e in t.elems.iter() {
1401 if let syn::Type::Reference(_) = e {
1406 write!(w, ".iter().map(|(").unwrap();
1407 for i in 0..t.elems.len() {
1408 write!(w, "{}{}", if i != 0 { ", " } else { "" }, ('a' as u8 + i as u8) as char).unwrap();
1410 write!(w, ")| (").unwrap();
1411 for (idx, e) in t.elems.iter().enumerate() {
1412 if let syn::Type::Reference(_) = e {
1413 write!(w, "{}{}", if idx != 0 { ", " } else { "" }, (idx as u8 + 'a' as u8) as char).unwrap();
1414 } else if let syn::Type::Path(_) = e {
1415 write!(w, "{}*{}", if idx != 0 { ", " } else { "" }, (idx as u8 + 'a' as u8) as char).unwrap();
1416 } else { unimplemented!(); }
1418 write!(w, ")).collect::<Vec<_>>()[..]").unwrap();
1421 } else { unimplemented!(); }
1423 syn::Type::Tuple(t) => {
1424 if t.elems.is_empty() {
1425 // cbindgen has poor support for (), see, eg https://github.com/eqrion/cbindgen/issues/527
1426 // so work around it by just pretending its a 0u8
1427 write!(w, "{}", tupleconv).unwrap();
1429 if prefix { write!(w, "local_").unwrap(); }
1432 _ => unimplemented!(),
1436 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) {
1437 self.write_conversion_inline_intern(w, t, generics, is_ref, false, ptr_for_ref, "0u8 /*", true, |_| "local_",
1438 |a, b, c| self.to_c_conversion_inline_prefix_from_path(a, b, c),
1439 |w, decl_type, decl_path, is_ref, _is_mut| {
1441 DeclType::MirroredEnum if is_ref && ptr_for_ref => write!(w, "crate::{}::from_native(&", decl_path).unwrap(),
1442 DeclType::MirroredEnum if is_ref => write!(w, "&crate::{}::from_native(&", decl_path).unwrap(),
1443 DeclType::MirroredEnum => write!(w, "crate::{}::native_into(", decl_path).unwrap(),
1444 DeclType::EnumIgnored|DeclType::StructImported if is_ref && ptr_for_ref && from_ptr =>
1445 write!(w, "crate::{} {{ inner: unsafe {{ (", decl_path).unwrap(),
1446 DeclType::EnumIgnored|DeclType::StructImported if is_ref && ptr_for_ref =>
1447 write!(w, "crate::{} {{ inner: unsafe {{ ( (&(", decl_path).unwrap(),
1448 DeclType::EnumIgnored|DeclType::StructImported if is_ref =>
1449 write!(w, "&crate::{} {{ inner: unsafe {{ (", decl_path).unwrap(),
1450 DeclType::EnumIgnored|DeclType::StructImported if !is_ref && from_ptr =>
1451 write!(w, "crate::{} {{ inner: ", decl_path).unwrap(),
1452 DeclType::EnumIgnored|DeclType::StructImported if !is_ref =>
1453 write!(w, "crate::{} {{ inner: Box::into_raw(Box::new(", decl_path).unwrap(),
1454 DeclType::Trait(_) if is_ref => write!(w, "&").unwrap(),
1455 DeclType::Trait(_) if !is_ref => {},
1456 _ => panic!("{:?}", decl_path),
1460 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) {
1461 self.write_to_c_conversion_inline_prefix_inner(w, t, generics, false, ptr_for_ref, false);
1463 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) {
1464 self.write_conversion_inline_intern(w, t, generics, is_ref, false, ptr_for_ref, "*/", false, |_| ".into()",
1465 |a, b, c| self.to_c_conversion_inline_suffix_from_path(a, b, c),
1466 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
1467 DeclType::MirroredEnum => write!(w, ")").unwrap(),
1468 DeclType::EnumIgnored|DeclType::StructImported if is_ref && ptr_for_ref && from_ptr =>
1469 write!(w, " as *const _) as *mut _ }}, is_owned: false }}").unwrap(),
1470 DeclType::EnumIgnored|DeclType::StructImported if is_ref && ptr_for_ref =>
1471 write!(w, ") as *const _) as *mut _) }}, is_owned: false }}").unwrap(),
1472 DeclType::EnumIgnored|DeclType::StructImported if is_ref =>
1473 write!(w, " as *const _) as *mut _ }}, is_owned: false }}").unwrap(),
1474 DeclType::EnumIgnored|DeclType::StructImported if !is_ref && from_ptr =>
1475 write!(w, ", is_owned: true }}").unwrap(),
1476 DeclType::EnumIgnored|DeclType::StructImported if !is_ref => write!(w, ")), is_owned: true }}").unwrap(),
1477 DeclType::Trait(_) if is_ref => {},
1478 DeclType::Trait(_) => {
1479 // This is used when we're converting a concrete Rust type into a C trait
1480 // for use when a Rust trait method returns an associated type.
1481 // Because all of our C traits implement From<RustTypesImplementingTraits>
1482 // we can just call .into() here and be done.
1483 write!(w, ".into()").unwrap()
1485 _ => unimplemented!(),
1488 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) {
1489 self.write_to_c_conversion_inline_suffix_inner(w, t, generics, false, ptr_for_ref, false);
1492 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) {
1493 self.write_conversion_inline_intern(w, t, generics, is_ref, false, false, "() /*", true, |_| "&local_",
1494 |a, b, _c| self.from_c_conversion_prefix_from_path(a, b),
1495 |w, decl_type, _full_path, is_ref, is_mut| match decl_type {
1496 DeclType::StructImported if is_ref && ptr_for_ref => write!(w, "unsafe {{ &*(*").unwrap(),
1497 DeclType::StructImported if is_mut && is_ref => write!(w, "unsafe {{ &mut *").unwrap(),
1498 DeclType::StructImported if is_ref => write!(w, "unsafe {{ &*").unwrap(),
1499 DeclType::StructImported if !is_ref => write!(w, "*unsafe {{ Box::from_raw(").unwrap(),
1500 DeclType::MirroredEnum if is_ref => write!(w, "&").unwrap(),
1501 DeclType::MirroredEnum => {},
1502 DeclType::Trait(_) => {},
1503 _ => unimplemented!(),
1506 pub fn write_from_c_conversion_prefix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
1507 self.write_from_c_conversion_prefix_inner(w, t, generics, false, false);
1509 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) {
1510 self.write_conversion_inline_intern(w, t, generics, is_ref, false, false, "*/", false,
1511 |has_inner| match has_inner {
1512 false => ".iter().collect::<Vec<_>>()[..]",
1515 |a, b, _c| self.from_c_conversion_suffix_from_path(a, b),
1516 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
1517 DeclType::StructImported if is_ref && ptr_for_ref => write!(w, ").inner }}").unwrap(),
1518 DeclType::StructImported if is_ref => write!(w, ".inner }}").unwrap(),
1519 DeclType::StructImported if !is_ref => write!(w, ".take_inner()) }}").unwrap(),
1520 DeclType::MirroredEnum if is_ref => write!(w, ".to_native()").unwrap(),
1521 DeclType::MirroredEnum => write!(w, ".into_native()").unwrap(),
1522 DeclType::Trait(_) => {},
1523 _ => unimplemented!(),
1526 pub fn write_from_c_conversion_suffix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
1527 self.write_from_c_conversion_suffix_inner(w, t, generics, false, false);
1529 // Note that compared to the above conversion functions, the following two are generally
1530 // significantly undertested:
1531 pub fn write_from_c_conversion_to_ref_prefix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
1532 self.write_conversion_inline_intern(w, t, generics, false, false, false, "() /*", true, |_| "&local_",
1534 if let Some(conv) = self.from_c_conversion_prefix_from_path(a, b) {
1535 Some(format!("&{}", conv))
1538 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
1539 DeclType::StructImported if !is_ref => write!(w, "unsafe {{ &*").unwrap(),
1540 _ => unimplemented!(),
1543 pub fn write_from_c_conversion_to_ref_suffix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
1544 self.write_conversion_inline_intern(w, t, generics, false, false, false, "*/", false,
1545 |has_inner| match has_inner {
1546 false => ".iter().collect::<Vec<_>>()[..]",
1549 |a, b, _c| self.from_c_conversion_suffix_from_path(a, b),
1550 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
1551 DeclType::StructImported if !is_ref => write!(w, ".inner }}").unwrap(),
1552 _ => unimplemented!(),
1556 fn write_conversion_new_var_intern<'b, W: std::io::Write,
1557 LP: Fn(&str, bool) -> Option<(&str, &str)>,
1558 LC: Fn(&str, bool, Option<&syn::Type>, &syn::Ident, &str) -> Option<(&'b str, Vec<(String, String)>, &'b str)>,
1559 VP: Fn(&mut W, &syn::Type, Option<&GenericTypes>, bool, bool, bool),
1560 VS: Fn(&mut W, &syn::Type, Option<&GenericTypes>, bool, bool, bool)>
1561 (&self, w: &mut W, ident: &syn::Ident, var: &str, t: &syn::Type, generics: Option<&GenericTypes>,
1562 mut is_ref: bool, mut ptr_for_ref: bool, to_c: bool,
1563 path_lookup: &LP, container_lookup: &LC, var_prefix: &VP, var_suffix: &VS) -> bool {
1565 macro_rules! convert_container {
1566 ($container_type: expr, $args_len: expr, $args_iter: expr) => { {
1567 // For slices (and Options), we refuse to directly map them as is_ref when they
1568 // aren't opaque types containing an inner pointer. This is due to the fact that,
1569 // in both cases, the actual higher-level type is non-is_ref.
1570 let ty_has_inner = if self.is_transparent_container(&$container_type, is_ref) || $container_type == "Slice" {
1571 let ty = $args_iter().next().unwrap();
1572 if $container_type == "Slice" && to_c {
1573 // "To C ptr_for_ref" means "return the regular object with is_owned
1574 // set to false", which is totally what we want in a slice if we're about to
1575 // set ty_has_inner.
1578 if let syn::Type::Reference(t) = ty {
1579 if let syn::Type::Path(p) = &*t.elem {
1580 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
1582 } else if let syn::Type::Path(p) = ty {
1583 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
1587 // Options get a bunch of special handling, since in general we map Option<>al
1588 // types into the same C type as non-Option-wrapped types. This ends up being
1589 // pretty manual here and most of the below special-cases are for Options.
1590 let mut needs_ref_map = false;
1591 let mut only_contained_type = None;
1592 let mut only_contained_has_inner = false;
1593 let mut contains_slice = false;
1594 if $args_len == 1 && self.is_transparent_container(&$container_type, is_ref) {
1595 only_contained_has_inner = ty_has_inner;
1596 let arg = $args_iter().next().unwrap();
1597 if let syn::Type::Reference(t) = arg {
1598 only_contained_type = Some(&*t.elem);
1599 if let syn::Type::Path(_) = &*t.elem {
1601 } else if let syn::Type::Slice(_) = &*t.elem {
1602 contains_slice = true;
1603 } else { return false; }
1604 needs_ref_map = true;
1605 } else if let syn::Type::Path(_) = arg {
1606 only_contained_type = Some(&arg);
1607 } else { unimplemented!(); }
1610 if let Some((prefix, conversions, suffix)) = container_lookup(&$container_type, is_ref && ty_has_inner, only_contained_type, ident, var) {
1611 assert_eq!(conversions.len(), $args_len);
1612 write!(w, "let mut local_{}{} = ", ident, if !to_c && needs_ref_map {"_base"} else { "" }).unwrap();
1613 if only_contained_has_inner && to_c {
1614 var_prefix(w, $args_iter().next().unwrap(), generics, is_ref, ptr_for_ref, true);
1616 write!(w, "{}{}", prefix, var).unwrap();
1618 for ((pfx, var_name), (idx, ty)) in conversions.iter().zip($args_iter().enumerate()) {
1619 let mut var = std::io::Cursor::new(Vec::new());
1620 write!(&mut var, "{}", var_name).unwrap();
1621 let var_access = String::from_utf8(var.into_inner()).unwrap();
1623 let conv_ty = if needs_ref_map { only_contained_type.as_ref().unwrap() } else { ty };
1625 write!(w, "{} {{ ", pfx).unwrap();
1626 let new_var_name = format!("{}_{}", ident, idx);
1627 let new_var = self.write_conversion_new_var_intern(w, &syn::Ident::new(&new_var_name, Span::call_site()),
1628 &var_access, conv_ty, generics, contains_slice || (is_ref && ty_has_inner), ptr_for_ref, to_c, path_lookup, container_lookup, var_prefix, var_suffix);
1629 if new_var { write!(w, " ").unwrap(); }
1630 if (!only_contained_has_inner || !to_c) && !contains_slice {
1631 var_prefix(w, conv_ty, generics, is_ref && ty_has_inner, ptr_for_ref, false);
1634 if !is_ref && !needs_ref_map && to_c && only_contained_has_inner {
1635 write!(w, "Box::into_raw(Box::new(").unwrap();
1637 write!(w, "{}{}", if contains_slice { "local_" } else { "" }, if new_var { new_var_name } else { var_access }).unwrap();
1638 if (!only_contained_has_inner || !to_c) && !contains_slice {
1639 var_suffix(w, conv_ty, generics, is_ref && ty_has_inner, ptr_for_ref, false);
1641 if !is_ref && !needs_ref_map && to_c && only_contained_has_inner {
1642 write!(w, "))").unwrap();
1644 write!(w, " }}").unwrap();
1646 write!(w, "{}", suffix).unwrap();
1647 if only_contained_has_inner && to_c {
1648 var_suffix(w, $args_iter().next().unwrap(), generics, is_ref, ptr_for_ref, true);
1650 write!(w, ";").unwrap();
1651 if !to_c && needs_ref_map {
1652 write!(w, " let mut local_{} = local_{}_base.as_ref()", ident, ident).unwrap();
1654 write!(w, ".map(|a| &a[..])").unwrap();
1656 write!(w, ";").unwrap();
1664 syn::Type::Reference(r) => {
1665 if let syn::Type::Slice(_) = &*r.elem {
1666 self.write_conversion_new_var_intern(w, ident, var, &*r.elem, generics, is_ref, ptr_for_ref, to_c, path_lookup, container_lookup, var_prefix, var_suffix)
1668 self.write_conversion_new_var_intern(w, ident, var, &*r.elem, generics, true, ptr_for_ref, to_c, path_lookup, container_lookup, var_prefix, var_suffix)
1671 syn::Type::Path(p) => {
1672 if p.qself.is_some() {
1675 let resolved_path = self.resolve_path(&p.path, generics);
1676 if let Some(aliased_type) = self.crate_types.type_aliases.get(&resolved_path) {
1677 return self.write_conversion_new_var_intern(w, ident, var, aliased_type, None, is_ref, ptr_for_ref, to_c, path_lookup, container_lookup, var_prefix, var_suffix);
1679 if self.is_known_container(&resolved_path, is_ref) || self.is_transparent_container(&resolved_path, is_ref) {
1680 if let syn::PathArguments::AngleBracketed(args) = &p.path.segments.iter().next().unwrap().arguments {
1681 convert_container!(resolved_path, args.args.len(), || args.args.iter().map(|arg| {
1682 if let syn::GenericArgument::Type(ty) = arg {
1684 } else { unimplemented!(); }
1686 } else { unimplemented!(); }
1688 if self.is_primitive(&resolved_path) {
1690 } else if let Some(ty_ident) = single_ident_generic_path_to_ident(&p.path) {
1691 if let Some((prefix, suffix)) = path_lookup(&resolved_path, is_ref) {
1692 write!(w, "let mut local_{} = {}{}{};", ident, prefix, var, suffix).unwrap();
1694 } else if self.types.maybe_resolve_declared(ty_ident).is_some() {
1699 syn::Type::Array(_) => {
1700 // We assume all arrays contain only primitive types.
1701 // This may result in some outputs not compiling.
1704 syn::Type::Slice(s) => {
1705 if let syn::Type::Path(p) = &*s.elem {
1706 let resolved = self.resolve_path(&p.path, generics);
1707 assert!(self.is_primitive(&resolved));
1708 let slice_path = format!("[{}]", resolved);
1709 if let Some((prefix, suffix)) = path_lookup(&slice_path, true) {
1710 write!(w, "let mut local_{} = {}{}{};", ident, prefix, var, suffix).unwrap();
1713 } else if let syn::Type::Reference(ty) = &*s.elem {
1714 let tyref = [&*ty.elem];
1716 convert_container!("Slice", 1, || tyref.iter());
1717 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
1718 } else if let syn::Type::Tuple(t) = &*s.elem {
1719 // When mapping into a temporary new var, we need to own all the underlying objects.
1720 // Thus, we drop any references inside the tuple and convert with non-reference types.
1721 let mut elems = syn::punctuated::Punctuated::new();
1722 for elem in t.elems.iter() {
1723 if let syn::Type::Reference(r) = elem {
1724 elems.push((*r.elem).clone());
1726 elems.push(elem.clone());
1729 let ty = [syn::Type::Tuple(syn::TypeTuple {
1730 paren_token: t.paren_token, elems
1734 convert_container!("Slice", 1, || ty.iter());
1735 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
1736 } else { unimplemented!() }
1738 syn::Type::Tuple(t) => {
1739 if !t.elems.is_empty() {
1740 // We don't (yet) support tuple elements which cannot be converted inline
1741 write!(w, "let (").unwrap();
1742 for idx in 0..t.elems.len() {
1743 if idx != 0 { write!(w, ", ").unwrap(); }
1744 write!(w, "{} orig_{}_{}", if is_ref { "ref" } else { "mut" }, ident, idx).unwrap();
1746 write!(w, ") = {}{}; ", var, if !to_c { ".to_rust()" } else { "" }).unwrap();
1747 // Like other template types, tuples are always mapped as their non-ref
1748 // versions for types which have different ref mappings. Thus, we convert to
1749 // non-ref versions and handle opaque types with inner pointers manually.
1750 for (idx, elem) in t.elems.iter().enumerate() {
1751 if let syn::Type::Path(p) = elem {
1752 let v_name = format!("orig_{}_{}", ident, idx);
1753 let tuple_elem_ident = syn::Ident::new(&v_name, Span::call_site());
1754 if self.write_conversion_new_var_intern(w, &tuple_elem_ident, &v_name, elem, generics,
1755 false, ptr_for_ref, to_c,
1756 path_lookup, container_lookup, var_prefix, var_suffix) {
1757 write!(w, " ").unwrap();
1758 // Opaque types with inner pointers shouldn't ever create new stack
1759 // variables, so we don't handle it and just assert that it doesn't
1761 assert!(!self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)));
1765 write!(w, "let mut local_{} = (", ident).unwrap();
1766 for (idx, elem) in t.elems.iter().enumerate() {
1767 let ty_has_inner = {
1769 // "To C ptr_for_ref" means "return the regular object with
1770 // is_owned set to false", which is totally what we want
1771 // if we're about to set ty_has_inner.
1774 if let syn::Type::Reference(t) = elem {
1775 if let syn::Type::Path(p) = &*t.elem {
1776 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
1778 } else if let syn::Type::Path(p) = elem {
1779 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
1782 if idx != 0 { write!(w, ", ").unwrap(); }
1783 var_prefix(w, elem, generics, is_ref && ty_has_inner, ptr_for_ref, false);
1784 if is_ref && ty_has_inner {
1785 // For ty_has_inner, the regular var_prefix mapping will take a
1786 // reference, so deref once here to make sure we keep the original ref.
1787 write!(w, "*").unwrap();
1789 write!(w, "orig_{}_{}", ident, idx).unwrap();
1790 if is_ref && !ty_has_inner {
1791 // If we don't have an inner variable's reference to maintain, just
1792 // hope the type is Clonable and use that.
1793 write!(w, ".clone()").unwrap();
1795 var_suffix(w, elem, generics, is_ref && ty_has_inner, ptr_for_ref, false);
1797 write!(w, "){};", if to_c { ".into()" } else { "" }).unwrap();
1801 _ => unimplemented!(),
1805 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) -> bool {
1806 self.write_conversion_new_var_intern(w, ident, var_access, t, generics, false, ptr_for_ref, true,
1807 &|a, b| self.to_c_conversion_new_var_from_path(a, b),
1808 &|a, b, c, d, e| self.to_c_conversion_container_new_var(generics, a, b, c, d, e),
1809 // We force ptr_for_ref here since we can't generate a ref on one line and use it later
1810 &|a, b, c, d, e, f| self.write_to_c_conversion_inline_prefix_inner(a, b, c, d, e, f),
1811 &|a, b, c, d, e, f| self.write_to_c_conversion_inline_suffix_inner(a, b, c, d, e, f))
1813 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 {
1814 self.write_to_c_conversion_new_var_inner(w, ident, &format!("{}", ident), t, generics, ptr_for_ref)
1816 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 {
1817 self.write_conversion_new_var_intern(w, ident, &format!("{}", ident), t, generics, false, false, false,
1818 &|a, b| self.from_c_conversion_new_var_from_path(a, b),
1819 &|a, b, c, d, e| self.from_c_conversion_container_new_var(generics, a, b, c, d, e),
1820 // We force ptr_for_ref here since we can't generate a ref on one line and use it later
1821 &|a, b, c, d, e, _f| self.write_from_c_conversion_prefix_inner(a, b, c, d, e),
1822 &|a, b, c, d, e, _f| self.write_from_c_conversion_suffix_inner(a, b, c, d, e))
1825 // ******************************************************
1826 // *** C Container Type Equivalent and alias Printing ***
1827 // ******************************************************
1829 fn write_template_generics<'b, W: std::io::Write>(&mut self, w: &mut W, args: &mut dyn Iterator<Item=&'b syn::Type>, generics: Option<&GenericTypes>, is_ref: bool) -> bool {
1830 assert!(!is_ref); // We don't currently support outer reference types
1831 for (idx, t) in args.enumerate() {
1833 write!(w, ", ").unwrap();
1835 if let syn::Type::Reference(r_arg) = t {
1836 if !self.write_c_type_intern(w, &*r_arg.elem, generics, false, false, false) { return false; }
1838 // While write_c_type_intern, above is correct, we don't want to blindly convert a
1839 // reference to something stupid, so check that the container is either opaque or a
1840 // predefined type (currently only Transaction).
1841 if let syn::Type::Path(p_arg) = &*r_arg.elem {
1842 let resolved = self.resolve_path(&p_arg.path, generics);
1843 assert!(self.crate_types.opaques.get(&resolved).is_some() ||
1844 self.c_type_from_path(&resolved, true, true).is_some(), "Template generics should be opaque or have a predefined mapping");
1845 } else { unimplemented!(); }
1847 if !self.write_c_type_intern(w, t, generics, false, false, false) { return false; }
1852 fn check_create_container(&mut self, mangled_container: String, container_type: &str, args: Vec<&syn::Type>, generics: Option<&GenericTypes>, is_ref: bool) -> bool {
1853 if !self.crate_types.templates_defined.get(&mangled_container).is_some() {
1854 let mut created_container: Vec<u8> = Vec::new();
1856 if container_type == "Result" {
1857 let mut a_ty: Vec<u8> = Vec::new();
1858 if let syn::Type::Tuple(tup) = args.iter().next().unwrap() {
1859 if tup.elems.is_empty() {
1860 write!(&mut a_ty, "()").unwrap();
1862 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t).take(1), generics, is_ref) { return false; }
1865 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t).take(1), generics, is_ref) { return false; }
1868 let mut b_ty: Vec<u8> = Vec::new();
1869 if let syn::Type::Tuple(tup) = args.iter().skip(1).next().unwrap() {
1870 if tup.elems.is_empty() {
1871 write!(&mut b_ty, "()").unwrap();
1873 if !self.write_template_generics(&mut b_ty, &mut args.iter().map(|t| *t).skip(1), generics, is_ref) { return false; }
1876 if !self.write_template_generics(&mut b_ty, &mut args.iter().map(|t| *t).skip(1), generics, is_ref) { return false; }
1879 let ok_str = String::from_utf8(a_ty).unwrap();
1880 let err_str = String::from_utf8(b_ty).unwrap();
1881 let is_clonable = self.is_clonable(&ok_str) && self.is_clonable(&err_str);
1882 write_result_block(&mut created_container, &mangled_container, &ok_str, &err_str, is_clonable);
1884 self.crate_types.clonable_types.insert(Self::generated_container_path().to_owned() + "::" + &mangled_container);
1886 } else if container_type == "Vec" {
1887 let mut a_ty: Vec<u8> = Vec::new();
1888 if !self.write_template_generics(&mut a_ty, &mut args.iter().map(|t| *t), generics, is_ref) { return false; }
1889 let ty = String::from_utf8(a_ty).unwrap();
1890 let is_clonable = self.is_clonable(&ty);
1891 write_vec_block(&mut created_container, &mangled_container, &ty, is_clonable);
1893 self.crate_types.clonable_types.insert(Self::generated_container_path().to_owned() + "::" + &mangled_container);
1895 } else if container_type.ends_with("Tuple") {
1896 let mut tuple_args = Vec::new();
1897 let mut is_clonable = true;
1898 for arg in args.iter() {
1899 let mut ty: Vec<u8> = Vec::new();
1900 if !self.write_template_generics(&mut ty, &mut [arg].iter().map(|t| **t), generics, is_ref) { return false; }
1901 let ty_str = String::from_utf8(ty).unwrap();
1902 if !self.is_clonable(&ty_str) {
1903 is_clonable = false;
1905 tuple_args.push(ty_str);
1907 write_tuple_block(&mut created_container, &mangled_container, &tuple_args, is_clonable);
1909 self.crate_types.clonable_types.insert(Self::generated_container_path().to_owned() + "::" + &mangled_container);
1914 self.crate_types.templates_defined.insert(mangled_container.clone(), true);
1916 self.crate_types.template_file.write(&created_container).unwrap();
1920 fn path_to_generic_args(path: &syn::Path) -> Vec<&syn::Type> {
1921 if let syn::PathArguments::AngleBracketed(args) = &path.segments.iter().next().unwrap().arguments {
1922 args.args.iter().map(|gen| if let syn::GenericArgument::Type(t) = gen { t } else { unimplemented!() }).collect()
1923 } else { unimplemented!(); }
1925 fn write_c_mangled_container_path_intern<W: std::io::Write>
1926 (&mut 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 {
1927 let mut mangled_type: Vec<u8> = Vec::new();
1928 if !self.is_transparent_container(ident, is_ref) {
1929 write!(w, "C{}_", ident).unwrap();
1930 write!(mangled_type, "C{}_", ident).unwrap();
1931 } else { assert_eq!(args.len(), 1); }
1932 for arg in args.iter() {
1933 macro_rules! write_path {
1934 ($p_arg: expr, $extra_write: expr) => {
1935 if let Some(subtype) = self.maybe_resolve_path(&$p_arg.path, generics) {
1936 if self.is_transparent_container(ident, is_ref) {
1937 // We dont (yet) support primitives or containers inside transparent
1938 // containers, so check for that first:
1939 if self.is_primitive(&subtype) { return false; }
1940 if self.is_known_container(&subtype, is_ref) { return false; }
1942 if self.c_type_has_inner_from_path(&subtype) {
1943 if !self.write_c_path_intern(w, &$p_arg.path, generics, is_ref, is_mut, ptr_for_ref) { return false; }
1945 // Option<T> needs to be converted to a *mut T, ie mut ptr-for-ref
1946 if !self.write_c_path_intern(w, &$p_arg.path, generics, true, true, true) { return false; }
1949 write!(w, "{}", $p_arg.path.segments.last().unwrap().ident).unwrap();
1951 } else if self.is_known_container(&subtype, is_ref) || self.is_transparent_container(&subtype, is_ref) {
1952 if !self.write_c_mangled_container_path_intern(w, Self::path_to_generic_args(&$p_arg.path), generics,
1953 &subtype, is_ref, is_mut, ptr_for_ref, true) {
1956 self.write_c_mangled_container_path_intern(&mut mangled_type, Self::path_to_generic_args(&$p_arg.path),
1957 generics, &subtype, is_ref, is_mut, ptr_for_ref, true);
1958 if let Some(w2) = $extra_write as Option<&mut Vec<u8>> {
1959 self.write_c_mangled_container_path_intern(w2, Self::path_to_generic_args(&$p_arg.path),
1960 generics, &subtype, is_ref, is_mut, ptr_for_ref, true);
1963 let id = subtype.rsplitn(2, ':').next().unwrap(); // Get the "Base" name of the resolved type
1964 write!(w, "{}", id).unwrap();
1965 write!(mangled_type, "{}", id).unwrap();
1966 if let Some(w2) = $extra_write as Option<&mut Vec<u8>> {
1967 write!(w2, "{}", id).unwrap();
1970 } else { return false; }
1973 if let syn::Type::Tuple(tuple) = arg {
1974 if tuple.elems.len() == 0 {
1975 write!(w, "None").unwrap();
1976 write!(mangled_type, "None").unwrap();
1978 let mut mangled_tuple_type: Vec<u8> = Vec::new();
1980 // Figure out what the mangled type should look like. To disambiguate
1981 // ((A, B), C) and (A, B, C) we prefix the generic args with a _ and suffix
1982 // them with a Z. Ideally we wouldn't use Z, but not many special chars are
1983 // available for use in type names.
1984 write!(w, "C{}Tuple_", tuple.elems.len()).unwrap();
1985 write!(mangled_type, "C{}Tuple_", tuple.elems.len()).unwrap();
1986 write!(mangled_tuple_type, "C{}Tuple_", tuple.elems.len()).unwrap();
1987 for elem in tuple.elems.iter() {
1988 if let syn::Type::Path(p) = elem {
1989 write_path!(p, Some(&mut mangled_tuple_type));
1990 } else if let syn::Type::Reference(refelem) = elem {
1991 if let syn::Type::Path(p) = &*refelem.elem {
1992 write_path!(p, Some(&mut mangled_tuple_type));
1993 } else { return false; }
1994 } else { return false; }
1996 write!(w, "Z").unwrap();
1997 write!(mangled_type, "Z").unwrap();
1998 write!(mangled_tuple_type, "Z").unwrap();
1999 if !self.check_create_container(String::from_utf8(mangled_tuple_type).unwrap(),
2000 &format!("{}Tuple", tuple.elems.len()), tuple.elems.iter().collect(), generics, is_ref) {
2004 } else if let syn::Type::Path(p_arg) = arg {
2005 write_path!(p_arg, None);
2006 } else if let syn::Type::Reference(refty) = arg {
2007 if let syn::Type::Path(p_arg) = &*refty.elem {
2008 write_path!(p_arg, None);
2009 } else if let syn::Type::Slice(_) = &*refty.elem {
2010 // write_c_type will actually do exactly what we want here, we just need to
2011 // make it a pointer so that its an option. Note that we cannot always convert
2012 // the Vec-as-slice (ie non-ref types) containers, so sometimes need to be able
2013 // to edit it, hence we use *mut here instead of *const.
2014 if args.len() != 1 { return false; }
2015 write!(w, "*mut ").unwrap();
2016 self.write_c_type(w, arg, None, true);
2017 } else { return false; }
2018 } else if let syn::Type::Array(a) = arg {
2019 if let syn::Type::Path(p_arg) = &*a.elem {
2020 let resolved = self.resolve_path(&p_arg.path, generics);
2021 if !self.is_primitive(&resolved) { return false; }
2022 if let syn::Expr::Lit(syn::ExprLit { lit: syn::Lit::Int(len), .. }) = &a.len {
2023 if self.c_type_from_path(&format!("[{}; {}]", resolved, len.base10_digits()), is_ref, ptr_for_ref).is_none() { return false; }
2024 write!(w, "_{}{}", resolved, len.base10_digits()).unwrap();
2025 write!(mangled_type, "_{}{}", resolved, len.base10_digits()).unwrap();
2026 } else { return false; }
2027 } else { return false; }
2028 } else { return false; }
2030 if self.is_transparent_container(ident, is_ref) { return true; }
2031 // Push the "end of type" Z
2032 write!(w, "Z").unwrap();
2033 write!(mangled_type, "Z").unwrap();
2035 // Make sure the type is actually defined:
2036 self.check_create_container(String::from_utf8(mangled_type).unwrap(), ident, args, generics, is_ref)
2038 fn write_c_mangled_container_path<W: std::io::Write>(&mut self, w: &mut W, args: Vec<&syn::Type>, generics: Option<&GenericTypes>, ident: &str, is_ref: bool, is_mut: bool, ptr_for_ref: bool) -> bool {
2039 if !self.is_transparent_container(ident, is_ref) {
2040 write!(w, "{}::", Self::generated_container_path()).unwrap();
2042 self.write_c_mangled_container_path_intern(w, args, generics, ident, is_ref, is_mut, ptr_for_ref, false)
2045 // **********************************
2046 // *** C Type Equivalent Printing ***
2047 // **********************************
2049 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) -> bool {
2050 let full_path = match self.maybe_resolve_path(&path, generics) {
2051 Some(path) => path, None => return false };
2052 if let Some(c_type) = self.c_type_from_path(&full_path, is_ref, ptr_for_ref) {
2053 write!(w, "{}", c_type).unwrap();
2055 } else if self.crate_types.traits.get(&full_path).is_some() {
2056 if is_ref && ptr_for_ref {
2057 write!(w, "*{} crate::{}", if is_mut { "mut" } else { "const" }, full_path).unwrap();
2059 write!(w, "&{}crate::{}", if is_mut { "mut " } else { "" }, full_path).unwrap();
2061 write!(w, "crate::{}", full_path).unwrap();
2064 } else if self.crate_types.opaques.get(&full_path).is_some() || self.crate_types.mirrored_enums.get(&full_path).is_some() {
2065 if is_ref && ptr_for_ref {
2066 // ptr_for_ref implies we're returning the object, which we can't really do for
2067 // opaque or mirrored types without box'ing them, which is quite a waste, so return
2068 // the actual object itself (for opaque types we'll set the pointer to the actual
2069 // type and note that its a reference).
2070 write!(w, "crate::{}", full_path).unwrap();
2072 write!(w, "&{}crate::{}", if is_mut { "mut " } else { "" }, full_path).unwrap();
2074 write!(w, "crate::{}", full_path).unwrap();
2081 fn write_c_type_intern<W: std::io::Write>(&mut self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, is_ref: bool, is_mut: bool, ptr_for_ref: bool) -> bool {
2083 syn::Type::Path(p) => {
2084 if p.qself.is_some() {
2087 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
2088 if self.is_known_container(&full_path, is_ref) || self.is_transparent_container(&full_path, is_ref) {
2089 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);
2091 if let Some(aliased_type) = self.crate_types.type_aliases.get(&full_path).cloned() {
2092 return self.write_c_type_intern(w, &aliased_type, None, is_ref, is_mut, ptr_for_ref);
2095 self.write_c_path_intern(w, &p.path, generics, is_ref, is_mut, ptr_for_ref)
2097 syn::Type::Reference(r) => {
2098 self.write_c_type_intern(w, &*r.elem, generics, true, r.mutability.is_some(), ptr_for_ref)
2100 syn::Type::Array(a) => {
2101 if is_ref && is_mut {
2102 write!(w, "*mut [").unwrap();
2103 if !self.write_c_type_intern(w, &a.elem, generics, false, false, ptr_for_ref) { return false; }
2105 write!(w, "*const [").unwrap();
2106 if !self.write_c_type_intern(w, &a.elem, generics, false, false, ptr_for_ref) { return false; }
2108 let mut typecheck = Vec::new();
2109 if !self.write_c_type_intern(&mut typecheck, &a.elem, generics, false, false, ptr_for_ref) { return false; }
2110 if typecheck[..] != ['u' as u8, '8' as u8] { return false; }
2112 if let syn::Expr::Lit(l) = &a.len {
2113 if let syn::Lit::Int(i) = &l.lit {
2115 if let Some(ty) = self.c_type_from_path(&format!("[u8; {}]", i.base10_digits()), false, ptr_for_ref) {
2116 write!(w, "{}", ty).unwrap();
2120 write!(w, "; {}]", i).unwrap();
2126 syn::Type::Slice(s) => {
2127 if !is_ref || is_mut { return false; }
2128 if let syn::Type::Path(p) = &*s.elem {
2129 let resolved = self.resolve_path(&p.path, generics);
2130 if self.is_primitive(&resolved) {
2131 write!(w, "{}::{}slice", Self::container_templ_path(), resolved).unwrap();
2134 } else if let syn::Type::Reference(r) = &*s.elem {
2135 if let syn::Type::Path(p) = &*r.elem {
2136 // Slices with "real types" inside are mapped as the equivalent non-ref Vec
2137 let resolved = self.resolve_path(&p.path, generics);
2138 let mangled_container = if let Some(ident) = self.crate_types.opaques.get(&resolved) {
2139 format!("CVec_{}Z", ident)
2140 } else if let Some(en) = self.crate_types.mirrored_enums.get(&resolved) {
2141 format!("CVec_{}Z", en.ident)
2142 } else if let Some(id) = p.path.get_ident() {
2143 format!("CVec_{}Z", id)
2144 } else { return false; };
2145 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
2146 self.check_create_container(mangled_container, "Vec", vec![&*r.elem], generics, false)
2148 } else if let syn::Type::Tuple(_) = &*s.elem {
2149 let mut args = syn::punctuated::Punctuated::new();
2150 args.push(syn::GenericArgument::Type((*s.elem).clone()));
2151 let mut segments = syn::punctuated::Punctuated::new();
2152 segments.push(syn::PathSegment {
2153 ident: syn::Ident::new("Vec", Span::call_site()),
2154 arguments: syn::PathArguments::AngleBracketed(syn::AngleBracketedGenericArguments {
2155 colon2_token: None, lt_token: syn::Token![<](Span::call_site()), args, gt_token: syn::Token![>](Span::call_site()),
2158 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)
2161 syn::Type::Tuple(t) => {
2162 if t.elems.len() == 0 {
2165 self.write_c_mangled_container_path(w, t.elems.iter().collect(), generics,
2166 &format!("{}Tuple", t.elems.len()), is_ref, is_mut, ptr_for_ref)
2172 pub fn write_c_type<W: std::io::Write>(&mut self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, ptr_for_ref: bool) {
2173 assert!(self.write_c_type_intern(w, t, generics, false, false, ptr_for_ref));
2175 pub fn understood_c_path(&mut self, p: &syn::Path) -> bool {
2176 if p.leading_colon.is_some() { return false; }
2177 self.write_c_path_intern(&mut std::io::sink(), p, None, false, false, false)
2179 pub fn understood_c_type(&mut self, t: &syn::Type, generics: Option<&GenericTypes>) -> bool {
2180 self.write_c_type_intern(&mut std::io::sink(), t, generics, false, false, false)