X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=typescript_strings.py;h=d595e4d2351470ae4f86eb4fe666ec2b783df9da;hb=153c5653d39ca5dc40e4cd9bfbab41936b850768;hp=621b62eebe04af7bf31d3502273c16d58a6f0603;hpb=18a58ec41f1775502365e58fe0e8bc467755c33a;p=ldk-java diff --git a/typescript_strings.py b/typescript_strings.py index 621b62ee..d595e4d2 100644 --- a/typescript_strings.py +++ b/typescript_strings.py @@ -76,9 +76,6 @@ public static native long new_empty_slice_vec(); self.bindings_footer = "" - self.util_fn_pfx = "" - self.util_fn_sfx = "" - self.common_base = """ function freer(f: () => void) { f() } const finalizer = new FinalizationRegistry(freer); @@ -97,10 +94,40 @@ export default class CommonBase { finalizer.register(this, get_freeer(ptr, free_fn)); } } - public _test_only_get_ptr(): number { return this.ptr; } + // 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.txout_defn = """export class TxOut extends CommonBase { + /** The script_pubkey in this output */ + public script_pubkey: Uint8Array; + /** The value, in satoshis, of this output */ + public value: number; + + /* @internal */ + public constructor(_dummy: object, ptr: number) { + super(ptr, bindings.TxOut_free); + this.script_pubkey = bindings.TxOut_get_script_pubkey(ptr); + this.value = bindings.TxOut_get_value(ptr); + } + public constructor_new(value: number, script_pubkey: Uint8Array): TxOut { + return new TxOut(null, bindings.TxOut_new(script_pubkey, value)); + } +}""" + self.obj_defined(["TxOut"], "structs") + self.c_file_pfx = """#include "js-wasm.h" #include #include @@ -294,8 +321,11 @@ void __attribute__((visibility("default"))) TS_free(uint32_t ptr) { self.hu_struct_file_prefix = """ import CommonBase from './CommonBase.mjs'; import * as bindings from '../bindings.mjs' +import * as InternalUtils from '../InternalUtils.mjs' """ + self.util_fn_pfx = self.hu_struct_file_prefix + "\nexport class UtilMethods extends CommonBase {\n" + self.util_fn_sfx = "}" self.c_fn_ty_pfx = "" self.file_ext = ".mts" self.ptr_c_ty = "uint32_t" @@ -305,6 +335,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): @@ -339,6 +375,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): @@ -349,13 +388,9 @@ import * as bindings from '../bindings.mjs' def wasm_import_header(self, target): res = """ -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'}); @@ -422,16 +457,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; @@ -439,7 +474,7 @@ const encodeUint32Array = (inputArray) => { const getArrayLength = (arrayPointer) => { const arraySizeViewer = new Uint32Array( - memory.buffer, // value + wasm.memory.buffer, // value arrayPointer, // offset 1 // one int ); @@ -448,7 +483,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 ); @@ -463,7 +498,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 ); @@ -481,7 +516,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 ); @@ -493,7 +528,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 = ''; @@ -516,6 +551,25 @@ const decodeString = (stringPointer, free = true) => { 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" @@ -549,6 +603,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): @@ -579,13 +634,13 @@ const decodeString = (stringPointer, free = true) => { if var.from_hu_conv is not None: super_instantiator += ", " + var.from_hu_conv[0] if var.from_hu_conv[1] != "": - pointer_to_adder += var.from_hu_conv[1] + ";\n" + pointer_to_adder += "\t\t\t" + var.from_hu_conv[1] + ";\n" else: super_instantiator += ", " + first_to_lower(var.arg_name) else: constructor_arguments += f", {first_to_lower(var[1])}?: bindings.{var[0]}" super_instantiator += ", " + first_to_lower(var[1]) - pointer_to_adder += "this.ptrs_to.push(" + first_to_lower(var[1]) + ");\n" + pointer_to_adder += "\t\t\tthis.ptrs_to.push(" + first_to_lower(var[1]) + ");\n" impl_constructor_arguments += f", {first_to_lower(var[1])}_impl: {var[0].replace('LDK', '')}.{var[0].replace('LDK', '')}Interface" # BUILD INTERFACE METHODS @@ -595,8 +650,8 @@ const decodeString = (stringPointer, free = true) => { for fn_line in field_function_lines: java_method_descriptor = "" if fn_line.fn_name != "free" and fn_line.fn_name != "cloned": - out_java_interface += fn_line.fn_name + "(" - out_interface_implementation_overrides += f"{fn_line.fn_name} (" + out_java_interface += "\t" + fn_line.fn_name + "(" + out_interface_implementation_overrides += f"\t\t\t{fn_line.fn_name} (" for idx, arg_conv_info in enumerate(fn_line.args_ty): if idx >= 1: @@ -605,22 +660,20 @@ const decodeString = (stringPointer, free = true) => { out_java_interface += f"{arg_conv_info.arg_name}: {arg_conv_info.java_hu_ty}" out_interface_implementation_overrides += f"{arg_conv_info.arg_name}: {arg_conv_info.java_ty}" java_method_descriptor += arg_conv_info.java_fn_ty_arg - out_java_interface += f"): {fn_line.ret_ty_info.java_hu_ty};\n\t\t\t\t" + out_java_interface += f"): {fn_line.ret_ty_info.java_hu_ty};\n" java_method_descriptor += ")" + fn_line.ret_ty_info.java_fn_ty_arg java_methods.append((fn_line.fn_name, java_method_descriptor)) out_interface_implementation_overrides += f"): {fn_line.ret_ty_info.java_ty} {{\n" - interface_method_override_inset = "\t\t\t\t\t\t" - interface_implementation_inset = "\t\t\t\t\t\t\t" for arg_info in fn_line.args_ty: if arg_info.to_hu_conv is not None: - out_interface_implementation_overrides += interface_implementation_inset + arg_info.to_hu_conv.replace("\n", "\n\t\t\t\t") + "\n" + out_interface_implementation_overrides += "\t\t\t\t" + arg_info.to_hu_conv.replace("\n", "\n\t\t\t\t") + "\n" if fn_line.ret_ty_info.java_ty != "void": - out_interface_implementation_overrides += interface_implementation_inset + fn_line.ret_ty_info.java_hu_ty + " ret = arg." + fn_line.fn_name + "(" + out_interface_implementation_overrides += "\t\t\t\tconst ret: " + fn_line.ret_ty_info.java_hu_ty + " = arg." + fn_line.fn_name + "(" else: - out_interface_implementation_overrides += f"{interface_implementation_inset}arg." + fn_line.fn_name + "(" + out_interface_implementation_overrides += f"\t\t\t\targ." + fn_line.fn_name + "(" for idx, arg_info in enumerate(fn_line.args_ty): if idx != 0: @@ -633,17 +686,17 @@ const decodeString = (stringPointer, free = true) => { out_interface_implementation_overrides += ");\n" if fn_line.ret_ty_info.java_ty != "void": if fn_line.ret_ty_info.from_hu_conv is not None: - 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" + out_interface_implementation_overrides += "\t\t\t\t" + f"const result: {fn_line.ret_ty_info.java_ty} = " + fn_line.ret_ty_info.from_hu_conv[0].replace("\n", "\n\t\t\t\t") + ";\n" if fn_line.ret_ty_info.from_hu_conv[1] != "": - 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" + out_interface_implementation_overrides += "\t\t\t\t" + fn_line.ret_ty_info.from_hu_conv[1].replace("this", "impl_holder.held").replace("\n", "\n\t\t\t\t") + ";\n" #if fn_line.ret_ty_info.rust_obj in result_types: # XXX: We need to handle this in conversion logic so that its cross-language! # Avoid double-free by breaking the result - we should learn to clone these and then we can be safe instead # out_interface_implementation_overrides = out_interface_implementation_overrides + "\t\t\t\tret.ptr = 0;\n" - out_interface_implementation_overrides = out_interface_implementation_overrides + "\t\t\t\treturn result;\n" + out_interface_implementation_overrides += "\t\t\t\treturn result;\n" else: - out_interface_implementation_overrides = out_interface_implementation_overrides + "\t\t\t\treturn ret;\n" - out_interface_implementation_overrides += f"{interface_method_override_inset}}},\n\n{interface_method_override_inset}" + out_interface_implementation_overrides += "\t\t\t\treturn ret;\n" + out_interface_implementation_overrides += f"\t\t\t}},\n" trait_constructor_arguments = "" for var in field_var_conversions: @@ -666,9 +719,15 @@ const decodeString = (stringPointer, free = true) => { out_typescript_human = f""" {self.hu_struct_file_prefix} -{struct_name.replace("LDK","")} extends CommonBase {{ +export interface {struct_name.replace("LDK", "")}Interface {{ +{out_java_interface}}} + +class {struct_name}Holder {{ + held: {struct_name.replace("LDK", "")}; +}} - bindings_instance?: bindings.{struct_name}; +export class {struct_name.replace("LDK","")} extends CommonBase {{ + private bindings_instance?: bindings.{struct_name}; constructor(ptr?: number, arg?: bindings.{struct_name}{constructor_arguments}) {{ if (Number.isFinite(ptr)) {{ @@ -676,27 +735,17 @@ const decodeString = (stringPointer, free = true) => { this.bindings_instance = null; }} else {{ // TODO: private constructor instantiation - super(bindings.{struct_name}_new(arg{super_instantiator})); + super(bindings.{struct_name}_new(arg{super_instantiator}), bindings.{struct_name.replace("LDK","")}_free); this.ptrs_to.push(arg); - {pointer_to_adder} - }} +{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} - }}; + let structImplementation = {{ +{out_interface_implementation_overrides} }} as bindings.{struct_name}; 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", "")}; + return impl_holder.held; }} """ @@ -723,8 +772,8 @@ const decodeString = (stringPointer, free = true) => { out_typescript_bindings += f", {var[1]}: {var[0]}" out_typescript_bindings += f"""): number {{ - throw new Error('unimplemented'); // TODO: bind to WASM - }} + throw new Error('unimplemented'); // TODO: bind to WASM + }} """ out_typescript_bindings += '\n// OUT_TYPESCRIPT_BINDINGS :: MAP_TRAIT :: END\n\n\n' @@ -960,6 +1009,7 @@ const decodeString = (stringPointer, free = true) => { out_c += ("\t}\n}\n") 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): @@ -978,11 +1028,70 @@ export class {hu_name} extends CommonBase {implementations}{{ }} """ + 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