1 from bindingstypes import *
9 def __init__(self, DEBUG: bool, target: Target, **kwargs):
11 self.c_array_class_caches = set()
12 self.c_type_map = dict(
20 self.java_type_map = dict(
23 self.java_hu_type_map = dict(
27 self.to_hu_conv_templates = dict(
28 ptr = '{human_type} {var_name}_hu_conv = null; if ({var_name} < 0 || {var_name} > 4096) { {var_name}_hu_conv = new {human_type}(null, {var_name}); }',
29 default = '{human_type} {var_name}_hu_conv = null; if ({var_name} < 0 || {var_name} > 4096) { {var_name}_hu_conv = new {human_type}(null, {var_name}); }'
32 self.bindings_header = """
35 using System.Runtime.InteropServices;
37 namespace org { namespace ldk { namespace impl {
39 internal class bindings {
41 init(java.lang.Enum.class, VecOrSliceDef.class);
43 if (!get_lib_version_string().equals(version.get_ldk_java_bindings_version()))
44 throw new ArgumentException("Compiled LDK library and LDK class failes do not match");
45 // Fetching the LDK versions from C also checks that the header and binaries match
46 Console.Error.WriteLine("Loaded LDK-Java Bindings " + version.get_ldk_java_bindings_version() + " with LDK " + get_ldk_version() + " and LDK-C-Bindings " + get_ldk_c_bindings_version());
48 //static extern void init(java.lang.Class c);
49 //static native void init_class_cache();
51 self.bindings_header += self.native_meth_decl("get_lib_version_string", "string") + "();\n"
52 self.bindings_header += self.native_meth_decl("get_ldk_c_bindings_version", "string") + "();\n"
53 self.bindings_header += self.native_meth_decl("get_ldk_version", "string") + "();\n\n"
55 self.bindings_version_file = """
57 public class version {
58 public static string get_ldk_java_bindings_version() {
59 return "<git_version_ldk_garbagecollected>";
63 self.util_fn_pfx = """using org.ldk.impl;
66 using org.ldk.structs;
69 namespace org { namespace ldk { namespace util {
70 public class UtilMethods {
72 self.util_fn_sfx = "} } } }"
73 self.common_base = """using System.Collections.Generic;
74 using System.Diagnostics;
76 public class CommonBase {
77 protected internal long ptr;
78 protected internal LinkedList<object> ptrs_to = new LinkedList<object>();
79 protected CommonBase(long ptr) { Trace.Assert(ptr < 0 || ptr > 4096); this.ptr = ptr; }
83 self.txin_defn = """public class TxIn : CommonBase {
84 /** The witness in this input, in serialized form */
85 public readonly byte[] witness;
86 /** The script_sig in this input */
87 public readonly byte[] script_sig;
88 /** The transaction output's sequence number */
89 public readonly int sequence;
90 /** The txid this input is spending */
91 public readonly byte[] previous_txid;
92 /** The output index within the spent transaction of the output this input is spending */
93 public readonly int previous_vout;
95 internal TxIn(object _dummy, long ptr) : base(ptr) {
96 this.witness = bindings.TxIn_get_witness(ptr);
97 this.script_sig = bindings.TxIn_get_script_sig(ptr);
98 this.sequence = bindings.TxIn_get_sequence(ptr);
99 this.previous_txid = bindings.TxIn_get_previous_txid(ptr);
100 this.previous_vout = bindings.TxIn_get_previous_vout(ptr);
102 public TxIn(byte[] witness, byte[] script_sig, int sequence, byte[] previous_txid, int previous_vout)
103 : this(null, bindings.TxIn_new(witness, script_sig, sequence, previous_txid, previous_vout)) {}
106 if (ptr != 0) { bindings.TxIn_free(ptr); }
110 self.txout_defn = """public class TxOut : CommonBase {
111 /** The script_pubkey in this output */
112 public readonly byte[] script_pubkey;
113 /** The value, in satoshis, of this output */
114 public readonly long value;
116 internal TxOut(object _dummy, long ptr) : base(ptr) {
117 this.script_pubkey = bindings.TxOut_get_script_pubkey(ptr);
118 this.value = bindings.TxOut_get_value(ptr);
120 public TxOut(long value, byte[] script_pubkey) : this(null, bindings.TxOut_new(script_pubkey, value)) {}
123 if (ptr != 0) { bindings.TxOut_free(ptr); }
127 self.scalar_defn = """public class BigEndianScalar : CommonBase {
128 /** The bytes of the scalar value, in big endian */
129 public readonly byte[] scalar_bytes;
131 internal BigEndianScalar(object _dummy, long ptr) : base(ptr) {
132 this.scalar_bytes = bindings.BigEndianScalar_get_bytes(ptr);
134 public BigEndianScalar(byte[] scalar_bytes) : base(bindings.BigEndianScalar_new(scalar_bytes)) {
135 this.scalar_bytes = bindings.BigEndianScalar_get_bytes(ptr);
139 if (ptr != 0) { bindings.BigEndianScalar_free(ptr); }
144 self.c_file_pfx = """
145 // On OSX jlong (ie long long) is not equivalent to int64_t, so we override here
146 #define int64_t jlong
147 #include <lightning.h>
149 #include <stdatomic.h>
152 #define LIKELY(v) __builtin_expect(!!(v), 1)
153 #define UNLIKELY(v) __builtin_expect(!!(v), 0)
157 self.c_file_pfx = self.c_file_pfx + "#include <stdio.h>\n#define DEBUG_PRINT(...) fprintf(stderr, __VA_ARGS__)\n"
159 if not DEBUG or sys.platform == "darwin":
160 self.c_file_pfx = self.c_file_pfx + """#define MALLOC(a, _) malloc(a)
161 #define FREE(p) if ((uint64_t)(p) > 4096) { free(p); }
162 #define CHECK_ACCESS(p)
163 #define CHECK_INNER_FIELD_ACCESS_OR_NULL(v)
166 self.c_file_pfx += """#define DO_ASSERT(a) (void)(a)
170 self.c_file_pfx = self.c_file_pfx + """#include <assert.h>
171 // Always run a, then assert it is true:
172 #define DO_ASSERT(a) do { bool _assert_val = (a); assert(_assert_val); } while(0)
173 // Assert a is true or do nothing
174 #define CHECK(a) DO_ASSERT(a)
176 void __attribute__((constructor)) debug_log_version() {
177 if (check_get_ldk_version() == NULL)
178 DEBUG_PRINT("LDK version did not match the header we built against\\n");
179 if (check_get_ldk_bindings_version() == NULL)
180 DEBUG_PRINT("LDK C Bindings version did not match the header we built against\\n");
184 if sys.platform != "darwin":
185 self.c_file_pfx += """
186 // Running a leak check across all the allocations and frees of the JDK is a mess,
187 // so instead we implement our own naive leak checker here, relying on the -wrap
188 // linker option to wrap malloc/calloc/realloc/free, tracking everyhing allocated
189 // and free'd in Rust or C across the generated bindings shared library.
193 self.c_file_pfx = self.c_file_pfx + "#include <execinfo.h>\n"
194 self.c_file_pfx = self.c_file_pfx + """
197 static pthread_mutex_t allocation_mtx;
199 void __attribute__((constructor)) init_mtx() {
200 DO_ASSERT(!pthread_mutex_init(&allocation_mtx, NULL));
204 typedef struct allocation {
205 struct allocation* next;
207 const char* struct_name;
210 unsigned long alloc_len;
212 static allocation* allocation_ll = NULL;
214 void* __real_malloc(size_t len);
215 void* __real_calloc(size_t nmemb, size_t len);
216 static void new_allocation(void* res, const char* struct_name, size_t len) {
217 allocation* new_alloc = __real_malloc(sizeof(allocation));
218 new_alloc->ptr = res;
219 new_alloc->struct_name = struct_name;
220 new_alloc->bt_len = backtrace(new_alloc->bt, BT_MAX);
221 new_alloc->alloc_len = len;
222 DO_ASSERT(!pthread_mutex_lock(&allocation_mtx));
223 new_alloc->next = allocation_ll;
224 allocation_ll = new_alloc;
225 DO_ASSERT(!pthread_mutex_unlock(&allocation_mtx));
227 static void* MALLOC(size_t len, const char* struct_name) {
228 void* res = __real_malloc(len);
229 new_allocation(res, struct_name, len);
232 void __real_free(void* ptr);
233 static void alloc_freed(void* ptr) {
234 allocation* p = NULL;
235 DO_ASSERT(!pthread_mutex_lock(&allocation_mtx));
236 allocation* it = allocation_ll;
237 while (it->ptr != ptr) {
238 p = it; it = it->next;
240 DEBUG_PRINT("ERROR: Tried to free unknown pointer %p at:\\n", ptr);
242 int bt_len = backtrace(bt, BT_MAX);
243 backtrace_symbols_fd(bt, bt_len, STDERR_FILENO);
244 DEBUG_PRINT("\\n\\n");
245 DO_ASSERT(!pthread_mutex_unlock(&allocation_mtx));
246 return; // addrsan should catch malloc-unknown and print more info than we have
249 if (p) { p->next = it->next; } else { allocation_ll = it->next; }
250 DO_ASSERT(!pthread_mutex_unlock(&allocation_mtx));
251 DO_ASSERT(it->ptr == ptr);
254 static void FREE(void* ptr) {
255 if ((uint64_t)ptr <= 4096) return; // Rust loves to create pointers to the NULL page for dummys
260 void* __wrap_malloc(size_t len) {
261 void* res = __real_malloc(len);
262 new_allocation(res, "malloc call", len);
265 void* __wrap_calloc(size_t nmemb, size_t len) {
266 void* res = __real_calloc(nmemb, len);
267 new_allocation(res, "calloc call", len);
270 void __wrap_free(void* ptr) {
271 if (ptr == NULL) return;
276 static void CHECK_ACCESS(const void* ptr) {
277 DO_ASSERT(!pthread_mutex_lock(&allocation_mtx));
278 allocation* it = allocation_ll;
279 while (it->ptr != ptr) {
282 DEBUG_PRINT("ERROR: Tried to access unknown pointer %p at:\\n", ptr);
284 int bt_len = backtrace(bt, BT_MAX);
285 backtrace_symbols_fd(bt, bt_len, STDERR_FILENO);
286 DEBUG_PRINT("\\n\\n");
287 DO_ASSERT(!pthread_mutex_unlock(&allocation_mtx));
288 return; // addrsan should catch and print more info than we have
291 DO_ASSERT(!pthread_mutex_unlock(&allocation_mtx));
293 #define CHECK_INNER_FIELD_ACCESS_OR_NULL(v) \\
294 if (v.is_owned && v.inner != NULL) { \\
295 const void *p = __unmangle_inner_ptr(v.inner); \\
301 void* __real_realloc(void* ptr, size_t newlen);
302 void* __wrap_realloc(void* ptr, size_t len) {
303 if (ptr != NULL) alloc_freed(ptr);
304 void* res = __real_realloc(ptr, len);
305 new_allocation(res, "realloc call", len);
308 void __wrap_reallocarray(void* ptr, size_t new_sz) {
309 // Rust doesn't seem to use reallocarray currently
313 void __attribute__((destructor)) check_leaks() {
314 unsigned long alloc_count = 0;
315 unsigned long alloc_size = 0;
316 DEBUG_PRINT("The following LDK-allocated blocks still remain.\\n");
317 DEBUG_PRINT("Note that this is only accurate if System.gc(); System.runFinalization()\\n");
318 DEBUG_PRINT("was called prior to exit after all LDK objects were out of scope.\\n");
319 for (allocation* a = allocation_ll; a != NULL; a = a->next) {
320 DEBUG_PRINT("%s %p (%lu bytes) remains:\\n", a->struct_name, a->ptr, a->alloc_len);
321 backtrace_symbols_fd(a->bt, a->bt_len, STDERR_FILENO);
322 DEBUG_PRINT("\\n\\n");
324 alloc_size += a->alloc_len;
326 DEBUG_PRINT("%lu allocations remained for %lu bytes.\\n", alloc_count, alloc_size);
327 DEBUG_PRINT("Note that this is only accurate if System.gc(); System.runFinalization()\\n");
328 DEBUG_PRINT("was called prior to exit after all LDK objects were out of scope.\\n");
331 self.c_file_pfx = self.c_file_pfx + """
333 // We assume that CVec_u8Z and u8slice are the same size and layout (and thus pointers to the two can be mixed)
334 _Static_assert(sizeof(LDKCVec_u8Z) == sizeof(LDKu8slice), "Vec<u8> and [u8] need to have been mapped identically");
335 _Static_assert(offsetof(LDKCVec_u8Z, data) == offsetof(LDKu8slice, data), "Vec<u8> and [u8] need to have been mapped identically");
336 _Static_assert(offsetof(LDKCVec_u8Z, datalen) == offsetof(LDKu8slice, datalen), "Vec<u8> and [u8] need to have been mapped identically");
338 _Static_assert(sizeof(void*) <= 8, "Pointers must fit into 64 bits");
340 typedef jlongArray int64_tArray;
341 typedef jbyteArray int8_tArray;
343 static inline jstring str_ref_to_java(JNIEnv *env, const char* chars, size_t len) {
344 // Sadly we need to create a temporary because Java can't accept a char* without a 0-terminator
345 char* conv_buf = MALLOC(len + 1, "str conv buf");
346 memcpy(conv_buf, chars, len);
348 jstring ret = (*env)->NewStringUTF(env, conv_buf);
352 static inline LDKStr java_to_owned_str(JNIEnv *env, jstring str) {
353 uint64_t str_len = (*env)->GetStringUTFLength(env, str);
354 char* newchars = MALLOC(str_len + 1, "String chars");
355 const char* jchars = (*env)->GetStringUTFChars(env, str, NULL);
356 memcpy(newchars, jchars, str_len);
357 newchars[str_len] = 0;
358 (*env)->ReleaseStringUTFChars(env, str, jchars);
362 .chars_is_owned = true
367 const char* CS_LDK_get_ldk_c_bindings_version() {
368 return str_ref_to_java(check_get_ldk_bindings_version(), strlen(check_get_ldk_bindings_version()));
370 const char* CS_LDK_get_ldk_version() {
371 return str_ref_to_java(check_get_ldk_version(), strlen(check_get_ldk_version()));
375 self.c_version_file = """const char* CS_LDK_get_lib_version_string() {
376 return "<git_version_ldk_garbagecollected>";
379 self.hu_struct_file_prefix = """using org.ldk.impl;
384 namespace org { namespace ldk { namespace structs {
387 self.hu_struct_file_suffix = "} } }\n"
388 self.c_fn_args_pfx = ""
389 self.c_fn_ty_pfx = ""
390 self.file_ext = ".cs"
391 self.ptr_c_ty = "int64_t"
392 self.ptr_native_ty = "long"
393 self.u128_native_ty = "UInt128"
394 self.usize_c_ty = "int64_t"
395 self.usize_native_ty = "long"
396 self.native_zero_ptr = "0"
397 self.result_c_ty = "jclass"
398 self.ptr_arr = "jobjectArray"
399 self.is_arr_some_check = ("", " != NULL")
400 self.get_native_arr_len_call = ("(*env)->GetArrayLength(env, ", ")")
402 self.bindings_footer_wip = "\tstatic bindings() {\n"
403 def bindings_footer(self):
404 return self.bindings_footer_wip + "\t}\n}\n} } }\n"
406 def native_meth_decl(self, meth_name, ret_ty_str):
407 return "\t[DllImport (\"ldkcsharp\", EntryPoint=\"CS_LDK_" + meth_name + "\")] public static extern " + ret_ty_str + " " + meth_name
409 def c_fn_name_define_pfx(self, fn_name, have_args):
410 return " CS_LDK_" + fn_name + "("
412 def construct_jenv(self):
413 res = "JNIEnv *env;\n"
414 res += "jint get_jenv_res = (*j_calls->vm)->GetEnv(j_calls->vm, (void**)&env, JNI_VERSION_1_6);\n"
415 res += "if (get_jenv_res == JNI_EDETACHED) {\n"
416 res += "\tDO_ASSERT((*j_calls->vm)->AttachCurrentThread(j_calls->vm, (void**)&env, NULL) == JNI_OK);\n"
418 res += "\tDO_ASSERT(get_jenv_res == JNI_OK);\n"
421 def deconstruct_jenv(self):
422 res = "if (get_jenv_res == JNI_EDETACHED) {\n"
423 res += "\tDO_ASSERT((*j_calls->vm)->DetachCurrentThread(j_calls->vm) == JNI_OK);\n"
427 def release_native_arr_ptr_call(self, ty_info, arr_var, arr_ptr_var):
428 if ty_info.subty is None or not ty_info.subty.c_ty.endswith("Array"):
429 return "(*env)->ReleasePrimitiveArrayCritical(env, " + arr_var + ", " + arr_ptr_var + ", 0)"
431 def create_native_arr_call(self, arr_len, ty_info):
432 if ty_info.c_ty == "int8_tArray":
433 return "(*env)->NewByteArray(env, " + arr_len + ")"
434 elif ty_info.subty.c_ty.endswith("Array"):
435 clz_var = ty_info.java_fn_ty_arg[1:].replace("[", "arr_of_")
436 self.c_array_class_caches.add(clz_var)
437 return "(*env)->NewObjectArray(env, " + arr_len + ", " + clz_var + "_clz, NULL);\n"
439 return "(*env)->New" + ty_info.java_ty.strip("[]").title() + "Array(env, " + arr_len + ")"
440 def set_native_arr_contents(self, arr_name, arr_len, ty_info):
441 if ty_info.c_ty == "int8_tArray":
442 return ("(*env)->SetByteArrayRegion(env, " + arr_name + ", 0, " + arr_len + ", ", ")")
443 elif ty_info.c_ty == "int16_tArray":
444 return ("(*env)->SetByteArrayRegion(env, " + arr_name + ", 0, " + arr_len + ", ", ")")
447 def get_native_arr_contents(self, arr_name, dest_name, arr_len, ty_info, copy):
448 if ty_info.c_ty == "int8_tArray":
450 return "(*env)->GetByteArrayRegion(env, " + arr_name + ", 0, " + arr_len + ", " + dest_name + ")"
452 return "(*env)->GetByteArrayElements (env, " + arr_name + ", NULL)"
453 elif not ty_info.java_ty[:len(ty_info.java_ty) - 2].endswith("[]"):
454 return "(*env)->Get" + ty_info.subty.java_ty.title() + "ArrayElements (env, " + arr_name + ", NULL)"
457 def get_native_arr_elem(self, arr_name, idxc, ty_info):
458 if self.get_native_arr_contents(arr_name, "", "", ty_info, False) is None:
459 return "(*env)->GetObjectArrayElement(env, " + arr_name + ", " + idxc + ")"
461 assert False # Only called if above is None
462 def get_native_arr_ptr_call(self, ty_info):
463 if ty_info.subty is not None and ty_info.subty.c_ty.endswith("Array"):
465 return ("(*env)->GetPrimitiveArrayCritical(env, ", ", NULL)")
466 def get_native_arr_entry_call(self, ty_info, arr_name, idxc, entry_access):
467 if ty_info.subty is None or not ty_info.subty.c_ty.endswith("Array"):
469 return "(*env)->SetObjectArrayElement(env, " + arr_name + ", " + idxc + ", " + entry_access + ")"
470 def cleanup_native_arr_ref_contents(self, arr_name, dest_name, arr_len, ty_info):
471 if ty_info.c_ty == "int8_tArray":
472 return "(*env)->ReleaseByteArrayElements(env, " + arr_name + ", (int8_t*)" + dest_name + ", 0);"
474 return "(*env)->Release" + ty_info.java_ty.strip("[]").title() + "ArrayElements(env, " + arr_name + ", " + dest_name + ", 0)"
476 def map_hu_array_elems(self, arr_name, conv_name, arr_ty, elem_ty):
477 if elem_ty.java_hu_ty == "UInt5":
478 return arr_name + " != null ? InternalUtils.convUInt5Array(" + arr_name + ") : null"
479 elif elem_ty.java_hu_ty == "WitnessVersion":
480 return arr_name + " != null ? InternalUtils.convWitnessVersionArray(" + arr_name + ") : null"
482 return arr_name + " != null ? InternalUtils.mapArray(" + arr_name + ", " + conv_name + " => " + elem_ty.from_hu_conv[0] + ") : null"
484 def str_ref_to_native_call(self, var_name, str_len):
485 return "str_ref_to_java(env, " + var_name + ", " + str_len + ")"
486 def str_ref_to_c_call(self, var_name):
487 return "java_to_owned_str(env, " + var_name + ")"
488 def str_to_hu_conv(self, var_name):
490 def str_from_hu_conv(self, var_name):
496 def var_decl_statement(self, ty_string, var_name, statement):
497 return ty_string + " " + var_name + " = " + statement
499 def get_java_arr_len(self, arr_name):
500 return arr_name + ".Length"
501 def get_java_arr_elem(self, elem_ty, arr_name, idx):
502 return arr_name + "[" + idx + "]"
503 def constr_hu_array(self, ty_info, arr_len):
504 base_ty = ty_info.subty.java_hu_ty.split("[")[0].split("<")[0]
505 conv = "new " + base_ty + "[" + arr_len + "]"
506 if "[" in ty_info.subty.java_hu_ty.split("<")[0]:
507 # Do a bit of a dance to move any excess [] to the end
508 conv += "[" + ty_info.subty.java_hu_ty.split("<")[0].split("[")[1]
510 def cleanup_converted_native_array(self, ty_info, arr_name):
513 def primitive_arr_from_hu(self, arr_ty, fixed_len, arr_name):
514 mapped_ty = arr_ty.subty
515 if arr_ty.rust_obj == "LDKU128":
516 return ("" + arr_name + ".getLEBytes()", "")
517 if fixed_len is not None:
518 return ("InternalUtils.check_arr_len(" + arr_name + ", " + fixed_len + ")", "")
520 def primitive_arr_to_hu(self, arr_ty, fixed_len, arr_name, conv_name):
521 if arr_ty.rust_obj == "LDKU128":
522 return "org.ldk.util.UInt128 " + conv_name + " = new org.ldk.util.UInt128(" + arr_name + ");"
525 def java_arr_ty_str(self, elem_ty_str):
526 return elem_ty_str + "[]"
528 def for_n_in_range(self, n, minimum, maximum):
529 return "for (int " + n + " = " + minimum + "; " + n + " < " + maximum + "; " + n + "++) {"
530 def for_n_in_arr(self, n, arr_name, arr_elem_ty):
531 return ("foreach (" + arr_elem_ty.java_hu_ty + " " + n + " in " + arr_name + ") { ", " }")
533 def get_ptr(self, var):
535 def set_null_skip_free(self, var):
536 return var + ".ptr" + " = 0;"
538 def add_ref(self, holder, referent):
539 return "if (" + holder + " != null) { " + holder + ".ptrs_to.AddLast(" + referent + "); }"
541 def fully_qualified_hu_ty_path(self, ty):
542 if ty.java_fn_ty_arg.startswith("L") and ty.java_fn_ty_arg.endswith(";"):
544 if ty.java_hu_ty == "UnqualifiedError" or ty.java_hu_ty == "UInt128" or ty.java_hu_ty == "UInt5" or ty.java_hu_ty == "WitnessVersion":
545 return "org.ldk.util." + ty.java_hu_ty
546 if not ty.is_native_primitive and ty.rust_obj is not None and not "[]" in ty.java_hu_ty:
547 return "org.ldk.structs." + ty.java_hu_ty
550 def native_c_unitary_enum_map(self, struct_name, variants, enum_doc_comment):
551 out_java_enum = "namespace org { namespace ldk { namespace enums {"
555 out_c = "static inline LDK" + struct_name + " LDK" + struct_name + "_from_cs(int32_t ord) {\n"
556 out_c += "\tswitch (ord) {\n"
558 if enum_doc_comment is not None:
559 out_java_enum += "/**\n * " + enum_doc_comment.replace("\n", "\n * ") + "\n */\n"
560 out_java_enum += "public enum " + struct_name + " {\n"
562 for var, var_docs in variants:
563 if var_docs is not None:
564 out_java_enum += "\t/**\n\t * " + var_docs.replace("\n", "\n\t * ") + "\n\t */\n"
565 out_java_enum += "\t" + var + ",\n"
566 out_c = out_c + "\t\tcase %d: return %s;\n" % (ord_v, var)
569 out_c += "\t\tdefault: abort();\n"
573 out_c = out_c + "static inline int32_t LDK" + struct_name + "_to_cs(LDK" + struct_name + " val) {\n"
574 out_c = out_c + "\tswitch (val) {\n"
576 for var, _ in variants:
577 out_c = out_c + "\t\tcase " + var + ": return %d;\n" % ord_v
579 out_c = out_c + "\t\tdefault: abort();\n"
580 out_c = out_c + "\t}\n"
581 out_c = out_c + "}\n"
583 return (out_c, out_java_enum + "} } }\n", out_java)
585 def c_unitary_enum_to_native_call(self, ty_info):
586 return (ty_info.rust_obj + "_to_cs(", ")")
587 def native_unitary_enum_to_c_call(self, ty_info):
588 return (ty_info.rust_obj + "_from_cs(", ")")
590 def c_complex_enum_pfx(self, struct_name, variants, init_meth_jty_strs):
593 out_c = out_c + "static jclass " + struct_name + "_" + var + "_class = NULL;\n"
594 out_c = out_c + "static jmethodID " + struct_name + "_" + var + "_meth = NULL;\n"
595 out_c += "void" + self.c_fn_name_define_pfx(struct_name.replace("_", "_1") + "_init", True) + self.c_fn_args_pfx + ") {\n"
596 for var_name in variants:
597 out_c += "\t" + struct_name + "_" + var_name + "_class =\n"
598 out_c += "\t\t(*env)->NewGlobalRef(env, (*env)->FindClass(env, \"org/ldk/impl/bindings$" + struct_name + "$" + var_name + "\"));\n"
599 out_c += "\tCHECK(" + struct_name + "_" + var_name + "_class != NULL);\n"
600 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"
601 out_c += "\tCHECK(" + struct_name + "_" + var_name + "_meth != NULL);\n"
602 out_c = out_c + "}\n"
605 def c_complex_enum_pass_ty(self, struct_name):
608 def c_constr_native_complex_enum(self, struct_name, variant, c_params):
609 ret = "(*env)->NewObject(env, " + struct_name + "_" + variant + "_class, " + struct_name + "_" + variant + "_meth"
610 for param in c_params:
611 ret = ret + ", " + param
614 def native_c_map_trait(self, struct_name, field_vars, flattened_field_vars, field_fns, trait_doc_comment):
618 # First generate most of the Java code, note that we need information about java method argument strings for C
619 out_java_trait += self.hu_struct_file_prefix
620 if trait_doc_comment is not None:
621 out_java_trait += "/**\n * " + trait_doc_comment.replace("\n", "\n * ") + "\n */\n"
622 out_java_trait = out_java_trait + "public class " + struct_name.replace("LDK","") + " : CommonBase {\n"
623 out_java_trait = out_java_trait + "\tinternal readonly bindings." + struct_name + " bindings_instance;\n"
624 out_java_trait = out_java_trait + "\tinternal " + struct_name.replace("LDK", "") + "(object _dummy, long ptr) : base(ptr) { bindings_instance = null; }\n"
625 out_java_trait = out_java_trait + "\tprivate " + struct_name.replace("LDK", "") + "(bindings." + struct_name + " arg"
626 for var in flattened_field_vars:
627 if isinstance(var, ConvInfo):
628 out_java_trait += ", " + var.java_hu_ty + " " + var.arg_name
630 out_java_trait += ", bindings." + var[0] + " " + var[1]
631 out_java_trait += ") : base(bindings." + struct_name + "_new(arg"
632 for var in flattened_field_vars:
633 if isinstance(var, ConvInfo):
634 if var.from_hu_conv is not None:
635 out_java_trait = out_java_trait + ", " + var.from_hu_conv[0]
637 out_java_trait = out_java_trait + ", " + var.arg_name
639 out_java_trait = out_java_trait + ", " + var[1]
640 out_java_trait = out_java_trait + ")) {\n"
641 out_java_trait = out_java_trait + "\t\tthis.ptrs_to.AddLast(arg);\n"
642 for var in flattened_field_vars:
643 if isinstance(var, ConvInfo):
644 if var.from_hu_conv is not None and var.from_hu_conv[1] != "":
645 out_java_trait = out_java_trait + "\t\t" + var.from_hu_conv[1].replace("\n", "\n\t\t") + ";\n"
647 out_java_trait = out_java_trait + "\t\tthis.ptrs_to.AddLast(" + var[1] + ");\n"
648 out_java_trait = out_java_trait + "\t\tthis.bindings_instance = arg;\n"
649 out_java_trait = out_java_trait + "\t}\n"
650 out_java_trait = out_java_trait + "\t~" + struct_name.replace("LDK","") + "() {\n"
651 out_java_trait = out_java_trait + "\t\tif (ptr != 0) { bindings." + struct_name.replace("LDK","") + "_free(ptr); }\n"
652 out_java_trait = out_java_trait + "\t}\n\n"
654 java_trait_wrapper = "\tprivate class " + struct_name + "Holder { internal " + struct_name.replace("LDK", "") + " held; }\n"
655 java_trait_wrapper += "\tprivate class " + struct_name + "Impl : bindings." + struct_name + " {\n"
656 java_trait_wrapper += "\t\tinternal " + struct_name + "Impl(" + struct_name.replace("LDK", "") + "Interface arg, " + struct_name + "Holder impl_holder) { this.arg = arg; this.impl_holder = impl_holder; }\n"
657 java_trait_wrapper += "\t\tprivate " + struct_name.replace("LDK", "") + "Interface arg;\n"
658 java_trait_wrapper += "\t\tprivate " + struct_name + "Holder impl_holder;\n"
659 java_trait_constr = "\tpublic static " + struct_name.replace("LDK", "") + " new_impl(" + struct_name.replace("LDK", "") + "Interface arg"
660 for var in flattened_field_vars:
661 if isinstance(var, ConvInfo):
662 java_trait_constr += ", " + var.java_hu_ty + " " + var.arg_name
664 # Ideally we'd be able to take any instance of the interface, but our C code can only represent
665 # Java-implemented version, so we require users pass a Java implementation here :/
666 java_trait_constr += ", " + var[0].replace("LDK", "") + "." + var[0].replace("LDK", "") + "Interface " + var[1] + "_impl"
667 java_trait_constr = java_trait_constr + ") {\n\t\t" + struct_name + "Holder impl_holder = new " + struct_name + "Holder();\n"
668 java_trait_constr = java_trait_constr + "\t\timpl_holder.held = new " + struct_name.replace("LDK", "") + "(new " + struct_name + "Impl(arg, impl_holder)"
669 out_java_trait += "\tpublic interface " + struct_name.replace("LDK", "") + "Interface {\n"
670 out_java += "\tpublic interface " + struct_name + " {\n"
672 for fn_line in field_fns:
673 java_meth_descr = "("
674 if fn_line.fn_name != "free" and fn_line.fn_name != "cloned":
675 fn_name = fn_line.fn_name
676 if fn_name == "lock": # reserved symbol
678 out_java += "\t\t" + fn_line.ret_ty_info.java_ty + " " + fn_name + "("
679 java_trait_wrapper += "\t\tpublic " + fn_line.ret_ty_info.java_ty + " " + fn_name + "("
680 out_java_trait += "\t\t/**\n\t\t * " + fn_line.docs.replace("\n", "\n\t\t * ") + "\n\t\t */\n"
681 out_java_trait += "\t\t" + fn_line.ret_ty_info.java_hu_ty + " " + fn_name + "("
683 for idx, arg_conv_info in enumerate(fn_line.args_ty):
686 java_trait_wrapper += ", "
687 out_java_trait += ", "
688 out_java += arg_conv_info.java_ty + " _" + arg_conv_info.arg_name
689 out_java_trait += arg_conv_info.java_hu_ty + " _" + arg_conv_info.arg_name
690 java_trait_wrapper += arg_conv_info.java_ty + " _" + arg_conv_info.arg_name
691 java_meth_descr = java_meth_descr + arg_conv_info.java_fn_ty_arg
692 java_meth_descr = java_meth_descr + ")" + fn_line.ret_ty_info.java_fn_ty_arg
693 java_meths.append((fn_line.fn_name, java_meth_descr))
696 out_java_trait += ");\n"
697 java_trait_wrapper += ") {\n"
699 for arg_info in fn_line.args_ty:
700 if arg_info.to_hu_conv is not None:
701 java_trait_wrapper += "\t\t\t" + arg_info.to_hu_conv.replace("\n", "\n\t\t\t").replace(arg_info.arg_name, "_" + arg_info.arg_name) + "\n"
703 if fn_line.ret_ty_info.java_ty != "void":
704 java_trait_wrapper += "\t\t\t" + fn_line.ret_ty_info.java_hu_ty + " ret = arg." + fn_name + "("
706 java_trait_wrapper += "\t\t\targ." + fn_name + "("
708 for idx, arg_info in enumerate(fn_line.args_ty):
710 java_trait_wrapper += ", "
711 if arg_info.to_hu_conv_name is not None:
712 java_trait_wrapper += arg_info.to_hu_conv_name.replace(arg_info.arg_name, "_" + arg_info.arg_name)
714 java_trait_wrapper += "_" + arg_info.arg_name
716 java_trait_wrapper += ");\n"
717 java_trait_wrapper += "\t\t\t\tGC.KeepAlive(arg);\n"
718 if fn_line.ret_ty_info.java_ty != "void":
719 if fn_line.ret_ty_info.from_hu_conv is not None:
720 java_trait_wrapper += "\t\t\t" + fn_line.ret_ty_info.java_ty + " result = " + fn_line.ret_ty_info.from_hu_conv[0] + ";\n"
721 if fn_line.ret_ty_info.from_hu_conv[1] != "":
722 java_trait_wrapper += "\t\t\t" + fn_line.ret_ty_info.from_hu_conv[1].replace("this", "impl_holder.held") + ";\n"
723 java_trait_wrapper += "\t\t\treturn result;\n"
725 java_trait_wrapper += "\t\t\treturn ret;\n"
726 java_trait_wrapper += "\t\t}\n"
727 java_trait_wrapper += "\t}"
728 for var in field_vars:
729 if isinstance(var, ConvInfo):
730 java_trait_constr = java_trait_constr + ", " + var.arg_name
732 java_trait_constr += ", " + var[1] + ".new_impl(" + var[1] + "_impl"
734 for suparg in var[2]:
735 if isinstance(suparg, ConvInfo):
736 suptrait_constr += ", " + suparg.arg_name
738 suptrait_constr += ", " + suparg[1] + "_impl"
739 java_trait_constr += suptrait_constr + ").bindings_instance"
740 for suparg in var[2]:
741 if isinstance(suparg, ConvInfo):
742 java_trait_constr += ", " + suparg.arg_name
744 java_trait_constr += ", " + suparg[1] + ".new_impl("
745 # Blindly assume that we can just strip the first arg to build the args for the supertrait
746 java_trait_constr += suptrait_constr.split(", ", 1)[1]
747 java_trait_constr += ").bindings_instance"
748 out_java_trait += "\t}\n" + java_trait_wrapper + "\n"
749 out_java_trait += java_trait_constr + ");\n\t\treturn impl_holder.held;\n\t}\n"
753 out_java += self.native_meth_decl(struct_name + "_new", "long") + "(" + struct_name + " impl"
754 for var in flattened_field_vars:
755 if isinstance(var, ConvInfo):
756 out_java += ", " + var.java_ty + " " + var.arg_name
758 out_java += ", " + var[0] + " " + var[1]
761 # Now that we've written out our java code (and created java_meths), generate C
762 out_c = "typedef struct " + struct_name + "_JCalls {\n"
763 out_c = out_c + "\tatomic_size_t refcnt;\n"
764 out_c = out_c + "\tJavaVM *vm;\n"
765 out_c = out_c + "\tjweak o;\n"
766 for var in flattened_field_vars:
767 if isinstance(var, ConvInfo):
768 # We're a regular ol' field
772 out_c = out_c + "\t" + var[0] + "_JCalls* " + var[1] + ";\n"
774 if fn.fn_name != "free" and fn.fn_name != "cloned":
775 out_c = out_c + "\tjmethodID " + fn.fn_name + "_meth;\n"
776 out_c = out_c + "} " + struct_name + "_JCalls;\n"
778 for fn_line in field_fns:
779 if fn_line.fn_name == "free":
780 out_c = out_c + "static void " + struct_name + "_JCalls_free(void* this_arg) {\n"
781 out_c = out_c + "\t" + struct_name + "_JCalls *j_calls = (" + struct_name + "_JCalls*) this_arg;\n"
782 out_c = out_c + "\tif (atomic_fetch_sub_explicit(&j_calls->refcnt, 1, memory_order_acquire) == 1) {\n"
783 out_c += "\t\t" + self.construct_jenv().replace("\n", "\n\t\t").strip() + "\n"
784 out_c = out_c + "\t\t(*env)->DeleteWeakGlobalRef(env, j_calls->o);\n"
785 out_c += "\t\t" + self.deconstruct_jenv().replace("\n", "\n\t\t").strip() + "\n"
786 out_c = out_c + "\t\tFREE(j_calls);\n"
787 out_c = out_c + "\t}\n}\n"
789 for idx, fn_line in enumerate(field_fns):
790 if fn_line.fn_name != "free" and fn_line.fn_name != "cloned":
791 assert fn_line.ret_ty_info.ty_info.get_full_rust_ty()[1] == ""
792 out_c = out_c + fn_line.ret_ty_info.ty_info.get_full_rust_ty()[0] + " " + fn_line.fn_name + "_" + struct_name + "_jcall("
793 if fn_line.self_is_const:
794 out_c = out_c + "const void* this_arg"
796 out_c = out_c + "void* this_arg"
798 for idx, arg in enumerate(fn_line.args_ty):
799 out_c = out_c + ", " + arg.ty_info.get_full_rust_ty()[0] + " " + arg.arg_name + arg.ty_info.get_full_rust_ty()[1]
801 out_c = out_c + ") {\n"
802 out_c = out_c + "\t" + struct_name + "_JCalls *j_calls = (" + struct_name + "_JCalls*) this_arg;\n"
803 out_c += "\t" + self.construct_jenv().replace("\n", "\n\t").strip() + "\n"
805 for arg_info in fn_line.args_ty:
806 if arg_info.ret_conv is not None:
807 out_c = out_c + "\t" + arg_info.ret_conv[0].replace('\n', '\n\t')
808 out_c = out_c + arg_info.arg_name
809 out_c = out_c + arg_info.ret_conv[1].replace('\n', '\n\t') + "\n"
811 out_c = out_c + "\tjobject obj = (*env)->NewLocalRef(env, j_calls->o);\n\tCHECK(obj != NULL);\n"
812 if fn_line.ret_ty_info.c_ty.endswith("Array"):
813 out_c = out_c + "\t" + fn_line.ret_ty_info.c_ty + " ret = (*env)->CallObjectMethod(env, obj, j_calls->" + fn_line.fn_name + "_meth"
814 elif fn_line.ret_ty_info.c_ty == "void":
815 out_c += "\t(*env)->CallVoidMethod(env, obj, j_calls->" + fn_line.fn_name + "_meth"
816 elif fn_line.ret_ty_info.java_hu_ty == "string" or "org/ldk/enums" in fn_line.ret_ty_info.java_fn_ty_arg:
817 # Manually write out string methods as they're just an Object
818 out_c += "\t" + fn_line.ret_ty_info.c_ty + " ret = (*env)->CallObjectMethod(env, obj, j_calls->" + fn_line.fn_name + "_meth"
819 elif not fn_line.ret_ty_info.passed_as_ptr:
820 out_c += "\t" + fn_line.ret_ty_info.c_ty + " ret = (*env)->Call" + fn_line.ret_ty_info.java_ty.title() + "Method(env, obj, j_calls->" + fn_line.fn_name + "_meth"
822 out_c = out_c + "\tuint64_t ret = (*env)->CallLongMethod(env, obj, j_calls->" + fn_line.fn_name + "_meth"
824 for idx, arg_info in enumerate(fn_line.args_ty):
825 if arg_info.ret_conv is not None:
826 out_c = out_c + ", " + arg_info.ret_conv_name
828 out_c = out_c + ", " + arg_info.arg_name
829 out_c = out_c + ");\n"
831 out_c += "\tif (UNLIKELY((*env)->ExceptionCheck(env))) {\n"
832 out_c += "\t\t(*env)->ExceptionDescribe(env);\n"
833 out_c += "\t\t(*env)->FatalError(env, \"A call to " + fn_line.fn_name + " in " + struct_name + " from rust threw an exception.\");\n"
836 if fn_line.ret_ty_info.arg_conv is not None:
837 out_c += "\t" + fn_line.ret_ty_info.arg_conv.replace("\n", "\n\t") + "\n"
838 out_c += "\t" + self.deconstruct_jenv().replace("\n", "\n\t").strip() + "\n"
839 out_c += "\treturn " + fn_line.ret_ty_info.arg_conv_name + ";\n"
841 out_c += "\t" + self.deconstruct_jenv().replace("\n", "\n\t").strip() + "\n"
842 if not fn_line.ret_ty_info.passed_as_ptr and fn_line.ret_ty_info.c_ty != "void":
843 out_c += "\treturn ret;\n"
845 out_c = out_c + "}\n"
847 # If we can, write out a clone function whether we need one or not, as we use them in moving to rust
848 can_clone_with_ptr = True
849 for var in field_vars:
850 if isinstance(var, ConvInfo):
851 can_clone_with_ptr = False
852 if can_clone_with_ptr:
853 out_c = out_c + "static void " + struct_name + "_JCalls_cloned(" + struct_name + "* new_obj) {\n"
854 out_c = out_c + "\t" + struct_name + "_JCalls *j_calls = (" + struct_name + "_JCalls*) new_obj->this_arg;\n"
855 out_c = out_c + "\tatomic_fetch_add_explicit(&j_calls->refcnt, 1, memory_order_release);\n"
856 for var in field_vars:
857 if not isinstance(var, ConvInfo):
858 out_c = out_c + "\tatomic_fetch_add_explicit(&j_calls->" + var[1] + "->refcnt, 1, memory_order_release);\n"
859 out_c = out_c + "}\n"
861 out_c = out_c + "static inline " + struct_name + " " + struct_name + "_init (" + self.c_fn_args_pfx + ", jobject o"
862 for var in flattened_field_vars:
863 if isinstance(var, ConvInfo):
864 out_c = out_c + ", " + var.c_ty + " " + var.arg_name
866 out_c = out_c + ", jobject " + var[1]
867 out_c = out_c + ") {\n"
869 out_c = out_c + "\tjclass c = (*env)->GetObjectClass(env, o);\n"
870 out_c = out_c + "\tCHECK(c != NULL);\n"
871 out_c = out_c + "\t" + struct_name + "_JCalls *calls = MALLOC(sizeof(" + struct_name + "_JCalls), \"" + struct_name + "_JCalls\");\n"
872 out_c = out_c + "\tatomic_init(&calls->refcnt, 1);\n"
873 out_c = out_c + "\tDO_ASSERT((*env)->GetJavaVM(env, &calls->vm) == 0);\n"
874 out_c = out_c + "\tcalls->o = (*env)->NewWeakGlobalRef(env, o);\n"
876 for (fn_name, java_meth_descr) in java_meths:
877 if fn_name != "free" and fn_name != "cloned":
878 out_c = out_c + "\tcalls->" + fn_name + "_meth = (*env)->GetMethodID(env, c, \"" + fn_name + "\", \"" + java_meth_descr + "\");\n"
879 out_c = out_c + "\tCHECK(calls->" + fn_name + "_meth != NULL);\n"
881 for var in flattened_field_vars:
882 if isinstance(var, ConvInfo) and var.arg_conv is not None:
883 out_c = out_c + "\n\t" + var.arg_conv.replace("\n", "\n\t") +"\n"
884 out_c = out_c + "\n\t" + struct_name + " ret = {\n"
885 out_c = out_c + "\t\t.this_arg = (void*) calls,\n"
886 for fn_line in field_fns:
887 if fn_line.fn_name != "free" and fn_line.fn_name != "cloned":
888 out_c = out_c + "\t\t." + fn_line.fn_name + " = " + fn_line.fn_name + "_" + struct_name + "_jcall,\n"
889 elif fn_line.fn_name == "free":
890 out_c = out_c + "\t\t.free = " + struct_name + "_JCalls_free,\n"
892 out_c = out_c + "\t\t.cloned = " + struct_name + "_JCalls_cloned,\n"
893 for var in field_vars:
894 if isinstance(var, ConvInfo):
895 if var.arg_conv_name is not None:
896 out_c = out_c + "\t\t." + var.arg_name + " = " + var.arg_conv_name + ",\n"
897 out_c = out_c + "\t\t.set_" + var.arg_name + " = NULL,\n"
899 out_c = out_c + "\t\t." + var.var_name + " = " + var.var_name + ",\n"
900 out_c = out_c + "\t\t.set_" + var.var_name + " = NULL,\n"
902 out_c += "\t\t." + var[1] + " = " + var[0] + "_init(env, clz, " + var[1]
903 for suparg in var[2]:
904 if isinstance(suparg, ConvInfo):
905 out_c = out_c + ", " + suparg.arg_name
907 out_c = out_c + ", " + suparg[1]
909 out_c = out_c + "\t};\n"
910 for var in flattened_field_vars:
911 if not isinstance(var, ConvInfo):
912 out_c = out_c + "\tcalls->" + var[1] + " = ret." + var[1] + ".this_arg;\n"
913 out_c = out_c + "\treturn ret;\n"
914 out_c = out_c + "}\n"
916 out_c += "int64_t " + self.c_fn_name_define_pfx(struct_name + "_new", True) + "jobject o"
917 for var in flattened_field_vars:
918 if isinstance(var, ConvInfo):
919 out_c = out_c + ", " + var.c_ty + " " + var.arg_name
921 out_c = out_c + ", jobject " + var[1]
922 out_c = out_c + ") {\n"
923 out_c = out_c + "\t" + struct_name + " *res_ptr = MALLOC(sizeof(" + struct_name + "), \"" + struct_name + "\");\n"
924 out_c = out_c + "\t*res_ptr = " + struct_name + "_init(env, clz, o"
925 for var in flattened_field_vars:
926 if isinstance(var, ConvInfo):
927 out_c = out_c + ", " + var.arg_name
929 out_c = out_c + ", " + var[1]
930 out_c = out_c + ");\n"
931 out_c = out_c + "\treturn tag_ptr(res_ptr, true);\n"
932 out_c = out_c + "}\n"
934 for var in flattened_field_vars:
935 if not isinstance(var, ConvInfo):
936 out_java_trait += "\n\t/**\n"
937 out_java_trait += "\t * Gets the underlying " + var[1] + ".\n"
938 out_java_trait += "\t */\n"
939 underscore_name = ''.join('_' + c.lower() if c.isupper() else c for c in var[1]).strip('_')
940 out_java_trait += "\tpublic " + var[1] + " get_" + underscore_name + "() {\n"
941 out_java_trait += "\t\t" + var[1] + " res = new " + var[1] + "(null, bindings." + struct_name + "_get_" + var[1] + "(this.ptr));\n"
942 out_java_trait += "\t\tthis.ptrs_to.AddLast(res);\n"
943 out_java_trait += "\t\treturn res;\n"
944 out_java_trait += "\t}\n"
945 out_java_trait += "\n"
947 out_java += self.native_meth_decl(struct_name + "_get_" + var[1], "long") + "(long arg);\n"
949 out_c += "int64_t " + self.c_fn_name_define_pfx(struct_name + "_get_" + var[1], True) + "int64_t arg) {\n"
950 out_c += "\t" + struct_name + " *inp = (" + struct_name + " *)untag_ptr(arg);\n"
951 out_c += "\treturn tag_ptr(&inp->" + var[1] + ", false);\n"
954 return (out_java, out_java_trait, out_c)
956 def trait_struct_inc_refcnt(self, ty_info):
957 base_conv = "\nif (" + ty_info.var_name + "_conv.free == " + ty_info.rust_obj + "_JCalls_free) {\n"
958 base_conv = base_conv + "\t// If this_arg is a JCalls struct, then we need to increment the refcnt in it.\n"
959 base_conv = base_conv + "\t" + ty_info.rust_obj + "_JCalls_cloned(&" + ty_info.var_name + "_conv);\n}"
962 def map_complex_enum(self, struct_name, variant_list, camel_to_snake, enum_doc_comment):
963 bindings_type = struct_name.replace("LDK", "")
964 java_hu_type = struct_name.replace("LDK", "").replace("COption", "Option")
970 out_java_enum += (self.hu_struct_file_prefix)
972 java_hu_class = "/**\n * " + enum_doc_comment.replace("\n", "\n * ") + "\n */\n"
973 java_hu_class += "public class " + java_hu_type + " : CommonBase {\n"
974 java_hu_class += f"\tprotected {java_hu_type}(object _dummy, long ptr) : base(ptr)" + " { }\n"
975 java_hu_class += "\t~" + java_hu_type + "() {\n"
976 java_hu_class += "\t\tif (ptr != 0) { bindings." + bindings_type + "_free(ptr); }\n"
977 java_hu_class += "\t}\n\n"
978 java_hu_class += f"\tinternal static {java_hu_type} constr_from_ptr(long ptr) {{\n"
979 java_hu_class += f"\t\tlong raw_ty = bindings." + struct_name + "_ty_from_ptr(ptr);\n"
980 out_c += self.c_fn_ty_pfx + "uint32_t" + self.c_fn_name_define_pfx(struct_name + "_ty_from_ptr", True) + self.ptr_c_ty + " ptr) {\n"
981 out_c += "\t" + struct_name + " *obj = (" + struct_name + "*)untag_ptr(ptr);\n"
982 out_c += "\tswitch(obj->tag) {\n"
983 java_hu_class += "\t\tswitch (raw_ty) {\n"
984 java_hu_subclasses = ""
987 for var in variant_list:
988 java_hu_subclasses += "\t/** A " + java_hu_type + " of type " + var.var_name + " */\n"
989 java_hu_subclasses += "\tpublic class " + java_hu_type + "_" + var.var_name + " : " + java_hu_type + " {\n"
990 java_hu_class += f"\t\t\tcase {var_idx}: "
991 java_hu_class += "return new " + java_hu_type + "_" + var.var_name + "(ptr);\n"
992 out_c += f"\t\tcase {struct_name}_{var.var_name}: return {var_idx};\n"
994 for idx, (field_ty, field_docs) in enumerate(var.fields):
995 if field_docs is not None:
996 java_hu_subclasses += "\t\t/**\n\t\t * " + field_docs.replace("\n", "\n\t\t * ") + "\n\t\t */\n"
997 java_hu_subclasses += f"\t\tpublic {field_ty.java_hu_ty} {field_ty.arg_name};\n"
998 if field_ty.to_hu_conv is not None:
999 hu_conv_body += f"\t\t\t{field_ty.java_ty} {field_ty.arg_name} = bindings.{struct_name}_{var.var_name}_get_{field_ty.arg_name}(ptr);\n"
1000 hu_conv_body += f"\t\t\t" + field_ty.to_hu_conv.replace("\n", "\n\t\t\t") + "\n"
1001 hu_conv_body += f"\t\t\tthis." + field_ty.arg_name + " = " + field_ty.to_hu_conv_name + ";\n"
1003 hu_conv_body += f"\t\t\tthis.{field_ty.arg_name} = bindings.{struct_name}_{var.var_name}_get_{field_ty.arg_name}(ptr);\n"
1004 java_hu_subclasses += "\t\tinternal " + java_hu_type + "_" + var.var_name + "(long ptr) : base(null, ptr) {\n"
1005 java_hu_subclasses += hu_conv_body
1006 java_hu_subclasses += "\t\t}\n\t}\n"
1008 java_hu_class += "\t\t\tdefault:\n\t\t\t\tthrow new ArgumentException(\"Impossible enum variant\");\n\t\t}\n\t}\n\n"
1009 out_java += self.native_meth_decl(struct_name + "_ty_from_ptr", "long") + "(long ptr);\n"
1010 out_c += ("\t\tdefault: abort();\n")
1011 out_c += ("\t}\n}\n")
1013 for var in variant_list:
1014 for idx, (field_map, _) in enumerate(var.fields):
1015 fn_name = f"{struct_name}_{var.var_name}_get_{field_map.arg_name}"
1016 out_c += self.c_fn_ty_pfx + field_map.c_ty + self.c_fn_name_define_pfx(fn_name, True) + self.ptr_c_ty + " ptr) {\n"
1017 out_c += "\t" + struct_name + " *obj = (" + struct_name + "*)untag_ptr(ptr);\n"
1018 out_c += f"\tassert(obj->tag == {struct_name}_{var.var_name});\n"
1019 if field_map.ret_conv is not None:
1020 out_c += ("\t\t\t" + field_map.ret_conv[0].replace("\n", "\n\t\t\t"))
1021 if var.tuple_variant:
1022 out_c += "obj->" + camel_to_snake(var.var_name)
1024 out_c += "obj->" + camel_to_snake(var.var_name) + "." + field_map.arg_name
1025 out_c += (field_map.ret_conv[1].replace("\n", "\n\t\t\t") + "\n")
1026 out_c += "\treturn " + field_map.ret_conv_name + ";\n"
1028 if var.tuple_variant:
1029 out_c += "\treturn " + "obj->" + camel_to_snake(var.var_name) + ";\n"
1031 out_c += "\treturn " + "obj->" + camel_to_snake(var.var_name) + "." + field_map.arg_name + ";\n"
1033 out_java += self.native_meth_decl(fn_name, field_map.java_ty) + "(long ptr);\n"
1034 out_java_enum += java_hu_class
1035 out_java_enum += java_hu_subclasses
1036 return (out_java, out_java_enum, out_c)
1038 def map_opaque_struct(self, struct_name, struct_doc_comment):
1039 out_opaque_struct_human = ""
1040 out_opaque_struct_human += self.hu_struct_file_prefix
1041 out_opaque_struct_human += "\n/**\n * " + struct_doc_comment.replace("\n", "\n * ") + "\n */\n"
1042 hu_name = struct_name.replace("LDKC2Tuple", "TwoTuple").replace("LDKC3Tuple", "ThreeTuple").replace("LDK", "")
1043 out_opaque_struct_human += ("public class " + hu_name + " : CommonBase")
1044 if struct_name.startswith("LDKLocked") or struct_name.startswith("LDKReadOnly"):
1045 out_opaque_struct_human += (", IDisposable")
1046 out_opaque_struct_human += (" {\n")
1047 out_opaque_struct_human += ("\tinternal " + hu_name + "(object _dummy, long ptr) : base(ptr) { }\n")
1048 if struct_name.startswith("LDKLocked") or struct_name.startswith("LDKReadOnly"):
1049 out_opaque_struct_human += ("\tpublic void Dispose() {\n")
1051 out_opaque_struct_human += ("\t~" + hu_name + "() {\n")
1052 out_opaque_struct_human += ("\t\tif (ptr != 0) { bindings." + struct_name.replace("LDK","") + "_free(ptr); }\n")
1053 out_opaque_struct_human += ("\t}\n\n")
1054 return out_opaque_struct_human
1056 def map_tuple(self, struct_name):
1057 return self.map_opaque_struct(struct_name, "A Tuple")
1059 def map_result(self, struct_name, res_map, err_map):
1060 human_ty = struct_name.replace("LDKCResult", "Result")
1062 java_hu_struct += self.hu_struct_file_prefix
1063 java_hu_struct += "public class " + human_ty + " : CommonBase {\n"
1064 java_hu_struct += "\t" + human_ty + "(object _dummy, long ptr) : base(ptr) { }\n"
1065 java_hu_struct += "\t~" + human_ty + "() {\n"
1066 java_hu_struct += "\t\tif (ptr != 0) { bindings." + struct_name.replace("LDK","") + "_free(ptr); }\n"
1067 java_hu_struct += "\t}\n\n"
1068 java_hu_struct += "\tinternal static " + human_ty + " constr_from_ptr(long ptr) {\n"
1069 java_hu_struct += "\t\tif (bindings." + struct_name.replace("LDK", "") + "_is_ok(ptr)) {\n"
1070 java_hu_struct += "\t\t\treturn new " + human_ty + "_OK(null, ptr);\n"
1071 java_hu_struct += "\t\t} else {\n"
1072 java_hu_struct += "\t\t\treturn new " + human_ty + "_Err(null, ptr);\n"
1073 java_hu_struct += "\t\t}\n"
1074 java_hu_struct += "\t}\n"
1076 java_hu_struct += "\tpublic class " + human_ty + "_OK : " + human_ty + " {\n"
1078 if res_map.java_hu_ty != "void":
1079 java_hu_struct += "\t\tpublic readonly " + res_map.java_hu_ty + " res;\n"
1080 java_hu_struct += "\t\tinternal " + human_ty + "_OK(object _dummy, long ptr) : base(_dummy, ptr) {\n"
1081 if res_map.java_hu_ty == "void":
1083 elif res_map.to_hu_conv is not None:
1084 java_hu_struct += "\t\t\t" + res_map.java_ty + " res = bindings." + struct_name.replace("LDK", "") + "_get_ok(ptr);\n"
1085 java_hu_struct += "\t\t\t" + res_map.to_hu_conv.replace("\n", "\n\t\t\t")
1086 java_hu_struct += "\n\t\t\tthis.res = " + res_map.to_hu_conv_name + ";\n"
1088 java_hu_struct += "\t\t\tthis.res = bindings." + struct_name.replace("LDK", "") + "_get_ok(ptr);\n"
1089 java_hu_struct += "\t\t}\n"
1090 java_hu_struct += "\t}\n\n"
1092 java_hu_struct += "\tpublic class " + human_ty + "_Err : " + human_ty + " {\n"
1093 if err_map.java_hu_ty != "void":
1094 java_hu_struct += "\t\tpublic readonly " + err_map.java_hu_ty + " err;\n"
1095 java_hu_struct += "\t\tinternal " + human_ty + "_Err(object _dummy, long ptr) : base(_dummy, ptr) {\n"
1096 if err_map.java_hu_ty == "void":
1098 elif err_map.to_hu_conv is not None:
1099 java_hu_struct += "\t\t\t" + err_map.java_ty + " err = bindings." + struct_name.replace("LDK", "") + "_get_err(ptr);\n"
1100 java_hu_struct += "\t\t\t" + err_map.to_hu_conv.replace("\n", "\n\t\t\t")
1101 java_hu_struct += "\n\t\t\tthis.err = " + err_map.to_hu_conv_name + ";\n"
1103 java_hu_struct += "\t\t\tthis.err = bindings." + struct_name.replace("LDK", "") + "_get_err(ptr);\n"
1104 java_hu_struct += "\t\t}\n"
1106 java_hu_struct += "\t}\n\n"
1107 return java_hu_struct
1109 def map_function(self, argument_types, c_call_string, method_name, meth_n, return_type_info, struct_meth, default_constructor_args, takes_self, takes_self_as_ref, args_known, type_mapping_generator, doc_comment):
1110 arg_name_repl = lambda s, arg_name: s.replace(arg_name, "_" + arg_name) if arg_name == "lock" or arg_name == "event" or arg_name == "params" else s
1113 out_java_struct = None
1115 out_java += self.native_meth_decl(method_name, return_type_info.java_ty) + "("
1116 out_c += (return_type_info.c_ty)
1117 if return_type_info.ret_conv is not None:
1118 ret_conv_pfx, ret_conv_sfx = return_type_info.ret_conv
1119 have_args = len(argument_types) > 1 or (len(argument_types) > 0 and argument_types[0].c_ty != "void")
1120 out_c += (" " + self.c_fn_name_define_pfx(method_name, have_args))
1122 for idx, arg_conv_info in enumerate(argument_types):
1126 if arg_conv_info.c_ty != "void":
1127 out_c += (arg_conv_info.c_ty + " " + arg_conv_info.arg_name)
1128 out_java += (arg_conv_info.java_ty + " _" + arg_conv_info.arg_name) # Add a _ to avoid using reserved words
1130 out_java_struct = ""
1131 extra_java_struct_out = ""
1133 out_java_struct += ("\t// Skipped " + method_name + "\n")
1135 if doc_comment is not None:
1136 out_java_struct += "\t/**\n\t * " + doc_comment.replace("\n", "\n\t * ") + "\n\t */\n"
1137 hu_ret_ty = return_type_info.java_hu_ty
1138 if return_type_info.nullable:
1139 #hu_ret_ty += "?" - apparently mono doesn't support the nullable stuff
1143 out_java_struct += "\tpublic static " + hu_ret_ty + " of("
1144 elif meth_n == "default":
1145 out_java_struct += "\tpublic static " + hu_ret_ty + " with_default("
1147 out_java_struct += "\tpublic static " + hu_ret_ty + " " + meth_n + "("
1148 elif meth_n == "clone_ptr" or (struct_meth.startswith("LDKCResult") and (meth_n == "get_ok" or meth_n == "get_err")):
1149 out_java_struct += "\tinternal " + hu_ret_ty + " " + meth_n + "("
1151 if meth_n == "hash" and return_type_info.java_hu_ty == "long":
1152 extra_java_struct_out = "\tpublic override int GetHashCode() {\n"
1153 extra_java_struct_out += "\t\treturn (int)this.hash();\n"
1154 extra_java_struct_out += "\t}\n"
1155 elif meth_n == "eq" and return_type_info.java_hu_ty == "bool":
1156 extra_java_struct_out = "\tpublic override bool Equals(object o) {\n"
1157 extra_java_struct_out += "\t\tif (!(o is " + struct_meth + ")) return false;\n"
1158 extra_java_struct_out += "\t\treturn this.eq((" + struct_meth + ")o);\n"
1159 extra_java_struct_out += "\t}\n"
1160 if meth_n == "lock":
1161 out_java_struct += "\tpublic " + hu_ret_ty + " do_lock("
1163 out_java_struct += "\tpublic " + hu_ret_ty + " " + meth_n + "("
1164 for idx, arg in enumerate(argument_types):
1166 if not takes_self or idx > 1:
1167 out_java_struct += ", "
1170 if arg.java_ty != "void":
1171 if arg.arg_name in default_constructor_args:
1172 assert not arg.nullable
1173 for explode_idx, explode_arg in enumerate(default_constructor_args[arg.arg_name]):
1174 if explode_idx != 0:
1175 out_java_struct += (", ")
1176 out_java_struct += (
1177 explode_arg.java_hu_ty + " " + arg.arg_name + "_" + explode_arg.arg_name)
1179 ty_string = arg.java_hu_ty
1181 #ty_string += "?" - apparently mono doesn't support the nullable stuff
1183 ty_string = self.fully_qualified_hu_ty_path(arg)
1184 out_java_struct += ty_string + " " + arg_name_repl(arg.arg_name, arg.arg_name)
1185 out_java += (");\n")
1187 if out_java_struct is not None:
1188 out_java_struct += (") {\n")
1189 for info in argument_types:
1190 if info.arg_conv is not None:
1191 out_c += ("\t" + info.arg_conv.replace('\n', "\n\t") + "\n")
1192 if return_type_info.ret_conv is not None:
1193 out_c += ("\t" + ret_conv_pfx.replace('\n', '\n\t'))
1194 elif return_type_info.c_ty != "void":
1195 out_c += ("\t" + return_type_info.c_ty + " ret_val = ")
1198 if c_call_string is None:
1199 out_c += (method_name + "(")
1201 out_c += (c_call_string)
1202 for idx, info in enumerate(argument_types):
1203 if info.arg_conv_name is not None:
1206 elif c_call_string is not None:
1208 out_c += (info.arg_conv_name)
1210 if return_type_info.ret_conv is not None:
1211 out_c += (ret_conv_sfx.replace('\n', '\n\t'))
1214 for info in argument_types:
1215 if info.arg_conv_cleanup is not None:
1216 out_c += ("\n\t" + info.arg_conv_cleanup.replace("\n", "\n\t"))
1217 if return_type_info.ret_conv is not None:
1218 out_c += ("\n\treturn " + return_type_info.ret_conv_name + ";")
1219 elif return_type_info.c_ty != "void":
1220 out_c += ("\n\treturn ret_val;")
1221 out_c += ("\n}\n\n")
1224 out_java_struct += ("\t\t")
1225 if return_type_info.java_ty != "void":
1226 out_java_struct += (return_type_info.java_ty + " ret = ")
1227 out_java_struct += ("bindings." + method_name + "(")
1228 for idx, info in enumerate(argument_types):
1230 out_java_struct += (", ")
1231 if idx == 0 and takes_self:
1232 out_java_struct += ("this.ptr")
1233 elif info.arg_name in default_constructor_args:
1234 out_java_struct += ("bindings." + info.java_hu_ty + "_new(")
1235 for explode_idx, explode_arg in enumerate(default_constructor_args[info.arg_name]):
1236 if explode_idx != 0:
1237 out_java_struct += (", ")
1238 expl_arg_name = info.arg_name + "_" + explode_arg.arg_name
1239 if explode_arg.from_hu_conv is not None:
1240 out_java_struct += (
1241 explode_arg.from_hu_conv[0].replace(explode_arg.arg_name, expl_arg_name))
1243 out_java_struct += (expl_arg_name)
1244 out_java_struct += (")")
1245 elif info.from_hu_conv is not None:
1246 out_java_struct += arg_name_repl(info.from_hu_conv[0], info.arg_name)
1248 out_java_struct += arg_name_repl(info.arg_name, info.arg_name)
1249 out_java_struct += (");\n")
1251 # Like Java, the C# GC is quite aggressive and can finalize an object while a method
1252 # on it is operating. Unlike Java, this behavior appears to be better documented,
1254 for idx, info in enumerate(argument_types):
1255 if idx == 0 and takes_self:
1256 out_java_struct += ("\t\tGC.KeepAlive(this);\n")
1257 elif info.arg_name in default_constructor_args:
1258 for explode_idx, explode_arg in enumerate(default_constructor_args[info.arg_name]):
1259 expl_arg_name = info.arg_name + "_" + explode_arg.arg_name
1260 out_java_struct += ("\t\tGC.KeepAlive(" + expl_arg_name + ");\n")
1261 elif info.c_ty != "void":
1262 out_java_struct += ("\t\tGC.KeepAlive(" + arg_name_repl(info.arg_name, info.arg_name) + ");\n")
1264 if return_type_info.java_ty == "long" and return_type_info.java_hu_ty != "long":
1265 out_java_struct += "\t\tif (ret >= 0 && ret <= 4096) { return null; }\n"
1267 if return_type_info.to_hu_conv is not None:
1269 out_java_struct += ("\t\t" + return_type_info.to_hu_conv.replace("\n", "\n\t\t")
1270 .replace("this", return_type_info.to_hu_conv_name) + "\n")
1272 out_java_struct += ("\t\t" + return_type_info.to_hu_conv.replace("\n", "\n\t\t") + "\n")
1274 for idx, info in enumerate(argument_types):
1275 if idx == 0 and takes_self:
1277 elif info.arg_name in default_constructor_args:
1278 for explode_arg in default_constructor_args[info.arg_name]:
1279 expl_arg_name = info.arg_name + "_" + explode_arg.arg_name
1280 if explode_arg.from_hu_conv is not None and return_type_info.to_hu_conv_name:
1281 out_java_struct += ("\t\t" +
1282 arg_name_repl(explode_arg.from_hu_conv[1], info.arg_name)
1283 .replace(explode_arg.arg_name, expl_arg_name)
1284 .replace("this", return_type_info.to_hu_conv_name) + ";\n")
1285 elif info.from_hu_conv is not None and info.from_hu_conv[1] != "":
1286 if not takes_self and return_type_info.to_hu_conv_name is not None:
1287 out_java_struct += ("\t\t" + arg_name_repl(info.from_hu_conv[1], info.arg_name)
1288 .replace("this", return_type_info.to_hu_conv_name)
1289 .replace("\n", "\n\t\t") + ";\n")
1291 out_java_struct += ("\t\t" + arg_name_repl(info.from_hu_conv[1], info.arg_name)
1292 .replace("\n", "\n\t\t") + ";\n")
1294 if takes_self and not takes_self_as_ref:
1295 out_java_struct += "\t\t" + argument_types[0].from_hu_conv[1].replace("\n", "\n\t\t").replace("this_arg", "this") + ";\n"
1296 if return_type_info.to_hu_conv_name is not None:
1297 out_java_struct += ("\t\treturn " + return_type_info.to_hu_conv_name + ";\n")
1298 elif return_type_info.java_ty != "void" and return_type_info.rust_obj != "LDK" + struct_meth:
1299 out_java_struct += ("\t\treturn ret;\n")
1300 out_java_struct += ("\t}\n\n")
1302 return (out_java, out_c, out_java_struct + extra_java_struct_out)