X-Git-Url: http://git.bitcoin.ninja/index.cgi?p=ldk-c-bindings;a=blobdiff_plain;f=c-bindings-gen%2Fsrc%2Fmain.rs;h=c2ef30fbcf83a9e0c37204e1ee1b0f9466756ba4;hp=d107f3e9a6c66af726c4c84602c45c209686712c;hb=1926a7a71ae0f37ebd6562996769334e0af0cf1b;hpb=29298fd16d3c535cb9d3bfb64fb9854e50998901

diff --git a/c-bindings-gen/src/main.rs b/c-bindings-gen/src/main.rs
index d107f3e..c2ef30f 100644
--- a/c-bindings-gen/src/main.rs
+++ b/c-bindings-gen/src/main.rs
@@ -33,6 +33,8 @@ mod blocks;
 use types::*;
 use blocks::*;
 
+const DEFAULT_IMPORTS: &'static str = "\nuse std::str::FromStr;\nuse std::ffi::c_void;\nuse bitcoin::hashes::Hash;\nuse crate::c_types::*;\n";
+
 // *************************************
 // *** Manually-expanded conversions ***
 // *************************************
@@ -225,7 +227,7 @@ fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, ty
 	}
 	writeln_docs(w, &t.attrs, "");
 
-	let mut gen_types = GenericTypes::new();
+	let mut gen_types = GenericTypes::new(None);
 	assert!(gen_types.learn_generics(&t.generics, types));
 	gen_types.learn_associated_types(&t, types);
 
@@ -386,7 +388,7 @@ fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, ty
 													ident.mutability.is_some() || ident.subpat.is_some() {
 												unimplemented!();
 											}
-											write!(w, ", {}{}: ", if $type_resolver.skip_arg(&*arg.ty, Some(&meth_gen_types)) { "_" } else { "" }, ident.ident).unwrap();
+											write!(w, ", mut {}{}: ", if $type_resolver.skip_arg(&*arg.ty, Some(&meth_gen_types)) { "_" } else { "" }, ident.ident).unwrap();
 										}
 										_ => unimplemented!(),
 									}
