Dont pass original crate name in generator CLI (as there are multiple)
[ldk-c-bindings] / c-bindings-gen / src / main.rs
index a1c5a746edd2527118cca86b5fdb03262ea13235..e217bab57aa97723ed7389e480fa092842333118 100644 (file)
@@ -58,7 +58,7 @@ fn maybe_convert_trait_impl<W: std::io::Write>(w: &mut W, trait_path: &syn::Path
                }
 
                match &t as &str {
-                       "util::ser::Writeable" => {
+                       "lightning::util::ser::Writeable" => {
                                writeln!(w, "#[no_mangle]").unwrap();
                                writeln!(w, "/// Serialize the {} object into a byte array which can be read by {}_read", for_obj, for_obj).unwrap();
                                writeln!(w, "pub extern \"C\" fn {}_write(obj: &{}) -> crate::c_types::derived::CVec_u8Z {{", for_obj, full_obj_path).unwrap();
@@ -82,7 +82,7 @@ fn maybe_convert_trait_impl<W: std::io::Write>(w: &mut W, trait_path: &syn::Path
                                        writeln!(w, "}}").unwrap();
                                }
                        },
-                       "util::ser::Readable"|"util::ser::ReadableArgs" => {
+                       "lightning::util::ser::Readable"|"lightning::util::ser::ReadableArgs" => {
                                // Create the Result<Object, DecodeError> syn::Type
                                let mut err_segs = syn::punctuated::Punctuated::new();
                                err_segs.push(syn::PathSegment { ident: syn::Ident::new("ln", Span::call_site()), arguments: syn::PathArguments::None });
@@ -110,7 +110,7 @@ fn maybe_convert_trait_impl<W: std::io::Write>(w: &mut W, trait_path: &syn::Path
                                write!(w, "pub extern \"C\" fn {}_read(ser: crate::c_types::u8slice", for_obj).unwrap();
 
                                let mut arg_conv = Vec::new();
-                               if t == "util::ser::ReadableArgs" {
+                               if t == "lightning::util::ser::ReadableArgs" {
                                        write!(w, ", arg: ").unwrap();
                                        assert!(trait_path.leading_colon.is_none());
                                        let args_seg = trait_path.segments.iter().last().unwrap();
@@ -133,7 +133,7 @@ fn maybe_convert_trait_impl<W: std::io::Write>(w: &mut W, trait_path: &syn::Path
                                types.write_c_type(w, &res_ty, Some(generics), false);
                                writeln!(w, " {{").unwrap();
 
-                               if t == "util::ser::ReadableArgs" {
+                               if t == "lightning::util::ser::ReadableArgs" {
                                        w.write(&arg_conv).unwrap();
                                        write!(w, ";\n\tlet res: ").unwrap();
                                        // At least in one case we need type annotations here, so provide them.
@@ -162,7 +162,7 @@ fn maybe_convert_trait_impl<W: std::io::Write>(w: &mut W, trait_path: &syn::Path
 /// single function (eg for serialization).
 fn convert_trait_impl_field(trait_path: &str) -> (&'static str, String, &'static str) {
        match trait_path {
-               "util::ser::Writeable" => ("Serialize the object into a byte array", "write".to_owned(), "crate::c_types::derived::CVec_u8Z"),
+               "lightning::util::ser::Writeable" => ("Serialize the object into a byte array", "write".to_owned(), "crate::c_types::derived::CVec_u8Z"),
                _ => unimplemented!(),
        }
 }
@@ -171,7 +171,7 @@ fn convert_trait_impl_field(trait_path: &str) -> (&'static str, String, &'static
 /// `for_obj` which implements the the trait at `trait_path`.
 fn write_trait_impl_field_assign<W: std::io::Write>(w: &mut W, trait_path: &str, for_obj: &syn::Ident) {
        match trait_path {
-               "util::ser::Writeable" => {
+               "lightning::util::ser::Writeable" => {
                        writeln!(w, "\t\twrite: {}_write_void,", for_obj).unwrap();
                },
                _ => unimplemented!(),
@@ -182,8 +182,8 @@ fn write_trait_impl_field_assign<W: std::io::Write>(w: &mut W, trait_path: &str,
 fn do_write_impl_trait<W: std::io::Write>(w: &mut W, trait_path: &str, _trait_name: &syn::Ident, for_obj: &str) {
 eprintln!("{}", trait_path);
        match trait_path {
-               "util::ser::Writeable" => {
-                       writeln!(w, "impl lightning::{} for {} {{", trait_path, for_obj).unwrap();
+               "lightning::util::ser::Writeable" => {
+                       writeln!(w, "impl {} for {} {{", trait_path, for_obj).unwrap();
                        writeln!(w, "\tfn write<W: lightning::util::ser::Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {{").unwrap();
                        writeln!(w, "\t\tlet vec = (self.write)(self.this_arg);").unwrap();
                        writeln!(w, "\t\tw.write_all(vec.as_slice())").unwrap();
@@ -368,7 +368,7 @@ fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, ty
        writeln!(w, "}}").unwrap();
 
        macro_rules! impl_trait_for_c {
-               ($t: expr, $impl_accessor: expr) => {
+               ($t: expr, $impl_accessor: expr, $type_resolver: expr) => {
                        for item in $t.items.iter() {
                                match item {
                                        syn::TraitItem::Method(m) => {
@@ -379,9 +379,9 @@ fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, ty
                                                        unimplemented!();
                                                }
                                                let mut meth_gen_types = gen_types.push_ctx();
-                                               assert!(meth_gen_types.learn_generics(&m.sig.generics, types));
+                                               assert!(meth_gen_types.learn_generics(&m.sig.generics, $type_resolver));
                                                write!(w, "\tfn {}", m.sig.ident).unwrap();
-                                               types.write_rust_generic_param(w, Some(&meth_gen_types), m.sig.generics.params.iter());
+                                               $type_resolver.write_rust_generic_param(w, Some(&meth_gen_types), m.sig.generics.params.iter());
                                                write!(w, "(").unwrap();
                                                for inp in m.sig.inputs.iter() {
                                                        match inp {
@@ -405,11 +405,11 @@ 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 types.skip_arg(&*arg.ty, Some(&meth_gen_types)) { "_" } else { "" }, ident.ident).unwrap();
+                                                                                       write!(w, ", {}{}: ", if $type_resolver.skip_arg(&*arg.ty, Some(&meth_gen_types)) { "_" } else { "" }, ident.ident).unwrap();
                                                                                }
                                                                                _ => unimplemented!(),
                                                                        }
-                                                                       types.write_rust_type(w, Some(&meth_gen_types), &*arg.ty);
+                                                                       $type_resolver.write_rust_type(w, Some(&meth_gen_types), &*arg.ty);
                                                                }
                                                        }
                                                }
@@ -417,7 +417,7 @@ fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, ty
                                                match &m.sig.output {
                                                        syn::ReturnType::Type(_, rtype) => {
                                                                write!(w, " -> ").unwrap();
-                                                               types.write_rust_type(w, Some(&meth_gen_types), &*rtype)
+                                                               $type_resolver.write_rust_type(w, Some(&meth_gen_types), &*rtype)
                                                        },
                                                        _ => {},
                                                }
@@ -434,16 +434,16 @@ fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, ty
                                                                writeln!(w, "if let Some(f) = self{}.set_{} {{", $impl_accessor, m.sig.ident).unwrap();
                                                                writeln!(w, "\t\t\t(f)(&self{});", $impl_accessor).unwrap();
                                                                write!(w, "\t\t}}\n\t\t").unwrap();
-                                                               types.write_from_c_conversion_to_ref_prefix(w, &*r.elem, Some(&meth_gen_types));
+                                                               $type_resolver.write_from_c_conversion_to_ref_prefix(w, &*r.elem, Some(&meth_gen_types));
                                                                write!(w, "self{}.{}", $impl_accessor, m.sig.ident).unwrap();
-                                                               types.write_from_c_conversion_to_ref_suffix(w, &*r.elem, Some(&meth_gen_types));
+                                                               $type_resolver.write_from_c_conversion_to_ref_suffix(w, &*r.elem, Some(&meth_gen_types));
                                                                writeln!(w, "\n\t}}").unwrap();
                                                                continue;
                                                        }
                                                }
-                                               write_method_var_decl_body(w, &m.sig, "\t", types, Some(&meth_gen_types), true);
+                                               write_method_var_decl_body(w, &m.sig, "\t", $type_resolver, Some(&meth_gen_types), true);
                                                write!(w, "(self{}.{})(", $impl_accessor, m.sig.ident).unwrap();
-                                               write_method_call_params(w, &m.sig, "\t", types, Some(&meth_gen_types), "", true);
+                                               write_method_call_params(w, &m.sig, "\t", $type_resolver, Some(&meth_gen_types), "", true);
 
                                                writeln!(w, "\n\t}}").unwrap();
                                        },
@@ -452,7 +452,7 @@ fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, ty
                                                let mut bounds_iter = t.bounds.iter();
                                                match bounds_iter.next().unwrap() {
                                                        syn::TypeParamBound::Trait(tr) => {
-                                                               writeln!(w, "\ttype {} = crate::{};", t.ident, types.resolve_path(&tr.path, Some(&gen_types))).unwrap();
+                                                               writeln!(w, "\ttype {} = crate::{};", t.ident, $type_resolver.resolve_path(&tr.path, Some(&gen_types))).unwrap();
                                                        },
                                                        _ => unimplemented!(),
                                                }
@@ -500,8 +500,14 @@ fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, ty
                },
                (s, i) => {
                        if let Some(supertrait) = types.crate_types.traits.get(s) {
-                               writeln!(w, "impl lightning::{} for {} {{", s, trait_name).unwrap(); // TODO: Drop hard-coded crate name here
-                               impl_trait_for_c!(supertrait, format!(".{}", i));
+                               let mut module_iter = s.rsplitn(2, "::");
+                               module_iter.next().unwrap();
+                               let supertrait_module = module_iter.next().unwrap();
+                               let imports = ImportResolver::new(supertrait_module.splitn(2, "::").next().unwrap(), &types.crate_types.lib_ast.dependencies,
+                                       supertrait_module, &types.crate_types.lib_ast.modules.get(supertrait_module).unwrap().items);
+                               let resolver = TypeResolver::new(&supertrait_module, imports, types.crate_types);
+                               writeln!(w, "impl {} for {} {{", s, trait_name).unwrap();
+                               impl_trait_for_c!(supertrait, format!(".{}", i), &resolver);
                                writeln!(w, "}}").unwrap();
                                walk_supertraits!(supertrait, Some(&types), (
                                        ("Send", _) => writeln!(w, "unsafe impl Send for {} {{}}", trait_name).unwrap(),
@@ -515,11 +521,11 @@ fn writeln_trait<'a, 'b, W: std::io::Write>(w: &mut W, t: &'a syn::ItemTrait, ty
        ) );
 
        // Finally, implement the original Rust trait for the newly created mapped trait.
-       writeln!(w, "\nuse {}::{}::{} as rust{};", types.orig_crate, types.module_path, t.ident, trait_name).unwrap();
+       writeln!(w, "\nuse {}::{} as rust{};", types.module_path, t.ident, trait_name).unwrap();
        write!(w, "impl rust{}", t.ident).unwrap();
        maybe_write_generics(w, &t.generics, types, false);
        writeln!(w, " for {} {{", trait_name).unwrap();
-       impl_trait_for_c!(t, "");
+       impl_trait_for_c!(t, "", types);
        writeln!(w, "}}\n").unwrap();
        writeln!(w, "// We're essentially a pointer already, or at least a set of pointers, so allow us to be used").unwrap();
        writeln!(w, "// directly as a Deref trait in higher-level structs:").unwrap();
@@ -545,7 +551,7 @@ fn writeln_opaque<W: std::io::Write>(w: &mut W, ident: &syn::Ident, struct_name:
        // If we directly read the original type by its original name, cbindgen hits
        // https://github.com/eqrion/cbindgen/issues/286 Thus, instead, we import it as a temporary
        // name and then reference it by that name, which works around the issue.
-       write!(w, "\nuse {}::{}::{} as native{}Import;\ntype native{} = native{}Import", types.orig_crate, types.module_path, ident, ident, ident, ident).unwrap();
+       write!(w, "\nuse {}::{} as native{}Import;\ntype native{} = native{}Import", types.module_path, ident, ident, ident, ident).unwrap();
        maybe_write_generics(w, &generics, &types, true);
        writeln!(w, ";\n").unwrap();
        writeln!(extra_headers, "struct native{}Opaque;\ntypedef struct native{}Opaque LDKnative{};", ident, ident, ident).unwrap();
@@ -879,9 +885,9 @@ fn writeln_impl<W: std::io::Write>(w: &mut W, i: &syn::ItemImpl, types: &mut Typ
                                                                        t_gen_args += "_"
                                                                }
                                                                if takes_self {
-                                                                       write!(w, "<native{} as {}::{}<{}>>::{}(unsafe {{ &mut *(this_arg as *mut native{}) }}, ", ident, types.orig_crate, $trait_path, t_gen_args, $m.sig.ident, ident).unwrap();
+                                                                       write!(w, "<native{} as {}<{}>>::{}(unsafe {{ &mut *(this_arg as *mut native{}) }}, ", ident, $trait_path, t_gen_args, $m.sig.ident, ident).unwrap();
                                                                } else {
-                                                                       write!(w, "<native{} as {}::{}<{}>>::{}(", ident, types.orig_crate, $trait_path, t_gen_args, $m.sig.ident).unwrap();
+                                                                       write!(w, "<native{} as {}<{}>>::{}(", ident, $trait_path, t_gen_args, $m.sig.ident).unwrap();
                                                                }
 
                                                                let mut real_type = "".to_string();
@@ -1015,7 +1021,7 @@ fn writeln_impl<W: std::io::Write>(w: &mut W, i: &syn::ItemImpl, types: &mut Typ
                                                                        } else if takes_self {
                                                                                write!(w, "unsafe {{ &*this_arg.inner }}.{}(", m.sig.ident).unwrap();
                                                                        } else {
-                                                                               write!(w, "{}::{}::{}(", types.orig_crate, resolved_path, m.sig.ident).unwrap();
+                                                                               write!(w, "{}::{}(", resolved_path, m.sig.ident).unwrap();
                                                                        }
                                                                        write_method_call_params(w, &m.sig, "", types, Some(&meth_gen_types), &ret_type, false);
                                                                        writeln!(w, "\n}}\n").unwrap();
@@ -1141,7 +1147,7 @@ fn writeln_enum<'a, 'b, W: std::io::Write>(w: &mut W, e: &'a syn::ItemEnum, type
                if var.discriminant.is_some() { unimplemented!(); }
                writeln!(w, ",").unwrap();
        }
-       writeln!(w, "}}\nuse {}::{}::{} as native{};\nimpl {} {{", types.orig_crate, types.module_path, e.ident, e.ident, e.ident).unwrap();
+       writeln!(w, "}}\nuse {}::{} as native{};\nimpl {} {{", types.module_path, e.ident, e.ident, e.ident).unwrap();
 
        macro_rules! write_conv {
                ($fn_sig: expr, $to_c: expr, $ref: expr) => {
@@ -1282,7 +1288,7 @@ fn writeln_fn<'a, 'b, W: std::io::Write>(w: &mut W, f: &'a syn::ItemFn, types: &
        write_method_params(w, &f.sig, "", types, Some(&gen_types), false, true);
        write!(w, " {{\n\t").unwrap();
        write_method_var_decl_body(w, &f.sig, "", types, Some(&gen_types), false);
-       write!(w, "{}::{}::{}(", types.orig_crate, types.module_path, f.sig.ident).unwrap();
+       write!(w, "{}::{}(", types.module_path, f.sig.ident).unwrap();
        write_method_call_params(w, &f.sig, "", types, Some(&gen_types), "", false);
        writeln!(w, "\n}}\n").unwrap();
 }
@@ -1294,8 +1300,9 @@ fn writeln_fn<'a, 'b, W: std::io::Write>(w: &mut W, f: &'a syn::ItemFn, types: &
 /// 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.
-fn convert_file<'a, 'b>(libast: &'a FullLibraryAST, crate_types: &CrateTypes<'a>, out_dir: &str, orig_crate: &str, header_file: &mut File, cpp_header_file: &mut File) {
+fn convert_file<'a, 'b>(libast: &'a FullLibraryAST, crate_types: &CrateTypes<'a>, out_dir: &str, header_file: &mut File, cpp_header_file: &mut File) {
        for (module, astmod) in libast.modules.iter() {
+               let orig_crate = module.splitn(2, "::").next().unwrap();
                let ASTModule { ref attrs, ref items, ref submods } = astmod;
                assert_eq!(export_status(&attrs), ExportStatus::Export);
 
@@ -1324,6 +1331,7 @@ fn convert_file<'a, 'b>(libast: &'a FullLibraryAST, crate_types: &CrateTypes<'a>
                if module == "" {
                        // Special-case the top-level lib.rs with various lint allows and a pointer to the c_types
                        // and bitcoin hand-written modules.
+                       writeln!(out, "//! C Bindings").unwrap();
                        writeln!(out, "#![allow(unknown_lints)]").unwrap();
                        writeln!(out, "#![allow(non_camel_case_types)]").unwrap();
                        writeln!(out, "#![allow(non_snake_case)]").unwrap();
@@ -1346,8 +1354,8 @@ fn convert_file<'a, 'b>(libast: &'a FullLibraryAST, crate_types: &CrateTypes<'a>
 
                eprintln!("Converting {} entries...", module);
 
-               let import_resolver = ImportResolver::new(module, items);
-               let mut type_resolver = TypeResolver::new(orig_crate, module, import_resolver, crate_types);
+               let import_resolver = ImportResolver::new(orig_crate, &libast.dependencies, module, items);
+               let mut type_resolver = TypeResolver::new(module, import_resolver, crate_types);
 
                for item in items.iter() {
                        match item {
@@ -1380,7 +1388,7 @@ fn convert_file<'a, 'b>(libast: &'a FullLibraryAST, crate_types: &CrateTypes<'a>
                                                        if type_resolver.is_primitive(&resolved_path) {
                                                                writeln_docs(&mut out, &c.attrs, "");
                                                                writeln!(out, "\n#[no_mangle]").unwrap();
-                                                               writeln!(out, "pub static {}: {} = {}::{}::{};", c.ident, resolved_path, orig_crate, module, c.ident).unwrap();
+                                                               writeln!(out, "pub static {}: {} = {}::{};", c.ident, resolved_path, module, c.ident).unwrap();
                                                        }
                                                }
                                        }
@@ -1422,11 +1430,11 @@ fn convert_file<'a, 'b>(libast: &'a FullLibraryAST, crate_types: &CrateTypes<'a>
        }
 }
 
-fn walk_private_mod<'a>(module: String, items: &'a syn::ItemMod, crate_types: &mut CrateTypes<'a>) {
-       let import_resolver = ImportResolver::new(&module, &items.content.as_ref().unwrap().1);
+fn walk_private_mod<'a>(ast_storage: &'a FullLibraryAST, orig_crate: &str, module: String, items: &'a syn::ItemMod, crate_types: &mut CrateTypes<'a>) {
+       let import_resolver = ImportResolver::new(orig_crate, &ast_storage.dependencies, &module, &items.content.as_ref().unwrap().1);
        for item in items.content.as_ref().unwrap().1.iter() {
                match item {
-                       syn::Item::Mod(m) => walk_private_mod(format!("{}::{}", module, m.ident), m, crate_types),
+                       syn::Item::Mod(m) => walk_private_mod(ast_storage, orig_crate, format!("{}::{}", module, m.ident), m, crate_types),
                        syn::Item::Impl(i) => {
                                if let &syn::Type::Path(ref p) = &*i.self_ty {
                                        if let Some(trait_path) = i.trait_.as_ref() {
@@ -1451,7 +1459,8 @@ fn walk_ast<'a>(ast_storage: &'a FullLibraryAST, crate_types: &mut CrateTypes<'a
        for (module, astmod) in ast_storage.modules.iter() {
                let ASTModule { ref attrs, ref items, submods: _ } = astmod;
                assert_eq!(export_status(&attrs), ExportStatus::Export);
-               let import_resolver = ImportResolver::new(module, items);
+               let orig_crate = module.splitn(2, "::").next().unwrap();
+               let import_resolver = ImportResolver::new(orig_crate, &ast_storage.dependencies, module, items);
 
                for item in items.iter() {
                        match item {
@@ -1557,7 +1566,7 @@ fn walk_ast<'a>(ast_storage: &'a FullLibraryAST, crate_types: &mut CrateTypes<'a
                                                }
                                        }
                                },
-                               syn::Item::Mod(m) => walk_private_mod(format!("{}::{}", module, m.ident), m, crate_types),
+                               syn::Item::Mod(m) => walk_private_mod(ast_storage, orig_crate, format!("{}::{}", module, m.ident), m, crate_types),
                                _ => {},
                        }
                }
@@ -1566,17 +1575,17 @@ fn walk_ast<'a>(ast_storage: &'a FullLibraryAST, crate_types: &mut CrateTypes<'a
 
 fn main() {
        let args: Vec<String> = env::args().collect();
-       if args.len() != 6 {
-               eprintln!("Usage: target/dir source_crate_name derived_templates.rs extra/includes.h extra/cpp/includes.hpp");
+       if args.len() != 5 {
+               eprintln!("Usage: target/dir derived_templates.rs extra/includes.h extra/cpp/includes.hpp");
                process::exit(1);
        }
 
        let mut derived_templates = std::fs::OpenOptions::new().write(true).create(true).truncate(true)
-               .open(&args[3]).expect("Unable to open new header file");
+               .open(&args[2]).expect("Unable to open new header file");
        let mut header_file = std::fs::OpenOptions::new().write(true).create(true).truncate(true)
-               .open(&args[4]).expect("Unable to open new header file");
+               .open(&args[3]).expect("Unable to open new header file");
        let mut cpp_header_file = std::fs::OpenOptions::new().write(true).create(true).truncate(true)
-               .open(&args[5]).expect("Unable to open new header file");
+               .open(&args[4]).expect("Unable to open new header file");
 
        writeln!(header_file, "#if defined(__GNUC__)").unwrap();
        writeln!(header_file, "#define MUST_USE_STRUCT __attribute__((warn_unused))").unwrap();
@@ -1605,7 +1614,7 @@ fn main() {
        walk_ast(&libast, &mut libtypes);
 
        // ... finally, do the actual file conversion/mapping, writing out types as we go.
-       convert_file(&libast, &libtypes, &args[1], &args[2], &mut header_file, &mut cpp_header_file);
+       convert_file(&libast, &libtypes, &args[1], &mut header_file, &mut cpp_header_file);
 
        // For container templates which we created while walking the crate, make sure we add C++
        // mapped types so that C++ users can utilize the auto-destructors available.