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 // First learn simple generics...
133 for generic in generics.params.iter() {
135 syn::GenericParam::Type(type_param) => {
136 let mut non_lifetimes_processed = false;
137 for bound in type_param.bounds.iter() {
138 if let syn::TypeParamBound::Trait(trait_bound) = bound {
139 if let Some(ident) = single_ident_generic_path_to_ident(&trait_bound.path) {
140 match &format!("{}", ident) as &str { "Send" => continue, "Sync" => continue, _ => {} }
143 assert_simple_bound(&trait_bound);
144 if let Some(mut path) = types.maybe_resolve_path(&trait_bound.path, None) {
145 if types.skip_path(&path) { continue; }
146 if non_lifetimes_processed { return false; }
147 non_lifetimes_processed = true;
148 let new_ident = if path != "std::ops::Deref" {
149 path = "crate::".to_string() + &path;
150 Some(&trait_bound.path)
152 self.typed_generics.last_mut().unwrap().insert(&type_param.ident, (path, new_ident));
153 } else { return false; }
160 // Then find generics where we are required to pass a Deref<Target=X> and pretend its just X.
161 if let Some(wh) = &generics.where_clause {
162 for pred in wh.predicates.iter() {
163 if let syn::WherePredicate::Type(t) = pred {
164 if let syn::Type::Path(p) = &t.bounded_ty {
165 if p.qself.is_some() { return false; }
166 if p.path.leading_colon.is_some() { return false; }
167 let mut p_iter = p.path.segments.iter();
168 if let Some(gen) = self.typed_generics.last_mut().unwrap().get_mut(&p_iter.next().unwrap().ident) {
169 if gen.0 != "std::ops::Deref" { return false; }
170 if &format!("{}", p_iter.next().unwrap().ident) != "Target" { return false; }
172 let mut non_lifetimes_processed = false;
173 for bound in t.bounds.iter() {
174 if let syn::TypeParamBound::Trait(trait_bound) = bound {
175 if non_lifetimes_processed { return false; }
176 non_lifetimes_processed = true;
177 assert_simple_bound(&trait_bound);
178 *gen = ("crate::".to_string() + &types.resolve_path(&trait_bound.path, None),
179 Some(&trait_bound.path));
182 } else { return false; }
183 } else { return false; }
187 for (_, (_, ident)) in self.typed_generics.last().unwrap().iter() {
188 if ident.is_none() { return false; }
193 /// Learn the associated types from the trait in the current context.
194 pub fn learn_associated_types<'b, 'c>(&mut self, t: &'a syn::ItemTrait, types: &'b TypeResolver<'a, 'c>) {
195 for item in t.items.iter() {
197 &syn::TraitItem::Type(ref t) => {
198 if t.default.is_some() || t.generics.lt_token.is_some() { unimplemented!(); }
199 let mut bounds_iter = t.bounds.iter();
200 match bounds_iter.next().unwrap() {
201 syn::TypeParamBound::Trait(tr) => {
202 assert_simple_bound(&tr);
203 if let Some(mut path) = types.maybe_resolve_path(&tr.path, None) {
204 if types.skip_path(&path) { continue; }
205 // In general we handle Deref<Target=X> as if it were just X (and
206 // implement Deref<Target=Self> for relevant types). We don't
207 // bother to implement it for associated types, however, so we just
208 // ignore such bounds.
209 let new_ident = if path != "std::ops::Deref" {
210 path = "crate::".to_string() + &path;
213 self.typed_generics.last_mut().unwrap().insert(&t.ident, (path, new_ident));
214 } else { unimplemented!(); }
216 _ => unimplemented!(),
218 if bounds_iter.next().is_some() { unimplemented!(); }
225 /// Attempt to resolve an Ident as a generic parameter and return the full path.
226 pub fn maybe_resolve_ident<'b>(&'b self, ident: &syn::Ident) -> Option<&'b String> {
227 for gen in self.typed_generics.iter().rev() {
228 if let Some(res) = gen.get(ident).map(|(a, _)| a) {
234 /// Attempt to resolve a Path as a generic parameter and return the full path. as both a string
236 pub fn maybe_resolve_path<'b>(&'b self, path: &syn::Path) -> Option<(&'b String, &'a syn::Path)> {
237 if let Some(ident) = path.get_ident() {
238 for gen in self.typed_generics.iter().rev() {
239 if let Some(res) = gen.get(ident).map(|(a, b)| (a, b.unwrap())) {
244 // Associated types are usually specified as "Self::Generic", so we check for that
246 let mut it = path.segments.iter();
247 if path.segments.len() == 2 && format!("{}", it.next().unwrap().ident) == "Self" {
248 let ident = &it.next().unwrap().ident;
249 for gen in self.typed_generics.iter().rev() {
250 if let Some(res) = gen.get(ident).map(|(a, b)| (a, b.unwrap())) {
260 #[derive(Clone, PartialEq)]
261 // The type of declaration and the object itself
262 pub enum DeclType<'a> {
264 Trait(&'a syn::ItemTrait),
270 // templates_defined is walked to write the C++ header, so if we use the default hashing it get
271 // reordered on each genbindings run. Instead, we use SipHasher (which defaults to 0-keys) so that
272 // the sorting is stable across runs. It is deprecated, but the "replacement" doesn't actually
273 // accomplish the same goals, so we just ignore it.
275 type NonRandomHash = hash::BuildHasherDefault<hash::SipHasher>;
277 /// Top-level struct tracking everything which has been defined while walking the crate.
278 pub struct CrateTypes<'a> {
279 /// This may contain structs or enums, but only when either is mapped as
280 /// struct X { inner: *mut originalX, .. }
281 pub opaques: HashMap<String, &'a syn::Ident>,
282 /// Enums which are mapped as C enums with conversion functions
283 pub mirrored_enums: HashMap<String, &'a syn::ItemEnum>,
284 /// Traits which are mapped as a pointer + jump table
285 pub traits: HashMap<String, &'a syn::ItemTrait>,
286 /// Aliases from paths to some other Type
287 pub type_aliases: HashMap<String, syn::Type>,
288 /// Template continer types defined, map from mangled type name -> whether a destructor fn
291 /// This is used at the end of processing to make C++ wrapper classes
292 pub templates_defined: HashMap<String, bool, NonRandomHash>,
293 /// The output file for any created template container types, written to as we find new
294 /// template containers which need to be defined.
295 pub template_file: &'a mut File,
298 /// A struct which tracks resolving rust types into C-mapped equivalents, exists for one specific
299 /// module but contains a reference to the overall CrateTypes tracking.
300 pub struct TypeResolver<'mod_lifetime, 'crate_lft: 'mod_lifetime> {
301 pub orig_crate: &'mod_lifetime str,
302 pub module_path: &'mod_lifetime str,
303 imports: HashMap<syn::Ident, String>,
304 // ident -> is-mirrored-enum
305 declared: HashMap<syn::Ident, DeclType<'crate_lft>>,
306 pub crate_types: &'mod_lifetime mut CrateTypes<'crate_lft>,
309 /// Returned by write_empty_rust_val_check_suffix to indicate what type of dereferencing needs to
310 /// happen to get the inner value of a generic.
311 enum EmptyValExpectedTy {
312 /// A type which has a flag for being empty (eg an array where we treat all-0s as empty).
314 /// A pointer that we want to dereference and move out of.
316 /// A pointer which we want to convert to a reference.
320 impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
321 pub fn new(orig_crate: &'a str, module_path: &'a str, crate_types: &'a mut CrateTypes<'c>) -> Self {
322 let mut imports = HashMap::new();
323 // Add primitives to the "imports" list:
324 imports.insert(syn::Ident::new("bool", Span::call_site()), "bool".to_string());
325 imports.insert(syn::Ident::new("u64", Span::call_site()), "u64".to_string());
326 imports.insert(syn::Ident::new("u32", Span::call_site()), "u32".to_string());
327 imports.insert(syn::Ident::new("u16", Span::call_site()), "u16".to_string());
328 imports.insert(syn::Ident::new("u8", Span::call_site()), "u8".to_string());
329 imports.insert(syn::Ident::new("usize", Span::call_site()), "usize".to_string());
330 imports.insert(syn::Ident::new("str", Span::call_site()), "str".to_string());
331 imports.insert(syn::Ident::new("String", Span::call_site()), "String".to_string());
333 // These are here to allow us to print native Rust types in trait fn impls even if we don't
335 imports.insert(syn::Ident::new("Result", Span::call_site()), "Result".to_string());
336 imports.insert(syn::Ident::new("Vec", Span::call_site()), "Vec".to_string());
337 imports.insert(syn::Ident::new("Option", Span::call_site()), "Option".to_string());
338 Self { orig_crate, module_path, imports, declared: HashMap::new(), crate_types }
341 // *************************************************
342 // *** Well know type and conversion definitions ***
343 // *************************************************
345 /// Returns true we if can just skip passing this to C entirely
346 fn skip_path(&self, full_path: &str) -> bool {
347 full_path == "bitcoin::secp256k1::Secp256k1" ||
348 full_path == "bitcoin::secp256k1::Signing" ||
349 full_path == "bitcoin::secp256k1::Verification"
351 /// Returns true we if can just skip passing this to C entirely
352 fn no_arg_path_to_rust(&self, full_path: &str) -> &str {
353 if full_path == "bitcoin::secp256k1::Secp256k1" {
354 "&bitcoin::secp256k1::Secp256k1::new()"
355 } else { unimplemented!(); }
358 /// Returns true if the object is a primitive and is mapped as-is with no conversion
360 pub fn is_primitive(&self, full_path: &str) -> bool {
371 /// Gets the C-mapped type for types which are outside of the crate, or which are manually
372 /// ignored by for some reason need mapping anyway.
373 fn c_type_from_path<'b>(&self, full_path: &'b str, is_ref: bool, ptr_for_ref: bool) -> Option<&'b str> {
374 if self.is_primitive(full_path) {
375 return Some(full_path);
378 "Result" => Some("crate::c_types::derived::CResult"),
379 "Vec" if !is_ref => Some("crate::c_types::derived::CVec"),
380 "Option" => Some(""),
382 // Note that no !is_ref types can map to an array because Rust and C's call semantics
383 // for arrays are different (https://github.com/eqrion/cbindgen/issues/528)
385 "[u8; 32]" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
386 "[u8; 16]" if !is_ref => Some("crate::c_types::SixteenBytes"),
387 "[u8; 10]" if !is_ref => Some("crate::c_types::TenBytes"),
388 "[u8; 4]" if !is_ref => Some("crate::c_types::FourBytes"),
389 "[u8; 3]" if !is_ref => Some("crate::c_types::ThreeBytes"), // Used for RGB values
391 "str" if is_ref => Some("crate::c_types::Str"),
392 "String" if !is_ref => Some("crate::c_types::derived::CVec_u8Z"),
393 "String" if is_ref => Some("crate::c_types::Str"),
395 "std::time::Duration" => Some("u64"),
397 "bitcoin::secp256k1::key::PublicKey" => Some("crate::c_types::PublicKey"),
398 "bitcoin::secp256k1::Signature" => Some("crate::c_types::Signature"),
399 "bitcoin::secp256k1::key::SecretKey" if is_ref => Some("*const [u8; 32]"),
400 "bitcoin::secp256k1::key::SecretKey" if !is_ref => Some("crate::c_types::SecretKey"),
401 "bitcoin::secp256k1::Error" if !is_ref => Some("crate::c_types::Secp256k1Error"),
402 "bitcoin::blockdata::script::Script" if is_ref => Some("crate::c_types::u8slice"),
403 "bitcoin::blockdata::script::Script" if !is_ref => Some("crate::c_types::derived::CVec_u8Z"),
404 "bitcoin::blockdata::transaction::OutPoint" if is_ref => Some("crate::chain::transaction::OutPoint"),
405 "bitcoin::blockdata::transaction::Transaction" => Some("crate::c_types::Transaction"),
406 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some("crate::c_types::TxOut"),
407 "bitcoin::OutPoint" => Some("crate::chain::transaction::OutPoint"),
408 "bitcoin::network::constants::Network" => Some("crate::bitcoin::network::Network"),
409 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some("*const [u8; 80]"),
410 "bitcoin::blockdata::block::Block" if is_ref => Some("crate::c_types::u8slice"),
412 // Newtypes that we just expose in their original form.
413 "bitcoin::hash_types::Txid" if is_ref => Some("*const [u8; 32]"),
414 "bitcoin::hash_types::Txid" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
415 "bitcoin::hash_types::BlockHash" if is_ref => Some("*const [u8; 32]"),
416 "bitcoin::hash_types::BlockHash" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
417 "ln::channelmanager::PaymentHash" if is_ref => Some("*const [u8; 32]"),
418 "ln::channelmanager::PaymentHash" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
419 "ln::channelmanager::PaymentPreimage" if is_ref => Some("*const [u8; 32]"),
420 "ln::channelmanager::PaymentPreimage" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
421 "ln::channelmanager::PaymentSecret" if is_ref => Some("crate::c_types::ThirtyTwoBytes"),
422 "ln::channelmanager::PaymentSecret" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
424 // Override the default since Records contain an fmt with a lifetime:
425 "util::logger::Record" => Some("*const std::os::raw::c_char"),
427 // List of structs we map that aren't detected:
428 "ln::features::InitFeatures" if is_ref && ptr_for_ref => Some("crate::ln::features::InitFeatures"),
429 "ln::features::InitFeatures" if is_ref => Some("*const crate::ln::features::InitFeatures"),
430 "ln::features::InitFeatures" => Some("crate::ln::features::InitFeatures"),
432 eprintln!(" Type {} (ref: {}) unresolvable in C", full_path, is_ref);
438 fn from_c_conversion_new_var_from_path<'b>(&self, _full_path: &str, _is_ref: bool) -> Option<(&'b str, &'b str)> {
441 fn from_c_conversion_prefix_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<String> {
442 if self.is_primitive(full_path) {
443 return Some("".to_owned());
446 "Vec" if !is_ref => Some("local_"),
447 "Result" if !is_ref => Some("local_"),
448 "Option" if is_ref => Some("&local_"),
449 "Option" => Some("local_"),
451 "[u8; 32]" if is_ref => Some("unsafe { &*"),
452 "[u8; 32]" if !is_ref => Some(""),
453 "[u8; 16]" if !is_ref => Some(""),
454 "[u8; 10]" if !is_ref => Some(""),
455 "[u8; 4]" if !is_ref => Some(""),
456 "[u8; 3]" if !is_ref => Some(""),
458 "[u8]" if is_ref => Some(""),
459 "[usize]" if is_ref => Some(""),
461 "str" if is_ref => Some(""),
462 "String" if !is_ref => Some("String::from_utf8("),
463 // Note that we'll panic for String if is_ref, as we only have non-owned memory, we
464 // cannot create a &String.
466 "std::time::Duration" => Some("std::time::Duration::from_secs("),
468 "bitcoin::secp256k1::key::PublicKey" if is_ref => Some("&"),
469 "bitcoin::secp256k1::key::PublicKey" => Some(""),
470 "bitcoin::secp256k1::Signature" if is_ref => Some("&"),
471 "bitcoin::secp256k1::Signature" => Some(""),
472 "bitcoin::secp256k1::key::SecretKey" if is_ref => Some("&::bitcoin::secp256k1::key::SecretKey::from_slice(&unsafe { *"),
473 "bitcoin::secp256k1::key::SecretKey" if !is_ref => Some(""),
474 "bitcoin::blockdata::script::Script" if is_ref => Some("&::bitcoin::blockdata::script::Script::from(Vec::from("),
475 "bitcoin::blockdata::script::Script" if !is_ref => Some("::bitcoin::blockdata::script::Script::from("),
476 "bitcoin::blockdata::transaction::Transaction" if is_ref => Some("&"),
477 "bitcoin::blockdata::transaction::Transaction" => Some(""),
478 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(""),
479 "bitcoin::network::constants::Network" => Some(""),
480 "bitcoin::blockdata::block::BlockHeader" => Some("&::bitcoin::consensus::encode::deserialize(unsafe { &*"),
481 "bitcoin::blockdata::block::Block" if is_ref => Some("&::bitcoin::consensus::encode::deserialize("),
483 // Newtypes that we just expose in their original form.
484 "bitcoin::hash_types::Txid" if is_ref => Some("&::bitcoin::hash_types::Txid::from_slice(&unsafe { &*"),
485 "bitcoin::hash_types::Txid" if !is_ref => Some("::bitcoin::hash_types::Txid::from_slice(&"),
486 "bitcoin::hash_types::BlockHash" => Some("::bitcoin::hash_types::BlockHash::from_slice(&"),
487 "ln::channelmanager::PaymentHash" if !is_ref => Some("::lightning::ln::channelmanager::PaymentHash("),
488 "ln::channelmanager::PaymentHash" if is_ref => Some("&::lightning::ln::channelmanager::PaymentHash(unsafe { *"),
489 "ln::channelmanager::PaymentPreimage" if !is_ref => Some("::lightning::ln::channelmanager::PaymentPreimage("),
490 "ln::channelmanager::PaymentPreimage" if is_ref => Some("&::lightning::ln::channelmanager::PaymentPreimage(unsafe { *"),
491 "ln::channelmanager::PaymentSecret" => Some("::lightning::ln::channelmanager::PaymentSecret("),
493 // List of structs we map (possibly during processing of other files):
494 "ln::features::InitFeatures" if !is_ref => Some("*unsafe { Box::from_raw("),
496 // List of traits we map (possibly during processing of other files):
497 "crate::util::logger::Logger" => Some(""),
500 eprintln!(" Type {} unconvertable from C", full_path);
503 }.map(|s| s.to_owned())
505 fn from_c_conversion_suffix_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<String> {
506 if self.is_primitive(full_path) {
507 return Some("".to_owned());
510 "Vec" if !is_ref => Some(""),
511 "Option" => Some(""),
512 "Result" if !is_ref => Some(""),
514 "[u8; 32]" if is_ref => Some("}"),
515 "[u8; 32]" if !is_ref => Some(".data"),
516 "[u8; 16]" if !is_ref => Some(".data"),
517 "[u8; 10]" if !is_ref => Some(".data"),
518 "[u8; 4]" if !is_ref => Some(".data"),
519 "[u8; 3]" if !is_ref => Some(".data"),
521 "[u8]" if is_ref => Some(".to_slice()"),
522 "[usize]" if is_ref => Some(".to_slice()"),
524 "str" if is_ref => Some(".into()"),
525 "String" if !is_ref => Some(".into_rust()).unwrap()"),
527 "std::time::Duration" => Some(")"),
529 "bitcoin::secp256k1::key::PublicKey" => Some(".into_rust()"),
530 "bitcoin::secp256k1::Signature" => Some(".into_rust()"),
531 "bitcoin::secp256k1::key::SecretKey" if !is_ref => Some(".into_rust()"),
532 "bitcoin::secp256k1::key::SecretKey" if is_ref => Some("}[..]).unwrap()"),
533 "bitcoin::blockdata::script::Script" if is_ref => Some(".to_slice()))"),
534 "bitcoin::blockdata::script::Script" if !is_ref => Some(".into_rust())"),
535 "bitcoin::blockdata::transaction::Transaction" => Some(".into_bitcoin()"),
536 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(".into_rust()"),
537 "bitcoin::network::constants::Network" => Some(".into_bitcoin()"),
538 "bitcoin::blockdata::block::BlockHeader" => Some(" }).unwrap()"),
539 "bitcoin::blockdata::block::Block" => Some(".to_slice()).unwrap()"),
541 // Newtypes that we just expose in their original form.
542 "bitcoin::hash_types::Txid" if is_ref => Some(" }[..]).unwrap()"),
543 "bitcoin::hash_types::Txid" => Some(".data[..]).unwrap()"),
544 "bitcoin::hash_types::BlockHash" if !is_ref => Some(".data[..]).unwrap()"),
545 "ln::channelmanager::PaymentHash" if !is_ref => Some(".data)"),
546 "ln::channelmanager::PaymentHash" if is_ref => Some(" })"),
547 "ln::channelmanager::PaymentPreimage" if !is_ref => Some(".data)"),
548 "ln::channelmanager::PaymentPreimage" if is_ref => Some(" })"),
549 "ln::channelmanager::PaymentSecret" => Some(".data)"),
551 // List of structs we map (possibly during processing of other files):
552 "ln::features::InitFeatures" if is_ref => Some(".inner) }"),
553 "ln::features::InitFeatures" if !is_ref => Some(".take_ptr()) }"),
555 // List of traits we map (possibly during processing of other files):
556 "crate::util::logger::Logger" => Some(""),
559 eprintln!(" Type {} unconvertable from C", full_path);
562 }.map(|s| s.to_owned())
565 fn to_c_conversion_new_var_from_path<'b>(&self, full_path: &str, is_ref: bool) -> Option<(&'b str, &'b str)> {
566 if self.is_primitive(full_path) {
570 "[u8]" if is_ref => Some(("crate::c_types::u8slice::from_slice(", ")")),
571 "[usize]" if is_ref => Some(("crate::c_types::usizeslice::from_slice(", ")")),
573 "bitcoin::blockdata::transaction::Transaction" if is_ref => Some(("::bitcoin::consensus::encode::serialize(", ")")),
574 "bitcoin::blockdata::transaction::Transaction" if !is_ref => Some(("::bitcoin::consensus::encode::serialize(&", ")")),
575 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some(("{ let mut s = [0u8; 80]; s[..].copy_from_slice(&::bitcoin::consensus::encode::serialize(", ")); s }")),
576 "bitcoin::blockdata::block::Block" if is_ref => Some(("::bitcoin::consensus::encode::serialize(", ")")),
577 "bitcoin::hash_types::Txid" => None,
579 // Override the default since Records contain an fmt with a lifetime:
580 // TODO: We should include the other record fields
581 "util::logger::Record" => Some(("std::ffi::CString::new(format!(\"{}\", ", ".args)).unwrap()")),
583 }.map(|s| s.to_owned())
585 fn to_c_conversion_inline_prefix_from_path(&self, full_path: &str, is_ref: bool, ptr_for_ref: bool) -> Option<String> {
586 if self.is_primitive(full_path) {
587 return Some("".to_owned());
590 "Result" if !is_ref => Some("local_"),
591 "Vec" if !is_ref => Some("local_"),
592 "Option" => Some("local_"),
594 "[u8; 32]" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
595 "[u8; 32]" if is_ref => Some("&"),
596 "[u8; 16]" if !is_ref => Some("crate::c_types::SixteenBytes { data: "),
597 "[u8; 10]" if !is_ref => Some("crate::c_types::TenBytes { data: "),
598 "[u8; 4]" if !is_ref => Some("crate::c_types::FourBytes { data: "),
599 "[u8; 3]" if is_ref => Some("&"),
601 "[u8]" if is_ref => Some("local_"),
602 "[usize]" if is_ref => Some("local_"),
604 "str" if is_ref => Some(""),
605 "String" => Some(""),
607 "std::time::Duration" => Some(""),
609 "bitcoin::secp256k1::key::PublicKey" => Some("crate::c_types::PublicKey::from_rust(&"),
610 "bitcoin::secp256k1::Signature" => Some("crate::c_types::Signature::from_rust(&"),
611 "bitcoin::secp256k1::key::SecretKey" if is_ref => Some(""),
612 "bitcoin::secp256k1::key::SecretKey" if !is_ref => Some("crate::c_types::SecretKey::from_rust("),
613 "bitcoin::secp256k1::Error" if !is_ref => Some("crate::c_types::Secp256k1Error::from_rust("),
614 "bitcoin::blockdata::script::Script" if is_ref => Some("crate::c_types::u8slice::from_slice(&"),
615 "bitcoin::blockdata::script::Script" if !is_ref => Some(""),
616 "bitcoin::blockdata::transaction::Transaction" => Some("crate::c_types::Transaction::from_vec(local_"),
617 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some("crate::c_types::TxOut::from_rust("),
618 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some("&local_"),
619 "bitcoin::blockdata::block::Block" if is_ref => Some("crate::c_types::u8slice::from_slice(&local_"),
621 "bitcoin::hash_types::Txid" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
623 // Newtypes that we just expose in their original form.
624 "bitcoin::hash_types::Txid" if is_ref => Some(""),
625 "bitcoin::hash_types::BlockHash" if is_ref => Some(""),
626 "bitcoin::hash_types::BlockHash" => Some("crate::c_types::ThirtyTwoBytes { data: "),
627 "ln::channelmanager::PaymentHash" if is_ref => Some("&"),
628 "ln::channelmanager::PaymentHash" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
629 "ln::channelmanager::PaymentPreimage" if is_ref => Some("&"),
630 "ln::channelmanager::PaymentPreimage" => Some("crate::c_types::ThirtyTwoBytes { data: "),
631 "ln::channelmanager::PaymentSecret" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
633 // Override the default since Records contain an fmt with a lifetime:
634 "util::logger::Record" => Some("local_"),
636 // List of structs we map (possibly during processing of other files):
637 "ln::features::InitFeatures" if is_ref && ptr_for_ref => Some("crate::ln::features::InitFeatures { inner: &mut "),
638 "ln::features::InitFeatures" if is_ref => Some("Box::into_raw(Box::new(crate::ln::features::InitFeatures { inner: &mut "),
639 "ln::features::InitFeatures" if !is_ref => Some("crate::ln::features::InitFeatures { inner: Box::into_raw(Box::new("),
642 eprintln!(" Type {} (is_ref: {}) unconvertable to C", full_path, is_ref);
645 }.map(|s| s.to_owned())
647 fn to_c_conversion_inline_suffix_from_path(&self, full_path: &str, is_ref: bool, ptr_for_ref: bool) -> Option<String> {
648 if self.is_primitive(full_path) {
649 return Some("".to_owned());
652 "Result" if !is_ref => Some(""),
653 "Vec" if !is_ref => Some(".into()"),
654 "Option" => Some(""),
656 "[u8; 32]" if !is_ref => Some(" }"),
657 "[u8; 32]" if is_ref => Some(""),
658 "[u8; 16]" if !is_ref => Some(" }"),
659 "[u8; 10]" if !is_ref => Some(" }"),
660 "[u8; 4]" if !is_ref => Some(" }"),
661 "[u8; 3]" if is_ref => Some(""),
663 "[u8]" if is_ref => Some(""),
664 "[usize]" if is_ref => Some(""),
666 "str" if is_ref => Some(".into()"),
667 "String" if !is_ref => Some(".into_bytes().into()"),
668 "String" if is_ref => Some(".as_str().into()"),
670 "std::time::Duration" => Some(".as_secs()"),
672 "bitcoin::secp256k1::key::PublicKey" => Some(")"),
673 "bitcoin::secp256k1::Signature" => Some(")"),
674 "bitcoin::secp256k1::key::SecretKey" if !is_ref => Some(")"),
675 "bitcoin::secp256k1::key::SecretKey" if is_ref => Some(".as_ref()"),
676 "bitcoin::secp256k1::Error" if !is_ref => Some(")"),
677 "bitcoin::blockdata::script::Script" if is_ref => Some("[..])"),
678 "bitcoin::blockdata::script::Script" if !is_ref => Some(".into_bytes().into()"),
679 "bitcoin::blockdata::transaction::Transaction" => Some(")"),
680 "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(")"),
681 "bitcoin::blockdata::block::BlockHeader" if is_ref => Some(""),
682 "bitcoin::blockdata::block::Block" if is_ref => Some(")"),
684 "bitcoin::hash_types::Txid" if !is_ref => Some(".into_inner() }"),
686 // Newtypes that we just expose in their original form.
687 "bitcoin::hash_types::Txid" if is_ref => Some(".as_inner()"),
688 "bitcoin::hash_types::BlockHash" if is_ref => Some(".as_inner()"),
689 "bitcoin::hash_types::BlockHash" => Some(".into_inner() }"),
690 "ln::channelmanager::PaymentHash" if is_ref => Some(".0"),
691 "ln::channelmanager::PaymentHash" => Some(".0 }"),
692 "ln::channelmanager::PaymentPreimage" if is_ref => Some(".0"),
693 "ln::channelmanager::PaymentPreimage" => Some(".0 }"),
694 "ln::channelmanager::PaymentSecret" if !is_ref => Some(".0 }"),
696 // Override the default since Records contain an fmt with a lifetime:
697 "util::logger::Record" => Some(".as_ptr()"),
699 // List of structs we map (possibly during processing of other files):
700 "ln::features::InitFeatures" if is_ref && ptr_for_ref => Some(", is_owned: false }"),
701 "ln::features::InitFeatures" if is_ref => Some(", is_owned: false }))"),
702 "ln::features::InitFeatures" => Some(")), is_owned: true }"),
705 eprintln!(" Type {} unconvertable to C", full_path);
708 }.map(|s| s.to_owned())
711 fn empty_val_check_suffix_from_path(&self, full_path: &str) -> Option<&str> {
713 "ln::channelmanager::PaymentSecret" => Some(".data == [0; 32]"),
714 "bitcoin::secp256k1::key::PublicKey" => Some(".is_null()"),
715 "bitcoin::secp256k1::Signature" => Some(".is_null()"),
720 // ****************************
721 // *** Container Processing ***
722 // ****************************
724 /// Returns the module path in the generated mapping crate to the containers which we generate
725 /// when writing to CrateTypes::template_file.
726 fn generated_container_path() -> &'static str {
727 "crate::c_types::derived"
729 /// Returns the module path in the generated mapping crate to the container templates, which
730 /// are then concretized and put in the generated container path/template_file.
731 fn container_templ_path() -> &'static str {
735 /// Returns true if this is a "transparent" container, ie an Option or a container which does
736 /// not require a generated continer class.
737 fn is_transparent_container(&self, full_path: &str, _is_ref: bool) -> bool {
738 full_path == "Option"
740 /// Returns true if this is a known, supported, non-transparent container.
741 fn is_known_container(&self, full_path: &str, is_ref: bool) -> bool {
742 (full_path == "Result" && !is_ref) || (full_path == "Vec" && !is_ref) || full_path.ends_with("Tuple")
744 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)
745 // Returns prefix + Vec<(prefix, var-name-to-inline-convert)> + suffix
746 // expecting one element in the vec per generic type, each of which is inline-converted
747 -> Option<(&'b str, Vec<(String, String)>, &'b str)> {
749 "Result" if !is_ref => {
751 vec![(" { Ok(mut o) => crate::c_types::CResultTempl::ok(".to_string(), "o".to_string()),
752 ("), Err(mut e) => crate::c_types::CResultTempl::err(".to_string(), "e".to_string())],
755 "Vec" if !is_ref => {
756 Some(("Vec::new(); for item in ", vec![(format!(".drain(..) {{ local_{}.push(", var_name), "item".to_string())], "); }"))
759 Some(("Vec::new(); for item in ", vec![(format!(".iter() {{ local_{}.push(", var_name), "**item".to_string())], "); }"))
762 if let Some(syn::Type::Path(p)) = single_contained {
763 if self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)) {
765 return Some(("if ", vec![
766 (".is_none() { std::ptr::null() } else { ".to_owned(), format!("({}.as_ref().unwrap())", var_access))
769 return Some(("if ", vec![
770 (".is_none() { std::ptr::null_mut() } else { ".to_owned(), format!("({}.unwrap())", var_access))
775 if let Some(t) = single_contained {
776 let mut v = Vec::new();
777 self.write_empty_rust_val(generics, &mut v, t);
778 let s = String::from_utf8(v).unwrap();
779 return Some(("if ", vec![
780 (format!(".is_none() {{ {} }} else {{ ", s), format!("({}.unwrap())", var_access))
782 } else { unreachable!(); }
788 /// only_contained_has_inner implies that there is only one contained element in the container
789 /// and it has an inner field (ie is an "opaque" type we've defined).
790 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)
791 // Returns prefix + Vec<(prefix, var-name-to-inline-convert)> + suffix
792 // expecting one element in the vec per generic type, each of which is inline-converted
793 -> Option<(&'b str, Vec<(String, String)>, &'b str)> {
795 "Result" if !is_ref => {
797 vec![(".result_ok { true => Ok(".to_string(), format!("(*unsafe {{ Box::from_raw({}.contents.result.take_ptr()) }})", var_name)),
798 ("), false => Err(".to_string(), format!("(*unsafe {{ Box::from_raw({}.contents.err.take_ptr()) }})", var_name))],
801 "Vec"|"Slice" if !is_ref => {
802 Some(("Vec::new(); for mut item in ", vec![(format!(".into_rust().drain(..) {{ local_{}.push(", var_name), "item".to_string())], "); }"))
804 "Slice" if is_ref => {
805 Some(("Vec::new(); for mut item in ", vec![(format!(".as_slice().iter() {{ local_{}.push(", var_name), "item".to_string())], "); }"))
808 if let Some(syn::Type::Path(p)) = single_contained {
809 if self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)) {
811 return Some(("if ", vec![(".inner.is_null() { None } else { Some((*".to_string(), format!("{}", var_name))], ").clone()) }"))
813 return Some(("if ", vec![(".inner.is_null() { None } else { Some(".to_string(), format!("{}", var_name))], ") }"));
818 if let Some(t) = single_contained {
819 let mut v = Vec::new();
820 let ret_ref = self.write_empty_rust_val_check_suffix(generics, &mut v, t);
821 let s = String::from_utf8(v).unwrap();
823 EmptyValExpectedTy::ReferenceAsPointer =>
824 return Some(("if ", vec![
825 (format!("{} {{ None }} else {{ Some(", s), format!("unsafe {{ &mut *{} }}", var_access))
827 EmptyValExpectedTy::OwnedPointer =>
828 return Some(("if ", vec![
829 (format!("{} {{ None }} else {{ Some(", s), format!("unsafe {{ *Box::from_raw({}) }}", var_access))
831 EmptyValExpectedTy::NonPointer =>
832 return Some(("if ", vec![
833 (format!("{} {{ None }} else {{ Some(", s), format!("{}", var_access))
836 } else { unreachable!(); }
842 // *************************************************
843 // *** Type definition during main.rs processing ***
844 // *************************************************
846 fn process_use_intern<W: std::io::Write>(&mut self, w: &mut W, u: &syn::UseTree, partial_path: &str) {
848 syn::UseTree::Path(p) => {
849 let new_path = format!("{}::{}", partial_path, p.ident);
850 self.process_use_intern(w, &p.tree, &new_path);
852 syn::UseTree::Name(n) => {
853 let full_path = format!("{}::{}", partial_path, n.ident);
854 self.imports.insert(n.ident.clone(), full_path);
856 syn::UseTree::Group(g) => {
857 for i in g.items.iter() {
858 self.process_use_intern(w, i, partial_path);
861 syn::UseTree::Rename(r) => {
862 let full_path = format!("{}::{}", partial_path, r.ident);
863 self.imports.insert(r.rename.clone(), full_path);
865 syn::UseTree::Glob(_) => {
866 eprintln!("Ignoring * use for {} - this may result in resolution failures", partial_path);
870 pub fn process_use<W: std::io::Write>(&mut self, w: &mut W, u: &syn::ItemUse) {
871 if let syn::Visibility::Public(_) = u.vis {
872 // We actually only use these for #[cfg(fuzztarget)]
873 eprintln!("Ignoring pub(use) tree!");
877 syn::UseTree::Path(p) => {
878 let new_path = format!("{}", p.ident);
879 self.process_use_intern(w, &p.tree, &new_path);
881 syn::UseTree::Name(n) => {
882 let full_path = format!("{}", n.ident);
883 self.imports.insert(n.ident.clone(), full_path);
885 _ => unimplemented!(),
887 if u.leading_colon.is_some() { unimplemented!() }
890 pub fn mirrored_enum_declared(&mut self, ident: &syn::Ident) {
891 eprintln!("{} mirrored", ident);
892 self.declared.insert(ident.clone(), DeclType::MirroredEnum);
894 pub fn enum_ignored(&mut self, ident: &'c syn::Ident) {
895 self.declared.insert(ident.clone(), DeclType::EnumIgnored);
897 pub fn struct_imported(&mut self, ident: &'c syn::Ident, named: String) {
898 eprintln!("Imported {} as {}", ident, named);
899 self.declared.insert(ident.clone(), DeclType::StructImported);
901 pub fn struct_ignored(&mut self, ident: &syn::Ident) {
902 eprintln!("Not importing {}", ident);
903 self.declared.insert(ident.clone(), DeclType::StructIgnored);
905 pub fn trait_declared(&mut self, ident: &syn::Ident, t: &'c syn::ItemTrait) {
906 eprintln!("Trait {} created", ident);
907 self.declared.insert(ident.clone(), DeclType::Trait(t));
909 pub fn get_declared_type(&'a self, ident: &syn::Ident) -> Option<&'a DeclType<'c>> {
910 self.declared.get(ident)
912 /// Returns true if the object at the given path is mapped as X { inner: *mut origX, .. }.
913 fn c_type_has_inner_from_path(&self, full_path: &str) -> bool{
914 self.crate_types.opaques.get(full_path).is_some()
917 pub fn maybe_resolve_ident(&self, id: &syn::Ident) -> Option<String> {
918 if let Some(imp) = self.imports.get(id) {
920 } else if self.declared.get(id).is_some() {
921 Some(self.module_path.to_string() + "::" + &format!("{}", id))
925 pub fn maybe_resolve_non_ignored_ident(&self, id: &syn::Ident) -> Option<String> {
926 if let Some(imp) = self.imports.get(id) {
928 } else if let Some(decl_type) = self.declared.get(id) {
930 DeclType::StructIgnored => None,
931 _ => Some(self.module_path.to_string() + "::" + &format!("{}", id)),
936 pub fn maybe_resolve_path(&self, p_arg: &syn::Path, generics: Option<&GenericTypes>) -> Option<String> {
937 let p = if let Some(gen_types) = generics {
938 if let Some((_, synpath)) = gen_types.maybe_resolve_path(p_arg) {
943 if p.leading_colon.is_some() {
944 Some(p.segments.iter().enumerate().map(|(idx, seg)| {
945 format!("{}{}", if idx == 0 { "" } else { "::" }, seg.ident)
947 } else if let Some(id) = p.get_ident() {
948 self.maybe_resolve_ident(id)
950 if p.segments.len() == 1 {
951 let seg = p.segments.iter().next().unwrap();
952 return self.maybe_resolve_ident(&seg.ident);
954 let mut seg_iter = p.segments.iter();
955 let first_seg = seg_iter.next().unwrap();
956 let remaining: String = seg_iter.map(|seg| {
957 format!("::{}", seg.ident)
959 if let Some(imp) = self.imports.get(&first_seg.ident) {
961 Some(imp.clone() + &remaining)
968 pub fn resolve_path(&self, p: &syn::Path, generics: Option<&GenericTypes>) -> String {
969 self.maybe_resolve_path(p, generics).unwrap()
972 // ***********************************
973 // *** Original Rust Type Printing ***
974 // ***********************************
976 fn in_rust_prelude(resolved_path: &str) -> bool {
977 match resolved_path {
985 fn write_rust_path<W: std::io::Write>(&self, w: &mut W, generics_resolver: Option<&GenericTypes>, path: &syn::Path) {
986 if let Some(resolved) = self.maybe_resolve_path(&path, generics_resolver) {
987 if self.is_primitive(&resolved) {
988 write!(w, "{}", path.get_ident().unwrap()).unwrap();
990 // TODO: We should have a generic "is from a dependency" check here instead of
991 // checking for "bitcoin" explicitly.
992 if resolved.starts_with("bitcoin::") || Self::in_rust_prelude(&resolved) {
993 write!(w, "{}", resolved).unwrap();
994 // If we're printing a generic argument, it needs to reference the crate, otherwise
995 // the original crate:
996 } else if self.maybe_resolve_path(&path, None).as_ref() == Some(&resolved) {
997 write!(w, "{}::{}", self.orig_crate, resolved).unwrap();
999 write!(w, "crate::{}", resolved).unwrap();
1002 if let syn::PathArguments::AngleBracketed(args) = &path.segments.iter().last().unwrap().arguments {
1003 self.write_rust_generic_arg(w, generics_resolver, args.args.iter());
1006 if path.leading_colon.is_some() {
1007 write!(w, "::").unwrap();
1009 for (idx, seg) in path.segments.iter().enumerate() {
1010 if idx != 0 { write!(w, "::").unwrap(); }
1011 write!(w, "{}", seg.ident).unwrap();
1012 if let syn::PathArguments::AngleBracketed(args) = &seg.arguments {
1013 self.write_rust_generic_arg(w, generics_resolver, args.args.iter());
1018 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>) {
1019 let mut had_params = false;
1020 for (idx, arg) in generics.enumerate() {
1021 if idx != 0 { write!(w, ", ").unwrap(); } else { write!(w, "<").unwrap(); }
1024 syn::GenericParam::Lifetime(lt) => write!(w, "'{}", lt.lifetime.ident).unwrap(),
1025 syn::GenericParam::Type(t) => {
1026 write!(w, "{}", t.ident).unwrap();
1027 if t.colon_token.is_some() { write!(w, ":").unwrap(); }
1028 for (idx, bound) in t.bounds.iter().enumerate() {
1029 if idx != 0 { write!(w, " + ").unwrap(); }
1031 syn::TypeParamBound::Trait(tb) => {
1032 if tb.paren_token.is_some() || tb.lifetimes.is_some() { unimplemented!(); }
1033 self.write_rust_path(w, generics_resolver, &tb.path);
1035 _ => unimplemented!(),
1038 if t.eq_token.is_some() || t.default.is_some() { unimplemented!(); }
1040 _ => unimplemented!(),
1043 if had_params { write!(w, ">").unwrap(); }
1046 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>) {
1047 write!(w, "<").unwrap();
1048 for (idx, arg) in generics.enumerate() {
1049 if idx != 0 { write!(w, ", ").unwrap(); }
1051 syn::GenericArgument::Type(t) => self.write_rust_type(w, generics_resolver, t),
1052 _ => unimplemented!(),
1055 write!(w, ">").unwrap();
1057 pub fn write_rust_type<W: std::io::Write>(&self, w: &mut W, generics: Option<&GenericTypes>, t: &syn::Type) {
1059 syn::Type::Path(p) => {
1060 if p.qself.is_some() || p.path.leading_colon.is_some() {
1063 self.write_rust_path(w, generics, &p.path);
1065 syn::Type::Reference(r) => {
1066 write!(w, "&").unwrap();
1067 if let Some(lft) = &r.lifetime {
1068 write!(w, "'{} ", lft.ident).unwrap();
1070 if r.mutability.is_some() {
1071 write!(w, "mut ").unwrap();
1073 self.write_rust_type(w, generics, &*r.elem);
1075 syn::Type::Array(a) => {
1076 write!(w, "[").unwrap();
1077 self.write_rust_type(w, generics, &a.elem);
1078 if let syn::Expr::Lit(l) = &a.len {
1079 if let syn::Lit::Int(i) = &l.lit {
1080 write!(w, "; {}]", i).unwrap();
1081 } else { unimplemented!(); }
1082 } else { unimplemented!(); }
1084 syn::Type::Slice(s) => {
1085 write!(w, "[").unwrap();
1086 self.write_rust_type(w, generics, &s.elem);
1087 write!(w, "]").unwrap();
1089 syn::Type::Tuple(s) => {
1090 write!(w, "(").unwrap();
1091 for (idx, t) in s.elems.iter().enumerate() {
1092 if idx != 0 { write!(w, ", ").unwrap(); }
1093 self.write_rust_type(w, generics, &t);
1095 write!(w, ")").unwrap();
1097 _ => unimplemented!(),
1101 /// Prints a constructor for something which is "uninitialized" (but obviously not actually
1102 /// unint'd memory).
1103 pub fn write_empty_rust_val<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type) {
1105 syn::Type::Path(p) => {
1106 let resolved = self.resolve_path(&p.path, generics);
1107 if self.crate_types.opaques.get(&resolved).is_some() {
1108 write!(w, "crate::{} {{ inner: std::ptr::null_mut(), is_owned: true }}", resolved).unwrap();
1110 // Assume its a manually-mapped C type, where we can just define an null() fn
1111 write!(w, "{}::null()", self.c_type_from_path(&resolved, false, false).unwrap()).unwrap();
1114 syn::Type::Array(a) => {
1115 if let syn::Expr::Lit(l) = &a.len {
1116 if let syn::Lit::Int(i) = &l.lit {
1117 if i.base10_digits().parse::<usize>().unwrap() < 32 {
1118 // Blindly assume that if we're trying to create an empty value for an
1119 // array < 32 entries that all-0s may be a valid state.
1122 let arrty = format!("[u8; {}]", i.base10_digits());
1123 write!(w, "{}", self.to_c_conversion_inline_prefix_from_path(&arrty, false, false).unwrap()).unwrap();
1124 write!(w, "[0; {}]", i.base10_digits()).unwrap();
1125 write!(w, "{}", self.to_c_conversion_inline_suffix_from_path(&arrty, false, false).unwrap()).unwrap();
1126 } else { unimplemented!(); }
1127 } else { unimplemented!(); }
1129 _ => unimplemented!(),
1133 /// Prints a suffix to determine if a variable is empty (ie was set by write_empty_rust_val).
1134 /// See EmptyValExpectedTy for information on return types.
1135 fn write_empty_rust_val_check_suffix<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type) -> EmptyValExpectedTy {
1137 syn::Type::Path(p) => {
1138 let resolved = self.resolve_path(&p.path, generics);
1139 if self.crate_types.opaques.get(&resolved).is_some() {
1140 write!(w, ".inner.is_null()").unwrap();
1141 EmptyValExpectedTy::NonPointer
1143 if let Some(suffix) = self.empty_val_check_suffix_from_path(&resolved) {
1144 write!(w, "{}", suffix).unwrap();
1145 // We may eventually need to allow empty_val_check_suffix_from_path to specify if we need a deref or not
1146 EmptyValExpectedTy::NonPointer
1148 write!(w, " == std::ptr::null_mut()").unwrap();
1149 EmptyValExpectedTy::OwnedPointer
1153 syn::Type::Array(a) => {
1154 if let syn::Expr::Lit(l) = &a.len {
1155 if let syn::Lit::Int(i) = &l.lit {
1156 write!(w, " == [0; {}]", i.base10_digits()).unwrap();
1157 EmptyValExpectedTy::NonPointer
1158 } else { unimplemented!(); }
1159 } else { unimplemented!(); }
1161 syn::Type::Slice(_) => {
1162 // Option<[]> always implies that we want to treat len() == 0 differently from
1163 // None, so we always map an Option<[]> into a pointer.
1164 write!(w, " == std::ptr::null_mut()").unwrap();
1165 EmptyValExpectedTy::ReferenceAsPointer
1167 _ => unimplemented!(),
1171 /// Prints a suffix to determine if a variable is empty (ie was set by write_empty_rust_val).
1172 pub fn write_empty_rust_val_check<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type, var_access: &str) {
1174 syn::Type::Path(_) => {
1175 write!(w, "{}", var_access).unwrap();
1176 self.write_empty_rust_val_check_suffix(generics, w, t);
1178 syn::Type::Array(a) => {
1179 if let syn::Expr::Lit(l) = &a.len {
1180 if let syn::Lit::Int(i) = &l.lit {
1181 let arrty = format!("[u8; {}]", i.base10_digits());
1182 // We don't (yet) support a new-var conversion here.
1183 assert!(self.from_c_conversion_new_var_from_path(&arrty, false).is_none());
1185 self.from_c_conversion_prefix_from_path(&arrty, false).unwrap(),
1187 self.from_c_conversion_suffix_from_path(&arrty, false).unwrap()).unwrap();
1188 self.write_empty_rust_val_check_suffix(generics, w, t);
1189 } else { unimplemented!(); }
1190 } else { unimplemented!(); }
1192 _ => unimplemented!(),
1196 // ********************************
1197 // *** Type conversion printing ***
1198 // ********************************
1200 /// Returns true we if can just skip passing this to C entirely
1201 pub fn skip_arg(&self, t: &syn::Type, generics: Option<&GenericTypes>) -> bool {
1203 syn::Type::Path(p) => {
1204 if p.qself.is_some() { unimplemented!(); }
1205 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
1206 self.skip_path(&full_path)
1209 syn::Type::Reference(r) => {
1210 self.skip_arg(&*r.elem, generics)
1215 pub fn no_arg_to_rust<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
1217 syn::Type::Path(p) => {
1218 if p.qself.is_some() { unimplemented!(); }
1219 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
1220 write!(w, "{}", self.no_arg_path_to_rust(&full_path)).unwrap();
1223 syn::Type::Reference(r) => {
1224 self.no_arg_to_rust(w, &*r.elem, generics);
1230 fn write_conversion_inline_intern<W: std::io::Write,
1231 LP: Fn(&str, bool, bool) -> Option<String>, DL: Fn(&mut W, &DeclType, &str, bool, bool), SC: Fn(bool) -> &'static str>
1232 (&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, is_ref: bool, is_mut: bool, ptr_for_ref: bool,
1233 tupleconv: &str, prefix: bool, sliceconv: SC, path_lookup: LP, decl_lookup: DL) {
1235 syn::Type::Reference(r) => {
1236 self.write_conversion_inline_intern(w, &*r.elem, generics, true, r.mutability.is_some(),
1237 ptr_for_ref, tupleconv, prefix, sliceconv, path_lookup, decl_lookup);
1239 syn::Type::Path(p) => {
1240 if p.qself.is_some() {
1244 let resolved_path = self.resolve_path(&p.path, generics);
1245 if let Some(aliased_type) = self.crate_types.type_aliases.get(&resolved_path) {
1246 return self.write_conversion_inline_intern(w, aliased_type, None, is_ref, is_mut, ptr_for_ref, tupleconv, prefix, sliceconv, path_lookup, decl_lookup);
1247 } else if let Some(c_type) = path_lookup(&resolved_path, is_ref, ptr_for_ref) {
1248 write!(w, "{}", c_type).unwrap();
1249 } else if self.crate_types.opaques.get(&resolved_path).is_some() {
1250 decl_lookup(w, &DeclType::StructImported, &resolved_path, is_ref, is_mut);
1251 } else if self.crate_types.mirrored_enums.get(&resolved_path).is_some() {
1252 decl_lookup(w, &DeclType::MirroredEnum, &resolved_path, is_ref, is_mut);
1253 } else if let Some(ident) = single_ident_generic_path_to_ident(&p.path) {
1254 if let Some(t) = self.crate_types.traits.get(&resolved_path) {
1255 decl_lookup(w, &DeclType::Trait(t), &resolved_path, is_ref, is_mut);
1257 } else if let Some(_) = self.imports.get(ident) {
1258 // crate_types lookup has to have succeeded:
1259 panic!("Failed to print inline conversion for {}", ident);
1260 } else if let Some(decl_type) = self.declared.get(ident) {
1261 decl_lookup(w, decl_type, &self.maybe_resolve_ident(ident).unwrap(), is_ref, is_mut);
1262 } else { unimplemented!(); }
1265 syn::Type::Array(a) => {
1266 // We assume all arrays contain only [int_literal; X]s.
1267 // This may result in some outputs not compiling.
1268 if let syn::Expr::Lit(l) = &a.len {
1269 if let syn::Lit::Int(i) = &l.lit {
1270 write!(w, "{}", path_lookup(&format!("[u8; {}]", i.base10_digits()), is_ref, ptr_for_ref).unwrap()).unwrap();
1271 } else { unimplemented!(); }
1272 } else { unimplemented!(); }
1274 syn::Type::Slice(s) => {
1275 // We assume all slices contain only literals or references.
1276 // This may result in some outputs not compiling.
1277 if let syn::Type::Path(p) = &*s.elem {
1278 let resolved = self.resolve_path(&p.path, generics);
1279 assert!(self.is_primitive(&resolved));
1280 write!(w, "{}", path_lookup("[u8]", is_ref, ptr_for_ref).unwrap()).unwrap();
1281 } else if let syn::Type::Reference(r) = &*s.elem {
1282 if let syn::Type::Path(p) = &*r.elem {
1283 write!(w, "{}", sliceconv(self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)))).unwrap();
1284 } else { unimplemented!(); }
1285 } else if let syn::Type::Tuple(t) = &*s.elem {
1286 assert!(!t.elems.is_empty());
1288 write!(w, "&local_").unwrap();
1290 let mut needs_map = false;
1291 for e in t.elems.iter() {
1292 if let syn::Type::Reference(_) = e {
1297 write!(w, ".iter().map(|(").unwrap();
1298 for i in 0..t.elems.len() {
1299 write!(w, "{}{}", if i != 0 { ", " } else { "" }, ('a' as u8 + i as u8) as char).unwrap();
1301 write!(w, ")| (").unwrap();
1302 for (idx, e) in t.elems.iter().enumerate() {
1303 if let syn::Type::Reference(_) = e {
1304 write!(w, "{}{}", if idx != 0 { ", " } else { "" }, (idx as u8 + 'a' as u8) as char).unwrap();
1305 } else if let syn::Type::Path(_) = e {
1306 write!(w, "{}*{}", if idx != 0 { ", " } else { "" }, (idx as u8 + 'a' as u8) as char).unwrap();
1307 } else { unimplemented!(); }
1309 write!(w, ")).collect::<Vec<_>>()[..]").unwrap();
1312 } else { unimplemented!(); }
1314 syn::Type::Tuple(t) => {
1315 if t.elems.is_empty() {
1316 // cbindgen has poor support for (), see, eg https://github.com/eqrion/cbindgen/issues/527
1317 // so work around it by just pretending its a 0u8
1318 write!(w, "{}", tupleconv).unwrap();
1320 if prefix { write!(w, "local_").unwrap(); }
1323 _ => unimplemented!(),
1327 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) {
1328 self.write_conversion_inline_intern(w, t, generics, is_ref, false, ptr_for_ref, "0u8 /*", true, |_| "local_",
1329 |a, b, c| self.to_c_conversion_inline_prefix_from_path(a, b, c),
1330 |w, decl_type, decl_path, is_ref, _is_mut| {
1332 DeclType::MirroredEnum if is_ref && ptr_for_ref => write!(w, "crate::{}::from_native(&", decl_path).unwrap(),
1333 DeclType::MirroredEnum if is_ref => write!(w, "&crate::{}::from_native(&", decl_path).unwrap(),
1334 DeclType::MirroredEnum => write!(w, "crate::{}::native_into(", decl_path).unwrap(),
1335 DeclType::EnumIgnored|DeclType::StructImported if is_ref && ptr_for_ref && from_ptr =>
1336 write!(w, "crate::{} {{ inner: unsafe {{ (", decl_path).unwrap(),
1337 DeclType::EnumIgnored|DeclType::StructImported if is_ref && ptr_for_ref =>
1338 write!(w, "crate::{} {{ inner: unsafe {{ ( (&(", decl_path).unwrap(),
1339 DeclType::EnumIgnored|DeclType::StructImported if is_ref =>
1340 write!(w, "&crate::{} {{ inner: unsafe {{ (", decl_path).unwrap(),
1341 DeclType::EnumIgnored|DeclType::StructImported if !is_ref && from_ptr =>
1342 write!(w, "crate::{} {{ inner: ", decl_path).unwrap(),
1343 DeclType::EnumIgnored|DeclType::StructImported if !is_ref =>
1344 write!(w, "crate::{} {{ inner: Box::into_raw(Box::new(", decl_path).unwrap(),
1345 DeclType::Trait(_) if is_ref => write!(w, "&").unwrap(),
1346 _ => panic!("{:?}", decl_path),
1350 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) {
1351 self.write_to_c_conversion_inline_prefix_inner(w, t, generics, false, ptr_for_ref, false);
1353 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) {
1354 self.write_conversion_inline_intern(w, t, generics, is_ref, false, ptr_for_ref, "*/", false, |_| ".into()",
1355 |a, b, c| self.to_c_conversion_inline_suffix_from_path(a, b, c),
1356 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
1357 DeclType::MirroredEnum => write!(w, ")").unwrap(),
1358 DeclType::EnumIgnored|DeclType::StructImported if is_ref && ptr_for_ref && from_ptr =>
1359 write!(w, " as *const _) as *mut _ }}, is_owned: false }}").unwrap(),
1360 DeclType::EnumIgnored|DeclType::StructImported if is_ref && ptr_for_ref =>
1361 write!(w, ") as *const _) as *mut _) }}, is_owned: false }}").unwrap(),
1362 DeclType::EnumIgnored|DeclType::StructImported if is_ref =>
1363 write!(w, " as *const _) as *mut _ }}, is_owned: false }}").unwrap(),
1364 DeclType::EnumIgnored|DeclType::StructImported if !is_ref && from_ptr =>
1365 write!(w, ", is_owned: true }}").unwrap(),
1366 DeclType::EnumIgnored|DeclType::StructImported if !is_ref => write!(w, ")), is_owned: true }}").unwrap(),
1367 DeclType::Trait(_) if is_ref => {},
1368 _ => unimplemented!(),
1371 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) {
1372 self.write_to_c_conversion_inline_suffix_inner(w, t, generics, false, ptr_for_ref, false);
1375 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) {
1376 self.write_conversion_inline_intern(w, t, generics, is_ref, false, false, "() /*", true, |_| "&local_",
1377 |a, b, _c| self.from_c_conversion_prefix_from_path(a, b),
1378 |w, decl_type, _full_path, is_ref, is_mut| match decl_type {
1379 DeclType::StructImported if is_ref && ptr_for_ref => write!(w, "unsafe {{ &*(*").unwrap(),
1380 DeclType::StructImported if is_mut && is_ref => write!(w, "unsafe {{ &mut *").unwrap(),
1381 DeclType::StructImported if is_ref => write!(w, "unsafe {{ &*").unwrap(),
1382 DeclType::StructImported if !is_ref => write!(w, "*unsafe {{ Box::from_raw(").unwrap(),
1383 DeclType::MirroredEnum if is_ref => write!(w, "&").unwrap(),
1384 DeclType::MirroredEnum => {},
1385 DeclType::Trait(_) => {},
1386 _ => unimplemented!(),
1389 pub fn write_from_c_conversion_prefix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
1390 self.write_from_c_conversion_prefix_inner(w, t, generics, false, false);
1392 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) {
1393 self.write_conversion_inline_intern(w, t, generics, is_ref, false, false, "*/", false,
1394 |has_inner| match has_inner {
1395 false => ".iter().collect::<Vec<_>>()[..]",
1398 |a, b, _c| self.from_c_conversion_suffix_from_path(a, b),
1399 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
1400 DeclType::StructImported if is_ref && ptr_for_ref => write!(w, ").inner }}").unwrap(),
1401 DeclType::StructImported if is_ref => write!(w, ".inner }}").unwrap(),
1402 DeclType::StructImported if !is_ref => write!(w, ".take_ptr()) }}").unwrap(),
1403 DeclType::MirroredEnum if is_ref => write!(w, ".to_native()").unwrap(),
1404 DeclType::MirroredEnum => write!(w, ".into_native()").unwrap(),
1405 DeclType::Trait(_) => {},
1406 _ => unimplemented!(),
1409 pub fn write_from_c_conversion_suffix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
1410 self.write_from_c_conversion_suffix_inner(w, t, generics, false, false);
1412 // Note that compared to the above conversion functions, the following two are generally
1413 // significantly undertested:
1414 pub fn write_from_c_conversion_to_ref_prefix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
1415 self.write_conversion_inline_intern(w, t, generics, false, false, false, "() /*", true, |_| "&local_",
1417 if let Some(conv) = self.from_c_conversion_prefix_from_path(a, b) {
1418 Some(format!("&{}", conv))
1421 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
1422 DeclType::StructImported if !is_ref => write!(w, "unsafe {{ &*").unwrap(),
1423 _ => unimplemented!(),
1426 pub fn write_from_c_conversion_to_ref_suffix<W: std::io::Write>(&self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>) {
1427 self.write_conversion_inline_intern(w, t, generics, false, false, false, "*/", false,
1428 |has_inner| match has_inner {
1429 false => ".iter().collect::<Vec<_>>()[..]",
1432 |a, b, _c| self.from_c_conversion_suffix_from_path(a, b),
1433 |w, decl_type, _full_path, is_ref, _is_mut| match decl_type {
1434 DeclType::StructImported if !is_ref => write!(w, ".inner }}").unwrap(),
1435 _ => unimplemented!(),
1439 fn write_conversion_new_var_intern<'b, W: std::io::Write,
1440 LP: Fn(&str, bool) -> Option<(&str, &str)>,
1441 LC: Fn(&str, bool, Option<&syn::Type>, &syn::Ident, &str) -> Option<(&'b str, Vec<(String, String)>, &'b str)>,
1442 VP: Fn(&mut W, &syn::Type, Option<&GenericTypes>, bool, bool, bool),
1443 VS: Fn(&mut W, &syn::Type, Option<&GenericTypes>, bool, bool, bool)>
1444 (&self, w: &mut W, ident: &syn::Ident, var: &str, t: &syn::Type, generics: Option<&GenericTypes>,
1445 mut is_ref: bool, mut ptr_for_ref: bool, to_c: bool,
1446 path_lookup: &LP, container_lookup: &LC, var_prefix: &VP, var_suffix: &VS) -> bool {
1448 macro_rules! convert_container {
1449 ($container_type: expr, $args_len: expr, $args_iter: expr) => { {
1450 // For slices (and Options), we refuse to directly map them as is_ref when they
1451 // aren't opaque types containing an inner pointer. This is due to the fact that,
1452 // in both cases, the actual higher-level type is non-is_ref.
1453 let ty_has_inner = if self.is_transparent_container(&$container_type, is_ref) || $container_type == "Slice" {
1454 let ty = $args_iter().next().unwrap();
1455 if $container_type == "Slice" && to_c {
1456 // "To C ptr_for_ref" means "return the regular object with is_owned
1457 // set to false", which is totally what we want in a slice if we're about to
1458 // set ty_has_inner.
1461 if let syn::Type::Reference(t) = ty {
1462 if let syn::Type::Path(p) = &*t.elem {
1463 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
1465 } else if let syn::Type::Path(p) = ty {
1466 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
1470 // Options get a bunch of special handling, since in general we map Option<>al
1471 // types into the same C type as non-Option-wrapped types. This ends up being
1472 // pretty manual here and most of the below special-cases are for Options.
1473 let mut needs_ref_map = false;
1474 let mut only_contained_type = None;
1475 let mut only_contained_has_inner = false;
1476 let mut contains_slice = false;
1477 if $args_len == 1 && self.is_transparent_container(&$container_type, is_ref) {
1478 only_contained_has_inner = ty_has_inner;
1479 let arg = $args_iter().next().unwrap();
1480 if let syn::Type::Reference(t) = arg {
1481 only_contained_type = Some(&*t.elem);
1482 if let syn::Type::Path(_) = &*t.elem {
1484 } else if let syn::Type::Slice(_) = &*t.elem {
1485 contains_slice = true;
1486 } else { return false; }
1487 needs_ref_map = true;
1488 } else if let syn::Type::Path(_) = arg {
1489 only_contained_type = Some(&arg);
1490 } else { unimplemented!(); }
1493 if let Some((prefix, conversions, suffix)) = container_lookup(&$container_type, is_ref && ty_has_inner, only_contained_type, ident, var) {
1494 assert_eq!(conversions.len(), $args_len);
1495 write!(w, "let mut local_{}{} = ", ident, if !to_c && needs_ref_map {"_base"} else { "" }).unwrap();
1496 if only_contained_has_inner && to_c {
1497 var_prefix(w, $args_iter().next().unwrap(), generics, is_ref, ptr_for_ref, true);
1499 write!(w, "{}{}", prefix, var).unwrap();
1501 for ((pfx, var_name), (idx, ty)) in conversions.iter().zip($args_iter().enumerate()) {
1502 let mut var = std::io::Cursor::new(Vec::new());
1503 write!(&mut var, "{}", var_name).unwrap();
1504 let var_access = String::from_utf8(var.into_inner()).unwrap();
1506 let conv_ty = if needs_ref_map { only_contained_type.as_ref().unwrap() } else { ty };
1508 write!(w, "{} {{ ", pfx).unwrap();
1509 let new_var_name = format!("{}_{}", ident, idx);
1510 let new_var = self.write_conversion_new_var_intern(w, &syn::Ident::new(&new_var_name, Span::call_site()),
1511 &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);
1512 if new_var { write!(w, " ").unwrap(); }
1513 if (!only_contained_has_inner || !to_c) && !contains_slice {
1514 var_prefix(w, conv_ty, generics, is_ref && ty_has_inner, ptr_for_ref, false);
1517 if !is_ref && !needs_ref_map && to_c && only_contained_has_inner {
1518 write!(w, "Box::into_raw(Box::new(").unwrap();
1520 write!(w, "{}{}", if contains_slice { "local_" } else { "" }, if new_var { new_var_name } else { var_access }).unwrap();
1521 if (!only_contained_has_inner || !to_c) && !contains_slice {
1522 var_suffix(w, conv_ty, generics, is_ref && ty_has_inner, ptr_for_ref, false);
1524 if !is_ref && !needs_ref_map && to_c && only_contained_has_inner {
1525 write!(w, "))").unwrap();
1527 write!(w, " }}").unwrap();
1529 write!(w, "{}", suffix).unwrap();
1530 if only_contained_has_inner && to_c {
1531 var_suffix(w, $args_iter().next().unwrap(), generics, is_ref, ptr_for_ref, true);
1533 write!(w, ";").unwrap();
1534 if !to_c && needs_ref_map {
1535 write!(w, " let mut local_{} = local_{}_base.as_ref()", ident, ident).unwrap();
1537 write!(w, ".map(|a| &a[..])").unwrap();
1539 write!(w, ";").unwrap();
1547 syn::Type::Reference(r) => {
1548 if let syn::Type::Slice(_) = &*r.elem {
1549 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)
1551 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)
1554 syn::Type::Path(p) => {
1555 if p.qself.is_some() {
1558 let resolved_path = self.resolve_path(&p.path, generics);
1559 if let Some(aliased_type) = self.crate_types.type_aliases.get(&resolved_path) {
1560 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);
1562 if self.is_known_container(&resolved_path, is_ref) || self.is_transparent_container(&resolved_path, is_ref) {
1563 if let syn::PathArguments::AngleBracketed(args) = &p.path.segments.iter().next().unwrap().arguments {
1564 convert_container!(resolved_path, args.args.len(), || args.args.iter().map(|arg| {
1565 if let syn::GenericArgument::Type(ty) = arg {
1567 } else { unimplemented!(); }
1569 } else { unimplemented!(); }
1571 if self.is_primitive(&resolved_path) {
1573 } else if let Some(ty_ident) = single_ident_generic_path_to_ident(&p.path) {
1574 if let Some((prefix, suffix)) = path_lookup(&resolved_path, is_ref) {
1575 write!(w, "let mut local_{} = {}{}{};", ident, prefix, var, suffix).unwrap();
1577 } else if self.declared.get(ty_ident).is_some() {
1582 syn::Type::Array(_) => {
1583 // We assume all arrays contain only primitive types.
1584 // This may result in some outputs not compiling.
1587 syn::Type::Slice(s) => {
1588 if let syn::Type::Path(p) = &*s.elem {
1589 let resolved = self.resolve_path(&p.path, generics);
1590 assert!(self.is_primitive(&resolved));
1591 let slice_path = format!("[{}]", resolved);
1592 if let Some((prefix, suffix)) = path_lookup(&slice_path, true) {
1593 write!(w, "let mut local_{} = {}{}{};", ident, prefix, var, suffix).unwrap();
1596 } else if let syn::Type::Reference(ty) = &*s.elem {
1597 let tyref = [&*ty.elem];
1599 convert_container!("Slice", 1, || tyref.iter());
1600 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
1601 } else if let syn::Type::Tuple(t) = &*s.elem {
1602 // When mapping into a temporary new var, we need to own all the underlying objects.
1603 // Thus, we drop any references inside the tuple and convert with non-reference types.
1604 let mut elems = syn::punctuated::Punctuated::new();
1605 for elem in t.elems.iter() {
1606 if let syn::Type::Reference(r) = elem {
1607 elems.push((*r.elem).clone());
1609 elems.push(elem.clone());
1612 let ty = [syn::Type::Tuple(syn::TypeTuple {
1613 paren_token: t.paren_token, elems
1617 convert_container!("Slice", 1, || ty.iter());
1618 unimplemented!("convert_container should return true as container_lookup should succeed for slices");
1619 } else { unimplemented!() }
1621 syn::Type::Tuple(t) => {
1622 if !t.elems.is_empty() {
1623 // We don't (yet) support tuple elements which cannot be converted inline
1624 write!(w, "let (").unwrap();
1625 for idx in 0..t.elems.len() {
1626 if idx != 0 { write!(w, ", ").unwrap(); }
1627 write!(w, "{} orig_{}_{}", if is_ref { "ref" } else { "mut" }, ident, idx).unwrap();
1629 write!(w, ") = {}{}; ", var, if !to_c { ".to_rust()" } else { "" }).unwrap();
1630 // Like other template types, tuples are always mapped as their non-ref
1631 // versions for types which have different ref mappings. Thus, we convert to
1632 // non-ref versions and handle opaque types with inner pointers manually.
1633 for (idx, elem) in t.elems.iter().enumerate() {
1634 if let syn::Type::Path(p) = elem {
1635 let v_name = format!("orig_{}_{}", ident, idx);
1636 let tuple_elem_ident = syn::Ident::new(&v_name, Span::call_site());
1637 if self.write_conversion_new_var_intern(w, &tuple_elem_ident, &v_name, elem, generics,
1638 false, ptr_for_ref, to_c,
1639 path_lookup, container_lookup, var_prefix, var_suffix) {
1640 write!(w, " ").unwrap();
1641 // Opaque types with inner pointers shouldn't ever create new stack
1642 // variables, so we don't handle it and just assert that it doesn't
1644 assert!(!self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics)));
1648 write!(w, "let mut local_{} = (", ident).unwrap();
1649 for (idx, elem) in t.elems.iter().enumerate() {
1650 let ty_has_inner = {
1652 // "To C ptr_for_ref" means "return the regular object with
1653 // is_owned set to false", which is totally what we want
1654 // if we're about to set ty_has_inner.
1657 if let syn::Type::Reference(t) = elem {
1658 if let syn::Type::Path(p) = &*t.elem {
1659 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
1661 } else if let syn::Type::Path(p) = elem {
1662 self.c_type_has_inner_from_path(&self.resolve_path(&p.path, generics))
1665 if idx != 0 { write!(w, ", ").unwrap(); }
1666 var_prefix(w, elem, generics, is_ref && ty_has_inner, ptr_for_ref, false);
1667 if is_ref && ty_has_inner {
1668 // For ty_has_inner, the regular var_prefix mapping will take a
1669 // reference, so deref once here to make sure we keep the original ref.
1670 write!(w, "*").unwrap();
1672 write!(w, "orig_{}_{}", ident, idx).unwrap();
1673 if is_ref && !ty_has_inner {
1674 // If we don't have an inner variable's reference to maintain, just
1675 // hope the type is Clonable and use that.
1676 write!(w, ".clone()").unwrap();
1678 var_suffix(w, elem, generics, is_ref && ty_has_inner, ptr_for_ref, false);
1680 write!(w, "){};", if to_c { ".into()" } else { "" }).unwrap();
1684 _ => unimplemented!(),
1688 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 {
1689 self.write_conversion_new_var_intern(w, ident, var_access, t, generics, false, ptr_for_ref, true,
1690 &|a, b| self.to_c_conversion_new_var_from_path(a, b),
1691 &|a, b, c, d, e| self.to_c_conversion_container_new_var(generics, a, b, c, d, e),
1692 // We force ptr_for_ref here since we can't generate a ref on one line and use it later
1693 &|a, b, c, d, e, f| self.write_to_c_conversion_inline_prefix_inner(a, b, c, d, e, f),
1694 &|a, b, c, d, e, f| self.write_to_c_conversion_inline_suffix_inner(a, b, c, d, e, f))
1696 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 {
1697 self.write_to_c_conversion_new_var_inner(w, ident, &format!("{}", ident), t, generics, ptr_for_ref)
1699 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 {
1700 self.write_conversion_new_var_intern(w, ident, &format!("{}", ident), t, generics, false, false, false,
1701 &|a, b| self.from_c_conversion_new_var_from_path(a, b),
1702 &|a, b, c, d, e| self.from_c_conversion_container_new_var(generics, a, b, c, d, e),
1703 // We force ptr_for_ref here since we can't generate a ref on one line and use it later
1704 &|a, b, c, d, e, _f| self.write_from_c_conversion_prefix_inner(a, b, c, d, e),
1705 &|a, b, c, d, e, _f| self.write_from_c_conversion_suffix_inner(a, b, c, d, e))
1708 // ******************************************************
1709 // *** C Container Type Equivalent and alias Printing ***
1710 // ******************************************************
1712 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) {
1713 if container_type == "Result" {
1714 assert_eq!(args.len(), 2);
1715 macro_rules! write_fn {
1716 ($call: expr) => { {
1717 writeln!(w, "#[no_mangle]\npub extern \"C\" fn {}_{}() -> {} {{", mangled_container, $call, mangled_container).unwrap();
1718 writeln!(w, "\t{}::CResultTempl::{}(0)\n}}\n", Self::container_templ_path(), $call).unwrap();
1721 macro_rules! write_alias {
1722 ($call: expr, $item: expr) => { {
1723 write!(w, "#[no_mangle]\npub static {}_{}: extern \"C\" fn (", mangled_container, $call).unwrap();
1724 if let syn::Type::Path(syn::TypePath { path, .. }) = $item {
1725 let resolved = self.resolve_path(path, generics);
1726 if self.is_known_container(&resolved, is_ref) || self.is_transparent_container(&resolved, is_ref) {
1727 self.write_c_mangled_container_path_intern(w, Self::path_to_generic_args(path), generics,
1728 &format!("{}", single_ident_generic_path_to_ident(path).unwrap()), is_ref, false, false, false);
1730 self.write_template_generics(w, &mut [$item].iter().map(|t| *t), is_ref, true);
1732 } else if let syn::Type::Tuple(syn::TypeTuple { elems, .. }) = $item {
1733 self.write_c_mangled_container_path_intern(w, elems.iter().collect(), generics,
1734 &format!("{}Tuple", elems.len()), is_ref, false, false, false);
1735 } else { unimplemented!(); }
1736 write!(w, ") -> {} =\n\t{}::CResultTempl::<", mangled_container, Self::container_templ_path()).unwrap();
1737 self.write_template_generics(w, &mut args.iter().map(|t| *t), is_ref, true);
1738 writeln!(w, ">::{};\n", $call).unwrap();
1742 syn::Type::Tuple(t) if t.elems.is_empty() => write_fn!("ok"),
1743 _ => write_alias!("ok", args[0]),
1746 syn::Type::Tuple(t) if t.elems.is_empty() => write_fn!("err"),
1747 _ => write_alias!("err", args[1]),
1749 } else if container_type.ends_with("Tuple") {
1750 write!(w, "#[no_mangle]\npub extern \"C\" fn {}_new(", mangled_container).unwrap();
1751 for (idx, gen) in args.iter().enumerate() {
1752 write!(w, "{}{}: ", if idx != 0 { ", " } else { "" }, ('a' as u8 + idx as u8) as char).unwrap();
1753 assert!(self.write_c_type_intern(w, gen, None, false, false, false));
1755 writeln!(w, ") -> {} {{", mangled_container).unwrap();
1756 write!(w, "\t{} {{ ", mangled_container).unwrap();
1757 for idx in 0..args.len() {
1758 write!(w, "{}, ", ('a' as u8 + idx as u8) as char).unwrap();
1760 writeln!(w, "}}\n}}\n").unwrap();
1762 writeln!(w, "").unwrap();
1766 fn write_template_generics<'b, W: std::io::Write>(&self, w: &mut W, args: &mut dyn Iterator<Item=&'b syn::Type>, is_ref: bool, in_crate: bool) {
1767 for (idx, t) in args.enumerate() {
1769 write!(w, ", ").unwrap();
1771 if let syn::Type::Tuple(tup) = t {
1772 if tup.elems.is_empty() {
1773 write!(w, "u8").unwrap();
1775 write!(w, "{}::C{}TupleTempl<", Self::container_templ_path(), tup.elems.len()).unwrap();
1776 self.write_template_generics(w, &mut tup.elems.iter(), is_ref, in_crate);
1777 write!(w, ">").unwrap();
1779 } else if let syn::Type::Path(p_arg) = t {
1780 let resolved_generic = self.resolve_path(&p_arg.path, None);
1781 if self.is_primitive(&resolved_generic) {
1782 write!(w, "{}", resolved_generic).unwrap();
1783 } else if let Some(c_type) = self.c_type_from_path(&resolved_generic, is_ref, false) {
1784 if self.is_known_container(&resolved_generic, is_ref) {
1785 write!(w, "{}::C{}Templ<", Self::container_templ_path(), single_ident_generic_path_to_ident(&p_arg.path).unwrap()).unwrap();
1786 assert_eq!(p_arg.path.segments.len(), 1);
1787 if let syn::PathArguments::AngleBracketed(args) = &p_arg.path.segments.iter().next().unwrap().arguments {
1788 self.write_template_generics(w, &mut args.args.iter().map(|gen|
1789 if let syn::GenericArgument::Type(t) = gen { t } else { unimplemented!() }),
1791 } else { unimplemented!(); }
1792 write!(w, ">").unwrap();
1793 } else if resolved_generic == "Option" {
1794 if let syn::PathArguments::AngleBracketed(args) = &p_arg.path.segments.iter().next().unwrap().arguments {
1795 self.write_template_generics(w, &mut args.args.iter().map(|gen|
1796 if let syn::GenericArgument::Type(t) = gen { t } else { unimplemented!() }),
1798 } else { unimplemented!(); }
1799 } else if in_crate {
1800 write!(w, "{}", c_type).unwrap();
1802 self.write_rust_type(w, None, &t);
1805 // If we just write out resolved_generic, it may mostly work, however for
1806 // original types which are generic, we need the template args. We could
1807 // figure them out and write them out, too, but its much easier to just
1808 // reference the native{} type alias which exists at least for opaque types.
1810 write!(w, "crate::{}", resolved_generic).unwrap();
1812 let path_name: Vec<&str> = resolved_generic.rsplitn(2, "::").collect();
1813 if path_name.len() > 1 {
1814 write!(w, "crate::{}::native{}", path_name[1], path_name[0]).unwrap();
1816 write!(w, "crate::native{}", path_name[0]).unwrap();
1820 } else if let syn::Type::Reference(r_arg) = t {
1821 if let syn::Type::Path(p_arg) = &*r_arg.elem {
1822 let resolved = self.resolve_path(&p_arg.path, None);
1823 if self.crate_types.opaques.get(&resolved).is_some() {
1824 write!(w, "crate::{}", resolved).unwrap();
1826 let cty = self.c_type_from_path(&resolved, true, true).expect("Template generics should be opaque or have a predefined mapping");
1827 w.write(cty.as_bytes()).unwrap();
1829 } else { unimplemented!(); }
1830 } else if let syn::Type::Array(a_arg) = t {
1831 if let syn::Type::Path(p_arg) = &*a_arg.elem {
1832 let resolved = self.resolve_path(&p_arg.path, None);
1833 assert!(self.is_primitive(&resolved));
1834 if let syn::Expr::Lit(syn::ExprLit { lit: syn::Lit::Int(len), .. }) = &a_arg.len {
1836 self.c_type_from_path(&format!("[{}; {}]", resolved, len.base10_digits()), is_ref, false).unwrap()).unwrap();
1842 fn check_create_container(&mut self, mangled_container: String, container_type: &str, args: Vec<&syn::Type>, generics: Option<&GenericTypes>, is_ref: bool) {
1843 if !self.crate_types.templates_defined.get(&mangled_container).is_some() {
1844 self.crate_types.templates_defined.insert(mangled_container.clone(), true);
1845 let mut created_container: Vec<u8> = Vec::new();
1847 write!(&mut created_container, "#[no_mangle]\npub type {} = ", mangled_container).unwrap();
1848 write!(&mut created_container, "{}::C{}Templ<", Self::container_templ_path(), container_type).unwrap();
1849 self.write_template_generics(&mut created_container, &mut args.iter().map(|t| *t), is_ref, true);
1850 writeln!(&mut created_container, ">;").unwrap();
1852 write!(&mut created_container, "#[no_mangle]\npub static {}_free: extern \"C\" fn({}) = ", mangled_container, mangled_container).unwrap();
1853 write!(&mut created_container, "{}::C{}Templ_free::<", Self::container_templ_path(), container_type).unwrap();
1854 self.write_template_generics(&mut created_container, &mut args.iter().map(|t| *t), is_ref, true);
1855 writeln!(&mut created_container, ">;").unwrap();
1857 self.write_template_constructor(&mut created_container, container_type, &mangled_container, &args, generics, is_ref);
1859 self.crate_types.template_file.write(&created_container).unwrap();
1862 fn path_to_generic_args(path: &syn::Path) -> Vec<&syn::Type> {
1863 if let syn::PathArguments::AngleBracketed(args) = &path.segments.iter().next().unwrap().arguments {
1864 args.args.iter().map(|gen| if let syn::GenericArgument::Type(t) = gen { t } else { unimplemented!() }).collect()
1865 } else { unimplemented!(); }
1867 fn write_c_mangled_container_path_intern<W: std::io::Write>
1868 (&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 {
1869 let mut mangled_type: Vec<u8> = Vec::new();
1870 if !self.is_transparent_container(ident, is_ref) {
1871 write!(w, "C{}_", ident).unwrap();
1872 write!(mangled_type, "C{}_", ident).unwrap();
1873 } else { assert_eq!(args.len(), 1); }
1874 for arg in args.iter() {
1875 macro_rules! write_path {
1876 ($p_arg: expr, $extra_write: expr) => {
1877 let subtype = self.resolve_path(&$p_arg.path, generics);
1878 if self.is_transparent_container(ident, is_ref) {
1879 // We dont (yet) support primitives or containers inside transparent
1880 // containers, so check for that first:
1881 if self.is_primitive(&subtype) { return false; }
1882 if self.is_known_container(&subtype, is_ref) { return false; }
1884 if self.c_type_has_inner_from_path(&subtype) {
1885 if !self.write_c_path_intern(w, &$p_arg.path, generics, is_ref, is_mut, ptr_for_ref) { return false; }
1887 // Option<T> needs to be converted to a *mut T, ie mut ptr-for-ref
1888 if !self.write_c_path_intern(w, &$p_arg.path, generics, true, true, true) { return false; }
1891 if $p_arg.path.segments.len() == 1 {
1892 write!(w, "{}", $p_arg.path.segments.iter().next().unwrap().ident).unwrap();
1897 } else if self.is_known_container(&subtype, is_ref) || self.is_transparent_container(&subtype, is_ref) {
1898 if !self.write_c_mangled_container_path_intern(w, Self::path_to_generic_args(&$p_arg.path), generics,
1899 &subtype, is_ref, is_mut, ptr_for_ref, true) {
1902 self.write_c_mangled_container_path_intern(&mut mangled_type, Self::path_to_generic_args(&$p_arg.path),
1903 generics, &subtype, is_ref, is_mut, ptr_for_ref, true);
1904 if let Some(w2) = $extra_write as Option<&mut Vec<u8>> {
1905 self.write_c_mangled_container_path_intern(w2, Self::path_to_generic_args(&$p_arg.path),
1906 generics, &subtype, is_ref, is_mut, ptr_for_ref, true);
1909 let id = &&$p_arg.path.segments.iter().rev().next().unwrap().ident;
1910 write!(w, "{}", id).unwrap();
1911 write!(mangled_type, "{}", id).unwrap();
1912 if let Some(w2) = $extra_write as Option<&mut Vec<u8>> {
1913 write!(w2, "{}", id).unwrap();
1918 if let syn::Type::Tuple(tuple) = arg {
1919 if tuple.elems.len() == 0 {
1920 write!(w, "None").unwrap();
1921 write!(mangled_type, "None").unwrap();
1923 let mut mangled_tuple_type: Vec<u8> = Vec::new();
1925 // Figure out what the mangled type should look like. To disambiguate
1926 // ((A, B), C) and (A, B, C) we prefix the generic args with a _ and suffix
1927 // them with a Z. Ideally we wouldn't use Z, but not many special chars are
1928 // available for use in type names.
1929 write!(w, "C{}Tuple_", tuple.elems.len()).unwrap();
1930 write!(mangled_type, "C{}Tuple_", tuple.elems.len()).unwrap();
1931 write!(mangled_tuple_type, "C{}Tuple_", tuple.elems.len()).unwrap();
1932 for elem in tuple.elems.iter() {
1933 if let syn::Type::Path(p) = elem {
1934 write_path!(p, Some(&mut mangled_tuple_type));
1935 } else if let syn::Type::Reference(refelem) = elem {
1936 if let syn::Type::Path(p) = &*refelem.elem {
1937 write_path!(p, Some(&mut mangled_tuple_type));
1938 } else { return false; }
1939 } else { return false; }
1941 write!(w, "Z").unwrap();
1942 write!(mangled_type, "Z").unwrap();
1943 write!(mangled_tuple_type, "Z").unwrap();
1944 self.check_create_container(String::from_utf8(mangled_tuple_type).unwrap(),
1945 &format!("{}Tuple", tuple.elems.len()), tuple.elems.iter().collect(), generics, is_ref);
1947 } else if let syn::Type::Path(p_arg) = arg {
1948 write_path!(p_arg, None);
1949 } else if let syn::Type::Reference(refty) = arg {
1950 if args.len() != 1 { return false; }
1951 if let syn::Type::Path(p_arg) = &*refty.elem {
1952 write_path!(p_arg, None);
1953 } else if let syn::Type::Slice(_) = &*refty.elem {
1954 // write_c_type will actually do exactly what we want here, we just need to
1955 // make it a pointer so that its an option. Note that we cannot always convert
1956 // the Vec-as-slice (ie non-ref types) containers, so sometimes need to be able
1957 // to edit it, hence we use *mut here instead of *const.
1958 write!(w, "*mut ").unwrap();
1959 self.write_c_type(w, arg, None, true);
1960 } else { return false; }
1961 } else if let syn::Type::Array(a) = arg {
1962 if let syn::Type::Path(p_arg) = &*a.elem {
1963 let resolved = self.resolve_path(&p_arg.path, generics);
1964 if !self.is_primitive(&resolved) { return false; }
1965 if let syn::Expr::Lit(syn::ExprLit { lit: syn::Lit::Int(len), .. }) = &a.len {
1966 if self.c_type_from_path(&format!("[{}; {}]", resolved, len.base10_digits()), is_ref, ptr_for_ref).is_none() { return false; }
1967 write!(w, "_{}{}", resolved, len.base10_digits()).unwrap();
1968 write!(mangled_type, "_{}{}", resolved, len.base10_digits()).unwrap();
1969 } else { return false; }
1970 } else { return false; }
1971 } else { return false; }
1973 if self.is_transparent_container(ident, is_ref) { return true; }
1974 // Push the "end of type" Z
1975 write!(w, "Z").unwrap();
1976 write!(mangled_type, "Z").unwrap();
1978 // Make sure the type is actually defined:
1979 self.check_create_container(String::from_utf8(mangled_type).unwrap(), ident, args, generics, is_ref);
1982 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 {
1983 if !self.is_transparent_container(ident, is_ref) {
1984 write!(w, "{}::", Self::generated_container_path()).unwrap();
1986 self.write_c_mangled_container_path_intern(w, args, generics, ident, is_ref, is_mut, ptr_for_ref, false)
1989 // **********************************
1990 // *** C Type Equivalent Printing ***
1991 // **********************************
1993 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 {
1994 let full_path = match self.maybe_resolve_path(&path, generics) {
1995 Some(path) => path, None => return false };
1996 if let Some(c_type) = self.c_type_from_path(&full_path, is_ref, ptr_for_ref) {
1997 write!(w, "{}", c_type).unwrap();
1999 } else if self.crate_types.traits.get(&full_path).is_some() {
2000 if is_ref && ptr_for_ref {
2001 write!(w, "*{} crate::{}", if is_mut { "mut" } else { "const" }, full_path).unwrap();
2003 write!(w, "&{}crate::{}", if is_mut { "mut " } else { "" }, full_path).unwrap();
2005 write!(w, "crate::{}", full_path).unwrap();
2008 } else if self.crate_types.opaques.get(&full_path).is_some() || self.crate_types.mirrored_enums.get(&full_path).is_some() {
2009 if is_ref && ptr_for_ref {
2010 // ptr_for_ref implies we're returning the object, which we can't really do for
2011 // opaque or mirrored types without box'ing them, which is quite a waste, so return
2012 // the actual object itself (for opaque types we'll set the pointer to the actual
2013 // type and note that its a reference).
2014 write!(w, "crate::{}", full_path).unwrap();
2016 write!(w, "&{}crate::{}", if is_mut { "mut " } else { "" }, full_path).unwrap();
2018 write!(w, "crate::{}", full_path).unwrap();
2025 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 {
2027 syn::Type::Path(p) => {
2028 if p.qself.is_some() {
2031 if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
2032 if self.is_known_container(&full_path, is_ref) || self.is_transparent_container(&full_path, is_ref) {
2033 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);
2035 if let Some(aliased_type) = self.crate_types.type_aliases.get(&full_path).cloned() {
2036 return self.write_c_type_intern(w, &aliased_type, None, is_ref, is_mut, ptr_for_ref);
2039 self.write_c_path_intern(w, &p.path, generics, is_ref, is_mut, ptr_for_ref)
2041 syn::Type::Reference(r) => {
2042 self.write_c_type_intern(w, &*r.elem, generics, true, r.mutability.is_some(), ptr_for_ref)
2044 syn::Type::Array(a) => {
2045 if is_ref && is_mut {
2046 write!(w, "*mut [").unwrap();
2047 if !self.write_c_type_intern(w, &a.elem, generics, false, false, ptr_for_ref) { return false; }
2049 write!(w, "*const [").unwrap();
2050 if !self.write_c_type_intern(w, &a.elem, generics, false, false, ptr_for_ref) { return false; }
2052 let mut typecheck = Vec::new();
2053 if !self.write_c_type_intern(&mut typecheck, &a.elem, generics, false, false, ptr_for_ref) { return false; }
2054 if typecheck[..] != ['u' as u8, '8' as u8] { return false; }
2056 if let syn::Expr::Lit(l) = &a.len {
2057 if let syn::Lit::Int(i) = &l.lit {
2059 if let Some(ty) = self.c_type_from_path(&format!("[u8; {}]", i.base10_digits()), false, ptr_for_ref) {
2060 write!(w, "{}", ty).unwrap();
2064 write!(w, "; {}]", i).unwrap();
2070 syn::Type::Slice(s) => {
2071 if !is_ref || is_mut { return false; }
2072 if let syn::Type::Path(p) = &*s.elem {
2073 let resolved = self.resolve_path(&p.path, generics);
2074 if self.is_primitive(&resolved) {
2075 write!(w, "{}::{}slice", Self::container_templ_path(), resolved).unwrap();
2078 } else if let syn::Type::Reference(r) = &*s.elem {
2079 if let syn::Type::Path(p) = &*r.elem {
2080 // Slices with "real types" inside are mapped as the equivalent non-ref Vec
2081 let resolved = self.resolve_path(&p.path, generics);
2082 let mangled_container = if let Some(ident) = self.crate_types.opaques.get(&resolved) {
2083 format!("CVec_{}Z", ident)
2084 } else if let Some(en) = self.crate_types.mirrored_enums.get(&resolved) {
2085 format!("CVec_{}Z", en.ident)
2086 } else if let Some(id) = p.path.get_ident() {
2087 format!("CVec_{}Z", id)
2088 } else { return false; };
2089 write!(w, "{}::{}", Self::generated_container_path(), mangled_container).unwrap();
2090 self.check_create_container(mangled_container, "Vec", vec![&*r.elem], generics, false);
2093 } else if let syn::Type::Tuple(_) = &*s.elem {
2094 let mut args = syn::punctuated::Punctuated::new();
2095 args.push(syn::GenericArgument::Type((*s.elem).clone()));
2096 let mut segments = syn::punctuated::Punctuated::new();
2097 segments.push(syn::PathSegment {
2098 ident: syn::Ident::new("Vec", Span::call_site()),
2099 arguments: syn::PathArguments::AngleBracketed(syn::AngleBracketedGenericArguments {
2100 colon2_token: None, lt_token: syn::Token![<](Span::call_site()), args, gt_token: syn::Token![>](Span::call_site()),
2103 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)
2106 syn::Type::Tuple(t) => {
2107 if t.elems.len() == 0 {
2110 self.write_c_mangled_container_path(w, t.elems.iter().collect(), generics,
2111 &format!("{}Tuple", t.elems.len()), is_ref, is_mut, ptr_for_ref)
2117 pub fn write_c_type<W: std::io::Write>(&mut self, w: &mut W, t: &syn::Type, generics: Option<&GenericTypes>, ptr_for_ref: bool) {
2118 assert!(self.write_c_type_intern(w, t, generics, false, false, ptr_for_ref));
2120 pub fn understood_c_path(&mut self, p: &syn::Path) -> bool {
2121 if p.leading_colon.is_some() { return false; }
2122 self.write_c_path_intern(&mut std::io::sink(), p, None, false, false, false)
2124 pub fn understood_c_type(&mut self, t: &syn::Type, generics: Option<&GenericTypes>) -> bool {
2125 self.write_c_type_intern(&mut std::io::sink(), t, generics, false, false, false)