1 use std::collections::HashMap;
6 use proc_macro2::{TokenTree, Span};
8 // The following utils are used purely to build our known types maps - they break down all the
9 // types we need to resolve to include the given object, and no more.
11 pub fn first_seg_self<'a>(t: &'a syn::Type) -> Option<impl Iterator<Item=&syn::PathSegment> + 'a> {
13 syn::Type::Path(p) => {
14 if p.qself.is_some() || p.path.leading_colon.is_some() {
17 let mut segs = p.path.segments.iter();
18 let ty = segs.next().unwrap();
19 if !ty.arguments.is_empty() { return None; }
20 if format!("{}", ty.ident) == "Self" {
28 pub fn get_single_remaining_path_seg<'a, I: Iterator<Item=&'a syn::PathSegment>>(segs: &mut I) -> Option<&'a syn::Ident> {
29 if let Some(ty) = segs.next() {
30 if !ty.arguments.is_empty() { unimplemented!(); }
31 if segs.next().is_some() { return None; }
36 pub fn single_ident_generic_path_to_ident(p: &syn::Path) -> Option<&syn::Ident> {
37 if p.segments.len() == 1 {
38 Some(&p.segments.iter().next().unwrap().ident)
42 #[derive(Debug, PartialEq)]
43 pub enum ExportStatus {
48 /// Gets the ExportStatus of an object (struct, fn, etc) given its attributes.
49 pub fn export_status(attrs: &[syn::Attribute]) -> ExportStatus {
50 for attr in attrs.iter() {
51 let tokens_clone = attr.tokens.clone();
52 let mut token_iter = tokens_clone.into_iter();
53 if let Some(token) = token_iter.next() {
55 TokenTree::Punct(c) if c.as_char() == '=' => {
56 // Really not sure where syn gets '=' from here -
57 // it somehow represents '///' or '//!'
59 TokenTree::Group(g) => {
60 if format!("{}", single_ident_generic_path_to_ident(&attr.path).unwrap()) == "cfg" {
61 let mut iter = g.stream().into_iter();
62 if let TokenTree::Ident(i) = iter.next().unwrap() {
64 // #[cfg(any(test, feature = ""))]
65 if let TokenTree::Group(g) = iter.next().unwrap() {
66 if let TokenTree::Ident(i) = g.stream().into_iter().next().unwrap() {
67 if i == "test" || i == "feature" {
68 // If its cfg(feature(...)) we assume its test-only
69 return ExportStatus::TestOnly;
73 } else if i == "test" || i == "feature" {
74 // If its cfg(feature(...)) we assume its test-only
75 return ExportStatus::TestOnly;
79 continue; // eg #[derive()]
81 _ => unimplemented!(),
84 match token_iter.next().unwrap() {
85 TokenTree::Literal(lit) => {
86 let line = format!("{}", lit);
87 if line.contains("(C-not exported)") {
88 return ExportStatus::NoExport;
91 _ => unimplemented!(),
97 pub fn assert_simple_bound(bound: &syn::TraitBound) {
98 if bound.paren_token.is_some() || bound.lifetimes.is_some() { unimplemented!(); }
99 if let syn::TraitBoundModifier::Maybe(_) = bound.modifier { unimplemented!(); }
102 /// A stack of sets of generic resolutions.
104 /// This tracks the template parameters for a function, struct, or trait, allowing resolution into
105 /// a concrete type. By pushing a new context onto the stack, this can track a function's template
106 /// parameters inside of a generic struct or trait.
108 /// It maps both direct types as well as Deref<Target = X>, mapping them via the provided
109 /// TypeResolver's resolve_path function (ie traits map to the concrete jump table, structs to the
110 /// concrete C container struct, etc).
111 pub struct GenericTypes<'a> {
112 typed_generics: Vec<HashMap<&'a syn::Ident, (String, Option<&'a syn::Path>)>>,
114 impl<'a> GenericTypes<'a> {
115 pub fn new() -> Self {
116 Self { typed_generics: vec![HashMap::new()], }
119 /// push a new context onto the stack, allowing for a new set of generics to be learned which
120 /// will override any lower contexts, but which will still fall back to resoltion via lower
122 pub fn push_ctx(&mut self) {
123 self.typed_generics.push(HashMap::new());
125 /// pop the latest context off the stack.
126 pub fn pop_ctx(&mut self) {
127 self.typed_generics.pop();
130 /// Learn the generics in generics in the current context, given a TypeResolver.
131 pub fn learn_generics<'b, 'c>(&mut self, generics: &'a syn::Generics, types: &'b TypeResolver<'a, 'c>) -> bool {
132 for generic in generics.params.iter() {
134 syn::GenericParam::Type(type_param) => {
135 let mut non_lifetimes_processed = false;
136 for bound in type_param.bounds.iter() {
137 if let syn::TypeParamBound::Trait(trait_bound) = bound {
138 if let Some(ident) = single_ident_generic_path_to_ident(&trait_bound.path) {
139 match &format!("{}", ident) as &str { "Send" => continue, "Sync" => continue, _ => {} }
142 assert_simple_bound(&trait_bound);
143 if let Some(mut path) = types.maybe_resolve_path(&trait_bound.path, None) {
144 if types.skip_path(&path) { continue; }
145 if non_lifetimes_processed { return false; }
146 non_lifetimes_processed = true;
147 let new_ident = if path != "std::ops::Deref" {
148 path = "crate::".to_string() + &path;
149 Some(&trait_bound.path)
151 self.typed_generics.last_mut().unwrap().insert(&type_param.ident, (path, new_ident));
152 } else { return false; }
159 if let Some(wh) = &generics.where_clause {
160 for pred in wh.predicates.iter() {
161 if let syn::WherePredicate::Type(t) = pred {
162 if let syn::Type::Path(p) = &t.bounded_ty {
163 if p.qself.is_some() { return false; }
164 if p.path.leading_colon.is_some() { return false; }
165 let mut p_iter = p.path.segments.iter();
166 if let Some(gen) = self.typed_generics.last_mut().unwrap().get_mut(&p_iter.next().unwrap().ident) {
167 if gen.0 != "std::ops::Deref" { return false; }
168 if &format!("{}", p_iter.next().unwrap().ident) != "Target" { return false; }
170 let mut non_lifetimes_processed = false;
171 for bound in t.bounds.iter() {
172 if let syn::TypeParamBound::Trait(trait_bound) = bound {
173 if non_lifetimes_processed { return false; }
174 non_lifetimes_processed = true;
175 assert_simple_bound(&trait_bound);
176 *gen = ("crate::".to_string() + &types.resolve_path(&trait_bound.path, None),
177 Some(&trait_bound.path));
180 } else { return false; }
181 } else { return false; }
185 for (_, (_, ident)) in self.typed_generics.last().unwrap().iter() {
186 if ident.is_none() { return false; }
191 /// Learn the associated types from the trait in the current context.
192 pub fn learn_associated_types<'b, 'c>(&mut self, t: &'a syn::ItemTrait, types: &'b TypeResolver<'a, 'c>) {
193 for item in t.items.iter() {
195 &syn::TraitItem::Type(ref t) => {
196 if t.default.is_some() || t.generics.lt_token.is_some() { unimplemented!(); }
197 let mut bounds_iter = t.bounds.iter();
198 match bounds_iter.next().unwrap() {
199 syn::TypeParamBound::Trait(tr) => {
200 assert_simple_bound(&tr);
201 if let Some(mut path) = types.maybe_resolve_path(&tr.path, None) {
202 if types.skip_path(&path) { continue; }
203 let new_ident = if path != "std::ops::Deref" {
204 path = "crate::".to_string() + &path;
207 self.typed_generics.last_mut().unwrap().insert(&t.ident, (path, new_ident));
208 } else { unimplemented!(); }
210 _ => unimplemented!(),
212 if bounds_iter.next().is_some() { unimplemented!(); }
219 /// Attempt to resolve an Ident as a generic parameter and return the full path.
220 pub fn maybe_resolve_ident<'b>(&'b self, ident: &syn::Ident) -> Option<&'b String> {
221 for gen in self.typed_generics.iter().rev() {
222 if let Some(res) = gen.get(ident).map(|(a, _)| a) {
228 /// Attempt to resolve a Path as a generic parameter and return the full path. as both a string
230 pub fn maybe_resolve_path<'b>(&'b self, path: &syn::Path) -> Option<(&'b String, &'a syn::Path)> {
231 if let Some(ident) = path.get_ident() {
232 for gen in self.typed_generics.iter().rev() {
233 if let Some(res) = gen.get(ident).map(|(a, b)| (a, b.unwrap())) {
238 let mut it = path.segments.iter();
239 if path.segments.len() == 2 && format!("{}", it.next().unwrap().ident) == "Self" {
240 let ident = &it.next().unwrap().ident;
241 for gen in self.typed_generics.iter().rev() {
242 if let Some(res) = gen.get(ident).map(|(a, b)| (a, b.unwrap())) {
252 #[derive(Clone, PartialEq)]
253 // The type of declaration and the object itself
254 pub enum DeclType<'a> {
256 Trait(&'a syn::ItemTrait),
262 // templates_defined is walked to write the C++ header, so if we use the default hashing it get
263 // reordered on each genbindings run. Instead, we use SipHasher (which defaults to 0-keys) so that
264 // the sorting is stable across runs. It is deprecated, but the "replacement" doesn't actually
265 // accomplish the same goals, so we just ignore it.
267 type NonRandomHash = hash::BuildHasherDefault<hash::SipHasher>;
269 /// Top-level struct tracking everything which has been defined while walking the crate.
270 pub struct CrateTypes<'a> {
271 /// This may contain structs or enums, but only when either is mapped as
272 /// struct X { inner: *mut originalX, .. }
273 pub opaques: HashMap<String, &'a syn::Ident>,
274 /// Enums which are mapped as C enums with conversion functions
275 pub mirrored_enums: HashMap<String, &'a syn::ItemEnum>,
276 /// Traits which are mapped as a pointer + jump table
277 pub traits: HashMap<String, &'a syn::ItemTrait>,
278 /// Aliases from paths to some other Type
279 pub type_aliases: HashMap<String, syn::Type>,
280 /// Template continer types defined, map from mangled type name -> whether a destructor fn
283 /// This is used at the end of processing to make C++ wrapper classes
284 pub templates_defined: HashMap<String, bool, NonRandomHash>,
285 /// The output file for any created template container types, written to as we find new
286 /// template containers which need to be defined.
287 pub template_file: &'a mut File,
290 /// A struct which tracks resolving rust types into C-mapped equivalents, exists for one specific
291 /// module but contains a reference to the overall CrateTypes tracking.
292 pub struct TypeResolver<'mod_lifetime, 'crate_lft: 'mod_lifetime> {
293 pub orig_crate: &'mod_lifetime str,
294 pub module_path: &'mod_lifetime str,
295 imports: HashMap<syn::Ident, String>,
296 // ident -> is-mirrored-enum
297 declared: HashMap<syn::Ident, DeclType<'crate_lft>>,
298 pub crate_types: &'mod_lifetime mut CrateTypes<'crate_lft>,
301 /// Returned by write_empty_rust_val_check_suffix to indicate what type of dereferencing needs to
302 /// happen to get the inner value of a generic.
303 enum EmptyValExpectedTy {
304 /// A type which has a flag for being empty (eg an array where we treat all-0s as empty).
306 /// A pointer that we want to dereference and move out of.
308 /// A pointer which we want to convert to a reference.
312 impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
313 pub fn new(orig_crate: &'a str, module_path: &'a str, crate_types: &'a mut CrateTypes<'c>) -> Self {
314 let mut imports = HashMap::new();
315 // Add primitives to the "imports" list:
316 imports.insert(syn::Ident::new("bool", Span::call_site()), "bool".to_string());
317 imports.insert(syn::Ident::new("u64", Span::call_site()), "u64".to_string());
318 imports.insert(syn::Ident::new("u32", Span::call_site()), "u32".to_string());
319 imports.insert(syn::Ident::new("u16", Span::call_site()), "u16".to_string());
320 imports.insert(syn::Ident::new("u8", Span::call_site()), "u8".to_string());
321 imports.insert(syn::Ident::new("usize", Span::call_site()), "usize".to_string());
322 imports.insert(syn::Ident::new("str", Span::call_site()), "str".to_string());
323 imports.insert(syn::Ident::new("String", Span::call_site()), "String".to_string());
325 // These are here to allow us to print native Rust types in trait fn impls even if we don't
327 imports.insert(syn::Ident::new("Result", Span::call_site()), "Result".to_string());
328 imports.insert(syn::Ident::new("Vec", Span::call_site()), "Vec".to_string());
329 imports.insert(syn::Ident::new("Option", Span::call_site()), "Option".to_string());
330 Self { orig_crate, module_path, imports, declared: HashMap::new(), crate_types }
333 // *************************************************
334 // *** Well know type and conversion definitions ***
335 // *************************************************
337 /// Returns true we if can just skip passing this to C entirely
338 fn skip_path(&self, full_path: &str) -> bool {
339 full_path == "bitcoin::secp256k1::Secp256k1" ||
340 full_path == "bitcoin::secp256k1::Signing" ||
341 full_path == "bitcoin::secp256k1::Verification"
343 /// Returns true we if can just skip passing this to C entirely
344 fn no_arg_path_to_rust(&self, full_path: &str) -> &str {
345 if full_path == "bitcoin::secp256k1::Secp256k1" {
346 "&bitcoin::secp256k1::Secp256k1::new()"
347 } else { unimplemented!(); }
350 /// Returns true if the object is a primitive and is mapped as-is with no conversion
352 pub fn is_primitive(&self, full_path: &str) -> bool {
363 /// Gets the C-mapped type for types which are outside of the crate, or which are manually
364 /// ignored by for some reason need mapping anyway.
365 fn c_type_from_path<'b>(&self, full_path: &'b str, is_ref: bool, ptr_for_ref: bool) -> Option<&'b str> {
366 if self.is_primitive(full_path) {
367 return Some(full_path);
370 "Result" => Some("crate::c_types::derived::CResult"),
371 "Vec" if !is_ref => Some("crate::c_types::derived::CVec"),
372 "Option" => Some(""),
374 // Note that no !is_ref types can map to an array because Rust and C's call semantics
375 // for arrays are different (https://github.com/eqrion/cbindgen/issues/528)
377 "[u8; 32]" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
378 "[u8; 16]" if !is_ref => Some("crate::c_types::SixteenBytes"),
379 "[u8; 10]" if !is_ref => Some("crate::c_types::TenBytes"),
380 "[u8; 4]" if !is_ref => Some("crate::c_types::FourBytes"),
381 "[u8; 3]" if !is_ref => Some("crate::c_types::ThreeBytes"), // Used for RGB values
383 "str" if is_ref => Some("crate::c_types::Str"),
384 "String" if !is_ref => Some("crate::c_types::derived::CVec_u8Z"),
385 "String" if is_ref => Some("crate::c_types::Str"),
387 "std::time::Duration" => Some("u64"),
389 "bitcoin::secp256k1::key::PublicKey" => Some("crate::c_types::PublicKey"),
390 "bitcoin::secp256k1::Signature" => Some("crate::c_types::Signature"),
391 "bitcoin::secp256k1::key::SecretKey" if is_ref => Some("*const [u8; 32]"),
392 "bitcoin::secp256k1::key::SecretKey" if !is_ref => Some("crate::c_types::SecretKey"),
393 "bitcoin::secp256k1::Error" if !is_ref => Some("crate::c_types::Secp256k1Error"),
394 "bitcoin::blockdata::script::Script" if is_ref => Some("crate::c_types::u8slice"),
395 "bitcoin::blockdata::script::Script" if !is_ref => Some("crate::c_types::derived::CVec_u8Z"),
396 "bitcoin::blockdata::transaction::OutPoint" => Some("crate::chain::transaction::OutPoint"),
397 "bitcoin::blockdata::transaction::Transaction" => Some("crate::c_types::Transaction"),
398 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some("crate::c_types::TxOut"),
399 "bitcoin::network::constants::Network" => Some("crate::bitcoin::network::Network"),
400 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some("*const [u8; 80]"),
401 "bitcoin::blockdata::block::Block" if is_ref => Some("crate::c_types::u8slice"),
403 // Newtypes that we just expose in their original form.
404 "bitcoin::hash_types::Txid" if is_ref => Some("*const [u8; 32]"),
405 "bitcoin::hash_types::Txid" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
406 "bitcoin::hash_types::BlockHash" if is_ref => Some("*const [u8; 32]"),
407 "bitcoin::hash_types::BlockHash" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
408 "bitcoin::secp256k1::Message" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
409 "ln::channelmanager::PaymentHash" if is_ref => Some("*const [u8; 32]"),
410 "ln::channelmanager::PaymentHash" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
411 "ln::channelmanager::PaymentPreimage" if is_ref => Some("*const [u8; 32]"),
412 "ln::channelmanager::PaymentPreimage" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
413 "ln::channelmanager::PaymentSecret" if is_ref => Some("crate::c_types::ThirtyTwoBytes"),
414 "ln::channelmanager::PaymentSecret" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
416 // Override the default since Records contain an fmt with a lifetime:
417 "util::logger::Record" => Some("*const std::os::raw::c_char"),
419 // List of structs we map that aren't detected:
420 "ln::features::InitFeatures" if is_ref && ptr_for_ref => Some("crate::ln::features::InitFeatures"),
421 "ln::features::InitFeatures" if is_ref => Some("*const crate::ln::features::InitFeatures"),
422 "ln::features::InitFeatures" => Some("crate::ln::features::InitFeatures"),
424 eprintln!(" Type {} (ref: {}) unresolvable in C", full_path, is_ref);
430 fn from_c_conversion_new_var_from_path<'b>(&self, _full_path: &str, _is_ref: bool) -> Option<(&'b str, &'b str)> {
433 fn from_c_conversion_prefix_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<String> {
434 if self.is_primitive(full_path) {
435 return Some("".to_owned());
438 "Vec" if !is_ref => Some("local_"),
439 "Result" if !is_ref => Some("local_"),
440 "Option" if is_ref => Some("&local_"),
441 "Option" => Some("local_"),
443 "[u8; 32]" if is_ref => Some("unsafe { &*"),
444 "[u8; 32]" if !is_ref => Some(""),
445 "[u8; 16]" if !is_ref => Some(""),
446 "[u8; 10]" if !is_ref => Some(""),
447 "[u8; 4]" if !is_ref => Some(""),
448 "[u8; 3]" if !is_ref => Some(""),
450 "[u8]" if is_ref => Some(""),
451 "[usize]" if is_ref => Some(""),
453 "str" if is_ref => Some(""),
454 "String" if !is_ref => Some("String::from_utf8("),
455 // Note that we'll panic for String if is_ref, as we only have non-owned memory, we
456 // cannot create a &String.
458 "std::time::Duration" => Some("std::time::Duration::from_secs("),
460 "bitcoin::secp256k1::key::PublicKey" if is_ref => Some("&"),
461 "bitcoin::secp256k1::key::PublicKey" => Some(""),
462 "bitcoin::secp256k1::Signature" if is_ref => Some("&"),
463 "bitcoin::secp256k1::Signature" => Some(""),
464 "bitcoin::secp256k1::key::SecretKey" if is_ref => Some("&::bitcoin::secp256k1::key::SecretKey::from_slice(&unsafe { *"),
465 "bitcoin::secp256k1::key::SecretKey" if !is_ref => Some(""),
466 "bitcoin::blockdata::script::Script" if is_ref => Some("&::bitcoin::blockdata::script::Script::from(Vec::from("),
467 "bitcoin::blockdata::script::Script" if !is_ref => Some("::bitcoin::blockdata::script::Script::from("),
468 "bitcoin::blockdata::transaction::Transaction" if is_ref => Some("&"),
469 "bitcoin::blockdata::transaction::Transaction" => Some(""),
470 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(""),
471 "bitcoin::network::constants::Network" => Some(""),
472 "bitcoin::blockdata::block::BlockHeader" => Some("&::bitcoin::consensus::encode::deserialize(unsafe { &*"),
473 "bitcoin::blockdata::block::Block" if is_ref => Some("&::bitcoin::consensus::encode::deserialize("),
475 // Newtypes that we just expose in their original form.
476 "bitcoin::hash_types::Txid" if is_ref => Some("&::bitcoin::hash_types::Txid::from_slice(&unsafe { &*"),
477 "bitcoin::hash_types::Txid" if !is_ref => Some("::bitcoin::hash_types::Txid::from_slice(&"),
478 "bitcoin::hash_types::BlockHash" => Some("::bitcoin::hash_types::BlockHash::from_slice(&"),
479 "ln::channelmanager::PaymentHash" if !is_ref => Some("::lightning::ln::channelmanager::PaymentHash("),
480 "ln::channelmanager::PaymentHash" if is_ref => Some("&::lightning::ln::channelmanager::PaymentHash(unsafe { *"),
481 "ln::channelmanager::PaymentPreimage" if !is_ref => Some("::lightning::ln::channelmanager::PaymentPreimage("),
482 "ln::channelmanager::PaymentPreimage" if is_ref => Some("&::lightning::ln::channelmanager::PaymentPreimage(unsafe { *"),
483 "ln::channelmanager::PaymentSecret" => Some("::lightning::ln::channelmanager::PaymentSecret("),
485 // List of structs we map (possibly during processing of other files):
486 "ln::features::InitFeatures" if !is_ref => Some("*unsafe { Box::from_raw("),
488 // List of traits we map (possibly during processing of other files):
489 "crate::util::logger::Logger" => Some(""),
492 eprintln!(" Type {} unconvertable from C", full_path);
495 }.map(|s| s.to_owned())
497 fn from_c_conversion_suffix_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<String> {
498 if self.is_primitive(full_path) {
499 return Some("".to_owned());
502 "Vec" if !is_ref => Some(""),
503 "Option" => Some(""),
504 "Result" if !is_ref => Some(""),
506 "[u8; 32]" if is_ref => Some("}"),
507 "[u8; 32]" if !is_ref => Some(".data"),
508 "[u8; 16]" if !is_ref => Some(".data"),
509 "[u8; 10]" if !is_ref => Some(".data"),
510 "[u8; 4]" if !is_ref => Some(".data"),
511 "[u8; 3]" if !is_ref => Some(".data"),
513 "[u8]" if is_ref => Some(".to_slice()"),
514 "[usize]" if is_ref => Some(".to_slice()"),
516 "str" if is_ref => Some(".into()"),
517 "String" if !is_ref => Some(".into_rust()).unwrap()"),
519 "std::time::Duration" => Some(")"),
521 "bitcoin::secp256k1::key::PublicKey" => Some(".into_rust()"),
522 "bitcoin::secp256k1::Signature" => Some(".into_rust()"),
523 "bitcoin::secp256k1::key::SecretKey" if !is_ref => Some(".into_rust()"),
524 "bitcoin::secp256k1::key::SecretKey" if is_ref => Some("}[..]).unwrap()"),
525 "bitcoin::blockdata::script::Script" if is_ref => Some(".to_slice()))"),
526 "bitcoin::blockdata::script::Script" if !is_ref => Some(".into_rust())"),
527 "bitcoin::blockdata::transaction::Transaction" => Some(".into_bitcoin()"),
528 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(".into_rust()"),
529 "bitcoin::network::constants::Network" => Some(".into_bitcoin()"),
530 "bitcoin::blockdata::block::BlockHeader" => Some(" }).unwrap()"),
531 "bitcoin::blockdata::block::Block" => Some(".to_slice()).unwrap()"),
533 // Newtypes that we just expose in their original form.
534 "bitcoin::hash_types::Txid" if is_ref => Some(" }[..]).unwrap()"),
535 "bitcoin::hash_types::Txid" => Some(".data[..]).unwrap()"),
536 "bitcoin::hash_types::BlockHash" if !is_ref => Some(".data[..]).unwrap()"),
537 "ln::channelmanager::PaymentHash" if !is_ref => Some(".data)"),
538 "ln::channelmanager::PaymentHash" if is_ref => Some(" })"),
539 "ln::channelmanager::PaymentPreimage" if !is_ref => Some(".data)"),
540 "ln::channelmanager::PaymentPreimage" if is_ref => Some(" })"),
541 "ln::channelmanager::PaymentSecret" => Some(".data)"),
543 // List of structs we map (possibly during processing of other files):
544 "ln::features::InitFeatures" if is_ref => Some(".inner) }"),
545 "ln::features::InitFeatures" if !is_ref => Some(".take_inner()) }"),
547 // List of traits we map (possibly during processing of other files):
548 "crate::util::logger::Logger" => Some(""),
551 eprintln!(" Type {} unconvertable from C", full_path);
554 }.map(|s| s.to_owned())
557 fn to_c_conversion_new_var_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<(&'b str, &'b str)> {
558 if self.is_primitive(full_path) {
562 "[u8]" if is_ref => Some(("crate::c_types::u8slice::from_slice(", ")")),
563 "[usize]" if is_ref => Some(("crate::c_types::usizeslice::from_slice(", ")")),
565 "bitcoin::blockdata::transaction::Transaction" if is_ref => Some(("::bitcoin::consensus::encode::serialize(", ")")),
566 "bitcoin::blockdata::transaction::Transaction" if !is_ref => Some(("::bitcoin::consensus::encode::serialize(&", ")")),
567 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some(("{ let mut s = [0u8; 80]; s[..].copy_from_slice(&::bitcoin::consensus::encode::serialize(", ")); s }")),
568 "bitcoin::blockdata::block::Block" if is_ref => Some(("::bitcoin::consensus::encode::serialize(", ")")),
569 "bitcoin::hash_types::Txid" => None,
571 // Override the default since Records contain an fmt with a lifetime:
572 // TODO: We should include the other record fields
573 "util::logger::Record" => Some(("std::ffi::CString::new(format!(\"{}\", ", ".args)).unwrap()")),
575 }.map(|s| s.to_owned())
577 fn to_c_conversion_inline_prefix_from_path(&self, full_path: &str, is_ref: bool, ptr_for_ref: bool) -> Option<String> {
578 if self.is_primitive(full_path) {
579 return Some("".to_owned());
582 "Result" if !is_ref => Some("local_"),
583 "Vec" if !is_ref => Some("local_"),
584 "Option" => Some("local_"),
586 "[u8; 32]" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
587 "[u8; 32]" if is_ref => Some("&"),
588 "[u8; 16]" if !is_ref => Some("crate::c_types::SixteenBytes { data: "),
589 "[u8; 10]" if !is_ref => Some("crate::c_types::TenBytes { data: "),
590 "[u8; 4]" if !is_ref => Some("crate::c_types::FourBytes { data: "),
591 "[u8; 3]" if is_ref => Some("&"),
593 "[u8]" if is_ref => Some("local_"),
594 "[usize]" if is_ref => Some("local_"),
596 "str" if is_ref => Some(""),
597 "String" => Some(""),
599 "std::time::Duration" => Some(""),
601 "bitcoin::secp256k1::key::PublicKey" => Some("crate::c_types::PublicKey::from_rust(&"),
602 "bitcoin::secp256k1::Signature" => Some("crate::c_types::Signature::from_rust(&"),
603 "bitcoin::secp256k1::key::SecretKey" if is_ref => Some(""),
604 "bitcoin::secp256k1::key::SecretKey" if !is_ref => Some("crate::c_types::SecretKey::from_rust("),
605 "bitcoin::secp256k1::Error" if !is_ref => Some("crate::c_types::Secp256k1Error::from_rust("),
606 "bitcoin::blockdata::script::Script" if is_ref => Some("crate::c_types::u8slice::from_slice(&"),
607 "bitcoin::blockdata::script::Script" if !is_ref => Some(""),
608 "bitcoin::blockdata::transaction::Transaction" => Some("crate::c_types::Transaction::from_vec(local_"),
609 "bitcoin::blockdata::transaction::OutPoint" => Some("crate::c_types::bitcoin_to_C_outpoint("),
610 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some("crate::c_types::TxOut::from_rust("),
611 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some("&local_"),
612 "bitcoin::blockdata::block::Block" if is_ref => Some("crate::c_types::u8slice::from_slice(&local_"),
614 "bitcoin::hash_types::Txid" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
616 // Newtypes that we just expose in their original form.
617 "bitcoin::hash_types::Txid" if is_ref => Some(""),
618 "bitcoin::hash_types::BlockHash" if is_ref => Some(""),
619 "bitcoin::hash_types::BlockHash" => Some("crate::c_types::ThirtyTwoBytes { data: "),
620 "bitcoin::secp256k1::Message" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
621 "ln::channelmanager::PaymentHash" if is_ref => Some("&"),
622 "ln::channelmanager::PaymentHash" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
623 "ln::channelmanager::PaymentPreimage" if is_ref => Some("&"),
624 "ln::channelmanager::PaymentPreimage" => Some("crate::c_types::ThirtyTwoBytes { data: "),
625 "ln::channelmanager::PaymentSecret" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
627 // Override the default since Records contain an fmt with a lifetime:
628 "util::logger::Record" => Some("local_"),
630 // List of structs we map (possibly during processing of other files):
631 "ln::features::InitFeatures" if is_ref && ptr_for_ref => Some("crate::ln::features::InitFeatures { inner: &mut "),
632 "ln::features::InitFeatures" if is_ref => Some("Box::into_raw(Box::new(crate::ln::features::InitFeatures { inner: &mut "),
633 "ln::features::InitFeatures" if !is_ref => Some("crate::ln::features::InitFeatures { inner: Box::into_raw(Box::new("),
636 eprintln!(" Type {} (is_ref: {}) unconvertable to C", full_path, is_ref);
639 }.map(|s| s.to_owned())
641 fn to_c_conversion_inline_suffix_from_path(&self, full_path: &str, is_ref: bool, ptr_for_ref: bool) -> Option<String> {
642 if self.is_primitive(full_path) {
643 return Some("".to_owned());
646 "Result" if !is_ref => Some(""),
647 "Vec" if !is_ref => Some(".into()"),
648 "Option" => Some(""),
650 "[u8; 32]" if !is_ref => Some(" }"),
651 "[u8; 32]" if is_ref => Some(""),
652 "[u8; 16]" if !is_ref => Some(" }"),
653 "[u8; 10]" if !is_ref => Some(" }"),
654 "[u8; 4]" if !is_ref => Some(" }"),
655 "[u8; 3]" if is_ref => Some(""),
657 "[u8]" if is_ref => Some(""),
658 "[usize]" if is_ref => Some(""),
660 "str" if is_ref => Some(".into()"),
661 "String" if !is_ref => Some(".into_bytes().into()"),
662 "String" if is_ref => Some(".as_str().into()"),
664 "std::time::Duration" => Some(".as_secs()"),
666 "bitcoin::secp256k1::key::PublicKey" => Some(")"),
667 "bitcoin::secp256k1::Signature" => Some(")"),
668 "bitcoin::secp256k1::key::SecretKey" if !is_ref => Some(")"),
669 "bitcoin::secp256k1::key::SecretKey" if is_ref => Some(".as_ref()"),
670 "bitcoin::secp256k1::Error" if !is_ref => Some(")"),
671 "bitcoin::blockdata::script::Script" if is_ref => Some("[..])"),
672 "bitcoin::blockdata::script::Script" if !is_ref => Some(".into_bytes().into()"),
673 "bitcoin::blockdata::transaction::Transaction" => Some(")"),
674 "bitcoin::blockdata::transaction::OutPoint" => Some(")"),
675 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(")"),
676 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some(""),
677 "bitcoin::blockdata::block::Block" if is_ref => Some(")"),
679 "bitcoin::hash_types::Txid" if !is_ref => Some(".into_inner() }"),
681 // Newtypes that we just expose in their original form.
682 "bitcoin::hash_types::Txid" if is_ref => Some(".as_inner()"),
683 "bitcoin::hash_types::BlockHash" if is_ref => Some(".as_inner()"),
684 "bitcoin::hash_types::BlockHash" => Some(".into_inner() }"),
685 "bitcoin::secp256k1::Message" if !is_ref => Some(".as_ref().clone() }"),
686 "ln::channelmanager::PaymentHash" if is_ref => Some(".0"),
687 "ln::channelmanager::PaymentHash" => Some(".0 }"),
688 "ln::channelmanager::PaymentPreimage" if is_ref => Some(".0"),
689 "ln::channelmanager::PaymentPreimage" => Some(".0 }"),
690 "ln::channelmanager::PaymentSecret" if !is_ref => Some(".0 }"),
692 // Override the default since Records contain an fmt with a lifetime:
693 "util::logger::Record" => Some(".as_ptr()"),
695 // List of structs we map (possibly during processing of other files):
696 "ln::features::InitFeatures" if is_ref && ptr_for_ref => Some(", is_owned: false }"),
697 "ln::features::InitFeatures" if is_ref => Some(", is_owned: false }))"),
698 "ln::features::InitFeatures" => Some(")), is_owned: true }"),
701 eprintln!(" Type {} unconvertable to C", full_path);
704 }.map(|s| s.to_owned())
707 fn empty_val_check_suffix_from_path(&self, full_path: &str) -> Option<&str> {
709 "ln::channelmanager::PaymentSecret" => Some(".data == [0; 32]"),
710 "bitcoin::secp256k1::key::PublicKey" => Some(".is_null()"),
711 "bitcoin::secp256k1::Signature" => Some(".is_null()"),
716 // ****************************
717 // *** Container Processing ***
718 // ****************************
720 /// Returns the module path in the generated mapping crate to the containers which we generate
721 /// when writing to CrateTypes::template_file.
722 fn generated_container_path() -> &'static str {
723 "crate::c_types::derived"
725 /// Returns the module path in the generated mapping crate to the container templates, which
726 /// are then concretized and put in the generated container path/template_file.
727 fn container_templ_path() -> &'static str {
731 /// Returns true if this is a "transparent" container, ie an Option or a container which does
732 /// not require a generated continer class.
733 fn is_transparent_container(&self, full_path: &str, _is_ref: bool) -> bool {
734 full_path == "Option"
736 /// Returns true if this is a known, supported, non-transparent container.
737 fn is_known_container(&self, full_path: &str, is_ref: bool) -> bool {
738 (full_path == "Result" && !is_ref) || (full_path == "Vec" && !is_ref) || full_path.ends_with("Tuple")
740 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)
741 // Returns prefix + Vec<(prefix, var-name-to-inline-convert)> + suffix
742 // expecting one element in the vec per generic type, each of which is inline-converted
743 -> Option<(&'b str, Vec<(String, String)>, &'b str)> {
745 "Result" if !is_ref => {
747 vec![(" { Ok(mut o) => crate::c_types::CResultTempl::ok(".to_string(), "o".to_string()),
748 ("), Err(mut e) => crate::c_types::CResultTempl::err(".to_string(), "e".to_string())],
751 "Vec" if !is_ref => {
752 Some(("Vec::new(); for item in ", vec![(format!(".drain(..) {{ local_{}.push(", var_name), "item".to_string())], "); }"))
755 Some(("Vec::new(); for item in ", vec![(format!(".iter() {{ local_{}.push(", var_name), "**item".to_string())], "); }"))
758 if let Some(syn::Type::Path(p)) = single_contained {
759 if self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)) {
761 return Some(("if ", vec![
762 (".is_none() { std::ptr::null() } else { ".to_owned(), format!("({}.as_ref().unwrap())", var_access))
765 return Some(("if ", vec![
766 (".is_none() { std::ptr::null_mut() } else { ".to_owned(), format!("({}.unwrap())", var_access))
771 if let Some(t) = single_contained {
772 let mut v = Vec::new();
773 self.write_empty_rust_val(generics, &mut v, t);
774 let s = String::from_utf8(v).unwrap();
775 return Some(("if ", vec![
776 (format!(".is_none() {{ {} }} else {{ ", s), format!("({}.unwrap())", var_access))
778 } else { unreachable!(); }
784 /// only_contained_has_inner implies that there is only one contained element in the container
785 /// and it has an inner field (ie is an "opaque" type we've defined).
786 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)
787 // Returns prefix + Vec<(prefix, var-name-to-inline-convert)> + suffix
788 // expecting one element in the vec per generic type, each of which is inline-converted
789 -> Option<(&'b str, Vec<(String, String)>, &'b str)> {
791 "Result" if !is_ref => {
793 vec![(".result_ok { true => Ok(".to_string(), format!("(*unsafe {{ Box::from_raw(<*mut _>::take_ptr(&mut {}.contents.result)) }})", var_name)),
794 ("), false => Err(".to_string(), format!("(*unsafe {{ Box::from_raw(<*mut _>::take_ptr(&mut {}.contents.err)) }})", var_name))],
797 "Vec"|"Slice" if !is_ref => {
798 Some(("Vec::new(); for mut item in ", vec![(format!(".into_rust().drain(..) {{ local_{}.push(", var_name), "item".to_string())], "); }"))
800 "Slice" if is_ref => {
801 Some(("Vec::new(); for mut item in ", vec![(format!(".as_slice().iter() {{ local_{}.push(", var_name), "item".to_string())], "); }"))
804 if let Some(syn::Type::Path(p)) = single_contained {
805 if self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)) {
807 return Some(("if ", vec![(".inner.is_null() { None } else { Some((*".to_string(), format!("{}", var_name))], ").clone()) }"))
809 return Some(("if ", vec![(".inner.is_null() { None } else { Some(".to_string(), format!("{}", var_name))], ") }"));
814 if let Some(t) = single_contained {
815 let mut v = Vec::new();
816 let ret_ref = self.write_empty_rust_val_check_suffix(generics, &mut v, t);
817 let s = String::from_utf8(v).unwrap();
819 EmptyValExpectedTy::ReferenceAsPointer =>
820 return Some(("if ", vec![
821 (format!("{} {{ None }} else {{ Some(", s), format!("unsafe {{ &mut *{} }}", var_access))
823 EmptyValExpectedTy::OwnedPointer =>
824 return Some(("if ", vec![
825 (format!("{} {{ None }} else {{ Some(", s), format!("unsafe {{ *Box::from_raw({}) }}", var_access))
827 EmptyValExpectedTy::NonPointer =>
828 return Some(("if ", vec![
829 (format!("{} {{ None }} else {{ Some(", s), format!("{}", var_access))
832 } else { unreachable!(); }
838 // *************************************************
839 // *** Type definition during main.rs processing ***
840 // *************************************************
842 fn process_use_intern<W: std::io::Write>(&mut self, w: &mut W, u: &syn::UseTree, partial_path: &str) {
844 syn::UseTree::Path(p) => {
845 let new_path = format!("{}::{}", partial_path, p.ident);
846 self.process_use_intern(w, &p.tree, &new_path);
848 syn::UseTree::Name(n) => {
849 let full_path = format!("{}::{}", partial_path, n.ident);
850 self.imports.insert(n.ident.clone(), full_path);
852 syn::UseTree::Group(g) => {
853 for i in g.items.iter() {
854 self.process_use_intern(w, i, partial_path);
857 syn::UseTree::Rename(r) => {
858 let full_path = format!("{}::{}", partial_path, r.ident);
859 self.imports.insert(r.rename.clone(), full_path);
861 syn::UseTree::Glob(_) => {
862 eprintln!("Ignoring * use for {} - this may result in resolution failures", partial_path);
866 pub fn process_use<W: std::io::Write>(&mut self, w: &mut W, u: &syn::ItemUse) {
867 if let syn::Visibility::Public(_) = u.vis {
868 // We actually only use these for #[cfg(fuzztarget)]
869 eprintln!("Ignoring pub(use) tree!");
873 syn::UseTree::Path(p) => {
874 let new_path = format!("{}", p.ident);
875 self.process_use_intern(w, &p.tree, &new_path);
877 syn::UseTree::Name(n) => {
878 let full_path = format!("{}", n.ident);
879 self.imports.insert(n.ident.clone(), full_path);
881 _ => unimplemented!(),
883 if u.leading_colon.is_some() { unimplemented!() }
886 pub fn mirrored_enum_declared(&mut self, ident: &syn::Ident) {
887 eprintln!("{} mirrored", ident);
888 self.declared.insert(ident.clone(), DeclType::MirroredEnum);
890 pub fn enum_ignored(&mut self, ident: &'c syn::Ident) {
891 self.declared.insert(ident.clone(), DeclType::EnumIgnored);
893 pub fn struct_imported(&mut self, ident: &'c syn::Ident, named: String) {
894 eprintln!("Imported {} as {}", ident, named);
895 self.declared.insert(ident.clone(), DeclType::StructImported);
897 pub fn struct_ignored(&mut self, ident: &syn::Ident) {
898 eprintln!("Not importing {}", ident);
899 self.declared.insert(ident.clone(), DeclType::StructIgnored);
901 pub fn trait_declared(&mut self, ident: &syn::Ident, t: &'c syn::ItemTrait) {
902 eprintln!("Trait {} created", ident);
903 self.declared.insert(ident.clone(), DeclType::Trait(t));
905 pub fn get_declared_type(&'a self, ident: &syn::Ident) -> Option<&'a DeclType<'c>> {
906 self.declared.get(ident)
908 /// Returns true if the object at the given path is mapped as X { inner: *mut origX, .. }.
909 fn c_type_has_inner_from_path(&self, full_path: &str) -> bool{
910 self.crate_types.opaques.get(full_path).is_some()
913 pub fn maybe_resolve_ident(&self, id: &syn::Ident) -> Option<String> {
914 if let Some(imp) = self.imports.get(id) {
916 } else if self.declared.get(id).is_some() {
917 Some(self.module_path.to_string() + "::" + &format!("{}", id))
921 pub fn maybe_resolve_non_ignored_ident(&self, id: &syn::Ident) -> Option<String> {
922 if let Some(imp) = self.imports.get(id) {
924 } else if let Some(decl_type) = self.declared.get(id) {
926 DeclType::StructIgnored => None,
927 _ => Some(self.module_path.to_string() + "::" + &format!("{}", id)),
932 pub fn maybe_resolve_path(&self, p_arg: &syn::Path, generics: Option<&GenericTypes>) -> Option<String> {
933 let p = if let Some(gen_types) = generics {
934 if let Some((_, synpath)) = gen_types.maybe_resolve_path(p_arg) {
939 if p.leading_colon.is_some() {
940 Some(p.segments.iter().enumerate().map(|(idx, seg)| {
941 format!("{}{}", if idx == 0 { "" } else { "::" }, seg.ident)
943 } else if let Some(id) = p.get_ident() {
944 self.maybe_resolve_ident(id)
946 if p.segments.len() == 1 {
947 let seg = p.segments.iter().next().unwrap();
948 return self.maybe_resolve_ident(&seg.ident);
950 let mut seg_iter = p.segments.iter();
951 let first_seg = seg_iter.next().unwrap();
952 let remaining: String = seg_iter.map(|seg| {
953 format!("::{}", seg.ident)
955 if let Some(imp) = self.imports.get(&first_seg.ident) {
957 Some(imp.clone() + &remaining)
964 pub fn resolve_path(&self, p: &syn::Path, generics: Option<&GenericTypes>) -> String {
965 self.maybe_resolve_path(p, generics).unwrap()
968 // ***********************************
969 // *** Original Rust Type Printing ***
970 // ***********************************
972 fn in_rust_prelude(resolved_path: &str) -> bool {
973 match resolved_path {
981 fn write_rust_path<W: std::io::Write>(&self, w: &mut W, generics_resolver: Option<&GenericTypes>, path: &syn::Path) {
982 if let Some(resolved) = self.maybe_resolve_path(&path, generics_resolver) {
983 if self.is_primitive(&resolved) {
984 write!(w, "{}", path.get_ident().unwrap()).unwrap();
986 // TODO: We should have a generic "is from a dependency" check here instead of
987 // checking for "bitcoin" explicitly.
988 if resolved.starts_with("bitcoin::") || Self::in_rust_prelude(&resolved) {
989 write!(w, "{}", resolved).unwrap();
990 // If we're printing a generic argument, it needs to reference the crate, otherwise
991 // the original crate:
992 } else if self.maybe_resolve_path(&path, None).as_ref() == Some(&resolved) {
993 write!(w, "{}::{}", self.orig_crate, resolved).unwrap();
995 write!(w, "crate::{}", resolved).unwrap();
998 if let syn::PathArguments::AngleBracketed(args) = &path.segments.iter().last().unwrap().arguments {
999 self.write_rust_generic_arg(w, generics_resolver, args.args.iter());
1002 if path.leading_colon.is_some() {
1003 write!(w, "::").unwrap();
1005 for (idx, seg) in path.segments.iter().enumerate() {
1006 if idx != 0 { write!(w, "::").unwrap(); }
1007 write!(w, "{}", seg.ident).unwrap();
1008 if let syn::PathArguments::AngleBracketed(args) = &seg.arguments {
1009 self.write_rust_generic_arg(w, generics_resolver, args.args.iter());
1014 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>) {
1015 let mut had_params = false;
1016 for (idx, arg) in generics.enumerate() {
1017 if idx != 0 { write!(w, ", ").unwrap(); } else { write!(w, "<").unwrap(); }
1020 syn::GenericParam::Lifetime(lt) => write!(w, "'{}", lt.lifetime.ident).unwrap(),
1021 syn::GenericParam::Type(t) => {
1022 write!(w, "{}", t.ident).unwrap();
1023 if t.colon_token.is_some() { write!(w, ":").unwrap(); }
1024 for (idx, bound) in t.bounds.iter().enumerate() {
1025 if idx != 0 { write!(w, " + ").unwrap(); }
1027 syn::TypeParamBound::Trait(tb) => {
1028 if tb.paren_token.is_some() || tb.lifetimes.is_some() { unimplemented!(); }
1029 self.write_rust_path(w, generics_resolver, &tb.path);
1031 _ => unimplemented!(),
1034 if t.eq_token.is_some() || t.default.is_some() { unimplemented!(); }
1036 _ => unimplemented!(),
1039 if had_params { write!(w, ">").unwrap(); }
1042 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>) {
1043 write!(w, "<").unwrap();
1044 for (idx, arg) in generics.enumerate() {
1045 if idx != 0 { write!(w, ", ").unwrap(); }
1047 syn::GenericArgument::Type(t) => self.write_rust_type(w, generics_resolver, t),
1048 _ => unimplemented!(),
1051 write!(w, ">").unwrap();
1053 pub fn write_rust_type<W: std::io::Write>(&self, w: &mut W, generics: Option<&GenericTypes>, t: &syn::Type) {
1055 syn::Type::Path(p) => {
1056 if p.qself.is_some() || p.path.leading_colon.is_some() {
1059 self.write_rust_path(w, generics, &p.path);
1061 syn::Type::Reference(r) => {
1062 write!(w, "&").unwrap();
1063 if let Some(lft) = &r.lifetime {
1064 write!(w, "'{} ", lft.ident).unwrap();
1066 if r.mutability.is_some() {
1067 write!(w, "mut ").unwrap();
1069 self.write_rust_type(w, generics, &*r.elem);
1071 syn::Type::Array(a) => {
1072 write!(w, "[").unwrap();
1073 self.write_rust_type(w, generics, &a.elem);
1074 if let syn::Expr::Lit(l) = &a.len {
1075 if let syn::Lit::Int(i) = &l.lit {
1076 write!(w, "; {}]", i).unwrap();
1077 } else { unimplemented!(); }
1078 } else { unimplemented!(); }
1080 syn::Type::Slice(s) => {
1081 write!(w, "[").unwrap();
1082 self.write_rust_type(w, generics, &s.elem);
1083 write!(w, "]").unwrap();
1085 syn::Type::Tuple(s) => {
1086 write!(w, "(").unwrap();
1087 for (idx, t) in s.elems.iter().enumerate() {
1088 if idx != 0 { write!(w, ", ").unwrap(); }
1089 self.write_rust_type(w, generics, &t);
1091 write!(w, ")").unwrap();
1093 _ => unimplemented!(),
1097 /// Prints a constructor for something which is "uninitialized" (but obviously not actually
1098 /// unint'd memory).
1099 pub fn write_empty_rust_val<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type) {
1101 syn::Type::Path(p) => {
1102 let resolved = self.resolve_path(&p.path, generics);
1103 if self.crate_types.opaques.get(&resolved).is_some() {
1104 write!(w, "crate::{} {{ inner: std::ptr::null_mut(), is_owned: true }}", resolved).unwrap();
1106 // Assume its a manually-mapped C type, where we can just define an null() fn
1107 write!(w, "{}::null()", self.c_type_from_path(&resolved, false, false).unwrap()).unwrap();
1110 syn::Type::Array(a) => {
1111 if let syn::Expr::Lit(l) = &a.len {
1112 if let syn::Lit::Int(i) = &l.lit {
1113 if i.base10_digits().parse::<usize>().unwrap() < 32 {
1114 // Blindly assume that if we're trying to create an empty value for an
1115 // array < 32 entries that all-0s may be a valid state.
1118 let arrty = format!("[u8; {}]", i.base10_digits());
1119 write!(w, "{}", self.to_c_conversion_inline_prefix_from_path(&arrty, false, false).unwrap()).unwrap();
1120 write!(w, "[0; {}]", i.base10_digits()).unwrap();
1121 write!(w, "{}", self.to_c_conversion_inline_suffix_from_path(&arrty, false, false).unwrap()).unwrap();
1122 } else { unimplemented!(); }
1123 } else { unimplemented!(); }
1125 _ => unimplemented!(),
1129 /// Prints a suffix to determine if a variable is empty (ie was set by write_empty_rust_val).
1130 /// See EmptyValExpectedTy for information on return types.
1131 fn write_empty_rust_val_check_suffix<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type) -> EmptyValExpectedTy {
1133 syn::Type::Path(p) => {
1134 let resolved = self.resolve_path(&p.path, generics);
1135 if self.crate_types.opaques.get(&resolved).is_some() {
1136 write!(w, ".inner.is_null()").unwrap();
1137 EmptyValExpectedTy::NonPointer
1139 if let Some(suffix) = self.empty_val_check_suffix_from_path(&resolved) {
1140 write!(w, "{}", suffix).unwrap();
1141 // We may eventually need to allow empty_val_check_suffix_from_path to specify if we need a deref or not
1142 EmptyValExpectedTy::NonPointer
1144 write!(w, " == std::ptr::null_mut()").unwrap();
1145 EmptyValExpectedTy::OwnedPointer
1149 syn::Type::Array(a) => {
1150 if let syn::Expr::Lit(l) = &a.len {
1151 if let syn::Lit::Int(i) = &l.lit {
1152 write!(w, " == [0; {}]", i.base10_digits()).unwrap();
1153 EmptyValExpectedTy::NonPointer
1154 } else { unimplemented!(); }
1155 } else { unimplemented!(); }
1157 syn::Type::Slice(_) => {
1158 // Option<[]> always implies that we want to treat len() == 0 differently from
1159 // None, so we always map an Option<[]> into a pointer.
1160 write!(w, " == std::ptr::null_mut()").unwrap();
1161 EmptyValExpectedTy::ReferenceAsPointer
1163 _ => unimplemented!(),
1167 /// Prints a suffix to determine if a variable is empty (ie was set by write_empty_rust_val).
1168 pub fn write_empty_rust_val_check<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type, var_access: &str) {
1170 syn::Type::Path(_) => {
1171 write!(w, "{}", var_access).unwrap();
1172 self.write_empty_rust_val_check_suffix(generics, w, t);
1174 syn::Type::Array(a) => {
1175 if let syn::Expr::Lit(l) = &a.len {
1176 if let syn::Lit::Int(i) = &l.lit {
1177 let arrty = format!("[u8; {}]", i.base10_digits());
1178 // We don't (yet) support a new-var conversion here.
1179 assert!(self.from_c_conversion_new_var_from_path(&arrty, false).is_none());
1181 self.from_c_conversion_prefix_from_path(&arrty, false).unwrap(),
1183 self.from_c_conversion_suffix_from_path(&arrty, false).unwrap()).unwrap();
1184 self.write_empty_rust_val_check_suffix(generics, w, t);
1185 } else { unimplemented!(); }
1186 } else { unimplemented!(); }
1188 _ => unimplemented!(),
1192 // ********************************
1193 // *** Type conversion printing ***
1194 // ********************************
1196 /// Returns true we if can just skip passing this to C entirely
1197 pub fn skip_arg(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> bool {
1199 syn::Type::Path(p) => {
1200 if p.qself.is_some() { unimplemented!(); }
1201 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
1202 self.skip_path(&full_path)
1205 syn::Type::Reference(r) => {
1206 self.skip_arg(&*r.elem, generics)
1211 pub fn no_arg_to_rust<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
1213 syn::Type::Path(p) => {
1214 if p.qself.is_some() { unimplemented!(); }
1215 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
1216 write!(w, "{}", self.no_arg_path_to_rust(&full_path)).unwrap();
1219 syn::Type::Reference(r) => {
1220 self.no_arg_to_rust(w, &*r.elem, generics);
1226 fn write_conversion_inline_intern<W: std::io::Write,
1227 LP: Fn(&str, bool, bool) -> Option<String>, DL: Fn(&mut W, &DeclType, &str, bool, bool), SC: Fn(bool) -> &'static str>
1228 (&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, is_ref: bool, is_mut: bool, ptr_for_ref: bool,
1229 tupleconv: &str, prefix: bool, sliceconv: SC, path_lookup: LP, decl_lookup: DL) {
1231 syn::Type::Reference(r) => {
1232 self.write_conversion_inline_intern(w, &*r.elem, generics, true, r.mutability.is_some(),
1233 ptr_for_ref, tupleconv, prefix, sliceconv, path_lookup, decl_lookup);
1235 syn::Type::Path(p) => {
1236 if p.qself.is_some() {
1240 let resolved_path = self.resolve_path(&p.path, generics);
1241 if let Some(aliased_type) = self.crate_types.type_aliases.get(&resolved_path) {
1242 return self.write_conversion_inline_intern(w, aliased_type, None, is_ref, is_mut, ptr_for_ref, tupleconv, prefix, sliceconv, path_lookup, decl_lookup);
1243 } else if let Some(c_type) = path_lookup(&resolved_path, is_ref, ptr_for_ref) {
1244 write!(w, "{}", c_type).unwrap();
1245 } else if self.crate_types.opaques.get(&resolved_path).is_some() {
1246 decl_lookup(w, &DeclType::StructImported, &resolved_path, is_ref, is_mut);
1247 } else if self.crate_types.mirrored_enums.get(&resolved_path).is_some() {
1248 decl_lookup(w, &DeclType::MirroredEnum, &resolved_path, is_ref, is_mut);
1249 } else if let Some(t) = self.crate_types.traits.get(&resolved_path) {
1250 decl_lookup(w, &DeclType::Trait(t), &resolved_path, is_ref, is_mut);
1251 } else if let Some(ident) = single_ident_generic_path_to_ident(&p.path) {
1252 if let Some(_) = self.imports.get(ident) {
1253 // crate_types lookup has to have succeeded:
1254 panic!("Failed to print inline conversion for {}", ident);
1255 } else if let Some(decl_type) = self.declared.get(ident) {
1256 decl_lookup(w, decl_type, &self.maybe_resolve_ident(ident).unwrap(), is_ref, is_mut);
1257 } else { unimplemented!(); }
1258 } else { unimplemented!(); }
1260 syn::Type::Array(a) => {
1261 // We assume all arrays contain only [int_literal; X]s.
1262 // This may result in some outputs not compiling.
1263 if let syn::Expr::Lit(l) = &a.len {
1264 if let syn::Lit::Int(i) = &l.lit {
1265 write!(w, "{}", path_lookup(&format!("[u8; {}]", i.base10_digits()), is_ref, ptr_for_ref).unwrap()).unwrap();
1266 } else { unimplemented!(); }
1267 } else { unimplemented!(); }
1269 syn::Type::Slice(s) => {
1270 // We assume all slices contain only literals or references.
1271 // This may result in some outputs not compiling.
1272 if let syn::Type::Path(p) = &*s.elem {
1273 let resolved = self.resolve_path(&p.path, generics);
1274 assert!(self.is_primitive(&resolved));
1275 write!(w, "{}", path_lookup("[u8]", is_ref, ptr_for_ref).unwrap()).unwrap();
1276 } else if let syn::Type::Reference(r) = &*s.elem {
1277 if let syn::Type::Path(p) = &*r.elem {
1278 write!(w, "{}", sliceconv(self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)))).unwrap();
1279 } else { unimplemented!(); }
1280 } else if let syn::Type::Tuple(t) = &*s.elem {
1281 assert!(!t.elems.is_empty());
1283 write!(w, "&local_").unwrap();
1285 let mut needs_map = false;
1286 for e in t.elems.iter() {
1287 if let syn::Type::Reference(_) = e {
1292 write!(w, ".iter().map(|(").unwrap();
1293 for i in 0..t.elems.len() {
1294 write!(w, "{}{}", if i != 0 { ", " } else { "" }, ('a' as u8 + i as u8) as char).unwrap();
1296 write!(w, ")| (").unwrap();
1297 for (idx, e) in t.elems.iter().enumerate() {
1298 if let syn::Type::Reference(_) = e {
1299 write!(w, "{}{}", if idx != 0 { ", " } else { "" }, (idx as u8 + 'a' as u8) as char).unwrap();
1300 } else if let syn::Type::Path(_) = e {
1301 write!(w, "{}*{}", if idx != 0 { ", " } else { "" }, (idx as u8 + 'a' as u8) as char).unwrap();
1302 } else { unimplemented!(); }
1304 write!(w, ")).collect::<Vec<_>>()[..]").unwrap();
1307 } else { unimplemented!(); }
1309 syn::Type::Tuple(t) => {
1310 if t.elems.is_empty() {
1311 // cbindgen has poor support for (), see, eg https://github.com/eqrion/cbindgen/issues/527
1312 // so work around it by just pretending its a 0u8
1313 write!(w, "{}", tupleconv).unwrap();
1315 if prefix { write!(w, "local_").unwrap(); }
1318 _ => unimplemented!(),
1322 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) {
1323 self.write_conversion_inline_intern(w, t, generics, is_ref, false, ptr_for_ref, "0u8 /*", true, |_| "local_",
1324 |a, b, c| self.to_c_conversion_inline_prefix_from_path(a, b, c),
1325 |w, decl_type, decl_path, is_ref, _is_mut| {
1327 DeclType::MirroredEnum if is_ref && ptr_for_ref => write!(w, "crate::{}::from_native(&", decl_path).unwrap(),
1328 DeclType::MirroredEnum if is_ref => write!(w, "&crate::{}::from_native(&", decl_path).unwrap(),
1329 DeclType::MirroredEnum => write!(w, "crate::{}::native_into(", decl_path).unwrap(),
1330 DeclType::EnumIgnored|DeclType::StructImported if is_ref && ptr_for_ref && from_ptr =>
1331 write!(w, "crate::{} {{ inner: unsafe {{ (", decl_path).unwrap(),
1332 DeclType::EnumIgnored|DeclType::StructImported if is_ref && ptr_for_ref =>
1333 write!(w, "crate::{} {{ inner: unsafe {{ ( (&(", decl_path).unwrap(),
1334 DeclType::EnumIgnored|DeclType::StructImported if is_ref =>
1335 write!(w, "&crate::{} {{ inner: unsafe {{ (", decl_path).unwrap(),
1336 DeclType::EnumIgnored|DeclType::StructImported if !is_ref && from_ptr =>
1337 write!(w, "crate::{} {{ inner: ", decl_path).unwrap(),
1338 DeclType::EnumIgnored|DeclType::StructImported if !is_ref =>
1339 write!(w, "crate::{} {{ inner: Box::into_raw(Box::new(", decl_path).unwrap(),
1340 DeclType::Trait(_) if is_ref => write!(w, "&").unwrap(),
1341 DeclType::Trait(_) if !is_ref => {},
1342 _ => panic!("{:?}", decl_path),
1346 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) {
1347 self.write_to_c_conversion_inline_prefix_inner(w, t, generics, false, ptr_for_ref, false);
1349 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) {
1350 self.write_conversion_inline_intern(w, t, generics, is_ref, false, ptr_for_ref, "*/", false, |_| ".into()",
1351 |a, b, c| self.to_c_conversion_inline_suffix_from_path(a, b, c),
1352 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
1353 DeclType::MirroredEnum => write!(w, ")").unwrap(),
1354 DeclType::EnumIgnored|DeclType::StructImported if is_ref && ptr_for_ref && from_ptr =>
1355 write!(w, " as *const _) as *mut _ }}, is_owned: false }}").unwrap(),
1356 DeclType::EnumIgnored|DeclType::StructImported if is_ref && ptr_for_ref =>
1357 write!(w, ") as *const _) as *mut _) }}, is_owned: false }}").unwrap(),
1358 DeclType::EnumIgnored|DeclType::StructImported if is_ref =>
1359 write!(w, " as *const _) as *mut _ }}, is_owned: false }}").unwrap(),
1360 DeclType::EnumIgnored|DeclType::StructImported if !is_ref && from_ptr =>
1361 write!(w, ", is_owned: true }}").unwrap(),
1362 DeclType::EnumIgnored|DeclType::StructImported if !is_ref => write!(w, ")), is_owned: true }}").unwrap(),
1363 DeclType::Trait(_) if is_ref => {},
1364 DeclType::Trait(_) => {
1365 // This is used when we're converting a concrete Rust type into a C trait
1366 // for use when a Rust trait method returns an associated type.
1367 // Because all of our C traits implement From<RustTypesImplementingTraits>
1368 // we can just call .into() here and be done.
1369 write!(w, ".into()").unwrap()
1371 _ => unimplemented!(),
1374 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) {
1375 self.write_to_c_conversion_inline_suffix_inner(w, t, generics, false, ptr_for_ref, false);
1378 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) {
1379 self.write_conversion_inline_intern(w, t, generics, is_ref, false, false, "() /*", true, |_| "&local_",
1380 |a, b, _c| self.from_c_conversion_prefix_from_path(a, b),
1381 |w, decl_type, _full_path, is_ref, is_mut| match decl_type {
1382 DeclType::StructImported if is_ref && ptr_for_ref => write!(w, "unsafe {{ &*(*").unwrap(),
1383 DeclType::StructImported if is_mut && is_ref => write!(w, "unsafe {{ &mut *").unwrap(),
1384 DeclType::StructImported if is_ref => write!(w, "unsafe {{ &*").unwrap(),
1385 DeclType::StructImported if !is_ref => write!(w, "*unsafe {{ Box::from_raw(").unwrap(),
1386 DeclType::MirroredEnum if is_ref => write!(w, "&").unwrap(),
1387 DeclType::MirroredEnum => {},
1388 DeclType::Trait(_) => {},
1389 _ => unimplemented!(),
1392 pub fn write_from_c_conversion_prefix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
1393 self.write_from_c_conversion_prefix_inner(w, t, generics, false, false);
1395 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) {
1396 self.write_conversion_inline_intern(w, t, generics, is_ref, false, false, "*/", false,
1397 |has_inner| match has_inner {
1398 false => ".iter().collect::<Vec<_>>()[..]",
1401 |a, b, _c| self.from_c_conversion_suffix_from_path(a, b),
1402 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
1403 DeclType::StructImported if is_ref && ptr_for_ref => write!(w, ").inner }}").unwrap(),
1404 DeclType::StructImported if is_ref => write!(w, ".inner }}").unwrap(),
1405 DeclType::StructImported if !is_ref => write!(w, ".take_inner()) }}").unwrap(),
1406 DeclType::MirroredEnum if is_ref => write!(w, ".to_native()").unwrap(),
1407 DeclType::MirroredEnum => write!(w, ".into_native()").unwrap(),
1408 DeclType::Trait(_) => {},
1409 _ => unimplemented!(),
1412 pub fn write_from_c_conversion_suffix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
1413 self.write_from_c_conversion_suffix_inner(w, t, generics, false, false);
1415 // Note that compared to the above conversion functions, the following two are generally
1416 // significantly undertested:
1417 pub fn write_from_c_conversion_to_ref_prefix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
1418 self.write_conversion_inline_intern(w, t, generics, false, false, false, "() /*", true, |_| "&local_",
1420 if let Some(conv) = self.from_c_conversion_prefix_from_path(a, b) {
1421 Some(format!("&{}", conv))
1424 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
1425 DeclType::StructImported if !is_ref => write!(w, "unsafe {{ &*").unwrap(),
1426 _ => unimplemented!(),
1429 pub fn write_from_c_conversion_to_ref_suffix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
1430 self.write_conversion_inline_intern(w, t, generics, false, false, false, "*/", false,
1431 |has_inner| match has_inner {
1432 false => ".iter().collect::<Vec<_>>()[..]",
1435 |a, b, _c| self.from_c_conversion_suffix_from_path(a, b),
1436 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
1437 DeclType::StructImported if !is_ref => write!(w, ".inner }}").unwrap(),
1438 _ => unimplemented!(),
1442 fn write_conversion_new_var_intern<'b, W: std::io::Write,
1443 LP: Fn(&str, bool) -> Option<(&str, &str)>,
1444 LC: Fn(&str, bool, Option<&syn::Type>, &syn::Ident, &str) -> Option<(&'b str, Vec<(String, String)>, &'b str)>,
1445 VP: Fn(&mut W, &syn::Type, Option<&GenericTypes>, bool, bool, bool),
1446 VS: Fn(&mut W, &syn::Type, Option<&GenericTypes>, bool, bool, bool)>
1447 (&self, w: &mut W, ident: &syn::Ident, var: &str, t: &syn::Type, generics: Option<&GenericTypes>,
1448 mut is_ref: bool, mut ptr_for_ref: bool, to_c: bool,
1449 path_lookup: &LP, container_lookup: &LC, var_prefix: &VP, var_suffix: &VS) -> bool {
1451 macro_rules! convert_container {
1452 ($container_type: expr, $args_len: expr, $args_iter: expr) => { {
1453 // For slices (and Options), we refuse to directly map them as is_ref when they
1454 // aren't opaque types containing an inner pointer. This is due to the fact that,
1455 // in both cases, the actual higher-level type is non-is_ref.
1456 let ty_has_inner = if self.is_transparent_container(&$container_type, is_ref) || $container_type == "Slice" {
1457 let ty = $args_iter().next().unwrap();
1458 if $container_type == "Slice" && to_c {
1459 // "To C ptr_for_ref" means "return the regular object with is_owned
1460 // set to false", which is totally what we want in a slice if we're about to
1461 // set ty_has_inner.
1464 if let syn::Type::Reference(t) = ty {
1465 if let syn::Type::Path(p) = &*t.elem {
1466 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
1468 } else if let syn::Type::Path(p) = ty {
1469 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
1473 // Options get a bunch of special handling, since in general we map Option<>al
1474 // types into the same C type as non-Option-wrapped types. This ends up being
1475 // pretty manual here and most of the below special-cases are for Options.
1476 let mut needs_ref_map = false;
1477 let mut only_contained_type = None;
1478 let mut only_contained_has_inner = false;
1479 let mut contains_slice = false;
1480 if $args_len == 1 && self.is_transparent_container(&$container_type, is_ref) {
1481 only_contained_has_inner = ty_has_inner;
1482 let arg = $args_iter().next().unwrap();
1483 if let syn::Type::Reference(t) = arg {
1484 only_contained_type = Some(&*t.elem);
1485 if let syn::Type::Path(_) = &*t.elem {
1487 } else if let syn::Type::Slice(_) = &*t.elem {
1488 contains_slice = true;
1489 } else { return false; }
1490 needs_ref_map = true;
1491 } else if let syn::Type::Path(_) = arg {
1492 only_contained_type = Some(&arg);
1493 } else { unimplemented!(); }
1496 if let Some((prefix, conversions, suffix)) = container_lookup(&$container_type, is_ref && ty_has_inner, only_contained_type, ident, var) {
1497 assert_eq!(conversions.len(), $args_len);
1498 write!(w, "let mut local_{}{} = ", ident, if !to_c && needs_ref_map {"_base"} else { "" }).unwrap();
1499 if only_contained_has_inner && to_c {
1500 var_prefix(w, $args_iter().next().unwrap(), generics, is_ref, ptr_for_ref, true);
1502 write!(w, "{}{}", prefix, var).unwrap();
1504 for ((pfx, var_name), (idx, ty)) in conversions.iter().zip($args_iter().enumerate()) {
1505 let mut var = std::io::Cursor::new(Vec::new());
1506 write!(&mut var, "{}", var_name).unwrap();
1507 let var_access = String::from_utf8(var.into_inner()).unwrap();
1509 let conv_ty = if needs_ref_map { only_contained_type.as_ref().unwrap() } else { ty };
1511 write!(w, "{} {{ ", pfx).unwrap();
1512 let new_var_name = format!("{}_{}", ident, idx);
1513 let new_var = self.write_conversion_new_var_intern(w, &syn::Ident::new(&new_var_name, Span::call_site()),
1514 &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);
1515 if new_var { write!(w, " ").unwrap(); }
1516 if (!only_contained_has_inner || !to_c) && !contains_slice {
1517 var_prefix(w, conv_ty, generics, is_ref && ty_has_inner, ptr_for_ref, false);
1520 if !is_ref && !needs_ref_map && to_c && only_contained_has_inner {
1521 write!(w, "Box::into_raw(Box::new(").unwrap();
1523 write!(w, "{}{}", if contains_slice { "local_" } else { "" }, if new_var { new_var_name } else { var_access }).unwrap();
1524 if (!only_contained_has_inner || !to_c) && !contains_slice {
1525 var_suffix(w, conv_ty, generics, is_ref && ty_has_inner, ptr_for_ref, false);
1527 if !is_ref && !needs_ref_map && to_c && only_contained_has_inner {
1528 write!(w, "))").unwrap();
1530 write!(w, " }}").unwrap();
1532 write!(w, "{}", suffix).unwrap();
1533 if only_contained_has_inner && to_c {
1534 var_suffix(w, $args_iter().next().unwrap(), generics, is_ref, ptr_for_ref, true);
1536 write!(w, ";").unwrap();
1537 if !to_c && needs_ref_map {
1538 write!(w, " let mut local_{} = local_{}_base.as_ref()", ident, ident).unwrap();
1540 write!(w, ".map(|a| &a[..])").unwrap();
1542 write!(w, ";").unwrap();
1550 syn::Type::Reference(r) => {
1551 if let syn::Type::Slice(_) = &*r.elem {
1552 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)
1554 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)
1557 syn::Type::Path(p) => {
1558 if p.qself.is_some() {
1561 let resolved_path = self.resolve_path(&p.path, generics);
1562 if let Some(aliased_type) = self.crate_types.type_aliases.get(&resolved_path) {
1563 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);
1565 if self.is_known_container(&resolved_path, is_ref) || self.is_transparent_container(&resolved_path, is_ref) {
1566 if let syn::PathArguments::AngleBracketed(args) = &p.path.segments.iter().next().unwrap().arguments {
1567 convert_container!(resolved_path, args.args.len(), || args.args.iter().map(|arg| {
1568 if let syn::GenericArgument::Type(ty) = arg {
1570 } else { unimplemented!(); }
1572 } else { unimplemented!(); }
1574 if self.is_primitive(&resolved_path) {
1576 } else if let Some(ty_ident) = single_ident_generic_path_to_ident(&p.path) {
1577 if let Some((prefix, suffix)) = path_lookup(&resolved_path, is_ref) {
1578 write!(w, "let mut local_{} = {}{}{};", ident, prefix, var, suffix).unwrap();
1580 } else if self.declared.get(ty_ident).is_some() {
1585 syn::Type::Array(_) => {
1586 // We assume all arrays contain only primitive types.
1587 // This may result in some outputs not compiling.
1590 syn::Type::Slice(s) => {
1591 if let syn::Type::Path(p) = &*s.elem {
1592 let resolved = self.resolve_path(&p.path, generics);
1593 assert!(self.is_primitive(&resolved));
1594 let slice_path = format!("[{}]", resolved);
1595 if let Some((prefix, suffix)) = path_lookup(&slice_path, true) {
1596 write!(w, "let mut local_{} = {}{}{};", ident, prefix, var, suffix).unwrap();
1599 } else if let syn::Type::Reference(ty) = &*s.elem {
1600 let tyref = [&*ty.elem];
1602 convert_container!("Slice", 1, || tyref.iter());
1603 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
1604 } else if let syn::Type::Tuple(t) = &*s.elem {
1605 // When mapping into a temporary new var, we need to own all the underlying objects.
1606 // Thus, we drop any references inside the tuple and convert with non-reference types.
1607 let mut elems = syn::punctuated::Punctuated::new();
1608 for elem in t.elems.iter() {
1609 if let syn::Type::Reference(r) = elem {
1610 elems.push((*r.elem).clone());
1612 elems.push(elem.clone());
1615 let ty = [syn::Type::Tuple(syn::TypeTuple {
1616 paren_token: t.paren_token, elems
1620 convert_container!("Slice", 1, || ty.iter());
1621 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
1622 } else { unimplemented!() }
1624 syn::Type::Tuple(t) => {
1625 if !t.elems.is_empty() {
1626 // We don't (yet) support tuple elements which cannot be converted inline
1627 write!(w, "let (").unwrap();
1628 for idx in 0..t.elems.len() {
1629 if idx != 0 { write!(w, ", ").unwrap(); }
1630 write!(w, "{} orig_{}_{}", if is_ref { "ref" } else { "mut" }, ident, idx).unwrap();
1632 write!(w, ") = {}{}; ", var, if !to_c { ".to_rust()" } else { "" }).unwrap();
1633 // Like other template types, tuples are always mapped as their non-ref
1634 // versions for types which have different ref mappings. Thus, we convert to
1635 // non-ref versions and handle opaque types with inner pointers manually.
1636 for (idx, elem) in t.elems.iter().enumerate() {
1637 if let syn::Type::Path(p) = elem {
1638 let v_name = format!("orig_{}_{}", ident, idx);
1639 let tuple_elem_ident = syn::Ident::new(&v_name, Span::call_site());
1640 if self.write_conversion_new_var_intern(w, &tuple_elem_ident, &v_name, elem, generics,
1641 false, ptr_for_ref, to_c,
1642 path_lookup, container_lookup, var_prefix, var_suffix) {
1643 write!(w, " ").unwrap();
1644 // Opaque types with inner pointers shouldn't ever create new stack
1645 // variables, so we don't handle it and just assert that it doesn't
1647 assert!(!self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)));
1651 write!(w, "let mut local_{} = (", ident).unwrap();
1652 for (idx, elem) in t.elems.iter().enumerate() {
1653 let ty_has_inner = {
1655 // "To C ptr_for_ref" means "return the regular object with
1656 // is_owned set to false", which is totally what we want
1657 // if we're about to set ty_has_inner.
1660 if let syn::Type::Reference(t) = elem {
1661 if let syn::Type::Path(p) = &*t.elem {
1662 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
1664 } else if let syn::Type::Path(p) = elem {
1665 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
1668 if idx != 0 { write!(w, ", ").unwrap(); }
1669 var_prefix(w, elem, generics, is_ref && ty_has_inner, ptr_for_ref, false);
1670 if is_ref && ty_has_inner {
1671 // For ty_has_inner, the regular var_prefix mapping will take a
1672 // reference, so deref once here to make sure we keep the original ref.
1673 write!(w, "*").unwrap();
1675 write!(w, "orig_{}_{}", ident, idx).unwrap();
1676 if is_ref && !ty_has_inner {
1677 // If we don't have an inner variable's reference to maintain, just
1678 // hope the type is Clonable and use that.
1679 write!(w, ".clone()").unwrap();
1681 var_suffix(w, elem, generics, is_ref && ty_has_inner, ptr_for_ref, false);
1683 write!(w, "){};", if to_c { ".into()" } else { "" }).unwrap();
1687 _ => unimplemented!(),
1691 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 {
1692 self.write_conversion_new_var_intern(w, ident, var_access, t, generics, false, ptr_for_ref, true,
1693 &|a, b| self.to_c_conversion_new_var_from_path(a, b),
1694 &|a, b, c, d, e| self.to_c_conversion_container_new_var(generics, a, b, c, d, e),
1695 // We force ptr_for_ref here since we can't generate a ref on one line and use it later
1696 &|a, b, c, d, e, f| self.write_to_c_conversion_inline_prefix_inner(a, b, c, d, e, f),
1697 &|a, b, c, d, e, f| self.write_to_c_conversion_inline_suffix_inner(a, b, c, d, e, f))
1699 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 {
1700 self.write_to_c_conversion_new_var_inner(w, ident, &format!("{}", ident), t, generics, ptr_for_ref)
1702 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 {
1703 self.write_conversion_new_var_intern(w, ident, &format!("{}", ident), t, generics, false, false, false,
1704 &|a, b| self.from_c_conversion_new_var_from_path(a, b),
1705 &|a, b, c, d, e| self.from_c_conversion_container_new_var(generics, a, b, c, d, e),
1706 // We force ptr_for_ref here since we can't generate a ref on one line and use it later
1707 &|a, b, c, d, e, _f| self.write_from_c_conversion_prefix_inner(a, b, c, d, e),
1708 &|a, b, c, d, e, _f| self.write_from_c_conversion_suffix_inner(a, b, c, d, e))
1711 // ******************************************************
1712 // *** C Container Type Equivalent and alias Printing ***
1713 // ******************************************************
1715 fn write_template_constructor<W: std::io::Write>(&mut self, w: &mut W, container_type: &str, mangled_container: &str, args: &Vec<&syn::Type>, generics: Option<&GenericTypes>, is_ref: bool) {
1716 if container_type == "Result" {
1717 assert_eq!(args.len(), 2);
1718 macro_rules! write_fn {
1719 ($call: expr) => { {
1720 writeln!(w, "#[no_mangle]\npub extern \"C\" fn {}_{}() -> {} {{", mangled_container, $call, mangled_container).unwrap();
1721 writeln!(w, "\t{}::CResultTempl::{}(0)\n}}\n", Self::container_templ_path(), $call).unwrap();
1724 macro_rules! write_alias {
1725 ($call: expr, $item: expr) => { {
1726 write!(w, "#[no_mangle]\npub static {}_{}: extern \"C\" fn (", mangled_container, $call).unwrap();
1727 if let syn::Type::Path(syn::TypePath { path, .. }) = $item {
1728 let resolved = self.resolve_path(path, generics);
1729 if self.is_known_container(&resolved, is_ref) || self.is_transparent_container(&resolved, is_ref) {
1730 self.write_c_mangled_container_path_intern(w, Self::path_to_generic_args(path), generics,
1731 &format!("{}", single_ident_generic_path_to_ident(path).unwrap()), is_ref, false, false, false);
1733 self.write_template_generics(w, &mut [$item].iter().map(|t| *t), generics, is_ref, true);
1735 } else if let syn::Type::Tuple(syn::TypeTuple { elems, .. }) = $item {
1736 self.write_c_mangled_container_path_intern(w, elems.iter().collect(), generics,
1737 &format!("{}Tuple", elems.len()), is_ref, false, false, false);
1738 } else { unimplemented!(); }
1739 write!(w, ") -> {} =\n\t{}::CResultTempl::<", mangled_container, Self::container_templ_path()).unwrap();
1740 self.write_template_generics(w, &mut args.iter().map(|t| *t), generics, is_ref, true);
1741 writeln!(w, ">::{};\n", $call).unwrap();
1745 syn::Type::Tuple(t) if t.elems.is_empty() => write_fn!("ok"),
1746 _ => write_alias!("ok", args[0]),
1749 syn::Type::Tuple(t) if t.elems.is_empty() => write_fn!("err"),
1750 _ => write_alias!("err", args[1]),
1752 } else if container_type.ends_with("Tuple") {
1753 write!(w, "#[no_mangle]\npub extern \"C\" fn {}_new(", mangled_container).unwrap();
1754 for (idx, gen) in args.iter().enumerate() {
1755 write!(w, "{}{}: ", if idx != 0 { ", " } else { "" }, ('a' as u8 + idx as u8) as char).unwrap();
1756 assert!(self.write_c_type_intern(w, gen, None, false, false, false));
1758 writeln!(w, ") -> {} {{", mangled_container).unwrap();
1759 write!(w, "\t{} {{ ", mangled_container).unwrap();
1760 for idx in 0..args.len() {
1761 write!(w, "{}, ", ('a' as u8 + idx as u8) as char).unwrap();
1763 writeln!(w, "}}\n}}\n").unwrap();
1765 writeln!(w, "").unwrap();
1769 fn write_template_generics<'b, W: std::io::Write>(&self, w: &mut W, args: &mut dyn Iterator<Item=&'b syn::Type>, generics: Option<&GenericTypes>, is_ref: bool, in_crate: bool) {
1770 for (idx, t) in args.enumerate() {
1772 write!(w, ", ").unwrap();
1774 if let syn::Type::Tuple(tup) = t {
1775 if tup.elems.is_empty() {
1776 write!(w, "u8").unwrap();
1778 write!(w, "{}::C{}TupleTempl<", Self::container_templ_path(), tup.elems.len()).unwrap();
1779 self.write_template_generics(w, &mut tup.elems.iter(), generics, is_ref, in_crate);
1780 write!(w, ">").unwrap();
1782 } else if let syn::Type::Path(p_arg) = t {
1783 let resolved_generic = self.resolve_path(&p_arg.path, generics);
1784 if self.is_primitive(&resolved_generic) {
1785 write!(w, "{}", resolved_generic).unwrap();
1786 } else if let Some(c_type) = self.c_type_from_path(&resolved_generic, is_ref, false) {
1787 if self.is_known_container(&resolved_generic, is_ref) {
1788 write!(w, "{}::C{}Templ<", Self::container_templ_path(), single_ident_generic_path_to_ident(&p_arg.path).unwrap()).unwrap();
1789 assert_eq!(p_arg.path.segments.len(), 1);
1790 if let syn::PathArguments::AngleBracketed(args) = &p_arg.path.segments.iter().next().unwrap().arguments {
1791 self.write_template_generics(w, &mut args.args.iter().map(|gen|
1792 if let syn::GenericArgument::Type(t) = gen { t } else { unimplemented!() }),
1793 generics, is_ref, in_crate);
1794 } else { unimplemented!(); }
1795 write!(w, ">").unwrap();
1796 } else if resolved_generic == "Option" {
1797 if let syn::PathArguments::AngleBracketed(args) = &p_arg.path.segments.iter().next().unwrap().arguments {
1798 self.write_template_generics(w, &mut args.args.iter().map(|gen|
1799 if let syn::GenericArgument::Type(t) = gen { t } else { unimplemented!() }),
1800 generics, is_ref, in_crate);
1801 } else { unimplemented!(); }
1802 } else if in_crate {
1803 write!(w, "{}", c_type).unwrap();
1805 self.write_rust_type(w, generics, &t);
1808 // If we just write out resolved_generic, it may mostly work, however for
1809 // original types which are generic, we need the template args. We could
1810 // figure them out and write them out, too, but its much easier to just
1811 // reference the native{} type alias which exists at least for opaque types.
1813 write!(w, "crate::{}", resolved_generic).unwrap();
1815 let path_name: Vec<&str> = resolved_generic.rsplitn(2, "::").collect();
1816 if path_name.len() > 1 {
1817 write!(w, "crate::{}::native{}", path_name[1], path_name[0]).unwrap();
1819 write!(w, "crate::native{}", path_name[0]).unwrap();
1823 } else if let syn::Type::Reference(r_arg) = t {
1824 if let syn::Type::Path(p_arg) = &*r_arg.elem {
1825 let resolved = self.resolve_path(&p_arg.path, generics);
1826 if self.crate_types.opaques.get(&resolved).is_some() {
1827 write!(w, "crate::{}", resolved).unwrap();
1829 let cty = self.c_type_from_path(&resolved, true, true).expect("Template generics should be opaque or have a predefined mapping");
1830 w.write(cty.as_bytes()).unwrap();
1832 } else { unimplemented!(); }
1833 } else if let syn::Type::Array(a_arg) = t {
1834 if let syn::Type::Path(p_arg) = &*a_arg.elem {
1835 let resolved = self.resolve_path(&p_arg.path, generics);
1836 assert!(self.is_primitive(&resolved));
1837 if let syn::Expr::Lit(syn::ExprLit { lit: syn::Lit::Int(len), .. }) = &a_arg.len {
1839 self.c_type_from_path(&format!("[{}; {}]", resolved, len.base10_digits()), is_ref, false).unwrap()).unwrap();
1845 fn check_create_container(&mut self, mangled_container: String, container_type: &str, args: Vec<&syn::Type>, generics: Option<&GenericTypes>, is_ref: bool) {
1846 if !self.crate_types.templates_defined.get(&mangled_container).is_some() {
1847 self.crate_types.templates_defined.insert(mangled_container.clone(), true);
1848 let mut created_container: Vec<u8> = Vec::new();
1850 write!(&mut created_container, "#[no_mangle]\npub type {} = ", mangled_container).unwrap();
1851 write!(&mut created_container, "{}::C{}Templ<", Self::container_templ_path(), container_type).unwrap();
1852 self.write_template_generics(&mut created_container, &mut args.iter().map(|t| *t), generics, is_ref, true);
1853 writeln!(&mut created_container, ">;").unwrap();
1855 write!(&mut created_container, "#[no_mangle]\npub static {}_free: extern \"C\" fn({}) = ", mangled_container, mangled_container).unwrap();
1856 write!(&mut created_container, "{}::C{}Templ_free::<", Self::container_templ_path(), container_type).unwrap();
1857 self.write_template_generics(&mut created_container, &mut args.iter().map(|t| *t), generics, is_ref, true);
1858 writeln!(&mut created_container, ">;").unwrap();
1860 self.write_template_constructor(&mut created_container, container_type, &mangled_container, &args, generics, is_ref);
1862 self.crate_types.template_file.write(&created_container).unwrap();
1865 fn path_to_generic_args(path: &syn::Path) -> Vec<&syn::Type> {
1866 if let syn::PathArguments::AngleBracketed(args) = &path.segments.iter().next().unwrap().arguments {
1867 args.args.iter().map(|gen| if let syn::GenericArgument::Type(t) = gen { t } else { unimplemented!() }).collect()
1868 } else { unimplemented!(); }
1870 fn write_c_mangled_container_path_intern<W: std::io::Write>
1871 (&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 {
1872 let mut mangled_type: Vec<u8> = Vec::new();
1873 if !self.is_transparent_container(ident, is_ref) {
1874 write!(w, "C{}_", ident).unwrap();
1875 write!(mangled_type, "C{}_", ident).unwrap();
1876 } else { assert_eq!(args.len(), 1); }
1877 for arg in args.iter() {
1878 macro_rules! write_path {
1879 ($p_arg: expr, $extra_write: expr) => {
1880 let subtype = self.resolve_path(&$p_arg.path, generics);
1881 if self.is_transparent_container(ident, is_ref) {
1882 // We dont (yet) support primitives or containers inside transparent
1883 // containers, so check for that first:
1884 if self.is_primitive(&subtype) { return false; }
1885 if self.is_known_container(&subtype, is_ref) { return false; }
1887 if self.c_type_has_inner_from_path(&subtype) {
1888 if !self.write_c_path_intern(w, &$p_arg.path, generics, is_ref, is_mut, ptr_for_ref) { return false; }
1890 // Option<T> needs to be converted to a *mut T, ie mut ptr-for-ref
1891 if !self.write_c_path_intern(w, &$p_arg.path, generics, true, true, true) { return false; }
1894 if $p_arg.path.segments.len() == 1 {
1895 write!(w, "{}", $p_arg.path.segments.iter().next().unwrap().ident).unwrap();
1900 } else if self.is_known_container(&subtype, is_ref) || self.is_transparent_container(&subtype, is_ref) {
1901 if !self.write_c_mangled_container_path_intern(w, Self::path_to_generic_args(&$p_arg.path), generics,
1902 &subtype, is_ref, is_mut, ptr_for_ref, true) {
1905 self.write_c_mangled_container_path_intern(&mut mangled_type, Self::path_to_generic_args(&$p_arg.path),
1906 generics, &subtype, is_ref, is_mut, ptr_for_ref, true);
1907 if let Some(w2) = $extra_write as Option<&mut Vec<u8>> {
1908 self.write_c_mangled_container_path_intern(w2, Self::path_to_generic_args(&$p_arg.path),
1909 generics, &subtype, is_ref, is_mut, ptr_for_ref, true);
1912 let id = &&$p_arg.path.segments.iter().rev().next().unwrap().ident;
1913 write!(w, "{}", id).unwrap();
1914 write!(mangled_type, "{}", id).unwrap();
1915 if let Some(w2) = $extra_write as Option<&mut Vec<u8>> {
1916 write!(w2, "{}", id).unwrap();
1921 if let syn::Type::Tuple(tuple) = arg {
1922 if tuple.elems.len() == 0 {
1923 write!(w, "None").unwrap();
1924 write!(mangled_type, "None").unwrap();
1926 let mut mangled_tuple_type: Vec<u8> = Vec::new();
1928 // Figure out what the mangled type should look like. To disambiguate
1929 // ((A, B), C) and (A, B, C) we prefix the generic args with a _ and suffix
1930 // them with a Z. Ideally we wouldn't use Z, but not many special chars are
1931 // available for use in type names.
1932 write!(w, "C{}Tuple_", tuple.elems.len()).unwrap();
1933 write!(mangled_type, "C{}Tuple_", tuple.elems.len()).unwrap();
1934 write!(mangled_tuple_type, "C{}Tuple_", tuple.elems.len()).unwrap();
1935 for elem in tuple.elems.iter() {
1936 if let syn::Type::Path(p) = elem {
1937 write_path!(p, Some(&mut mangled_tuple_type));
1938 } else if let syn::Type::Reference(refelem) = elem {
1939 if let syn::Type::Path(p) = &*refelem.elem {
1940 write_path!(p, Some(&mut mangled_tuple_type));
1941 } else { return false; }
1942 } else { return false; }
1944 write!(w, "Z").unwrap();
1945 write!(mangled_type, "Z").unwrap();
1946 write!(mangled_tuple_type, "Z").unwrap();
1947 self.check_create_container(String::from_utf8(mangled_tuple_type).unwrap(),
1948 &format!("{}Tuple", tuple.elems.len()), tuple.elems.iter().collect(), generics, is_ref);
1950 } else if let syn::Type::Path(p_arg) = arg {
1951 write_path!(p_arg, None);
1952 } else if let syn::Type::Reference(refty) = arg {
1953 if args.len() != 1 { return false; }
1954 if let syn::Type::Path(p_arg) = &*refty.elem {
1955 write_path!(p_arg, None);
1956 } else if let syn::Type::Slice(_) = &*refty.elem {
1957 // write_c_type will actually do exactly what we want here, we just need to
1958 // make it a pointer so that its an option. Note that we cannot always convert
1959 // the Vec-as-slice (ie non-ref types) containers, so sometimes need to be able
1960 // to edit it, hence we use *mut here instead of *const.
1961 write!(w, "*mut ").unwrap();
1962 self.write_c_type(w, arg, None, true);
1963 } else { return false; }
1964 } else if let syn::Type::Array(a) = arg {
1965 if let syn::Type::Path(p_arg) = &*a.elem {
1966 let resolved = self.resolve_path(&p_arg.path, generics);
1967 if !self.is_primitive(&resolved) { return false; }
1968 if let syn::Expr::Lit(syn::ExprLit { lit: syn::Lit::Int(len), .. }) = &a.len {
1969 if self.c_type_from_path(&format!("[{}; {}]", resolved, len.base10_digits()), is_ref, ptr_for_ref).is_none() { return false; }
1970 write!(w, "_{}{}", resolved, len.base10_digits()).unwrap();
1971 write!(mangled_type, "_{}{}", resolved, len.base10_digits()).unwrap();
1972 } else { return false; }
1973 } else { return false; }
1974 } else { return false; }
1976 if self.is_transparent_container(ident, is_ref) { return true; }
1977 // Push the "end of type" Z
1978 write!(w, "Z").unwrap();
1979 write!(mangled_type, "Z").unwrap();
1981 // Make sure the type is actually defined:
1982 self.check_create_container(String::from_utf8(mangled_type).unwrap(), ident, args, generics, is_ref);
1985 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 {
1986 if !self.is_transparent_container(ident, is_ref) {
1987 write!(w, "{}::", Self::generated_container_path()).unwrap();
1989 self.write_c_mangled_container_path_intern(w, args, generics, ident, is_ref, is_mut, ptr_for_ref, false)
1992 // **********************************
1993 // *** C Type Equivalent Printing ***
1994 // **********************************
1996 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 {
1997 let full_path = match self.maybe_resolve_path(&path, generics) {
1998 Some(path) => path, None => return false };
1999 if let Some(c_type) = self.c_type_from_path(&full_path, is_ref, ptr_for_ref) {
2000 write!(w, "{}", c_type).unwrap();
2002 } else if self.crate_types.traits.get(&full_path).is_some() {
2003 if is_ref && ptr_for_ref {
2004 write!(w, "*{} crate::{}", if is_mut { "mut" } else { "const" }, full_path).unwrap();
2006 write!(w, "&{}crate::{}", if is_mut { "mut " } else { "" }, full_path).unwrap();
2008 write!(w, "crate::{}", full_path).unwrap();
2011 } else if self.crate_types.opaques.get(&full_path).is_some() || self.crate_types.mirrored_enums.get(&full_path).is_some() {
2012 if is_ref && ptr_for_ref {
2013 // ptr_for_ref implies we're returning the object, which we can't really do for
2014 // opaque or mirrored types without box'ing them, which is quite a waste, so return
2015 // the actual object itself (for opaque types we'll set the pointer to the actual
2016 // type and note that its a reference).
2017 write!(w, "crate::{}", full_path).unwrap();
2019 write!(w, "&{}crate::{}", if is_mut { "mut " } else { "" }, full_path).unwrap();
2021 write!(w, "crate::{}", full_path).unwrap();
2028 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 {
2030 syn::Type::Path(p) => {
2031 if p.qself.is_some() {
2034 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
2035 if self.is_known_container(&full_path, is_ref) || self.is_transparent_container(&full_path, is_ref) {
2036 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);
2038 if let Some(aliased_type) = self.crate_types.type_aliases.get(&full_path).cloned() {
2039 return self.write_c_type_intern(w, &aliased_type, None, is_ref, is_mut, ptr_for_ref);
2042 self.write_c_path_intern(w, &p.path, generics, is_ref, is_mut, ptr_for_ref)
2044 syn::Type::Reference(r) => {
2045 self.write_c_type_intern(w, &*r.elem, generics, true, r.mutability.is_some(), ptr_for_ref)
2047 syn::Type::Array(a) => {
2048 if is_ref && is_mut {
2049 write!(w, "*mut [").unwrap();
2050 if !self.write_c_type_intern(w, &a.elem, generics, false, false, ptr_for_ref) { return false; }
2052 write!(w, "*const [").unwrap();
2053 if !self.write_c_type_intern(w, &a.elem, generics, false, false, ptr_for_ref) { return false; }
2055 let mut typecheck = Vec::new();
2056 if !self.write_c_type_intern(&mut typecheck, &a.elem, generics, false, false, ptr_for_ref) { return false; }
2057 if typecheck[..] != ['u' as u8, '8' as u8] { return false; }
2059 if let syn::Expr::Lit(l) = &a.len {
2060 if let syn::Lit::Int(i) = &l.lit {
2062 if let Some(ty) = self.c_type_from_path(&format!("[u8; {}]", i.base10_digits()), false, ptr_for_ref) {
2063 write!(w, "{}", ty).unwrap();
2067 write!(w, "; {}]", i).unwrap();
2073 syn::Type::Slice(s) => {
2074 if !is_ref || is_mut { return false; }
2075 if let syn::Type::Path(p) = &*s.elem {
2076 let resolved = self.resolve_path(&p.path, generics);
2077 if self.is_primitive(&resolved) {
2078 write!(w, "{}::{}slice", Self::container_templ_path(), resolved).unwrap();
2081 } else if let syn::Type::Reference(r) = &*s.elem {
2082 if let syn::Type::Path(p) = &*r.elem {
2083 // Slices with "real types" inside are mapped as the equivalent non-ref Vec
2084 let resolved = self.resolve_path(&p.path, generics);
2085 let mangled_container = if let Some(ident) = self.crate_types.opaques.get(&resolved) {
2086 format!("CVec_{}Z", ident)
2087 } else if let Some(en) = self.crate_types.mirrored_enums.get(&resolved) {
2088 format!("CVec_{}Z", en.ident)
2089 } else if let Some(id) = p.path.get_ident() {
2090 format!("CVec_{}Z", id)
2091 } else { return false; };
2092 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
2093 self.check_create_container(mangled_container, "Vec", vec![&*r.elem], generics, false);
2096 } else if let syn::Type::Tuple(_) = &*s.elem {
2097 let mut args = syn::punctuated::Punctuated::new();
2098 args.push(syn::GenericArgument::Type((*s.elem).clone()));
2099 let mut segments = syn::punctuated::Punctuated::new();
2100 segments.push(syn::PathSegment {
2101 ident: syn::Ident::new("Vec", Span::call_site()),
2102 arguments: syn::PathArguments::AngleBracketed(syn::AngleBracketedGenericArguments {
2103 colon2_token: None, lt_token: syn::Token![<](Span::call_site()), args, gt_token: syn::Token![>](Span::call_site()),
2106 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)
2109 syn::Type::Tuple(t) => {
2110 if t.elems.len() == 0 {
2113 self.write_c_mangled_container_path(w, t.elems.iter().collect(), generics,
2114 &format!("{}Tuple", t.elems.len()), is_ref, is_mut, ptr_for_ref)
2120 pub fn write_c_type<W: std::io::Write>(&mut self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, ptr_for_ref: bool) {
2121 assert!(self.write_c_type_intern(w, t, generics, false, false, ptr_for_ref));
2123 pub fn understood_c_path(&mut self, p: &syn::Path) -> bool {
2124 if p.leading_colon.is_some() { return false; }
2125 self.write_c_path_intern(&mut std::io::sink(), p, None, false, false, false)
2127 pub fn understood_c_type(&mut self, t: &syn::Type, generics: Option<&GenericTypes>) -> bool {
2128 self.write_c_type_intern(&mut std::io::sink(), t, generics, false, false, false)