Properly convert 2D arrays in from_hu_conv
[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                 if not ty_info.subty.is_native_primitive and ty_info.subty.rust_obj == "LDKChannelMonitor":
81                     # We take a Vec of references to ChannelMonitors as input to ChannelManagerReadArgs, if we clone them,
82                     # we end up freeing the clones after creating the ChannelManagerReadArgs before calling the read
83                     # function itself, resulting in a segfault. Thus, we manually check and ensure we don't clone for
84                     # ChannelMonitors inside of vecs.
85                     ty_info.subty.requires_clone = False
86                 subty = self.map_type_with_info(ty_info.subty, False, None, is_free, holds_ref)
87                 if arr_name == "":
88                     arr_name = "arg"
89                 arg_conv = ty_info.rust_obj + " " + arr_name + "_constr;\n"
90                 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"
91                 arg_conv = arg_conv + "if (" + arr_name + "_constr." + arr_len + " > 0)\n"
92                 if subty.is_native_primitive:
93                     szof = subty.c_ty
94                 else:
95                     szof = subty.rust_obj
96                 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"
97                 arg_conv = arg_conv + "else\n"
98                 arg_conv = arg_conv + "\t" + arr_name + "_constr." + ty_info.arr_access + " = NULL;\n"
99                 get_arr = self.consts.get_native_arr_contents(arr_name, "NO_DEST", arr_name + "_constr." + arr_len, ty_info, False)
100                 if get_arr != None:
101                     arg_conv = arg_conv + subty.c_ty + "* " + arr_name + "_vals = " + get_arr + ";\n"
102                 arg_conv = arg_conv + "for (size_t " + idxc + " = 0; " + idxc + " < " + arr_name + "_constr." + arr_len + "; " + idxc + "++) {\n"
103                 if get_arr != None:
104                     arg_conv = arg_conv + "\t" + subty.c_ty + " " + conv_name + " = " + arr_name + "_vals[" + idxc + "];"
105                     if subty.arg_conv is not None:
106                         arg_conv = arg_conv + "\n\t" + subty.arg_conv.replace("\n", "\n\t")
107                 else:
108                     arg_conv = arg_conv + "\t" + subty.c_ty + " " + conv_name + " = " + self.consts.get_native_arr_elem(arr_name, idxc, ty_info) + ";\n"
109                     arg_conv = arg_conv + "\t" + subty.arg_conv.replace("\n", "\n\t")
110                 arg_conv = arg_conv + "\n\t" + arr_name + "_constr." + ty_info.arr_access + "[" + idxc + "] = " + subty.arg_conv_name + ";\n}"
111                 if get_arr != None:
112                     cleanup = self.consts.cleanup_native_arr_ref_contents(arr_name, arr_name + "_vals", arr_name + "_constr." + arr_len, ty_info)
113                     if cleanup is not None:
114                         arg_conv = arg_conv + "\n" + cleanup + ";"
115                 if ty_info.is_ptr:
116                     arg_conv_name = "&" + arr_name + "_constr"
117                 else:
118                     arg_conv_name = arr_name + "_constr"
119                 arg_conv_cleanup = None
120                 if ty_info.is_ptr:
121                     arg_conv_cleanup = "FREE(" + arr_name + "_constr." + ty_info.arr_access + ");"
122
123                 if arr_name == "arg":
124                     arr_name = "ret"
125                 ret_conv = (ty_info.rust_obj + " " + arr_name + "_var = ", "")
126                 if subty.ret_conv is None:
127                     ret_conv = ("DUMMY", "DUMMY")
128                 else:
129                     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")
130                     get_ptr_call = self.consts.get_native_arr_ptr_call(ty_info)
131                     if get_ptr_call is not None:
132                         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")
133                     ret_conv = (ret_conv[0], ret_conv[1] + "for (size_t " + idxc + " = 0; " + idxc + " < " + arr_name + "_var." + arr_len + "; " + idxc + "++) {\n")
134                     ret_conv = (ret_conv[0], ret_conv[1] + "\t" + subty.ret_conv[0].replace("\n", "\n\t"))
135                     ret_conv = (ret_conv[0], ret_conv[1] + arr_name + "_var." + ty_info.arr_access + "[" + idxc + "]" + subty.ret_conv[1].replace("\n", "\n\t"))
136                     if get_ptr_call is not None:
137                         ret_conv = (ret_conv[0], ret_conv[1] + "\n\t" + arr_name + "_arr_ptr[" + idxc + "] = " + subty.ret_conv_name + ";\n}")
138                     else:
139                         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}")
140                     cleanup = self.consts.release_native_arr_ptr_call(ty_info, arr_name + "_arr", arr_name + "_arr_ptr")
141                     if cleanup is not None:
142                         ret_conv = (ret_conv[0], ret_conv[1] + "\n" + cleanup + ";")
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 = ("Arrays.stream(" + arr_name + ").map(" + conv_name + " -> " + subty.from_hu_conv[0] + ").toArray(" + ty_info.java_ty + "::new)", "/* 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 = ("const char* " + ty_info.var_name + "_str = ",
178                         ";\njstring " + ty_info.var_name + "_conv = " + self.consts.str_ref_to_c_call(ty_info.var_name + "_str", "strlen(" + ty_info.var_name + "_str)") + ";"),
179                     ret_conv_name = ty_info.var_name + "_conv",
180                     to_hu_conv = None, to_hu_conv_name = None, from_hu_conv = None)
181             else:
182                 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
183                     arg_conv = None, arg_conv_name = None, arg_conv_cleanup = None,
184                     ret_conv = ("LDKStr " + ty_info.var_name + "_str = ",
185                         ";\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) + ";"),
186                     ret_conv_name = ty_info.var_name + "_conv", to_hu_conv = None, to_hu_conv_name = None, from_hu_conv = None)
187         elif ty_info.var_name == "" and not print_void:
188             # We don't have a parameter name, and want one, just call it arg
189             if not ty_info.is_native_primitive:
190                 assert(not is_free or ty_info.rust_obj not in self.opaque_structs)
191                 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
192                     arg_conv = ty_info.rust_obj + " arg_conv = *(" + ty_info.rust_obj + "*)arg;\nFREE((void*)arg);",
193                     arg_conv_name = "arg_conv", arg_conv_cleanup = None,
194                     ret_conv = None, ret_conv_name = None, to_hu_conv = "TODO 7", to_hu_conv_name = None, from_hu_conv = None)
195             else:
196                 assert(not is_free)
197                 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
198                     arg_conv = None, arg_conv_name = "arg", arg_conv_cleanup = None,
199                     ret_conv = None, ret_conv_name = None, to_hu_conv = "TODO 8", to_hu_conv_name = None, from_hu_conv = None)
200         elif ty_info.is_native_primitive:
201             return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
202                 arg_conv = None, arg_conv_name = ty_info.var_name, arg_conv_cleanup = None,
203                 ret_conv = None, ret_conv_name = None, to_hu_conv = None, to_hu_conv_name = None, from_hu_conv = None)
204         else:
205             if ty_info.var_name == "":
206                 ty_info.var_name = "ret"
207
208             if ty_info.rust_obj in self.opaque_structs:
209                 from_hu_conv = (ty_info.var_name + " == null ? 0 : " + ty_info.var_name + ".ptr & ~1", "this.ptrs_to.add(" + ty_info.var_name + ")")
210                 opaque_arg_conv = ty_info.rust_obj + " " + ty_info.var_name + "_conv;\n"
211                 opaque_arg_conv = opaque_arg_conv + ty_info.var_name + "_conv.inner = (void*)(" + ty_info.var_name + " & (~1));\n"
212                 if ty_info.is_ptr and holds_ref:
213                     opaque_arg_conv = opaque_arg_conv + ty_info.var_name + "_conv.is_owned = false;"
214                 else:
215                     opaque_arg_conv = opaque_arg_conv + ty_info.var_name + "_conv.is_owned = (" + ty_info.var_name + " & 1) || (" + ty_info.var_name + " == 0);"
216                 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:
217                     if (ty_info.rust_obj.replace("LDK", "") + "_clone") in self.clone_fns:
218                         # 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.
219                         opaque_arg_conv = opaque_arg_conv + "\n" + ty_info.var_name + "_conv = " + ty_info.rust_obj.replace("LDK", "") + "_clone(&" + ty_info.var_name + "_conv);"
220                     elif ty_info.passed_as_ptr:
221                         opaque_arg_conv = opaque_arg_conv + "\n// Warning: we need a move here but no clone is available for " + ty_info.rust_obj
222                         # TODO: Once we support features cloning (which just isn't in C yet), we can make this a compile error instead!
223                         from_hu_conv = (from_hu_conv[0], from_hu_conv[1] + ";\n" +
224                             "// Due to rust's strict-ownership memory model, in some cases we need to \"move\"\n" +
225                             "// an object to pass exclusive ownership to the function being called.\n" +
226                             "// In most cases, we avoid this being visible in GC'd languages by cloning the object\n" +
227                             "// at the FFI layer, creating a new object which Rust can claim ownership of\n" +
228                             "// However, in some cases (eg here), there is no way to clone an object, and thus\n" +
229                             "// we actually have to pass full ownership to Rust.\n" +
230                             "// Thus, after this call, " + ty_info.var_name + " is reset to null and is now a dummy object.\n" + ty_info.var_name + ".ptr = 0")
231
232                 opaque_ret_conv_suf = ";\n"
233                 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
234                     opaque_ret_conv_suf = opaque_ret_conv_suf + ty_info.var_name + "_var = " + ty_info.rust_obj.replace("LDK", "") + "_clone(" + ty_info.var_name + ");\n"
235                 elif not holds_ref and ty_info.is_ptr:
236                     opaque_ret_conv_suf = opaque_ret_conv_suf + "// Warning: we may need a move here but no clone is available for " + ty_info.rust_obj + "\n"
237
238                 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"
239                 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"
240                 if holds_ref:
241                     opaque_ret_conv_suf = opaque_ret_conv_suf + "long " + ty_info.var_name + "_ref = (long)" + ty_info.var_name + "_var.inner & ~1;"
242                 else:
243                     opaque_ret_conv_suf = opaque_ret_conv_suf + "long " + ty_info.var_name + "_ref = (long)" + ty_info.var_name + "_var.inner;\n"
244                     opaque_ret_conv_suf = opaque_ret_conv_suf + "if (" + ty_info.var_name + "_var.is_owned) {\n"
245                     opaque_ret_conv_suf = opaque_ret_conv_suf + "\t" + ty_info.var_name + "_ref |= 1;\n"
246                     opaque_ret_conv_suf = opaque_ret_conv_suf + "}"
247
248                 if ty_info.is_ptr:
249                     return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
250                         arg_conv = opaque_arg_conv, arg_conv_name = "&" + ty_info.var_name + "_conv", arg_conv_cleanup = None,
251                         ret_conv = (ty_info.rust_obj + " " + ty_info.var_name + "_var = *", opaque_ret_conv_suf),
252                         ret_conv_name = ty_info.var_name + "_ref",
253                         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),
254                         to_hu_conv_name = ty_info.var_name + "_hu_conv",
255                         from_hu_conv = from_hu_conv)
256                 else:
257                     return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
258                         arg_conv = opaque_arg_conv, arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
259                         ret_conv = (ty_info.rust_obj + " " + ty_info.var_name + "_var = ", opaque_ret_conv_suf),
260                         ret_conv_name = ty_info.var_name + "_ref",
261                         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) + "\n" + ty_info.var_name + "_hu_conv.ptrs_to.add(this);",
262                         to_hu_conv_name = ty_info.var_name + "_hu_conv",
263                         from_hu_conv = from_hu_conv)
264
265             if not ty_info.is_ptr:
266                 if ty_info.rust_obj in self.unitary_enums:
267                     (ret_pfx, ret_sfx) = self.consts.c_unitary_enum_to_native_call(ty_info)
268                     (arg_pfx, arg_sfx) = self.consts.native_unitary_enum_to_c_call(ty_info)
269                     return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
270                         arg_conv = ty_info.rust_obj + " " + ty_info.var_name + "_conv = " + arg_pfx + ty_info.var_name + arg_sfx + ";",
271                         arg_conv_name = ty_info.var_name + "_conv",
272                         arg_conv_cleanup = None,
273                         ret_conv = (ty_info.c_ty + " " + ty_info.var_name + "_conv = " + ret_pfx, ret_sfx + ";"),
274                         ret_conv_name = ty_info.var_name + "_conv", to_hu_conv = None, to_hu_conv_name = None, from_hu_conv = None)
275                 base_conv = ty_info.rust_obj + " " + ty_info.var_name + "_conv = *(" + ty_info.rust_obj + "*)(((uint64_t)" + ty_info.var_name + ") & ~1);"
276                 if ty_info.rust_obj in self.trait_structs:
277                     ret_conv = (ty_info.rust_obj + "* ret = MALLOC(sizeof(" + ty_info.rust_obj + "), \"" + ty_info.rust_obj + "\");\n*ret = ", ";")
278                     if holds_ref:
279                         if (ty_info.rust_obj.replace("LDK", "") + "_clone") in self.clone_fns:
280                             ret_conv = (ret_conv[0] + ty_info.rust_obj.replace("LDK", "") + "_clone(&", ");")
281                         else:
282                             ret_conv = (ret_conv[0], "; // Warning: We likely need to clone here, but no clone is available for " + ty_info.rust_obj)
283                     if not is_free:
284                         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
285                         if needs_full_clone and (ty_info.rust_obj.replace("LDK", "") + "_clone") in self.clone_fns:
286                             base_conv = base_conv + "\n" + ty_info.var_name + "_conv = " + ty_info.rust_obj.replace("LDK", "") + "_clone(" + ty_info.var_name + ");"
287                         else:
288                             base_conv = base_conv + self.consts.trait_struct_inc_refcnt(ty_info)
289                             if needs_full_clone:
290                                 base_conv = base_conv + "// Warning: we may need a move here but no clone is available for " + ty_info.rust_obj + "\n"
291                     else:
292                         base_conv = base_conv + "\n" + "FREE((void*)" + ty_info.var_name + ");"
293                     return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
294                         arg_conv = base_conv, arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
295                         ret_conv = ret_conv, ret_conv_name = "(long)ret",
296                         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);",
297                         to_hu_conv_name = "ret_hu_conv",
298                         from_hu_conv = (ty_info.var_name + " == null ? 0 : " + ty_info.var_name + ".ptr", "this.ptrs_to.add(" + ty_info.var_name + ")"))
299                 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
300                 if needs_full_clone:
301                     if not ty_info.var_name.startswith("ret") or "res" in ty_info.var_name: # XXX: This is a stupid hack
302                         needs_full_clone = False
303                     if needs_full_clone and (ty_info.rust_obj.replace("LDK", "") + "_clone") in self.clone_fns:
304                         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 + ");"
305                     elif needs_full_clone:
306                         base_conv = base_conv + "\n// Warning: we may need a move here but no clone is available for " + ty_info.rust_obj
307                 if not needs_full_clone and ty_info.rust_obj != "LDKu8slice":
308                     # Don't bother free'ing slices passed in - Rust doesn't auto-free the
309                     # underlying unlike Vecs, and it gives Java more freedom.
310                     base_conv = base_conv + "\nFREE((void*)" + ty_info.var_name + ");"
311                 if ty_info.rust_obj in self.complex_enums:
312                     ret_conv = ("long " + ty_info.var_name + "_ref = ((long)&", ") | 1;")
313                     if not holds_ref:
314                         ret_conv = (ty_info.rust_obj + " *" + ty_info.var_name + "_copy = MALLOC(sizeof(" + ty_info.rust_obj + "), \"" + ty_info.rust_obj + "\");\n", "")
315                         if ty_info.requires_clone == True: # Set in object array mapping
316                             if (ty_info.rust_obj.replace("LDK", "") + "_clone") in self.clone_fns:
317                                 ret_conv = (ret_conv[0] + "*" + ty_info.var_name + "_copy = " + ty_info.rust_obj.replace("LDK", "") + "_clone(&", ");\n")
318                             else:
319                                 ret_conv = (ret_conv[0] + "*" + ty_info.var_name + "_copy = ", "; // Warning: We likely need to clone here, but no clone is available for " + ty_inf.rust_obj + "\n")
320                         else:
321                             ret_conv = (ret_conv[0] + "*" + ty_info.var_name + "_copy = ", ";\n")
322                         ret_conv = (ret_conv[0], ret_conv[1] + "long " + ty_info.var_name + "_ref = (long)" + ty_info.var_name + "_copy;")
323                     return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
324                         arg_conv = base_conv, arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
325                         ret_conv = ret_conv, ret_conv_name = ty_info.var_name + "_ref",
326                         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);",
327                         to_hu_conv_name = ty_info.var_name + "_hu_conv", from_hu_conv = (ty_info.var_name + ".ptr", ""))
328                 if ty_info.rust_obj in self.result_types:
329                     if holds_ref:
330                         # If we're trying to return a ref, we have to clone.
331                         # We just blindly assume its implemented and let the compiler fail if its not.
332                         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 = ", ";")
333                         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);")
334                     else:
335                         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 = ", ";")
336                     return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
337                         arg_conv = base_conv, arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
338                         ret_conv = ret_conv, ret_conv_name = "(long)" + ty_info.var_name + "_conv",
339                         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 + ");",
340                         to_hu_conv_name = ty_info.var_name + "_hu_conv", from_hu_conv = (ty_info.var_name + " != null ? " + ty_info.var_name + ".ptr : 0", ""))
341                 if ty_info.rust_obj in self.tuple_types:
342                     from_hu_conv_sfx = ""
343                     from_hu_conv = "bindings." + self.tuple_types[ty_info.rust_obj][1].replace("LDK", "") + "_new("
344                     to_hu_conv_pfx = ""
345                     to_hu_conv_sfx = ty_info.java_hu_ty + " " + ty_info.var_name + "_conv = new " + ty_info.java_hu_ty + "("
346                     to_hu_conv_refs = ""
347                     for idx, conv in enumerate(self.tuple_types[ty_info.rust_obj][0]):
348                         if idx != 0:
349                             to_hu_conv_sfx = to_hu_conv_sfx + ", "
350                             from_hu_conv = from_hu_conv + ", "
351                         conv.var_name = ty_info.var_name + "_" + chr(idx + ord("a"))
352                         conv_map = self.map_type_with_info(conv, False, None, is_free, holds_ref)
353                         to_hu_conv_pfx = to_hu_conv_pfx + conv.java_ty + " " + ty_info.var_name + "_" + chr(idx + ord("a")) + " = "
354                         if not conv.is_native_primitive and (conv_map.rust_obj.replace("LDK", "") + "_clone") in self.clone_fns and conv_map.rust_obj == "LDKTxOut":
355                             to_hu_conv_pfx = to_hu_conv_pfx + "bindings." + conv_map.rust_obj.replace("LDK", "") + "_clone("
356                         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 + ")"
357                         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
358                             to_hu_conv_pfx = to_hu_conv_pfx + ")"
359                         to_hu_conv_pfx = to_hu_conv_pfx + ";\n"
360                         if conv_map.to_hu_conv is not None:
361                             to_hu_conv_pfx = to_hu_conv_pfx + conv_map.to_hu_conv + ";\n"
362                             to_hu_conv_sfx = to_hu_conv_sfx + conv_map.to_hu_conv_name
363                             if to_hu_conv_refs is not None:
364                                 if conv_map.c_ty.endswith("Array"):
365                                     to_hu_conv_refs = None
366                                 else:
367                                     to_hu_conv_refs = to_hu_conv_refs + "\n" + conv_map.to_hu_conv_name + ".ptrs_to.add(" + ty_info.var_name + "_conv);"
368                         else:
369                             to_hu_conv_sfx = to_hu_conv_sfx + ty_info.var_name + "_" + chr(idx + ord("a"))
370                         if conv_map.from_hu_conv is not None:
371                             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")))
372                             if conv_map.from_hu_conv[1] != "":
373                                 from_hu_conv_sfx = from_hu_conv_sfx + conv_map.from_hu_conv[1].replace(conv.var_name, ty_info.var_name + "." + chr(idx + ord("a")))
374                         else:
375                             from_hu_conv = from_hu_conv + ty_info.var_name + "." + chr(idx + ord("a"))
376
377                     if to_hu_conv_refs is None:
378                         to_hu_conv = to_hu_conv_pfx + to_hu_conv_sfx + ");\n// Warning: We may not free the C tuple object!"
379                     else:
380                         to_hu_conv = to_hu_conv_pfx + to_hu_conv_sfx + ", () -> {\n"
381                         to_hu_conv = to_hu_conv + "\tbindings." + ty_info.rust_obj.replace("LDK", "") + "_free(" + ty_info.var_name + ");\n"
382                         to_hu_conv = to_hu_conv + "});" + to_hu_conv_refs
383                     if not ty_info.is_ptr and not holds_ref:
384                         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 = ", ";")
385                         return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
386                             arg_conv = base_conv, arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
387                             ret_conv = ret_conv,
388                             ret_conv_name = "(long)" + ty_info.var_name + "_ref",
389                             to_hu_conv = to_hu_conv, to_hu_conv_name = ty_info.var_name + "_conv", from_hu_conv = (from_hu_conv + ")", from_hu_conv_sfx))
390                     return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
391                         arg_conv = base_conv, arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
392                         ret_conv = ("long " + ty_info.var_name + "_ref = (long)(&", ") | 1;"), ret_conv_name = ty_info.var_name + "_ref",
393                         to_hu_conv = to_hu_conv, to_hu_conv_name = ty_info.var_name + "_conv", from_hu_conv = (from_hu_conv + ")", from_hu_conv_sfx))
394
395                 # The manually-defined types - TxOut and Transaction
396                 assert ty_info.rust_obj == "LDKTxOut"
397                 if not ty_info.is_ptr and not holds_ref:
398                     ret_conv = ("LDKTxOut* " + ty_info.var_name + "_ref = MALLOC(sizeof(LDKTxOut), \"LDKTxOut\");\n*" + ty_info.var_name + "_ref = ", ";")
399                 else:
400                     ret_conv = ("long " + ty_info.var_name + "_ref = ((long)&", ") | 1;")
401                 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
402                     arg_conv = base_conv, arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
403                     ret_conv = ret_conv, ret_conv_name = "(long)" + ty_info.var_name + "_ref",
404                     to_hu_conv = ty_info.java_hu_ty + " " + ty_info.var_name + "_conv = new " +ty_info.java_hu_ty + "(null, " + ty_info.var_name + ");",
405                     to_hu_conv_name = ty_info.var_name + "_conv", from_hu_conv = (ty_info.var_name + ".ptr", ""))
406             elif ty_info.is_ptr:
407                 assert(not is_free)
408                 if ty_info.rust_obj in self.complex_enums:
409                     return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
410                         arg_conv = ty_info.rust_obj + "* " + ty_info.var_name + "_conv = (" + ty_info.rust_obj + "*)" + ty_info.var_name + ";",
411                         arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
412                         ret_conv = ("long ret_" + ty_info.var_name + " = (long)", ";"), ret_conv_name = "ret_" + ty_info.var_name,
413                         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 + ");",
414                         to_hu_conv_name = ty_info.var_name + "_hu_conv",
415                         from_hu_conv = (ty_info.var_name + " == null ? 0 : " + ty_info.var_name + ".ptr & ~1", "this.ptrs_to.add(" + ty_info.var_name + ")"))
416                 elif ty_info.rust_obj in self.trait_structs:
417                     if ty_info.rust_obj.replace("LDK", "") + "_clone" in self.clone_fns:
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 + ";",
420                             arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
421                             ret_conv = (ty_info.rust_obj + " *" + ty_info.var_name + "_clone = MALLOC(sizeof(" + ty_info.rust_obj + "), \"" + ty_info.rust_obj + "\");\n" +
422                                 "*" + ty_info.var_name + "_clone = " + ty_info.rust_obj.replace("LDK", "") + "_clone(", ");"),
423                             ret_conv_name = "(long)" + ty_info.var_name + "_clone",
424                             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);",
425                             to_hu_conv_name = "ret_hu_conv",
426                             from_hu_conv = (ty_info.var_name + " == null ? 0 : " + ty_info.var_name + ".ptr", "this.ptrs_to.add(" + ty_info.var_name + ")"))
427                     else:
428                         return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
429                             arg_conv = ty_info.rust_obj + "* " + ty_info.var_name + "_conv = (" + ty_info.rust_obj + "*)" + ty_info.var_name + ";",
430                             arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
431                             ret_conv = ("long ret_" + ty_info.var_name + " = (long)", ";"), ret_conv_name = "ret_" + ty_info.var_name,
432                             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);",
433                             to_hu_conv_name = "ret_hu_conv",
434                             from_hu_conv = (ty_info.var_name + " == null ? 0 : " + ty_info.var_name + ".ptr", "this.ptrs_to.add(" + ty_info.var_name + ")"))
435                 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
436                     arg_conv = ty_info.rust_obj + "* " + ty_info.var_name + "_conv = (" + ty_info.rust_obj + "*)(" + ty_info.var_name + " & ~1);",
437                     arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
438                     ret_conv = ("long ret_" + ty_info.var_name + " = (long)", ";"), ret_conv_name = "ret_" + ty_info.var_name,
439                     to_hu_conv = "TODO 3", to_hu_conv_name = None, from_hu_conv = None) # its a pointer, no conv needed
440             assert False # We should have handled every case by now.