From: Matt Corallo Date: Wed, 3 Feb 2021 22:46:29 +0000 (-0500) Subject: [bindings] Keep track of all types which derive[Clone] X-Git-Tag: v0.0.13~32^2~8 X-Git-Url: http://git.bitcoin.ninja/?a=commitdiff_plain;h=f5e0e228fd73f0b44381af28c13ffc2df67608c0;p=rust-lightning [bindings] Keep track of all types which derive[Clone] --- diff --git a/c-bindings-gen/src/main.rs b/c-bindings-gen/src/main.rs index 9a329eeab..d927d2ae7 100644 --- a/c-bindings-gen/src/main.rs +++ b/c-bindings-gen/src/main.rs @@ -10,7 +10,7 @@ //! It also generates relevant memory-management functions and free-standing functions with //! parameters mapped. -use std::collections::HashMap; +use std::collections::{HashMap, HashSet}; use std::env; use std::fs::File; use std::io::{Read, Write}; @@ -233,15 +233,20 @@ macro_rules! walk_supertraits { ($t: expr, $types: expr, ($( $pat: pat => $e: ex } // First try to resolve path to find in-crate traits, but if that doesn't work // assume its a prelude trait (eg Clone, etc) and just use the single ident. - if let Some(path) = $types.maybe_resolve_path(&supertrait.path, None) { - match (&path as &str, &supertrait.path.segments.iter().last().unwrap().ident) { - $( $pat => $e, )* + let types_opt: Option<&TypeResolver> = $types; + if let Some(types) = types_opt { + if let Some(path) = types.maybe_resolve_path(&supertrait.path, None) { + match (&path as &str, &supertrait.path.segments.iter().last().unwrap().ident) { + $( $pat => $e, )* + } + continue; } - } else if let Some(ident) = supertrait.path.get_ident() { + } + if let Some(ident) = supertrait.path.get_ident() { match (&format!("{}", ident) as &str, &ident) { $( $pat => $e, )* } - } else { + } else if types_opt.is_some() { panic!("Supertrait unresolvable and not single-ident"); } }, @@ -337,7 +342,7 @@ fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, ty } } // Add functions which may be required for supertrait implementations. - walk_supertraits!(t, types, ( + walk_supertraits!(t, Some(&types), ( ("Clone", _) => { writeln!(w, "\tpub clone: Option *mut c_void>,").unwrap(); generated_fields.push("clone".to_owned()); @@ -368,7 +373,7 @@ fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, ty generated_fields.push("free".to_owned()); writeln!(w, "}}").unwrap(); // Implement supertraits for the C-mapped struct. - walk_supertraits!(t, types, ( + walk_supertraits!(t, Some(&types), ( ("Send", _) => writeln!(w, "unsafe impl Send for {} {{}}", trait_name).unwrap(), ("Sync", _) => writeln!(w, "unsafe impl Sync for {} {{}}", trait_name).unwrap(), ("std::cmp::Eq", _) => { @@ -550,40 +555,22 @@ fn writeln_opaque(w: &mut W, ident: &syn::Ident, struct_name: writeln!(w, "\t\tret").unwrap(); writeln!(w, "\t}}\n}}").unwrap(); - 'attr_loop: for attr in attrs.iter() { - let tokens_clone = attr.tokens.clone(); - let mut token_iter = tokens_clone.into_iter(); - if let Some(token) = token_iter.next() { - match token { - TokenTree::Group(g) => { - if format!("{}", single_ident_generic_path_to_ident(&attr.path).unwrap()) == "derive" { - for id in g.stream().into_iter() { - if let TokenTree::Ident(i) = id { - if i == "Clone" { - writeln!(w, "impl Clone for {} {{", struct_name).unwrap(); - writeln!(w, "\tfn clone(&self) -> Self {{").unwrap(); - writeln!(w, "\t\tSelf {{").unwrap(); - writeln!(w, "\t\t\tinner: Box::into_raw(Box::new(unsafe {{ &*self.inner }}.clone())),").unwrap(); - writeln!(w, "\t\t\tis_owned: true,").unwrap(); - writeln!(w, "\t\t}}\n\t}}\n}}").unwrap(); - writeln!(w, "#[allow(unused)]").unwrap(); - writeln!(w, "/// Used only if an object of this type is returned as a trait impl by a method").unwrap(); - writeln!(w, "pub(crate) extern \"C\" fn {}_clone_void(this_ptr: *const c_void) -> *mut c_void {{", struct_name).unwrap(); - writeln!(w, "\tBox::into_raw(Box::new(unsafe {{ (*(this_ptr as *mut native{})).clone() }})) as *mut c_void", struct_name).unwrap(); - writeln!(w, "}}").unwrap(); - writeln!(w, "#[no_mangle]").unwrap(); - writeln!(w, "pub extern \"C\" fn {}_clone(orig: &{}) -> {} {{", struct_name, struct_name, struct_name).unwrap(); - writeln!(w, "\t{} {{ inner: Box::into_raw(Box::new(unsafe {{ &*orig.inner }}.clone())), is_owned: true }}", struct_name).unwrap(); - writeln!(w, "}}").unwrap(); - break 'attr_loop; - } - } - } - } - }, - _ => {}, - } - } + if attrs_derives_clone(attrs) { + writeln!(w, "impl Clone for {} {{", struct_name).unwrap(); + writeln!(w, "\tfn clone(&self) -> Self {{").unwrap(); + writeln!(w, "\t\tSelf {{").unwrap(); + writeln!(w, "\t\t\tinner: Box::into_raw(Box::new(unsafe {{ &*self.inner }}.clone())),").unwrap(); + writeln!(w, "\t\t\tis_owned: true,").unwrap(); + writeln!(w, "\t\t}}\n\t}}\n}}").unwrap(); + writeln!(w, "#[allow(unused)]").unwrap(); + writeln!(w, "/// Used only if an object of this type is returned as a trait impl by a method").unwrap(); + writeln!(w, "pub(crate) extern \"C\" fn {}_clone_void(this_ptr: *const c_void) -> *mut c_void {{", struct_name).unwrap(); + writeln!(w, "\tBox::into_raw(Box::new(unsafe {{ (*(this_ptr as *mut native{})).clone() }})) as *mut c_void", struct_name).unwrap(); + writeln!(w, "}}").unwrap(); + writeln!(w, "#[no_mangle]").unwrap(); + writeln!(w, "pub extern \"C\" fn {}_clone(orig: &{}) -> {} {{", struct_name, struct_name, struct_name).unwrap(); + writeln!(w, "\t{} {{ inner: Box::into_raw(Box::new(unsafe {{ &*orig.inner }}.clone())), is_owned: true }}", struct_name).unwrap(); + writeln!(w, "}}").unwrap(); } write_cpp_wrapper(cpp_headers, &format!("{}", ident), true); @@ -832,7 +819,7 @@ fn writeln_impl(w: &mut W, i: &syn::ItemImpl, types: &mut Typ _ => {}, } } - walk_supertraits!(trait_obj, types, ( + walk_supertraits!(trait_obj, Some(&types), ( ("Clone", _) => { writeln!(w, "\t\tclone: Some({}_clone_void),", ident).unwrap(); }, @@ -930,7 +917,7 @@ fn writeln_impl(w: &mut W, i: &syn::ItemImpl, types: &mut Typ _ => unimplemented!(), } } - walk_supertraits!(trait_obj, types, ( + walk_supertraits!(trait_obj, Some(&types), ( (s, t) => { if let Some(supertrait_obj) = types.crate_types.traits.get(s).cloned() { writeln!(w, "use {}::{} as native{}Trait;", types.orig_crate, s, t).unwrap(); @@ -1479,6 +1466,10 @@ fn walk_ast<'a>(in_dir: &str, path: &str, module: String, ast_storage: &'a FullL ExportStatus::NoExport|ExportStatus::TestOnly => continue, } let struct_path = format!("{}::{}", module, s.ident); + if attrs_derives_clone(&s.attrs) { + crate_types.clonable_types.insert("crate::".to_owned() + &struct_path); + } + crate_types.opaques.insert(struct_path, &s.ident); } }, @@ -1489,6 +1480,12 @@ fn walk_ast<'a>(in_dir: &str, path: &str, module: String, ast_storage: &'a FullL ExportStatus::NoExport|ExportStatus::TestOnly => continue, } let trait_path = format!("{}::{}", module, t.ident); + walk_supertraits!(t, None, ( + ("Clone", _) => { + crate_types.clonable_types.insert("crate::".to_owned() + &trait_path); + }, + (_, _) => {} + ) ); crate_types.traits.insert(trait_path, &t); } }, @@ -1524,6 +1521,9 @@ fn walk_ast<'a>(in_dir: &str, path: &str, module: String, ast_storage: &'a FullL ExportStatus::NoExport|ExportStatus::TestOnly => continue, } let enum_path = format!("{}::{}", module, e.ident); + if attrs_derives_clone(&e.attrs) { + crate_types.clonable_types.insert("crate::".to_owned() + &enum_path); + } crate_types.opaques.insert(enum_path, &e.ident); } }, @@ -1534,6 +1534,9 @@ fn walk_ast<'a>(in_dir: &str, path: &str, module: String, ast_storage: &'a FullL ExportStatus::NoExport|ExportStatus::TestOnly => continue, } let enum_path = format!("{}::{}", module, e.ident); + if attrs_derives_clone(&e.attrs) { + crate_types.clonable_types.insert("crate::".to_owned() + &enum_path); + } crate_types.mirrored_enums.insert(enum_path, &e); } }, @@ -1578,7 +1581,8 @@ fn main() { // ...then walk the ASTs tracking what types we will map, and how, so that we can resolve them // when parsing other file ASTs... let mut libtypes = CrateTypes { traits: HashMap::new(), opaques: HashMap::new(), mirrored_enums: HashMap::new(), - type_aliases: HashMap::new(), templates_defined: HashMap::default(), template_file: &mut derived_templates }; + type_aliases: HashMap::new(), templates_defined: HashMap::default(), template_file: &mut derived_templates, + clonable_types: HashSet::new() }; walk_ast(&args[1], "/lib.rs", "".to_string(), &libast, &mut libtypes); // ... finally, do the actual file conversion/mapping, writing out types as we go. diff --git a/c-bindings-gen/src/types.rs b/c-bindings-gen/src/types.rs index 628d263bf..22f1d9e5a 100644 --- a/c-bindings-gen/src/types.rs +++ b/c-bindings-gen/src/types.rs @@ -1,4 +1,4 @@ -use std::collections::HashMap; +use std::collections::{HashMap, HashSet}; use std::fs::File; use std::io::Write; use std::hash; @@ -39,6 +39,30 @@ pub fn single_ident_generic_path_to_ident(p: &syn::Path) -> Option<&syn::Ident> } else { None } } +pub fn attrs_derives_clone(attrs: &[syn::Attribute]) -> bool { + for attr in attrs.iter() { + let tokens_clone = attr.tokens.clone(); + let mut token_iter = tokens_clone.into_iter(); + if let Some(token) = token_iter.next() { + match token { + TokenTree::Group(g) => { + if format!("{}", single_ident_generic_path_to_ident(&attr.path).unwrap()) == "derive" { + for id in g.stream().into_iter() { + if let TokenTree::Ident(i) = id { + if i == "Clone" { + return true; + } + } + } + } + }, + _ => {}, + } + } + } + false +} + #[derive(Debug, PartialEq)] pub enum ExportStatus { Export, @@ -293,6 +317,8 @@ pub struct CrateTypes<'a> { /// 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, + /// Set of containers which are clonable + pub clonable_types: HashSet, } /// A struct which tracks resolving rust types into C-mapped equivalents, exists for one specific @@ -368,6 +394,16 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> { _ => false, } } + pub fn is_clonable(&self, ty: &str) -> bool { + if self.crate_types.clonable_types.contains(ty) { return true; } + if self.is_primitive(ty) { return true; } + match ty { + "()" => true, + "crate::c_types::Signature" => true, + "crate::c_types::TxOut" => true, + _ => false, + } + } /// Gets the C-mapped type for types which are outside of the crate, or which are manually /// ignored by for some reason need mapping anyway. fn c_type_from_path<'b>(&self, full_path: &'b str, is_ref: bool, ptr_for_ref: bool) -> Option<&'b str> {