Fix short, push trait struct refcnt increment down to lang
[ldk-java] / gen_type_mapping.py
1 from bindingstypes import ConvInfo
2
3 class TypeMappingGenerator:
4
5     def __init__(self, java_c_types, consts, c_array_class_caches, opaque_structs, clone_fns, unitary_enums, trait_structs, complex_enums, result_types, tuple_types):
6         # trick our way around circular imports
7         self.java_c_types = java_c_types
8         self.consts = consts
9         self.c_array_class_caches = c_array_class_caches
10         self.opaque_structs = opaque_structs
11         self.clone_fns = clone_fns
12         self.unitary_enums = unitary_enums
13         self.trait_structs = trait_structs
14         self.complex_enums = complex_enums
15         self.result_types = result_types
16         self.tuple_types = tuple_types
17
18     def map_type(self, fn_arg, print_void, ret_arr_len, is_free, holds_ref):
19         ty_info = self.java_c_types(fn_arg, ret_arr_len)
20         mapped_info = self.map_type_with_info(ty_info, print_void, ret_arr_len, is_free, holds_ref)
21         return mapped_info
22
23     def map_type_with_info(self, ty_info, print_void, ret_arr_len, is_free, holds_ref):
24         if ty_info.c_ty == "void":
25             if not print_void:
26                 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
27                     arg_conv = None, arg_conv_name = None, arg_conv_cleanup = None,
28                     ret_conv = None, ret_conv_name = None, to_hu_conv = None, to_hu_conv_name = None, from_hu_conv = None)
29         if ty_info.c_ty.endswith("Array"):
30             arr_len = ty_info.arr_len
31             if arr_len is not None:
32                 arr_name = ty_info.var_name
33             else:
34                 arr_name = "ret"
35                 arr_len = ret_arr_len
36             if ty_info.c_ty == "int8_tArray":
37                 (set_pfx, set_sfx) = self.consts.set_native_arr_contents(arr_name + "_arr", arr_len, ty_info)
38                 ret_conv = ("int8_tArray " + arr_name + "_arr = " + self.consts.create_native_arr_call(arr_len, ty_info) + ";\n" + set_pfx, "")
39                 arg_conv_cleanup = None
40                 if not arr_len.isdigit():
41                     arg_conv = ty_info.rust_obj + " " + arr_name + "_ref;\n"
42                     arg_conv = arg_conv + arr_name + "_ref." + arr_len + " = " +  self.consts.get_native_arr_len_call[0] + arr_name + self.consts.get_native_arr_len_call[1] + ";\n"
43                     if (not ty_info.is_ptr or not holds_ref) and ty_info.rust_obj != "LDKu8slice":
44                         arg_conv = arg_conv + arr_name + "_ref." + ty_info.arr_access + " = MALLOC(" + arr_name + "_ref." + arr_len + ", \"" + ty_info.rust_obj + " Bytes\");\n"
45                         arg_conv = arg_conv + self.consts.get_native_arr_contents(arr_name, arr_name + "_ref." + ty_info.arr_access, arr_name + "_ref." + arr_len, ty_info, True) + ";"
46                     else:
47                         arg_conv = arg_conv + arr_name + "_ref." + ty_info.arr_access + " = " + self.consts.get_native_arr_contents(arr_name, "NO_DEST", arr_name + "_ref." + arr_len, ty_info, False) + ";"
48                         arg_conv_cleanup = self.consts.cleanup_native_arr_ref_contents(arr_name, arr_name + "_ref." + ty_info.arr_access, arr_name + "_ref." + arr_len, ty_info)
49                     if ty_info.rust_obj == "LDKTransaction":
50                         arg_conv = arg_conv + "\n" + arr_name + "_ref.data_is_owned = " + str(holds_ref).lower() + ";"
51                     ret_conv = (ty_info.rust_obj + " " + arr_name + "_var = ", "")
52                     ret_conv = (ret_conv[0], ";\nint8_tArray " + arr_name + "_arr = " + self.consts.create_native_arr_call(arr_name + "_var." + arr_len, ty_info) + ";\n")
53                     (pfx, sfx) = self.consts.set_native_arr_contents(arr_name + "_arr", arr_name + "_var." + arr_len, ty_info)
54                     ret_conv = (ret_conv[0], ret_conv[1] + pfx + arr_name + "_var." + ty_info.arr_access + sfx + ";")
55                     if not holds_ref and ty_info.rust_obj != "LDKu8slice":
56                         ret_conv = (ret_conv[0], ret_conv[1] + "\n" + ty_info.rust_obj.replace("LDK", "") + "_free(" + arr_name + "_var);")
57                 elif ty_info.rust_obj is not None:
58                     arg_conv = ty_info.rust_obj + " " + arr_name + "_ref;\n"
59                     arg_conv = arg_conv + "CHECK(" + self.consts.get_native_arr_len_call[0] + arr_name + self.consts.get_native_arr_len_call[1] + " == " + arr_len + ");\n"
60                     arg_conv = arg_conv + self.consts.get_native_arr_contents(arr_name, arr_name + "_ref." + ty_info.arr_access, arr_len, ty_info, True) + ";"
61                     ret_conv = (ret_conv[0], "." + ty_info.arr_access + set_sfx + ";")
62                 else:
63                     arg_conv = "unsigned char " + arr_name + "_arr[" + arr_len + "];\n"
64                     arg_conv = arg_conv + "CHECK(" + self.consts.get_native_arr_len_call[0] + arr_name + self.consts.get_native_arr_len_call[1] + " == " + arr_len + ");\n"
65                     arg_conv = arg_conv + self.consts.get_native_arr_contents(arr_name, arr_name + "_arr", arr_len, ty_info, True) + ";\n"
66                     arg_conv = arg_conv + "unsigned char (*" + arr_name + "_ref)[" + arr_len + "] = &" + arr_name + "_arr;"
67                     ret_conv = (ret_conv[0] + "*", set_sfx + ";")
68                 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
69                     arg_conv = arg_conv, arg_conv_name = arr_name + "_ref", arg_conv_cleanup = arg_conv_cleanup,
70                     ret_conv = ret_conv, ret_conv_name = arr_name + "_arr", to_hu_conv = None, to_hu_conv_name = None, from_hu_conv = None)
71             else:
72                 assert not arr_len.isdigit() # fixed length arrays not implemented
73                 assert ty_info.java_ty[len(ty_info.java_ty) - 2:] == "[]"
74                 conv_name = "arr_conv_" + str(len(ty_info.java_hu_ty))
75                 idxc = chr(ord('a') + (len(ty_info.java_hu_ty) % 26))
76                 ty_info.subty.var_name = conv_name
77                 #XXX: We'd really prefer to only ever set to False, avoiding lots of clone, but need smarter free logic
78                 #if ty_info.is_ptr or holds_ref:
79                 #    ty_info.subty.requires_clone = False
80                 ty_info.subty.requires_clone = not ty_info.is_ptr or not holds_ref
81                 subty = self.map_type_with_info(ty_info.subty, False, None, is_free, holds_ref)
82                 if arr_name == "":
83                     arr_name = "arg"
84                 arg_conv = ty_info.rust_obj + " " + arr_name + "_constr;\n"
85                 arg_conv = arg_conv + arr_name + "_constr." + arr_len + " = " + self.consts.get_native_arr_len_call[0] + arr_name + self.consts.get_native_arr_len_call[1] + ";\n"
86                 arg_conv = arg_conv + "if (" + arr_name + "_constr." + arr_len + " > 0)\n"
87                 if subty.rust_obj is None:
88                     szof = subty.c_ty
89                 else:
90                     szof = subty.rust_obj
91                 arg_conv = arg_conv + "\t" + arr_name + "_constr." + ty_info.arr_access + " = MALLOC(" + arr_name + "_constr." + arr_len + " * sizeof(" + szof + "), \"" + ty_info.rust_obj + " Elements\");\n"
92                 arg_conv = arg_conv + "else\n"
93                 arg_conv = arg_conv + "\t" + arr_name + "_constr." + ty_info.arr_access + " = NULL;\n"
94                 get_arr = self.consts.get_native_arr_contents(arr_name, "NO_DEST", arr_name + "_constr." + arr_len, ty_info, False)
95                 if get_arr != None:
96                     arg_conv = arg_conv + subty.c_ty + "* " + arr_name + "_vals = " + get_arr + ";\n"
97                 arg_conv = arg_conv + "for (size_t " + idxc + " = 0; " + idxc + " < " + arr_name + "_constr." + arr_len + "; " + idxc + "++) {\n"
98                 if get_arr != None:
99                     arg_conv = arg_conv + "\t" + subty.c_ty + " " + conv_name + " = " + arr_name + "_vals[" + idxc + "];"
100                     if subty.arg_conv is not None:
101                         arg_conv = arg_conv + "\n\t" + subty.arg_conv.replace("\n", "\n\t")
102                 else:
103                     arg_conv = arg_conv + "\t" + subty.c_ty + " " + conv_name + " = " + self.consts.get_native_arr_elem(arr_name, idxc, ty_info) + ";\n"
104                     arg_conv = arg_conv + "\t" + subty.arg_conv.replace("\n", "\n\t")
105                 arg_conv = arg_conv + "\n\t" + arr_name + "_constr." + ty_info.arr_access + "[" + idxc + "] = " + subty.arg_conv_name + ";\n}"
106                 if get_arr != None:
107                     cleanup = self.consts.cleanup_native_arr_ref_contents(arr_name, arr_name + "_vals", arr_name + "_constr." + arr_len, ty_info)
108                     if cleanup is not None:
109                         arg_conv = arg_conv + "\n" + cleanup + ";"
110                 if ty_info.is_ptr:
111                     arg_conv_name = "&" + arr_name + "_constr"
112                 else:
113                     arg_conv_name = arr_name + "_constr"
114                 arg_conv_cleanup = None
115                 if ty_info.is_ptr:
116                     arg_conv_cleanup = "FREE(" + arr_name + "_constr." + ty_info.arr_access + ");"
117
118                 if arr_name == "arg":
119                     arr_name = "ret"
120                 ret_conv = (ty_info.rust_obj + " " + arr_name + "_var = ", "")
121                 if subty.ret_conv is None:
122                     ret_conv = ("DUMMY", "DUMMY")
123                 elif not ty_info.java_ty[:len(ty_info.java_ty) - 2].endswith("[]"):
124                     ret_conv = (ret_conv[0], ";\n" + ty_info.c_ty + " " + arr_name + "_arr = " + self.consts.create_native_arr_call(arr_name + "_var." + arr_len, ty_info) + ";\n")
125                     ret_conv = (ret_conv[0], ret_conv[1] + subty.c_ty + " *" + arr_name + "_arr_ptr = " + self.consts.get_native_arr_ptr_call[0] + arr_name + "_arr" + self.consts.get_native_arr_ptr_call[1] + ";\n")
126                     ret_conv = (ret_conv[0], ret_conv[1] + "for (size_t " + idxc + " = 0; " + idxc + " < " + arr_name + "_var." + arr_len + "; " + idxc + "++) {\n")
127                     ret_conv = (ret_conv[0], ret_conv[1] + "\t" + subty.ret_conv[0].replace("\n", "\n\t"))
128                     ret_conv = (ret_conv[0], ret_conv[1] + arr_name + "_var." + ty_info.arr_access + "[" + idxc + "]" + subty.ret_conv[1].replace("\n", "\n\t"))
129                     ret_conv = (ret_conv[0], ret_conv[1] + "\n\t" + arr_name + "_arr_ptr[" + idxc + "] = " + subty.ret_conv_name + ";\n}")
130                     cleanup = self.consts.release_native_arr_ptr_call(arr_name + "_arr", arr_name + "_arr_ptr")
131                     if cleanup is not None:
132                         ret_conv = (ret_conv[0], ret_conv[1] + "\n" + cleanup + ";")
133                 else:
134                     assert ty_info.java_fn_ty_arg.startswith("[")
135                     clz_var = ty_info.java_fn_ty_arg[1:].replace("[", "arr_of_")
136                     self.c_array_class_caches.add(clz_var)
137                     ret_conv = (ret_conv[0], ";\n" + ty_info.c_ty + " " + arr_name + "_arr = (*env)->NewObjectArray(env, " + arr_name + "_var." + arr_len + ", " + clz_var + "_clz, NULL);\n")
138                     ret_conv = (ret_conv[0], ret_conv[1] + "for (size_t " + idxc + " = 0; " + idxc + " < " + arr_name + "_var." + arr_len + "; " + idxc + "++) {\n")
139                     ret_conv = (ret_conv[0], ret_conv[1] + "\t" + subty.ret_conv[0].replace("\n", "\n\t"))
140                     ret_conv = (ret_conv[0], ret_conv[1] + arr_name + "_var." + ty_info.arr_access + "[" + idxc + "]" + subty.ret_conv[1].replace("\n", "\n\t"))
141                     ret_conv = (ret_conv[0], ret_conv[1] + "\n\t(*env)->SetObjectArrayElement(env, " + arr_name + "_arr, " + idxc + ", " + subty.ret_conv_name + ");\n")
142                     ret_conv = (ret_conv[0], ret_conv[1] + "}")
143                 if not holds_ref:
144                     # XXX: The commented if's are a bit smarter freeing, but we need to be a nudge smarter still
145                     # Note that we don't drop the full vec here - we're passing ownership to java (or have cloned) or free'd by now!
146                     ret_conv = (ret_conv[0], ret_conv[1] + "\nFREE(" + arr_name + "_var." + ty_info.arr_access + ");")
147                     #if subty.rust_obj is not None and subty.rust_obj in self.opaque_structs:
148                     #    ret_conv = (ret_conv[0], ret_conv[1] + "\nFREE(" + arr_name + "_var." + ty_info.arr_access + ");")
149                     #else:
150                     #    ret_conv = (ret_conv[0], ret_conv[1] + "\n" + ty_info.rust_obj.replace("LDK", "") + "_free(" + arr_name + "_var);")
151
152                 to_hu_conv = None
153                 to_hu_conv_name = None
154                 if subty.to_hu_conv is not None:
155                     to_hu_conv = ty_info.java_hu_ty + " " + conv_name + "_arr = new " + ty_info.subty.java_hu_ty.split("<")[0] + "[" + arr_name + ".length];\n"
156                     to_hu_conv = to_hu_conv + "for (int " + idxc + " = 0; " + idxc + " < " + arr_name + ".length; " + idxc + "++) {\n"
157                     to_hu_conv = to_hu_conv + "\t" + subty.java_ty + " " + conv_name + " = " + arr_name + "[" + idxc + "];\n"
158                     to_hu_conv = to_hu_conv + "\t" + subty.to_hu_conv.replace("\n", "\n\t") + "\n"
159                     to_hu_conv = to_hu_conv + "\t" + conv_name + "_arr[" + idxc + "] = " + subty.to_hu_conv_name + ";\n}"
160                     to_hu_conv_name = conv_name + "_arr"
161                 from_hu_conv = None
162                 if subty.from_hu_conv is not None:
163                     if subty.java_ty == "long" and subty.java_hu_ty != "long":
164                         from_hu_conv = ("Arrays.stream(" + arr_name + ").mapToLong(" + conv_name + " -> " + subty.from_hu_conv[0] + ").toArray()", "/* TODO 2 " + subty.java_hu_ty + "  */")
165                     elif subty.java_ty == "long":
166                         from_hu_conv = ("Arrays.stream(" + arr_name + ").map(" + conv_name + " -> " + subty.from_hu_conv[0] + ").toArray()", "/* TODO 2 " + subty.java_hu_ty + "  */")
167                     else:
168                         from_hu_conv = ("(" + ty_info.java_ty + ")Arrays.stream(" + arr_name + ").map(" + conv_name + " -> " + subty.from_hu_conv[0] + ").toArray()", "/* TODO 2 " + subty.java_hu_ty + "  */")
169
170                 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
171                     arg_conv = arg_conv, arg_conv_name = arg_conv_name, arg_conv_cleanup = arg_conv_cleanup,
172                     ret_conv = ret_conv, ret_conv_name = arr_name + "_arr", to_hu_conv = to_hu_conv, to_hu_conv_name = to_hu_conv_name, from_hu_conv = from_hu_conv)
173         elif ty_info.java_ty == "String":
174             if ty_info.arr_access is None:
175                 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
176                     arg_conv = None, arg_conv_name = None, arg_conv_cleanup = None,
177                     ret_conv = ("jstring " + ty_info.var_name + "_conv = (*env)->NewStringUTF(env, ", ");"), ret_conv_name = ty_info.var_name + "_conv",
178                     to_hu_conv = None, to_hu_conv_name = None, from_hu_conv = None)
179             else:
180                 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
181                     arg_conv = None, arg_conv_name = None, arg_conv_cleanup = None,
182                     ret_conv = ("LDKStr " + ty_info.var_name + "_str = ",
183                         ";\nchar* " + ty_info.var_name + "_buf = MALLOC(" + ty_info.var_name + "_str." + ty_info.arr_len + " + 1, \"str conv buf\");\n" +
184                         "memcpy(" + ty_info.var_name + "_buf, " + ty_info.var_name + "_str." + ty_info.arr_access + ", " + ty_info.var_name + "_str." + ty_info.arr_len + ");\n" +
185                         ty_info.var_name + "_buf[" + ty_info.var_name + "_str." + ty_info.arr_len + "] = 0;\n" +
186                         "jstring " + ty_info.var_name + "_conv = (*env)->NewStringUTF(env, " + ty_info.var_name + "_str." + ty_info.arr_access + ");\n" +
187                         "FREE(" + ty_info.var_name + "_buf);"),
188                     ret_conv_name = ty_info.var_name + "_conv", to_hu_conv = None, to_hu_conv_name = None, from_hu_conv = None)
189         elif ty_info.var_name == "" and not print_void:
190             # We don't have a parameter name, and want one, just call it arg
191             if ty_info.rust_obj is not None:
192                 assert(not is_free or ty_info.rust_obj not in self.opaque_structs)
193                 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
194                     arg_conv = ty_info.rust_obj + " arg_conv = *(" + ty_info.rust_obj + "*)arg;\nFREE((void*)arg);",
195                     arg_conv_name = "arg_conv", arg_conv_cleanup = None,
196                     ret_conv = None, ret_conv_name = None, to_hu_conv = "TODO 7", to_hu_conv_name = None, from_hu_conv = None)
197             else:
198                 assert(not is_free)
199                 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
200                     arg_conv = None, arg_conv_name = "arg", arg_conv_cleanup = None,
201                     ret_conv = None, ret_conv_name = None, to_hu_conv = "TODO 8", to_hu_conv_name = None, from_hu_conv = None)
202         elif ty_info.rust_obj is None:
203             return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
204                 arg_conv = None, arg_conv_name = ty_info.var_name, arg_conv_cleanup = None,
205                 ret_conv = None, ret_conv_name = None, to_hu_conv = None, to_hu_conv_name = None, from_hu_conv = None)
206         else:
207             if ty_info.var_name == "":
208                 ty_info.var_name = "ret"
209
210             if ty_info.rust_obj in self.opaque_structs:
211                 opaque_arg_conv = ty_info.rust_obj + " " + ty_info.var_name + "_conv;\n"
212                 opaque_arg_conv = opaque_arg_conv + ty_info.var_name + "_conv.inner = (void*)(" + ty_info.var_name + " & (~1));\n"
213                 if ty_info.is_ptr and holds_ref:
214                     opaque_arg_conv = opaque_arg_conv + ty_info.var_name + "_conv.is_owned = false;"
215                 else:
216                     opaque_arg_conv = opaque_arg_conv + ty_info.var_name + "_conv.is_owned = (" + ty_info.var_name + " & 1) || (" + ty_info.var_name + " == 0);"
217                 if not is_free and (not ty_info.is_ptr or not holds_ref or ty_info.requires_clone == True) and ty_info.requires_clone != False:
218                     if (ty_info.rust_obj.replace("LDK", "") + "_clone") in self.clone_fns:
219                         # TODO: This is a bit too naive, even with the checks above, we really need to know if rust wants a ref or not, not just if its pass as a ptr.
220                         opaque_arg_conv = opaque_arg_conv + "\nif (" + ty_info.var_name + "_conv.inner != NULL)\n"
221                         opaque_arg_conv = opaque_arg_conv + "\t" + ty_info.var_name + "_conv = " + ty_info.rust_obj.replace("LDK", "") + "_clone(&" + ty_info.var_name + "_conv);"
222                     elif ty_info.passed_as_ptr:
223                         opaque_arg_conv = opaque_arg_conv + "\n// Warning: we may need a move here but can't clone!"
224
225                 opaque_ret_conv_suf = ";\n"
226                 if not holds_ref and ty_info.is_ptr and (ty_info.rust_obj.replace("LDK", "") + "_clone") in self.clone_fns: # is_ptr, not holds_ref implies passing a pointed-to value to java, which needs copied
227                     opaque_ret_conv_suf = opaque_ret_conv_suf + "if (" + ty_info.var_name + "->inner != NULL)\n"
228                     opaque_ret_conv_suf = opaque_ret_conv_suf + "\t" + ty_info.var_name + "_var = " + ty_info.rust_obj.replace("LDK", "") + "_clone(" + ty_info.var_name + ");\n"
229                 elif not holds_ref and ty_info.is_ptr:
230                     opaque_ret_conv_suf = opaque_ret_conv_suf + "// Warning: we may need a move here but can't clone!\n"
231
232                 opaque_ret_conv_suf = opaque_ret_conv_suf + "CHECK((((long)" + ty_info.var_name + "_var.inner) & 1) == 0); // We rely on a free low bit, malloc guarantees this.\n"
233                 opaque_ret_conv_suf = opaque_ret_conv_suf + "CHECK((((long)&" + ty_info.var_name + "_var) & 1) == 0); // We rely on a free low bit, pointer alignment guarantees this.\n"
234                 if holds_ref:
235                     opaque_ret_conv_suf = opaque_ret_conv_suf + "long " + ty_info.var_name + "_ref = (long)" + ty_info.var_name + "_var.inner & ~1;"
236                 else:
237                     opaque_ret_conv_suf = opaque_ret_conv_suf + "long " + ty_info.var_name + "_ref = (long)" + ty_info.var_name + "_var.inner;\n"
238                     opaque_ret_conv_suf = opaque_ret_conv_suf + "if (" + ty_info.var_name + "_var.is_owned) {\n"
239                     opaque_ret_conv_suf = opaque_ret_conv_suf + "\t" + ty_info.var_name + "_ref |= 1;\n"
240                     opaque_ret_conv_suf = opaque_ret_conv_suf + "}"
241
242                 if ty_info.is_ptr:
243                     return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
244                         arg_conv = opaque_arg_conv, arg_conv_name = "&" + ty_info.var_name + "_conv", arg_conv_cleanup = None,
245                         ret_conv = (ty_info.rust_obj + " " + ty_info.var_name + "_var = *", opaque_ret_conv_suf),
246                         ret_conv_name = ty_info.var_name + "_ref",
247                         # to_hu_conv = ty_info.java_hu_ty + " " + ty_info.var_name + "_hu_conv = new " + ty_info.java_hu_ty + "(null, " + ty_info.var_name + ");",
248                         to_hu_conv = self.consts.to_hu_conv_templates['ptr'].replace('{human_type}', ty_info.java_hu_ty).replace('{var_name}', ty_info.var_name),
249                         to_hu_conv_name = ty_info.var_name + "_hu_conv",
250                         from_hu_conv = (ty_info.var_name + " == null ? 0 : " + ty_info.var_name + ".ptr & ~1", "this.ptrs_to.add(" + ty_info.var_name + ")"))
251                 else:
252                     return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
253                         arg_conv = opaque_arg_conv, arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
254                         ret_conv = (ty_info.rust_obj + " " + ty_info.var_name + "_var = ", opaque_ret_conv_suf),
255                         ret_conv_name = ty_info.var_name + "_ref",
256                         # to_hu_conv = ty_info.java_hu_ty + " " + ty_info.var_name + "_hu_conv = new " + ty_info.java_hu_ty + "(null, " + ty_info.var_name + ");",
257                         to_hu_conv = self.consts.to_hu_conv_templates['default'].replace('{human_type}', ty_info.java_hu_ty).replace('{var_name}', ty_info.var_name),
258                         to_hu_conv_name = ty_info.var_name + "_hu_conv",
259                         from_hu_conv = (ty_info.var_name + " == null ? 0 : " + ty_info.var_name + ".ptr & ~1", "this.ptrs_to.add(" + ty_info.var_name + ")"))
260
261             if not ty_info.is_ptr:
262                 if ty_info.rust_obj in self.unitary_enums:
263                     (ret_pfx, ret_sfx) = self.consts.c_unitary_enum_to_native_call(ty_info)
264                     (arg_pfx, arg_sfx) = self.consts.native_unitary_enum_to_c_call(ty_info)
265                     return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
266                         arg_conv = ty_info.rust_obj + " " + ty_info.var_name + "_conv = " + arg_pfx + ty_info.var_name + arg_sfx + ";",
267                         arg_conv_name = ty_info.var_name + "_conv",
268                         arg_conv_cleanup = None,
269                         ret_conv = (ty_info.c_ty + " " + ty_info.var_name + "_conv = " + ret_pfx, ret_sfx + ";"),
270                         ret_conv_name = ty_info.var_name + "_conv", to_hu_conv = None, to_hu_conv_name = None, from_hu_conv = None)
271                 base_conv = ty_info.rust_obj + " " + ty_info.var_name + "_conv = *(" + ty_info.rust_obj + "*)" + ty_info.var_name + ";"
272                 if ty_info.rust_obj in self.trait_structs:
273                     if not is_free:
274                         needs_full_clone = not is_free and (not ty_info.is_ptr and not holds_ref or ty_info.requires_clone == True) and ty_info.requires_clone != False
275                         if needs_full_clone and (ty_info.rust_obj.replace("LDK", "") + "_clone") in self.clone_fns:
276                             base_conv = base_conv + "\n" + ty_info.var_name + "_conv = " + ty_info.rust_obj.replace("LDK", "") + "_clone(" + ty_info.var_name + ");"
277                         else:
278                             base_conv = base_conv + self.consts.trait_struct_inc_refcnt(ty_info)
279                             if needs_full_clone:
280                                 base_conv = base_conv + "// Warning: we may need a move here but can't do a full clone!\n"
281
282                     else:
283                         base_conv = base_conv + "\n" + "FREE((void*)" + ty_info.var_name + ");"
284                     return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
285                         arg_conv = base_conv, arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
286                         ret_conv = (ty_info.rust_obj + "* ret = MALLOC(sizeof(" + ty_info.rust_obj + "), \"" + ty_info.rust_obj + "\");\n*ret = ", ";"),
287                         ret_conv_name = "(long)ret",
288                         to_hu_conv = ty_info.java_hu_ty + " ret_hu_conv = new " + ty_info.java_hu_ty + "(null, " + ty_info.var_name + ");\nret_hu_conv.ptrs_to.add(this);",
289                         to_hu_conv_name = "ret_hu_conv",
290                         from_hu_conv = (ty_info.var_name + " == null ? 0 : " + ty_info.var_name + ".ptr", "this.ptrs_to.add(" + ty_info.var_name + ")"))
291                 if ty_info.rust_obj != "LDKu8slice":
292                     # Don't bother free'ing slices passed in - Rust doesn't auto-free the
293                     # underlying unlike Vecs, and it gives Java more freedom.
294                     base_conv = base_conv + "\nFREE((void*)" + ty_info.var_name + ");";
295                 if ty_info.rust_obj in self.complex_enums:
296                     ret_conv = ("long " + ty_info.var_name + "_ref = (long)&", ";")
297                     if not holds_ref:
298                         ret_conv = (ty_info.rust_obj + " *" + ty_info.var_name + "_copy = MALLOC(sizeof(" + ty_info.rust_obj + "), \"" + ty_info.rust_obj + "\");\n", "")
299                         if ty_info.requires_clone == True: # Set in object array mapping
300                             if (ty_info.rust_obj.replace("LDK", "") + "_clone") in self.clone_fns:
301                                 ret_conv = (ret_conv[0] + "*" + ty_info.var_name + "_copy = " + ty_info.rust_obj.replace("LDK", "") + "_clone(&", ");\n")
302                             else:
303                                 ret_conv = (ret_conv[0] + "*" + ty_info.var_name + "_copy = ", "; // XXX: We likely need to clone here, but no _clone fn is available!\n")
304                         else:
305                             ret_conv = (ret_conv[0] + "*" + ty_info.var_name + "_copy = ", ";\n")
306                         ret_conv = (ret_conv[0], ret_conv[1] + "long " + ty_info.var_name + "_ref = (long)" + ty_info.var_name + "_copy;")
307                     return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
308                         arg_conv = base_conv, arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
309                         ret_conv = ret_conv, ret_conv_name = ty_info.var_name + "_ref",
310                         to_hu_conv = ty_info.java_hu_ty + " " + ty_info.var_name + "_hu_conv = " + ty_info.java_hu_ty + ".constr_from_ptr(" + ty_info.var_name + ");\n" + ty_info.var_name + "_hu_conv.ptrs_to.add(this);",
311                         to_hu_conv_name = ty_info.var_name + "_hu_conv", from_hu_conv = (ty_info.var_name + ".ptr", ""))
312                 if ty_info.rust_obj in self.result_types:
313                     if holds_ref:
314                         # If we're trying to return a ref, we have to clone.
315                         # We just blindly assume its implemented and let the compiler fail if its not.
316                         ret_conv = (ty_info.rust_obj + "* " + ty_info.var_name + "_conv = MALLOC(sizeof(" + ty_info.rust_obj + "), \"" + ty_info.rust_obj + "\");\n*" + ty_info.var_name + "_conv = ", ";")
317                         ret_conv = (ret_conv[0], ret_conv[1] + "\n*" + ty_info.var_name + "_conv = " + ty_info.rust_obj.replace("LDK", "") + "_clone(" + ty_info.var_name + "_conv);")
318                     else:
319                         ret_conv = (ty_info.rust_obj + "* " + ty_info.var_name + "_conv = MALLOC(sizeof(" + ty_info.rust_obj + "), \"" + ty_info.rust_obj + "\");\n*" + ty_info.var_name + "_conv = ", ";")
320                     return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
321                         arg_conv = base_conv, arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
322                         ret_conv = ret_conv, ret_conv_name = "(long)" + ty_info.var_name + "_conv",
323                         to_hu_conv = ty_info.java_hu_ty + " " + ty_info.var_name + "_hu_conv = " + ty_info.java_hu_ty + ".constr_from_ptr(" + ty_info.var_name + ");",
324                         to_hu_conv_name = ty_info.var_name + "_hu_conv", from_hu_conv = (ty_info.var_name + " != null ? " + ty_info.var_name + ".ptr : 0", ""))
325                 if ty_info.rust_obj in self.tuple_types:
326                     from_hu_conv = "bindings." + self.tuple_types[ty_info.rust_obj][1].replace("LDK", "") + "_new("
327                     to_hu_conv_pfx = ""
328                     to_hu_conv_sfx = ty_info.java_hu_ty + " " + ty_info.var_name + "_conv = new " + ty_info.java_hu_ty + "("
329                     clone_ret_str = ""
330                     for idx, conv in enumerate(self.tuple_types[ty_info.rust_obj][0]):
331                         if idx != 0:
332                             to_hu_conv_sfx = to_hu_conv_sfx + ", "
333                             from_hu_conv = from_hu_conv + ", "
334                         conv.var_name = ty_info.var_name + "_" + chr(idx + ord("a"))
335                         conv_map = self.map_type_with_info(conv, False, None, is_free, holds_ref)
336                         to_hu_conv_pfx = to_hu_conv_pfx + conv.java_ty + " " + ty_info.var_name + "_" + chr(idx + ord("a")) + " = " + "bindings." + self.tuple_types[ty_info.rust_obj][1] + "_get_" + chr(idx + ord("a")) + "(" + ty_info.var_name + ");\n"
337                         if conv_map.to_hu_conv is not None:
338                             to_hu_conv_pfx = to_hu_conv_pfx + conv_map.to_hu_conv + ";\n"
339                             to_hu_conv_sfx = to_hu_conv_sfx + conv_map.to_hu_conv_name
340                         else:
341                             to_hu_conv_sfx = to_hu_conv_sfx + ty_info.var_name + "_" + chr(idx + ord("a"))
342                         if conv_map.from_hu_conv is not None:
343                             from_hu_conv = from_hu_conv + conv_map.from_hu_conv[0].replace(ty_info.var_name + "_" + chr(idx + ord("a")), ty_info.var_name + "." + chr(idx + ord("a")))
344                             if conv_map.from_hu_conv[1] != "":
345                                 from_hu_conv = from_hu_conv + "/*XXX: " + conv_map.from_hu_conv[1] + "*/"
346                         else:
347                             from_hu_conv = from_hu_conv + ty_info.var_name + "." + chr(idx + ord("a"))
348
349                         if conv.is_native_primitive:
350                             pass
351                         elif (conv_map.rust_obj.replace("LDK", "") + "_clone") in self.clone_fns:
352                             accessor = ty_info.var_name + "_ref->" + chr(idx + ord("a"))
353                             clone_ret_str = clone_ret_str + "\n" + accessor + " = " + conv_map.rust_obj.replace("LDK", "") + "_clone(&" + accessor + ");"
354                         else:
355                             clone_ret_str = clone_ret_str + "\n// XXX: We likely need to clone here, but no _clone fn is available for " + conv_map.java_hu_ty
356                     if not ty_info.is_ptr and not holds_ref:
357                         ret_conv = (ty_info.rust_obj + "* " + ty_info.var_name + "_ref = MALLOC(sizeof(" + ty_info.rust_obj + "), \"" + ty_info.rust_obj + "\");\n*" + ty_info.var_name + "_ref = ", ";")
358                         if not is_free and (not ty_info.is_ptr and not holds_ref or ty_info.requires_clone == True) and ty_info.requires_clone != False:
359                             ret_conv = (ret_conv[0], ret_conv[1] + clone_ret_str)
360                         return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
361                             arg_conv = base_conv, arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
362                             ret_conv = ret_conv,
363                             ret_conv_name = "(long)" + ty_info.var_name + "_ref",
364                             to_hu_conv = to_hu_conv_pfx + to_hu_conv_sfx + ");", to_hu_conv_name = ty_info.var_name + "_conv", from_hu_conv = (from_hu_conv + ")", ""))
365                     return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
366                         arg_conv = base_conv, arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
367                         ret_conv = ("long " + ty_info.var_name + "_ref = (long)&", ";"), ret_conv_name = ty_info.var_name + "_ref",
368                         to_hu_conv = to_hu_conv_pfx + to_hu_conv_sfx + ");", to_hu_conv_name = ty_info.var_name + "_conv", from_hu_conv = (from_hu_conv + ")", ""))
369
370                 # The manually-defined types - TxOut and Transaction
371                 assert ty_info.rust_obj == "LDKTxOut"
372                 if not ty_info.is_ptr and not holds_ref:
373                     ret_conv = ("LDKTxOut* " + ty_info.var_name + "_ref = MALLOC(sizeof(LDKTxOut), \"LDKTxOut\");\n*" + ty_info.var_name + "_ref = ", ";")
374                 else:
375                     ret_conv = ("long " + ty_info.var_name + "_ref = (long)&", ";")
376                 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
377                     arg_conv = base_conv, arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
378                     ret_conv = ret_conv, ret_conv_name = "(long)" + ty_info.var_name + "_ref",
379                     to_hu_conv = ty_info.java_hu_ty + " " + ty_info.var_name + "_conv = new " +ty_info.java_hu_ty + "(null, " + ty_info.var_name + ");",
380                     to_hu_conv_name = ty_info.var_name + "_conv", from_hu_conv = (ty_info.var_name + ".ptr", ""))
381             elif ty_info.is_ptr:
382                 assert(not is_free)
383                 if ty_info.rust_obj in self.complex_enums:
384                     return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
385                         arg_conv = ty_info.rust_obj + "* " + ty_info.var_name + "_conv = (" + ty_info.rust_obj + "*)" + ty_info.var_name + ";",
386                         arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
387                         ret_conv = ("long ret_" + ty_info.var_name + " = (long)", ";"), ret_conv_name = "ret_" + ty_info.var_name,
388                         to_hu_conv = ty_info.java_hu_ty + " " + ty_info.var_name + "_hu_conv = " + ty_info.java_hu_ty + ".constr_from_ptr(" + ty_info.var_name + ");",
389                         to_hu_conv_name = ty_info.var_name + "_hu_conv",
390                         from_hu_conv = (ty_info.var_name + " == null ? 0 : " + ty_info.var_name + ".ptr & ~1", "this.ptrs_to.add(" + ty_info.var_name + ")"))
391                 elif ty_info.rust_obj in self.trait_structs:
392                     if ty_info.rust_obj.replace("LDK", "") + "_clone" in self.clone_fns:
393                         return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
394                             arg_conv = ty_info.rust_obj + "* " + ty_info.var_name + "_conv = (" + ty_info.rust_obj + "*)" + ty_info.var_name + ";",
395                             arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
396                             ret_conv = (ty_info.rust_obj + " *" + ty_info.var_name + "_clone = MALLOC(sizeof(" + ty_info.rust_obj + "), \"" + ty_info.rust_obj + "\");\n" +
397                                 "*" + ty_info.var_name + "_clone = " + ty_info.rust_obj.replace("LDK", "") + "_clone(", ");"),
398                             ret_conv_name = "(long)" + ty_info.var_name + "_clone",
399                             to_hu_conv = ty_info.java_hu_ty + " ret_hu_conv = new " + ty_info.java_hu_ty + "(null, " + ty_info.var_name + ");\nret_hu_conv.ptrs_to.add(this);",
400                             to_hu_conv_name = "ret_hu_conv",
401                             from_hu_conv = (ty_info.var_name + " == null ? 0 : " + ty_info.var_name + ".ptr", "this.ptrs_to.add(" + ty_info.var_name + ")"))
402                     else:
403                         return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
404                             arg_conv = ty_info.rust_obj + "* " + ty_info.var_name + "_conv = (" + ty_info.rust_obj + "*)" + ty_info.var_name + ";",
405                             arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
406                             ret_conv = ("long ret_" + ty_info.var_name + " = (long)", ";"), ret_conv_name = "ret_" + ty_info.var_name,
407                             to_hu_conv = ty_info.java_hu_ty + " ret_hu_conv = new " + ty_info.java_hu_ty + "(null, " + ty_info.var_name + ");\nret_hu_conv.ptrs_to.add(this);",
408                             to_hu_conv_name = "ret_hu_conv",
409                             from_hu_conv = (ty_info.var_name + " == null ? 0 : " + ty_info.var_name + ".ptr", "this.ptrs_to.add(" + ty_info.var_name + ")"))
410                 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
411                     arg_conv = ty_info.rust_obj + "* " + ty_info.var_name + "_conv = (" + ty_info.rust_obj + "*)" + ty_info.var_name + ";",
412                     arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
413                     ret_conv = ("long ret_" + ty_info.var_name + " = (long)", ";"), ret_conv_name = "ret_" + ty_info.var_name,
414                     to_hu_conv = "TODO 3", to_hu_conv_name = None, from_hu_conv = None) # its a pointer, no conv needed
415             assert False # We should have handled every case by now.