@@ -579,7 +581,10 @@ fn writeln_struct<'a, 'b, W: std::io::Write>(w: &mut W, s: &'a syn::ItemStruct,
 	writeln_opaque(w, &s.ident, struct_name, &s.generics, &s.attrs, types, extra_headers, cpp_headers);
 
 	if let syn::Fields::Named(fields) = &s.fields {
-		let mut gen_types = GenericTypes::new();
+		let mut self_path_segs = syn::punctuated::Punctuated::new();
+		self_path_segs.push(s.ident.clone().into());
+		let self_path = syn::Path { leading_colon: None, segments: self_path_segs};
+		let mut gen_types = GenericTypes::new(Some((types.resolve_path(&self_path, None), &self_path)));
 		assert!(gen_types.learn_generics(&s.generics, types));
 
 		let mut all_fields_settable = true;
@@ -606,11 +611,7 @@ fn writeln_struct<'a, 'b, W: std::io::Write>(w: &mut W, s: &'a syn::ItemStruct,
 						let local_var = types.write_to_c_conversion_new_var(w, &format_ident!("inner_val"), &ref_type, Some(&gen_types), true);
 						if local_var { write!(w, "\n\t").unwrap(); }
 						types.write_to_c_conversion_inline_prefix(w, &ref_type, Some(&gen_types), true);
-						if local_var {
-							write!(w, "inner_val").unwrap();
-						} else {
-							write!(w, "(*inner_val)").unwrap();
-						}
+						write!(w, "inner_val").unwrap();
 						types.write_to_c_conversion_inline_suffix(w, &ref_type, Some(&gen_types), true);
 						writeln!(w, "\n}}").unwrap();
 					}
@@ -678,7 +679,7 @@ fn writeln_impl<W: std::io::Write>(w: &mut W, i: &syn::ItemImpl, types: &mut Typ
 
 	if let syn::Type::Tuple(_) = &*i.self_ty {
 		if types.understood_c_type(&*i.self_ty, None) {
-			let mut gen_types = GenericTypes::new();
+			let mut gen_types = GenericTypes::new(None);
 			if !gen_types.learn_generics(&i.generics, types) {
 				eprintln!("Not implementing anything for `impl (..)` due to not understood generics");
 				return;
@@ -705,7 +706,7 @@ fn writeln_impl<W: std::io::Write>(w: &mut W, i: &syn::ItemImpl, types: &mut Typ
 		if p.qself.is_some() { unimplemented!(); }
 		if let Some(ident) = single_ident_generic_path_to_ident(&p.path) {
 			if let Some(resolved_path) = types.maybe_resolve_non_ignored_ident(&ident) {
-				let mut gen_types = GenericTypes::new();
+				let mut gen_types = GenericTypes::new(Some((resolved_path.clone(), &p.path)));
 				if !gen_types.learn_generics(&i.generics, types) {
 					eprintln!("Not implementing anything for impl {} due to not understood generics", ident);
 					return;
@@ -957,6 +958,39 @@ fn writeln_impl<W: std::io::Write>(w: &mut W, i: &syn::ItemImpl, types: &mut Typ
 						writeln!(w, "/// Creates a copy of the {}", ident).unwrap();
 						writeln!(w, "pub extern \"C\" fn {}_clone(orig: &{}) -> {} {{", ident, ident, ident).unwrap();
 						writeln!(w, "\torig.clone()").unwrap();
+						writeln!(w, "}}").unwrap();
+					} else if path_matches_nongeneric(&trait_path.1, &["FromStr"]) {
+						if let Some(container) = types.get_c_mangled_container_type(
+								vec![&*i.self_ty, &syn::Type::Tuple(syn::TypeTuple { paren_token: Default::default(), elems: syn::punctuated::Punctuated::new() })],
+								Some(&gen_types), "Result") {
+							writeln!(w, "#[no_mangle]").unwrap();
+							writeln!(w, "/// Read a {} object from a string", ident).unwrap();
+							writeln!(w, "pub extern \"C\" fn {}_from_str(s: crate::c_types::Str) -> {} {{", ident, container).unwrap();
+							writeln!(w, "\tmatch {}::from_str(s.into_str()) {{", resolved_path).unwrap();
+							writeln!(w, "\t\tOk(r) => {{").unwrap();
+							let new_var = types.write_to_c_conversion_new_var(w, &format_ident!("r"), &*i.self_ty, Some(&gen_types), false);
+							write!(w, "\t\t\tcrate::c_types::CResultTempl::ok(\n\t\t\t\t").unwrap();
+							types.write_to_c_conversion_inline_prefix(w, &*i.self_ty, Some(&gen_types), false);
+							write!(w, "{}r", if new_var { "local_" } else { "" }).unwrap();
+							types.write_to_c_conversion_inline_suffix(w, &*i.self_ty, Some(&gen_types), false);
+							writeln!(w, "\n\t\t\t)\n\t\t}},").unwrap();
+							writeln!(w, "\t\tErr(e) => crate::c_types::CResultTempl::err(()),").unwrap();
+							writeln!(w, "\t}}.into()\n}}").unwrap();
+						}
+					} else if path_matches_nongeneric(&trait_path.1, &["Display"]) {
+						writeln!(w, "#[no_mangle]").unwrap();
+						writeln!(w, "/// Get the string representation of a {} object", ident).unwrap();
+						writeln!(w, "pub extern \"C\" fn {}_to_str(o: &crate::{}) -> Str {{", ident, resolved_path).unwrap();
+
+						let self_ty = &i.self_ty;
+						let ref_type: syn::Type = syn::parse_quote!(&#self_ty);
+						let new_var = types.write_from_c_conversion_new_var(w, &format_ident!("o"), &ref_type, Some(&gen_types));
+						write!(w, "\tformat!(\"{{}}\", ").unwrap();
+						types.write_from_c_conversion_prefix(w, &ref_type, Some(&gen_types));
+						write!(w, "{}o", if new_var { "local_" } else { "" }).unwrap();
+						types.write_from_c_conversion_suffix(w, &ref_type, Some(&gen_types));
+						writeln!(w, ").into()").unwrap();
+
 						writeln!(w, "}}").unwrap();
 					} else {
 						//XXX: implement for other things like ToString
@@ -991,18 +1025,30 @@ fn writeln_impl<W: std::io::Write>(w: &mut W, i: &syn::ItemImpl, types: &mut Typ
 									write_method_var_decl_body(w, &m.sig, "", types, Some(&meth_gen_types), false);
 									let mut takes_self = false;
 									let mut takes_mut_self = false;
+									let mut takes_owned_self = false;
 									for inp in m.sig.inputs.iter() {
 										if let syn::FnArg::Receiver(r) = inp {
 											takes_self = true;
 											if r.mutability.is_some() { takes_mut_self = true; }
+											if r.reference.is_none() { takes_owned_self = true; }
 										}
 									}
-									if takes_mut_self {
-										write!(w, "unsafe {{ &mut (*(this_arg.inner as *mut native{})) }}.{}(", ident, m.sig.ident).unwrap();
-									} else if takes_self {
-										write!(w, "unsafe {{ &*this_arg.inner }}.{}(", m.sig.ident).unwrap();
-									} else {
+									if !takes_mut_self && !takes_self {
 										write!(w, "{}::{}(", resolved_path, m.sig.ident).unwrap();
+									} else {
+										match &declared_type {
+											DeclType::MirroredEnum => write!(w, "this_arg.to_native().{}(", m.sig.ident).unwrap(),
+											DeclType::StructImported => {
+												if takes_owned_self {
+													write!(w, "(*unsafe {{ Box::from_raw(this_arg.take_inner()) }}).{}(", m.sig.ident).unwrap();
+												} else if takes_mut_self {
+													write!(w, "unsafe {{ &mut (*(this_arg.inner as *mut native{})) }}.{}(", ident, m.sig.ident).unwrap();
+												} else {
+													write!(w, "unsafe {{ &*this_arg.inner }}.{}(", m.sig.ident).unwrap();
+												}
+											},
+											_ => unimplemented!(),
+										}
 									}
 									write_method_call_params(w, &m.sig, "", types, Some(&meth_gen_types), &ret_type, false);
 									writeln!(w, "\n}}\n").unwrap();
@@ -1091,9 +1137,8 @@ fn writeln_enum<'a, 'b, W: std::io::Write>(w: &mut W, e: &'a syn::ItemEnum, type
 	}
 	writeln_docs(w, &e.attrs, "");
 
-	if e.generics.lt_token.is_some() {
-		unimplemented!();
-	}
+	let mut gen_types = GenericTypes::new(None);
+	assert!(gen_types.learn_generics(&e.generics, types));
 
 	let mut needs_free = false;
 
@@ -1109,21 +1154,31 @@ fn writeln_enum<'a, 'b, W: std::io::Write>(w: &mut W, e: &'a syn::ItemEnum, type
 				if export_status(&field.attrs) == ExportStatus::TestOnly { continue; }
 				writeln_docs(w, &field.attrs, "\t\t");
 				write!(w, "\t\t{}: ", field.ident.as_ref().unwrap()).unwrap();
-				types.write_c_type(w, &field.ty, None, false);
+				types.write_c_type(w, &field.ty, Some(&gen_types), false);
 				writeln!(w, ",").unwrap();
 			}
 			write!(w, "\t}}").unwrap();
 		} else if let syn::Fields::Unnamed(fields) = &var.fields {
-			needs_free = true;
-			write!(w, "(").unwrap();
-			for (idx, field) in fields.unnamed.iter().enumerate() {
-				if export_status(&field.attrs) == ExportStatus::TestOnly { continue; }
-				types.write_c_type(w, &field.ty, None, false);
-				if idx != fields.unnamed.len() - 1 {
-					write!(w, ",").unwrap();
+			let mut empty_tuple_variant = false;
+			if fields.unnamed.len() == 1 {
+				let mut empty_check = Vec::new();
+				types.write_c_type(&mut empty_check, &fields.unnamed[0].ty, Some(&gen_types), false);
+				if empty_check.is_empty() {
+					empty_tuple_variant = true;
 				}
 			}
-			write!(w, ")").unwrap();
+			if !empty_tuple_variant {
+				needs_free = true;
+				write!(w, "(").unwrap();
+				for (idx, field) in fields.unnamed.iter().enumerate() {
+					if export_status(&field.attrs) == ExportStatus::TestOnly { continue; }
+					types.write_c_type(w, &field.ty, Some(&gen_types), false);
+					if idx != fields.unnamed.len() - 1 {
+						write!(w, ",").unwrap();
+					}
+				}
+				write!(w, ")").unwrap();
+			}
 		}
 		if var.discriminant.is_some() { unimplemented!(); }
 		writeln!(w, ",").unwrap();
@@ -1135,6 +1190,7 @@ fn writeln_enum<'a, 'b, W: std::io::Write>(w: &mut W, e: &'a syn::ItemEnum, type
 			writeln!(w, "\t#[allow(unused)]\n\tpub(crate) fn {} {{\n\t\tmatch {} {{", $fn_sig, if $to_c { "native" } else { "self" }).unwrap();
 			for var in e.variants.iter() {
 				write!(w, "\t\t\t{}{}::{} ", if $to_c { "native" } else { "" }, e.ident, var.ident).unwrap();
+				let mut empty_tuple_variant = false;
 				if let syn::Fields::Named(fields) = &var.fields {
 					write!(w, "{{").unwrap();
 					for field in fields.named.iter() {
@@ -1143,12 +1199,21 @@ fn writeln_enum<'a, 'b, W: std::io::Write>(w: &mut W, e: &'a syn::ItemEnum, type
 					}
 					write!(w, "}} ").unwrap();
 				} else if let syn::Fields::Unnamed(fields) = &var.fields {
-					write!(w, "(").unwrap();
-					for (idx, field) in fields.unnamed.iter().enumerate() {
-						if export_status(&field.attrs) == ExportStatus::TestOnly { continue; }
-						write!(w, "{}{}, ", if $ref { "ref " } else { "mut " }, ('a' as u8 + idx as u8) as char).unwrap();
+					if fields.unnamed.len() == 1 {
+						let mut empty_check = Vec::new();
+						types.write_c_type(&mut empty_check, &fields.unnamed[0].ty, Some(&gen_types), false);
+						if empty_check.is_empty() {
+							empty_tuple_variant = true;
+						}
+					}
+					if !empty_tuple_variant || $to_c {
+						write!(w, "(").unwrap();
+						for (idx, field) in fields.unnamed.iter().enumerate() {
+							if export_status(&field.attrs) == ExportStatus::TestOnly { continue; }
+							write!(w, "{}{}, ", if $ref { "ref " } else { "mut " }, ('a' as u8 + idx as u8) as char).unwrap();
+						}
+						write!(w, ") ").unwrap();
 					}
-					write!(w, ") ").unwrap();
 				}
 				write!(w, "=>").unwrap();
 
@@ -1158,9 +1223,9 @@ fn writeln_enum<'a, 'b, W: std::io::Write>(w: &mut W, e: &'a syn::ItemEnum, type
 						let mut sink = ::std::io::sink();
 						let mut out: &mut dyn std::io::Write = if $ref { &mut sink } else { w };
 						let new_var = if $to_c {
-							types.write_to_c_conversion_new_var(&mut out, $field_ident, &$field.ty, None, false)
+							types.write_to_c_conversion_new_var(&mut out, $field_ident, &$field.ty, Some(&gen_types), false)
 						} else {
-							types.write_from_c_conversion_new_var(&mut out, $field_ident, &$field.ty, None)
+							types.write_from_c_conversion_new_var(&mut out, $field_ident, &$field.ty, Some(&gen_types))
 						};
 						if $ref || new_var {
 							if $ref {
@@ -1168,9 +1233,9 @@ fn writeln_enum<'a, 'b, W: std::io::Write>(w: &mut W, e: &'a syn::ItemEnum, type
 								if new_var {
 									let nonref_ident = format_ident!("{}_nonref", $field_ident);
 									if $to_c {
-										types.write_to_c_conversion_new_var(w, &nonref_ident, &$field.ty, None, false);
+										types.write_to_c_conversion_new_var(w, &nonref_ident, &$field.ty, Some(&gen_types), false);
 									} else {
-										types.write_from_c_conversion_new_var(w, &nonref_ident, &$field.ty, None);
+										types.write_from_c_conversion_new_var(w, &nonref_ident, &$field.ty, Some(&gen_types));
 									}
 									write!(w, "\n\t\t\t\t").unwrap();
 								}
@@ -1188,7 +1253,9 @@ fn writeln_enum<'a, 'b, W: std::io::Write>(w: &mut W, e: &'a syn::ItemEnum, type
 				} else if let syn::Fields::Unnamed(fields) = &var.fields {
 					write!(w, " {{\n\t\t\t\t").unwrap();
 					for (idx, field) in fields.unnamed.iter().enumerate() {
-						handle_field_a!(field, &format_ident!("{}", ('a' as u8 + idx as u8) as char));
+						if !empty_tuple_variant {
+							handle_field_a!(field, &format_ident!("{}", ('a' as u8 + idx as u8) as char));
+						}
 					}
 				} else { write!(w, " ").unwrap(); }
 
@@ -1198,16 +1265,16 @@ fn writeln_enum<'a, 'b, W: std::io::Write>(w: &mut W, e: &'a syn::ItemEnum, type
 					($field: expr, $field_ident: expr) => { {
 						if export_status(&$field.attrs) == ExportStatus::TestOnly { continue; }
 						if $to_c {
-							types.write_to_c_conversion_inline_prefix(w, &$field.ty, None, false);
+							types.write_to_c_conversion_inline_prefix(w, &$field.ty, Some(&gen_types), false);
 						} else {
-							types.write_from_c_conversion_prefix(w, &$field.ty, None);
+							types.write_from_c_conversion_prefix(w, &$field.ty, Some(&gen_types));
 						}
 						write!(w, "{}{}", $field_ident,
 							if $ref { "_nonref" } else { "" }).unwrap();
 						if $to_c {
-							types.write_to_c_conversion_inline_suffix(w, &$field.ty, None, false);
+							types.write_to_c_conversion_inline_suffix(w, &$field.ty, Some(&gen_types), false);
 						} else {
-							types.write_from_c_conversion_suffix(w, &$field.ty, None);
+							types.write_from_c_conversion_suffix(w, &$field.ty, Some(&gen_types));
 						}
 						write!(w, ",").unwrap();
 					} }
@@ -1223,12 +1290,14 @@ fn writeln_enum<'a, 'b, W: std::io::Write>(w: &mut W, e: &'a syn::ItemEnum, type
 					writeln!(w, "\n\t\t\t\t}}").unwrap();
 					write!(w, "\t\t\t}}").unwrap();
 				} else if let syn::Fields::Unnamed(fields) = &var.fields {
-					write!(w, " (").unwrap();
-					for (idx, field) in fields.unnamed.iter().enumerate() {
-						write!(w, "\n\t\t\t\t\t").unwrap();
-						handle_field_b!(field, &format_ident!("{}", ('a' as u8 + idx as u8) as char));
+					if !empty_tuple_variant || !$to_c {
+						write!(w, " (").unwrap();
+						for (idx, field) in fields.unnamed.iter().enumerate() {
+							write!(w, "\n\t\t\t\t\t").unwrap();
+							handle_field_b!(field, &format_ident!("{}", ('a' as u8 + idx as u8) as char));
+						}
+						writeln!(w, "\n\t\t\t\t)").unwrap();
 					}
-					writeln!(w, "\n\t\t\t\t)").unwrap();
 					write!(w, "\t\t\t}}").unwrap();
 				}
 				writeln!(w, ",").unwrap();
@@ -1262,7 +1331,7 @@ fn writeln_fn<'a, 'b, W: std::io::Write>(w: &mut W, f: &'a syn::ItemFn, types: &
 	}
 	writeln_docs(w, &f.attrs, "");
 
-	let mut gen_types = GenericTypes::new();
+	let mut gen_types = GenericTypes::new(None);
 	if !gen_types.learn_generics(&f.sig.generics, types) { return; }
 
 	write!(w, "#[no_mangle]\npub extern \"C\" fn {}(", f.sig.ident).unwrap();
@@ -1278,6 +1347,35 @@ fn writeln_fn<'a, 'b, W: std::io::Write>(w: &mut W, f: &'a syn::ItemFn, types: &
 // *** File/Crate Walking Logic ***
 // ********************************
 
+fn convert_priv_mod<'a, 'b: 'a, W: std::io::Write>(w: &mut W, libast: &'b FullLibraryAST, crate_types: &CrateTypes<'b>, out_dir: &str, mod_path: &str, module: &'b syn::ItemMod) {
+	// We want to ignore all items declared in this module (as they are not pub), but we still need
+	// to give the ImportResolver any use statements, so we copy them here.
+	let mut use_items = Vec::new();
+	for item in module.content.as_ref().unwrap().1.iter() {
+		if let syn::Item::Use(_) = item {
+			use_items.push(item);
+		}
+	}
+	let import_resolver = ImportResolver::from_borrowed_items(mod_path.splitn(2, "::").next().unwrap(), &libast.dependencies, mod_path, &use_items);
+	let mut types = TypeResolver::new(mod_path, import_resolver, crate_types);
+
+	writeln!(w, "mod {} {{\n{}", module.ident, DEFAULT_IMPORTS).unwrap();
+	for item in module.content.as_ref().unwrap().1.iter() {
+		match item {
+			syn::Item::Mod(m) => convert_priv_mod(w, libast, crate_types, out_dir, &format!("{}::{}", mod_path, module.ident), m),
+			syn::Item::Impl(i) => {
+				if let &syn::Type::Path(ref p) = &*i.self_ty {
+					if p.path.get_ident().is_some() {
+						writeln_impl(w, i, &mut types);
+					}
+				}
+			},
+			_ => {},
+		}
+	}
+	writeln!(w, "}}").unwrap();
+}
+
 /// Do the Real Work of mapping an original file to C-callable wrappers. Creates a new file at
 /// `out_path` and fills it with wrapper structs/functions to allow calling the things in the AST
 /// at `module` from C.
@@ -1322,11 +1420,12 @@ fn convert_file<'a, 'b>(libast: &'a FullLibraryAST, crate_types: &CrateTypes<'a>
 			writeln!(out, "#![allow(unused_parens)]").unwrap();
 			writeln!(out, "#![allow(unused_unsafe)]").unwrap();
 			writeln!(out, "#![allow(unused_braces)]").unwrap();
-			writeln!(out, "#![deny(missing_docs)]").unwrap();
+			// TODO: We need to map deny(missing_docs) in the source crate(s)
+			//writeln!(out, "#![deny(missing_docs)]").unwrap();
 			writeln!(out, "pub mod c_types;").unwrap();
 			writeln!(out, "pub mod bitcoin;").unwrap();
 		} else {
-			writeln!(out, "\nuse std::ffi::c_void;\nuse bitcoin::hashes::Hash;\nuse crate::c_types::*;\n").unwrap();
+			writeln!(out, "{}", DEFAULT_IMPORTS).unwrap();
 		}
 
 		for m in submods {
@@ -1360,7 +1459,9 @@ fn convert_file<'a, 'b>(libast: &'a FullLibraryAST, crate_types: &CrateTypes<'a>
 						writeln_trait(&mut out, &t, &mut type_resolver, header_file, cpp_header_file);
 					}
 				},
-				syn::Item::Mod(_) => {}, // We don't have to do anything - the top loop handles these.
+				syn::Item::Mod(m) => {
+					convert_priv_mod(&mut out, libast, crate_types, out_dir, &format!("{}::{}", module, m.ident), m);
+				},
 				syn::Item::Const(c) => {
 					// Re-export any primitive-type constants.
 					if let syn::Visibility::Public(_) = c.vis {