add typescript tuple generics
[ldk-java] / java_strings.py
1 from bindingstypes import *
2
3 class Consts:
4     def __init__(self, DEBUG):
5
6         self.c_type_map = dict(
7             uint8_t = ['byte'],
8             uint16_t = ['short'],
9             uint32_t = ['int'],
10             long = ['long'],
11         )
12
13         self.common_base = """package org.ldk.structs;
14 import java.util.LinkedList;
15 class CommonBase {
16         long ptr;
17         LinkedList<Object> ptrs_to = new LinkedList();
18         protected CommonBase(long ptr) { this.ptr = ptr; }
19         public long _test_only_get_ptr() { return this.ptr; }
20 }
21 """
22
23         self.c_file_pfx = """#include \"org_ldk_impl_bindings.h\"
24 #include <rust_types.h>
25 #include <lightning.h>
26 #include <string.h>
27 #include <stdatomic.h>
28 #include <stdlib.h>
29 """
30
31         if not DEBUG:
32             self.c_file_pfx = self.c_file_pfx + """#define MALLOC(a, _) malloc(a)
33 #define FREE(p) if ((long)(p) > 1024) { free(p); }
34 #define DO_ASSERT(a) (void)(a)
35 #define CHECK(a)
36 """
37         else:
38             self.c_file_pfx = self.c_file_pfx + """#include <assert.h>
39 // Always run a, then assert it is true:
40 #define DO_ASSERT(a) do { bool _assert_val = (a); assert(_assert_val); } while(0)
41 // Assert a is true or do nothing
42 #define CHECK(a) DO_ASSERT(a)
43
44 // Running a leak check across all the allocations and frees of the JDK is a mess,
45 // so instead we implement our own naive leak checker here, relying on the -wrap
46 // linker option to wrap malloc/calloc/realloc/free, tracking everyhing allocated
47 // and free'd in Rust or C across the generated bindings shared library.
48 #include <threads.h>
49 #include <execinfo.h>
50 #include <unistd.h>
51 static mtx_t allocation_mtx;
52
53 void __attribute__((constructor)) init_mtx() {
54         DO_ASSERT(mtx_init(&allocation_mtx, mtx_plain) == thrd_success);
55 }
56
57 #define BT_MAX 128
58 typedef struct allocation {
59         struct allocation* next;
60         void* ptr;
61         const char* struct_name;
62         void* bt[BT_MAX];
63         int bt_len;
64 } allocation;
65 static allocation* allocation_ll = NULL;
66
67 void* __real_malloc(size_t len);
68 void* __real_calloc(size_t nmemb, size_t len);
69 static void new_allocation(void* res, const char* struct_name) {
70         allocation* new_alloc = __real_malloc(sizeof(allocation));
71         new_alloc->ptr = res;
72         new_alloc->struct_name = struct_name;
73         new_alloc->bt_len = backtrace(new_alloc->bt, BT_MAX);
74         DO_ASSERT(mtx_lock(&allocation_mtx) == thrd_success);
75         new_alloc->next = allocation_ll;
76         allocation_ll = new_alloc;
77         DO_ASSERT(mtx_unlock(&allocation_mtx) == thrd_success);
78 }
79 static void* MALLOC(size_t len, const char* struct_name) {
80         void* res = __real_malloc(len);
81         new_allocation(res, struct_name);
82         return res;
83 }
84 void __real_free(void* ptr);
85 static void alloc_freed(void* ptr) {
86         allocation* p = NULL;
87         DO_ASSERT(mtx_lock(&allocation_mtx) == thrd_success);
88         allocation* it = allocation_ll;
89         while (it->ptr != ptr) {
90                 p = it; it = it->next;
91                 if (it == NULL) {
92                         fprintf(stderr, "Tried to free unknown pointer %p at:\\n", ptr);
93                         void* bt[BT_MAX];
94                         int bt_len = backtrace(bt, BT_MAX);
95                         backtrace_symbols_fd(bt, bt_len, STDERR_FILENO);
96                         fprintf(stderr, "\\n\\n");
97                         DO_ASSERT(mtx_unlock(&allocation_mtx) == thrd_success);
98                         return; // addrsan should catch malloc-unknown and print more info than we have
99                 }
100         }
101         if (p) { p->next = it->next; } else { allocation_ll = it->next; }
102         DO_ASSERT(mtx_unlock(&allocation_mtx) == thrd_success);
103         DO_ASSERT(it->ptr == ptr);
104         __real_free(it);
105 }
106 static void FREE(void* ptr) {
107         if ((long)ptr < 1024) return; // Rust loves to create pointers to the NULL page for dummys
108         alloc_freed(ptr);
109         __real_free(ptr);
110 }
111
112 void* __wrap_malloc(size_t len) {
113         void* res = __real_malloc(len);
114         new_allocation(res, "malloc call");
115         return res;
116 }
117 void* __wrap_calloc(size_t nmemb, size_t len) {
118         void* res = __real_calloc(nmemb, len);
119         new_allocation(res, "calloc call");
120         return res;
121 }
122 void __wrap_free(void* ptr) {
123         if (ptr == NULL) return;
124         alloc_freed(ptr);
125         __real_free(ptr);
126 }
127
128 void* __real_realloc(void* ptr, size_t newlen);
129 void* __wrap_realloc(void* ptr, size_t len) {
130         if (ptr != NULL) alloc_freed(ptr);
131         void* res = __real_realloc(ptr, len);
132         new_allocation(res, "realloc call");
133         return res;
134 }
135 void __wrap_reallocarray(void* ptr, size_t new_sz) {
136         // Rust doesn't seem to use reallocarray currently
137         DO_ASSERT(false);
138 }
139
140 void __attribute__((destructor)) check_leaks() {
141         for (allocation* a = allocation_ll; a != NULL; a = a->next) {
142                 fprintf(stderr, "%s %p remains:\\n", a->struct_name, a->ptr);
143                 backtrace_symbols_fd(a->bt, a->bt_len, STDERR_FILENO);
144                 fprintf(stderr, "\\n\\n");
145         }
146         DO_ASSERT(allocation_ll == NULL);
147 }
148 """
149         self.c_file_pfx = self.c_file_pfx + """
150 static jmethodID ordinal_meth = NULL;
151 static jmethodID slicedef_meth = NULL;
152 static jclass slicedef_cls = NULL;
153 JNIEXPORT void Java_org_ldk_impl_bindings_init(JNIEnv * env, jclass _b, jclass enum_class, jclass slicedef_class) {
154         ordinal_meth = (*env)->GetMethodID(env, enum_class, "ordinal", "()I");
155         CHECK(ordinal_meth != NULL);
156         slicedef_meth = (*env)->GetMethodID(env, slicedef_class, "<init>", "(JJJ)V");
157         CHECK(slicedef_meth != NULL);
158         slicedef_cls = (*env)->NewGlobalRef(env, slicedef_class);
159         CHECK(slicedef_cls != NULL);
160 }
161
162 JNIEXPORT jboolean JNICALL Java_org_ldk_impl_bindings_deref_1bool (JNIEnv * env, jclass _a, jlong ptr) {
163         return *((bool*)ptr);
164 }
165 JNIEXPORT jlong JNICALL Java_org_ldk_impl_bindings_deref_1long (JNIEnv * env, jclass _a, jlong ptr) {
166         return *((long*)ptr);
167 }
168 JNIEXPORT void JNICALL Java_org_ldk_impl_bindings_free_1heap_1ptr (JNIEnv * env, jclass _a, jlong ptr) {
169         FREE((void*)ptr);
170 }
171 JNIEXPORT jbyteArray JNICALL Java_org_ldk_impl_bindings_read_1bytes (JNIEnv * env, jclass _b, jlong ptr, jlong len) {
172         jbyteArray ret_arr = (*env)->NewByteArray(env, len);
173         (*env)->SetByteArrayRegion(env, ret_arr, 0, len, (unsigned char*)ptr);
174         return ret_arr;
175 }
176 JNIEXPORT jbyteArray JNICALL Java_org_ldk_impl_bindings_get_1u8_1slice_1bytes (JNIEnv * env, jclass _b, jlong slice_ptr) {
177         LDKu8slice *slice = (LDKu8slice*)slice_ptr;
178         jbyteArray ret_arr = (*env)->NewByteArray(env, slice->datalen);
179         (*env)->SetByteArrayRegion(env, ret_arr, 0, slice->datalen, slice->data);
180         return ret_arr;
181 }
182 JNIEXPORT long JNICALL Java_org_ldk_impl_bindings_bytes_1to_1u8_1vec (JNIEnv * env, jclass _b, jbyteArray bytes) {
183         LDKCVec_u8Z *vec = (LDKCVec_u8Z*)MALLOC(sizeof(LDKCVec_u8Z), "LDKCVec_u8");
184         vec->datalen = (*env)->GetArrayLength(env, bytes);
185         vec->data = (uint8_t*)MALLOC(vec->datalen, "LDKCVec_u8Z Bytes");
186         (*env)->GetByteArrayRegion (env, bytes, 0, vec->datalen, vec->data);
187         return (long)vec;
188 }
189 JNIEXPORT jbyteArray JNICALL Java_org_ldk_impl_bindings_txpointer_1get_1buffer (JNIEnv * env, jclass _b, jlong ptr) {
190         LDKTransaction *txdata = (LDKTransaction*)ptr;
191         LDKu8slice slice;
192         slice.data = txdata->data;
193         slice.datalen = txdata->datalen;
194         return Java_org_ldk_impl_bindings_get_1u8_1slice_1bytes(env, _b, (long)&slice);
195 }
196 JNIEXPORT long JNICALL Java_org_ldk_impl_bindings_new_1txpointer_1copy_1data (JNIEnv * env, jclass _b, jbyteArray bytes) {
197         LDKTransaction *txdata = (LDKTransaction*)MALLOC(sizeof(LDKTransaction), "LDKTransaction");
198         txdata->datalen = (*env)->GetArrayLength(env, bytes);
199         txdata->data = (uint8_t*)MALLOC(txdata->datalen, "Tx Data Bytes");
200         txdata->data_is_owned = false;
201         (*env)->GetByteArrayRegion (env, bytes, 0, txdata->datalen, txdata->data);
202         return (long)txdata;
203 }
204 JNIEXPORT void JNICALL Java_org_ldk_impl_bindings_txpointer_1free (JNIEnv * env, jclass _b, jlong ptr) {
205         LDKTransaction *tx = (LDKTransaction*)ptr;
206         tx->data_is_owned = true;
207         Transaction_free(*tx);
208         FREE((void*)ptr);
209 }
210 JNIEXPORT jlong JNICALL Java_org_ldk_impl_bindings_vec_1slice_1len (JNIEnv * env, jclass _a, jlong ptr) {
211         // Check offsets of a few Vec types are all consistent as we're meant to be generic across types
212         _Static_assert(offsetof(LDKCVec_u8Z, datalen) == offsetof(LDKCVec_SignatureZ, datalen), "Vec<*> needs to be mapped identically");
213         _Static_assert(offsetof(LDKCVec_u8Z, datalen) == offsetof(LDKCVec_MessageSendEventZ, datalen), "Vec<*> needs to be mapped identically");
214         _Static_assert(offsetof(LDKCVec_u8Z, datalen) == offsetof(LDKCVec_EventZ, datalen), "Vec<*> needs to be mapped identically");
215         _Static_assert(offsetof(LDKCVec_u8Z, datalen) == offsetof(LDKCVec_C2Tuple_usizeTransactionZZ, datalen), "Vec<*> needs to be mapped identically");
216         LDKCVec_u8Z *vec = (LDKCVec_u8Z*)ptr;
217         return (long)vec->datalen;
218 }
219 JNIEXPORT long JNICALL Java_org_ldk_impl_bindings_new_1empty_1slice_1vec (JNIEnv * env, jclass _b) {
220         // Check sizes of a few Vec types are all consistent as we're meant to be generic across types
221         _Static_assert(sizeof(LDKCVec_u8Z) == sizeof(LDKCVec_SignatureZ), "Vec<*> needs to be mapped identically");
222         _Static_assert(sizeof(LDKCVec_u8Z) == sizeof(LDKCVec_MessageSendEventZ), "Vec<*> needs to be mapped identically");
223         _Static_assert(sizeof(LDKCVec_u8Z) == sizeof(LDKCVec_EventZ), "Vec<*> needs to be mapped identically");
224         _Static_assert(sizeof(LDKCVec_u8Z) == sizeof(LDKCVec_C2Tuple_usizeTransactionZZ), "Vec<*> needs to be mapped identically");
225         LDKCVec_u8Z *vec = (LDKCVec_u8Z*)MALLOC(sizeof(LDKCVec_u8Z), "Empty LDKCVec");
226         vec->data = NULL;
227         vec->datalen = 0;
228         return (long)vec;
229 }
230
231 // We assume that CVec_u8Z and u8slice are the same size and layout (and thus pointers to the two can be mixed)
232 _Static_assert(sizeof(LDKCVec_u8Z) == sizeof(LDKu8slice), "Vec<u8> and [u8] need to have been mapped identically");
233 _Static_assert(offsetof(LDKCVec_u8Z, data) == offsetof(LDKu8slice, data), "Vec<u8> and [u8] need to have been mapped identically");
234 _Static_assert(offsetof(LDKCVec_u8Z, datalen) == offsetof(LDKu8slice, datalen), "Vec<u8> and [u8] need to have been mapped identically");
235
236 _Static_assert(sizeof(jlong) == sizeof(int64_t), "We assume that j-types are the same as C types");
237 _Static_assert(sizeof(jbyte) == sizeof(char), "We assume that j-types are the same as C types");
238 _Static_assert(sizeof(void*) <= 8, "Pointers must fit into 64 bits");
239
240 typedef jlongArray int64_tArray;
241 typedef jbyteArray int8_tArray;
242
243 """
244
245         self.hu_struct_file_prefix = """package org.ldk.structs;
246
247 import org.ldk.impl.bindings;
248 import org.ldk.enums.*;
249 import org.ldk.util.*;
250 import java.util.Arrays;
251
252 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
253 """
254         self.c_fn_ty_pfx = "JNIEXPORT "
255         self.c_fn_name_pfx = "JNICALL Java_org_ldk_impl_bindings_"
256         self.c_fn_args_pfx = "JNIEnv *env, jclass clz"
257         self.file_ext = ".java"
258         self.ptr_c_ty = "int64_t"
259         self.ptr_native_ty = "long"
260         self.result_c_ty = "jclass"
261         self.ptr_arr = "jobjectArray"
262         self.get_native_arr_len_call = ("(*env)->GetArrayLength(env, ", ")")
263         self.get_native_arr_ptr_call = ("(*env)->GetPrimitiveArrayCritical(env, ", ", NULL)")
264
265     def release_native_arr_ptr_call(self, arr_var, arr_ptr_var):
266         return "(*env)->ReleasePrimitiveArrayCritical(env, " + arr_var + ", " + arr_ptr_var + ", 0)"
267     def create_native_arr_call(self, arr_len, ty_info):
268         if ty_info.c_ty == "int8_tArray":
269             return "(*env)->NewByteArray(env, " + arr_len + ")"
270         else:
271             return "(*env)->New" + ty_info.java_ty.strip("[]").title() + "Array(env, " + arr_len + ")"
272     def set_native_arr_contents(self, arr_name, arr_len, ty_info):
273         if ty_info.c_ty == "int8_tArray":
274             return ("(*env)->SetByteArrayRegion(env, " + arr_name + ", 0, " + arr_len + ", ", ")")
275         else:
276             assert False
277     def get_native_arr_contents(self, arr_name, dest_name, arr_len, ty_info, copy):
278         if ty_info.c_ty == "int8_tArray":
279             if copy:
280                 return "(*env)->GetByteArrayRegion(env, " + arr_name + ", 0, " + arr_len + ", " + dest_name + ")"
281             else:
282                 return "(*env)->GetByteArrayElements (env, " + arr_name + ", NULL)"
283         elif not ty_info.java_ty[:len(ty_info.java_ty) - 2].endswith("[]"):
284             return "(*env)->Get" + ty_info.subty.java_ty.title() + "ArrayElements (env, " + arr_name + ", NULL)"
285         else:
286             return None
287     def get_native_arr_elem(self, arr_name, idxc, ty_info):
288         if self.get_native_arr_contents(arr_name, "", "", ty_info, False) is None:
289             return "(*env)->GetObjectArrayElement(env, " + arr_name + ", " + idxc + ")"
290         else:
291             assert False # Only called if above is None
292     def cleanup_native_arr_ref_contents(self, arr_name, dest_name, arr_len, ty_info):
293         if ty_info.c_ty == "int8_tArray":
294             return "(*env)->ReleaseByteArrayElements(env, " + arr_name + ", (int8_t*)" + dest_name + ", 0);"
295         else:
296             return "(*env)->Release" + ty_info.java_ty.strip("[]").title() + "ArrayElements(env, " + arr_name + ", " + dest_name + ", 0)"
297
298     def init_str(self, c_array_class_caches):
299         res = ""
300         for ty in c_array_class_caches:
301             res = res + "static jclass " + ty + "_clz = NULL;\n"
302         res = res + "JNIEXPORT void Java_org_ldk_impl_bindings_init_1class_1cache(JNIEnv * env, jclass clz) {\n"
303         for ty in c_array_class_caches:
304             res = res + "\t" + ty + "_clz = (*env)->FindClass(env, \"" + ty.replace("arr_of_", "[") + "\");\n"
305             res = res + "\tCHECK(" + ty + "_clz != NULL);\n"
306             res = res + "\t" + ty + "_clz = (*env)->NewGlobalRef(env, " + ty + "_clz);\n"
307         res = res + "}\n"
308         return res
309
310     def native_c_unitary_enum_map(self, struct_name, variants):
311         out_java_enum = "package org.ldk.enums;\n\n"
312         out_java = ""
313         out_c = ""
314         out_c = out_c + "static inline " + struct_name + " " + struct_name + "_from_java(" + self.c_fn_args_pfx + ") {\n"
315         out_c = out_c + "\tswitch ((*env)->CallIntMethod(env, clz, ordinal_meth)) {\n"
316
317         out_java_enum = out_java_enum + "public enum " + struct_name + " {\n"
318         ord_v = 0
319         for var in variants:
320             out_java_enum = out_java_enum + "\t" + var + ",\n"
321             out_c = out_c + "\t\tcase %d: return %s;\n" % (ord_v, var)
322             ord_v = ord_v + 1
323         out_java_enum = out_java_enum + "\t; static native void init();\n"
324         out_java_enum = out_java_enum + "\tstatic { init(); }\n"
325         out_java_enum = out_java_enum + "}"
326         out_java = out_java + "\tstatic { " + struct_name + ".values(); /* Force enum statics to run */ }\n"
327         out_c = out_c + "\t}\n"
328         out_c = out_c + "\tabort();\n"
329         out_c = out_c + "}\n"
330
331         out_c = out_c + "static jclass " + struct_name + "_class = NULL;\n"
332         for var in variants:
333             out_c = out_c + "static jfieldID " + struct_name + "_" + var + " = NULL;\n"
334         out_c = out_c + self.c_fn_ty_pfx + "void JNICALL Java_org_ldk_enums_" + struct_name.replace("_", "_1") + "_init (" + self.c_fn_args_pfx + ") {\n"
335         out_c = out_c + "\t" + struct_name + "_class = (*env)->NewGlobalRef(env, clz);\n"
336         out_c = out_c + "\tCHECK(" + struct_name + "_class != NULL);\n"
337         for var in variants:
338             out_c = out_c + "\t" + struct_name + "_" + var + " = (*env)->GetStaticFieldID(env, " + struct_name + "_class, \"" + var + "\", \"Lorg/ldk/enums/" + struct_name + ";\");\n"
339             out_c = out_c + "\tCHECK(" + struct_name + "_" + var + " != NULL);\n"
340         out_c = out_c + "}\n"
341         out_c = out_c + "static inline jclass " + struct_name + "_to_java(JNIEnv *env, " + struct_name + " val) {\n"
342         out_c = out_c + "\tswitch (val) {\n"
343         ord_v = 0
344         for var in variants:
345             out_c = out_c + "\t\tcase " + var + ":\n"
346             out_c = out_c + "\t\t\treturn (*env)->GetStaticObjectField(env, " + struct_name + "_class, " + struct_name + "_" + var + ");\n"
347             ord_v = ord_v + 1
348         out_c = out_c + "\t\tdefault: abort();\n"
349         out_c = out_c + "\t}\n"
350         out_c = out_c + "}\n\n"
351
352         return (out_c, out_java_enum, out_java)
353
354     def c_unitary_enum_to_native_call(self, ty_info):
355         return (ty_info.rust_obj + "_to_java(env, ", ")")
356     def native_unitary_enum_to_c_call(self, ty_info):
357         return (ty_info.rust_obj + "_from_java(env, ", ")")
358
359     def c_complex_enum_pfx(self, struct_name, variants, init_meth_jty_strs):
360         out_c = ""
361         for var in variants:
362             out_c = out_c + "static jclass " + struct_name + "_" + var + "_class = NULL;\n"
363             out_c = out_c + "static jmethodID " + struct_name + "_" + var + "_meth = NULL;\n"
364         out_c = out_c + self.c_fn_ty_pfx + "void JNICALL Java_org_ldk_impl_bindings_00024" + struct_name.replace("_", "_1") + "_init (" + self.c_fn_args_pfx + ") {\n"
365         for var_name in variants:
366             out_c = out_c + "\t" + struct_name + "_" + var_name + "_class =\n"
367             out_c = out_c + "\t\t(*env)->NewGlobalRef(env, (*env)->FindClass(env, \"Lorg/ldk/impl/bindings$" + struct_name + "$" + var_name + ";\"));\n"
368             out_c = out_c + "\tCHECK(" + struct_name + "_" + var_name + "_class != NULL);\n"
369             out_c = out_c + "\t" + struct_name + "_" + var_name + "_meth = (*env)->GetMethodID(env, " + struct_name + "_" + var_name + "_class, \"<init>\", \"(" + init_meth_jty_strs[var_name] + ")V\");\n"
370             out_c = out_c + "\tCHECK(" + struct_name + "_" + var_name + "_meth != NULL);\n"
371         out_c = out_c + "}\n"
372         return out_c
373
374     def c_complex_enum_pass_ty(self, struct_name):
375         return "jobject"
376
377     def c_constr_native_complex_enum(self, struct_name, variant, c_params):
378         ret = "(*env)->NewObject(env, " + struct_name + "_" + variant + "_class, " + struct_name + "_" + variant + "_meth"
379         for param in c_params:
380             ret = ret + ", " + param
381         return ret + ")"
382
383     def native_c_map_trait(self, struct_name, field_vars, field_fns):
384         out_java_trait = ""
385         out_java = ""
386
387         # First generate most of the Java code, note that we need information about java method argument strings for C
388         out_java_trait = out_java_trait + self.hu_struct_file_prefix
389         out_java_trait = out_java_trait + "public class " + struct_name.replace("LDK","") + " extends CommonBase {\n"
390         out_java_trait = out_java_trait + "\tfinal bindings." + struct_name + " bindings_instance;\n"
391         out_java_trait = out_java_trait + "\t" + struct_name.replace("LDK", "") + "(Object _dummy, long ptr) { super(ptr); bindings_instance = null; }\n"
392         out_java_trait = out_java_trait + "\tprivate " + struct_name.replace("LDK", "") + "(bindings." + struct_name + " arg"
393         for var in field_vars:
394             if isinstance(var, ConvInfo):
395                 out_java_trait = out_java_trait + ", " + var.java_hu_ty + " " + var.arg_name
396             else:
397                 out_java_trait = out_java_trait + ", bindings." + var[0] + " " + var[1]
398         out_java_trait = out_java_trait + ") {\n"
399         out_java_trait = out_java_trait + "\t\tsuper(bindings." + struct_name + "_new(arg"
400         for var in field_vars:
401             if isinstance(var, ConvInfo):
402                 if var.from_hu_conv is not None:
403                     out_java_trait = out_java_trait + ", " + var.from_hu_conv[0]
404                 else:
405                     out_java_trait = out_java_trait + ", " + var.arg_name
406             else:
407                 out_java_trait = out_java_trait + ", " + var[1]
408         out_java_trait = out_java_trait + "));\n"
409         out_java_trait = out_java_trait + "\t\tthis.ptrs_to.add(arg);\n"
410         for var in field_vars:
411             if isinstance(var, ConvInfo):
412                 if var.from_hu_conv is not None and var.from_hu_conv[1] != "":
413                     out_java_trait = out_java_trait + "\t\t" + var.from_hu_conv[1] + ";\n"
414             else:
415                 out_java_trait = out_java_trait + "\t\tthis.ptrs_to.add(" + var[1] + ");\n"
416         out_java_trait = out_java_trait + "\t\tthis.bindings_instance = arg;\n"
417         out_java_trait = out_java_trait + "\t}\n"
418         out_java_trait = out_java_trait + "\t@Override @SuppressWarnings(\"deprecation\")\n"
419         out_java_trait = out_java_trait + "\tprotected void finalize() throws Throwable {\n"
420         out_java_trait = out_java_trait + "\t\tif (ptr != 0) { bindings." + struct_name.replace("LDK","") + "_free(ptr); } super.finalize();\n"
421         out_java_trait = out_java_trait + "\t}\n\n"
422
423         java_trait_constr = "\tprivate static class " + struct_name + "Holder { " + struct_name.replace("LDK", "") + " held; }\n"
424         java_trait_constr = java_trait_constr + "\tpublic static " + struct_name.replace("LDK", "") + " new_impl(" + struct_name.replace("LDK", "") + "Interface arg"
425         for var in field_vars:
426             if isinstance(var, ConvInfo):
427                 java_trait_constr = java_trait_constr + ", " + var.java_hu_ty + " " + var.arg_name
428             else:
429                 # Ideally we'd be able to take any instance of the interface, but our C code can only represent
430                 # Java-implemented version, so we require users pass a Java implementation here :/
431                 java_trait_constr = java_trait_constr + ", " + var[0].replace("LDK", "") + "." + var[0].replace("LDK", "") + "Interface " + var[1] + "_impl"
432         java_trait_constr = java_trait_constr + ") {\n\t\tfinal " + struct_name + "Holder impl_holder = new " + struct_name + "Holder();\n"
433         java_trait_constr = java_trait_constr + "\t\timpl_holder.held = new " + struct_name.replace("LDK", "") + "(new bindings." + struct_name + "() {\n"
434         out_java_trait = out_java_trait + "\tpublic static interface " + struct_name.replace("LDK", "") + "Interface {\n"
435         out_java = out_java + "\tpublic interface " + struct_name + " {\n"
436         java_meths = []
437         for fn_line in field_fns:
438             java_meth_descr = "("
439             if fn_line.fn_name != "free" and fn_line.fn_name != "clone":
440                 out_java = out_java + "\t\t " + fn_line.ret_ty_info.java_ty + " " + fn_line.fn_name + "("
441                 java_trait_constr = java_trait_constr + "\t\t\t@Override public " + fn_line.ret_ty_info.java_ty + " " + fn_line.fn_name + "("
442                 out_java_trait = out_java_trait + "\t\t" + fn_line.ret_ty_info.java_hu_ty + " " + fn_line.fn_name + "("
443
444                 for idx, arg_conv_info in enumerate(fn_line.args_ty):
445                     if idx >= 1:
446                         out_java = out_java + ", "
447                         java_trait_constr = java_trait_constr + ", "
448                         out_java_trait = out_java_trait + ", "
449                     out_java = out_java + arg_conv_info.java_ty + " " + arg_conv_info.arg_name
450                     out_java_trait = out_java_trait + arg_conv_info.java_hu_ty + " " + arg_conv_info.arg_name
451                     java_trait_constr = java_trait_constr + arg_conv_info.java_ty + " " + arg_conv_info.arg_name
452                     java_meth_descr = java_meth_descr + arg_conv_info.java_fn_ty_arg
453                 java_meth_descr = java_meth_descr + ")" + fn_line.ret_ty_info.java_fn_ty_arg
454                 java_meths.append((fn_line.fn_name, java_meth_descr))
455
456                 out_java = out_java + ");\n"
457                 out_java_trait = out_java_trait + ");\n"
458                 java_trait_constr = java_trait_constr + ") {\n"
459
460                 for arg_info in fn_line.args_ty:
461                     if arg_info.to_hu_conv is not None:
462                         java_trait_constr = java_trait_constr + "\t\t\t\t" + arg_info.to_hu_conv.replace("\n", "\n\t\t\t\t") + "\n"
463
464                 if fn_line.ret_ty_info.java_ty != "void":
465                     java_trait_constr = java_trait_constr + "\t\t\t\t" + fn_line.ret_ty_info.java_hu_ty + " ret = arg." + fn_line.fn_name + "("
466                 else:
467                     java_trait_constr = java_trait_constr + "\t\t\t\targ." + fn_line.fn_name + "("
468
469                 for idx, arg_info in enumerate(fn_line.args_ty):
470                     if idx != 0:
471                         java_trait_constr = java_trait_constr + ", "
472                     if arg_info.to_hu_conv_name is not None:
473                         java_trait_constr = java_trait_constr + arg_info.to_hu_conv_name
474                     else:
475                         java_trait_constr = java_trait_constr + arg_info.arg_name
476
477                 java_trait_constr = java_trait_constr + ");\n"
478                 if fn_line.ret_ty_info.java_ty != "void":
479                     if fn_line.ret_ty_info.from_hu_conv is not None:
480                         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"
481                         if fn_line.ret_ty_info.from_hu_conv[1] != "":
482                             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"
483                         #if fn_line.ret_ty_info.rust_obj in result_types:
484                         # XXX: We need to handle this in conversion logic so that its cross-language!
485                             # Avoid double-free by breaking the result - we should learn to clone these and then we can be safe instead
486                         #    java_trait_constr = java_trait_constr + "\t\t\t\tret.ptr = 0;\n"
487                         java_trait_constr = java_trait_constr + "\t\t\t\treturn result;\n"
488                     else:
489                         java_trait_constr = java_trait_constr + "\t\t\t\treturn ret;\n"
490                 java_trait_constr = java_trait_constr + "\t\t\t}\n"
491         java_trait_constr = java_trait_constr + "\t\t}"
492         for var in field_vars:
493             if isinstance(var, ConvInfo):
494                 java_trait_constr = java_trait_constr + ", " + var.arg_name
495             else:
496                 java_trait_constr = java_trait_constr + ", " + var[1] + ".new_impl(" + var[1] + "_impl).bindings_instance"
497         out_java_trait = out_java_trait + "\t}\n"
498         out_java_trait = out_java_trait + java_trait_constr + ");\n\t\treturn impl_holder.held;\n\t}\n"
499
500         out_java = out_java + "\t}\n"
501
502         out_java = out_java + "\tpublic static native long " + struct_name + "_new(" + struct_name + " impl"
503         for var in field_vars:
504             if isinstance(var, ConvInfo):
505                 out_java = out_java + ", " + var.java_ty + " " + var.arg_name
506             else:
507                 out_java = out_java + ", " + var[0] + " " + var[1]
508         out_java = out_java + ");\n"
509         out_java = out_java + "\tpublic static native " + struct_name + " " + struct_name + "_get_obj_from_jcalls(long val);\n"
510
511         # Now that we've written out our java code (and created java_meths), generate C
512         out_c = "typedef struct " + struct_name + "_JCalls {\n"
513         out_c = out_c + "\tatomic_size_t refcnt;\n"
514         out_c = out_c + "\tJavaVM *vm;\n"
515         out_c = out_c + "\tjweak o;\n"
516         for var in field_vars:
517             if isinstance(var, ConvInfo):
518                 # We're a regular ol' field
519                 pass
520             else:
521                 # We're a supertrait
522                 out_c = out_c + "\t" + var[0] + "_JCalls* " + var[1] + ";\n"
523         for fn in field_fns:
524             if fn.fn_name != "free" and fn.fn_name != "clone":
525                 out_c = out_c + "\tjmethodID " + fn.fn_name + "_meth;\n"
526         out_c = out_c + "} " + struct_name + "_JCalls;\n"
527
528         for fn_line in field_fns:
529             if fn_line.fn_name == "free":
530                 out_c = out_c + "static void " + struct_name + "_JCalls_free(void* this_arg) {\n"
531                 out_c = out_c + "\t" + struct_name + "_JCalls *j_calls = (" + struct_name + "_JCalls*) this_arg;\n"
532                 out_c = out_c + "\tif (atomic_fetch_sub_explicit(&j_calls->refcnt, 1, memory_order_acquire) == 1) {\n"
533                 out_c = out_c + "\t\tJNIEnv *env;\n"
534                 out_c = out_c + "\t\tDO_ASSERT((*j_calls->vm)->GetEnv(j_calls->vm, (void**)&env, JNI_VERSION_1_8) == JNI_OK);\n"
535                 out_c = out_c + "\t\t(*env)->DeleteWeakGlobalRef(env, j_calls->o);\n"
536                 out_c = out_c + "\t\tFREE(j_calls);\n"
537                 out_c = out_c + "\t}\n}\n"
538
539         for idx, fn_line in enumerate(field_fns):
540             if fn_line.fn_name != "free" and fn_line.fn_name != "clone":
541                 assert fn_line.ret_ty_info.ty_info.get_full_rust_ty()[1] == ""
542                 out_c = out_c + fn_line.ret_ty_info.ty_info.get_full_rust_ty()[0] + " " + fn_line.fn_name + "_jcall("
543                 if fn_line.self_is_const:
544                     out_c = out_c + "const void* this_arg"
545                 else:
546                     out_c = out_c + "void* this_arg"
547
548                 for idx, arg in enumerate(fn_line.args_ty):
549                     out_c = out_c + ", " + arg.ty_info.get_full_rust_ty()[0] + " " + arg.arg_name + arg.ty_info.get_full_rust_ty()[1]
550
551                 out_c = out_c + ") {\n"
552                 out_c = out_c + "\t" + struct_name + "_JCalls *j_calls = (" + struct_name + "_JCalls*) this_arg;\n"
553                 out_c = out_c + "\tJNIEnv *env;\n"
554                 out_c = out_c + "\tDO_ASSERT((*j_calls->vm)->GetEnv(j_calls->vm, (void**)&env, JNI_VERSION_1_8) == JNI_OK);\n"
555
556                 for arg_info in fn_line.args_ty:
557                     if arg_info.ret_conv is not None:
558                         out_c = out_c + "\t" + arg_info.ret_conv[0].replace('\n', '\n\t')
559                         out_c = out_c + arg_info.arg_name
560                         out_c = out_c + arg_info.ret_conv[1].replace('\n', '\n\t') + "\n"
561
562                 out_c = out_c + "\tjobject obj = (*env)->NewLocalRef(env, j_calls->o);\n\tCHECK(obj != NULL);\n"
563                 if fn_line.ret_ty_info.c_ty.endswith("Array"):
564                     out_c = out_c + "\t" + fn_line.ret_ty_info.c_ty + " arg = (*env)->CallObjectMethod(env, obj, j_calls->" + fn_line.fn_name + "_meth"
565                 elif not fn_line.ret_ty_info.passed_as_ptr:
566                     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"
567                 else:
568                     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"
569
570                 for idx, arg_info in enumerate(fn_line.args_ty):
571                     if arg_info.ret_conv is not None:
572                         out_c = out_c + ", " + arg_info.ret_conv_name
573                     else:
574                         out_c = out_c + ", " + arg_info.arg_name
575                 out_c = out_c + ");\n"
576                 if fn_line.ret_ty_info.arg_conv is not None:
577                     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"
578
579                 out_c = out_c + "}\n"
580
581         # Write out a clone function whether we need one or not, as we use them in moving to rust
582         out_c = out_c + "static void* " + struct_name + "_JCalls_clone(const void* this_arg) {\n"
583         out_c = out_c + "\t" + struct_name + "_JCalls *j_calls = (" + struct_name + "_JCalls*) this_arg;\n"
584         out_c = out_c + "\tatomic_fetch_add_explicit(&j_calls->refcnt, 1, memory_order_release);\n"
585         for var in field_vars:
586             if not isinstance(var, ConvInfo):
587                 out_c = out_c + "\tatomic_fetch_add_explicit(&j_calls->" + var[1] + "->refcnt, 1, memory_order_release);\n"
588         out_c = out_c + "\treturn (void*) this_arg;\n"
589         out_c = out_c + "}\n"
590
591         out_c = out_c + "static inline " + struct_name + " " + struct_name + "_init (" + self.c_fn_args_pfx + ", jobject o"
592         for var in field_vars:
593             if isinstance(var, ConvInfo):
594                 out_c = out_c + ", " + var.c_ty + " " + var.arg_name
595             else:
596                 out_c = out_c + ", jobject " + var[1]
597         out_c = out_c + ") {\n"
598
599         out_c = out_c + "\tjclass c = (*env)->GetObjectClass(env, o);\n"
600         out_c = out_c + "\tCHECK(c != NULL);\n"
601         out_c = out_c + "\t" + struct_name + "_JCalls *calls = MALLOC(sizeof(" + struct_name + "_JCalls), \"" + struct_name + "_JCalls\");\n"
602         out_c = out_c + "\tatomic_init(&calls->refcnt, 1);\n"
603         out_c = out_c + "\tDO_ASSERT((*env)->GetJavaVM(env, &calls->vm) == 0);\n"
604         out_c = out_c + "\tcalls->o = (*env)->NewWeakGlobalRef(env, o);\n"
605
606         for (fn_name, java_meth_descr) in java_meths:
607             if fn_name != "free" and fn_name != "clone":
608                 out_c = out_c + "\tcalls->" + fn_name + "_meth = (*env)->GetMethodID(env, c, \"" + fn_name + "\", \"" + java_meth_descr + "\");\n"
609                 out_c = out_c + "\tCHECK(calls->" + fn_name + "_meth != NULL);\n"
610
611         for var in field_vars:
612             if isinstance(var, ConvInfo) and var.arg_conv is not None:
613                 out_c = out_c + "\n\t" + var.arg_conv.replace("\n", "\n\t") +"\n"
614         out_c = out_c + "\n\t" + struct_name + " ret = {\n"
615         out_c = out_c + "\t\t.this_arg = (void*) calls,\n"
616         for fn_line in field_fns:
617             if fn_line.fn_name != "free" and fn_line.fn_name != "clone":
618                 out_c = out_c + "\t\t." + fn_line.fn_name + " = " + fn_line.fn_name + "_jcall,\n"
619             elif fn_line.fn_name == "free":
620                 out_c = out_c + "\t\t.free = " + struct_name + "_JCalls_free,\n"
621             else:
622                 out_c = out_c + "\t\t.clone = " + struct_name + "_JCalls_clone,\n"
623         for var in field_vars:
624             if isinstance(var, ConvInfo):
625                 if var.arg_conv_name is not None:
626                     out_c = out_c + "\t\t." + var.arg_name + " = " + var.arg_conv_name + ",\n"
627                     out_c = out_c + "\t\t.set_" + var.arg_name + " = NULL,\n"
628                 else:
629                     out_c = out_c + "\t\t." + var.var_name + " = " + var.var_name + ",\n"
630                     out_c = out_c + "\t\t.set_" + var.var_name + " = NULL,\n"
631             else:
632                 out_c = out_c + "\t\t." + var[1] + " = " + var[0] + "_init(env, clz, " + var[1] + "),\n"
633         out_c = out_c + "\t};\n"
634         for var in field_vars:
635             if not isinstance(var, ConvInfo):
636                 out_c = out_c + "\tcalls->" + var[1] + " = ret." + var[1] + ".this_arg;\n"
637         out_c = out_c + "\treturn ret;\n"
638         out_c = out_c + "}\n"
639
640         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"
641         for var in field_vars:
642             if isinstance(var, ConvInfo):
643                 out_c = out_c + ", " + var.c_ty + " " + var.arg_name
644             else:
645                 out_c = out_c + ", jobject " + var[1]
646         out_c = out_c + ") {\n"
647         out_c = out_c + "\t" + struct_name + " *res_ptr = MALLOC(sizeof(" + struct_name + "), \"" + struct_name + "\");\n"
648         out_c = out_c + "\t*res_ptr = " + struct_name + "_init(env, clz, o"
649         for var in field_vars:
650             if isinstance(var, ConvInfo):
651                 out_c = out_c + ", " + var.arg_name
652             else:
653                 out_c = out_c + ", " + var[1]
654         out_c = out_c + ");\n"
655         out_c = out_c + "\treturn (long)res_ptr;\n"
656         out_c = out_c + "}\n"
657
658         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"
659         out_c = out_c + "\tjobject ret = (*env)->NewLocalRef(env, ((" + struct_name + "_JCalls*)val)->o);\n"
660         out_c = out_c + "\tCHECK(ret != NULL);\n"
661         out_c = out_c + "\treturn ret;\n"
662         out_c = out_c + "}\n"
663
664         return (out_java, out_java_trait, out_c)
665
666     def map_complex_enum(self, struct_name, variant_list, camel_to_snake):
667         java_hu_type = struct_name.replace("LDK", "")
668         out_java_enum = ""
669         out_java = ""
670         out_c = ""
671
672         out_java_enum += (self.hu_struct_file_prefix)
673         out_java_enum += ("public class " + java_hu_type + " extends CommonBase {\n")
674         out_java_enum += ("\tprivate " + java_hu_type + "(Object _dummy, long ptr) { super(ptr); }\n")
675         out_java_enum += ("\t@Override @SuppressWarnings(\"deprecation\")\n")
676         out_java_enum += ("\tprotected void finalize() throws Throwable {\n")
677         out_java_enum += ("\t\tsuper.finalize();\n")
678         out_java_enum += ("\t\tif (ptr != 0) { bindings." + java_hu_type + "_free(ptr); }\n")
679         out_java_enum += ("\t}\n")
680         out_java_enum += ("\tstatic " + java_hu_type + " constr_from_ptr(long ptr) {\n")
681         out_java_enum += ("\t\tbindings." + struct_name + " raw_val = bindings." + struct_name + "_ref_from_ptr(ptr);\n")
682         java_hu_subclasses = ""
683
684         init_meth_jty_strs = {}
685
686         out_java +=  ("\tpublic static class " + struct_name + " {\n")
687         out_java +=  ("\t\tprivate " + struct_name + "() {}\n")
688         for var in variant_list:
689             out_java +=  ("\t\tpublic final static class " + var.var_name + " extends " + struct_name + " {\n")
690             java_hu_subclasses = java_hu_subclasses + "\tpublic final static class " + var.var_name + " extends " + java_hu_type + " {\n"
691             out_java_enum += ("\t\tif (raw_val.getClass() == bindings." + struct_name + "." + var.var_name + ".class) {\n")
692             out_java_enum += ("\t\t\treturn new " + var.var_name + "(ptr, (bindings." + struct_name + "." + var.var_name + ")raw_val);\n")
693             init_meth_jty_str = ""
694             init_meth_params = ""
695             init_meth_body = ""
696             hu_conv_body = ""
697             for idx, field_ty in enumerate(var.fields):
698                 out_java += ("\t\t\tpublic " + field_ty.java_ty + " " + field_ty.arg_name + ";\n")
699                 java_hu_subclasses = java_hu_subclasses + "\t\tpublic final " + field_ty.java_hu_ty + " " + field_ty.arg_name + ";\n"
700                 if field_ty.to_hu_conv is not None:
701                     hu_conv_body = hu_conv_body + "\t\t\t" + field_ty.java_ty + " " + field_ty.arg_name + " = obj." + field_ty.arg_name + ";\n"
702                     hu_conv_body = hu_conv_body + "\t\t\t" + field_ty.to_hu_conv.replace("\n", "\n\t\t\t") + "\n"
703                     hu_conv_body = hu_conv_body + "\t\t\tthis." + field_ty.arg_name + " = " + field_ty.to_hu_conv_name + ";\n"
704                 else:
705                     hu_conv_body = hu_conv_body + "\t\t\tthis." + field_ty.arg_name + " = obj." + field_ty.arg_name + ";\n"
706                 init_meth_jty_str = init_meth_jty_str + field_ty.java_fn_ty_arg
707                 if idx > 0:
708                     init_meth_params = init_meth_params + ", "
709                 init_meth_params = init_meth_params + field_ty.java_ty + " " + field_ty.arg_name
710                 init_meth_body = init_meth_body + "this." + field_ty.arg_name + " = " + field_ty.arg_name + "; "
711             out_java +=  ("\t\t\t" + var.var_name + "(" + init_meth_params + ") { ")
712             out_java +=  (init_meth_body)
713             out_java +=  ("}\n")
714             out_java += ("\t\t}\n")
715             out_java_enum += ("\t\t}\n")
716             java_hu_subclasses = java_hu_subclasses + "\t\tprivate " + var.var_name + "(long ptr, bindings." + struct_name + "." + var.var_name + " obj) {\n\t\t\tsuper(null, ptr);\n"
717             java_hu_subclasses = java_hu_subclasses + hu_conv_body
718             java_hu_subclasses = java_hu_subclasses + "\t\t}\n\t}\n"
719             init_meth_jty_strs[var.var_name] = init_meth_jty_str
720         out_java += ("\t\tstatic native void init();\n")
721         out_java += ("\t}\n")
722         out_java_enum += ("\t\tassert false; return null; // Unreachable without extending the (internal) bindings interface\n\t}\n\n")
723         out_java_enum += (java_hu_subclasses)
724         out_java += ("\tstatic { " + struct_name + ".init(); }\n")
725         out_java += ("\tpublic static native " + struct_name + " " + struct_name + "_ref_from_ptr(long ptr);\n");
726
727         out_c += (self.c_complex_enum_pfx(struct_name, [x.var_name for x in variant_list], init_meth_jty_strs))
728
729         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")
730         out_c += ("\t" + struct_name + " *obj = (" + struct_name + "*)ptr;\n")
731         out_c += ("\tswitch(obj->tag) {\n")
732         for var in variant_list:
733             out_c += ("\t\tcase " + struct_name + "_" + var.var_name + ": {\n")
734             c_params = []
735             for idx, field_map in enumerate(var.fields):
736                 if field_map.ret_conv is not None:
737                     out_c += ("\t\t\t" + field_map.ret_conv[0].replace("\n", "\n\t\t\t"))
738                     out_c += ("obj->" + camel_to_snake(var.var_name) + "." + field_map.arg_name)
739                     out_c += (field_map.ret_conv[1].replace("\n", "\n\t\t\t") + "\n")
740                     c_params.append(field_map.ret_conv_name)
741                 else:
742                     c_params.append("obj->" + camel_to_snake(var.var_name) + "." + field_map.arg_name)
743             out_c += ("\t\t\treturn " + self.c_constr_native_complex_enum(struct_name, var.var_name, c_params) + ";\n")
744             out_c += ("\t\t}\n")
745         out_c += ("\t\tdefault: abort();\n")
746         out_c += ("\t}\n}\n")
747         out_java_enum += ("}\n")
748         return (out_java, out_java_enum, out_c)