X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=typescript_strings.py;h=d76318f3752feeac83a12fbb7d3dce564b40e230;hb=5e2e8f6fdee605dd8e1c674f054d64f1085691fc;hp=914c0189cf0167dd3fcf9dafa616f2eeb306e383;hpb=fd56c3464060f7df8ec0c21a831682d7b085fd10;p=ldk-java diff --git a/typescript_strings.py b/typescript_strings.py index 914c0189..d76318f3 100644 --- a/typescript_strings.py +++ b/typescript_strings.py @@ -11,8 +11,9 @@ class Target(Enum): BROWSER = 2 class Consts: - def __init__(self, DEBUG: bool, target: Target, **kwargs): - + def __init__(self, DEBUG: bool, target: Target, outdir: str, **kwargs): + self.outdir = outdir + self.struct_file_suffixes = {} self.c_type_map = dict( uint8_t = ['number', 'Uint8Array'], uint16_t = ['number', 'Uint16Array'], @@ -79,15 +80,37 @@ public static native long new_empty_slice_vec(); self.util_fn_sfx = "" self.common_base = """ - export default class CommonBase { - ptr: number; - ptrs_to: object[] = []; // new LinkedList(); TODO: build linked list implementation - protected constructor(ptr: number) { this.ptr = ptr; } - public _test_only_get_ptr(): number { return this.ptr; } - protected finalize() { - // TODO: finalize myself - } - } +function freer(f: () => void) { f() } +const finalizer = new FinalizationRegistry(freer); +function get_freeer(ptr: number, free_fn: (number) => void) { + return () => { + free_fn(ptr); + } +} + +export default class CommonBase { + protected ptr: number; + protected ptrs_to: object[] = []; + protected constructor(ptr: number, free_fn: (ptr: number) => void) { + this.ptr = ptr; + if (Number.isFinite(ptr) && ptr != 0){ + finalizer.register(this, get_freeer(ptr, free_fn)); + } + } + // In Java, protected means "any subclass can access fields on any other subclass'" + // In TypeScript, protected means "any subclass can access parent fields on instances of itself" + // To work around this, we add accessors for other instances' protected fields here. + protected static add_ref_from(holder: CommonBase, referent: object) { + holder.ptrs_to.push(referent); + } + protected static get_ptr_of(o: CommonBase) { + return o.ptr; + } + protected static set_null_skip_free(o: CommonBase) { + o.ptr = 0; + finalizer.unregister(o); + } +} """ self.c_file_pfx = """#include "js-wasm.h" @@ -280,9 +303,10 @@ void __attribute__((visibility("default"))) TS_free(uint32_t ptr) { self.c_version_file = "" - self.hu_struct_file_prefix = f""" -import CommonBase from './CommonBase'; + self.hu_struct_file_prefix = """ +import CommonBase from './CommonBase.mjs'; import * as bindings from '../bindings.mjs' +import * as InternalUtils from '../InternalUtils.mjs' """ self.c_fn_ty_pfx = "" @@ -294,6 +318,12 @@ import * as bindings from '../bindings.mjs' self.is_arr_some_check = ("", " != 0") self.get_native_arr_len_call = ("", "->arr_len") + with open(outdir + "/InternalUtils.mts", "w") as f: + f.write("export function check_arr_len(arr: Uint8Array, len: number): Uint8Array {\n") + f.write("\tif (arr.length != len) { throw new Error(\"Expected array of length \" + len + \"got \" + arr.length); }\n") + f.write("\treturn arr;\n") + f.write("}") + def release_native_arr_ptr_call(self, ty_info, arr_var, arr_ptr_var): return None def create_native_arr_call(self, arr_len, ty_info): @@ -328,6 +358,9 @@ import * as bindings from '../bindings.mjs' else: return None + def map_hu_array_elems(self, arr_name, conv_name, arr_ty, elem_ty): + return arr_name + " != null ? " + arr_name + ".map(" + conv_name + " => " + elem_ty.from_hu_conv[0] + ") : null" + def str_ref_to_native_call(self, var_name, str_len): return "str_ref_to_ts(" + var_name + ", " + str_len + ")" def str_ref_to_c_call(self, var_name): @@ -338,15 +371,9 @@ import * as bindings from '../bindings.mjs' def wasm_import_header(self, target): res = """ -function freer(f: () => void) { f() } -const finalizer = new FinalizationRegistry(freer); -const memory = new WebAssembly.Memory({initial: 256}); - const imports: any = {}; imports.env = {}; -imports.env.memoryBase = 0; -imports.env.memory = memory; imports.env.tableBase = 0; imports.env.table = new WebAssembly.Table({initial: 4, element: 'anyfunc'}); @@ -413,16 +440,16 @@ const nextMultipleOfFour = (value: number) => { const encodeUint8Array = (inputArray) => { const cArrayPointer = wasm.TS_malloc(inputArray.length + 4); - const arrayLengthView = new Uint32Array(memory.buffer, cArrayPointer, 1); + const arrayLengthView = new Uint32Array(wasm.memory.buffer, cArrayPointer, 1); arrayLengthView[0] = inputArray.length; - const arrayMemoryView = new Uint8Array(memory.buffer, cArrayPointer + 4, inputArray.length); + const arrayMemoryView = new Uint8Array(wasm.memory.buffer, cArrayPointer + 4, inputArray.length); arrayMemoryView.set(inputArray); return cArrayPointer; } const encodeUint32Array = (inputArray) => { const cArrayPointer = wasm.TS_malloc((inputArray.length + 1) * 4); - const arrayMemoryView = new Uint32Array(memory.buffer, cArrayPointer, inputArray.length); + const arrayMemoryView = new Uint32Array(wasm.memory.buffer, cArrayPointer, inputArray.length); arrayMemoryView.set(inputArray, 1); arrayMemoryView[0] = inputArray.length; return cArrayPointer; @@ -430,7 +457,7 @@ const encodeUint32Array = (inputArray) => { const getArrayLength = (arrayPointer) => { const arraySizeViewer = new Uint32Array( - memory.buffer, // value + wasm.memory.buffer, // value arrayPointer, // offset 1 // one int ); @@ -439,7 +466,7 @@ const getArrayLength = (arrayPointer) => { const decodeUint8Array = (arrayPointer, free = true) => { const arraySize = getArrayLength(arrayPointer); const actualArrayViewer = new Uint8Array( - memory.buffer, // value + wasm.memory.buffer, // value arrayPointer + 4, // offset (ignoring length bytes) arraySize // uint8 count ); @@ -454,7 +481,7 @@ const decodeUint8Array = (arrayPointer, free = true) => { const decodeUint32Array = (arrayPointer, free = true) => { const arraySize = getArrayLength(arrayPointer); const actualArrayViewer = new Uint32Array( - memory.buffer, // value + wasm.memory.buffer, // value arrayPointer + 4, // offset (ignoring length bytes) arraySize // uint32 count ); @@ -472,7 +499,7 @@ const encodeString = (string) => { const memoryNeed = nextMultipleOfFour(string.length + 1); const stringPointer = wasm.TS_malloc(memoryNeed); const stringMemoryView = new Uint8Array( - memory.buffer, // value + wasm.memory.buffer, // value stringPointer, // offset string.length + 1 // length ); @@ -484,7 +511,7 @@ const encodeString = (string) => { } const decodeString = (stringPointer, free = true) => { - const memoryView = new Uint8Array(memory.buffer, stringPointer); + const memoryView = new Uint8Array(wasm.memory.buffer, stringPointer); let cursor = 0; let result = ''; @@ -504,6 +531,28 @@ const decodeString = (stringPointer, free = true) => { def init_str(self): return "" + def var_decl_statement(self, ty_string, var_name, statement): + return "const " + var_name + ": " + ty_string + " = " + statement + + def for_n_in_range(self, n, minimum, maximum): + return "for (var " + n + " = " + minimum + "; " + n + " < " + maximum + "; " + n + "++) {" + def for_n_in_arr(self, n, arr_name, arr_elem_ty): + return (arr_name + ".forEach((" + n + ": " + arr_elem_ty.java_hu_ty + ") => { ", " })") + + def get_ptr(self, var): + return "CommonBase.get_ptr_of(" + var + ")" + def set_null_skip_free(self, var): + return "CommonBase.set_null_skip_free(" + var + ");" + + def add_ref(self, holder, referent): + return "CommonBase.add_ref_from(" + holder + ", " + referent + ")" + + def obj_defined(self, struct_names, folder): + with open(self.outdir + "/index.mts", 'a') as index: + index.write(f"export * from './{folder}/{struct_names[0]}.mjs';\n") + with open(self.outdir + "/imports.mts.part", 'a') as imports: + imports.write(f"import {{ {', '.join(struct_names)} }} from '../{folder}/{struct_names[0]}.mjs';\n") + def native_c_unitary_enum_map(self, struct_name, variants, enum_doc_comment): out_c = "static inline LDK" + struct_name + " LDK" + struct_name + "_from_js(int32_t ord) {\n" out_c = out_c + "\tswitch (ord) {\n" @@ -537,6 +586,7 @@ const decodeString = (stringPointer, free = true) => { }} """ out_typescript_enum = f"export {{ {struct_name} }} from \"../bindings.mjs\";" + self.obj_defined([struct_name], "enums") return (out_c, out_typescript_enum, out_typescript) def c_unitary_enum_to_native_call(self, ty_info): @@ -652,48 +702,40 @@ const decodeString = (stringPointer, free = true) => { trait_constructor_arguments += ", " + suparg[1] out_typescript_human = f""" - {self.hu_struct_file_prefix} - - export class {struct_name.replace("LDK","")} extends CommonBase {{ - - bindings_instance?: bindings.{struct_name}; - - constructor(ptr?: number, arg?: bindings.{struct_name}{constructor_arguments}) {{ - if (Number.isFinite(ptr)) {{ - super(ptr); - this.bindings_instance = null; - }} else {{ - // TODO: private constructor instantiation - super(bindings.{struct_name}_new(arg{super_instantiator})); - this.ptrs_to.push(arg); - {pointer_to_adder} - }} - }} - - protected finalize() {{ - if (this.ptr != 0) {{ - bindings.{struct_name.replace("LDK","")}_free(this.ptr); - }} - super.finalize(); - }} - - static new_impl(arg: {struct_name.replace("LDK", "")}Interface{impl_constructor_arguments}): {struct_name.replace("LDK", "")} {{ - const impl_holder: {struct_name}Holder = new {struct_name}Holder(); - let structImplementation = {{ - // todo: in-line interface filling - {out_interface_implementation_overrides} - }}; - impl_holder.held = new {struct_name.replace("LDK", "")} (null, structImplementation{trait_constructor_arguments}); - }} - }} +{self.hu_struct_file_prefix} - export interface {struct_name.replace("LDK", "")}Interface {{ - {out_java_interface} - }} +{struct_name.replace("LDK","")} extends CommonBase {{ - class {struct_name}Holder {{ - held: {struct_name.replace("LDK", "")}; - }} + bindings_instance?: bindings.{struct_name}; + + constructor(ptr?: number, arg?: bindings.{struct_name}{constructor_arguments}) {{ + if (Number.isFinite(ptr)) {{ + super(ptr, bindings.{struct_name.replace("LDK","")}_free); + this.bindings_instance = null; + }} else {{ + // TODO: private constructor instantiation + super(bindings.{struct_name}_new(arg{super_instantiator})); + this.ptrs_to.push(arg); + {pointer_to_adder} + }} + }} + + static new_impl(arg: {struct_name.replace("LDK", "")}Interface{impl_constructor_arguments}): {struct_name.replace("LDK", "")} {{ + const impl_holder: {struct_name}Holder = new {struct_name}Holder(); + let structImplementation = {{ + // todo: in-line interface filling + {out_interface_implementation_overrides} + }}; + impl_holder.held = new {struct_name.replace("LDK", "")} (null, structImplementation{trait_constructor_arguments}); + }} + + export interface {struct_name.replace("LDK", "")}Interface {{ + {out_java_interface} + }} + + class {struct_name}Holder {{ + held: {struct_name.replace("LDK", "")}; + }} """ out_typescript_bindings += "\t\texport interface " + struct_name + " {\n" @@ -880,21 +922,21 @@ const decodeString = (stringPointer, free = true) => { return "" def map_complex_enum(self, struct_name, variant_list, camel_to_snake, enum_doc_comment): - java_hu_type = struct_name.replace("LDK", "") + bindings_type = struct_name.replace("LDK", "") + java_hu_type = struct_name.replace("LDK", "").replace("COption", "Option") out_java_enum = "" out_java = "" out_c = "" out_java_enum += (self.hu_struct_file_prefix) - out_java_enum += ("export default class " + java_hu_type + " extends CommonBase {\n") - out_java_enum += ("\tprotected constructor(_dummy: object, ptr: number) { super(ptr); }\n") - out_java_enum += ("\tprotected finalize() {\n") - out_java_enum += ("\t\tsuper.finalize();\n") - out_java_enum += ("\t\tif (this.ptr != 0) { bindings." + java_hu_type + "_free(this.ptr); }\n") - out_java_enum += ("\t}\n") - out_java_enum += f"\tstatic constr_from_ptr(ptr: number): {java_hu_type} {{\n" - out_java_enum += (f"\t\tconst raw_val: bindings.{struct_name} = bindings." + struct_name + "_ref_from_ptr(ptr);\n") + + java_hu_class = "" + java_hu_class += "export class " + java_hu_type + " extends CommonBase {\n" + java_hu_class += "\tprotected constructor(_dummy: object, ptr: number) { super(ptr, bindings." + bindings_type + "_free); }\n" + java_hu_class += "\t/* @internal */\n" + java_hu_class += f"\tpublic static constr_from_ptr(ptr: number): {java_hu_type} {{\n" + java_hu_class += f"\t\tconst raw_val: bindings.{struct_name} = bindings." + struct_name + "_ref_from_ptr(ptr);\n" java_hu_subclasses = "" out_java += "\texport class " + struct_name + " {\n" @@ -902,9 +944,9 @@ const decodeString = (stringPointer, free = true) => { java_subclasses = "" for var in variant_list: java_subclasses += "\texport class " + struct_name + "_" + var.var_name + " extends " + struct_name + " {\n" - java_hu_subclasses = java_hu_subclasses + "export class " + var.var_name + " extends " + java_hu_type + " {\n" - out_java_enum += ("\t\tif (raw_val instanceof bindings." + struct_name + "." + var.var_name + ") {\n") - out_java_enum += ("\t\t\treturn new " + var.var_name + "(this.ptr, raw_val);\n") + java_hu_subclasses = java_hu_subclasses + "export class " + java_hu_type + "_" + var.var_name + " extends " + java_hu_type + " {\n" + java_hu_class += "\t\tif (raw_val instanceof bindings." + struct_name + "_" + var.var_name + ") {\n" + java_hu_class += "\t\t\treturn new " + java_hu_type + "_" + var.var_name + "(ptr, raw_val);\n" init_meth_params = "" hu_conv_body = "" for idx, (field_ty, field_docs) in enumerate(var.fields): @@ -920,13 +962,14 @@ const decodeString = (stringPointer, free = true) => { init_meth_params += "public " + field_ty.arg_name + ": " + field_ty.java_ty java_subclasses += "\t\tconstructor(" + init_meth_params + ") { super(); }\n" java_subclasses += "\t}\n" - out_java_enum += ("\t\t}\n") - java_hu_subclasses = java_hu_subclasses + "\tprivate constructor(ptr: number, obj: bindings." + struct_name + "." + var.var_name + ") {\n\t\tsuper(null, ptr);\n" + java_hu_class += "\t\t}\n" + java_hu_subclasses += "\t/* @internal */\n" + java_hu_subclasses += "\tpublic constructor(ptr: number, obj: bindings." + struct_name + "_" + var.var_name + ") {\n\t\tsuper(null, ptr);\n" java_hu_subclasses = java_hu_subclasses + hu_conv_body java_hu_subclasses = java_hu_subclasses + "\t}\n}\n" out_java += ("\t}\n") out_java += java_subclasses - out_java_enum += ("\t\tthrow new Error('oops, this should be unreachable'); // Unreachable without extending the (internal) bindings interface\n\t}\n\n") + java_hu_class += "\t\tthrow new Error('oops, this should be unreachable'); // Unreachable without extending the (internal) bindings interface\n\t}\n\n" out_java += self.fn_call_body(struct_name + "_ref_from_ptr", "uint32_t", "number", "ptr: number", "ptr") 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") @@ -953,43 +996,91 @@ const decodeString = (stringPointer, free = true) => { out_c += ("\t\t}\n") out_c += ("\t\tdefault: abort();\n") out_c += ("\t}\n}\n") - out_java_enum += ("}\n") - out_java_enum += (java_hu_subclasses) + out_java_enum += java_hu_class + self.struct_file_suffixes[java_hu_type] = java_hu_subclasses + self.obj_defined([java_hu_type], "structs") return (out_java, out_java_enum, out_c) def map_opaque_struct(self, struct_name, struct_doc_comment): implementations = "" method_header = "" if struct_name.startswith("LDKLocked"): - implementations += "implements AutoCloseable " - method_header = """ - public close() { -""" - else: - method_header = """ - protected finalize() { - super.finalize(); -""" + return "NOT IMPLEMENTED" - out_opaque_struct_human = f""" - {self.hu_struct_file_prefix} + hu_name = struct_name.replace("LDKC2Tuple", "TwoTuple").replace("LDKC3Tuple", "ThreeTuple").replace("LDK", "") + out_opaque_struct_human = f"""{self.hu_struct_file_prefix} - export default class {struct_name.replace("LDK","")} extends CommonBase {implementations}{{ - constructor(_dummy: object, ptr: number) {{ - super(ptr); - }} +export class {hu_name} extends CommonBase {implementations}{{ + /* @internal */ + public constructor(_dummy: object, ptr: number) {{ + super(ptr, bindings.{struct_name.replace("LDK","")}_free); + }} - {method_header} - if (this.ptr != 0) {{ - bindings.{struct_name.replace("LDK","")}_free(this.ptr); - }} - }} """ + self.obj_defined([hu_name], "structs") return out_opaque_struct_human def map_tuple(self, struct_name): return self.map_opaque_struct(struct_name, "A Tuple") + def map_result(self, struct_name, res_map, err_map): + human_ty = struct_name.replace("LDKCResult", "Result") + + suffixes = f"export class {human_ty}_OK extends {human_ty} {{\n" + if res_map.java_hu_ty != "void": + suffixes += "\tpublic res: " + res_map.java_hu_ty + ";\n" + suffixes += f""" + /* @internal */ + public constructor(_dummy: object, ptr: number) {{ + super(_dummy, ptr); +""" + if res_map.java_hu_ty == "void": + pass + elif res_map.to_hu_conv is not None: + suffixes += "\t\tconst res: " + res_map.java_ty + " = bindings." + struct_name.replace("LDK", "") + "_get_ok(ptr);\n" + suffixes += "\t\t" + res_map.to_hu_conv.replace("\n", "\n\t\t") + suffixes += "\n\t\tthis.res = " + res_map.to_hu_conv_name + ";\n" + else: + suffixes += "\t\tthis.res = bindings." + struct_name.replace("LDK", "") + "_get_ok(ptr);\n" + suffixes += "\t}\n}\n" + + suffixes += f"export class {human_ty}_Err extends {human_ty} {{\n" + if err_map.java_hu_ty != "void": + suffixes += "\tpublic err: " + err_map.java_hu_ty + ";\n" + suffixes += f""" + /* @internal */ + public constructor(_dummy: object, ptr: number) {{ + super(_dummy, ptr); +""" + if err_map.java_hu_ty == "void": + pass + elif err_map.to_hu_conv is not None: + suffixes += "\t\tconst err: " + err_map.java_ty + " = bindings." + struct_name.replace("LDK", "") + "_get_err(ptr);\n" + suffixes += "\t\t" + err_map.to_hu_conv.replace("\n", "\n\t\t") + suffixes += "\n\t\tthis.err = " + err_map.to_hu_conv_name + ";\n" + else: + suffixes += "\t\tthis.err = bindings." + struct_name.replace("LDK", "") + "_get_err(ptr);\n" + suffixes += "\t}\n}" + + self.struct_file_suffixes[human_ty] = suffixes + self.obj_defined([human_ty], "structs") + + return f"""{self.hu_struct_file_prefix} + +export class {human_ty} extends CommonBase {{ + protected constructor(_dummy: object, ptr: number) {{ + super(ptr, bindings.{struct_name.replace("LDK","")}_free); + }} + /* @internal */ + public static constr_from_ptr(ptr: number): {human_ty} {{ + if (bindings.{struct_name.replace("LDK", "")}_is_ok(ptr)) {{ + return new {human_ty}_OK(null, ptr); + }} else {{ + return new {human_ty}_Err(null, ptr); + }} + }} +""" + def fn_call_body(self, method_name, return_c_ty, return_java_ty, method_argument_string, native_call_argument_string): has_return_value = return_c_ty != 'void' needs_decoding = return_c_ty in self.wasm_decoding_map @@ -1046,9 +1137,9 @@ const decodeString = (stringPointer, free = true) => { else: if not takes_self: out_java_struct += ( - "\tpublic static " + return_type_info.java_hu_ty + " constructor_" + meth_n + "(") + "\tpublic static constructor_" + meth_n + "(") else: - out_java_struct += ("\tpublic " + return_type_info.java_hu_ty + " " + meth_n + "(") + out_java_struct += ("\tpublic " + meth_n + "(") for idx, arg in enumerate(argument_types): if idx != 0: if not takes_self or idx > 1: @@ -1060,14 +1151,13 @@ const decodeString = (stringPointer, free = true) => { for explode_idx, explode_arg in enumerate(default_constructor_args[arg.arg_name]): if explode_idx != 0: out_java_struct += (", ") - out_java_struct += ( - explode_arg.java_hu_ty + " " + arg.arg_name + "_" + explode_arg.arg_name) + out_java_struct += arg.arg_name + "_" + explode_arg.arg_name + ": " + explode_arg.java_hu_ty else: - out_java_struct += (arg.java_hu_ty + " " + arg.arg_name) + out_java_struct += arg.arg_name + ": " + arg.java_hu_ty out_c += (") {\n") if out_java_struct is not None: - out_java_struct += (") {\n") + out_java_struct += "): " + return_type_info.java_hu_ty + " {\n" for info in argument_types: if info.arg_conv is not None: out_c += ("\t" + info.arg_conv.replace('\n', "\n\t") + "\n") @@ -1105,7 +1195,7 @@ const decodeString = (stringPointer, free = true) => { if args_known: out_java_struct += ("\t\t") if return_type_info.java_ty != "void": - out_java_struct += (return_type_info.java_ty + " ret = ") + out_java_struct += "const ret: " + return_type_info.java_ty + " = " out_java_struct += ("bindings." + method_name + "(") for idx, info in enumerate(argument_types): if idx != 0: @@ -1160,3 +1250,8 @@ const decodeString = (stringPointer, free = true) => { out_java_struct += ("\t}\n\n") return (out_java, out_c, out_java_struct) + + def cleanup(self): + for struct in self.struct_file_suffixes: + with open(self.outdir + "/structs/" + struct + self.file_ext, "a") as src: + src.write(self.struct_file_suffixes[struct])