5 print("USAGE: /path/to/lightning.h /path/to/bindings/output /path/to/bindings/ /path/to/bindings/output.c debug lang")
8 if sys.argv[5] == "false":
10 elif sys.argv[5] == "true":
13 print("debug should be true or false and indicates whether to track allocations and ensure we don't leak")
17 if sys.argv[6] == "java":
18 from java_strings import Consts
19 elif sys.argv[6] == "typescript":
20 import typescript_strings
21 from typescript_strings import Consts
22 target = typescript_strings.Target.NODEJS
23 if len(sys.argv) == 8 and sys.argv[7] == 'browser':
24 target = typescript_strings.Target.BROWSER
26 print("Only java or typescript can be set for lang")
30 consts = Consts(DEBUG, target=target)
32 from bindingstypes import *
39 def camel_to_snake(s):
40 # Convert camel case to snake case, in a way that appears to match cbindgen
46 if lastchar.isupper():
47 if not char.isupper() and not lastund:
52 ret = ret + lastchar.lower()
55 if char.isupper() and not lastund:
63 return (ret + lastchar.lower()).strip("_")
67 opaque_structs = set()
72 var_is_arr_regex = re.compile("\(\*([A-za-z0-9_]*)\)\[([a-z0-9]*)\]")
73 var_ty_regex = re.compile("([A-za-z_0-9]*)(.*)")
74 java_c_types_none_allowed = True # Unset when we do the real pass that populates the above sets
75 def java_c_types(fn_arg, ret_arr_len):
76 fn_arg = fn_arg.strip()
77 if fn_arg.startswith("MUST_USE_RES "):
80 if fn_arg.startswith("const "):
83 if fn_arg.startswith("struct "):
85 if fn_arg.startswith("enum "):
87 fn_arg = fn_arg.replace("NONNULL_PTR", "")
94 if fn_arg.startswith("LDKThirtyTwoBytes"):
95 fn_arg = "uint8_t (*" + fn_arg[18:] + ")[32]"
96 assert var_is_arr_regex.match(fn_arg[8:])
97 rust_obj = "LDKThirtyTwoBytes"
99 elif fn_arg.startswith("LDKPublicKey"):
100 fn_arg = "uint8_t (*" + fn_arg[13:] + ")[33]"
101 assert var_is_arr_regex.match(fn_arg[8:])
102 rust_obj = "LDKPublicKey"
103 arr_access = "compressed_form"
104 elif fn_arg.startswith("LDKSecretKey"):
105 fn_arg = "uint8_t (*" + fn_arg[13:] + ")[32]"
106 assert var_is_arr_regex.match(fn_arg[8:])
107 rust_obj = "LDKSecretKey"
109 elif fn_arg.startswith("LDKSignature"):
110 fn_arg = "uint8_t (*" + fn_arg[13:] + ")[64]"
111 assert var_is_arr_regex.match(fn_arg[8:])
112 rust_obj = "LDKSignature"
113 arr_access = "compact_form"
114 elif fn_arg.startswith("LDKThreeBytes"):
115 fn_arg = "uint8_t (*" + fn_arg[14:] + ")[3]"
116 assert var_is_arr_regex.match(fn_arg[8:])
117 rust_obj = "LDKThreeBytes"
119 elif fn_arg.startswith("LDKFourBytes"):
120 fn_arg = "uint8_t (*" + fn_arg[13:] + ")[4]"
121 assert var_is_arr_regex.match(fn_arg[8:])
122 rust_obj = "LDKFourBytes"
124 elif fn_arg.startswith("LDKSixteenBytes"):
125 fn_arg = "uint8_t (*" + fn_arg[16:] + ")[16]"
126 assert var_is_arr_regex.match(fn_arg[8:])
127 rust_obj = "LDKSixteenBytes"
129 elif fn_arg.startswith("LDKTenBytes"):
130 fn_arg = "uint8_t (*" + fn_arg[12:] + ")[10]"
131 assert var_is_arr_regex.match(fn_arg[8:])
132 rust_obj = "LDKTenBytes"
134 elif fn_arg.startswith("LDKu8slice"):
135 fn_arg = "uint8_t (*" + fn_arg[11:] + ")[datalen]"
136 assert var_is_arr_regex.match(fn_arg[8:])
137 rust_obj = "LDKu8slice"
139 elif fn_arg.startswith("LDKCVec_u8Z"):
140 fn_arg = "uint8_t (*" + fn_arg[12:] + ")[datalen]"
141 rust_obj = "LDKCVec_u8Z"
142 assert var_is_arr_regex.match(fn_arg[8:])
144 elif fn_arg.startswith("LDKTransaction"):
145 fn_arg = "uint8_t (*" + fn_arg[15:] + ")[datalen]"
146 rust_obj = "LDKTransaction"
147 assert var_is_arr_regex.match(fn_arg[8:])
149 elif fn_arg.startswith("LDKCVec_"):
152 fn_arg = fn_arg.replace("*", "")
155 tyn = fn_arg[8:].split(" ")
156 assert tyn[0].endswith("Z")
160 new_arg = "LDK" + tyn[0][:-1]
162 new_arg = new_arg + " " + a
163 res = java_c_types(new_arg, ret_arr_len)
165 assert java_c_types_none_allowed
168 res.pass_by_ref = True
169 if res.is_native_primitive or res.passed_as_ptr:
170 return TypeInfo(rust_obj=fn_arg.split(" ")[0], java_ty=res.java_ty + "[]", java_hu_ty=res.java_hu_ty + "[]",
171 java_fn_ty_arg="[" + res.java_fn_ty_arg, c_ty=res.c_ty + "Array", passed_as_ptr=False, is_ptr=is_ptr, is_const=is_const,
172 var_name=res.var_name, arr_len="datalen", arr_access="data", subty=res, is_native_primitive=False)
174 return TypeInfo(rust_obj=fn_arg.split(" ")[0], java_ty=res.java_ty + "[]", java_hu_ty=res.java_hu_ty + "[]",
175 java_fn_ty_arg="[" + res.java_fn_ty_arg, c_ty=consts.ptr_arr, passed_as_ptr=False, is_ptr=is_ptr, is_const=is_const,
176 var_name=res.var_name, arr_len="datalen", arr_access="data", subty=res, is_native_primitive=False)
181 java_type_plural = None
182 if fn_arg.startswith("void"):
186 fn_arg = fn_arg[4:].strip()
188 elif fn_arg.startswith("bool"):
192 fn_arg = fn_arg[4:].strip()
194 elif fn_arg.startswith("uint8_t"):
195 mapped_type = consts.c_type_map['uint8_t']
196 java_ty = mapped_type[0]
199 fn_arg = fn_arg[7:].strip()
201 elif fn_arg.startswith("uint16_t"):
202 mapped_type = consts.c_type_map['uint16_t']
203 java_ty = mapped_type[0]
206 fn_arg = fn_arg[8:].strip()
208 elif fn_arg.startswith("uint32_t"):
209 mapped_type = consts.c_type_map['uint32_t']
210 java_ty = mapped_type[0]
213 fn_arg = fn_arg[8:].strip()
215 elif fn_arg.startswith("uint64_t") or fn_arg.startswith("uintptr_t"):
216 # TODO: uintptr_t is arch-dependent :(
217 mapped_type = consts.c_type_map['uint64_t']
218 java_ty = mapped_type[0]
220 if fn_arg.startswith("uint64_t"):
222 fn_arg = fn_arg[8:].strip()
225 fn_arg = fn_arg[9:].strip()
227 elif is_const and fn_arg.startswith("char *"):
230 fn_ty_arg = "Ljava/lang/String;"
231 fn_arg = fn_arg[6:].strip()
232 elif fn_arg.startswith("LDKStr"):
235 fn_ty_arg = "Ljava/lang/String;"
236 fn_arg = fn_arg[6:].strip()
240 ma = var_ty_regex.match(fn_arg)
241 if ma.group(1).strip() in unitary_enums:
242 java_ty = ma.group(1).strip()
243 c_ty = consts.result_c_ty
244 fn_ty_arg = "Lorg/ldk/enums/" + ma.group(1).strip() + ";"
245 fn_arg = ma.group(2).strip()
246 rust_obj = ma.group(1).strip()
247 elif ma.group(1).strip().startswith("LDKC2Tuple"):
248 c_ty = consts.ptr_c_ty
249 java_ty = consts.ptr_native_ty
250 java_hu_ty = "TwoTuple<"
251 if not ma.group(1).strip() in tuple_types:
252 assert java_c_types_none_allowed
254 for idx, ty_info in enumerate(tuple_types[ma.group(1).strip()][0]):
256 java_hu_ty = java_hu_ty + ", "
257 if ty_info.is_native_primitive:
258 if ty_info.java_hu_ty == "int":
259 java_hu_ty = java_hu_ty + "Integer" # Java concrete integer type is Integer, not Int
261 java_hu_ty = java_hu_ty + ty_info.java_hu_ty.title() # If we're a primitive, capitalize the first letter
263 java_hu_ty = java_hu_ty + ty_info.java_hu_ty
264 java_hu_ty = java_hu_ty + ">"
266 fn_arg = ma.group(2).strip()
267 rust_obj = ma.group(1).strip()
269 elif ma.group(1).strip().startswith("LDKC3Tuple"):
270 c_ty = consts.ptr_c_ty
271 java_ty = consts.ptr_native_ty
272 java_hu_ty = "ThreeTuple<"
273 if not ma.group(1).strip() in tuple_types:
274 assert java_c_types_none_allowed
276 for idx, ty_info in enumerate(tuple_types[ma.group(1).strip()][0]):
278 java_hu_ty = java_hu_ty + ", "
279 if ty_info.is_native_primitive:
280 if ty_info.java_hu_ty == "int":
281 java_hu_ty = java_hu_ty + "Integer" # Java concrete integer type is Integer, not Int
283 java_hu_ty = java_hu_ty + ty_info.java_hu_ty.title() # If we're a primitive, capitalize the first letter
285 java_hu_ty = java_hu_ty + ty_info.java_hu_ty
286 java_hu_ty = java_hu_ty + ">"
288 fn_arg = ma.group(2).strip()
289 rust_obj = ma.group(1).strip()
292 c_ty = consts.ptr_c_ty
293 java_ty = consts.ptr_native_ty
294 java_hu_ty = ma.group(1).strip().replace("LDKCResult", "Result").replace("LDK", "")
296 fn_arg = ma.group(2).strip()
297 rust_obj = ma.group(1).strip()
300 if fn_arg.startswith(" *") or fn_arg.startswith("*"):
301 fn_arg = fn_arg.replace("*", "").strip()
303 c_ty = consts.ptr_c_ty
304 java_ty = consts.ptr_native_ty
308 var_is_arr = var_is_arr_regex.match(fn_arg)
309 if var_is_arr is not None or ret_arr_len is not None:
310 assert(not take_by_ptr)
312 # is there a special case for plurals?
313 if len(mapped_type) == 2:
314 java_ty = mapped_type[1]
316 java_ty = java_ty + "[]"
317 c_ty = c_ty + "Array"
318 if var_is_arr is not None:
319 if var_is_arr.group(1) == "":
320 return TypeInfo(rust_obj=rust_obj, java_ty=java_ty, java_hu_ty=java_ty, java_fn_ty_arg="[" + fn_ty_arg, c_ty=c_ty, is_const=is_const,
321 passed_as_ptr=False, is_ptr=False, var_name="arg", arr_len=var_is_arr.group(2), arr_access=arr_access, is_native_primitive=False)
322 return TypeInfo(rust_obj=rust_obj, java_ty=java_ty, java_hu_ty=java_ty, java_fn_ty_arg="[" + fn_ty_arg, c_ty=c_ty, is_const=is_const,
323 passed_as_ptr=False, is_ptr=False, var_name=var_is_arr.group(1), arr_len=var_is_arr.group(2), arr_access=arr_access, is_native_primitive=False)
325 if java_hu_ty is None:
327 return TypeInfo(rust_obj=rust_obj, java_ty=java_ty, java_hu_ty=java_hu_ty, java_fn_ty_arg=fn_ty_arg, c_ty=c_ty, passed_as_ptr=is_ptr or take_by_ptr,
328 is_const=is_const, is_ptr=is_ptr, var_name=fn_arg, arr_len=arr_len, arr_access=arr_access, is_native_primitive=is_primitive)
330 fn_ptr_regex = re.compile("^extern const ([A-Za-z_0-9\* ]*) \(\*(.*)\)\((.*)\);$")
331 fn_ret_arr_regex = re.compile("(.*) \(\*(.*)\((.*)\)\)\[([0-9]*)\];$")
332 reg_fn_regex = re.compile("([A-Za-z_0-9\* ]* \*?)([a-zA-Z_0-9]*)\((.*)\);$")
336 from gen_type_mapping import TypeMappingGenerator
337 type_mapping_generator = TypeMappingGenerator(java_c_types, consts, opaque_structs, clone_fns, unitary_enums, trait_structs, complex_enums, result_types, tuple_types)
339 with open(sys.argv[1]) as in_h:
341 reg_fn = reg_fn_regex.match(line)
342 if reg_fn is not None:
343 if reg_fn.group(2).endswith("_clone"):
344 clone_fns.add(reg_fn.group(2))
346 rty = java_c_types(reg_fn.group(1), None)
347 if rty is not None and rty.rust_obj is not None and reg_fn.group(2) == rty.java_hu_ty + "_new":
348 constructor_fns[rty.rust_obj] = reg_fn.group(3)
350 arr_fn = fn_ret_arr_regex.match(line)
351 if arr_fn is not None:
352 if arr_fn.group(2).endswith("_clone"):
353 clone_fns.add(arr_fn.group(2))
354 # No object constructors return arrays, as then they wouldn't be an object constructor
357 # Define some manual clones...
358 clone_fns.add("ThirtyTwoBytes_clone")
359 write_c("static inline struct LDKThirtyTwoBytes ThirtyTwoBytes_clone(const struct LDKThirtyTwoBytes *orig) { struct LDKThirtyTwoBytes ret; memcpy(ret.data, orig->data, 32); return ret; }\n")
361 java_c_types_none_allowed = False # C structs created by cbindgen are declared in dependency order
363 with open(sys.argv[1]) as in_h, open(sys.argv[2], "w") as out_java:
365 # Map a top-level function
366 def map_fn(line, re_match, ret_arr_len, c_call_string):
369 method_return_type = re_match.group(1)
370 method_name = re_match.group(2)
371 method_comma_separated_arguments = re_match.group(3)
372 method_arguments = method_comma_separated_arguments.split(',')
374 is_free = method_name.endswith("_free")
375 struct_meth = method_name.split("_")[0]
377 return_type_info = type_mapping_generator.map_type(method_return_type, True, ret_arr_len, False, False)
380 default_constructor_args = {}
384 for argument_index, argument in enumerate(method_arguments):
385 argument_conversion_info = type_mapping_generator.map_type(argument, False, None, is_free, True)
386 if argument_index == 0 and argument_conversion_info.java_hu_ty == struct_meth:
388 if argument_conversion_info.arg_conv is not None and "Warning" in argument_conversion_info.arg_conv:
389 if argument_conversion_info.rust_obj in constructor_fns:
391 for explode_arg in constructor_fns[argument_conversion_info.rust_obj].split(','):
392 explode_arg_conv = type_mapping_generator.map_type(explode_arg, False, None, False, True)
393 if explode_arg_conv.c_ty == "void":
394 # We actually want to handle this case, but for now its only used in NetGraphMsgHandler::new()
395 # which ends up resulting in a redundant constructor - both without arguments for the NetworkGraph.
398 if not argument_conversion_info.arg_name in default_constructor_args:
399 default_constructor_args[argument_conversion_info.arg_name] = []
400 default_constructor_args[argument_conversion_info.arg_name].append(explode_arg_conv)
401 argument_types.append(argument_conversion_info)
403 has_out_java_struct = ("LDK" + struct_meth in opaque_structs or "LDK" + struct_meth in trait_structs) and not is_free
406 out_java.write("\t// " + line)
408 (out_java_delta, out_c_delta, out_java_struct_delta) = consts.map_function(argument_types, c_call_string, is_free, method_name, return_type_info, struct_meth, default_constructor_args, takes_self, args_known, has_out_java_struct, type_mapping_generator)
410 out_java.write(out_java_delta)
413 if has_out_java_struct:
414 out_java_struct = open(f"{sys.argv[3]}/structs/{struct_meth}{consts.file_ext}", "a")
415 out_java_struct.write(out_java_struct_delta)
421 def map_unitary_enum(struct_name, field_lines):
422 with open(f"{sys.argv[3]}/enums/{struct_name}{consts.file_ext}", "w") as out_java_enum:
423 unitary_enums.add(struct_name)
424 for idx, struct_line in enumerate(field_lines):
426 assert(struct_line == "typedef enum %s {" % struct_name)
427 elif idx == len(field_lines) - 3:
428 assert(struct_line.endswith("_Sentinel,"))
429 elif idx == len(field_lines) - 2:
430 assert(struct_line == "} %s;" % struct_name)
431 elif idx == len(field_lines) - 1:
432 assert(struct_line == "")
433 (c_out, native_file_out, native_out) = consts.native_c_unitary_enum_map(struct_name, [x.strip().strip(",") for x in field_lines[1:-3]])
435 out_java_enum.write(native_file_out)
436 out_java.write(native_out)
438 def map_complex_enum(struct_name, union_enum_items):
439 java_hu_type = struct_name.replace("LDK", "")
440 complex_enums.add(struct_name)
443 tag_field_lines = union_enum_items["field_lines"]
444 for idx, struct_line in enumerate(tag_field_lines):
446 assert(struct_line == "typedef enum %s_Tag {" % struct_name)
447 elif idx == len(tag_field_lines) - 3:
448 assert(struct_line.endswith("_Sentinel,"))
449 elif idx == len(tag_field_lines) - 2:
450 assert(struct_line == "} %s_Tag;" % struct_name)
451 elif idx == len(tag_field_lines) - 1:
452 assert(struct_line == "")
454 variant_name = struct_line.strip(' ,')[len(struct_name) + 1:]
456 if "LDK" + variant_name in union_enum_items:
457 enum_var_lines = union_enum_items["LDK" + variant_name]
458 for idx, field in enumerate(enum_var_lines):
459 if idx != 0 and idx < len(enum_var_lines) - 2:
460 fields.append(type_mapping_generator.map_type(field.strip(' ;'), False, None, False, True))
462 # TODO: Assert line format
465 # TODO: Assert line format
467 enum_variants.append(ComplexEnumVariantInfo(variant_name, fields))
469 with open(f"{sys.argv[3]}/structs/{java_hu_type}{consts.file_ext}", "w") as out_java_enum:
470 (out_java_addendum, out_java_enum_addendum, out_c_addendum) = consts.map_complex_enum(struct_name, enum_variants, camel_to_snake)
472 out_java_enum.write(out_java_enum_addendum)
473 out_java.write(out_java_addendum)
474 write_c(out_c_addendum)
476 def map_trait(struct_name, field_var_lines, trait_fn_lines):
477 with open(f"{sys.argv[3]}/structs/{struct_name.replace('LDK', '')}{consts.file_ext}", "w") as out_java_trait:
479 for var_line in field_var_lines:
480 if var_line.group(1) in trait_structs:
481 field_var_convs.append((var_line.group(1), var_line.group(2)))
483 field_var_convs.append(
484 type_mapping_generator.map_type(var_line.group(1) + " " + var_line.group(2), False, None, False, False))
487 for fn_line in trait_fn_lines:
488 ret_ty_info = type_mapping_generator.map_type(fn_line.group(2), True, None, False, False)
489 is_const = fn_line.group(4) is not None
492 for idx, arg in enumerate(fn_line.group(5).split(',')):
495 arg_conv_info = type_mapping_generator.map_type(arg, True, None, False, False)
496 arg_tys.append(arg_conv_info)
497 field_fns.append(TraitMethInfo(fn_line.group(3), is_const, ret_ty_info, arg_tys))
499 (out_java_addendum, out_java_trait_addendum, out_c_addendum) = consts.native_c_map_trait(struct_name, field_var_convs, field_fns)
500 write_c(out_c_addendum)
501 out_java_trait.write(out_java_trait_addendum)
502 out_java.write(out_java_addendum)
504 for fn_line in trait_fn_lines:
505 # For now, just disable enabling the _call_log - we don't know how to inverse-map String
506 is_log = fn_line.group(3) == "log" and struct_name == "LDKLogger"
507 if fn_line.group(3) != "free" and fn_line.group(3) != "clone" and fn_line.group(3) != "eq" and not is_log:
508 dummy_line = fn_line.group(2) + struct_name.replace("LDK", "") + "_" + fn_line.group(3) + " " + struct_name + "* this_arg" + fn_line.group(5) + "\n"
509 map_fn(dummy_line, re.compile("([A-Za-z_0-9]*) *([A-Za-z_0-9]*) *(.*)").match(dummy_line), None, "(this_arg_conv->" + fn_line.group(3) + ")(this_arg_conv->this_arg")
510 for idx, var_line in enumerate(field_var_lines):
511 if var_line.group(1) not in trait_structs:
512 write_c(var_line.group(1) + " " + struct_name + "_set_get_" + var_line.group(2) + "(" + struct_name + "* this_arg) {\n")
513 write_c("\tif (this_arg->set_" + var_line.group(2) + " != NULL)\n")
514 write_c("\t\tthis_arg->set_" + var_line.group(2) + "(this_arg);\n")
515 write_c("\treturn this_arg->" + var_line.group(2) + ";\n")
517 dummy_line = var_line.group(1) + " " + struct_name.replace("LDK", "") + "_get_" + var_line.group(2) + " " + struct_name + "* this_arg" + fn_line.group(5) + "\n"
518 map_fn(dummy_line, re.compile("([A-Za-z_0-9]*) *([A-Za-z_0-9]*) *(.*)").match(dummy_line), None, struct_name + "_set_get_" + var_line.group(2) + "(this_arg_conv")
520 def map_result(struct_name, res_ty, err_ty):
521 result_types.add(struct_name)
522 human_ty = struct_name.replace("LDKCResult", "Result")
523 with open(f"{sys.argv[3]}/structs/{human_ty}{consts.file_ext}", "w") as out_java_struct:
524 out_java_struct.write(consts.hu_struct_file_prefix)
525 out_java_struct.write("public class " + human_ty + " extends CommonBase {\n")
526 out_java_struct.write("\tprivate " + human_ty + "(Object _dummy, long ptr) { super(ptr); }\n")
527 out_java_struct.write("\tprotected void finalize() throws Throwable {\n")
528 out_java_struct.write("\t\tif (ptr != 0) { bindings." + struct_name.replace("LDK","") + "_free(ptr); } super.finalize();\n")
529 out_java_struct.write("\t}\n\n")
530 out_java_struct.write("\tstatic " + human_ty + " constr_from_ptr(long ptr) {\n")
531 out_java_struct.write("\t\tif (bindings." + struct_name + "_result_ok(ptr)) {\n")
532 out_java_struct.write("\t\t\treturn new " + human_ty + "_OK(null, ptr);\n")
533 out_java_struct.write("\t\t} else {\n")
534 out_java_struct.write("\t\t\treturn new " + human_ty + "_Err(null, ptr);\n")
535 out_java_struct.write("\t\t}\n")
536 out_java_struct.write("\t}\n")
538 res_map = type_mapping_generator.map_type(res_ty + " res", True, None, False, True)
539 err_map = type_mapping_generator.map_type(err_ty + " err", True, None, False, True)
541 if not res_map.is_native_primitive and (res_map.rust_obj.replace("LDK", "") + "_clone" not in clone_fns):
543 if not err_map.is_native_primitive and (err_map.rust_obj.replace("LDK", "") + "_clone" not in clone_fns):
546 out_java.write("\tpublic static native boolean " + struct_name + "_result_ok(long arg);\n")
547 write_c(consts.c_fn_ty_pfx + "jboolean " + consts.c_fn_name_define_pfx(struct_name + "_result_ok", True) + consts.ptr_c_ty + " arg) {\n")
548 write_c("\treturn ((" + struct_name + "*)arg)->result_ok;\n")
551 out_java.write("\tpublic static native " + res_map.java_ty + " " + struct_name + "_get_ok(long arg);\n")
552 write_c(consts.c_fn_ty_pfx + res_map.c_ty + " " + consts.c_fn_name_define_pfx(struct_name + "_get_ok", True) + consts.ptr_c_ty + " arg) {\n")
553 write_c("\t" + struct_name + " *val = (" + struct_name + "*)arg;\n")
554 write_c("\tCHECK(val->result_ok);\n\t")
555 out_java_struct.write("\tpublic static final class " + human_ty + "_OK extends " + human_ty + " {\n")
556 if res_map.ret_conv is not None:
557 write_c(res_map.ret_conv[0].replace("\n", "\n\t") + "(*val->contents.result)")
558 write_c(res_map.ret_conv[1].replace("\n", "\n\t") + "\n\treturn " + res_map.ret_conv_name)
560 write_c("return *val->contents.result")
563 if res_map.java_hu_ty != "void":
564 out_java_struct.write("\t\tpublic final " + res_map.java_hu_ty + " res;\n")
565 out_java_struct.write("\t\tprivate " + human_ty + "_OK(Object _dummy, long ptr) {\n")
566 out_java_struct.write("\t\t\tsuper(_dummy, ptr);\n")
567 if res_map.java_hu_ty == "void":
569 elif res_map.to_hu_conv is not None:
570 out_java_struct.write("\t\t\t" + res_map.java_ty + " res = bindings." + struct_name + "_get_ok(ptr);\n")
571 out_java_struct.write("\t\t\t" + res_map.to_hu_conv.replace("\n", "\n\t\t\t"))
572 out_java_struct.write("\n\t\t\tthis.res = " + res_map.to_hu_conv_name + ";\n")
574 out_java_struct.write("\t\t\tthis.res = bindings." + struct_name + "_get_ok(ptr);\n")
575 out_java_struct.write("\t\t}\n")
576 if struct_name.startswith("LDKCResult_None"):
577 out_java_struct.write("\t\tpublic " + human_ty + "_OK() {\n\t\t\tthis(null, bindings.C" + human_ty + "_ok());\n")
579 out_java_struct.write("\t\tpublic " + human_ty + "_OK(" + res_map.java_hu_ty + " res) {\n")
580 if res_map.from_hu_conv is not None:
581 out_java_struct.write("\t\t\tthis(null, bindings.C" + human_ty + "_ok(" + res_map.from_hu_conv[0] + "));\n")
582 if res_map.from_hu_conv[1] != "":
583 out_java_struct.write("\t\t\t" + res_map.from_hu_conv[1] + ";\n")
585 out_java_struct.write("\t\t\tthis(null, bindings.C" + human_ty + "_ok(res));\n")
586 out_java_struct.write("\t\t}\n\t}\n\n")
588 out_java.write("\tpublic static native " + err_map.java_ty + " " + struct_name + "_get_err(long arg);\n")
589 write_c(consts.c_fn_ty_pfx + err_map.c_ty + " " + consts.c_fn_name_define_pfx(struct_name + "_get_err", True) + consts.ptr_c_ty + " arg) {\n")
590 write_c("\t" + struct_name + " *val = (" + struct_name + "*)arg;\n")
591 write_c("\tCHECK(!val->result_ok);\n\t")
592 out_java_struct.write("\tpublic static final class " + human_ty + "_Err extends " + human_ty + " {\n")
593 if err_map.ret_conv is not None:
594 write_c(err_map.ret_conv[0].replace("\n", "\n\t") + "(*val->contents.err)")
595 write_c(err_map.ret_conv[1].replace("\n", "\n\t") + "\n\treturn " + err_map.ret_conv_name)
597 write_c("return *val->contents.err")
600 if err_map.java_hu_ty != "void":
601 out_java_struct.write("\t\tpublic final " + err_map.java_hu_ty + " err;\n")
602 out_java_struct.write("\t\tprivate " + human_ty + "_Err(Object _dummy, long ptr) {\n")
603 out_java_struct.write("\t\t\tsuper(_dummy, ptr);\n")
604 if err_map.java_hu_ty == "void":
606 elif err_map.to_hu_conv is not None:
607 out_java_struct.write("\t\t\t" + err_map.java_ty + " err = bindings." + struct_name + "_get_err(ptr);\n")
608 out_java_struct.write("\t\t\t" + err_map.to_hu_conv.replace("\n", "\n\t\t\t"))
609 out_java_struct.write("\n\t\t\tthis.err = " + err_map.to_hu_conv_name + ";\n")
611 out_java_struct.write("\t\t\tthis.err = bindings." + struct_name + "_get_err(ptr);\n")
612 out_java_struct.write("\t\t}\n")
614 if struct_name.endswith("NoneZ"):
615 out_java_struct.write("\t\tpublic " + human_ty + "_Err() {\n\t\t\tthis(null, bindings.C" + human_ty + "_err());\n")
617 out_java_struct.write("\t\tpublic " + human_ty + "_Err(" + err_map.java_hu_ty + " err) {\n")
618 if err_map.from_hu_conv is not None:
619 out_java_struct.write("\t\t\tthis(null, bindings.C" + human_ty + "_err(" + err_map.from_hu_conv[0] + "));\n")
620 if err_map.from_hu_conv[1] != "":
621 out_java_struct.write("\t\t\t" + err_map.from_hu_conv[1] + ";\n")
623 out_java_struct.write("\t\t\tthis(null, bindings.C" + human_ty + "_err(err));\n")
624 out_java_struct.write("\t\t}\n\t}\n}\n")
627 clone_fns.add(struct_name.replace("LDK", "") + "_clone")
628 write_c("static inline " + struct_name + " " + struct_name.replace("LDK", "") + "_clone(const " + struct_name + " *orig) {\n")
629 write_c("\t" + struct_name + " res = { .result_ok = orig->result_ok };\n")
630 write_c("\tif (orig->result_ok) {\n")
631 if res_map.c_ty == "void":
632 write_c("\t\tres.contents.result = NULL;\n")
634 if res_map.is_native_primitive:
635 write_c("\t\t" + res_map.c_ty + "* contents = MALLOC(sizeof(" + res_map.c_ty + "), \"" + res_map.c_ty + " result OK clone\");\n")
636 write_c("\t\t*contents = *orig->contents.result;\n")
638 write_c("\t\t" + res_map.rust_obj + "* contents = MALLOC(sizeof(" + res_map.rust_obj + "), \"" + res_map.rust_obj + " result OK clone\");\n")
639 write_c("\t\t*contents = " + res_map.rust_obj.replace("LDK", "") + "_clone(orig->contents.result);\n")
640 write_c("\t\tres.contents.result = contents;\n")
641 write_c("\t} else {\n")
642 if err_map.c_ty == "void":
643 write_c("\t\tres.contents.err = NULL;\n")
645 if err_map.is_native_primitive:
646 write_c("\t\t" + err_map.c_ty + "* contents = MALLOC(sizeof(" + err_map.c_ty + "), \"" + err_map.c_ty + " result Err clone\");\n")
647 write_c("\t\t*contents = *orig->contents.err;\n")
649 write_c("\t\t" + err_map.rust_obj + "* contents = MALLOC(sizeof(" + err_map.rust_obj + "), \"" + err_map.rust_obj + " result Err clone\");\n")
650 write_c("\t\t*contents = " + err_map.rust_obj.replace("LDK", "") + "_clone(orig->contents.err);\n")
651 write_c("\t\tres.contents.err = contents;\n")
652 write_c("\t}\n\treturn res;\n}\n")
654 def map_tuple(struct_name, field_lines):
655 out_java.write("\tpublic static native long " + struct_name + "_new(")
656 write_c(consts.c_fn_ty_pfx + consts.ptr_c_ty + " " + consts.c_fn_name_define_pfx(struct_name + "_new", len(field_lines) > 3))
658 for idx, line in enumerate(field_lines):
659 if idx != 0 and idx < len(field_lines) - 2:
660 ty_info = java_c_types(line.strip(';'), None)
664 e = chr(ord('a') + idx - 1)
665 out_java.write(ty_info.java_ty + " " + e)
666 write_c(ty_info.c_ty + " " + e)
667 ty_list.append(ty_info)
668 tuple_types[struct_name] = (ty_list, struct_name)
669 out_java.write(");\n")
671 write_c("\t" + struct_name + "* ret = MALLOC(sizeof(" + struct_name + "), \"" + struct_name + "\");\n")
673 clone_str = "static inline " + struct_name + " " + struct_name.replace("LDK", "") + "_clone(const " + struct_name + " *orig) {\n"
674 clone_str = clone_str + "\t" + struct_name + " ret = {\n"
675 for idx, line in enumerate(field_lines):
676 if idx != 0 and idx < len(field_lines) - 2:
677 ty_info = type_mapping_generator.map_type(line.strip(';'), False, None, False, False)
678 e = chr(ord('a') + idx - 1)
679 if ty_info.arg_conv is not None:
680 write_c("\t" + ty_info.arg_conv.replace("\n", "\n\t"))
681 write_c("\n\tret->" + e + " = " + ty_info.arg_conv_name + ";\n")
683 write_c("\tret->" + e + " = " + e + ";\n")
684 if ty_info.arg_conv_cleanup is not None:
685 write_c("\t//TODO: Really need to call " + ty_info.arg_conv_cleanup + " here\n")
686 if not ty_info.is_native_primitive and (ty_info.rust_obj.replace("LDK", "") + "_clone") not in clone_fns:
688 elif can_clone and ty_info.is_native_primitive:
689 clone_str = clone_str + "\t\t." + chr(ord('a') + idx - 1) + " = orig->" + chr(ord('a') + idx - 1) + ",\n"
691 clone_str = clone_str + "\t\t." + chr(ord('a') + idx - 1) + " = " + ty_info.rust_obj.replace("LDK", "") + "_clone(&orig->" + chr(ord('a') + idx - 1) + "),\n"
692 write_c("\treturn (long)ret;\n")
696 clone_fns.add(struct_name.replace("LDK", "") + "_clone")
698 write_c("\t};\n\treturn ret;\n}\n")
700 for idx, ty_info in enumerate(ty_list):
701 e = chr(ord('a') + idx)
702 out_java.write("\tpublic static native " + ty_info.java_ty + " " + struct_name + "_get_" + e + "(long ptr);\n")
703 write_c(consts.c_fn_ty_pfx + ty_info.c_ty + " " + consts.c_fn_name_define_pfx(struct_name + "_get_" + e, True) + consts.ptr_c_ty + " ptr) {\n")
704 write_c("\t" + struct_name + " *tuple = (" + struct_name + "*)ptr;\n")
705 conv_info = type_mapping_generator.map_type_with_info(ty_info, False, None, False, True)
706 if conv_info.ret_conv is not None:
707 write_c("\t" + conv_info.ret_conv[0].replace("\n", "\n\t") + "tuple->" + e + conv_info.ret_conv[1].replace("\n", "\n\t") + "\n")
708 write_c("\treturn " + conv_info.ret_conv_name + ";\n")
710 write_c("\treturn tuple->" + e + ";\n")
713 out_java.write(consts.bindings_header)
715 with open(f"{sys.argv[3]}/structs/CommonBase{consts.file_ext}", "w") as out_java_struct:
716 out_java_struct.write(consts.common_base)
718 in_block_comment = False
721 const_val_regex = re.compile("^extern const ([A-Za-z_0-9]*) ([A-Za-z_0-9]*);$")
723 line_indicates_result_regex = re.compile("^ union (LDKCResult_[A-Za-z_0-9]*Ptr) contents;$")
724 line_indicates_vec_regex = re.compile("^ (struct |enum |union )?([A-Za-z_0-9]*) \*data;$")
725 line_indicates_opaque_regex = re.compile("^ bool is_owned;$")
726 line_indicates_trait_regex = re.compile("^ (struct |enum |union )?([A-Za-z_0-9]* \*?)\(\*([A-Za-z_0-9]*)\)\((const )?void \*this_arg(.*)\);$")
727 assert(line_indicates_trait_regex.match(" uintptr_t (*send_data)(void *this_arg, LDKu8slice data, bool resume_read);"))
728 assert(line_indicates_trait_regex.match(" struct LDKCVec_MessageSendEventZ (*get_and_clear_pending_msg_events)(const void *this_arg);"))
729 assert(line_indicates_trait_regex.match(" void *(*clone)(const void *this_arg);"))
730 assert(line_indicates_trait_regex.match(" struct LDKCVec_u8Z (*write)(const void *this_arg);"))
731 line_field_var_regex = re.compile("^ struct ([A-Za-z_0-9]*) ([A-Za-z_0-9]*);$")
732 assert(line_field_var_regex.match(" struct LDKMessageSendEventsProvider MessageSendEventsProvider;"))
733 assert(line_field_var_regex.match(" struct LDKChannelPublicKeys pubkeys;"))
734 struct_name_regex = re.compile("^typedef (struct|enum|union) (MUST_USE_STRUCT )?(LDK[A-Za-z_0-9]*) {$")
735 assert(struct_name_regex.match("typedef struct LDKCVec_u8Z {"))
736 assert(struct_name_regex.match("typedef enum LDKNetwork {"))
738 union_enum_items = {}
739 result_ptr_struct_items = {}
742 if line.endswith("*/\n"):
743 in_block_comment = False
744 elif cur_block_obj is not None:
745 cur_block_obj = cur_block_obj + line
746 if line.startswith("} "):
750 obj_lines = cur_block_obj.split("\n")
752 result_contents = None
753 is_unitary_enum = False
754 is_union_enum = False
760 for idx, struct_line in enumerate(obj_lines):
761 if struct_line.strip().startswith("/*"):
762 in_block_comment = True
764 if struct_line.endswith("*/"):
765 in_block_comment = False
767 struct_name_match = struct_name_regex.match(struct_line)
768 if struct_name_match is not None:
769 struct_name = struct_name_match.group(3)
770 if struct_name_match.group(1) == "enum":
771 if not struct_name.endswith("_Tag"):
772 is_unitary_enum = True
775 elif struct_name_match.group(1) == "union":
777 if line_indicates_opaque_regex.match(struct_line):
779 result_match = line_indicates_result_regex.match(struct_line)
780 if result_match is not None:
781 result_contents = result_match.group(1)
782 vec_ty_match = line_indicates_vec_regex.match(struct_line)
783 if vec_ty_match is not None and struct_name.startswith("LDKCVec_"):
784 vec_ty = vec_ty_match.group(2)
785 elif struct_name.startswith("LDKC2Tuple_") or struct_name.startswith("LDKC3Tuple_"):
787 trait_fn_match = line_indicates_trait_regex.match(struct_line)
788 if trait_fn_match is not None:
789 trait_fn_lines.append(trait_fn_match)
790 field_var_match = line_field_var_regex.match(struct_line)
791 if field_var_match is not None:
792 field_var_lines.append(field_var_match)
793 field_lines.append(struct_line)
795 assert(struct_name is not None)
796 assert(len(trait_fn_lines) == 0 or not (is_opaque or is_unitary_enum or is_union_enum or is_union or result_contents is not None or vec_ty is not None))
797 assert(not is_opaque or not (len(trait_fn_lines) != 0 or is_unitary_enum or is_union_enum or is_union or result_contents is not None or vec_ty is not None))
798 assert(not is_unitary_enum or not (len(trait_fn_lines) != 0 or is_opaque or is_union_enum or is_union or result_contents is not None or vec_ty is not None))
799 assert(not is_union_enum or not (len(trait_fn_lines) != 0 or is_unitary_enum or is_opaque or is_union or result_contents is not None or vec_ty is not None))
800 assert(not is_union or not (len(trait_fn_lines) != 0 or is_unitary_enum or is_union_enum or is_opaque or result_contents is not None or vec_ty is not None))
801 assert(result_contents is None or not (len(trait_fn_lines) != 0 or is_unitary_enum or is_union_enum or is_opaque or is_union or vec_ty is not None))
802 assert(vec_ty is None or not (len(trait_fn_lines) != 0 or is_unitary_enum or is_union_enum or is_opaque or is_union or result_contents is not None))
805 opaque_structs.add(struct_name)
806 with open(f"{sys.argv[3]}/structs/{struct_name.replace('LDK', '')}{consts.file_ext}", "w") as out_java_struct:
807 out_opaque_struct_human = consts.map_opaque_struct(struct_name)
808 out_java_struct.write(out_opaque_struct_human)
809 elif result_contents is not None:
810 assert result_contents in result_ptr_struct_items
811 res_ty, err_ty = result_ptr_struct_items[result_contents]
812 map_result(struct_name, res_ty, err_ty)
813 elif struct_name.startswith("LDKCResult_") and struct_name.endswith("ZPtr"):
814 for line in field_lines:
815 if line.endswith("*result;"):
816 res_ty = line[:-8].strip()
817 elif line.endswith("*err;"):
818 err_ty = line[:-5].strip()
819 result_ptr_struct_items[struct_name] = (res_ty, err_ty)
820 result_types.add(struct_name[:-3])
822 map_tuple(struct_name, field_lines)
823 elif vec_ty is not None:
824 ty_info = type_mapping_generator.map_type(vec_ty + " arr_elem", False, None, False, False)
825 if len(ty_info.java_fn_ty_arg) == 1: # ie we're a primitive of some form
826 out_java.write("\tpublic static native long " + struct_name + "_new(" + ty_info.java_ty + "[] elems);\n")
827 write_c(consts.c_fn_ty_pfx + consts.ptr_c_ty + " " + consts.c_fn_name_define_pfx(struct_name + "_new", True) + ty_info.c_ty + "Array elems) {\n")
828 write_c("\t" + struct_name + " *ret = MALLOC(sizeof(" + struct_name + "), \"" + struct_name + "\");\n")
829 write_c("\tret->datalen = " + consts.get_native_arr_len_call[0] + "elems" + consts.get_native_arr_len_call[1] + ";\n")
830 write_c("\tif (ret->datalen == 0) {\n")
831 write_c("\t\tret->data = NULL;\n")
832 write_c("\t} else {\n")
833 write_c("\t\tret->data = MALLOC(sizeof(" + vec_ty + ") * ret->datalen, \"" + struct_name + " Data\");\n")
834 native_arr_ptr_call = consts.get_native_arr_ptr_call(ty_info.ty_info)
835 write_c("\t\t" + ty_info.c_ty + " *java_elems = " + native_arr_ptr_call[0] + "elems" + native_arr_ptr_call[1] + ";\n")
836 write_c("\t\tfor (size_t i = 0; i < ret->datalen; i++) {\n")
837 if ty_info.arg_conv is not None:
838 write_c("\t\t\t" + ty_info.c_ty + " arr_elem = java_elems[i];\n")
839 write_c("\t\t\t" + ty_info.arg_conv.replace("\n", "\n\t\t\t") + "\n")
840 write_c("\t\t\tret->data[i] = " + ty_info.arg_conv_name + ";\n")
841 assert ty_info.arg_conv_cleanup is None
843 write_c("\t\t\tret->data[i] = java_elems[i];\n")
845 cleanup = consts.release_native_arr_ptr_call(ty_info.ty_info, "elems", "java_elems")
846 if cleanup is not None:
847 write_c("\t\t" + cleanup + ";\n")
849 write_c("\treturn (long)ret;\n")
852 if ty_info.is_native_primitive:
853 clone_fns.add(struct_name.replace("LDK", "") + "_clone")
854 write_c("static inline " + struct_name + " " + struct_name.replace("LDK", "") + "_clone(const " + struct_name + " *orig) {\n")
855 write_c("\t" + struct_name + " ret = { .data = MALLOC(sizeof(" + ty_info.c_ty + ") * orig->datalen, \"" + struct_name + " clone bytes\"), .datalen = orig->datalen };\n")
856 write_c("\tmemcpy(ret.data, orig->data, sizeof(" + ty_info.c_ty + ") * ret.datalen);\n")
857 write_c("\treturn ret;\n}\n")
858 elif (ty_info.rust_obj.replace("LDK", "") + "_clone") in clone_fns:
859 ty_name = "CVec_" + ty_info.rust_obj.replace("LDK", "") + "Z";
860 clone_fns.add(ty_name + "_clone")
861 write_c("static inline " + struct_name + " " + ty_name + "_clone(const " + struct_name + " *orig) {\n")
862 write_c("\t" + struct_name + " ret = { .data = MALLOC(sizeof(" + ty_info.rust_obj + ") * orig->datalen, \"" + struct_name + " clone bytes\"), .datalen = orig->datalen };\n")
863 write_c("\tfor (size_t i = 0; i < ret.datalen; i++) {\n")
864 write_c("\t\tret.data[i] = " + ty_info.rust_obj.replace("LDK", "") + "_clone(&orig->data[i]);\n")
865 write_c("\t}\n\treturn ret;\n}\n")
867 assert(struct_name.endswith("_Tag"))
868 struct_name = struct_name[:-4]
869 union_enum_items[struct_name] = {"field_lines": field_lines}
870 elif struct_name.endswith("_Body") and struct_name.split("_")[0] in union_enum_items:
871 enum_var_name = struct_name.split("_")
872 union_enum_items[enum_var_name[0]][enum_var_name[1]] = field_lines
873 elif struct_name in union_enum_items:
874 map_complex_enum(struct_name, union_enum_items[struct_name])
875 elif is_unitary_enum:
876 map_unitary_enum(struct_name, field_lines)
877 elif len(trait_fn_lines) > 0:
878 trait_structs.add(struct_name)
879 map_trait(struct_name, field_var_lines, trait_fn_lines)
880 elif struct_name == "LDKTxOut":
881 with open(f"{sys.argv[3]}/structs/TxOut{consts.file_ext}", "w") as out_java_struct:
882 out_java_struct.write(consts.hu_struct_file_prefix)
883 out_java_struct.write("public class TxOut extends CommonBase{\n")
884 out_java_struct.write("\tTxOut(java.lang.Object _dummy, long ptr) { super(ptr); }\n")
885 out_java_struct.write("\tlong to_c_ptr() { return 0; }\n")
886 out_java_struct.write("\t@Override @SuppressWarnings(\"deprecation\")\n")
887 out_java_struct.write("\tprotected void finalize() throws Throwable {\n")
888 out_java_struct.write("\t\tsuper.finalize();\n")
889 out_java_struct.write("\t\tif (ptr != 0) { bindings.TxOut_free(ptr); }\n")
890 out_java_struct.write("\t}\n")
892 out_java_struct.write("}")
894 pass # Everything remaining is a byte[] or some form
897 fn_ptr = fn_ptr_regex.match(line)
898 fn_ret_arr = fn_ret_arr_regex.match(line)
899 reg_fn = reg_fn_regex.match(line)
900 const_val = const_val_regex.match(line)
902 if line.startswith("#include <"):
904 elif line.startswith("/*"):
905 #out_java.write("\t" + line)
906 if not line.endswith("*/\n"):
907 in_block_comment = True
908 elif line.startswith("typedef enum "):
910 elif line.startswith("typedef struct "):
912 elif line.startswith("typedef union "):
914 elif fn_ptr is not None:
915 map_fn(line, fn_ptr, None, None)
916 elif fn_ret_arr is not None:
917 map_fn(line, fn_ret_arr, fn_ret_arr.group(4), None)
918 elif reg_fn is not None:
919 map_fn(line, reg_fn, None, None)
920 elif const_val_regex is not None:
921 # TODO Map const variables
926 out_java.write(consts.bindings_footer)
927 for struct_name in opaque_structs:
928 with open(f"{sys.argv[3]}/structs/{struct_name.replace('LDK', '')}{consts.file_ext}", "a") as out_java_struct:
929 out_java_struct.write("}\n")
930 for struct_name in trait_structs:
931 with open(f"{sys.argv[3]}/structs/{struct_name.replace('LDK', '')}{consts.file_ext}", "a") as out_java_struct:
932 out_java_struct.write("}\n")
934 with open(sys.argv[4], "w") as out_c:
935 out_c.write(consts.c_file_pfx)
936 out_c.write(consts.init_str())