Merge pull request #18 from TheBlueMatt/2021-04-invoice-incl
[ldk-c-bindings] / c-bindings-gen / src / main.rs
index e30bb160247b3de02957ec89b8192db38bfee53c..24bcf82f4369ca3d21403ec77bfcc753b92dc925 100644 (file)
@@ -25,6 +25,7 @@ use std::io::{Read, Write};
 use std::process;
 
 use proc_macro2::Span;
+use quote::format_ident;
 use syn::parse_quote;
 
 mod types;
@@ -32,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 ***
 // *************************************
@@ -65,7 +68,7 @@ fn maybe_convert_trait_impl<W: std::io::Write>(w: &mut W, trait_path: &syn::Path
                                writeln!(w, "pub extern \"C\" fn {}_write(obj: &{}) -> crate::c_types::derived::CVec_u8Z {{", for_obj, full_obj_path).unwrap();
 
                                let ref_type: syn::Type = syn::parse_quote!(&#for_ty);
-                               assert!(!types.write_from_c_conversion_new_var(w, &syn::Ident::new("obj", Span::call_site()), &ref_type, Some(generics)));
+                               assert!(!types.write_from_c_conversion_new_var(w, &format_ident!("obj"), &ref_type, Some(generics)));
 
                                write!(w, "\tcrate::c_types::serialize_obj(").unwrap();
                                types.write_from_c_conversion_prefix(w, &ref_type, Some(generics));
@@ -100,7 +103,7 @@ fn maybe_convert_trait_impl<W: std::io::Write>(w: &mut W, trait_path: &syn::Path
                                                if let syn::GenericArgument::Type(args_ty) = args.args.iter().next().unwrap() {
                                                        types.write_c_type(w, args_ty, Some(generics), false);
 
-                                                       assert!(!types.write_from_c_conversion_new_var(&mut arg_conv, &syn::Ident::new("arg", Span::call_site()), &args_ty, Some(generics)));
+                                                       assert!(!types.write_from_c_conversion_new_var(&mut arg_conv, &format_ident!("arg"), &args_ty, Some(generics)));
 
                                                        write!(&mut arg_conv, "\tlet arg_conv = ").unwrap();
                                                        types.write_from_c_conversion_prefix(&mut arg_conv, &args_ty, Some(generics));
@@ -123,7 +126,7 @@ fn maybe_convert_trait_impl<W: std::io::Write>(w: &mut W, trait_path: &syn::Path
                                        writeln!(w, "\tlet res = crate::c_types::deserialize_obj(ser);").unwrap();
                                }
                                write!(w, "\t").unwrap();
-                               if types.write_to_c_conversion_new_var(w, &syn::Ident::new("res", Span::call_site()), &res_ty, Some(generics), false) {
+                               if types.write_to_c_conversion_new_var(w, &format_ident!("res"), &res_ty, Some(generics), false) {
                                        write!(w, "\n\t").unwrap();
                                }
                                types.write_to_c_conversion_inline_prefix(w, &res_ty, Some(generics), false);
@@ -224,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);
 
@@ -578,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;
@@ -602,14 +608,10 @@ fn writeln_struct<'a, 'b, W: std::io::Write>(w: &mut W, s: &'a syn::ItemStruct,
                                                write!(w, "#[no_mangle]\npub extern \"C\" fn {}_get_{}(this_ptr: &{}) -> ", struct_name, ident, struct_name).unwrap();
                                                types.write_c_type(w, &ref_type, Some(&gen_types), true);
                                                write!(w, " {{\n\tlet mut inner_val = &mut unsafe {{ &mut *this_ptr.inner }}.{};\n\t", ident).unwrap();
-                                               let local_var = types.write_to_c_conversion_new_var(w, &syn::Ident::new("inner_val", Span::call_site()), &ref_type, Some(&gen_types), true);
+                                               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();
                                        }
@@ -619,7 +621,7 @@ fn writeln_struct<'a, 'b, W: std::io::Write>(w: &mut W, s: &'a syn::ItemStruct,
                                                write!(w, "#[no_mangle]\npub extern \"C\" fn {}_set_{}(this_ptr: &mut {}, mut val: ", struct_name, ident, struct_name).unwrap();
                                                types.write_c_type(w, &field.ty, Some(&gen_types), false);
                                                write!(w, ") {{\n\t").unwrap();
-                                               let local_var = types.write_from_c_conversion_new_var(w, &syn::Ident::new("val", Span::call_site()), &field.ty, Some(&gen_types));
+                                               let local_var = types.write_from_c_conversion_new_var(w, &format_ident!("val"), &field.ty, Some(&gen_types));
                                                if local_var { write!(w, "\n\t").unwrap(); }
                                                write!(w, "unsafe {{ &mut *this_ptr.inner }}.{} = ", ident).unwrap();
                                                types.write_from_c_conversion_prefix(w, &field.ty, Some(&gen_types));
@@ -642,8 +644,8 @@ fn writeln_struct<'a, 'b, W: std::io::Write>(w: &mut W, s: &'a syn::ItemStruct,
                        }
                        write!(w, ") -> {} {{\n\t", struct_name).unwrap();
                        for field in fields.named.iter() {
-                               let field_name = format!("{}_arg", field.ident.as_ref().unwrap());
-                               if types.write_from_c_conversion_new_var(w, &syn::Ident::new(&field_name, Span::call_site()), &field.ty, Some(&gen_types)) {
+                               let field_ident = format_ident!("{}_arg", field.ident.as_ref().unwrap());
+                               if types.write_from_c_conversion_new_var(w, &field_ident, &field.ty, Some(&gen_types)) {
                                        write!(w, "\n\t").unwrap();
                                }
                        }
@@ -677,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;
@@ -704,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 +959,30 @@ fn writeln_impl<W: std::io::Write>(w: &mut W, i: &syn::ItemImpl, types: &mut Typ
                                                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()) {{", resolved_path).unwrap();
+                                                       writeln!(w, "\t\tOk(r) => {{").unwrap();
+                                                       let new_var = types.write_to_c_conversion_new_var(w, &syn::Ident::new("r", Span::call_site()), &*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(0u8),").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: &{}) -> Str {{", ident, resolved_path).unwrap();
+                                               writeln!(w, "\tformat!(\"{{}}\", o).into()").unwrap();
+                                               writeln!(w, "}}").unwrap();
                                        } else {
                                                //XXX: implement for other things like ToString
                                                // If we have no generics, try a manual implementation:
@@ -990,18 +1016,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();
@@ -1165,7 +1203,7 @@ fn writeln_enum<'a, 'b, W: std::io::Write>(w: &mut W, e: &'a syn::ItemEnum, type
                                                        if $ref {
                                                                write!(w, "let mut {}_nonref = (*{}).clone();\n\t\t\t\t", $field_ident, $field_ident).unwrap();
                                                                if new_var {
-                                                                       let nonref_ident = syn::Ident::new(&format!("{}_nonref", $field_ident), Span::call_site());
+                                                                       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);
                                                                        } else {
@@ -1187,7 +1225,7 @@ 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, &syn::Ident::new(&(('a' as u8 + idx as u8) as char).to_string(), Span::call_site()));
+                                               handle_field_a!(field, &format_ident!("{}", ('a' as u8 + idx as u8) as char));
                                        }
                                } else { write!(w, " ").unwrap(); }
 
@@ -1225,7 +1263,7 @@ fn writeln_enum<'a, 'b, W: std::io::Write>(w: &mut W, e: &'a syn::ItemEnum, type
                                        write!(w, " (").unwrap();
                                        for (idx, field) in fields.unnamed.iter().enumerate() {
                                                write!(w, "\n\t\t\t\t\t").unwrap();
-                                               handle_field_b!(field, &syn::Ident::new(&(('a' as u8 + idx as u8) as char).to_string(), Span::call_site()));
+                                               handle_field_b!(field, &format_ident!("{}", ('a' as u8 + idx as u8) as char));
                                        }
                                        writeln!(w, "\n\t\t\t\t)").unwrap();
                                        write!(w, "\t\t\t}}").unwrap();
@@ -1261,7 +1299,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();
@@ -1277,6 +1315,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.
@@ -1321,11 +1388,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 {
@@ -1359,7 +1427,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 {
@@ -1485,20 +1555,17 @@ fn walk_ast<'a>(ast_storage: &'a FullLibraryAST, crate_types: &mut CrateTypes<'a
                                                if process_alias {
                                                        match &*t.ty {
                                                                syn::Type::Path(p) => {
+                                                                       let t_ident = &t.ident;
+
                                                                        // If its a path with no generics, assume we don't map the aliased type and map it opaque
-                                                                       let mut segments = syn::punctuated::Punctuated::new();
-                                                                       segments.push(syn::PathSegment {
-                                                                               ident: t.ident.clone(),
-                                                                               arguments: syn::PathArguments::None,
-                                                                       });
-                                                                       let path_obj = syn::Path { leading_colon: None, segments };
+                                                                       let path_obj = parse_quote!(#t_ident);
                                                                        let args_obj = p.path.segments.last().unwrap().arguments.clone();
                                                                        match crate_types.reverse_alias_map.entry(import_resolver.maybe_resolve_path(&p.path, None).unwrap()) {
                                                                                hash_map::Entry::Occupied(mut e) => { e.get_mut().push((path_obj, args_obj)); },
                                                                                hash_map::Entry::Vacant(e) => { e.insert(vec![(path_obj, args_obj)]); },
                                                                        }
 
-                                                                       crate_types.opaques.insert(type_path.clone(), &t.ident);
+                                                                       crate_types.opaques.insert(type_path, t_ident);
                                                                },
                                                                _ => {
                                                                        crate_types.type_aliases.insert(type_path, import_resolver.resolve_imported_refs((*t.ty).clone()));