inch towards more map_trait cleanup for Typescript
[ldk-java] / typescript_strings.py
1 from bindingstypes import ConvInfo
2
3
4 def first_to_lower(string: str) -> str:
5     first = string[0]
6     return first.lower() + string[1:]
7
8
9 class Consts:
10     def __init__(self, DEBUG):
11
12         self.c_type_map = dict(
13             uint8_t = ['number', 'Uint8Array'],
14             uint16_t = ['number', 'Uint16Array'],
15             uint32_t = ['number', 'Uint32Array'],
16             long = ['number'],
17         )
18
19         self.common_base = """
20             export default class CommonBase {
21                 ptr: number;
22                 ptrs_to: object[] = []; // new LinkedList(); TODO: build linked list implementation
23                 protected constructor(ptr: number) { this.ptr = ptr; }
24                 public _test_only_get_ptr(): number { return this.ptr; }
25                 protected finalize() {
26                     // TODO: finalize myself
27                 }
28             }
29         """
30
31         self.c_file_pfx = """#include <rust_types.h>
32 #include <stdatomic.h>
33 #include <lightning.h>
34
35 // These should be provided...somehow...
36 void *memset(void *s, int c, size_t n);
37 void *memcpy(void *dest, const void *src, size_t n);
38 int memcmp(const void *s1, const void *s2, size_t n);
39
40 void __attribute__((noreturn)) abort(void);
41 void assert(scalar expression);
42 """
43
44         if not DEBUG:
45             self.c_file_pfx = self.c_file_pfx + """
46 void *malloc(size_t size);
47 void free(void *ptr);
48
49 #define MALLOC(a, _) malloc(a)
50 #define FREE(p) if ((long)(p) > 1024) { free(p); }
51 #define DO_ASSERT(a) (void)(a)
52 #define CHECK(a)
53 """
54         else:
55             self.c_file_pfx = self.c_file_pfx + """
56 // Always run a, then assert it is true:
57 #define DO_ASSERT(a) do { bool _assert_val = (a); assert(_assert_val); } while(0)
58 // Assert a is true or do nothing
59 #define CHECK(a) DO_ASSERT(a)
60
61 // Running a leak check across all the allocations and frees of the JDK is a mess,
62 // so instead we implement our own naive leak checker here, relying on the -wrap
63 // linker option to wrap malloc/calloc/realloc/free, tracking everyhing allocated
64 // and free'd in Rust or C across the generated bindings shared library.
65
66 #define BT_MAX 128
67 typedef struct allocation {
68         struct allocation* next;
69         void* ptr;
70         const char* struct_name;
71 } allocation;
72 static allocation* allocation_ll = NULL;
73
74 void* __real_malloc(size_t len);
75 void* __real_calloc(size_t nmemb, size_t len);
76 static void new_allocation(void* res, const char* struct_name) {
77         allocation* new_alloc = __real_malloc(sizeof(allocation));
78         new_alloc->ptr = res;
79         new_alloc->struct_name = struct_name;
80         new_alloc->next = allocation_ll;
81         allocation_ll = new_alloc;
82 }
83 static void* MALLOC(size_t len, const char* struct_name) {
84         void* res = __real_malloc(len);
85         new_allocation(res, struct_name);
86         return res;
87 }
88 void __real_free(void* ptr);
89 static void alloc_freed(void* ptr) {
90         allocation* p = NULL;
91         allocation* it = allocation_ll;
92         while (it->ptr != ptr) {
93                 p = it; it = it->next;
94                 if (it == NULL) {
95                         //XXX: fprintf(stderr, "Tried to free unknown pointer %p\\n", ptr);
96                         return; // addrsan should catch malloc-unknown and print more info than we have
97                 }
98         }
99         if (p) { p->next = it->next; } else { allocation_ll = it->next; }
100         DO_ASSERT(it->ptr == ptr);
101         __real_free(it);
102 }
103 static void FREE(void* ptr) {
104         if ((long)ptr < 1024) return; // Rust loves to create pointers to the NULL page for dummys
105         alloc_freed(ptr);
106         __real_free(ptr);
107 }
108
109 void* __wrap_malloc(size_t len) {
110         void* res = __real_malloc(len);
111         new_allocation(res, "malloc call");
112         return res;
113 }
114 void* __wrap_calloc(size_t nmemb, size_t len) {
115         void* res = __real_calloc(nmemb, len);
116         new_allocation(res, "calloc call");
117         return res;
118 }
119 void __wrap_free(void* ptr) {
120         if (ptr == NULL) return;
121         alloc_freed(ptr);
122         __real_free(ptr);
123 }
124
125 void* __real_realloc(void* ptr, size_t newlen);
126 void* __wrap_realloc(void* ptr, size_t len) {
127         if (ptr != NULL) alloc_freed(ptr);
128         void* res = __real_realloc(ptr, len);
129         new_allocation(res, "realloc call");
130         return res;
131 }
132 void __wrap_reallocarray(void* ptr, size_t new_sz) {
133         // Rust doesn't seem to use reallocarray currently
134         DO_ASSERT(false);
135 }
136
137 void __attribute__((destructor)) check_leaks() {
138         for (allocation* a = allocation_ll; a != NULL; a = a->next) {
139                 //XXX: fprintf(stderr, "%s %p remains\\n", a->struct_name, a->ptr);
140         }
141         DO_ASSERT(allocation_ll == NULL);
142 }
143 """
144         self.c_file_pfx = self.c_file_pfx + """
145 // We assume that CVec_u8Z and u8slice are the same size and layout (and thus pointers to the two can be mixed)
146 _Static_assert(sizeof(LDKCVec_u8Z) == sizeof(LDKu8slice), "Vec<u8> and [u8] need to have been mapped identically");
147 _Static_assert(offsetof(LDKCVec_u8Z, data) == offsetof(LDKu8slice, data), "Vec<u8> and [u8] need to have been mapped identically");
148 _Static_assert(offsetof(LDKCVec_u8Z, datalen) == offsetof(LDKu8slice, datalen), "Vec<u8> and [u8] need to have been mapped identically");
149
150 _Static_assert(sizeof(void*) == 4, "Pointers mut be 32 bits");
151
152 typedef struct int64_tArray {uint32_t len;int64_t *ptr;} int64_tArray;
153 typedef struct uint32_tArray {uint32_t len;int32_t *ptr;} uint32_tArray;
154 typedef struct int8_tArray {uint32_t len;int8_t *ptr;} int8_tArray;
155
156 typedef bool jboolean;
157
158 """
159
160         self.hu_struct_file_prefix = f"""
161 import CommonBase from './CommonBase';
162 import * as bindings from '../bindings' // TODO: figure out location
163
164 """
165         self.c_fn_ty_pfx = ""
166         self.c_fn_name_pfx = ""
167         self.c_fn_args_pfx = "void* ctx_TODO"
168         self.file_ext = ".ts"
169         self.ptr_c_ty = "uint32_t"
170         self.ptr_native_ty = "uint32_t"
171         self.result_c_ty = "uint32_t"
172         self.ptr_arr = "uint32_tArray"
173         self.get_native_arr_len_call = ("", ".len")
174         self.get_native_arr_ptr_call = ("", ".ptr")
175
176     def release_native_arr_ptr_call(self, arr_var, arr_ptr_var):
177         return None
178     def create_native_arr_call(self, arr_len, ty_info):
179         if ty_info.c_ty == "int8_tArray":
180             return "{ .len = " + arr_len + ", .ptr = MALLOC(" + arr_len + ", \"Native " + ty_info.c_ty + " Bytes\") }"
181         elif ty_info.c_ty == "int64_tArray":
182             return "{ .len = " + arr_len + ", .ptr = MALLOC(" + arr_len + " * sizeof(int64_t), \"Native " + ty_info.c_ty + " Bytes\") }"
183         elif ty_info.c_ty == "uint32_tArray":
184             return "{ .len = " + arr_len + ", .ptr = MALLOC(" + arr_len + " * sizeof(int32_t), \"Native " + ty_info.c_ty + " Bytes\") }"
185         else:
186             print("Need to create arr!", ty_info.c_ty)
187             return ty_info.c_ty
188     def set_native_arr_contents(self, arr_name, arr_len, ty_info):
189         if ty_info.c_ty == "int8_tArray":
190             return ("memcpy(" + arr_name + ".ptr, ", ", " + arr_len + ")")
191         else:
192             assert False
193     def get_native_arr_contents(self, arr_name, dest_name, arr_len, ty_info, copy):
194         if ty_info.c_ty == "int8_tArray":
195             if copy:
196                 return "memcpy(" + dest_name + ", " + arr_name + ".ptr, " + arr_len + ")"
197             else:
198                 return arr_name + ".ptr"
199         else:
200             return "(" + ty_info.subty.c_ty + "*) " + arr_name + ".ptr"
201     def get_native_arr_elem(self, arr_name, idxc, ty_info):
202         assert False # Only called if above is None
203     def cleanup_native_arr_ref_contents(self, arr_name, dest_name, arr_len, ty_info):
204         if ty_info.c_ty == "int8_tArray":
205             return None
206         else:
207             return None
208
209     def init_str(self, c_array_class_caches):
210         return ""
211
212     def native_c_unitary_enum_map(self, struct_name, variants):
213         out_c = "static inline " + struct_name + " " + struct_name + "_from_js(int32_t ord) {\n"
214         out_c = out_c + "\tswitch (ord) {\n"
215         ord_v = 0
216
217         out_typescript_enum_fields = ""
218
219         for var in variants:
220             out_c = out_c + "\t\tcase %d: return %s;\n" % (ord_v, var)
221             ord_v = ord_v + 1
222             out_typescript_enum_fields += f"{var},\n\t\t\t\t"
223         out_c = out_c + "\t}\n"
224         out_c = out_c + "\tabort();\n"
225         out_c = out_c + "}\n"
226
227         out_c = out_c + "static inline int32_t " + struct_name + "_to_js(" + struct_name + " val) {\n"
228         out_c = out_c + "\tswitch (val) {\n"
229         ord_v = 0
230         for var in variants:
231             out_c = out_c + "\t\tcase " + var + ": return %d;\n" % ord_v
232             ord_v = ord_v + 1
233         out_c = out_c + "\t\tdefault: abort();\n"
234         out_c = out_c + "\t}\n"
235         out_c = out_c + "}\n"
236
237         out_typescript_enum = f"""
238             export enum {struct_name} {{
239                 {out_typescript_enum_fields}
240             }}
241         """
242
243         return (out_c, out_typescript_enum, "")
244
245     def c_unitary_enum_to_native_call(self, ty_info):
246         return (ty_info.rust_obj + "_to_js(", ")")
247     def native_unitary_enum_to_c_call(self, ty_info):
248         return (ty_info.rust_obj + "_from_js(", ")")
249
250     def c_complex_enum_pass_ty(self, struct_name):
251         return "uint32_t"
252
253     def c_constr_native_complex_enum(self, struct_name, variant, c_params):
254         ret = "0 /* " + struct_name + " - " + variant + " */"
255         for param in c_params:
256             ret = ret + "; (void) " + param
257         return ret
258
259     def native_c_map_trait(self, struct_name, field_var_conversions, field_function_lines):
260         out_java = "out_java:native_c_map_trait"
261         out_java_trait = "out_java_trait:native_c_map_trait"
262         out_c = "out_c:native_c_map_trait"
263
264
265         out_java_trait = ""
266         out_java = ""
267
268         constructor_arguments = ""
269         super_instantiator = ""
270         pointer_to_adder = ""
271         impl_constructor_arguments = ""
272         for var in field_var_conversions:
273             if isinstance(var, ConvInfo):
274                 constructor_arguments += f", {first_to_lower(var.arg_name)}?: {var.java_hu_ty}"
275                 impl_constructor_arguments += f", {var.arg_name}: {var.java_hu_ty}"
276                 if var.from_hu_conv is not None:
277                     super_instantiator += ", " + var.from_hu_conv[0]
278                     if var.from_hu_conv[1] != "":
279                         pointer_to_adder += var.from_hu_conv[1] + ";\n"
280                 else:
281                     super_instantiator += ", " + first_to_lower(var.arg_name)
282             else:
283                 constructor_arguments += f", {first_to_lower(var[1])}?: bindings.{var[0]}"
284                 super_instantiator += ", " + first_to_lower(var[1])
285                 pointer_to_adder += "this.ptrs_to.push(" + first_to_lower(var[1]) + ");\n"
286                 impl_constructor_arguments += f", {first_to_lower(var[1])}_impl: {var[0].replace('LDK', '')}.{var[0].replace('LDK', '')}Interface"
287
288         # BUILD INTERFACE METHODS
289         out_java_interface = ""
290         for fn_line in field_function_lines:
291             if fn_line.fn_name != "free" and fn_line.fn_name != "clone":
292                 out_java_interface += fn_line.fn_name + "("
293
294                 for idx, arg_conv_info in enumerate(fn_line.args_ty):
295                     if idx >= 1:
296                         out_java_interface += ", "
297                     out_java_interface += f"{arg_conv_info.arg_name}: {arg_conv_info.java_hu_ty}"
298                 out_java_interface += f"): {fn_line.ret_ty_info.java_hu_ty};\n\t\t\t\t"
299
300         out_java_trait = f"""
301             {self.hu_struct_file_prefix}
302             
303             export class {struct_name.replace("LDK","")} extends CommonBase {{
304             
305                 bindings_instance?: bindings.{struct_name};
306                 
307                 constructor(ptr?: number, arg?: bindings.{struct_name}{constructor_arguments}) {{
308                     if (Number.isFinite(ptr)) {{
309                                         super(ptr);
310                                         this.bindings_instance = null;
311                                     }} else {{
312                                         // TODO: private constructor instantiation
313                                         super(bindings.{struct_name}_new(arg{super_instantiator}));
314                                         this.ptrs_to.push(arg);
315                                         {pointer_to_adder}
316                                     }}
317                 }}
318                 
319                 protected finalize() {{
320                     if (this.ptr != 0) {{ 
321                         bindings.{struct_name.replace("LDK","")}_free(this.ptr); 
322                     }} 
323                     super.finalize();
324                 }}
325                 
326                 static new_impl(arg: {struct_name.replace("LDK", "")}Interface{impl_constructor_arguments}): {struct_name.replace("LDK", "")} {{
327                     const impl_holder: {struct_name}Holder = new {struct_name}Holder();
328                     impl_holder.held = new {struct_name.replace("LDK", "")} (new bindings.{struct_name}() {{
329                         // todo: in-line interface filling
330                     }});
331                 }}
332                 
333             }}
334             
335             export interface {struct_name.replace("LDK", "")}Interface {{
336                 {out_java_interface}
337             }}
338             
339             class {struct_name}Holder {{
340                 held: {struct_name.replace("LDK", "")};
341             }}
342             
343         """
344
345
346
347         java_trait_constr = ") {\n\t\tfinal " + struct_name + "Holder impl_holder = new " + struct_name + "Holder();\n"
348         java_trait_constr = java_trait_constr + "\t\timpl_holder.held = new " + struct_name.replace("LDK", "") + "(new bindings." + struct_name + "() {\n"
349         out_java = out_java + "\tpublic interface " + struct_name + " {\n"
350         java_meths = []
351         for fn_line in field_function_lines:
352             java_meth_descr = "("
353             if fn_line.fn_name != "free" and fn_line.fn_name != "clone":
354                 out_java = out_java + "\t\t " + fn_line.ret_ty_info.java_ty + " " + fn_line.fn_name + "("
355                 java_trait_constr = java_trait_constr + "\t\t\t@Override public " + fn_line.ret_ty_info.java_ty + " " + fn_line.fn_name + "("
356
357                 for idx, arg_conv_info in enumerate(fn_line.args_ty):
358                     if idx >= 1:
359                         out_java = out_java + ", "
360                         java_trait_constr = java_trait_constr + ", "
361                         # out_java_trait = out_java_trait + ", "
362                     out_java = out_java + arg_conv_info.java_ty + " " + arg_conv_info.arg_name
363                     # out_java_trait = out_java_trait + arg_conv_info.java_hu_ty + " " + arg_conv_info.arg_name
364                     java_trait_constr = java_trait_constr + arg_conv_info.java_ty + " " + arg_conv_info.arg_name
365                     java_meth_descr = java_meth_descr + arg_conv_info.java_fn_ty_arg
366                 java_meth_descr = java_meth_descr + ")" + fn_line.ret_ty_info.java_fn_ty_arg
367                 java_meths.append((fn_line.fn_name, java_meth_descr))
368
369                 out_java = out_java + ");\n"
370                 # out_java_trait = out_java_trait + ");\n"
371                 java_trait_constr = java_trait_constr + ") {\n"
372
373                 for arg_info in fn_line.args_ty:
374                     if arg_info.to_hu_conv is not None:
375                         java_trait_constr = java_trait_constr + "\t\t\t\t" + arg_info.to_hu_conv.replace("\n", "\n\t\t\t\t") + "\n"
376
377                 if fn_line.ret_ty_info.java_ty != "void":
378                     java_trait_constr = java_trait_constr + "\t\t\t\t" + fn_line.ret_ty_info.java_hu_ty + " ret = arg." + fn_line.fn_name + "("
379                 else:
380                     java_trait_constr = java_trait_constr + "\t\t\t\targ." + fn_line.fn_name + "("
381
382                 for idx, arg_info in enumerate(fn_line.args_ty):
383                     if idx != 0:
384                         java_trait_constr = java_trait_constr + ", "
385                     if arg_info.to_hu_conv_name is not None:
386                         java_trait_constr = java_trait_constr + arg_info.to_hu_conv_name
387                     else:
388                         java_trait_constr = java_trait_constr + arg_info.arg_name
389
390                 java_trait_constr = java_trait_constr + ");\n"
391                 if fn_line.ret_ty_info.java_ty != "void":
392                     if fn_line.ret_ty_info.from_hu_conv is not None:
393                         java_trait_constr = java_trait_constr + "\t\t\t\t" + fn_line.ret_ty_info.java_ty + " result = " + fn_line.ret_ty_info.from_hu_conv[0] + ";\n"
394                         if fn_line.ret_ty_info.from_hu_conv[1] != "":
395                             java_trait_constr = java_trait_constr + "\t\t\t\t" + fn_line.ret_ty_info.from_hu_conv[1].replace("this", "impl_holder.held") + ";\n"
396                         #if fn_line.ret_ty_info.rust_obj in result_types:
397                         # XXX: We need to handle this in conversion logic so that its cross-language!
398                         # Avoid double-free by breaking the result - we should learn to clone these and then we can be safe instead
399                         #    java_trait_constr = java_trait_constr + "\t\t\t\tret.ptr = 0;\n"
400                         java_trait_constr = java_trait_constr + "\t\t\t\treturn result;\n"
401                     else:
402                         java_trait_constr = java_trait_constr + "\t\t\t\treturn ret;\n"
403                 java_trait_constr = java_trait_constr + "\t\t\t}\n"
404         java_trait_constr = java_trait_constr + "\t\t}"
405         for var in field_var_conversions:
406             if isinstance(var, ConvInfo):
407                 java_trait_constr = java_trait_constr + ", " + var.arg_name
408             else:
409                 java_trait_constr = java_trait_constr + ", " + var[1] + ".new_impl(" + var[1] + "_impl).bindings_instance"
410         out_java_trait += java_trait_constr + ");\n\t\treturn impl_holder.held;\n\t}\n"
411
412         out_java = out_java + "\t}\n"
413
414         out_java = out_java + "\tpublic static native long " + struct_name + "_new(" + struct_name + " impl"
415         for var in field_var_conversions:
416             if isinstance(var, ConvInfo):
417                 out_java = out_java + ", " + var.java_ty + " " + var.arg_name
418             else:
419                 out_java = out_java + ", " + var[0] + " " + var[1]
420         out_java = out_java + ");\n"
421         out_java = out_java + "\tpublic static native " + struct_name + " " + struct_name + "_get_obj_from_jcalls(long val);\n"
422
423         # Now that we've written out our java code (and created java_meths), generate C
424         out_c = "typedef struct " + struct_name + "_JCalls {\n"
425         out_c = out_c + "\tatomic_size_t refcnt;\n"
426         out_c = out_c + "\tJavaVM *vm;\n"
427         out_c = out_c + "\tjweak o;\n"
428         for var in field_var_conversions:
429             if isinstance(var, ConvInfo):
430                 # We're a regular ol' field
431                 pass
432             else:
433                 # We're a supertrait
434                 out_c = out_c + "\t" + var[0] + "_JCalls* " + var[1] + ";\n"
435         for fn in field_function_lines:
436             if fn.fn_name != "free" and fn.fn_name != "clone":
437                 out_c = out_c + "\tjmethodID " + fn.fn_name + "_meth;\n"
438         out_c = out_c + "} " + struct_name + "_JCalls;\n"
439
440         for fn_line in field_function_lines:
441             if fn_line.fn_name == "free":
442                 out_c = out_c + "static void " + struct_name + "_JCalls_free(void* this_arg) {\n"
443                 out_c = out_c + "\t" + struct_name + "_JCalls *j_calls = (" + struct_name + "_JCalls*) this_arg;\n"
444                 out_c = out_c + "\tif (atomic_fetch_sub_explicit(&j_calls->refcnt, 1, memory_order_acquire) == 1) {\n"
445                 out_c = out_c + "\t\tJNIEnv *env;\n"
446                 out_c = out_c + "\t\tDO_ASSERT((*j_calls->vm)->GetEnv(j_calls->vm, (void**)&env, JNI_VERSION_1_8) == JNI_OK);\n"
447                 out_c = out_c + "\t\t(*env)->DeleteWeakGlobalRef(env, j_calls->o);\n"
448                 out_c = out_c + "\t\tFREE(j_calls);\n"
449                 out_c = out_c + "\t}\n}\n"
450
451         for idx, fn_line in enumerate(field_function_lines):
452             if fn_line.fn_name != "free" and fn_line.fn_name != "clone":
453                 assert fn_line.ret_ty_info.ty_info.get_full_rust_ty()[1] == ""
454                 out_c = out_c + fn_line.ret_ty_info.ty_info.get_full_rust_ty()[0] + " " + fn_line.fn_name + "_jcall("
455                 if fn_line.self_is_const:
456                     out_c = out_c + "const void* this_arg"
457                 else:
458                     out_c = out_c + "void* this_arg"
459
460                 for idx, arg in enumerate(fn_line.args_ty):
461                     out_c = out_c + ", " + arg.ty_info.get_full_rust_ty()[0] + " " + arg.arg_name + arg.ty_info.get_full_rust_ty()[1]
462
463                 out_c = out_c + ") {\n"
464                 out_c = out_c + "\t" + struct_name + "_JCalls *j_calls = (" + struct_name + "_JCalls*) this_arg;\n"
465                 out_c = out_c + "\tJNIEnv *env;\n"
466                 out_c = out_c + "\tDO_ASSERT((*j_calls->vm)->GetEnv(j_calls->vm, (void**)&env, JNI_VERSION_1_8) == JNI_OK);\n"
467
468                 for arg_info in fn_line.args_ty:
469                     if arg_info.ret_conv is not None:
470                         out_c = out_c + "\t" + arg_info.ret_conv[0].replace('\n', '\n\t')
471                         out_c = out_c + arg_info.arg_name
472                         out_c = out_c + arg_info.ret_conv[1].replace('\n', '\n\t') + "\n"
473
474                 out_c = out_c + "\tjobject obj = (*env)->NewLocalRef(env, j_calls->o);\n\tCHECK(obj != NULL);\n"
475                 if fn_line.ret_ty_info.c_ty.endswith("Array"):
476                     out_c = out_c + "\t" + fn_line.ret_ty_info.c_ty + " arg = (*env)->CallObjectMethod(env, obj, j_calls->" + fn_line.fn_name + "_meth"
477                 elif not fn_line.ret_ty_info.passed_as_ptr:
478                     out_c = out_c + "\treturn (*env)->Call" + fn_line.ret_ty_info.java_ty.title() + "Method(env, obj, j_calls->" + fn_line.fn_name + "_meth"
479                 else:
480                     out_c = out_c + "\t" + fn_line.ret_ty_info.rust_obj + "* ret = (" + fn_line.ret_ty_info.rust_obj + "*)(*env)->CallLongMethod(env, obj, j_calls->" + fn_line.fn_name + "_meth"
481
482                 for idx, arg_info in enumerate(fn_line.args_ty):
483                     if arg_info.ret_conv is not None:
484                         out_c = out_c + ", " + arg_info.ret_conv_name
485                     else:
486                         out_c = out_c + ", " + arg_info.arg_name
487                 out_c = out_c + ");\n"
488                 if fn_line.ret_ty_info.arg_conv is not None:
489                     out_c = out_c + "\t" + fn_line.ret_ty_info.arg_conv.replace("\n", "\n\t") + "\n\treturn " + fn_line.ret_ty_info.arg_conv_name + ";\n"
490
491                 out_c = out_c + "}\n"
492
493         # Write out a clone function whether we need one or not, as we use them in moving to rust
494         out_c = out_c + "static void* " + struct_name + "_JCalls_clone(const void* this_arg) {\n"
495         out_c = out_c + "\t" + struct_name + "_JCalls *j_calls = (" + struct_name + "_JCalls*) this_arg;\n"
496         out_c = out_c + "\tatomic_fetch_add_explicit(&j_calls->refcnt, 1, memory_order_release);\n"
497         for var in field_var_conversions:
498             if not isinstance(var, ConvInfo):
499                 out_c = out_c + "\tatomic_fetch_add_explicit(&j_calls->" + var[1] + "->refcnt, 1, memory_order_release);\n"
500         out_c = out_c + "\treturn (void*) this_arg;\n"
501         out_c = out_c + "}\n"
502
503         out_c = out_c + "static inline " + struct_name + " " + struct_name + "_init (" + self.c_fn_args_pfx + ", jobject o"
504         for var in field_var_conversions:
505             if isinstance(var, ConvInfo):
506                 out_c = out_c + ", " + var.c_ty + " " + var.arg_name
507             else:
508                 out_c = out_c + ", jobject " + var[1]
509         out_c = out_c + ") {\n"
510
511         out_c = out_c + "\tjclass c = (*env)->GetObjectClass(env, o);\n"
512         out_c = out_c + "\tCHECK(c != NULL);\n"
513         out_c = out_c + "\t" + struct_name + "_JCalls *calls = MALLOC(sizeof(" + struct_name + "_JCalls), \"" + struct_name + "_JCalls\");\n"
514         out_c = out_c + "\tatomic_init(&calls->refcnt, 1);\n"
515         out_c = out_c + "\tDO_ASSERT((*env)->GetJavaVM(env, &calls->vm) == 0);\n"
516         out_c = out_c + "\tcalls->o = (*env)->NewWeakGlobalRef(env, o);\n"
517
518         for (fn_name, java_meth_descr) in java_meths:
519             if fn_name != "free" and fn_name != "clone":
520                 out_c = out_c + "\tcalls->" + fn_name + "_meth = (*env)->GetMethodID(env, c, \"" + fn_name + "\", \"" + java_meth_descr + "\");\n"
521                 out_c = out_c + "\tCHECK(calls->" + fn_name + "_meth != NULL);\n"
522
523         for var in field_var_conversions:
524             if isinstance(var, ConvInfo) and var.arg_conv is not None:
525                 out_c = out_c + "\n\t" + var.arg_conv.replace("\n", "\n\t") +"\n"
526         out_c = out_c + "\n\t" + struct_name + " ret = {\n"
527         out_c = out_c + "\t\t.this_arg = (void*) calls,\n"
528         for fn_line in field_function_lines:
529             if fn_line.fn_name != "free" and fn_line.fn_name != "clone":
530                 out_c = out_c + "\t\t." + fn_line.fn_name + " = " + fn_line.fn_name + "_jcall,\n"
531             elif fn_line.fn_name == "free":
532                 out_c = out_c + "\t\t.free = " + struct_name + "_JCalls_free,\n"
533             else:
534                 out_c = out_c + "\t\t.clone = " + struct_name + "_JCalls_clone,\n"
535         for var in field_var_conversions:
536             if isinstance(var, ConvInfo):
537                 if var.arg_conv_name is not None:
538                     out_c = out_c + "\t\t." + var.arg_name + " = " + var.arg_conv_name + ",\n"
539                     out_c = out_c + "\t\t.set_" + var.arg_name + " = NULL,\n"
540                 else:
541                     out_c = out_c + "\t\t." + var.var_name + " = " + var.var_name + ",\n"
542                     out_c = out_c + "\t\t.set_" + var.var_name + " = NULL,\n"
543             else:
544                 out_c = out_c + "\t\t." + var[1] + " = " + var[0] + "_init(env, clz, " + var[1] + "),\n"
545         out_c = out_c + "\t};\n"
546         for var in field_var_conversions:
547             if not isinstance(var, ConvInfo):
548                 out_c = out_c + "\tcalls->" + var[1] + " = ret." + var[1] + ".this_arg;\n"
549         out_c = out_c + "\treturn ret;\n"
550         out_c = out_c + "}\n"
551
552         out_c = out_c + self.c_fn_ty_pfx + "long " + self.c_fn_name_pfx + struct_name.replace("_", "_1") + "_1new (" + self.c_fn_args_pfx + ", jobject o"
553         for var in field_var_conversions:
554             if isinstance(var, ConvInfo):
555                 out_c = out_c + ", " + var.c_ty + " " + var.arg_name
556             else:
557                 out_c = out_c + ", jobject " + var[1]
558         out_c = out_c + ") {\n"
559         out_c = out_c + "\t" + struct_name + " *res_ptr = MALLOC(sizeof(" + struct_name + "), \"" + struct_name + "\");\n"
560         out_c = out_c + "\t*res_ptr = " + struct_name + "_init(env, clz, o"
561         for var in field_var_conversions:
562             if isinstance(var, ConvInfo):
563                 out_c = out_c + ", " + var.arg_name
564             else:
565                 out_c = out_c + ", " + var[1]
566         out_c = out_c + ");\n"
567         out_c = out_c + "\treturn (long)res_ptr;\n"
568         out_c = out_c + "}\n"
569
570         out_c = out_c + self.c_fn_ty_pfx + "jobject " + self.c_fn_name_pfx + struct_name.replace("_", "_1") + "_1get_1obj_1from_1jcalls (" + self.c_fn_args_pfx + ", " + self.ptr_c_ty + " val) {\n"
571         out_c = out_c + "\tjobject ret = (*env)->NewLocalRef(env, ((" + struct_name + "_JCalls*)val)->o);\n"
572         out_c = out_c + "\tCHECK(ret != NULL);\n"
573         out_c = out_c + "\treturn ret;\n"
574         out_c = out_c + "}\n"
575
576
577         return (out_java, out_java_trait, out_c)
578
579     def map_complex_enum(self, struct_name, variant_list, camel_to_snake):
580         java_hu_type = struct_name.replace("LDK", "")
581
582         out_java_enum = ""
583         out_java = ""
584         out_c = ""
585
586         out_java_enum += (self.hu_struct_file_prefix)
587         out_java_enum += ("export default class " + java_hu_type + " extends CommonBase {\n")
588         out_java_enum += ("\tprotected constructor(_dummy: object, ptr: number) { super(ptr); }\n")
589         out_java_enum += ("\tprotected finalize() {\n")
590         out_java_enum += ("\t\tsuper.finalize();\n")
591         out_java_enum += ("\t\tif (this.ptr != 0) { bindings." + java_hu_type + "_free(this.ptr); }\n")
592         out_java_enum += ("\t}\n")
593         out_java_enum += f"\tstatic constr_from_ptr(ptr: number): {java_hu_type} {{\n"
594         out_java_enum += (f"\t\tconst raw_val: bindings.{struct_name} = bindings." + struct_name + "_ref_from_ptr(ptr);\n")
595         java_hu_subclasses = ""
596
597         out_java +=  ("\tpublic static class " + struct_name + " {\n")
598         out_java +=  ("\t\tprivate " + struct_name + "() {}\n")
599         for var in variant_list:
600             out_java +=  ("\t\texport class " + var.var_name + " extends " + struct_name + " {\n")
601             java_hu_subclasses = java_hu_subclasses + "export class " + var.var_name + " extends " + java_hu_type + " {\n"
602             out_java_enum += ("\t\tif (raw_val instanceof bindings." + struct_name + "." + var.var_name + ") {\n")
603             out_java_enum += ("\t\t\treturn new " + var.var_name + "(this.ptr, raw_val);\n")
604             init_meth_params = ""
605             init_meth_body = ""
606             hu_conv_body = ""
607             for idx, field_ty in enumerate(var.fields):
608                 out_java += ("\t\t\tpublic " + field_ty.java_ty + " " + field_ty.arg_name + ";\n")
609                 java_hu_subclasses = java_hu_subclasses + "\tpublic " + field_ty.arg_name + f": {field_ty.java_hu_ty};\n"
610                 if field_ty.to_hu_conv is not None:
611                     hu_conv_body = hu_conv_body + "\t\tconst " + field_ty.arg_name + f": {field_ty.java_ty} = obj." + field_ty.arg_name + ";\n"
612                     hu_conv_body = hu_conv_body + "\t\t" + field_ty.to_hu_conv.replace("\n", "\n\t\t\t") + "\n"
613                     hu_conv_body = hu_conv_body + "\t\tthis." + field_ty.arg_name + " = " + field_ty.to_hu_conv_name + ";\n"
614                 else:
615                     hu_conv_body = hu_conv_body + "\t\tthis." + field_ty.arg_name + " = obj." + field_ty.arg_name + ";\n"
616                 if idx > 0:
617                     init_meth_params = init_meth_params + ", "
618                 init_meth_params = init_meth_params + field_ty.java_ty + " " + field_ty.arg_name
619                 init_meth_body = init_meth_body + "this." + field_ty.arg_name + " = " + field_ty.arg_name + "; "
620             out_java +=  ("\t\t\t" + var.var_name + "(" + init_meth_params + ") { ")
621             out_java +=  (init_meth_body)
622             out_java +=  ("}\n")
623             out_java += ("\t\t}\n")
624             out_java_enum += ("\t\t}\n")
625             java_hu_subclasses = java_hu_subclasses + "\tprivate constructor(ptr: number, obj: bindings." + struct_name + "." + var.var_name + ") {\n\t\tsuper(null, ptr);\n"
626             java_hu_subclasses = java_hu_subclasses + hu_conv_body
627             java_hu_subclasses = java_hu_subclasses + "\t}\n}\n"
628         out_java += ("\t\tstatic native void init();\n")
629         out_java += ("\t}\n")
630         out_java_enum += ("\t\tthrow new Error('oops, this should be unreachable'); // Unreachable without extending the (internal) bindings interface\n\t}\n\n")
631         out_java += ("\tstatic { " + struct_name + ".init(); }\n")
632         out_java += ("\tpublic static native " + struct_name + " " + struct_name + "_ref_from_ptr(long ptr);\n");
633
634         out_c += (self.c_fn_ty_pfx + self.c_complex_enum_pass_ty(struct_name) + " " + self.c_fn_name_pfx + struct_name.replace("_", "_1") + "_1ref_1from_1ptr (" + self.c_fn_args_pfx + ", " + self.ptr_c_ty + " ptr) {\n")
635         out_c += ("\t" + struct_name + " *obj = (" + struct_name + "*)ptr;\n")
636         out_c += ("\tswitch(obj->tag) {\n")
637         for var in variant_list:
638             out_c += ("\t\tcase " + struct_name + "_" + var.var_name + ": {\n")
639             c_params = []
640             for idx, field_map in enumerate(var.fields):
641                 if field_map.ret_conv is not None:
642                     out_c += ("\t\t\t" + field_map.ret_conv[0].replace("\n", "\n\t\t\t"))
643                     out_c += ("obj->" + camel_to_snake(var.var_name) + "." + field_map.arg_name)
644                     out_c += (field_map.ret_conv[1].replace("\n", "\n\t\t\t") + "\n")
645                     c_params.append(field_map.ret_conv_name)
646                 else:
647                     c_params.append("obj->" + camel_to_snake(var.var_name) + "." + field_map.arg_name)
648             out_c += ("\t\t\treturn " + self.c_constr_native_complex_enum(struct_name, var.var_name, c_params) + ";\n")
649             out_c += ("\t\t}\n")
650         out_c += ("\t\tdefault: abort();\n")
651         out_c += ("\t}\n}\n")
652         out_java_enum += ("}\n")
653         out_java_enum += (java_hu_subclasses)
654         return (out_java, out_java_enum, out_c)