Fix LDKRecoverableSignature variable parsing
[ldk-java] / genbindings.py
index 1d01ac6cff1f16a16fc48073f9defd98705acf0a..76c1a5f61a71f7632aa4784a4557425aa8ce4f56 100755 (executable)
@@ -31,7 +31,7 @@ else:
     sys.exit(1)
 
 
-consts = Consts(DEBUG, target=target)
+consts = Consts(DEBUG, target=target, outdir=sys.argv[4])
 
 local_git_version = os.getenv("LDK_GARBAGECOLLECTED_GIT_OVERRIDE")
 if local_git_version is None:
@@ -150,7 +150,7 @@ def java_c_types(fn_arg, ret_arr_len):
         rust_obj = "LDKSignature"
         arr_access = "compact_form"
     elif fn_arg.startswith("LDKRecoverableSignature"):
-        fn_arg = "uint8_t (*" + fn_arg[25:] + ")[68]"
+        fn_arg = "uint8_t (*" + fn_arg[24:] + ")[68]"
         assert var_is_arr_regex.match(fn_arg[8:])
         rust_obj = "LDKRecoverableSignature"
         arr_access = "serialized_form"
@@ -174,10 +174,10 @@ def java_c_types(fn_arg, ret_arr_len):
         assert var_is_arr_regex.match(fn_arg[8:])
         rust_obj = "LDKTwentyBytes"
         arr_access = "data"
-    elif fn_arg.startswith("LDKTenBytes"):
-        fn_arg = "uint8_t (*" + fn_arg[12:] + ")[10]"
+    elif fn_arg.startswith("LDKTwelveBytes"):
+        fn_arg = "uint8_t (*" + fn_arg[15:] + ")[12]"
         assert var_is_arr_regex.match(fn_arg[8:])
-        rust_obj = "LDKTenBytes"
+        rust_obj = "LDKTwelveBytes"
         arr_access = "data"
     elif fn_arg.startswith("LDKu8slice"):
         fn_arg = "uint8_t (*" + fn_arg[11:] + ")[datalen]"
