1 from bindingstypes import ConvInfo
4 def first_to_lower(string: str) -> str:
6 return first.lower() + string[1:]
14 def __init__(self, DEBUG: bool, target: Target, **kwargs):
16 self.c_type_map = dict(
17 uint8_t = ['number', 'Uint8Array'],
18 uint16_t = ['number', 'Uint16Array'],
19 uint32_t = ['number', 'Uint32Array'],
20 uint64_t = ['number'],
23 self.wasm_decoding_map = dict(
24 int8_tArray = 'decodeArray'
27 self.wasm_encoding_map = dict(
28 int8_tArray = 'encodeArray',
31 self.to_hu_conv_templates = dict(
32 ptr = 'const {var_name}_hu_conv: {human_type} = new {human_type}(null, {var_name});',
33 default = 'const {var_name}_hu_conv: {human_type} = new {human_type}(null, {var_name});',
36 self.bindings_header = self.wasm_import_header(target) + """
37 export class VecOrSliceDef {
38 public dataptr: number;
39 public datalen: number;
40 public stride: number;
41 public constructor(dataptr: number, datalen: number, stride: number) {
42 this.dataptr = dataptr;
43 this.datalen = datalen;
51 System.loadLibrary(\"lightningjni\");
52 init(java.lang.Enum.class, VecOrSliceDef.class);
56 static native void init(java.lang.Class c, java.lang.Class slicedef);
57 static native void init_class_cache();
59 public static native boolean deref_bool(long ptr);
60 public static native long deref_long(long ptr);
61 public static native void free_heap_ptr(long ptr);
62 public static native byte[] read_bytes(long ptr, long len);
63 public static native byte[] get_u8_slice_bytes(long slice_ptr);
64 public static native long bytes_to_u8_vec(byte[] bytes);
65 public static native long new_txpointer_copy_data(byte[] txdata);
66 public static native void txpointer_free(long ptr);
67 public static native byte[] txpointer_get_buffer(long ptr);
68 public static native long vec_slice_len(long vec);
69 public static native long new_empty_slice_vec();
74 self.bindings_version_file = ""
76 self.bindings_footer = """
77 export async function initializeWasm(allowDoubleInitialization: boolean = false): Promise<void> {
78 if(isWasmInitialized && !allowDoubleInitialization) {
81 const wasmInstance = await WebAssembly.instantiate(wasmModule, imports)
82 wasm = wasmInstance.exports;
83 isWasmInitialized = true;
90 self.common_base = """
91 export default class CommonBase {
93 ptrs_to: object[] = []; // new LinkedList(); TODO: build linked list implementation
94 protected constructor(ptr: number) { this.ptr = ptr; }
95 public _test_only_get_ptr(): number { return this.ptr; }
96 protected finalize() {
97 // TODO: finalize myself
102 self.c_file_pfx = """#include "js-wasm.h"
103 #include <stdatomic.h>
104 #include <lightning.h>
106 // These should be provided...somehow...
107 void *memset(void *s, int c, size_t n);
108 void *memcpy(void *dest, const void *src, size_t n);
109 int memcmp(const void *s1, const void *s2, size_t n);
111 void __attribute__((noreturn)) abort(void);
112 static inline void assert(bool expression) {
113 if (!expression) { abort(); }
118 self.c_file_pfx = self.c_file_pfx + """
119 void *malloc(size_t size);
120 void free(void *ptr);
122 #define MALLOC(a, _) malloc(a)
123 #define FREE(p) if ((unsigned long)(p) > 4096) { free(p); }
124 #define DO_ASSERT(a) (void)(a)
126 #define CHECK_ACCESS(p)
127 #define CHECK_INNER_FIELD_ACCESS_OR_NULL(v)
130 self.c_file_pfx = self.c_file_pfx + """
131 // Always run a, then assert it is true:
132 #define DO_ASSERT(a) do { bool _assert_val = (a); assert(_assert_val); } while(0)
133 // Assert a is true or do nothing
134 #define CHECK(a) DO_ASSERT(a)
136 // Running a leak check across all the allocations and frees of the JDK is a mess,
137 // so instead we implement our own naive leak checker here, relying on the -wrap
138 // linker option to wrap malloc/calloc/realloc/free, tracking everyhing allocated
139 // and free'd in Rust or C across the generated bindings shared library.
142 typedef struct allocation {
143 struct allocation* next;
145 const char* struct_name;
147 static allocation* allocation_ll = NULL;
149 void* __real_malloc(size_t len);
150 void* __real_calloc(size_t nmemb, size_t len);
151 static void new_allocation(void* res, const char* struct_name) {
152 allocation* new_alloc = __real_malloc(sizeof(allocation));
153 new_alloc->ptr = res;
154 new_alloc->struct_name = struct_name;
155 new_alloc->next = allocation_ll;
156 allocation_ll = new_alloc;
158 static void* MALLOC(size_t len, const char* struct_name) {
159 void* res = __real_malloc(len);
160 new_allocation(res, struct_name);
163 void __real_free(void* ptr);
164 static void alloc_freed(void* ptr) {
165 allocation* p = NULL;
166 allocation* it = allocation_ll;
167 while (it->ptr != ptr) {
168 p = it; it = it->next;
170 //XXX: fprintf(stderr, "Tried to free unknown pointer %p\\n", ptr);
171 return; // addrsan should catch malloc-unknown and print more info than we have
174 if (p) { p->next = it->next; } else { allocation_ll = it->next; }
175 DO_ASSERT(it->ptr == ptr);
178 static void FREE(void* ptr) {
179 if ((unsigned long)ptr <= 4096) return; // Rust loves to create pointers to the NULL page for dummys
184 static void CHECK_ACCESS(void* ptr) {
185 allocation* it = allocation_ll;
186 while (it->ptr != ptr) {
189 return; // addrsan should catch malloc-unknown and print more info than we have
193 #define CHECK_INNER_FIELD_ACCESS_OR_NULL(v) \\
194 if (v.is_owned && v.inner != NULL) { \\
195 const void *p = __unmangle_inner_ptr(v.inner); \\
201 void* __wrap_malloc(size_t len) {
202 void* res = __real_malloc(len);
203 new_allocation(res, "malloc call");
206 void* __wrap_calloc(size_t nmemb, size_t len) {
207 void* res = __real_calloc(nmemb, len);
208 new_allocation(res, "calloc call");
211 void __wrap_free(void* ptr) {
212 if (ptr == NULL) return;
217 void* __real_realloc(void* ptr, size_t newlen);
218 void* __wrap_realloc(void* ptr, size_t len) {
219 if (ptr != NULL) alloc_freed(ptr);
220 void* res = __real_realloc(ptr, len);
221 new_allocation(res, "realloc call");
224 void __wrap_reallocarray(void* ptr, size_t new_sz) {
225 // Rust doesn't seem to use reallocarray currently
229 void __attribute__((destructor)) check_leaks() {
230 for (allocation* a = allocation_ll; a != NULL; a = a->next) {
231 //XXX: fprintf(stderr, "%s %p remains\\n", a->struct_name, a->ptr);
233 DO_ASSERT(allocation_ll == NULL);
236 self.c_file_pfx = self.c_file_pfx + """
237 // We assume that CVec_u8Z and u8slice are the same size and layout (and thus pointers to the two can be mixed)
238 _Static_assert(sizeof(LDKCVec_u8Z) == sizeof(LDKu8slice), "Vec<u8> and [u8] need to have been mapped identically");
239 _Static_assert(offsetof(LDKCVec_u8Z, data) == offsetof(LDKu8slice, data), "Vec<u8> and [u8] need to have been mapped identically");
240 _Static_assert(offsetof(LDKCVec_u8Z, datalen) == offsetof(LDKu8slice, datalen), "Vec<u8> and [u8] need to have been mapped identically");
242 _Static_assert(sizeof(void*) == 4, "Pointers mut be 32 bits");
244 typedef uint32_t int64_tArray;
245 typedef uint32_t int8_tArray;
246 typedef uint32_t uint32_tArray;
247 typedef uint32_t ptrArray;
248 typedef uint32_t jstring;
250 static inline uint32_t init_arr(size_t arr_len, size_t elem_size, const char *type_desc) {
251 uint32_t *elems = (uint32_t*)MALLOC(arr_len * elem_size + 4, type_desc);
253 return (uint32_t)elems;
256 static inline jstring str_ref_to_ts(const char* chars, size_t len) {
257 char* err_buf = MALLOC(len + 4, "str conv buf");
258 *((uint32_t*)err_buf) = len;
259 memcpy(err_buf + 4, chars, len);
260 return (uint32_t) err_buf;
262 static inline LDKStr str_ref_to_owned_c(jstring str) {
263 uint32_t *str_len = (uint32_t*)str;
264 char* newchars = MALLOC(*str_len + 1, "String chars");
265 memcpy(newchars, (const char*)(str + 4), *str_len);
266 newchars[*str_len] = 0;
270 .chars_is_owned = true
275 typedef bool jboolean;
277 uint32_t __attribute__((visibility("default"))) TS_malloc(uint32_t size) {
278 return (uint32_t)MALLOC(size, "JS-Called malloc");
280 void __attribute__((visibility("default"))) TS_free(uint32_t ptr) {
285 self.c_version_file = ""
287 self.hu_struct_file_prefix = f"""
288 import CommonBase from './CommonBase';
289 import * as bindings from '../bindings' // TODO: figure out location
292 self.c_fn_ty_pfx = ""
293 self.file_ext = ".ts"
294 self.ptr_c_ty = "uint32_t"
295 self.ptr_native_ty = "number"
296 self.result_c_ty = "uint32_t"
297 self.ptr_arr = "ptrArray"
298 self.is_arr_some_check = ("", " != 0")
299 self.get_native_arr_len_call = ("*((uint32_t*)", ")")
301 def release_native_arr_ptr_call(self, ty_info, arr_var, arr_ptr_var):
303 def create_native_arr_call(self, arr_len, ty_info):
304 if ty_info.c_ty == "int8_tArray":
305 return "init_arr(" + arr_len + ", sizeof(uint8_t), \"Native int8_tArray Bytes\")"
306 elif ty_info.c_ty == "int64_tArray":
307 return "init_arr(" + arr_len + ", sizeof(uint64_t), \"Native int64_tArray Bytes\")"
308 elif ty_info.c_ty == "uint32_tArray":
309 return "init_arr(" + arr_len + ", sizeof(uint32_t), \"Native uint32_tArray Bytes\")"
310 elif ty_info.c_ty == "ptrArray":
311 assert ty_info.subty is not None and ty_info.subty.c_ty.endswith("Array")
312 return "init_arr(" + arr_len + ", sizeof(uint32_t), \"Native ptrArray Bytes\")"
314 print("Need to create arr!", ty_info.c_ty)
316 def set_native_arr_contents(self, arr_name, arr_len, ty_info):
317 if ty_info.c_ty == "int8_tArray":
318 return ("memcpy((uint8_t*)(" + arr_name + " + 4), ", ", " + arr_len + ")")
321 def get_native_arr_contents(self, arr_name, dest_name, arr_len, ty_info, copy):
322 if ty_info.c_ty == "int8_tArray":
324 return "memcpy(" + dest_name + ", (uint8_t*)(" + arr_name + " + 4), " + arr_len + ")"
326 return "(int8_t*)(" + arr_name + " + 4)"
328 return "(" + ty_info.subty.c_ty + "*)(" + arr_name + " + 4)"
329 def get_native_arr_elem(self, arr_name, idxc, ty_info):
330 assert False # Only called if above is None
331 def get_native_arr_ptr_call(self, ty_info):
332 if ty_info.subty is not None:
333 return "(" + ty_info.subty.c_ty + "*)(", " + 4)"
334 return "(" + ty_info.c_ty + "*)(", " + 4)"
335 def get_native_arr_entry_call(self, ty_info, arr_name, idxc, entry_access):
337 def cleanup_native_arr_ref_contents(self, arr_name, dest_name, arr_len, ty_info):
338 if ty_info.c_ty == "int8_tArray":
343 def str_ref_to_native_call(self, var_name, str_len):
344 return "str_ref_to_ts(" + var_name + ", " + str_len + ")"
345 def str_ref_to_c_call(self, var_name):
346 return "str_ref_to_owned_c(" + var_name + ")"
348 def c_fn_name_define_pfx(self, fn_name, have_args):
349 return " __attribute__((visibility(\"default\"))) TS_" + fn_name + "("
351 def wasm_import_header(self, target):
352 if target == Target.NODEJS:
354 import * as fs from 'fs';
355 const source = fs.readFileSync('./ldk.wasm');
357 const memory = new WebAssembly.Memory({initial: 256});
358 const wasmModule = new WebAssembly.Module(source);
360 const imports: any = {};
363 imports.env.memoryBase = 0;
364 imports.env.memory = memory;
365 imports.env.tableBase = 0;
366 imports.env.table = new WebAssembly.Table({initial: 4, element: 'anyfunc'});
368 imports.env["abort"] = function () {
369 console.error("ABORT");
373 let isWasmInitialized: boolean = false;
378 const nextMultipleOfFour = (value: number) => {
379 return Math.ceil(value / 4) * 4;
382 const encodeUint8Array = (inputArray) => {
383 const cArrayPointer = wasm.TS_malloc(inputArray.length + 4);
384 const arrayLengthView = new Uint32Array(memory.buffer, cArrayPointer, 1);
385 arrayLengthView[0] = inputArray.length;
386 const arrayMemoryView = new Uint8Array(memory.buffer, cArrayPointer + 4, inputArray.length);
387 arrayMemoryView.set(inputArray);
388 return cArrayPointer;
391 const encodeUint32Array = (inputArray) => {
392 const cArrayPointer = wasm.TS_malloc((inputArray.length + 1) * 4);
393 const arrayMemoryView = new Uint32Array(memory.buffer, cArrayPointer, inputArray.length);
394 arrayMemoryView.set(inputArray, 1);
395 arrayMemoryView[0] = inputArray.length;
396 return cArrayPointer;
399 const getArrayLength = (arrayPointer) => {
400 const arraySizeViewer = new Uint32Array(
401 memory.buffer, // value
402 arrayPointer, // offset
405 return arraySizeViewer[0];
407 const decodeUint8Array = (arrayPointer, free = true) => {
408 const arraySize = getArrayLength(arrayPointer);
409 const actualArrayViewer = new Uint8Array(
410 memory.buffer, // value
411 arrayPointer + 4, // offset (ignoring length bytes)
412 arraySize // uint8 count
414 // Clone the contents, TODO: In the future we should wrap the Viewer in a class that
415 // will free the underlying memory when it becomes unreachable instead of copying here.
416 const actualArray = actualArrayViewer.slice(0, arraySize);
418 wasm.TS_free(arrayPointer);
422 const decodeUint32Array = (arrayPointer, free = true) => {
423 const arraySize = getArrayLength(arrayPointer);
424 const actualArrayViewer = new Uint32Array(
425 memory.buffer, // value
426 arrayPointer + 4, // offset (ignoring length bytes)
427 arraySize // uint32 count
429 // Clone the contents, TODO: In the future we should wrap the Viewer in a class that
430 // will free the underlying memory when it becomes unreachable instead of copying here.
431 const actualArray = actualArrayViewer.slice(0, arraySize);
433 wasm.TS_free(arrayPointer);
438 const encodeString = (string) => {
439 // make malloc count divisible by 4
440 const memoryNeed = nextMultipleOfFour(string.length + 1);
441 const stringPointer = wasm.TS_malloc(memoryNeed);
442 const stringMemoryView = new Uint8Array(
443 memory.buffer, // value
444 stringPointer, // offset
445 string.length + 1 // length
447 for (let i = 0; i < string.length; i++) {
448 stringMemoryView[i] = string.charCodeAt(i);
450 stringMemoryView[string.length] = 0;
451 return stringPointer;
454 const decodeString = (stringPointer, free = true) => {
455 const memoryView = new Uint8Array(memory.buffer, stringPointer);
459 while (memoryView[cursor] !== 0) {
460 result += String.fromCharCode(memoryView[cursor]);
465 wasm.wasm_free(stringPointer);
476 def native_c_unitary_enum_map(self, struct_name, variants, enum_doc_comment):
477 out_c = "static inline LDK" + struct_name + " LDK" + struct_name + "_from_js(int32_t ord) {\n"
478 out_c = out_c + "\tswitch (ord) {\n"
481 out_typescript_enum_fields = ""
483 for var, var_docs in variants:
484 out_c = out_c + "\t\tcase %d: return %s;\n" % (ord_v, var)
486 if var_docs is not None:
487 out_typescript_enum_fields += f"/**\n * {var_docs}\n */\n"
488 out_typescript_enum_fields += f"{var},\n\t\t\t\t"
489 out_c = out_c + "\t}\n"
490 out_c = out_c + "\tabort();\n"
491 out_c = out_c + "}\n"
493 out_c = out_c + "static inline int32_t LDK" + struct_name + "_to_js(LDK" + struct_name + " val) {\n"
494 out_c = out_c + "\tswitch (val) {\n"
496 for var, _ in variants:
497 out_c = out_c + "\t\tcase " + var + ": return %d;\n" % ord_v
499 out_c = out_c + "\t\tdefault: abort();\n"
500 out_c = out_c + "\t}\n"
501 out_c = out_c + "}\n"
503 out_typescript_enum = f"""
504 export enum {struct_name} {{
505 {out_typescript_enum_fields}
509 return (out_c, out_typescript_enum, "")
511 def c_unitary_enum_to_native_call(self, ty_info):
512 return (ty_info.rust_obj + "_to_js(", ")")
513 def native_unitary_enum_to_c_call(self, ty_info):
514 return (ty_info.rust_obj + "_from_js(", ")")
516 def c_complex_enum_pass_ty(self, struct_name):
519 def c_constr_native_complex_enum(self, struct_name, variant, c_params):
520 ret = "0 /* " + struct_name + " - " + variant + " */"
521 for param in c_params:
522 ret = ret + "; (void) " + param
525 def native_c_map_trait(self, struct_name, field_var_conversions, flattened_field_var_conversions, field_function_lines, trait_doc_comment):
526 out_typescript_bindings = "\n\n\n// OUT_TYPESCRIPT_BINDINGS :: MAP_TRAIT :: START\n\n"
528 constructor_arguments = ""
529 super_instantiator = ""
530 pointer_to_adder = ""
531 impl_constructor_arguments = ""
532 for var in flattened_field_var_conversions:
533 if isinstance(var, ConvInfo):
534 constructor_arguments += f", {first_to_lower(var.arg_name)}?: {var.java_hu_ty}"
535 impl_constructor_arguments += f", {var.arg_name}: {var.java_hu_ty}"
536 if var.from_hu_conv is not None:
537 super_instantiator += ", " + var.from_hu_conv[0]
538 if var.from_hu_conv[1] != "":
539 pointer_to_adder += var.from_hu_conv[1] + ";\n"
541 super_instantiator += ", " + first_to_lower(var.arg_name)
543 constructor_arguments += f", {first_to_lower(var[1])}?: bindings.{var[0]}"
544 super_instantiator += ", " + first_to_lower(var[1])
545 pointer_to_adder += "this.ptrs_to.push(" + first_to_lower(var[1]) + ");\n"
546 impl_constructor_arguments += f", {first_to_lower(var[1])}_impl: {var[0].replace('LDK', '')}.{var[0].replace('LDK', '')}Interface"
548 # BUILD INTERFACE METHODS
549 out_java_interface = ""
550 out_interface_implementation_overrides = ""
552 for fn_line in field_function_lines:
553 java_method_descriptor = ""
554 if fn_line.fn_name != "free" and fn_line.fn_name != "cloned":
555 out_java_interface += fn_line.fn_name + "("
556 out_interface_implementation_overrides += f"{fn_line.fn_name} ("
558 for idx, arg_conv_info in enumerate(fn_line.args_ty):
560 out_java_interface += ", "
561 out_interface_implementation_overrides += ", "
562 out_java_interface += f"{arg_conv_info.arg_name}: {arg_conv_info.java_hu_ty}"
563 out_interface_implementation_overrides += f"{arg_conv_info.arg_name}: {arg_conv_info.java_ty}"
564 java_method_descriptor += arg_conv_info.java_fn_ty_arg
565 out_java_interface += f"): {fn_line.ret_ty_info.java_hu_ty};\n\t\t\t\t"
566 java_method_descriptor += ")" + fn_line.ret_ty_info.java_fn_ty_arg
567 java_methods.append((fn_line.fn_name, java_method_descriptor))
569 out_interface_implementation_overrides += f"): {fn_line.ret_ty_info.java_ty} {{\n"
571 interface_method_override_inset = "\t\t\t\t\t\t"
572 interface_implementation_inset = "\t\t\t\t\t\t\t"
573 for arg_info in fn_line.args_ty:
574 if arg_info.to_hu_conv is not None:
575 out_interface_implementation_overrides += interface_implementation_inset + arg_info.to_hu_conv.replace("\n", "\n\t\t\t\t") + "\n"
577 if fn_line.ret_ty_info.java_ty != "void":
578 out_interface_implementation_overrides += interface_implementation_inset + fn_line.ret_ty_info.java_hu_ty + " ret = arg." + fn_line.fn_name + "("
580 out_interface_implementation_overrides += f"{interface_implementation_inset}arg." + fn_line.fn_name + "("
582 for idx, arg_info in enumerate(fn_line.args_ty):
584 out_interface_implementation_overrides += ", "
585 if arg_info.to_hu_conv_name is not None:
586 out_interface_implementation_overrides += arg_info.to_hu_conv_name
588 out_interface_implementation_overrides += arg_info.arg_name
590 out_interface_implementation_overrides += ");\n"
591 if fn_line.ret_ty_info.java_ty != "void":
592 if fn_line.ret_ty_info.from_hu_conv is not None:
593 out_interface_implementation_overrides = out_interface_implementation_overrides + "\t\t\t\t" + f"result: {fn_line.ret_ty_info.java_ty} = " + fn_line.ret_ty_info.from_hu_conv[0] + ";\n"
594 if fn_line.ret_ty_info.from_hu_conv[1] != "":
595 out_interface_implementation_overrides = out_interface_implementation_overrides + "\t\t\t\t" + fn_line.ret_ty_info.from_hu_conv[1].replace("this", "impl_holder.held") + ";\n"
596 #if fn_line.ret_ty_info.rust_obj in result_types:
597 # XXX: We need to handle this in conversion logic so that its cross-language!
598 # Avoid double-free by breaking the result - we should learn to clone these and then we can be safe instead
599 # out_interface_implementation_overrides = out_interface_implementation_overrides + "\t\t\t\tret.ptr = 0;\n"
600 out_interface_implementation_overrides = out_interface_implementation_overrides + "\t\t\t\treturn result;\n"
602 out_interface_implementation_overrides = out_interface_implementation_overrides + "\t\t\t\treturn ret;\n"
603 out_interface_implementation_overrides += f"{interface_method_override_inset}}},\n\n{interface_method_override_inset}"
605 trait_constructor_arguments = ""
606 for var in field_var_conversions:
607 if isinstance(var, ConvInfo):
608 trait_constructor_arguments += ", " + var.arg_name
610 trait_constructor_arguments += ", " + var[1] + ".new_impl(" + var[1] + "_impl"
611 for suparg in var[2]:
612 if isinstance(suparg, ConvInfo):
613 trait_constructor_arguments += ", " + suparg.arg_name
615 trait_constructor_arguments += ", " + suparg[1]
616 trait_constructor_arguments += ").bindings_instance"
617 for suparg in var[2]:
618 if isinstance(suparg, ConvInfo):
619 trait_constructor_arguments += ", " + suparg.arg_name
621 trait_constructor_arguments += ", " + suparg[1]
623 out_typescript_human = f"""
624 {self.hu_struct_file_prefix}
626 export class {struct_name.replace("LDK","")} extends CommonBase {{
628 bindings_instance?: bindings.{struct_name};
630 constructor(ptr?: number, arg?: bindings.{struct_name}{constructor_arguments}) {{
631 if (Number.isFinite(ptr)) {{
633 this.bindings_instance = null;
635 // TODO: private constructor instantiation
636 super(bindings.{struct_name}_new(arg{super_instantiator}));
637 this.ptrs_to.push(arg);
642 protected finalize() {{
643 if (this.ptr != 0) {{
644 bindings.{struct_name.replace("LDK","")}_free(this.ptr);
649 static new_impl(arg: {struct_name.replace("LDK", "")}Interface{impl_constructor_arguments}): {struct_name.replace("LDK", "")} {{
650 const impl_holder: {struct_name}Holder = new {struct_name}Holder();
651 let structImplementation = <bindings.{struct_name}>{{
652 // todo: in-line interface filling
653 {out_interface_implementation_overrides}
655 impl_holder.held = new {struct_name.replace("LDK", "")} (null, structImplementation{trait_constructor_arguments});
659 export interface {struct_name.replace("LDK", "")}Interface {{
663 class {struct_name}Holder {{
664 held: {struct_name.replace("LDK", "")};
668 out_typescript_bindings += "\t\texport interface " + struct_name + " {\n"
670 for fn_line in field_function_lines:
671 if fn_line.fn_name != "free" and fn_line.fn_name != "cloned":
672 out_typescript_bindings += f"\t\t\t{fn_line.fn_name} ("
674 for idx, arg_conv_info in enumerate(fn_line.args_ty):
676 out_typescript_bindings = out_typescript_bindings + ", "
677 out_typescript_bindings += f"{arg_conv_info.arg_name}: {arg_conv_info.java_ty}"
679 out_typescript_bindings += f"): {fn_line.ret_ty_info.java_ty};\n"
681 out_typescript_bindings = out_typescript_bindings + "\t\t}\n\n"
683 out_typescript_bindings += f"\t\texport function {struct_name}_new(impl: {struct_name}"
684 for var in flattened_field_var_conversions:
685 if isinstance(var, ConvInfo):
686 out_typescript_bindings += f", {var.arg_name}: {var.java_ty}"
688 out_typescript_bindings += f", {var[1]}: {var[0]}"
690 out_typescript_bindings += f"""): number {{
691 throw new Error('unimplemented'); // TODO: bind to WASM
695 out_typescript_bindings += '\n// OUT_TYPESCRIPT_BINDINGS :: MAP_TRAIT :: END\n\n\n'
697 # Now that we've written out our java code (and created java_meths), generate C
698 out_c = "typedef struct " + struct_name + "_JCalls {\n"
699 out_c = out_c + "\tatomic_size_t refcnt;\n"
700 for var in flattened_field_var_conversions:
701 if isinstance(var, ConvInfo):
702 # We're a regular ol' field
706 out_c = out_c + "\t" + var[0] + "_JCalls* " + var[1] + ";\n"
707 for fn in field_function_lines:
708 if fn.fn_name != "free" and fn.fn_name != "cloned":
709 out_c = out_c + "\tuint32_t " + fn.fn_name + "_meth;\n"
710 out_c = out_c + "} " + struct_name + "_JCalls;\n"
712 for fn_line in field_function_lines:
713 if fn_line.fn_name == "free":
714 out_c = out_c + "static void " + struct_name + "_JCalls_free(void* this_arg) {\n"
715 out_c = out_c + "\t" + struct_name + "_JCalls *j_calls = (" + struct_name + "_JCalls*) this_arg;\n"
716 out_c = out_c + "\tif (atomic_fetch_sub_explicit(&j_calls->refcnt, 1, memory_order_acquire) == 1) {\n"
717 for fn in field_function_lines:
718 if fn.fn_name != "free" and fn.fn_name != "cloned":
719 out_c = out_c + "\t\tjs_free(j_calls->" + fn.fn_name + "_meth);\n"
720 out_c = out_c + "\t\tFREE(j_calls);\n"
721 out_c = out_c + "\t}\n}\n"
723 for idx, fn_line in enumerate(field_function_lines):
724 if fn_line.fn_name != "free" and fn_line.fn_name != "cloned":
725 assert fn_line.ret_ty_info.ty_info.get_full_rust_ty()[1] == ""
726 out_c = out_c + fn_line.ret_ty_info.ty_info.get_full_rust_ty()[0] + " " + fn_line.fn_name + "_" + struct_name + "_jcall("
727 if fn_line.self_is_const:
728 out_c = out_c + "const void* this_arg"
730 out_c = out_c + "void* this_arg"
732 for idx, arg in enumerate(fn_line.args_ty):
733 out_c = out_c + ", " + arg.ty_info.get_full_rust_ty()[0] + " " + arg.arg_name + arg.ty_info.get_full_rust_ty()[1]
735 out_c = out_c + ") {\n"
736 out_c = out_c + "\t" + struct_name + "_JCalls *j_calls = (" + struct_name + "_JCalls*) this_arg;\n"
738 for arg_info in fn_line.args_ty:
739 if arg_info.ret_conv is not None:
740 out_c = out_c + "\t" + arg_info.ret_conv[0].replace('\n', '\n\t')
741 out_c = out_c + arg_info.arg_name
742 out_c = out_c + arg_info.ret_conv[1].replace('\n', '\n\t') + "\n"
744 if fn_line.ret_ty_info.c_ty.endswith("Array"):
745 out_c = out_c + "\t" + fn_line.ret_ty_info.c_ty + " ret = js_invoke_function_" + str(len(fn_line.args_ty)) + "(j_calls->" + fn_line.fn_name + "_meth"
746 elif fn_line.ret_ty_info.java_ty == "void":
747 out_c = out_c + "\tjs_invoke_function_" + str(len(fn_line.args_ty)) + "(j_calls->" + fn_line.fn_name + "_meth"
748 elif fn_line.ret_ty_info.java_ty == "String":
749 out_c = out_c + "\tuint32_t ret = js_invoke_function_" + str(len(fn_line.args_ty)) + "(j_calls->" + fn_line.fn_name + "_meth"
750 elif not fn_line.ret_ty_info.passed_as_ptr:
751 out_c = out_c + "\treturn js_invoke_function_" + str(len(fn_line.args_ty)) + "(j_calls->" + fn_line.fn_name + "_meth"
753 out_c = out_c + "\tuint32_t ret = js_invoke_function_" + str(len(fn_line.args_ty)) + "(j_calls->" + fn_line.fn_name + "_meth"
755 for idx, arg_info in enumerate(fn_line.args_ty):
756 if arg_info.ret_conv is not None:
757 out_c = out_c + ", " + arg_info.ret_conv_name
759 out_c = out_c + ", " + arg_info.arg_name
760 out_c = out_c + ");\n"
761 if fn_line.ret_ty_info.arg_conv is not None:
762 out_c = out_c + "\t" + fn_line.ret_ty_info.arg_conv.replace("\n", "\n\t") + "\n\treturn " + fn_line.ret_ty_info.arg_conv_name + ";\n"
764 out_c = out_c + "}\n"
766 # Write out a clone function whether we need one or not, as we use them in moving to rust
767 out_c = out_c + "static void " + struct_name + "_JCalls_cloned(" + struct_name + "* new_obj) {\n"
768 out_c = out_c + "\t" + struct_name + "_JCalls *j_calls = (" + struct_name + "_JCalls*) new_obj->this_arg;\n"
769 out_c = out_c + "\tatomic_fetch_add_explicit(&j_calls->refcnt, 1, memory_order_release);\n"
770 for var in field_var_conversions:
771 if not isinstance(var, ConvInfo):
772 out_c = out_c + "\tatomic_fetch_add_explicit(&j_calls->" + var[1] + "->refcnt, 1, memory_order_release);\n"
773 out_c = out_c + "}\n"
775 out_c = out_c + "static inline " + struct_name + " " + struct_name + "_init (/*TODO: JS Object Reference */void* o"
776 for var in flattened_field_var_conversions:
777 if isinstance(var, ConvInfo):
778 out_c = out_c + ", " + var.c_ty + " " + var.arg_name
780 out_c = out_c + ", /*TODO: JS Object Reference */void* " + var[1]
781 out_c = out_c + ") {\n"
783 out_c = out_c + "\t" + struct_name + "_JCalls *calls = MALLOC(sizeof(" + struct_name + "_JCalls), \"" + struct_name + "_JCalls\");\n"
784 out_c = out_c + "\tatomic_init(&calls->refcnt, 1);\n"
785 out_c = out_c + "\t//TODO: Assign calls->o from o\n"
787 for (fn_name, java_meth_descr) in java_meths:
788 if fn_name != "free" and fn_name != "cloned":
789 out_c = out_c + "\tcalls->" + fn_name + "_meth = (*env)->GetMethodID(env, c, \"" + fn_name + "\", \"" + java_meth_descr + "\");\n"
790 out_c = out_c + "\tCHECK(calls->" + fn_name + "_meth != NULL);\n"
792 for var in flattened_field_var_conversions:
793 if isinstance(var, ConvInfo) and var.arg_conv is not None:
794 out_c = out_c + "\n\t" + var.arg_conv.replace("\n", "\n\t") +"\n"
795 out_c = out_c + "\n\t" + struct_name + " ret = {\n"
796 out_c = out_c + "\t\t.this_arg = (void*) calls,\n"
797 for fn_line in field_function_lines:
798 if fn_line.fn_name != "free" and fn_line.fn_name != "cloned":
799 out_c = out_c + "\t\t." + fn_line.fn_name + " = " + fn_line.fn_name + "_" + struct_name + "_jcall,\n"
800 elif fn_line.fn_name == "free":
801 out_c = out_c + "\t\t.free = " + struct_name + "_JCalls_free,\n"
803 out_c = out_c + "\t\t.cloned = " + struct_name + "_JCalls_cloned,\n"
804 for var in field_var_conversions:
805 if isinstance(var, ConvInfo):
806 if var.arg_conv_name is not None:
807 out_c = out_c + "\t\t." + var.arg_name + " = " + var.arg_conv_name + ",\n"
808 out_c = out_c + "\t\t.set_" + var.arg_name + " = NULL,\n"
810 out_c = out_c + "\t\t." + var.var_name + " = " + var.var_name + ",\n"
811 out_c = out_c + "\t\t.set_" + var.var_name + " = NULL,\n"
813 out_c += "\t\t." + var[1] + " = " + var[0] + "_init(" + var[1]
814 for suparg in var[2]:
815 if isinstance(suparg, ConvInfo):
816 out_c += ", " + suparg.arg_name
818 out_c += ", " + suparg[1]
820 out_c = out_c + "\t};\n"
821 for var in flattened_field_var_conversions:
822 if not isinstance(var, ConvInfo):
823 out_c = out_c + "\tcalls->" + var[1] + " = ret." + var[1] + ".this_arg;\n"
824 out_c = out_c + "\treturn ret;\n"
825 out_c = out_c + "}\n"
827 out_c = out_c + self.c_fn_ty_pfx + "long " + self.c_fn_name_define_pfx(struct_name + "_new", True) + "/*TODO: JS Object Reference */void* o"
828 for var in flattened_field_var_conversions:
829 if isinstance(var, ConvInfo):
830 out_c = out_c + ", " + var.c_ty + " " + var.arg_name
832 out_c = out_c + ", /*TODO: JS Object Reference */ void* " + var[1]
833 out_c = out_c + ") {\n"
834 out_c = out_c + "\t" + struct_name + " *res_ptr = MALLOC(sizeof(" + struct_name + "), \"" + struct_name + "\");\n"
835 out_c = out_c + "\t*res_ptr = " + struct_name + "_init(o"
836 for var in flattened_field_var_conversions:
837 if isinstance(var, ConvInfo):
838 out_c = out_c + ", " + var.arg_name
840 out_c = out_c + ", " + var[1]
841 out_c = out_c + ");\n"
842 out_c = out_c + "\treturn (long)res_ptr;\n"
843 out_c = out_c + "}\n"
845 return (out_typescript_bindings, out_typescript_human, out_c)
847 def trait_struct_inc_refcnt(self, ty_info):
850 def map_complex_enum(self, struct_name, variant_list, camel_to_snake, enum_doc_comment):
851 java_hu_type = struct_name.replace("LDK", "")
857 out_java_enum += (self.hu_struct_file_prefix)
858 out_java_enum += ("export default class " + java_hu_type + " extends CommonBase {\n")
859 out_java_enum += ("\tprotected constructor(_dummy: object, ptr: number) { super(ptr); }\n")
860 out_java_enum += ("\tprotected finalize() {\n")
861 out_java_enum += ("\t\tsuper.finalize();\n")
862 out_java_enum += ("\t\tif (this.ptr != 0) { bindings." + java_hu_type + "_free(this.ptr); }\n")
863 out_java_enum += ("\t}\n")
864 out_java_enum += f"\tstatic constr_from_ptr(ptr: number): {java_hu_type} {{\n"
865 out_java_enum += (f"\t\tconst raw_val: bindings.{struct_name} = bindings." + struct_name + "_ref_from_ptr(ptr);\n")
866 java_hu_subclasses = ""
868 out_java += ("\tpublic static class " + struct_name + " {\n")
869 out_java += ("\t\tprivate " + struct_name + "() {}\n")
870 for var in variant_list:
871 out_java += ("\t\texport class " + var.var_name + " extends " + struct_name + " {\n")
872 java_hu_subclasses = java_hu_subclasses + "export class " + var.var_name + " extends " + java_hu_type + " {\n"
873 out_java_enum += ("\t\tif (raw_val instanceof bindings." + struct_name + "." + var.var_name + ") {\n")
874 out_java_enum += ("\t\t\treturn new " + var.var_name + "(this.ptr, raw_val);\n")
875 init_meth_params = ""
878 for idx, (field_ty, field_docs) in enumerate(var.fields):
879 out_java += ("\t\t\tpublic " + field_ty.java_ty + " " + field_ty.arg_name + ";\n")
880 java_hu_subclasses = java_hu_subclasses + "\tpublic " + field_ty.arg_name + f": {field_ty.java_hu_ty};\n"
881 if field_ty.to_hu_conv is not None:
882 hu_conv_body = hu_conv_body + "\t\tconst " + field_ty.arg_name + f": {field_ty.java_ty} = obj." + field_ty.arg_name + ";\n"
883 hu_conv_body = hu_conv_body + "\t\t" + field_ty.to_hu_conv.replace("\n", "\n\t\t\t") + "\n"
884 hu_conv_body = hu_conv_body + "\t\tthis." + field_ty.arg_name + " = " + field_ty.to_hu_conv_name + ";\n"
886 hu_conv_body = hu_conv_body + "\t\tthis." + field_ty.arg_name + " = obj." + field_ty.arg_name + ";\n"
888 init_meth_params = init_meth_params + ", "
889 init_meth_params = init_meth_params + field_ty.java_ty + " " + field_ty.arg_name
890 init_meth_body = init_meth_body + "this." + field_ty.arg_name + " = " + field_ty.arg_name + "; "
891 out_java += ("\t\t\t" + var.var_name + "(" + init_meth_params + ") { ")
892 out_java += (init_meth_body)
894 out_java += ("\t\t}\n")
895 out_java_enum += ("\t\t}\n")
896 java_hu_subclasses = java_hu_subclasses + "\tprivate constructor(ptr: number, obj: bindings." + struct_name + "." + var.var_name + ") {\n\t\tsuper(null, ptr);\n"
897 java_hu_subclasses = java_hu_subclasses + hu_conv_body
898 java_hu_subclasses = java_hu_subclasses + "\t}\n}\n"
899 out_java += ("\t\tstatic native void init();\n")
900 out_java += ("\t}\n")
901 out_java_enum += ("\t\tthrow new Error('oops, this should be unreachable'); // Unreachable without extending the (internal) bindings interface\n\t}\n\n")
902 out_java += ("\tstatic { " + struct_name + ".init(); }\n")
903 out_java += ("\tpublic static native " + struct_name + " " + struct_name + "_ref_from_ptr(long ptr);\n");
905 out_c += (self.c_fn_ty_pfx + self.c_complex_enum_pass_ty(struct_name) + self.c_fn_name_define_pfx(struct_name + "_ref_from_ptr", True) + self.ptr_c_ty + " ptr) {\n")
906 out_c += ("\t" + struct_name + " *obj = (" + struct_name + "*)(ptr & ~1);\n")
907 out_c += ("\tswitch(obj->tag) {\n")
908 for var in variant_list:
909 out_c += ("\t\tcase " + struct_name + "_" + var.var_name + ": {\n")
911 for idx, (field_map, _) in enumerate(var.fields):
912 if field_map.ret_conv is not None:
913 out_c += ("\t\t\t" + field_map.ret_conv[0].replace("\n", "\n\t\t\t"))
914 if var.tuple_variant:
915 out_c += "obj->" + camel_to_snake(var.var_name)
917 out_c += "obj->" + camel_to_snake(var.var_name) + "." + field_map.arg_name
918 out_c += (field_map.ret_conv[1].replace("\n", "\n\t\t\t") + "\n")
919 c_params.append(field_map.ret_conv_name)
921 if var.tuple_variant:
922 c_params.append("obj->" + camel_to_snake(var.var_name))
924 c_params.append("obj->" + camel_to_snake(var.var_name) + "." + field_map.arg_name)
925 out_c += ("\t\t\treturn " + self.c_constr_native_complex_enum(struct_name, var.var_name, c_params) + ";\n")
927 out_c += ("\t\tdefault: abort();\n")
928 out_c += ("\t}\n}\n")
929 out_java_enum += ("}\n")
930 out_java_enum += (java_hu_subclasses)
931 return (out_java, out_java_enum, out_c)
933 def map_opaque_struct(self, struct_name, struct_doc_comment):
936 if struct_name.startswith("LDKLocked"):
937 implementations += "implements AutoCloseable "
943 protected finalize() {
947 out_opaque_struct_human = f"""
948 {self.hu_struct_file_prefix}
950 export default class {struct_name.replace("LDK","")} extends CommonBase {implementations}{{
951 constructor(_dummy: object, ptr: number) {{
956 if (this.ptr != 0) {{
957 bindings.{struct_name.replace("LDK","")}_free(this.ptr);
961 return out_opaque_struct_human
963 def map_tuple(self, struct_name):
964 return self.map_opaque_struct(struct_name, "A Tuple")
966 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):
969 out_java_struct = None
971 out_java += ("\tpublic static native ")
972 out_c += (self.c_fn_ty_pfx)
973 out_c += (return_type_info.c_ty)
974 out_java += (return_type_info.java_ty)
975 if return_type_info.ret_conv is not None:
976 ret_conv_pfx, ret_conv_sfx = return_type_info.ret_conv
977 out_java += (" " + method_name + "(")
978 out_c += (" " + self.c_fn_name_define_pfx(method_name, True))
980 method_argument_string = ""
981 native_call_argument_string = ""
982 for idx, arg_conv_info in enumerate(argument_types):
984 method_argument_string += (", ")
985 native_call_argument_string += ', '
987 if arg_conv_info.c_ty != "void":
988 out_c += (arg_conv_info.c_ty + " " + arg_conv_info.arg_name)
989 needs_encoding = arg_conv_info.c_ty in self.wasm_encoding_map
990 native_argument = arg_conv_info.arg_name
992 converter = self.wasm_encoding_map[arg_conv_info.c_ty]
993 native_argument = f"{converter}({arg_conv_info.arg_name})"
994 method_argument_string += f"{arg_conv_info.arg_name}: {arg_conv_info.java_ty}"
995 native_call_argument_string += native_argument
997 has_return_value = return_type_info.c_ty != 'void'
998 needs_decoding = return_type_info.c_ty in self.wasm_decoding_map
999 return_statement = 'return nativeResponseValue;'
1000 if not has_return_value:
1001 return_statement = '// debug statements here'
1002 elif needs_decoding:
1003 converter = self.wasm_decoding_map[return_type_info.c_ty]
1004 return_statement = f"return {converter}(nativeResponseValue);"
1006 out_java = f"""\texport function {method_name}({method_argument_string}): {return_type_info.java_ty} {{
1007 if(!isWasmInitialized) {{
1008 throw new Error("initializeWasm() must be awaited first!");
1010 const nativeResponseValue = wasm.{method_name}({native_call_argument_string});
1015 out_java_struct = ""
1017 out_java_struct += ("\t// Skipped " + method_name + "\n")
1020 out_java_struct += (
1021 "\tpublic static " + return_type_info.java_hu_ty + " constructor_" + meth_n + "(")
1023 out_java_struct += ("\tpublic " + return_type_info.java_hu_ty + " " + meth_n + "(")
1024 for idx, arg in enumerate(argument_types):
1026 if not takes_self or idx > 1:
1027 out_java_struct += (", ")
1030 if arg.java_ty != "void":
1031 if arg.arg_name in default_constructor_args:
1032 for explode_idx, explode_arg in enumerate(default_constructor_args[arg.arg_name]):
1033 if explode_idx != 0:
1034 out_java_struct += (", ")
1035 out_java_struct += (
1036 explode_arg.java_hu_ty + " " + arg.arg_name + "_" + explode_arg.arg_name)
1038 out_java_struct += (arg.java_hu_ty + " " + arg.arg_name)
1041 if out_java_struct is not None:
1042 out_java_struct += (") {\n")
1043 for info in argument_types:
1044 if info.arg_conv is not None:
1045 out_c += ("\t" + info.arg_conv.replace('\n', "\n\t") + "\n")
1046 if return_type_info.ret_conv is not None:
1047 out_c += ("\t" + ret_conv_pfx.replace('\n', '\n\t'))
1048 elif return_type_info.c_ty != "void":
1049 out_c += ("\t" + return_type_info.c_ty + " ret_val = ")
1052 if c_call_string is None:
1053 out_c += (method_name + "(")
1055 out_c += (c_call_string)
1056 for idx, info in enumerate(argument_types):
1057 if info.arg_conv_name is not None:
1060 elif c_call_string is not None:
1062 out_c += (info.arg_conv_name)
1064 if return_type_info.ret_conv is not None:
1065 out_c += (ret_conv_sfx.replace('\n', '\n\t'))
1068 for info in argument_types:
1069 if info.arg_conv_cleanup is not None:
1070 out_c += ("\n\t" + info.arg_conv_cleanup.replace("\n", "\n\t"))
1071 if return_type_info.ret_conv is not None:
1072 out_c += ("\n\treturn " + return_type_info.ret_conv_name + ";")
1073 elif return_type_info.c_ty != "void":
1074 out_c += ("\n\treturn ret_val;")
1075 out_c += ("\n}\n\n")
1078 out_java_struct += ("\t\t")
1079 if return_type_info.java_ty != "void":
1080 out_java_struct += (return_type_info.java_ty + " ret = ")
1081 out_java_struct += ("bindings." + method_name + "(")
1082 for idx, info in enumerate(argument_types):
1084 out_java_struct += (", ")
1085 if idx == 0 and takes_self:
1086 out_java_struct += ("this.ptr")
1087 elif info.arg_name in default_constructor_args:
1088 out_java_struct += ("bindings." + info.java_hu_ty + "_new(")
1089 for explode_idx, explode_arg in enumerate(default_constructor_args[info.arg_name]):
1090 if explode_idx != 0:
1091 out_java_struct += (", ")
1092 expl_arg_name = info.arg_name + "_" + explode_arg.arg_name
1093 if explode_arg.from_hu_conv is not None:
1094 out_java_struct += (
1095 explode_arg.from_hu_conv[0].replace(explode_arg.arg_name, expl_arg_name))
1097 out_java_struct += (expl_arg_name)
1098 out_java_struct += (")")
1099 elif info.from_hu_conv is not None:
1100 out_java_struct += (info.from_hu_conv[0])
1102 out_java_struct += (info.arg_name)
1103 out_java_struct += (");\n")
1104 if return_type_info.to_hu_conv is not None:
1106 out_java_struct += ("\t\t" + return_type_info.to_hu_conv.replace("\n", "\n\t\t").replace("this",
1107 return_type_info.to_hu_conv_name) + "\n")
1109 out_java_struct += ("\t\t" + return_type_info.to_hu_conv.replace("\n", "\n\t\t") + "\n")
1111 for idx, info in enumerate(argument_types):
1112 if idx == 0 and takes_self:
1114 elif info.arg_name in default_constructor_args:
1115 for explode_arg in default_constructor_args[info.arg_name]:
1116 expl_arg_name = info.arg_name + "_" + explode_arg.arg_name
1117 if explode_arg.from_hu_conv is not None and return_type_info.to_hu_conv_name:
1118 out_java_struct += ("\t\t" + explode_arg.from_hu_conv[1].replace(explode_arg.arg_name,
1119 expl_arg_name).replace(
1120 "this", return_type_info.to_hu_conv_name) + ";\n")
1121 elif info.from_hu_conv is not None and info.from_hu_conv[1] != "":
1122 if not takes_self and return_type_info.to_hu_conv_name is not None:
1123 out_java_struct += (
1124 "\t\t" + info.from_hu_conv[1].replace("this", return_type_info.to_hu_conv_name).replace("\n", "\n\t\t") + ";\n")
1126 out_java_struct += ("\t\t" + info.from_hu_conv[1].replace("\n", "\n\t\t") + ";\n")
1128 if return_type_info.to_hu_conv_name is not None:
1129 out_java_struct += ("\t\treturn " + return_type_info.to_hu_conv_name + ";\n")
1130 elif return_type_info.java_ty != "void" and return_type_info.rust_obj != "LDK" + struct_meth:
1131 out_java_struct += ("\t\treturn ret;\n")
1132 out_java_struct += ("\t}\n\n")
1134 return (out_java, out_c, out_java_struct)