use std::collections::HashMap;
use std::fs::File;
use std::io::Write;
+use std::hash;
use proc_macro2::{TokenTree, Span};
EnumIgnored,
}
+// templates_defined is walked to write the C++ header, so if we use the default hashing it get
+// reordered on each genbindings run. Instead, we use SipHasher (which defaults to 0-keys) so that
+// the sorting is stable across runs. It is deprecated, but the "replacement" doesn't actually
+// accomplish the same goals, so we just ignore it.
+#[allow(deprecated)]
+type NonRandomHash = hash::BuildHasherDefault<hash::SipHasher>;
+
/// Top-level struct tracking everything which has been defined while walking the crate.
pub struct CrateTypes<'a> {
/// This may contain structs or enums, but only when either is mapped as
pub mirrored_enums: HashMap<String, &'a syn::ItemEnum>,
/// Traits which are mapped as a pointer + jump table
pub traits: HashMap<String, &'a syn::ItemTrait>,
+ /// Aliases from paths to some other Type
+ pub type_aliases: HashMap<String, syn::Type>,
/// Template continer types defined, map from mangled type name -> whether a destructor fn
/// exists.
///
/// This is used at the end of processing to make C++ wrapper classes
- pub templates_defined: HashMap<String, bool>,
+ pub templates_defined: HashMap<String, bool, NonRandomHash>,
/// The output file for any created template container types, written to as we find new
/// template containers which need to be defined.
pub template_file: &'a mut File,
pub crate_types: &'mod_lifetime mut CrateTypes<'crate_lft>,
}
+/// Returned by write_empty_rust_val_check_suffix to indicate what type of dereferencing needs to
+/// happen to get the inner value of a generic.
+enum EmptyValExpectedTy {
+ /// A type which has a flag for being empty (eg an array where we treat all-0s as empty).
+ NonPointer,
+ /// A pointer that we want to dereference and move out of.
+ OwnedPointer,
+ /// A pointer which we want to convert to a reference.
+ ReferenceAsPointer,
+}
+
impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
pub fn new(orig_crate: &'a str, module_path: &'a str, crate_types: &'a mut CrateTypes<'c>) -> Self {
let mut imports = HashMap::new();
if let Some(t) = single_contained {
let mut v = Vec::new();
- let (needs_deref, ret_ref) = self.write_empty_rust_val_check_suffix(generics, &mut v, t);
+ let ret_ref = self.write_empty_rust_val_check_suffix(generics, &mut v, t);
let s = String::from_utf8(v).unwrap();
- if needs_deref && ret_ref {
- return Some(("if ", vec![
- (format!("{} {{ None }} else {{ Some(", s), format!("unsafe {{ &mut *{} }}", var_access))
- ], ") }"));
- } else if needs_deref {
- return Some(("if ", vec![
- (format!("{} {{ None }} else {{ Some(", s), format!("unsafe {{ *Box::from_raw({}) }}", var_access))
- ], ") }"));
- } else {
- return Some(("if ", vec![
- (format!("{} {{ None }} else {{ Some(", s), format!("{}", var_access))
- ], ") }"));
+ match ret_ref {
+ EmptyValExpectedTy::ReferenceAsPointer =>
+ return Some(("if ", vec![
+ (format!("{} {{ None }} else {{ Some(", s), format!("unsafe {{ &mut *{} }}", var_access))
+ ], ") }")),
+ EmptyValExpectedTy::OwnedPointer =>
+ return Some(("if ", vec![
+ (format!("{} {{ None }} else {{ Some(", s), format!("unsafe {{ *Box::from_raw({}) }}", var_access))
+ ], ") }")),
+ EmptyValExpectedTy::NonPointer =>
+ return Some(("if ", vec![
+ (format!("{} {{ None }} else {{ Some(", s), format!("{}", var_access))
+ ], ") }")),
}
} else { unreachable!(); }
},
} else { p_arg };
if p.leading_colon.is_some() {
- // At some point we may need this, but for now, its unused, so just fail.
- return None;
+ Some(p.segments.iter().enumerate().map(|(idx, seg)| {
+ format!("{}{}", if idx == 0 { "" } else { "::" }, seg.ident)
+ }).collect())
} else if let Some(id) = p.get_ident() {
self.maybe_resolve_ident(id)
} else {
let mut seg_iter = p.segments.iter();
let first_seg = seg_iter.next().unwrap();
let remaining: String = seg_iter.map(|seg| {
- if let syn::PathArguments::None = seg.arguments {
- format!("{}", seg.ident)
- } else {
- format!("{}", seg.ident)
- }
+ format!("::{}", seg.ident)
}).collect();
if let Some(imp) = self.imports.get(&first_seg.ident) {
if remaining != "" {
- Some(imp.clone() + "::" + &remaining)
+ Some(imp.clone() + &remaining)
} else {
Some(imp.clone())
}
// *** Original Rust Type Printing ***
// ***********************************
- fn write_rust_path<W: std::io::Write>(&self, w: &mut W, path: &syn::Path) {
- if let Some(resolved) = self.maybe_resolve_path(&path, None) {
+ fn in_rust_prelude(resolved_path: &str) -> bool {
+ match resolved_path {
+ "Vec" => true,
+ "Result" => true,
+ "Option" => true,
+ _ => false,
+ }
+ }
+
+ fn write_rust_path<W: std::io::Write>(&self, w: &mut W, generics_resolver: Option<&GenericTypes>, path: &syn::Path) {
+ if let Some(resolved) = self.maybe_resolve_path(&path, generics_resolver) {
if self.is_primitive(&resolved) {
write!(w, "{}", path.get_ident().unwrap()).unwrap();
} else {
- if resolved.starts_with("ln::") || resolved.starts_with("chain::") || resolved.starts_with("util::") {
- write!(w, "lightning::{}", resolved).unwrap();
+ // TODO: We should have a generic "is from a dependency" check here instead of
+ // checking for "bitcoin" explicitly.
+ if resolved.starts_with("bitcoin::") || Self::in_rust_prelude(&resolved) {
+ write!(w, "{}", resolved).unwrap();
+ // If we're printing a generic argument, it needs to reference the crate, otherwise
+ // the original crate:
+ } else if self.maybe_resolve_path(&path, None).as_ref() == Some(&resolved) {
+ write!(w, "{}::{}", self.orig_crate, resolved).unwrap();
} else {
- write!(w, "{}", resolved).unwrap(); // XXX: Probably doens't work, get_ident().unwrap()
+ write!(w, "crate::{}", resolved).unwrap();
}
}
if let syn::PathArguments::AngleBracketed(args) = &path.segments.iter().last().unwrap().arguments {
- self.write_rust_generic_arg(w, args.args.iter());
+ self.write_rust_generic_arg(w, generics_resolver, args.args.iter());
}
} else {
if path.leading_colon.is_some() {
if idx != 0 { write!(w, "::").unwrap(); }
write!(w, "{}", seg.ident).unwrap();
if let syn::PathArguments::AngleBracketed(args) = &seg.arguments {
- self.write_rust_generic_arg(w, args.args.iter());
+ self.write_rust_generic_arg(w, generics_resolver, args.args.iter());
}
}
}
}
- pub fn write_rust_generic_param<'b, W: std::io::Write>(&self, w: &mut W, generics: impl Iterator<Item=&'b syn::GenericParam>) {
+ 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>) {
let mut had_params = false;
for (idx, arg) in generics.enumerate() {
if idx != 0 { write!(w, ", ").unwrap(); } else { write!(w, "<").unwrap(); }
match bound {
syn::TypeParamBound::Trait(tb) => {
if tb.paren_token.is_some() || tb.lifetimes.is_some() { unimplemented!(); }
- self.write_rust_path(w, &tb.path);
+ self.write_rust_path(w, generics_resolver, &tb.path);
},
_ => unimplemented!(),
}
if had_params { write!(w, ">").unwrap(); }
}
- pub fn write_rust_generic_arg<'b, W: std::io::Write>(&self, w: &mut W, generics: impl Iterator<Item=&'b syn::GenericArgument>) {
+ 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>) {
write!(w, "<").unwrap();
for (idx, arg) in generics.enumerate() {
if idx != 0 { write!(w, ", ").unwrap(); }
match arg {
- syn::GenericArgument::Type(t) => self.write_rust_type(w, t),
+ syn::GenericArgument::Type(t) => self.write_rust_type(w, generics_resolver, t),
_ => unimplemented!(),
}
}
write!(w, ">").unwrap();
}
- pub fn write_rust_type<W: std::io::Write>(&self, w: &mut W, t: &syn::Type) {
+ pub fn write_rust_type<W: std::io::Write>(&self, w: &mut W, generics: Option<&GenericTypes>, t: &syn::Type) {
match t {
syn::Type::Path(p) => {
if p.qself.is_some() || p.path.leading_colon.is_some() {
unimplemented!();
}
- self.write_rust_path(w, &p.path);
+ self.write_rust_path(w, generics, &p.path);
},
syn::Type::Reference(r) => {
write!(w, "&").unwrap();
if r.mutability.is_some() {
write!(w, "mut ").unwrap();
}
- self.write_rust_type(w, &*r.elem);
+ self.write_rust_type(w, generics, &*r.elem);
},
syn::Type::Array(a) => {
write!(w, "[").unwrap();
- self.write_rust_type(w, &a.elem);
+ self.write_rust_type(w, generics, &a.elem);
if let syn::Expr::Lit(l) = &a.len {
if let syn::Lit::Int(i) = &l.lit {
write!(w, "; {}]", i).unwrap();
}
syn::Type::Slice(s) => {
write!(w, "[").unwrap();
- self.write_rust_type(w, &s.elem);
+ self.write_rust_type(w, generics, &s.elem);
write!(w, "]").unwrap();
},
syn::Type::Tuple(s) => {
write!(w, "(").unwrap();
for (idx, t) in s.elems.iter().enumerate() {
if idx != 0 { write!(w, ", ").unwrap(); }
- self.write_rust_type(w, &t);
+ self.write_rust_type(w, generics, &t);
}
write!(w, ")").unwrap();
},
}
}
- /// Prints a suffix to determine if a variable is empty (ie was set by write_empty_rust_val),
- /// returning whether we need to dereference the inner value before using it (ie it is a
- /// pointer).
- pub fn write_empty_rust_val_check_suffix<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type) -> (bool, bool) {
+ /// Prints a suffix to determine if a variable is empty (ie was set by write_empty_rust_val).
+ /// See EmptyValExpectedTy for information on return types.
+ fn write_empty_rust_val_check_suffix<W: std::io::Write>(&self, generics: Option<&GenericTypes>, w: &mut W, t: &syn::Type) -> EmptyValExpectedTy {
match t {
syn::Type::Path(p) => {
let resolved = self.resolve_path(&p.path, generics);
if self.crate_types.opaques.get(&resolved).is_some() {
write!(w, ".inner.is_null()").unwrap();
- (false, false)
+ EmptyValExpectedTy::NonPointer
} else {
if let Some(suffix) = self.empty_val_check_suffix_from_path(&resolved) {
write!(w, "{}", suffix).unwrap();
- (false, false) // We may eventually need to allow empty_val_check_suffix_from_path to specify if we need a deref or not
+ // We may eventually need to allow empty_val_check_suffix_from_path to specify if we need a deref or not
+ EmptyValExpectedTy::NonPointer
} else {
write!(w, " == std::ptr::null_mut()").unwrap();
- (true, false)
+ EmptyValExpectedTy::OwnedPointer
}
}
},
if let syn::Expr::Lit(l) = &a.len {
if let syn::Lit::Int(i) = &l.lit {
write!(w, " == [0; {}]", i.base10_digits()).unwrap();
- (false, false)
+ EmptyValExpectedTy::NonPointer
} else { unimplemented!(); }
} else { unimplemented!(); }
},
// Option<[]> always implies that we want to treat len() == 0 differently from
// None, so we always map an Option<[]> into a pointer.
write!(w, " == std::ptr::null_mut()").unwrap();
- (true, true)
+ EmptyValExpectedTy::ReferenceAsPointer
},
_ => unimplemented!(),
}
ptr_for_ref, tupleconv, prefix, sliceconv, path_lookup, decl_lookup);
},
syn::Type::Path(p) => {
- if p.qself.is_some() || p.path.leading_colon.is_some() {
+ if p.qself.is_some() {
unimplemented!();
}
let resolved_path = self.resolve_path(&p.path, generics);
- if let Some(c_type) = path_lookup(&resolved_path, is_ref, ptr_for_ref) {
+ if let Some(aliased_type) = self.crate_types.type_aliases.get(&resolved_path) {
+ return self.write_conversion_inline_intern(w, aliased_type, None, is_ref, is_mut, ptr_for_ref, tupleconv, prefix, sliceconv, path_lookup, decl_lookup);
+ } else if let Some(c_type) = path_lookup(&resolved_path, is_ref, ptr_for_ref) {
write!(w, "{}", c_type).unwrap();
} else if self.crate_types.opaques.get(&resolved_path).is_some() {
decl_lookup(w, &DeclType::StructImported, &resolved_path, is_ref, is_mut);
}
},
syn::Type::Path(p) => {
- if p.qself.is_some() || p.path.leading_colon.is_some() {
+ if p.qself.is_some() {
unimplemented!();
}
let resolved_path = self.resolve_path(&p.path, generics);
+ if let Some(aliased_type) = self.crate_types.type_aliases.get(&resolved_path) {
+ 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);
+ }
if self.is_known_container(&resolved_path, is_ref) || self.is_transparent_container(&resolved_path, is_ref) {
if let syn::PathArguments::AngleBracketed(args) = &p.path.segments.iter().next().unwrap().arguments {
convert_container!(resolved_path, args.args.len(), || args.args.iter().map(|arg| {
write!(w, "#[no_mangle]\npub extern \"C\" fn {}_new(", mangled_container).unwrap();
for (idx, gen) in args.iter().enumerate() {
write!(w, "{}{}: ", if idx != 0 { ", " } else { "" }, ('a' as u8 + idx as u8) as char).unwrap();
- self.write_c_type_intern(w, gen, None, false, false, false);
+ assert!(self.write_c_type_intern(w, gen, None, false, false, false));
}
writeln!(w, ") -> {} {{", mangled_container).unwrap();
- writeln!(w, "\t{} {{", mangled_container).unwrap();
+ write!(w, "\t{} {{ ", mangled_container).unwrap();
for idx in 0..args.len() {
- writeln!(w, "\t\t{}: Box::into_raw(Box::new({})),", ('a' as u8 + idx as u8) as char, ('a' as u8 + idx as u8) as char).unwrap();
+ write!(w, "{}, ", ('a' as u8 + idx as u8) as char).unwrap();
}
- writeln!(w, "\t}}\n}}\n").unwrap();
+ writeln!(w, "}}\n}}\n").unwrap();
} else {
writeln!(w, "").unwrap();
}
} else if in_crate {
write!(w, "{}", c_type).unwrap();
} else {
- self.write_rust_type(w, &t);
+ self.write_rust_type(w, None, &t);
}
} else {
// If we just write out resolved_generic, it may mostly work, however for
} else if let syn::Type::Reference(r_arg) = t {
if let syn::Type::Path(p_arg) = &*r_arg.elem {
let resolved = self.resolve_path(&p_arg.path, None);
- if single_ident_generic_path_to_ident(&p_arg.path).is_some() {
- if self.crate_types.opaques.get(&resolved).is_some() {
- write!(w, "crate::{}", resolved).unwrap();
- } else {
- let cty = self.c_type_from_path(&resolved, true, true).expect("Template generics should be opaque or have a predefined mapping");
- w.write(cty.as_bytes()).unwrap();
- }
- } else { unimplemented!(); }
+ if self.crate_types.opaques.get(&resolved).is_some() {
+ write!(w, "crate::{}", resolved).unwrap();
+ } else {
+ let cty = self.c_type_from_path(&resolved, true, true).expect("Template generics should be opaque or have a predefined mapping");
+ w.write(cty.as_bytes()).unwrap();
+ }
} else { unimplemented!(); }
} else if let syn::Type::Array(a_arg) = t {
if let syn::Type::Path(p_arg) = &*a_arg.elem {
self.write_c_mangled_container_path_intern(w2, Self::path_to_generic_args(&$p_arg.path),
generics, &subtype, is_ref, is_mut, ptr_for_ref, true);
}
- } else if let Some(id) = single_ident_generic_path_to_ident(&$p_arg.path) {
+ } else {
+ let id = &&$p_arg.path.segments.iter().rev().next().unwrap().ident;
write!(w, "{}", id).unwrap();
write!(mangled_type, "{}", id).unwrap();
if let Some(w2) = $extra_write as Option<&mut Vec<u8>> {
write!(w2, "{}", id).unwrap();
}
- } else { return false; }
+ }
}
}
if let syn::Type::Tuple(tuple) = arg {
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 {
match t {
syn::Type::Path(p) => {
- if p.qself.is_some() || p.path.leading_colon.is_some() {
+ if p.qself.is_some() {
return false;
}
if let Some(full_path) = self.maybe_resolve_path(&p.path, generics) {
if self.is_known_container(&full_path, is_ref) || self.is_transparent_container(&full_path, is_ref) {
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);
}
+ if let Some(aliased_type) = self.crate_types.type_aliases.get(&full_path).cloned() {
+ return self.write_c_type_intern(w, &aliased_type, None, is_ref, is_mut, ptr_for_ref);
+ }
}
- if p.path.leading_colon.is_some() { return false; }
self.write_c_path_intern(w, &p.path, generics, is_ref, is_mut, ptr_for_ref)
},
syn::Type::Reference(r) => {
- if let Some(lft) = &r.lifetime {
- if format!("{}", lft.ident) != "static" { return false; }
- }
self.write_c_type_intern(w, &*r.elem, generics, true, r.mutability.is_some(), ptr_for_ref)
},
syn::Type::Array(a) => {
projects / rust-lightning / blobdiff