@@ -410,10 +410,14 @@ with open(sys.argv[1]) as in_h, open(f"{sys.argv[2]}/bindings{consts.file_ext}",
             struct_meth = method_name.rsplit("Z", 1)[0][1:] + "Z"
             expected_struct = "LDKC" + struct_meth
             struct_meth_name = method_name[len(struct_meth) + 1:].strip("_")
-        elif method_name.startswith("C2Tuple"):
+        elif method_name.startswith("C2Tuple") or method_name.startswith("C3Tuple"):
             tuple_name = method_name.rsplit("Z", 1)[0][2:] + "Z"
-            struct_meth = "Two" + tuple_name
-            expected_struct = "LDKC2" + tuple_name
+            if method_name.startswith("C2Tuple"):
+                struct_meth = "Two" + tuple_name
+                expected_struct = "LDKC2" + tuple_name
+            else:
+                struct_meth = "Three" + tuple_name
+                expected_struct = "LDKC3" + tuple_name
             struct_meth_name = method_name[len(tuple_name) + 2:].strip("_")
         else:
             struct_meth = method_name.split("_")[0]
@@ -426,6 +430,15 @@ with open(sys.argv[1]) as in_h, open(f"{sys.argv[2]}/bindings{consts.file_ext}",
         else:
             return_type_info = type_mapping_generator.map_type(method_return_type.strip() + " ret", True, ret_arr_len, False, force_holds_ref)
 
+        if method_name.endswith("_clone") and expected_struct not in unitary_enums:
+            meth_line = "uintptr_t " + expected_struct.replace("LDK", "") + "_clone_ptr(" + expected_struct + " *NONNULL_PTR arg)"
+            write_c("static inline " + meth_line + " {\n")
+            write_c("\t" + return_type_info.ret_conv[0].replace("\n", "\n\t"))
+            write_c(method_name + "(arg)")
+            write_c(return_type_info.ret_conv[1])
+            write_c("\n\treturn " + return_type_info.ret_conv_name + ";\n}\n")
+            map_fn(meth_line + ";\n", re.compile("(uintptr_t) ([A-Za-z_0-9]*)\((.*)\)").match(meth_line), None, None, None)
+
         argument_types = []
         default_constructor_args = {}
         takes_self = False
@@ -523,7 +536,7 @@ with open(sys.argv[1]) as in_h, open(f"{sys.argv[2]}/bindings{consts.file_ext}",
                   or method_name.endswith("_read"))):
             out_java_struct = open(f"{sys.argv[3]}/structs/UtilMethods{consts.file_ext}", "a")
             for line in out_java_struct_delta.splitlines():
-                if not line.strip().startswith("this."):
+                if "this" not in line:
                     out_java_struct.write(line + "\n")
                 else:
                     out_java_struct.write("\t\t// " + line.strip() + "\n")
@@ -664,88 +677,43 @@ with open(sys.argv[1]) as in_h, open(f"{sys.argv[2]}/bindings{consts.file_ext}",
     def map_result(struct_name, res_ty, err_ty):
         result_types.add(struct_name)
         human_ty = struct_name.replace("LDKCResult", "Result")
+        res_map = type_mapping_generator.map_type(res_ty + " res", True, None, False, True)
+        err_map = type_mapping_generator.map_type(err_ty + " err", True, None, False, True)
+        java_hu_struct = consts.map_result(struct_name, res_map, err_map)
+        create_getter(struct_name, res_ty, "ok", ("*", "->contents.result"), ("", "->result_ok"))
+        create_getter(struct_name, err_ty, "err", ("*", "->contents.err"), ("!", "->result_ok"))
         with open(f"{sys.argv[3]}/structs/{human_ty}{consts.file_ext}", "w") as out_java_struct:
-            out_java_struct.write(consts.hu_struct_file_prefix)
-            out_java_struct.write("public class " + human_ty + " extends CommonBase {\n")
-            out_java_struct.write("\tprivate " + human_ty + "(Object _dummy, long ptr) { super(ptr); }\n")
-            out_java_struct.write("\tprotected void finalize() throws Throwable {\n")
-            out_java_struct.write("\t\tif (ptr != 0) { bindings." + struct_name.replace("LDK","") + "_free(ptr); } super.finalize();\n")
-            out_java_struct.write("\t}\n\n")
-            out_java_struct.write("\tstatic " + human_ty + " constr_from_ptr(long ptr) {\n")
-            out_java_struct.write("\t\tif (bindings." + struct_name + "_result_ok(ptr)) {\n")
-            out_java_struct.write("\t\t\treturn new " + human_ty + "_OK(null, ptr);\n")
-            out_java_struct.write("\t\t} else {\n")
-            out_java_struct.write("\t\t\treturn new " + human_ty + "_Err(null, ptr);\n")
-            out_java_struct.write("\t\t}\n")
-            out_java_struct.write("\t}\n")
-
-            res_map = type_mapping_generator.map_type(res_ty + " res", True, None, False, True)
-            err_map = type_mapping_generator.map_type(err_ty + " err", True, None, False, True)
-            can_clone = True
-            if not res_map.is_native_primitive and (res_map.rust_obj.replace("LDK", "") + "_clone" not in clone_fns):
-                can_clone = False
-            if not err_map.is_native_primitive and (err_map.rust_obj.replace("LDK", "") + "_clone" not in clone_fns):
-                can_clone = False
-
-            out_java.write("\tpublic static native boolean " + struct_name + "_result_ok(long arg);\n")
-            write_c(consts.c_fn_ty_pfx + "jboolean " + consts.c_fn_name_define_pfx(struct_name + "_result_ok", True) + consts.ptr_c_ty + " arg) {\n")
-            write_c("\treturn ((" + struct_name + "*)arg)->result_ok;\n")
-            write_c("}\n")
-
-            out_java.write("\tpublic static native " + res_map.java_ty + " " + struct_name + "_get_ok(long arg);\n")
-            write_c(consts.c_fn_ty_pfx + res_map.c_ty + " " + consts.c_fn_name_define_pfx(struct_name + "_get_ok", True) + consts.ptr_c_ty + " arg) {\n")
-            write_c("\t" + struct_name + " *val = (" + struct_name + "*)(arg & ~1);\n")
-            write_c("\tCHECK(val->result_ok);\n\t")
-            out_java_struct.write("\tpublic static final class " + human_ty + "_OK extends " + human_ty + " {\n")
-            if res_map.ret_conv is not None:
-                write_c(res_map.ret_conv[0].replace("\n", "\n\t") + "(*val->contents.result)")
-                write_c(res_map.ret_conv[1].replace("\n", "\n\t") + "\n\treturn " + res_map.ret_conv_name)
-            else:
-                write_c("return *val->contents.result")
-            write_c(";\n}\n")
-
-            if res_map.java_hu_ty != "void":
-                out_java_struct.write("\t\tpublic final " + res_map.java_hu_ty + " res;\n")
-            out_java_struct.write("\t\tprivate " + human_ty + "_OK(Object _dummy, long ptr) {\n")
-            out_java_struct.write("\t\t\tsuper(_dummy, ptr);\n")
-            if res_map.java_hu_ty == "void":
-                pass
-            elif res_map.to_hu_conv is not None:
-                out_java_struct.write("\t\t\t" + res_map.java_ty + " res = bindings." + struct_name + "_get_ok(ptr);\n")
-                out_java_struct.write("\t\t\t" + res_map.to_hu_conv.replace("\n", "\n\t\t\t"))
-                out_java_struct.write("\n\t\t\tthis.res = " + res_map.to_hu_conv_name + ";\n")
-            else:
-                out_java_struct.write("\t\t\tthis.res = bindings." + struct_name + "_get_ok(ptr);\n")
-            out_java_struct.write("\t\t}\n")
-            out_java_struct.write("\t}\n\n")
-
-            out_java.write("\tpublic static native " + err_map.java_ty + " " + struct_name + "_get_err(long arg);\n")
-            write_c(consts.c_fn_ty_pfx + err_map.c_ty + " " + consts.c_fn_name_define_pfx(struct_name + "_get_err", True) + consts.ptr_c_ty + " arg) {\n")
-            write_c("\t" + struct_name + " *val = (" + struct_name + "*)(arg & ~1);\n")
-            write_c("\tCHECK(!val->result_ok);\n\t")
-            out_java_struct.write("\tpublic static final class " + human_ty + "_Err extends " + human_ty + " {\n")
-            if err_map.ret_conv is not None:
-                write_c(err_map.ret_conv[0].replace("\n", "\n\t") + "(*val->contents.err)")
-                write_c(err_map.ret_conv[1].replace("\n", "\n\t") + "\n\treturn " + err_map.ret_conv_name)
-            else:
-                write_c("return *val->contents.err")
-            write_c(";\n}\n")
-
-            if err_map.java_hu_ty != "void":
-                out_java_struct.write("\t\tpublic final " + err_map.java_hu_ty + " err;\n")
-            out_java_struct.write("\t\tprivate " + human_ty + "_Err(Object _dummy, long ptr) {\n")
-            out_java_struct.write("\t\t\tsuper(_dummy, ptr);\n")
-            if err_map.java_hu_ty == "void":
-                pass
-            elif err_map.to_hu_conv is not None:
-                out_java_struct.write("\t\t\t" + err_map.java_ty + " err = bindings." + struct_name + "_get_err(ptr);\n")
-                out_java_struct.write("\t\t\t" + err_map.to_hu_conv.replace("\n", "\n\t\t\t"))
-                out_java_struct.write("\n\t\t\tthis.err = " + err_map.to_hu_conv_name + ";\n")
-            else:
-                out_java_struct.write("\t\t\tthis.err = bindings." + struct_name + "_get_err(ptr);\n")
-            out_java_struct.write("\t\t}\n")
-
-            out_java_struct.write("\t}\n\n")
+            out_java_struct.write(java_hu_struct)
+
+    def create_getter(struct_name, field_decl, field_name, accessor, check_sfx):
+        field_ty = java_c_types(field_decl + " " + field_name, None)
+        ptr_fn_defn = field_decl + " *" + struct_name.replace("LDK", "") + "_get_" + field_name + "(" + struct_name + " *NONNULL_PTR owner)"
+        owned_fn_defn = field_decl + " " + struct_name.replace("LDK", "") + "_get_" + field_name + "(" + struct_name + " *NONNULL_PTR owner)"
+
+        holds_ref = False
+        if field_ty.rust_obj is not None and field_ty.rust_obj.replace("LDK", "") + "_clone" in clone_fns:
+            fn_defn = owned_fn_defn
+            write_c("static inline " + fn_defn + "{\n")
+            if check_sfx is not None:
+                write_c("CHECK(" + check_sfx[0] + "owner" + check_sfx[1] + ");\n")
+            write_c("\treturn " + field_ty.rust_obj.replace("LDK", "") + "_clone(&" + accessor[0] + "owner" + accessor[1] + ");\n")
+        elif field_ty.arr_len is not None or field_ty.is_native_primitive or field_ty.rust_obj in unitary_enums:
+            fn_defn = owned_fn_defn
+            write_c("static inline " + fn_defn + "{\n")
+            if check_sfx is not None:
+                write_c("CHECK(" + check_sfx[0] + "owner" + check_sfx[1] + ");\n")
+            write_c("\treturn " + accessor[0] + "owner" + accessor[1] + ";\n")
+            holds_ref = True
+        else:
+            fn_defn = ptr_fn_defn
+            write_c("static inline " + fn_defn + "{\n")
+            if check_sfx is not None:
+                write_c("CHECK(" + check_sfx[0] + "owner" + check_sfx[1] + ");\n")
+            write_c("\treturn &" + accessor[0] + "owner" + accessor[1] + ";\n")
+            holds_ref = True
+        write_c("}\n")
+        dummy_line = fn_defn + ";\n"
+        map_fn_with_ref_option(dummy_line, reg_fn_regex.match(dummy_line), None, None, "", holds_ref)
 
     def map_tuple(struct_name, field_lines):
         human_ty = struct_name.replace("LDKC2Tuple", "TwoTuple").replace("LDKC3Tuple", "ThreeTuple")
@@ -762,27 +730,7 @@ with open(sys.argv[1]) as in_h, open(f"{sys.argv[2]}/bindings{consts.file_ext}",
             if idx != 0 and idx < len(field_lines) - 2:
                 field_name = chr(ord('a') + idx - 1)
                 assert line.endswith(" " + field_name + ";")
-                field_ty = java_c_types(line[:-1], None)
-                ptr_fn_defn = line[:-3].strip() + " *" + struct_name.replace("LDK", "") + "_get_" + field_name + "(" + struct_name + " *NONNULL_PTR tuple)"
-                owned_fn_defn = line[:-3].strip() + " " + struct_name.replace("LDK", "") + "_get_" + field_name + "(" + struct_name + " *NONNULL_PTR tuple)"
-
-                holds_ref = False
-                if field_ty.rust_obj is not None and field_ty.rust_obj.replace("LDK", "") + "_clone" in clone_fns:
-                    fn_defn = owned_fn_defn
-                    write_c("static inline " + fn_defn + "{\n")
-                    write_c("\treturn " + field_ty.rust_obj.replace("LDK", "") + "_clone(&tuple->" + field_name + ");\n")
-                elif field_ty.arr_len is not None or field_ty.is_native_primitive:
-                    fn_defn = owned_fn_defn
-                    write_c("static inline " + fn_defn + "{\n")
-                    write_c("\treturn tuple->" + field_name + ";\n")
-                else:
-                    fn_defn = ptr_fn_defn
-                    write_c("static inline " + fn_defn + "{\n")
-                    write_c("\treturn &tuple->" + field_name + ";\n")
-                    holds_ref = True
-                write_c("}\n")
-                dummy_line = fn_defn + ";\n"
-                map_fn_with_ref_option(dummy_line, reg_fn_regex.match(dummy_line), None, None, "", holds_ref)
+                create_getter(struct_name, line[:-3].strip(), field_name, ("", "->" + field_name), None)
 
     out_java.write(consts.bindings_header)
     with open(f"{sys.argv[2]}/version{consts.file_ext}", "w") as out_java_version:
@@ -847,7 +795,7 @@ with open(sys.argv[1]) as in_h, open(f"{sys.argv[2]}/bindings{consts.file_ext}",
                             last_struct_block_comment = block_comment.strip("\n")
                             block_comment = None
                         else:
-                            block_comment = block_comment + "\n" + struct_line.strip(" /*")
+                            block_comment = block_comment + "\n" + struct_line.strip(" /*").replace("…", "...")
                     else:
                         struct_name_match = struct_name_regex.match(struct_line)
                         if struct_name_match is not None:
@@ -912,33 +860,6 @@ with open(sys.argv[1]) as in_h, open(f"{sys.argv[2]}/bindings{consts.file_ext}",
                     map_tuple(struct_name, field_lines)
                 elif vec_ty is not None:
                     ty_info = type_mapping_generator.map_type(vec_ty + " arr_elem", False, None, False, False)
-                    if len(ty_info.java_fn_ty_arg) == 1: # ie we're a primitive of some form
-                        out_java.write("\tpublic static native long " + struct_name + "_new(" + ty_info.java_ty + "[] elems);\n")
-                        write_c(consts.c_fn_ty_pfx + consts.ptr_c_ty + " " + consts.c_fn_name_define_pfx(struct_name + "_new", True) + ty_info.c_ty + "Array elems) {\n")
-                        write_c("\t" + struct_name + " *ret = MALLOC(sizeof(" + struct_name + "), \"" + struct_name + "\");\n")
-                        write_c("\tret->datalen = " + consts.get_native_arr_len_call[0] + "elems" + consts.get_native_arr_len_call[1] + ";\n")
-                        write_c("\tif (ret->datalen == 0) {\n")
-                        write_c("\t\tret->data = NULL;\n")
-                        write_c("\t} else {\n")
-                        write_c("\t\tret->data = MALLOC(sizeof(" + vec_ty + ") * ret->datalen, \"" + struct_name + " Data\");\n")
-                        native_arr_ptr_call = consts.get_native_arr_ptr_call(ty_info.ty_info)
-                        write_c("\t\t" + ty_info.c_ty + " *java_elems = " + native_arr_ptr_call[0] + "elems" + native_arr_ptr_call[1] + ";\n")
-                        write_c("\t\tfor (size_t i = 0; i < ret->datalen; i++) {\n")
-                        if ty_info.arg_conv is not None:
-                            write_c("\t\t\t" + ty_info.c_ty + " arr_elem = java_elems[i];\n")
-                            write_c("\t\t\t" + ty_info.arg_conv.replace("\n", "\n\t\t\t") + "\n")
-                            write_c("\t\t\tret->data[i] = " + ty_info.arg_conv_name + ";\n")
-                            assert ty_info.arg_conv_cleanup is None
-                        else:
-                            write_c("\t\t\tret->data[i] = java_elems[i];\n")
-                        write_c("\t\t}\n")
-                        cleanup = consts.release_native_arr_ptr_call(ty_info.ty_info, "elems", "java_elems")
-                        if cleanup is not None:
-                            write_c("\t\t" + cleanup + ";\n")
-                        write_c("\t}\n")
-                        write_c("\treturn (uint64_t)ret;\n")
-                        write_c("}\n")
-
                     if ty_info.is_native_primitive:
                         clone_fns.add(struct_name.replace("LDK", "") + "_clone")
                         write_c("static inline " + struct_name + " " + struct_name.replace("LDK", "") + "_clone(const " + struct_name + " *orig) {\n")
@@ -991,30 +912,7 @@ with open(sys.argv[1]) as in_h, open(f"{sys.argv[2]}/bindings{consts.file_ext}",
                 elif struct_name == "LDKTxOut":
                     with open(f"{sys.argv[3]}/structs/TxOut{consts.file_ext}", "w") as out_java_struct:
                         out_java_struct.write(consts.hu_struct_file_prefix)
-                        out_java_struct.write("public class TxOut extends CommonBase{\n")
-                        out_java_struct.write("\t/** The script_pubkey in this output */\n")
-                        out_java_struct.write("\tpublic final byte[] script_pubkey;\n")
-                        out_java_struct.write("\t/** The value, in satoshis, of this output */\n")
-                        out_java_struct.write("\tpublic final long value;\n")
-                        out_java_struct.write("\n")
-                        out_java_struct.write("\tTxOut(java.lang.Object _dummy, long ptr) {\n")
-                        out_java_struct.write("\t\tsuper(ptr);\n")
-                        out_java_struct.write("\t\tthis.script_pubkey = bindings.TxOut_get_script_pubkey(ptr);\n")
-                        out_java_struct.write("\t\tthis.value = bindings.TxOut_get_value(ptr);\n")
-                        out_java_struct.write("\t}\n")
-                        out_java_struct.write("\tpublic TxOut(long value, byte[] script_pubkey) {\n")
-                        out_java_struct.write("\t\tsuper(bindings.TxOut_new(script_pubkey, value));\n")
-                        out_java_struct.write("\t\tthis.script_pubkey = bindings.TxOut_get_script_pubkey(ptr);\n")
-                        out_java_struct.write("\t\tthis.value = bindings.TxOut_get_value(ptr);\n")
-                        out_java_struct.write("\t}\n")
-                        out_java_struct.write("\n")
-                        out_java_struct.write("\t@Override @SuppressWarnings(\"deprecation\")\n")
-                        out_java_struct.write("\tprotected void finalize() throws Throwable {\n")
-                        out_java_struct.write("\t\tsuper.finalize();\n")
-                        out_java_struct.write("\t\tif (ptr != 0) { bindings.TxOut_free(ptr); }\n")
-                        out_java_struct.write("\t}\n")
-                        out_java_struct.write("\n")
-                        out_java_struct.write("}")
+                        out_java_struct.write(consts.txout_defn)
                         fn_line = "struct LDKCVec_u8Z TxOut_get_script_pubkey (struct LDKTxOut* thing)"
                         write_c(fn_line + " {")
                         write_c("\treturn CVec_u8Z_clone(&thing->script_pubkey);")
@@ -1086,3 +984,4 @@ with open(f"{sys.argv[4]}/version.c", "w") as out_c:
     out_c.write(consts.c_version_file.replace('<git_version_ldk_garbagecollected>', local_git_version))
 with open(f"{sys.argv[3]}/structs/UtilMethods{consts.file_ext}", "a") as util:
     util.write(consts.util_fn_sfx)
+consts.cleanup()