Make String types language-specific and fix TS string conversion
[ldk-java] / genbindings.py
index 1443a41ac6aaa2e68a4de02546d7f273e07b68d1..34434b2ee33e4327b29073bb58d20b3861a11e33 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"
@@ -279,18 +279,21 @@ def java_c_types(fn_arg, ret_arr_len):
             c_ty = "int64_t"
             fn_arg = fn_arg[8:].strip()
         else:
+            java_ty = consts.ptr_native_ty
             c_ty = "int64_t"
             rust_obj = "uintptr_t"
             fn_arg = fn_arg[9:].strip()
         is_primitive = True
     elif is_const and fn_arg.startswith("char *"):
-        java_ty = "String"
+        java_ty = consts.java_type_map["String"]
+        java_hu_ty = consts.java_hu_type_map["String"]
         c_ty = "const char*"
         fn_ty_arg = "Ljava/lang/String;"
         fn_arg = fn_arg[6:].strip()
     elif fn_arg.startswith("LDKStr"):
         rust_obj = "LDKStr"
-        java_ty = "String"
+        java_ty = consts.java_type_map["String"]
+        java_hu_ty = consts.java_hu_type_map["String"]
         c_ty = "jstring"
         fn_ty_arg = "Ljava/lang/String;"
         fn_arg = fn_arg[6:].strip()
@@ -431,13 +434,13 @@ with open(sys.argv[1]) as in_h, open(f"{sys.argv[2]}/bindings{consts.file_ext}",
             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 = "uint64_t " + expected_struct.replace("LDK", "") + "_clone_ptr(" + expected_struct + " *NONNULL_PTR arg)"
+            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("(uint64_t) ([A-Za-z_0-9]*)\((.*)\)").match(meth_line), None, None, None)
+            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 = {}
@@ -488,12 +491,34 @@ with open(sys.argv[1]) as in_h, open(f"{sys.argv[2]}/bindings{consts.file_ext}",
                             default_constructor_args[argument_conversion_info.arg_name] = []
                         default_constructor_args[argument_conversion_info.arg_name].append(explode_arg_conv)
             argument_types.append(argument_conversion_info)
+
         if not takes_self and return_type_info.java_hu_ty != struct_meth:
             if not return_type_info.java_hu_ty.startswith("Result_" + struct_meth):
                 struct_meth_name = method_name
                 struct_meth = ""
                 expected_struct = ""
 
+        impl_on_struct = (expected_struct in opaque_structs or expected_struct in trait_structs or
+            expected_struct in complex_enums or expected_struct in complex_enums or
+            expected_struct in result_types or expected_struct in tuple_types) and not is_free
+        impl_on_utils = not impl_on_struct and (not is_free and not method_name.endswith("_clone") and
+            not method_name.startswith("TxOut") and
+            not method_name.startswith("_") and
+            method_name != "check_platform" and method_name != "Result_read" and
+            not expected_struct in unitary_enums and
+            ((not method_name.startswith("C2Tuple_") and not method_name.startswith("C3Tuple_"))
+              or method_name.endswith("_read")))
+
+        # If we're adding a static method, and it returns a primitive or an array of primitives,
+        # and a variable conversion adds a reference on the return type (via `this`), skip the
+        # variable's conversion reference-add (as we obviously cannot need a reference).
+        if impl_on_utils and (return_type_info.is_native_primitive or
+                (return_type_info.ty_info.subty is not None and return_type_info.ty_info.subty.is_native_primitive)):
+            for arg in argument_types:
+                if arg.from_hu_conv is not None and arg.from_hu_conv[1] != "":
+                    if "this" in arg.from_hu_conv[1]:
+                        arg.from_hu_conv = (arg.from_hu_conv[0], "")
+
         out_java.write("\t// " + line)
         (out_java_delta, out_c_delta, out_java_struct_delta) = \
             consts.map_function(argument_types, c_call_string, method_name, struct_meth_name, return_type_info, struct_meth, default_constructor_args, takes_self, takes_self_ptr, args_known, type_mapping_generator, doc_comment)
@@ -522,24 +547,13 @@ with open(sys.argv[1]) as in_h, open(f"{sys.argv[2]}/bindings{consts.file_ext}",
             write_c(out_c_delta)
 
         out_java_struct = None
-        if (expected_struct in opaque_structs or expected_struct in trait_structs
-                or expected_struct in complex_enums or expected_struct in complex_enums
-                or expected_struct in result_types or expected_struct in tuple_types) and not is_free:
+        if impl_on_struct:
             out_java_struct = open(f"{sys.argv[3]}/structs/{struct_meth}{consts.file_ext}", "a")
             out_java_struct.write(out_java_struct_delta)
-        elif (not is_free and not method_name.endswith("_clone") and
-                not method_name.startswith("TxOut") and
-                not method_name.startswith("_") and
-                method_name != "check_platform" and method_name != "Result_read" and
-                not expected_struct in unitary_enums and
-                ((not method_name.startswith("C2Tuple_") and not method_name.startswith("C3Tuple_"))
-                  or method_name.endswith("_read"))):
+        elif impl_on_utils:
             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."):
-                    out_java_struct.write(line + "\n")
-                else:
-                    out_java_struct.write("\t\t// " + line.strip() + "\n")
+                out_java_struct.write(line + "\n")
 
     def map_unitary_enum(struct_name, field_lines, enum_doc_comment):
         assert struct_name.startswith("LDK")
@@ -677,65 +691,13 @@ 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.replace("LDK", "") + "_is_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
-
-            create_getter(struct_name, res_ty, "ok", ("*", "->contents.result"), ("", "->result_ok"))
-            create_getter(struct_name, err_ty, "err", ("*", "->contents.err"), ("!", "->result_ok"))
-
-            out_java_struct.write("\tpublic static final class " + human_ty + "_OK extends " + human_ty + " {\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.replace("LDK", "") + "_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.replace("LDK", "") + "_get_ok(ptr);\n")
-            out_java_struct.write("\t\t}\n")
-            out_java_struct.write("\t}\n\n")
-
-            out_java_struct.write("\tpublic static final class " + human_ty + "_Err extends " + human_ty + " {\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.replace("LDK", "") + "_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.replace("LDK", "") + "_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)
@@ -755,6 +717,7 @@ with open(sys.argv[1]) as in_h, open(f"{sys.argv[2]}/bindings{consts.file_ext}",
             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")
@@ -963,30 +926,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);")
@@ -1058,3 +998,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()