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 = """
36 using System.Runtime.InteropServices;
38 namespace org { namespace ldk { namespace impl {
40 internal class bindings {
41 internal class ArrayCoder : ICustomMarshaler {
44 public static ICustomMarshaler GetInstance(string pstrCookie) {
45 return new ArrayCoder();
48 public Object MarshalNativeToManaged(IntPtr pNativeData) { throw new NotImplementedException(); }
49 public IntPtr MarshalManagedToNative(Object obj) {
50 if (obj.GetType() == typeof(byte[])) {
51 byte[] inp = (byte[])obj;
52 IntPtr data = Marshal.AllocHGlobal(inp.Length + 8);
53 Marshal.WriteInt64(data, inp.Length);
54 Marshal.Copy(inp, 0, data + 8, inp.Length);
55 this.size = inp.Length + 8;
58 throw new NotImplementedException();
61 public void CleanUpNativeData(IntPtr pNativeData) {
62 Marshal.FreeHGlobal(pNativeData);
64 public void CleanUpManagedData(Object ManagedObj) { }
65 public int GetNativeDataSize() {
66 // Blindly guess based on the last allocation, no idea how else to implement this.
72 init(java.lang.Enum.class, VecOrSliceDef.class);
74 if (!get_lib_version_string().equals(version.get_ldk_java_bindings_version()))
75 throw new ArgumentException("Compiled LDK library and LDK class failes do not match");
76 // Fetching the LDK versions from C also checks that the header and binaries match
77 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());
79 //static extern void init(java.lang.Class c);
80 //static native void init_class_cache();
82 self.bindings_header += self.native_meth_decl("get_lib_version_string", "string") + "();\n"
83 self.bindings_header += self.native_meth_decl("get_ldk_c_bindings_version", "string") + "();\n"
84 self.bindings_header += self.native_meth_decl("get_ldk_version", "string") + "();\n\n"
86 self.bindings_version_file = """
88 public class version {
89 public static string get_ldk_java_bindings_version() {
90 return "<git_version_ldk_garbagecollected>";
94 self.util_fn_pfx = """using org.ldk.impl;
97 using org.ldk.structs;
100 namespace org { namespace ldk { namespace util {
101 public class UtilMethods {
103 self.util_fn_sfx = "} } } }"
104 self.common_base = """using System.Collections.Generic;
105 using System.Diagnostics;
107 public class CommonBase {
108 protected internal long ptr;
109 protected internal LinkedList<object> ptrs_to = new LinkedList<object>();
110 protected CommonBase(long ptr) { Trace.Assert(ptr < 0 || ptr > 4096); this.ptr = ptr; }
114 self.txin_defn = """public class TxIn : CommonBase {
115 /** The witness in this input, in serialized form */
116 public readonly byte[] witness;
117 /** The script_sig in this input */
118 public readonly byte[] script_sig;
119 /** The transaction output's sequence number */
120 public readonly int sequence;
121 /** The txid this input is spending */
122 public readonly byte[] previous_txid;
123 /** The output index within the spent transaction of the output this input is spending */
124 public readonly int previous_vout;
126 internal TxIn(object _dummy, long ptr) : base(ptr) {
127 this.witness = bindings.TxIn_get_witness(ptr);
128 this.script_sig = bindings.TxIn_get_script_sig(ptr);
129 this.sequence = bindings.TxIn_get_sequence(ptr);
130 this.previous_txid = bindings.TxIn_get_previous_txid(ptr);
131 this.previous_vout = bindings.TxIn_get_previous_vout(ptr);
133 public TxIn(byte[] witness, byte[] script_sig, int sequence, byte[] previous_txid, int previous_vout)
134 : this(null, bindings.TxIn_new(witness, script_sig, sequence, previous_txid, previous_vout)) {}
137 if (ptr != 0) { bindings.TxIn_free(ptr); }
141 self.txout_defn = """public class TxOut : CommonBase {
142 /** The script_pubkey in this output */
143 public readonly byte[] script_pubkey;
144 /** The value, in satoshis, of this output */
145 public readonly long value;
147 internal TxOut(object _dummy, long ptr) : base(ptr) {
148 this.script_pubkey = bindings.TxOut_get_script_pubkey(ptr);
149 this.value = bindings.TxOut_get_value(ptr);
151 public TxOut(long value, byte[] script_pubkey) : this(null, bindings.TxOut_new(script_pubkey, value)) {}
154 if (ptr != 0) { bindings.TxOut_free(ptr); }
158 self.scalar_defn = """public class BigEndianScalar : CommonBase {
159 /** The bytes of the scalar value, in big endian */
160 public readonly byte[] scalar_bytes;
162 internal BigEndianScalar(object _dummy, long ptr) : base(ptr) {
163 this.scalar_bytes = bindings.BigEndianScalar_get_bytes(ptr);
165 public BigEndianScalar(byte[] scalar_bytes) : base(bindings.BigEndianScalar_new(scalar_bytes)) {
166 this.scalar_bytes = bindings.BigEndianScalar_get_bytes(ptr);
170 if (ptr != 0) { bindings.BigEndianScalar_free(ptr); }
175 self.c_file_pfx = """
176 // On OSX jlong (ie long long) is not equivalent to int64_t, so we override here
177 #define int64_t jlong
178 #include <lightning.h>
180 #include <stdatomic.h>
183 #define LIKELY(v) __builtin_expect(!!(v), 1)
184 #define UNLIKELY(v) __builtin_expect(!!(v), 0)
188 self.c_file_pfx = self.c_file_pfx + "#include <stdio.h>\n#define DEBUG_PRINT(...) fprintf(stderr, __VA_ARGS__)\n"
190 if not DEBUG or sys.platform == "darwin":
191 self.c_file_pfx = self.c_file_pfx + """#define do_MALLOC(a, _b, _c) malloc(a)
192 #define MALLOC(a, _) malloc(a)
193 #define FREE(p) if ((uint64_t)(p) > 4096) { free(p); }
194 #define CHECK_ACCESS(p)
195 #define CHECK_INNER_FIELD_ACCESS_OR_NULL(v)
198 self.c_file_pfx += """#define DO_ASSERT(a) (void)(a)
202 self.c_file_pfx = self.c_file_pfx + """#include <assert.h>
203 // Always run a, then assert it is true:
204 #define DO_ASSERT(a) do { bool _assert_val = (a); assert(_assert_val); } while(0)
205 // Assert a is true or do nothing
206 #define CHECK(a) DO_ASSERT(a)
208 void __attribute__((constructor)) debug_log_version() {
209 if (check_get_ldk_version() == NULL)
210 DEBUG_PRINT("LDK version did not match the header we built against\\n");
211 if (check_get_ldk_bindings_version() == NULL)
212 DEBUG_PRINT("LDK C Bindings version did not match the header we built against\\n");
216 if sys.platform != "darwin":
217 self.c_file_pfx += """
218 // Running a leak check across all the allocations and frees of the JDK is a mess,
219 // so instead we implement our own naive leak checker here, relying on the -wrap
220 // linker option to wrap malloc/calloc/realloc/free, tracking everyhing allocated
221 // and free'd in Rust or C across the generated bindings shared library.
225 self.c_file_pfx = self.c_file_pfx + "#include <execinfo.h>\n"
226 self.c_file_pfx = self.c_file_pfx + """
229 static pthread_mutex_t allocation_mtx;
231 void __attribute__((constructor)) init_mtx() {
232 DO_ASSERT(!pthread_mutex_init(&allocation_mtx, NULL));
236 typedef struct allocation {
237 struct allocation* next;
239 const char* struct_name;
242 unsigned long alloc_len;
244 static allocation* allocation_ll = NULL;
246 void* __real_malloc(size_t len);
247 void* __real_calloc(size_t nmemb, size_t len);
248 static void new_allocation(void* res, const char* struct_name, size_t len) {
249 allocation* new_alloc = __real_malloc(sizeof(allocation));
250 new_alloc->ptr = res;
251 new_alloc->struct_name = struct_name;
252 new_alloc->bt_len = backtrace(new_alloc->bt, BT_MAX);
253 new_alloc->alloc_len = len;
254 DO_ASSERT(!pthread_mutex_lock(&allocation_mtx));
255 new_alloc->next = allocation_ll;
256 allocation_ll = new_alloc;
257 DO_ASSERT(!pthread_mutex_unlock(&allocation_mtx));
259 static void* do_MALLOC(size_t len, const char* struct_name, int lineno) {
260 void* res = __real_malloc(len);
261 new_allocation(res, struct_name, lineno);
264 #define MALLOC(len, struct_name) do_MALLOC(len, struct_name, __LINE__)
266 void __real_free(void* ptr);
267 static void alloc_freed(void* ptr) {
268 allocation* p = NULL;
269 DO_ASSERT(!pthread_mutex_lock(&allocation_mtx));
270 allocation* it = allocation_ll;
271 while (it->ptr != ptr) {
272 p = it; it = it->next;
274 DEBUG_PRINT("ERROR: Tried to free unknown pointer %p at:\\n", ptr);
276 int bt_len = backtrace(bt, BT_MAX);
277 backtrace_symbols_fd(bt, bt_len, STDERR_FILENO);
278 DEBUG_PRINT("\\n\\n");
279 DO_ASSERT(!pthread_mutex_unlock(&allocation_mtx));
280 return; // addrsan should catch malloc-unknown and print more info than we have
283 if (p) { p->next = it->next; } else { allocation_ll = it->next; }
284 DO_ASSERT(!pthread_mutex_unlock(&allocation_mtx));
285 DO_ASSERT(it->ptr == ptr);
288 static void FREE(void* ptr) {
289 if ((uint64_t)ptr <= 4096) return; // Rust loves to create pointers to the NULL page for dummys
294 void* __wrap_malloc(size_t len) {
295 void* res = __real_malloc(len);
296 new_allocation(res, "malloc call", len);
299 void* __wrap_calloc(size_t nmemb, size_t len) {
300 void* res = __real_calloc(nmemb, len);
301 new_allocation(res, "calloc call", len);
304 void __wrap_free(void* ptr) {
305 if (ptr == NULL) return;
310 static void CHECK_ACCESS(const void* ptr) {
311 DO_ASSERT(!pthread_mutex_lock(&allocation_mtx));
312 allocation* it = allocation_ll;
313 while (it->ptr != ptr) {
316 DEBUG_PRINT("ERROR: Tried to access unknown pointer %p at:\\n", ptr);
318 int bt_len = backtrace(bt, BT_MAX);
319 backtrace_symbols_fd(bt, bt_len, STDERR_FILENO);
320 DEBUG_PRINT("\\n\\n");
321 DO_ASSERT(!pthread_mutex_unlock(&allocation_mtx));
322 return; // addrsan should catch and print more info than we have
325 DO_ASSERT(!pthread_mutex_unlock(&allocation_mtx));
327 #define CHECK_INNER_FIELD_ACCESS_OR_NULL(v) \\
328 if (v.is_owned && v.inner != NULL) { \\
329 const void *p = __unmangle_inner_ptr(v.inner); \\
335 void* __real_realloc(void* ptr, size_t newlen);
336 void* __wrap_realloc(void* ptr, size_t len) {
337 if (ptr != NULL) alloc_freed(ptr);
338 void* res = __real_realloc(ptr, len);
339 new_allocation(res, "realloc call", len);
342 void __wrap_reallocarray(void* ptr, size_t new_sz) {
343 // Rust doesn't seem to use reallocarray currently
347 void __attribute__((destructor)) check_leaks() {
348 unsigned long alloc_count = 0;
349 unsigned long alloc_size = 0;
350 DEBUG_PRINT("The following LDK-allocated blocks still remain.\\n");
351 DEBUG_PRINT("Note that this is only accurate if System.gc(); System.runFinalization()\\n");
352 DEBUG_PRINT("was called prior to exit after all LDK objects were out of scope.\\n");
353 for (allocation* a = allocation_ll; a != NULL; a = a->next) {
354 DEBUG_PRINT("%s %p (%lu bytes) remains:\\n", a->struct_name, a->ptr, a->alloc_len);
355 backtrace_symbols_fd(a->bt, a->bt_len, STDERR_FILENO);
356 DEBUG_PRINT("\\n\\n");
358 alloc_size += a->alloc_len;
360 DEBUG_PRINT("%lu allocations remained for %lu bytes.\\n", alloc_count, alloc_size);
361 DEBUG_PRINT("Note that this is only accurate if System.gc(); System.runFinalization()\\n");
362 DEBUG_PRINT("was called prior to exit after all LDK objects were out of scope.\\n");
365 self.c_file_pfx = self.c_file_pfx + """
367 // We assume that CVec_u8Z and u8slice are the same size and layout (and thus pointers to the two can be mixed)
368 _Static_assert(sizeof(LDKCVec_u8Z) == sizeof(LDKu8slice), "Vec<u8> and [u8] need to have been mapped identically");
369 _Static_assert(offsetof(LDKCVec_u8Z, data) == offsetof(LDKu8slice, data), "Vec<u8> and [u8] need to have been mapped identically");
370 _Static_assert(offsetof(LDKCVec_u8Z, datalen) == offsetof(LDKu8slice, datalen), "Vec<u8> and [u8] need to have been mapped identically");
372 _Static_assert(sizeof(void*) <= 8, "Pointers must fit into 64 bits");
374 #define DECL_ARR_TYPE(ty, name) \\
375 struct name##array { \\
376 uint64_t arr_len; /* uint32_t would suffice but we want to align uint64_ts as well */ \\
379 typedef struct name##array * name##Array; \\
380 static inline name##Array init_##name##Array(size_t arr_len, int lineno) { \\
381 name##Array arr = (name##Array)do_MALLOC(arr_len * sizeof(ty) + sizeof(uint64_t), #name" array init", lineno); \\
382 arr->arr_len = arr_len; \\
386 DECL_ARR_TYPE(int64_t, int64_t);
387 DECL_ARR_TYPE(uint64_t, uint64_t);
388 DECL_ARR_TYPE(int8_t, int8_t);
389 DECL_ARR_TYPE(int16_t, int16_t);
390 DECL_ARR_TYPE(uint32_t, uint32_t);
391 DECL_ARR_TYPE(void*, ptr);
392 DECL_ARR_TYPE(char, char);
393 typedef charArray jstring;
395 static inline jstring str_ref_to_cs(const char* chars, size_t len) {
396 charArray arr = init_charArray(len, __LINE__);
397 memcpy(arr->elems, chars, len);
400 static inline LDKStr str_ref_to_owned_c(const jstring str) {
401 char* newchars = MALLOC(str->arr_len + 1, "String chars");
402 memcpy(newchars, str->elems, str->arr_len);
403 newchars[str->arr_len] = 0;
407 .chars_is_owned = true
412 jstring CS_LDK_get_ldk_c_bindings_version() {
413 return str_ref_to_cs(check_get_ldk_bindings_version(), strlen(check_get_ldk_bindings_version()));
415 jstring CS_LDK_get_ldk_version() {
416 return str_ref_to_cs(check_get_ldk_version(), strlen(check_get_ldk_version()));
420 self.c_version_file = """const char* CS_LDK_get_lib_version_string() {
421 return "<git_version_ldk_garbagecollected>";
424 self.hu_struct_file_prefix = """using org.ldk.impl;
429 namespace org { namespace ldk { namespace structs {
432 self.hu_struct_file_suffix = "} } }\n"
433 self.c_fn_args_pfx = ""
434 self.c_fn_ty_pfx = ""
435 self.file_ext = ".cs"
436 self.ptr_c_ty = "int64_t"
437 self.ptr_native_ty = "long"
438 self.u128_native_ty = "UInt128"
439 self.usize_c_ty = "int64_t"
440 self.usize_native_ty = "long"
441 self.native_zero_ptr = "0"
442 self.result_c_ty = "jclass"
443 self.ptr_arr = "jobjectArray"
444 self.is_arr_some_check = ("", " != NULL")
445 self.get_native_arr_len_call = ("(*env)->GetArrayLength(env, ", ")")
447 self.bindings_footer_wip = "\tstatic bindings() {\n"
448 def bindings_footer(self):
449 return self.bindings_footer_wip + "\t}\n}\n} } }\n"
451 def native_meth_decl(self, meth_name, ret_ty_str):
452 return "\t[DllImport (\"ldkcsharp\", EntryPoint=\"CS_LDK_" + meth_name + "\")] public static extern " + ret_ty_str + " " + meth_name
454 def c_fn_name_define_pfx(self, fn_name, have_args):
455 return " CS_LDK_" + fn_name + "("
457 def construct_jenv(self):
458 res = "JNIEnv *env;\n"
459 res += "jint get_jenv_res = (*j_calls->vm)->GetEnv(j_calls->vm, (void**)&env, JNI_VERSION_1_6);\n"
460 res += "if (get_jenv_res == JNI_EDETACHED) {\n"
461 res += "\tDO_ASSERT((*j_calls->vm)->AttachCurrentThread(j_calls->vm, (void**)&env, NULL) == JNI_OK);\n"
463 res += "\tDO_ASSERT(get_jenv_res == JNI_OK);\n"
466 def deconstruct_jenv(self):
467 res = "if (get_jenv_res == JNI_EDETACHED) {\n"
468 res += "\tDO_ASSERT((*j_calls->vm)->DetachCurrentThread(j_calls->vm) == JNI_OK);\n"
472 def release_native_arr_ptr_call(self, ty_info, arr_var, arr_ptr_var):
474 def create_native_arr_call(self, arr_len, ty_info):
475 if ty_info.c_ty == "ptrArray":
476 assert ty_info.rust_obj == "LDKCVec_U5Z" or (ty_info.subty is not None and (ty_info.subty.c_ty.endswith("Array") or ty_info.subty.rust_obj == "LDKStr"))
477 return "init_" + ty_info.c_ty + "(" + arr_len + ", __LINE__)"
478 def set_native_arr_contents(self, arr_name, arr_len, ty_info):
479 if ty_info.c_ty == "int8_tArray":
480 return ("memcpy(" + arr_name + "->elems, ", ", " + arr_len + ")")
481 elif ty_info.c_ty == "int16_tArray":
482 return ("memcpy(" + arr_name + "->elems, ", ", " + arr_len + " * 2)")
485 def get_native_arr_contents(self, arr_name, dest_name, arr_len, ty_info, copy):
486 if ty_info.c_ty == "int8_tArray" or ty_info.c_ty == "int16_tArray":
489 if ty_info.c_ty == "int16_tArray":
490 byte_len = arr_len + " * 2"
491 return "memcpy(" + dest_name + ", " + arr_name + "->elems, " + byte_len + "); FREE(" + arr_name + ")"
493 if ty_info.c_ty == "ptrArray":
494 return "(void*) " + arr_name + "->elems"
496 return arr_name + "->elems"
497 def get_native_arr_elem(self, arr_name, idxc, ty_info):
498 assert False # Only called if above is None
499 def get_native_arr_ptr_call(self, ty_info):
500 if ty_info.subty is not None:
501 return "(" + ty_info.subty.c_ty + "*)(((uint8_t*)", ") + 8)"
502 return "(" + ty_info.c_ty + "*)(((uint8_t*)", ") + 8)"
503 def get_native_arr_entry_call(self, ty_info, arr_name, idxc, entry_access):
505 def cleanup_native_arr_ref_contents(self, arr_name, dest_name, arr_len, ty_info):
506 if ty_info.c_ty == "int8_tArray":
507 return "FREE(" + arr_name + ");"
509 return "FREE(" + arr_name + ")"
511 def map_hu_array_elems(self, arr_name, conv_name, arr_ty, elem_ty):
512 if elem_ty.java_hu_ty == "UInt5":
513 return arr_name + " != null ? InternalUtils.convUInt5Array(" + arr_name + ") : null"
514 elif elem_ty.java_hu_ty == "WitnessVersion":
515 return arr_name + " != null ? InternalUtils.convWitnessVersionArray(" + arr_name + ") : null"
517 return arr_name + " != null ? InternalUtils.mapArray(" + arr_name + ", " + conv_name + " => " + elem_ty.from_hu_conv[0] + ") : null"
519 def str_ref_to_native_call(self, var_name, str_len):
520 return "str_ref_to_cs(" + var_name + ", " + str_len + ")"
521 def str_ref_to_c_call(self, var_name):
522 return "str_ref_to_owned_c(" + var_name + ")"
523 def str_to_hu_conv(self, var_name):
525 def str_from_hu_conv(self, var_name):
531 def var_decl_statement(self, ty_string, var_name, statement):
532 return ty_string + " " + var_name + " = " + statement
534 def get_java_arr_len(self, arr_name):
535 return arr_name + ".Length"
536 def get_java_arr_elem(self, elem_ty, arr_name, idx):
537 return arr_name + "[" + idx + "]"
538 def constr_hu_array(self, ty_info, arr_len):
539 base_ty = ty_info.subty.java_hu_ty.split("[")[0].split("<")[0]
540 conv = "new " + base_ty + "[" + arr_len + "]"
541 if "[" in ty_info.subty.java_hu_ty.split("<")[0]:
542 # Do a bit of a dance to move any excess [] to the end
543 conv += "[" + ty_info.subty.java_hu_ty.split("<")[0].split("[")[1]
545 def cleanup_converted_native_array(self, ty_info, arr_name):
548 def primitive_arr_from_hu(self, arr_ty, fixed_len, arr_name):
549 mapped_ty = arr_ty.subty
550 if arr_ty.rust_obj == "LDKU128":
551 return ("" + arr_name + ".getLEBytes()", "")
552 if fixed_len is not None:
553 return ("InternalUtils.check_arr_len(" + arr_name + ", " + fixed_len + ")", "")
555 def primitive_arr_to_hu(self, arr_ty, fixed_len, arr_name, conv_name):
556 if arr_ty.rust_obj == "LDKU128":
557 return "org.ldk.util.UInt128 " + conv_name + " = new org.ldk.util.UInt128(" + arr_name + ");"
560 def java_arr_ty_str(self, elem_ty_str):
561 return elem_ty_str + "[]"
563 def for_n_in_range(self, n, minimum, maximum):
564 return "for (int " + n + " = " + minimum + "; " + n + " < " + maximum + "; " + n + "++) {"
565 def for_n_in_arr(self, n, arr_name, arr_elem_ty):
566 return ("foreach (" + arr_elem_ty.java_hu_ty + " " + n + " in " + arr_name + ") { ", " }")
568 def get_ptr(self, var):
570 def set_null_skip_free(self, var):
571 return var + ".ptr" + " = 0;"
573 def add_ref(self, holder, referent):
574 return "if (" + holder + " != null) { " + holder + ".ptrs_to.AddLast(" + referent + "); }"
576 def fully_qualified_hu_ty_path(self, ty):
577 if ty.java_fn_ty_arg.startswith("L") and ty.java_fn_ty_arg.endswith(";"):
579 if ty.java_hu_ty == "UnqualifiedError" or ty.java_hu_ty == "UInt128" or ty.java_hu_ty == "UInt5" or ty.java_hu_ty == "WitnessVersion":
580 return "org.ldk.util." + ty.java_hu_ty
581 if not ty.is_native_primitive and ty.rust_obj is not None and not "[]" in ty.java_hu_ty:
582 return "org.ldk.structs." + ty.java_hu_ty
585 def native_c_unitary_enum_map(self, struct_name, variants, enum_doc_comment):
586 out_java_enum = "namespace org { namespace ldk { namespace enums {"
590 out_c = "static inline LDK" + struct_name + " LDK" + struct_name + "_from_cs(int32_t ord) {\n"
591 out_c += "\tswitch (ord) {\n"
593 if enum_doc_comment is not None:
594 out_java_enum += "/**\n * " + enum_doc_comment.replace("\n", "\n * ") + "\n */\n"
595 out_java_enum += "public enum " + struct_name + " {\n"
597 for var, var_docs in variants:
598 if var_docs is not None:
599 out_java_enum += "\t/**\n\t * " + var_docs.replace("\n", "\n\t * ") + "\n\t */\n"
600 out_java_enum += "\t" + var + ",\n"
601 out_c = out_c + "\t\tcase %d: return %s;\n" % (ord_v, var)
604 out_c += "\t\tdefault: abort();\n"
608 out_c = out_c + "static inline int32_t LDK" + struct_name + "_to_cs(LDK" + struct_name + " val) {\n"
609 out_c = out_c + "\tswitch (val) {\n"
611 for var, _ in variants:
612 out_c = out_c + "\t\tcase " + var + ": return %d;\n" % ord_v
614 out_c = out_c + "\t\tdefault: abort();\n"
615 out_c = out_c + "\t}\n"
616 out_c = out_c + "}\n"
618 return (out_c, out_java_enum + "} } }\n", out_java)
620 def c_unitary_enum_to_native_call(self, ty_info):
621 return (ty_info.rust_obj + "_to_cs(", ")")
622 def native_unitary_enum_to_c_call(self, ty_info):
623 return (ty_info.rust_obj + "_from_cs(", ")")
625 def c_complex_enum_pfx(self, struct_name, variants, init_meth_jty_strs):
628 out_c = out_c + "static jclass " + struct_name + "_" + var + "_class = NULL;\n"
629 out_c = out_c + "static jmethodID " + struct_name + "_" + var + "_meth = NULL;\n"
630 out_c += "void" + self.c_fn_name_define_pfx(struct_name.replace("_", "_1") + "_init", True) + self.c_fn_args_pfx + ") {\n"
631 for var_name in variants:
632 out_c += "\t" + struct_name + "_" + var_name + "_class =\n"
633 out_c += "\t\t(*env)->NewGlobalRef(env, (*env)->FindClass(env, \"org/ldk/impl/bindings$" + struct_name + "$" + var_name + "\"));\n"
634 out_c += "\tCHECK(" + struct_name + "_" + var_name + "_class != NULL);\n"
635 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"
636 out_c += "\tCHECK(" + struct_name + "_" + var_name + "_meth != NULL);\n"
637 out_c = out_c + "}\n"
640 def c_complex_enum_pass_ty(self, struct_name):
643 def c_constr_native_complex_enum(self, struct_name, variant, c_params):
644 ret = "(*env)->NewObject(env, " + struct_name + "_" + variant + "_class, " + struct_name + "_" + variant + "_meth"
645 for param in c_params:
646 ret = ret + ", " + param
649 def native_c_map_trait(self, struct_name, field_vars, flattened_field_vars, field_fns, trait_doc_comment):
653 # First generate most of the Java code, note that we need information about java method argument strings for C
654 out_java_trait += self.hu_struct_file_prefix
655 if trait_doc_comment is not None:
656 out_java_trait += "/**\n * " + trait_doc_comment.replace("\n", "\n * ") + "\n */\n"
657 out_java_trait = out_java_trait + "public class " + struct_name.replace("LDK","") + " : CommonBase {\n"
658 out_java_trait = out_java_trait + "\tinternal readonly bindings." + struct_name + " bindings_instance;\n"
659 out_java_trait = out_java_trait + "\tinternal " + struct_name.replace("LDK", "") + "(object _dummy, long ptr) : base(ptr) { bindings_instance = null; }\n"
660 out_java_trait = out_java_trait + "\tprivate " + struct_name.replace("LDK", "") + "(bindings." + struct_name + " arg"
661 for var in flattened_field_vars:
662 if isinstance(var, ConvInfo):
663 out_java_trait += ", " + var.java_hu_ty + " " + var.arg_name
665 out_java_trait += ", bindings." + var[0] + " " + var[1]
666 out_java_trait += ") : base(bindings." + struct_name + "_new(arg"
667 for var in flattened_field_vars:
668 if isinstance(var, ConvInfo):
669 if var.from_hu_conv is not None:
670 out_java_trait = out_java_trait + ", " + var.from_hu_conv[0]
672 out_java_trait = out_java_trait + ", " + var.arg_name
674 out_java_trait = out_java_trait + ", " + var[1]
675 out_java_trait = out_java_trait + ")) {\n"
676 out_java_trait = out_java_trait + "\t\tthis.ptrs_to.AddLast(arg);\n"
677 for var in flattened_field_vars:
678 if isinstance(var, ConvInfo):
679 if var.from_hu_conv is not None and var.from_hu_conv[1] != "":
680 out_java_trait = out_java_trait + "\t\t" + var.from_hu_conv[1].replace("\n", "\n\t\t") + ";\n"
682 out_java_trait = out_java_trait + "\t\tthis.ptrs_to.AddLast(" + var[1] + ");\n"
683 out_java_trait = out_java_trait + "\t\tthis.bindings_instance = arg;\n"
684 out_java_trait = out_java_trait + "\t}\n"
685 out_java_trait = out_java_trait + "\t~" + struct_name.replace("LDK","") + "() {\n"
686 out_java_trait = out_java_trait + "\t\tif (ptr != 0) { bindings." + struct_name.replace("LDK","") + "_free(ptr); }\n"
687 out_java_trait = out_java_trait + "\t}\n\n"
689 java_trait_wrapper = "\tprivate class " + struct_name + "Holder { internal " + struct_name.replace("LDK", "") + " held; }\n"
690 java_trait_wrapper += "\tprivate class " + struct_name + "Impl : bindings." + struct_name + " {\n"
691 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"
692 java_trait_wrapper += "\t\tprivate " + struct_name.replace("LDK", "") + "Interface arg;\n"
693 java_trait_wrapper += "\t\tprivate " + struct_name + "Holder impl_holder;\n"
694 java_trait_constr = "\tpublic static " + struct_name.replace("LDK", "") + " new_impl(" + struct_name.replace("LDK", "") + "Interface arg"
695 for var in flattened_field_vars:
696 if isinstance(var, ConvInfo):
697 java_trait_constr += ", " + var.java_hu_ty + " " + var.arg_name
699 # Ideally we'd be able to take any instance of the interface, but our C code can only represent
700 # Java-implemented version, so we require users pass a Java implementation here :/
701 java_trait_constr += ", " + var[0].replace("LDK", "") + "." + var[0].replace("LDK", "") + "Interface " + var[1] + "_impl"
702 java_trait_constr = java_trait_constr + ") {\n\t\t" + struct_name + "Holder impl_holder = new " + struct_name + "Holder();\n"
703 java_trait_constr = java_trait_constr + "\t\timpl_holder.held = new " + struct_name.replace("LDK", "") + "(new " + struct_name + "Impl(arg, impl_holder)"
704 out_java_trait += "\tpublic interface " + struct_name.replace("LDK", "") + "Interface {\n"
705 out_java += "\tpublic interface " + struct_name + " {\n"
707 for fn_line in field_fns:
708 java_meth_descr = "("
709 if fn_line.fn_name != "free" and fn_line.fn_name != "cloned":
710 fn_name = fn_line.fn_name
711 if fn_name == "lock": # reserved symbol
713 out_java += "\t\t" + fn_line.ret_ty_info.java_ty + " " + fn_name + "("
714 java_trait_wrapper += "\t\tpublic " + fn_line.ret_ty_info.java_ty + " " + fn_name + "("
715 out_java_trait += "\t\t/**\n\t\t * " + fn_line.docs.replace("\n", "\n\t\t * ") + "\n\t\t */\n"
716 out_java_trait += "\t\t" + fn_line.ret_ty_info.java_hu_ty + " " + fn_name + "("
718 for idx, arg_conv_info in enumerate(fn_line.args_ty):
721 java_trait_wrapper += ", "
722 out_java_trait += ", "
723 out_java += arg_conv_info.java_ty + " _" + arg_conv_info.arg_name
724 out_java_trait += arg_conv_info.java_hu_ty + " _" + arg_conv_info.arg_name
725 java_trait_wrapper += arg_conv_info.java_ty + " _" + arg_conv_info.arg_name
726 java_meth_descr = java_meth_descr + arg_conv_info.java_fn_ty_arg
727 java_meth_descr = java_meth_descr + ")" + fn_line.ret_ty_info.java_fn_ty_arg
728 java_meths.append((fn_line.fn_name, java_meth_descr))
731 out_java_trait += ");\n"
732 java_trait_wrapper += ") {\n"
734 for arg_info in fn_line.args_ty:
735 if arg_info.to_hu_conv is not None:
736 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"
738 if fn_line.ret_ty_info.java_ty != "void":
739 java_trait_wrapper += "\t\t\t" + fn_line.ret_ty_info.java_hu_ty + " ret = arg." + fn_name + "("
741 java_trait_wrapper += "\t\t\targ." + fn_name + "("
743 for idx, arg_info in enumerate(fn_line.args_ty):
745 java_trait_wrapper += ", "
746 if arg_info.to_hu_conv_name is not None:
747 java_trait_wrapper += arg_info.to_hu_conv_name.replace(arg_info.arg_name, "_" + arg_info.arg_name)
749 java_trait_wrapper += "_" + arg_info.arg_name
751 java_trait_wrapper += ");\n"
752 java_trait_wrapper += "\t\t\t\tGC.KeepAlive(arg);\n"
753 if fn_line.ret_ty_info.java_ty != "void":
754 if fn_line.ret_ty_info.from_hu_conv is not None:
755 java_trait_wrapper += "\t\t\t" + fn_line.ret_ty_info.java_ty + " result = " + fn_line.ret_ty_info.from_hu_conv[0] + ";\n"
756 if fn_line.ret_ty_info.from_hu_conv[1] != "":
757 java_trait_wrapper += "\t\t\t" + fn_line.ret_ty_info.from_hu_conv[1].replace("this", "impl_holder.held") + ";\n"
758 java_trait_wrapper += "\t\t\treturn result;\n"
760 java_trait_wrapper += "\t\t\treturn ret;\n"
761 java_trait_wrapper += "\t\t}\n"
762 java_trait_wrapper += "\t}"
763 for var in field_vars:
764 if isinstance(var, ConvInfo):
765 java_trait_constr = java_trait_constr + ", " + var.arg_name
767 java_trait_constr += ", " + var[1] + ".new_impl(" + var[1] + "_impl"
769 for suparg in var[2]:
770 if isinstance(suparg, ConvInfo):
771 suptrait_constr += ", " + suparg.arg_name
773 suptrait_constr += ", " + suparg[1] + "_impl"
774 java_trait_constr += suptrait_constr + ").bindings_instance"
775 for suparg in var[2]:
776 if isinstance(suparg, ConvInfo):
777 java_trait_constr += ", " + suparg.arg_name
779 java_trait_constr += ", " + suparg[1] + ".new_impl("
780 # Blindly assume that we can just strip the first arg to build the args for the supertrait
781 java_trait_constr += suptrait_constr.split(", ", 1)[1]
782 java_trait_constr += ").bindings_instance"
783 out_java_trait += "\t}\n" + java_trait_wrapper + "\n"
784 out_java_trait += java_trait_constr + ");\n\t\treturn impl_holder.held;\n\t}\n"
788 out_java += self.native_meth_decl(struct_name + "_new", "long") + "(" + struct_name + " impl"
789 for var in flattened_field_vars:
790 if isinstance(var, ConvInfo):
791 out_java += ", " + var.java_ty + " " + var.arg_name
793 out_java += ", " + var[0] + " " + var[1]
796 # Now that we've written out our java code (and created java_meths), generate C
797 out_c = "typedef struct " + struct_name + "_JCalls {\n"
798 out_c = out_c + "\tatomic_size_t refcnt;\n"
799 out_c = out_c + "\tJavaVM *vm;\n"
800 out_c = out_c + "\tjweak o;\n"
801 for var in flattened_field_vars:
802 if isinstance(var, ConvInfo):
803 # We're a regular ol' field
807 out_c = out_c + "\t" + var[0] + "_JCalls* " + var[1] + ";\n"
809 if fn.fn_name != "free" and fn.fn_name != "cloned":
810 out_c = out_c + "\tjmethodID " + fn.fn_name + "_meth;\n"
811 out_c = out_c + "} " + struct_name + "_JCalls;\n"
813 for fn_line in field_fns:
814 if fn_line.fn_name == "free":
815 out_c = out_c + "static void " + struct_name + "_JCalls_free(void* this_arg) {\n"
816 out_c = out_c + "\t" + struct_name + "_JCalls *j_calls = (" + struct_name + "_JCalls*) this_arg;\n"
817 out_c = out_c + "\tif (atomic_fetch_sub_explicit(&j_calls->refcnt, 1, memory_order_acquire) == 1) {\n"
818 out_c += "\t\t" + self.construct_jenv().replace("\n", "\n\t\t").strip() + "\n"
819 out_c = out_c + "\t\t(*env)->DeleteWeakGlobalRef(env, j_calls->o);\n"
820 out_c += "\t\t" + self.deconstruct_jenv().replace("\n", "\n\t\t").strip() + "\n"
821 out_c = out_c + "\t\tFREE(j_calls);\n"
822 out_c = out_c + "\t}\n}\n"
824 for idx, fn_line in enumerate(field_fns):
825 if fn_line.fn_name != "free" and fn_line.fn_name != "cloned":
826 assert fn_line.ret_ty_info.ty_info.get_full_rust_ty()[1] == ""
827 out_c = out_c + fn_line.ret_ty_info.ty_info.get_full_rust_ty()[0] + " " + fn_line.fn_name + "_" + struct_name + "_jcall("
828 if fn_line.self_is_const:
829 out_c = out_c + "const void* this_arg"
831 out_c = out_c + "void* this_arg"
833 for idx, arg in enumerate(fn_line.args_ty):
834 out_c = out_c + ", " + arg.ty_info.get_full_rust_ty()[0] + " " + arg.arg_name + arg.ty_info.get_full_rust_ty()[1]
836 out_c = out_c + ") {\n"
837 out_c = out_c + "\t" + struct_name + "_JCalls *j_calls = (" + struct_name + "_JCalls*) this_arg;\n"
838 out_c += "\t" + self.construct_jenv().replace("\n", "\n\t").strip() + "\n"
840 for arg_info in fn_line.args_ty:
841 if arg_info.ret_conv is not None:
842 out_c = out_c + "\t" + arg_info.ret_conv[0].replace('\n', '\n\t')
843 out_c = out_c + arg_info.arg_name
844 out_c = out_c + arg_info.ret_conv[1].replace('\n', '\n\t') + "\n"
846 out_c = out_c + "\tjobject obj = (*env)->NewLocalRef(env, j_calls->o);\n\tCHECK(obj != NULL);\n"
847 if fn_line.ret_ty_info.c_ty.endswith("Array"):
848 out_c = out_c + "\t" + fn_line.ret_ty_info.c_ty + " ret = (*env)->CallObjectMethod(env, obj, j_calls->" + fn_line.fn_name + "_meth"
849 elif fn_line.ret_ty_info.c_ty == "void":
850 out_c += "\t(*env)->CallVoidMethod(env, obj, j_calls->" + fn_line.fn_name + "_meth"
851 elif fn_line.ret_ty_info.java_hu_ty == "string" or "org/ldk/enums" in fn_line.ret_ty_info.java_fn_ty_arg:
852 # Manually write out string methods as they're just an Object
853 out_c += "\t" + fn_line.ret_ty_info.c_ty + " ret = (*env)->CallObjectMethod(env, obj, j_calls->" + fn_line.fn_name + "_meth"
854 elif not fn_line.ret_ty_info.passed_as_ptr:
855 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"
857 out_c = out_c + "\tuint64_t ret = (*env)->CallLongMethod(env, obj, j_calls->" + fn_line.fn_name + "_meth"
859 for idx, arg_info in enumerate(fn_line.args_ty):
860 if arg_info.ret_conv is not None:
861 out_c = out_c + ", " + arg_info.ret_conv_name
863 out_c = out_c + ", " + arg_info.arg_name
864 out_c = out_c + ");\n"
866 out_c += "\tif (UNLIKELY((*env)->ExceptionCheck(env))) {\n"
867 out_c += "\t\t(*env)->ExceptionDescribe(env);\n"
868 out_c += "\t\t(*env)->FatalError(env, \"A call to " + fn_line.fn_name + " in " + struct_name + " from rust threw an exception.\");\n"
871 if fn_line.ret_ty_info.arg_conv is not None:
872 out_c += "\t" + fn_line.ret_ty_info.arg_conv.replace("\n", "\n\t") + "\n"
873 out_c += "\t" + self.deconstruct_jenv().replace("\n", "\n\t").strip() + "\n"
874 out_c += "\treturn " + fn_line.ret_ty_info.arg_conv_name + ";\n"
876 out_c += "\t" + self.deconstruct_jenv().replace("\n", "\n\t").strip() + "\n"
877 if not fn_line.ret_ty_info.passed_as_ptr and fn_line.ret_ty_info.c_ty != "void":
878 out_c += "\treturn ret;\n"
880 out_c = out_c + "}\n"
882 # If we can, write out a clone function whether we need one or not, as we use them in moving to rust
883 can_clone_with_ptr = True
884 for var in field_vars:
885 if isinstance(var, ConvInfo):
886 can_clone_with_ptr = False
887 if can_clone_with_ptr:
888 out_c = out_c + "static void " + struct_name + "_JCalls_cloned(" + struct_name + "* new_obj) {\n"
889 out_c = out_c + "\t" + struct_name + "_JCalls *j_calls = (" + struct_name + "_JCalls*) new_obj->this_arg;\n"
890 out_c = out_c + "\tatomic_fetch_add_explicit(&j_calls->refcnt, 1, memory_order_release);\n"
891 for var in field_vars:
892 if not isinstance(var, ConvInfo):
893 out_c = out_c + "\tatomic_fetch_add_explicit(&j_calls->" + var[1] + "->refcnt, 1, memory_order_release);\n"
894 out_c = out_c + "}\n"
896 out_c = out_c + "static inline " + struct_name + " " + struct_name + "_init (" + self.c_fn_args_pfx + ", jobject o"
897 for var in flattened_field_vars:
898 if isinstance(var, ConvInfo):
899 out_c = out_c + ", " + var.c_ty + " " + var.arg_name
901 out_c = out_c + ", jobject " + var[1]
902 out_c = out_c + ") {\n"
904 out_c = out_c + "\tjclass c = (*env)->GetObjectClass(env, o);\n"
905 out_c = out_c + "\tCHECK(c != NULL);\n"
906 out_c = out_c + "\t" + struct_name + "_JCalls *calls = MALLOC(sizeof(" + struct_name + "_JCalls), \"" + struct_name + "_JCalls\");\n"
907 out_c = out_c + "\tatomic_init(&calls->refcnt, 1);\n"
908 out_c = out_c + "\tDO_ASSERT((*env)->GetJavaVM(env, &calls->vm) == 0);\n"
909 out_c = out_c + "\tcalls->o = (*env)->NewWeakGlobalRef(env, o);\n"
911 for (fn_name, java_meth_descr) in java_meths:
912 if fn_name != "free" and fn_name != "cloned":
913 out_c = out_c + "\tcalls->" + fn_name + "_meth = (*env)->GetMethodID(env, c, \"" + fn_name + "\", \"" + java_meth_descr + "\");\n"
914 out_c = out_c + "\tCHECK(calls->" + fn_name + "_meth != NULL);\n"
916 for var in flattened_field_vars:
917 if isinstance(var, ConvInfo) and var.arg_conv is not None:
918 out_c = out_c + "\n\t" + var.arg_conv.replace("\n", "\n\t") +"\n"
919 out_c = out_c + "\n\t" + struct_name + " ret = {\n"
920 out_c = out_c + "\t\t.this_arg = (void*) calls,\n"
921 for fn_line in field_fns:
922 if fn_line.fn_name != "free" and fn_line.fn_name != "cloned":
923 out_c = out_c + "\t\t." + fn_line.fn_name + " = " + fn_line.fn_name + "_" + struct_name + "_jcall,\n"
924 elif fn_line.fn_name == "free":
925 out_c = out_c + "\t\t.free = " + struct_name + "_JCalls_free,\n"
927 out_c = out_c + "\t\t.cloned = " + struct_name + "_JCalls_cloned,\n"
928 for var in field_vars:
929 if isinstance(var, ConvInfo):
930 if var.arg_conv_name is not None:
931 out_c = out_c + "\t\t." + var.arg_name + " = " + var.arg_conv_name + ",\n"
932 out_c = out_c + "\t\t.set_" + var.arg_name + " = NULL,\n"
934 out_c = out_c + "\t\t." + var.var_name + " = " + var.var_name + ",\n"
935 out_c = out_c + "\t\t.set_" + var.var_name + " = NULL,\n"
937 out_c += "\t\t." + var[1] + " = " + var[0] + "_init(env, clz, " + var[1]
938 for suparg in var[2]:
939 if isinstance(suparg, ConvInfo):
940 out_c = out_c + ", " + suparg.arg_name
942 out_c = out_c + ", " + suparg[1]
944 out_c = out_c + "\t};\n"
945 for var in flattened_field_vars:
946 if not isinstance(var, ConvInfo):
947 out_c = out_c + "\tcalls->" + var[1] + " = ret." + var[1] + ".this_arg;\n"
948 out_c = out_c + "\treturn ret;\n"
949 out_c = out_c + "}\n"
951 out_c += "int64_t " + self.c_fn_name_define_pfx(struct_name + "_new", True) + "jobject o"
952 for var in flattened_field_vars:
953 if isinstance(var, ConvInfo):
954 out_c = out_c + ", " + var.c_ty + " " + var.arg_name
956 out_c = out_c + ", jobject " + var[1]
957 out_c = out_c + ") {\n"
958 out_c = out_c + "\t" + struct_name + " *res_ptr = MALLOC(sizeof(" + struct_name + "), \"" + struct_name + "\");\n"
959 out_c = out_c + "\t*res_ptr = " + struct_name + "_init(env, clz, o"
960 for var in flattened_field_vars:
961 if isinstance(var, ConvInfo):
962 out_c = out_c + ", " + var.arg_name
964 out_c = out_c + ", " + var[1]
965 out_c = out_c + ");\n"
966 out_c = out_c + "\treturn tag_ptr(res_ptr, true);\n"
967 out_c = out_c + "}\n"
969 for var in flattened_field_vars:
970 if not isinstance(var, ConvInfo):
971 out_java_trait += "\n\t/**\n"
972 out_java_trait += "\t * Gets the underlying " + var[1] + ".\n"
973 out_java_trait += "\t */\n"
974 underscore_name = ''.join('_' + c.lower() if c.isupper() else c for c in var[1]).strip('_')
975 out_java_trait += "\tpublic " + var[1] + " get_" + underscore_name + "() {\n"
976 out_java_trait += "\t\t" + var[1] + " res = new " + var[1] + "(null, bindings." + struct_name + "_get_" + var[1] + "(this.ptr));\n"
977 out_java_trait += "\t\tthis.ptrs_to.AddLast(res);\n"
978 out_java_trait += "\t\treturn res;\n"
979 out_java_trait += "\t}\n"
980 out_java_trait += "\n"
982 out_java += self.native_meth_decl(struct_name + "_get_" + var[1], "long") + "(long arg);\n"
984 out_c += "int64_t " + self.c_fn_name_define_pfx(struct_name + "_get_" + var[1], True) + "int64_t arg) {\n"
985 out_c += "\t" + struct_name + " *inp = (" + struct_name + " *)untag_ptr(arg);\n"
986 out_c += "\treturn tag_ptr(&inp->" + var[1] + ", false);\n"
989 return (out_java, out_java_trait, out_c)
991 def trait_struct_inc_refcnt(self, ty_info):
992 base_conv = "\nif (" + ty_info.var_name + "_conv.free == " + ty_info.rust_obj + "_JCalls_free) {\n"
993 base_conv = base_conv + "\t// If this_arg is a JCalls struct, then we need to increment the refcnt in it.\n"
994 base_conv = base_conv + "\t" + ty_info.rust_obj + "_JCalls_cloned(&" + ty_info.var_name + "_conv);\n}"
997 def map_complex_enum(self, struct_name, variant_list, camel_to_snake, enum_doc_comment):
998 bindings_type = struct_name.replace("LDK", "")
999 java_hu_type = struct_name.replace("LDK", "").replace("COption", "Option")
1005 out_java_enum += (self.hu_struct_file_prefix)
1007 java_hu_class = "/**\n * " + enum_doc_comment.replace("\n", "\n * ") + "\n */\n"
1008 java_hu_class += "public class " + java_hu_type + " : CommonBase {\n"
1009 java_hu_class += f"\tprotected {java_hu_type}(object _dummy, long ptr) : base(ptr)" + " { }\n"
1010 java_hu_class += "\t~" + java_hu_type + "() {\n"
1011 java_hu_class += "\t\tif (ptr != 0) { bindings." + bindings_type + "_free(ptr); }\n"
1012 java_hu_class += "\t}\n\n"
1013 java_hu_class += f"\tinternal static {java_hu_type} constr_from_ptr(long ptr) {{\n"
1014 java_hu_class += f"\t\tlong raw_ty = bindings." + struct_name + "_ty_from_ptr(ptr);\n"
1015 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"
1016 out_c += "\t" + struct_name + " *obj = (" + struct_name + "*)untag_ptr(ptr);\n"
1017 out_c += "\tswitch(obj->tag) {\n"
1018 java_hu_class += "\t\tswitch (raw_ty) {\n"
1019 java_hu_subclasses = ""
1022 for var in variant_list:
1023 java_hu_subclasses += "\t/** A " + java_hu_type + " of type " + var.var_name + " */\n"
1024 java_hu_subclasses += "\tpublic class " + java_hu_type + "_" + var.var_name + " : " + java_hu_type + " {\n"
1025 java_hu_class += f"\t\t\tcase {var_idx}: "
1026 java_hu_class += "return new " + java_hu_type + "_" + var.var_name + "(ptr);\n"
1027 out_c += f"\t\tcase {struct_name}_{var.var_name}: return {var_idx};\n"
1029 for idx, (field_ty, field_docs) in enumerate(var.fields):
1030 if field_docs is not None:
1031 java_hu_subclasses += "\t\t/**\n\t\t * " + field_docs.replace("\n", "\n\t\t * ") + "\n\t\t */\n"
1032 java_hu_subclasses += f"\t\tpublic {field_ty.java_hu_ty} {field_ty.arg_name};\n"
1033 if field_ty.to_hu_conv is not None:
1034 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"
1035 hu_conv_body += f"\t\t\t" + field_ty.to_hu_conv.replace("\n", "\n\t\t\t") + "\n"
1036 hu_conv_body += f"\t\t\tthis." + field_ty.arg_name + " = " + field_ty.to_hu_conv_name + ";\n"
1038 hu_conv_body += f"\t\t\tthis.{field_ty.arg_name} = bindings.{struct_name}_{var.var_name}_get_{field_ty.arg_name}(ptr);\n"
1039 java_hu_subclasses += "\t\tinternal " + java_hu_type + "_" + var.var_name + "(long ptr) : base(null, ptr) {\n"
1040 java_hu_subclasses += hu_conv_body
1041 java_hu_subclasses += "\t\t}\n\t}\n"
1043 java_hu_class += "\t\t\tdefault:\n\t\t\t\tthrow new ArgumentException(\"Impossible enum variant\");\n\t\t}\n\t}\n\n"
1044 out_java += self.native_meth_decl(struct_name + "_ty_from_ptr", "long") + "(long ptr);\n"
1045 out_c += ("\t\tdefault: abort();\n")
1046 out_c += ("\t}\n}\n")
1048 for var in variant_list:
1049 for idx, (field_map, _) in enumerate(var.fields):
1050 fn_name = f"{struct_name}_{var.var_name}_get_{field_map.arg_name}"
1051 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"
1052 out_c += "\t" + struct_name + " *obj = (" + struct_name + "*)untag_ptr(ptr);\n"
1053 out_c += f"\tassert(obj->tag == {struct_name}_{var.var_name});\n"
1054 if field_map.ret_conv is not None:
1055 out_c += ("\t\t\t" + field_map.ret_conv[0].replace("\n", "\n\t\t\t"))
1056 if var.tuple_variant:
1057 out_c += "obj->" + camel_to_snake(var.var_name)
1059 out_c += "obj->" + camel_to_snake(var.var_name) + "." + field_map.arg_name
1060 out_c += (field_map.ret_conv[1].replace("\n", "\n\t\t\t") + "\n")
1061 out_c += "\treturn " + field_map.ret_conv_name + ";\n"
1063 if var.tuple_variant:
1064 out_c += "\treturn " + "obj->" + camel_to_snake(var.var_name) + ";\n"
1066 out_c += "\treturn " + "obj->" + camel_to_snake(var.var_name) + "." + field_map.arg_name + ";\n"
1068 out_java += self.native_meth_decl(fn_name, field_map.java_ty) + "(long ptr);\n"
1069 out_java_enum += java_hu_class
1070 out_java_enum += java_hu_subclasses
1071 return (out_java, out_java_enum, out_c)
1073 def map_opaque_struct(self, struct_name, struct_doc_comment):
1074 out_opaque_struct_human = ""
1075 out_opaque_struct_human += self.hu_struct_file_prefix
1076 out_opaque_struct_human += "\n/**\n * " + struct_doc_comment.replace("\n", "\n * ") + "\n */\n"
1077 hu_name = struct_name.replace("LDKC2Tuple", "TwoTuple").replace("LDKC3Tuple", "ThreeTuple").replace("LDK", "")
1078 out_opaque_struct_human += ("public class " + hu_name + " : CommonBase")
1079 if struct_name.startswith("LDKLocked") or struct_name.startswith("LDKReadOnly"):
1080 out_opaque_struct_human += (", IDisposable")
1081 out_opaque_struct_human += (" {\n")
1082 out_opaque_struct_human += ("\tinternal " + hu_name + "(object _dummy, long ptr) : base(ptr) { }\n")
1083 if struct_name.startswith("LDKLocked") or struct_name.startswith("LDKReadOnly"):
1084 out_opaque_struct_human += ("\tpublic void Dispose() {\n")
1086 out_opaque_struct_human += ("\t~" + hu_name + "() {\n")
1087 out_opaque_struct_human += ("\t\tif (ptr != 0) { bindings." + struct_name.replace("LDK","") + "_free(ptr); }\n")
1088 out_opaque_struct_human += ("\t}\n\n")
1089 return out_opaque_struct_human
1091 def map_tuple(self, struct_name):
1092 return self.map_opaque_struct(struct_name, "A Tuple")
1094 def map_result(self, struct_name, res_map, err_map):
1095 human_ty = struct_name.replace("LDKCResult", "Result")
1097 java_hu_struct += self.hu_struct_file_prefix
1098 java_hu_struct += "public class " + human_ty + " : CommonBase {\n"
1099 java_hu_struct += "\t" + human_ty + "(object _dummy, long ptr) : base(ptr) { }\n"
1100 java_hu_struct += "\t~" + human_ty + "() {\n"
1101 java_hu_struct += "\t\tif (ptr != 0) { bindings." + struct_name.replace("LDK","") + "_free(ptr); }\n"
1102 java_hu_struct += "\t}\n\n"
1103 java_hu_struct += "\tinternal static " + human_ty + " constr_from_ptr(long ptr) {\n"
1104 java_hu_struct += "\t\tif (bindings." + struct_name.replace("LDK", "") + "_is_ok(ptr)) {\n"
1105 java_hu_struct += "\t\t\treturn new " + human_ty + "_OK(null, ptr);\n"
1106 java_hu_struct += "\t\t} else {\n"
1107 java_hu_struct += "\t\t\treturn new " + human_ty + "_Err(null, ptr);\n"
1108 java_hu_struct += "\t\t}\n"
1109 java_hu_struct += "\t}\n"
1111 java_hu_struct += "\tpublic class " + human_ty + "_OK : " + human_ty + " {\n"
1113 if res_map.java_hu_ty != "void":
1114 java_hu_struct += "\t\tpublic readonly " + res_map.java_hu_ty + " res;\n"
1115 java_hu_struct += "\t\tinternal " + human_ty + "_OK(object _dummy, long ptr) : base(_dummy, ptr) {\n"
1116 if res_map.java_hu_ty == "void":
1118 elif res_map.to_hu_conv is not None:
1119 java_hu_struct += "\t\t\t" + res_map.java_ty + " res = bindings." + struct_name.replace("LDK", "") + "_get_ok(ptr);\n"
1120 java_hu_struct += "\t\t\t" + res_map.to_hu_conv.replace("\n", "\n\t\t\t")
1121 java_hu_struct += "\n\t\t\tthis.res = " + res_map.to_hu_conv_name + ";\n"
1123 java_hu_struct += "\t\t\tthis.res = bindings." + struct_name.replace("LDK", "") + "_get_ok(ptr);\n"
1124 java_hu_struct += "\t\t}\n"
1125 java_hu_struct += "\t}\n\n"
1127 java_hu_struct += "\tpublic class " + human_ty + "_Err : " + human_ty + " {\n"
1128 if err_map.java_hu_ty != "void":
1129 java_hu_struct += "\t\tpublic readonly " + err_map.java_hu_ty + " err;\n"
1130 java_hu_struct += "\t\tinternal " + human_ty + "_Err(object _dummy, long ptr) : base(_dummy, ptr) {\n"
1131 if err_map.java_hu_ty == "void":
1133 elif err_map.to_hu_conv is not None:
1134 java_hu_struct += "\t\t\t" + err_map.java_ty + " err = bindings." + struct_name.replace("LDK", "") + "_get_err(ptr);\n"
1135 java_hu_struct += "\t\t\t" + err_map.to_hu_conv.replace("\n", "\n\t\t\t")
1136 java_hu_struct += "\n\t\t\tthis.err = " + err_map.to_hu_conv_name + ";\n"
1138 java_hu_struct += "\t\t\tthis.err = bindings." + struct_name.replace("LDK", "") + "_get_err(ptr);\n"
1139 java_hu_struct += "\t\t}\n"
1141 java_hu_struct += "\t}\n\n"
1142 return java_hu_struct
1144 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):
1145 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
1148 out_java_struct = None
1150 out_java += self.native_meth_decl(method_name, return_type_info.java_ty) + "("
1151 out_c += (return_type_info.c_ty)
1152 if return_type_info.ret_conv is not None:
1153 ret_conv_pfx, ret_conv_sfx = return_type_info.ret_conv
1154 have_args = len(argument_types) > 1 or (len(argument_types) > 0 and argument_types[0].c_ty != "void")
1155 out_c += (" " + self.c_fn_name_define_pfx(method_name, have_args))
1157 for idx, arg_conv_info in enumerate(argument_types):
1161 if arg_conv_info.c_ty != "void":
1162 out_c += (arg_conv_info.c_ty + " " + arg_conv_info.arg_name)
1163 if "[]" in arg_conv_info.java_ty:
1164 out_java += "[MarshalAs(UnmanagedType.CustomMarshaler, MarshalType=\"org.ldk.impl.ArrayCoder\")] "
1165 out_java += (arg_conv_info.java_ty + " _" + arg_conv_info.arg_name) # Add a _ to avoid using reserved words
1167 out_java_struct = ""
1168 extra_java_struct_out = ""
1170 out_java_struct += ("\t// Skipped " + method_name + "\n")
1172 if doc_comment is not None:
1173 out_java_struct += "\t/**\n\t * " + doc_comment.replace("\n", "\n\t * ") + "\n\t */\n"
1174 hu_ret_ty = return_type_info.java_hu_ty
1175 if return_type_info.nullable:
1176 #hu_ret_ty += "?" - apparently mono doesn't support the nullable stuff
1180 out_java_struct += "\tpublic static " + hu_ret_ty + " of("
1181 elif meth_n == "default":
1182 out_java_struct += "\tpublic static " + hu_ret_ty + " with_default("
1184 out_java_struct += "\tpublic static " + hu_ret_ty + " " + meth_n + "("
1185 elif meth_n == "clone_ptr" or (struct_meth.startswith("LDKCResult") and (meth_n == "get_ok" or meth_n == "get_err")):
1186 out_java_struct += "\tinternal " + hu_ret_ty + " " + meth_n + "("
1188 if meth_n == "hash" and return_type_info.java_hu_ty == "long":
1189 extra_java_struct_out = "\tpublic override int GetHashCode() {\n"
1190 extra_java_struct_out += "\t\treturn (int)this.hash();\n"
1191 extra_java_struct_out += "\t}\n"
1192 elif meth_n == "eq" and return_type_info.java_hu_ty == "bool":
1193 extra_java_struct_out = "\tpublic override bool Equals(object o) {\n"
1194 extra_java_struct_out += "\t\tif (!(o is " + struct_meth + ")) return false;\n"
1195 extra_java_struct_out += "\t\treturn this.eq((" + struct_meth + ")o);\n"
1196 extra_java_struct_out += "\t}\n"
1197 if meth_n == "lock":
1198 out_java_struct += "\tpublic " + hu_ret_ty + " do_lock("
1200 out_java_struct += "\tpublic " + hu_ret_ty + " " + meth_n + "("
1201 for idx, arg in enumerate(argument_types):
1203 if not takes_self or idx > 1:
1204 out_java_struct += ", "
1207 if arg.java_ty != "void":
1208 if arg.arg_name in default_constructor_args:
1209 assert not arg.nullable
1210 for explode_idx, explode_arg in enumerate(default_constructor_args[arg.arg_name]):
1211 if explode_idx != 0:
1212 out_java_struct += (", ")
1213 out_java_struct += (
1214 explode_arg.java_hu_ty + " " + arg.arg_name + "_" + explode_arg.arg_name)
1216 ty_string = arg.java_hu_ty
1218 #ty_string += "?" - apparently mono doesn't support the nullable stuff
1220 ty_string = self.fully_qualified_hu_ty_path(arg)
1221 out_java_struct += ty_string + " " + arg_name_repl(arg.arg_name, arg.arg_name)
1222 out_java += (");\n")
1224 if out_java_struct is not None:
1225 out_java_struct += (") {\n")
1226 for info in argument_types:
1227 if info.arg_conv is not None:
1228 out_c += ("\t" + info.arg_conv.replace('\n', "\n\t") + "\n")
1229 if return_type_info.ret_conv is not None:
1230 out_c += ("\t" + ret_conv_pfx.replace('\n', '\n\t'))
1231 elif return_type_info.c_ty != "void":
1232 out_c += ("\t" + return_type_info.c_ty + " ret_val = ")
1235 if c_call_string is None:
1236 out_c += (method_name + "(")
1238 out_c += (c_call_string)
1239 for idx, info in enumerate(argument_types):
1240 if info.arg_conv_name is not None:
1243 elif c_call_string is not None:
1245 out_c += (info.arg_conv_name)
1247 if return_type_info.ret_conv is not None:
1248 out_c += (ret_conv_sfx.replace('\n', '\n\t'))
1251 for info in argument_types:
1252 if info.arg_conv_cleanup is not None:
1253 out_c += ("\n\t" + info.arg_conv_cleanup.replace("\n", "\n\t"))
1254 if return_type_info.ret_conv is not None:
1255 out_c += ("\n\treturn " + return_type_info.ret_conv_name + ";")
1256 elif return_type_info.c_ty != "void":
1257 out_c += ("\n\treturn ret_val;")
1258 out_c += ("\n}\n\n")
1261 out_java_struct += ("\t\t")
1262 if return_type_info.java_ty != "void":
1263 out_java_struct += (return_type_info.java_ty + " ret = ")
1264 out_java_struct += ("bindings." + method_name + "(")
1265 for idx, info in enumerate(argument_types):
1267 out_java_struct += (", ")
1268 if idx == 0 and takes_self:
1269 out_java_struct += ("this.ptr")
1270 elif info.arg_name in default_constructor_args:
1271 out_java_struct += ("bindings." + info.java_hu_ty + "_new(")
1272 for explode_idx, explode_arg in enumerate(default_constructor_args[info.arg_name]):
1273 if explode_idx != 0:
1274 out_java_struct += (", ")
1275 expl_arg_name = info.arg_name + "_" + explode_arg.arg_name
1276 if explode_arg.from_hu_conv is not None:
1277 out_java_struct += (
1278 explode_arg.from_hu_conv[0].replace(explode_arg.arg_name, expl_arg_name))
1280 out_java_struct += (expl_arg_name)
1281 out_java_struct += (")")
1282 elif info.from_hu_conv is not None:
1283 out_java_struct += arg_name_repl(info.from_hu_conv[0], info.arg_name)
1285 out_java_struct += arg_name_repl(info.arg_name, info.arg_name)
1286 out_java_struct += (");\n")
1288 # Like Java, the C# GC is quite aggressive and can finalize an object while a method
1289 # on it is operating. Unlike Java, this behavior appears to be better documented,
1291 for idx, info in enumerate(argument_types):
1292 if idx == 0 and takes_self:
1293 out_java_struct += ("\t\tGC.KeepAlive(this);\n")
1294 elif info.arg_name in default_constructor_args:
1295 for explode_idx, explode_arg in enumerate(default_constructor_args[info.arg_name]):
1296 expl_arg_name = info.arg_name + "_" + explode_arg.arg_name
1297 out_java_struct += ("\t\tGC.KeepAlive(" + expl_arg_name + ");\n")
1298 elif info.c_ty != "void":
1299 out_java_struct += ("\t\tGC.KeepAlive(" + arg_name_repl(info.arg_name, info.arg_name) + ");\n")
1301 if return_type_info.java_ty == "long" and return_type_info.java_hu_ty != "long":
1302 out_java_struct += "\t\tif (ret >= 0 && ret <= 4096) { return null; }\n"
1304 if return_type_info.to_hu_conv is not None:
1306 out_java_struct += ("\t\t" + return_type_info.to_hu_conv.replace("\n", "\n\t\t")
1307 .replace("this", return_type_info.to_hu_conv_name) + "\n")
1309 out_java_struct += ("\t\t" + return_type_info.to_hu_conv.replace("\n", "\n\t\t") + "\n")
1311 for idx, info in enumerate(argument_types):
1312 if idx == 0 and takes_self:
1314 elif info.arg_name in default_constructor_args:
1315 for explode_arg in default_constructor_args[info.arg_name]:
1316 expl_arg_name = info.arg_name + "_" + explode_arg.arg_name
1317 if explode_arg.from_hu_conv is not None and return_type_info.to_hu_conv_name:
1318 out_java_struct += ("\t\t" +
1319 arg_name_repl(explode_arg.from_hu_conv[1], info.arg_name)
1320 .replace(explode_arg.arg_name, expl_arg_name)
1321 .replace("this", return_type_info.to_hu_conv_name) + ";\n")
1322 elif info.from_hu_conv is not None and info.from_hu_conv[1] != "":
1323 if not takes_self and return_type_info.to_hu_conv_name is not None:
1324 out_java_struct += ("\t\t" + arg_name_repl(info.from_hu_conv[1], info.arg_name)
1325 .replace("this", return_type_info.to_hu_conv_name)
1326 .replace("\n", "\n\t\t") + ";\n")
1328 out_java_struct += ("\t\t" + arg_name_repl(info.from_hu_conv[1], info.arg_name)
1329 .replace("\n", "\n\t\t") + ";\n")
1331 if takes_self and not takes_self_as_ref:
1332 out_java_struct += "\t\t" + argument_types[0].from_hu_conv[1].replace("\n", "\n\t\t").replace("this_arg", "this") + ";\n"
1333 if return_type_info.to_hu_conv_name is not None:
1334 out_java_struct += ("\t\treturn " + return_type_info.to_hu_conv_name + ";\n")
1335 elif return_type_info.java_ty != "void" and return_type_info.rust_obj != "LDK" + struct_meth:
1336 out_java_struct += ("\t\treturn ret;\n")
1337 out_java_struct += ("\t}\n\n")
1339 return (out_java, out_c, out_java_struct + extra_java_struct_out)