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