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" or sys.argv[6] == "android":
19 from java_strings import Consts
20 target = java_strings.Target.JAVA
21 if sys.argv[6] == "android":
22 target = java_strings.Target.ANDROID
23 elif sys.argv[6] == "typescript":
24 import typescript_strings
25 from typescript_strings import Consts
26 target = typescript_strings.Target.NODEJS
27 if len(sys.argv) == 8 and sys.argv[7] == 'browser':
28 target = typescript_strings.Target.BROWSER
30 print("Only java or typescript can be set for lang")
34 consts = Consts(DEBUG, target=target)
36 from bindingstypes import *
43 def camel_to_snake(s):
44 # Convert camel case to snake case, in a way that appears to match cbindgen
50 if lastchar.isupper():
51 if not char.isupper() and not lastund:
56 ret = ret + lastchar.lower()
59 if char.isupper() and not lastund:
67 return (ret + lastchar.lower()).strip("_")
71 opaque_structs = set()
76 var_is_arr_regex = re.compile("\(\*([A-za-z0-9_]*)\)\[([a-z0-9]*)\]")
77 var_ty_regex = re.compile("([A-za-z_0-9]*)(.*)")
78 java_c_types_none_allowed = True # Unset when we do the real pass that populates the above sets
79 def java_c_types(fn_arg, ret_arr_len):
80 fn_arg = fn_arg.strip()
81 if fn_arg.startswith("MUST_USE_RES "):
84 if fn_arg.startswith("const "):
87 if fn_arg.startswith("struct "):
89 if fn_arg.startswith("enum "):
91 fn_arg = fn_arg.replace("NONNULL_PTR", "")
98 if fn_arg.startswith("LDKThirtyTwoBytes"):
99 fn_arg = "uint8_t (*" + fn_arg[18:] + ")[32]"
100 assert var_is_arr_regex.match(fn_arg[8:])
101 rust_obj = "LDKThirtyTwoBytes"
103 elif fn_arg.startswith("LDKPublicKey"):
104 fn_arg = "uint8_t (*" + fn_arg[13:] + ")[33]"
105 assert var_is_arr_regex.match(fn_arg[8:])
106 rust_obj = "LDKPublicKey"
107 arr_access = "compressed_form"
108 elif fn_arg.startswith("LDKSecretKey"):
109 fn_arg = "uint8_t (*" + fn_arg[13:] + ")[32]"
110 assert var_is_arr_regex.match(fn_arg[8:])
111 rust_obj = "LDKSecretKey"
113 elif fn_arg.startswith("LDKSignature"):
114 fn_arg = "uint8_t (*" + fn_arg[13:] + ")[64]"
115 assert var_is_arr_regex.match(fn_arg[8:])
116 rust_obj = "LDKSignature"
117 arr_access = "compact_form"
118 elif fn_arg.startswith("LDKThreeBytes"):
119 fn_arg = "uint8_t (*" + fn_arg[14:] + ")[3]"
120 assert var_is_arr_regex.match(fn_arg[8:])
121 rust_obj = "LDKThreeBytes"
123 elif fn_arg.startswith("LDKFourBytes"):
124 fn_arg = "uint8_t (*" + fn_arg[13:] + ")[4]"
125 assert var_is_arr_regex.match(fn_arg[8:])
126 rust_obj = "LDKFourBytes"
128 elif fn_arg.startswith("LDKSixteenBytes"):
129 fn_arg = "uint8_t (*" + fn_arg[16:] + ")[16]"
130 assert var_is_arr_regex.match(fn_arg[8:])
131 rust_obj = "LDKSixteenBytes"
133 elif fn_arg.startswith("LDKTenBytes"):
134 fn_arg = "uint8_t (*" + fn_arg[12:] + ")[10]"
135 assert var_is_arr_regex.match(fn_arg[8:])
136 rust_obj = "LDKTenBytes"
138 elif fn_arg.startswith("LDKu8slice"):
139 fn_arg = "uint8_t (*" + fn_arg[11:] + ")[datalen]"
140 assert var_is_arr_regex.match(fn_arg[8:])
141 rust_obj = "LDKu8slice"
143 elif fn_arg.startswith("LDKCVec_u8Z"):
144 fn_arg = "uint8_t (*" + fn_arg[12:] + ")[datalen]"
145 rust_obj = "LDKCVec_u8Z"
146 assert var_is_arr_regex.match(fn_arg[8:])
148 elif fn_arg.startswith("LDKTransaction"):
149 fn_arg = "uint8_t (*" + fn_arg[15:] + ")[datalen]"
150 rust_obj = "LDKTransaction"
151 assert var_is_arr_regex.match(fn_arg[8:])
153 elif fn_arg.startswith("LDKCVec_"):
156 fn_arg = fn_arg.replace("*", "")
159 tyn = fn_arg[8:].split(" ")
160 assert tyn[0].endswith("Z")
164 new_arg = "LDK" + tyn[0][:-1]
166 new_arg = new_arg + " " + a
167 res = java_c_types(new_arg, ret_arr_len)
169 assert java_c_types_none_allowed
172 res.pass_by_ref = True
173 if res.is_native_primitive or res.passed_as_ptr:
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=res.c_ty + "Array", 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)
178 return TypeInfo(rust_obj=fn_arg.split(" ")[0], java_ty=res.java_ty + "[]", java_hu_ty=res.java_hu_ty + "[]",
179 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,
180 var_name=res.var_name, arr_len="datalen", arr_access="data", subty=res, is_native_primitive=False)
185 java_type_plural = None
186 if fn_arg.startswith("void"):
190 fn_arg = fn_arg[4:].strip()
192 elif fn_arg.startswith("bool"):
196 fn_arg = fn_arg[4:].strip()
198 elif fn_arg.startswith("uint8_t"):
199 mapped_type = consts.c_type_map['uint8_t']
200 java_ty = mapped_type[0]
203 fn_arg = fn_arg[7:].strip()
205 elif fn_arg.startswith("uint16_t"):
206 mapped_type = consts.c_type_map['uint16_t']
207 java_ty = mapped_type[0]
210 fn_arg = fn_arg[8:].strip()
212 elif fn_arg.startswith("uint32_t"):
213 mapped_type = consts.c_type_map['uint32_t']
214 java_ty = mapped_type[0]
217 fn_arg = fn_arg[8:].strip()
219 elif fn_arg.startswith("uint64_t") or fn_arg.startswith("uintptr_t"):
220 # TODO: uintptr_t is arch-dependent :(
221 mapped_type = consts.c_type_map['uint64_t']
222 java_ty = mapped_type[0]
224 if fn_arg.startswith("uint64_t"):
226 fn_arg = fn_arg[8:].strip()
229 rust_obj = "uintptr_t"
230 fn_arg = fn_arg[9:].strip()
232 elif is_const and fn_arg.startswith("char *"):
235 fn_ty_arg = "Ljava/lang/String;"
236 fn_arg = fn_arg[6:].strip()
237 elif fn_arg.startswith("LDKStr"):
240 fn_ty_arg = "Ljava/lang/String;"
241 fn_arg = fn_arg[6:].strip()
245 ma = var_ty_regex.match(fn_arg)
246 if ma.group(1).strip() in unitary_enums:
247 java_ty = ma.group(1).strip()
248 c_ty = consts.result_c_ty
249 fn_ty_arg = "Lorg/ldk/enums/" + ma.group(1).strip() + ";"
250 fn_arg = ma.group(2).strip()
251 rust_obj = ma.group(1).strip()
252 elif ma.group(1).strip().startswith("LDKC2Tuple"):
253 c_ty = consts.ptr_c_ty
254 java_ty = consts.ptr_native_ty
255 java_hu_ty = "TwoTuple<"
256 if not ma.group(1).strip() in tuple_types:
257 assert java_c_types_none_allowed
259 for idx, ty_info in enumerate(tuple_types[ma.group(1).strip()][0]):
261 java_hu_ty = java_hu_ty + ", "
262 if ty_info.is_native_primitive:
263 if ty_info.java_hu_ty == "int":
264 java_hu_ty = java_hu_ty + "Integer" # Java concrete integer type is Integer, not Int
266 java_hu_ty = java_hu_ty + ty_info.java_hu_ty.title() # If we're a primitive, capitalize the first letter
268 java_hu_ty = java_hu_ty + ty_info.java_hu_ty
269 java_hu_ty = java_hu_ty + ">"
271 fn_arg = ma.group(2).strip()
272 rust_obj = ma.group(1).strip()
274 elif ma.group(1).strip().startswith("LDKC3Tuple"):
275 c_ty = consts.ptr_c_ty
276 java_ty = consts.ptr_native_ty
277 java_hu_ty = "ThreeTuple<"
278 if not ma.group(1).strip() in tuple_types:
279 assert java_c_types_none_allowed
281 for idx, ty_info in enumerate(tuple_types[ma.group(1).strip()][0]):
283 java_hu_ty = java_hu_ty + ", "
284 if ty_info.is_native_primitive:
285 if ty_info.java_hu_ty == "int":
286 java_hu_ty = java_hu_ty + "Integer" # Java concrete integer type is Integer, not Int
288 java_hu_ty = java_hu_ty + ty_info.java_hu_ty.title() # If we're a primitive, capitalize the first letter
290 java_hu_ty = java_hu_ty + ty_info.java_hu_ty
291 java_hu_ty = java_hu_ty + ">"
293 fn_arg = ma.group(2).strip()
294 rust_obj = ma.group(1).strip()
297 c_ty = consts.ptr_c_ty
298 java_ty = consts.ptr_native_ty
299 java_hu_ty = ma.group(1).strip().replace("LDKCResult", "Result").replace("LDK", "")
301 fn_arg = ma.group(2).strip()
302 rust_obj = ma.group(1).strip()
305 if fn_arg.startswith(" *") or fn_arg.startswith("*"):
306 fn_arg = fn_arg.replace("*", "").strip()
308 c_ty = consts.ptr_c_ty
309 java_ty = consts.ptr_native_ty
312 var_is_arr = var_is_arr_regex.match(fn_arg)
313 if var_is_arr is not None or ret_arr_len is not None:
314 assert(not take_by_ptr)
316 # is there a special case for plurals?
317 if len(mapped_type) == 2:
318 java_ty = mapped_type[1]
320 java_ty = java_ty + "[]"
321 c_ty = c_ty + "Array"
322 if var_is_arr is not None:
323 if var_is_arr.group(1) == "":
324 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,
325 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)
326 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,
327 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)
329 if java_hu_ty is None:
331 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,
332 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)
334 fn_ptr_regex = re.compile("^extern const ([A-Za-z_0-9\* ]*) \(\*(.*)\)\((.*)\);$")
335 fn_ret_arr_regex = re.compile("(.*) \(\*(.*)\((.*)\)\)\[([0-9]*)\];$")
336 reg_fn_regex = re.compile("([A-Za-z_0-9\* ]* \*?)([a-zA-Z_0-9]*)\((.*)\);$")
340 from gen_type_mapping import TypeMappingGenerator
341 type_mapping_generator = TypeMappingGenerator(java_c_types, consts, opaque_structs, clone_fns, unitary_enums, trait_structs, complex_enums, result_types, tuple_types)
343 with open(sys.argv[1]) as in_h:
345 reg_fn = reg_fn_regex.match(line)
346 if reg_fn is not None:
347 if reg_fn.group(2).endswith("_clone"):
348 clone_fns.add(reg_fn.group(2))
350 rty = java_c_types(reg_fn.group(1), None)
351 if rty is not None and not rty.is_native_primitive and reg_fn.group(2) == rty.java_hu_ty + "_new":
352 constructor_fns[rty.rust_obj] = reg_fn.group(3)
354 arr_fn = fn_ret_arr_regex.match(line)
355 if arr_fn is not None:
356 if arr_fn.group(2).endswith("_clone"):
357 clone_fns.add(arr_fn.group(2))
358 # No object constructors return arrays, as then they wouldn't be an object constructor
361 # Define some manual clones...
362 clone_fns.add("ThirtyTwoBytes_clone")
363 write_c("static inline struct LDKThirtyTwoBytes ThirtyTwoBytes_clone(const struct LDKThirtyTwoBytes *orig) { struct LDKThirtyTwoBytes ret; memcpy(ret.data, orig->data, 32); return ret; }\n")
365 java_c_types_none_allowed = False # C structs created by cbindgen are declared in dependency order
367 with open(f"{sys.argv[3]}/structs/UtilMethods{consts.file_ext}", "a") as util:
368 util.write(consts.util_fn_pfx)
370 with open(sys.argv[1]) as in_h, open(sys.argv[2], "w") as out_java:
371 # Map a top-level function
372 def map_fn(line, re_match, ret_arr_len, c_call_string, doc_comment):
373 method_return_type = re_match.group(1)
374 method_name = re_match.group(2)
375 method_comma_separated_arguments = re_match.group(3)
376 method_arguments = method_comma_separated_arguments.split(',')
378 is_free = method_name.endswith("_free")
379 struct_meth = method_name.split("_")[0]
381 return_type_info = type_mapping_generator.map_type(method_return_type, True, ret_arr_len, False, False)
384 default_constructor_args = {}
388 for argument_index, argument in enumerate(method_arguments):
389 argument_conversion_info = type_mapping_generator.map_type(argument, False, None, is_free, True)
390 if argument_index == 0 and argument_conversion_info.java_hu_ty == struct_meth:
392 if argument_conversion_info.arg_conv is not None and "Warning" in argument_conversion_info.arg_conv:
393 if argument_conversion_info.rust_obj in constructor_fns:
395 for explode_arg in constructor_fns[argument_conversion_info.rust_obj].split(','):
396 explode_arg_conv = type_mapping_generator.map_type(explode_arg, False, None, False, True)
397 if explode_arg_conv.c_ty == "void":
398 # We actually want to handle this case, but for now its only used in NetGraphMsgHandler::new()
399 # which ends up resulting in a redundant constructor - both without arguments for the NetworkGraph.
402 if not argument_conversion_info.arg_name in default_constructor_args:
403 default_constructor_args[argument_conversion_info.arg_name] = []
404 default_constructor_args[argument_conversion_info.arg_name].append(explode_arg_conv)
405 argument_types.append(argument_conversion_info)
407 out_java.write("\t// " + line)
408 (out_java_delta, out_c_delta, out_java_struct_delta) = \
409 consts.map_function(argument_types, c_call_string, method_name, return_type_info, struct_meth, default_constructor_args, takes_self, args_known, type_mapping_generator, doc_comment)
410 out_java.write(out_java_delta)
413 assert len(argument_types) == 1
414 assert return_type_info.c_ty == "void"
415 write_c(consts.c_fn_ty_pfx + "void " + consts.c_fn_name_define_pfx(method_name, True) + argument_types[0].c_ty + " " + argument_types[0].ty_info.var_name + ") {\n")
416 if argument_types[0].ty_info.passed_as_ptr and not argument_types[0].ty_info.rust_obj in opaque_structs:
417 write_c("\tif ((" + argument_types[0].ty_info.var_name + " & 1) != 0) return;\n")
419 for info in argument_types:
420 if info.arg_conv is not None:
421 write_c("\t" + info.arg_conv.replace('\n', "\n\t") + "\n")
422 assert c_call_string is None
423 write_c("\t" + method_name + "(")
424 if argument_types[0].arg_conv_name is not None:
425 write_c(argument_types[0].arg_conv_name)
427 for info in argument_types:
428 if info.arg_conv_cleanup is not None:
429 write_c("\n\t" + info.arg_conv_cleanup.replace("\n", "\n\t"))
434 out_java_struct = None
435 if ("LDK" + struct_meth in opaque_structs or "LDK" + struct_meth in trait_structs) and not is_free:
436 out_java_struct = open(f"{sys.argv[3]}/structs/{struct_meth}{consts.file_ext}", "a")
437 elif method_name.startswith("C2Tuple_") and method_name.endswith("_read"):
438 struct_meth = method_name.rsplit("_", 1)[0]
439 out_java_struct = open(f"{sys.argv[3]}/structs/UtilMethods{consts.file_ext}", "a")
440 if out_java_struct is not None:
441 out_java_struct.write(out_java_struct_delta)
443 def map_unitary_enum(struct_name, field_lines, enum_doc_comment):
444 with open(f"{sys.argv[3]}/enums/{struct_name}{consts.file_ext}", "w") as out_java_enum:
445 unitary_enums.add(struct_name)
446 for idx, struct_line in enumerate(field_lines):
448 assert(struct_line == "typedef enum %s {" % struct_name)
449 elif idx == len(field_lines) - 3:
450 assert(struct_line.endswith("_Sentinel,"))
451 elif idx == len(field_lines) - 2:
452 assert(struct_line == "} %s;" % struct_name)
453 elif idx == len(field_lines) - 1:
454 assert(struct_line == "")
455 (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]], enum_doc_comment)
457 out_java_enum.write(native_file_out)
458 out_java.write(native_out)
460 def map_complex_enum(struct_name, union_enum_items, enum_doc_comment):
461 java_hu_type = struct_name.replace("LDK", "")
462 complex_enums.add(struct_name)
465 tag_field_lines = union_enum_items["field_lines"]
466 for idx, struct_line in enumerate(tag_field_lines):
468 assert(struct_line == "typedef enum %s_Tag {" % struct_name)
469 elif idx == len(tag_field_lines) - 3:
470 assert(struct_line.endswith("_Sentinel,"))
471 elif idx == len(tag_field_lines) - 2:
472 assert(struct_line == "} %s_Tag;" % struct_name)
473 elif idx == len(tag_field_lines) - 1:
474 assert(struct_line == "")
476 variant_name = struct_line.strip(' ,')[len(struct_name) + 1:]
478 if "LDK" + variant_name in union_enum_items:
479 enum_var_lines = union_enum_items["LDK" + variant_name]
480 for idx, field in enumerate(enum_var_lines):
481 if idx != 0 and idx < len(enum_var_lines) - 2:
482 fields.append(type_mapping_generator.map_type(field.strip(' ;'), False, None, False, True))
484 # TODO: Assert line format
487 # TODO: Assert line format
489 enum_variants.append(ComplexEnumVariantInfo(variant_name, fields))
491 with open(f"{sys.argv[3]}/structs/{java_hu_type}{consts.file_ext}", "w") as out_java_enum:
492 (out_java_addendum, out_java_enum_addendum, out_c_addendum) = consts.map_complex_enum(struct_name, enum_variants, camel_to_snake, enum_doc_comment)
494 out_java_enum.write(out_java_enum_addendum)
495 out_java.write(out_java_addendum)
496 write_c(out_c_addendum)
498 def map_trait(struct_name, field_var_lines, trait_fn_lines, trait_doc_comment):
499 with open(f"{sys.argv[3]}/structs/{struct_name.replace('LDK', '')}{consts.file_ext}", "w") as out_java_trait:
501 for var_line in field_var_lines:
502 if var_line.group(1) in trait_structs:
503 field_var_convs.append((var_line.group(1), var_line.group(2)))
505 field_var_convs.append(
506 type_mapping_generator.map_type(var_line.group(1) + " " + var_line.group(2), False, None, False, False))
509 for fn_docs, fn_line in trait_fn_lines:
510 ret_ty_info = type_mapping_generator.map_type(fn_line.group(2), True, None, False, False)
511 is_const = fn_line.group(4) is not None
514 for idx, arg in enumerate(fn_line.group(5).split(',')):
517 arg_conv_info = type_mapping_generator.map_type(arg, True, None, False, False)
518 arg_tys.append(arg_conv_info)
519 field_fns.append(TraitMethInfo(fn_line.group(3), is_const, ret_ty_info, arg_tys, fn_docs))
521 (out_java_addendum, out_java_trait_addendum, out_c_addendum) = consts.native_c_map_trait(struct_name, field_var_convs, field_fns, trait_doc_comment)
522 write_c(out_c_addendum)
523 out_java_trait.write(out_java_trait_addendum)
524 out_java.write(out_java_addendum)
526 for fn_docs, fn_line in trait_fn_lines:
527 # For now, just disable enabling the _call_log - we don't know how to inverse-map String
528 is_log = fn_line.group(3) == "log" and struct_name == "LDKLogger"
529 if fn_line.group(3) != "free" and fn_line.group(3) != "clone" and fn_line.group(3) != "eq" and not is_log:
530 dummy_line = fn_line.group(2) + struct_name.replace("LDK", "") + "_" + fn_line.group(3) + " " + struct_name + "* this_arg" + fn_line.group(5) + "\n"
531 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", fn_docs)
532 for idx, var_line in enumerate(field_var_lines):
533 if var_line.group(1) not in trait_structs:
534 write_c(var_line.group(1) + " " + struct_name + "_set_get_" + var_line.group(2) + "(" + struct_name + "* this_arg) {\n")
535 write_c("\tif (this_arg->set_" + var_line.group(2) + " != NULL)\n")
536 write_c("\t\tthis_arg->set_" + var_line.group(2) + "(this_arg);\n")
537 write_c("\treturn this_arg->" + var_line.group(2) + ";\n")
539 dummy_line = var_line.group(1) + " " + struct_name.replace("LDK", "") + "_get_" + var_line.group(2) + " " + struct_name + "* this_arg" + fn_line.group(5) + "\n"
540 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", fn_docs)
542 def map_result(struct_name, res_ty, err_ty):
543 result_types.add(struct_name)
544 human_ty = struct_name.replace("LDKCResult", "Result")
545 with open(f"{sys.argv[3]}/structs/{human_ty}{consts.file_ext}", "w") as out_java_struct:
546 out_java_struct.write(consts.hu_struct_file_prefix)
547 out_java_struct.write("public class " + human_ty + " extends CommonBase {\n")
548 out_java_struct.write("\tprivate " + human_ty + "(Object _dummy, long ptr) { super(ptr); }\n")
549 out_java_struct.write("\tprotected void finalize() throws Throwable {\n")
550 out_java_struct.write("\t\tif (ptr != 0) { bindings." + struct_name.replace("LDK","") + "_free(ptr); } super.finalize();\n")
551 out_java_struct.write("\t}\n\n")
552 out_java_struct.write("\tstatic " + human_ty + " constr_from_ptr(long ptr) {\n")
553 out_java_struct.write("\t\tif (bindings." + struct_name + "_result_ok(ptr)) {\n")
554 out_java_struct.write("\t\t\treturn new " + human_ty + "_OK(null, ptr);\n")
555 out_java_struct.write("\t\t} else {\n")
556 out_java_struct.write("\t\t\treturn new " + human_ty + "_Err(null, ptr);\n")
557 out_java_struct.write("\t\t}\n")
558 out_java_struct.write("\t}\n")
560 res_map = type_mapping_generator.map_type(res_ty + " res", True, None, False, True)
561 err_map = type_mapping_generator.map_type(err_ty + " err", True, None, False, True)
563 if not res_map.is_native_primitive and (res_map.rust_obj.replace("LDK", "") + "_clone" not in clone_fns):
565 if not err_map.is_native_primitive and (err_map.rust_obj.replace("LDK", "") + "_clone" not in clone_fns):
568 out_java.write("\tpublic static native boolean " + struct_name + "_result_ok(long arg);\n")
569 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")
570 write_c("\treturn ((" + struct_name + "*)arg)->result_ok;\n")
573 out_java.write("\tpublic static native " + res_map.java_ty + " " + struct_name + "_get_ok(long arg);\n")
574 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")
575 write_c("\t" + struct_name + " *val = (" + struct_name + "*)(arg & ~1);\n")
576 write_c("\tCHECK(val->result_ok);\n\t")
577 out_java_struct.write("\tpublic static final class " + human_ty + "_OK extends " + human_ty + " {\n")
578 if res_map.ret_conv is not None:
579 write_c(res_map.ret_conv[0].replace("\n", "\n\t") + "(*val->contents.result)")
580 write_c(res_map.ret_conv[1].replace("\n", "\n\t") + "\n\treturn " + res_map.ret_conv_name)
582 write_c("return *val->contents.result")
585 if res_map.java_hu_ty != "void":
586 out_java_struct.write("\t\tpublic final " + res_map.java_hu_ty + " res;\n")
587 out_java_struct.write("\t\tprivate " + human_ty + "_OK(Object _dummy, long ptr) {\n")
588 out_java_struct.write("\t\t\tsuper(_dummy, ptr);\n")
589 if res_map.java_hu_ty == "void":
591 elif res_map.to_hu_conv is not None:
592 out_java_struct.write("\t\t\t" + res_map.java_ty + " res = bindings." + struct_name + "_get_ok(ptr);\n")
593 out_java_struct.write("\t\t\t" + res_map.to_hu_conv.replace("\n", "\n\t\t\t"))
594 out_java_struct.write("\n\t\t\tthis.res = " + res_map.to_hu_conv_name + ";\n")
596 out_java_struct.write("\t\t\tthis.res = bindings." + struct_name + "_get_ok(ptr);\n")
597 out_java_struct.write("\t\t}\n")
598 if struct_name.startswith("LDKCResult_None"):
599 out_java_struct.write("\t\tpublic " + human_ty + "_OK() {\n\t\t\tthis(null, bindings.C" + human_ty + "_ok());\n")
601 out_java_struct.write("\t\tpublic " + human_ty + "_OK(" + res_map.java_hu_ty + " res) {\n")
602 if res_map.from_hu_conv is not None:
603 out_java_struct.write("\t\t\tthis(null, bindings.C" + human_ty + "_ok(" + res_map.from_hu_conv[0] + "));\n")
604 if res_map.from_hu_conv[1] != "":
605 out_java_struct.write("\t\t\t" + res_map.from_hu_conv[1].replace("\n", "\n\t\t\t") + ";\n")
607 out_java_struct.write("\t\t\tthis(null, bindings.C" + human_ty + "_ok(res));\n")
608 out_java_struct.write("\t\t}\n\t}\n\n")
610 out_java.write("\tpublic static native " + err_map.java_ty + " " + struct_name + "_get_err(long arg);\n")
611 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")
612 write_c("\t" + struct_name + " *val = (" + struct_name + "*)(arg & ~1);\n")
613 write_c("\tCHECK(!val->result_ok);\n\t")
614 out_java_struct.write("\tpublic static final class " + human_ty + "_Err extends " + human_ty + " {\n")
615 if err_map.ret_conv is not None:
616 write_c(err_map.ret_conv[0].replace("\n", "\n\t") + "(*val->contents.err)")
617 write_c(err_map.ret_conv[1].replace("\n", "\n\t") + "\n\treturn " + err_map.ret_conv_name)
619 write_c("return *val->contents.err")
622 if err_map.java_hu_ty != "void":
623 out_java_struct.write("\t\tpublic final " + err_map.java_hu_ty + " err;\n")
624 out_java_struct.write("\t\tprivate " + human_ty + "_Err(Object _dummy, long ptr) {\n")
625 out_java_struct.write("\t\t\tsuper(_dummy, ptr);\n")
626 if err_map.java_hu_ty == "void":
628 elif err_map.to_hu_conv is not None:
629 out_java_struct.write("\t\t\t" + err_map.java_ty + " err = bindings." + struct_name + "_get_err(ptr);\n")
630 out_java_struct.write("\t\t\t" + err_map.to_hu_conv.replace("\n", "\n\t\t\t"))
631 out_java_struct.write("\n\t\t\tthis.err = " + err_map.to_hu_conv_name + ";\n")
633 out_java_struct.write("\t\t\tthis.err = bindings." + struct_name + "_get_err(ptr);\n")
634 out_java_struct.write("\t\t}\n")
636 if struct_name.endswith("NoneZ"):
637 out_java_struct.write("\t\tpublic " + human_ty + "_Err() {\n\t\t\tthis(null, bindings.C" + human_ty + "_err());\n")
639 out_java_struct.write("\t\tpublic " + human_ty + "_Err(" + err_map.java_hu_ty + " err) {\n")
640 if err_map.from_hu_conv is not None:
641 out_java_struct.write("\t\t\tthis(null, bindings.C" + human_ty + "_err(" + err_map.from_hu_conv[0] + "));\n")
642 if err_map.from_hu_conv[1] != "":
643 out_java_struct.write("\t\t\t" + err_map.from_hu_conv[1].replace("\n", "\n\t\t\t") + ";\n")
645 out_java_struct.write("\t\t\tthis(null, bindings.C" + human_ty + "_err(err));\n")
646 out_java_struct.write("\t\t}\n\t}\n}\n")
648 def map_tuple(struct_name, field_lines):
649 out_java.write("\tpublic static native long " + struct_name + "_new(")
650 write_c(consts.c_fn_ty_pfx + consts.ptr_c_ty + " " + consts.c_fn_name_define_pfx(struct_name + "_new", len(field_lines) > 3))
652 for idx, line in enumerate(field_lines):
653 if idx != 0 and idx < len(field_lines) - 2:
654 ty_info = java_c_types(line.strip(';'), None)
658 e = chr(ord('a') + idx - 1)
659 out_java.write(ty_info.java_ty + " " + e)
660 write_c(ty_info.c_ty + " " + e)
661 ty_list.append(ty_info)
662 tuple_types[struct_name] = (ty_list, struct_name)
663 out_java.write(");\n")
665 write_c("\t" + struct_name + "* ret = MALLOC(sizeof(" + struct_name + "), \"" + struct_name + "\");\n")
666 for idx, line in enumerate(field_lines):
667 if idx != 0 and idx < len(field_lines) - 2:
668 ty_info = type_mapping_generator.map_type(line.strip(';'), False, None, False, False)
669 e = chr(ord('a') + idx - 1)
670 if ty_info.arg_conv is not None:
671 write_c("\t" + ty_info.arg_conv.replace("\n", "\n\t"))
672 write_c("\n\tret->" + e + " = " + ty_info.arg_conv_name + ";\n")
674 write_c("\tret->" + e + " = " + e + ";\n")
675 if ty_info.arg_conv_cleanup is not None:
676 write_c("\t//TODO: Really need to call " + ty_info.arg_conv_cleanup + " here\n")
677 write_c("\treturn (long)ret;\n")
680 for idx, ty_info in enumerate(ty_list):
681 e = chr(ord('a') + idx)
682 out_java.write("\tpublic static native " + ty_info.java_ty + " " + struct_name + "_get_" + e + "(long ptr);\n")
683 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")
684 write_c("\t" + struct_name + " *tuple = (" + struct_name + "*)(ptr & ~1);\n")
685 conv_info = type_mapping_generator.map_type_with_info(ty_info, False, None, False, True)
686 if conv_info.ret_conv is not None:
687 write_c("\t" + conv_info.ret_conv[0].replace("\n", "\n\t") + "tuple->" + e + conv_info.ret_conv[1].replace("\n", "\n\t") + "\n")
688 write_c("\treturn " + conv_info.ret_conv_name + ";\n")
690 write_c("\treturn tuple->" + e + ";\n")
693 out_java.write(consts.bindings_header)
695 with open(f"{sys.argv[3]}/structs/CommonBase{consts.file_ext}", "w") as out_java_struct:
696 out_java_struct.write(consts.common_base)
699 last_block_comment = None
702 const_val_regex = re.compile("^extern const ([A-Za-z_0-9]*) ([A-Za-z_0-9]*);$")
704 line_indicates_result_regex = re.compile("^ union (LDKCResult_[A-Za-z_0-9]*Ptr) contents;$")
705 line_indicates_vec_regex = re.compile("^ (struct |enum |union )?([A-Za-z_0-9]*) \*data;$")
706 line_indicates_opaque_regex = re.compile("^ bool is_owned;$")
707 line_indicates_trait_regex = re.compile("^ (struct |enum |union )?([A-Za-z_0-9]* \*?)\(\*([A-Za-z_0-9]*)\)\((const )?void \*this_arg(.*)\);$")
708 assert(line_indicates_trait_regex.match(" uintptr_t (*send_data)(void *this_arg, LDKu8slice data, bool resume_read);"))
709 assert(line_indicates_trait_regex.match(" struct LDKCVec_MessageSendEventZ (*get_and_clear_pending_msg_events)(const void *this_arg);"))
710 assert(line_indicates_trait_regex.match(" void *(*clone)(const void *this_arg);"))
711 assert(line_indicates_trait_regex.match(" struct LDKCVec_u8Z (*write)(const void *this_arg);"))
712 line_field_var_regex = re.compile("^ struct ([A-Za-z_0-9]*) ([A-Za-z_0-9]*);$")
713 assert(line_field_var_regex.match(" struct LDKMessageSendEventsProvider MessageSendEventsProvider;"))
714 assert(line_field_var_regex.match(" struct LDKChannelPublicKeys pubkeys;"))
715 struct_name_regex = re.compile("^typedef (struct|enum|union) (MUST_USE_STRUCT )?(LDK[A-Za-z_0-9]*) {$")
716 assert(struct_name_regex.match("typedef struct LDKCVec_u8Z {"))
717 assert(struct_name_regex.match("typedef enum LDKNetwork {"))
719 union_enum_items = {}
720 result_ptr_struct_items = {}
722 if block_comment is not None:
723 if line.endswith("*/\n"):
724 last_block_comment = block_comment.strip("\n")
727 block_comment = block_comment + line.strip(" /*")
728 elif cur_block_obj is not None:
729 cur_block_obj = cur_block_obj + line
730 if line.startswith("} "):
734 obj_lines = cur_block_obj.split("\n")
736 result_contents = None
737 is_unitary_enum = False
738 is_union_enum = False
744 for idx, struct_line in enumerate(obj_lines):
745 if struct_line.strip().startswith("/*"):
746 block_comment = struct_line.strip(" /*")
747 if block_comment is not None:
748 if struct_line.endswith("*/"):
749 last_struct_block_comment = block_comment.strip("\n")
752 block_comment = block_comment + "\n" + struct_line.strip(" /*")
754 struct_name_match = struct_name_regex.match(struct_line)
755 if struct_name_match is not None:
756 struct_name = struct_name_match.group(3)
757 if struct_name_match.group(1) == "enum":
758 if not struct_name.endswith("_Tag"):
759 is_unitary_enum = True
762 elif struct_name_match.group(1) == "union":
764 if line_indicates_opaque_regex.match(struct_line):
766 result_match = line_indicates_result_regex.match(struct_line)
767 if result_match is not None:
768 result_contents = result_match.group(1)
769 vec_ty_match = line_indicates_vec_regex.match(struct_line)
770 if vec_ty_match is not None and struct_name.startswith("LDKCVec_"):
771 vec_ty = vec_ty_match.group(2)
772 elif struct_name.startswith("LDKC2Tuple_") or struct_name.startswith("LDKC3Tuple_"):
774 trait_fn_match = line_indicates_trait_regex.match(struct_line)
775 if trait_fn_match is not None:
776 trait_fn_lines.append((last_struct_block_comment, trait_fn_match))
777 field_var_match = line_field_var_regex.match(struct_line)
778 if field_var_match is not None:
779 field_var_lines.append(field_var_match)
780 field_lines.append(struct_line)
782 assert(struct_name is not None)
783 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))
784 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))
785 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))
786 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))
787 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))
788 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))
789 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))
792 opaque_structs.add(struct_name)
793 with open(f"{sys.argv[3]}/structs/{struct_name.replace('LDK', '')}{consts.file_ext}", "w") as out_java_struct:
794 out_opaque_struct_human = consts.map_opaque_struct(struct_name, last_block_comment)
795 last_block_comment = None
796 out_java_struct.write(out_opaque_struct_human)
797 elif result_contents is not None:
798 assert result_contents in result_ptr_struct_items
799 res_ty, err_ty = result_ptr_struct_items[result_contents]
800 map_result(struct_name, res_ty, err_ty)
801 elif struct_name.startswith("LDKCResult_") and struct_name.endswith("ZPtr"):
802 for line in field_lines:
803 if line.endswith("*result;"):
804 res_ty = line[:-8].strip()
805 elif line.endswith("*err;"):
806 err_ty = line[:-5].strip()
807 result_ptr_struct_items[struct_name] = (res_ty, err_ty)
808 result_types.add(struct_name[:-3])
810 map_tuple(struct_name, field_lines)
811 elif vec_ty is not None:
812 ty_info = type_mapping_generator.map_type(vec_ty + " arr_elem", False, None, False, False)
813 if len(ty_info.java_fn_ty_arg) == 1: # ie we're a primitive of some form
814 out_java.write("\tpublic static native long " + struct_name + "_new(" + ty_info.java_ty + "[] elems);\n")
815 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")
816 write_c("\t" + struct_name + " *ret = MALLOC(sizeof(" + struct_name + "), \"" + struct_name + "\");\n")
817 write_c("\tret->datalen = " + consts.get_native_arr_len_call[0] + "elems" + consts.get_native_arr_len_call[1] + ";\n")
818 write_c("\tif (ret->datalen == 0) {\n")
819 write_c("\t\tret->data = NULL;\n")
820 write_c("\t} else {\n")
821 write_c("\t\tret->data = MALLOC(sizeof(" + vec_ty + ") * ret->datalen, \"" + struct_name + " Data\");\n")
822 native_arr_ptr_call = consts.get_native_arr_ptr_call(ty_info.ty_info)
823 write_c("\t\t" + ty_info.c_ty + " *java_elems = " + native_arr_ptr_call[0] + "elems" + native_arr_ptr_call[1] + ";\n")
824 write_c("\t\tfor (size_t i = 0; i < ret->datalen; i++) {\n")
825 if ty_info.arg_conv is not None:
826 write_c("\t\t\t" + ty_info.c_ty + " arr_elem = java_elems[i];\n")
827 write_c("\t\t\t" + ty_info.arg_conv.replace("\n", "\n\t\t\t") + "\n")
828 write_c("\t\t\tret->data[i] = " + ty_info.arg_conv_name + ";\n")
829 assert ty_info.arg_conv_cleanup is None
831 write_c("\t\t\tret->data[i] = java_elems[i];\n")
833 cleanup = consts.release_native_arr_ptr_call(ty_info.ty_info, "elems", "java_elems")
834 if cleanup is not None:
835 write_c("\t\t" + cleanup + ";\n")
837 write_c("\treturn (long)ret;\n")
840 if ty_info.is_native_primitive:
841 clone_fns.add(struct_name.replace("LDK", "") + "_clone")
842 write_c("static inline " + struct_name + " " + struct_name.replace("LDK", "") + "_clone(const " + struct_name + " *orig) {\n")
843 write_c("\t" + struct_name + " ret = { .data = MALLOC(sizeof(" + ty_info.c_ty + ") * orig->datalen, \"" + struct_name + " clone bytes\"), .datalen = orig->datalen };\n")
844 write_c("\tmemcpy(ret.data, orig->data, sizeof(" + ty_info.c_ty + ") * ret.datalen);\n")
845 write_c("\treturn ret;\n}\n")
846 elif (ty_info.rust_obj.replace("LDK", "") + "_clone") in clone_fns:
847 ty_name = "CVec_" + ty_info.rust_obj.replace("LDK", "") + "Z";
848 clone_fns.add(ty_name + "_clone")
849 write_c("static inline " + struct_name + " " + ty_name + "_clone(const " + struct_name + " *orig) {\n")
850 write_c("\t" + struct_name + " ret = { .data = MALLOC(sizeof(" + ty_info.rust_obj + ") * orig->datalen, \"" + struct_name + " clone bytes\"), .datalen = orig->datalen };\n")
851 write_c("\tfor (size_t i = 0; i < ret.datalen; i++) {\n")
852 write_c("\t\tret.data[i] = " + ty_info.rust_obj.replace("LDK", "") + "_clone(&orig->data[i]);\n")
853 write_c("\t}\n\treturn ret;\n}\n")
855 assert(struct_name.endswith("_Tag"))
856 struct_name = struct_name[:-4]
857 union_enum_items[struct_name] = {"field_lines": field_lines}
858 elif struct_name.endswith("_Body") and struct_name.split("_")[0] in union_enum_items:
859 enum_var_name = struct_name.split("_")
860 union_enum_items[enum_var_name[0]][enum_var_name[1]] = field_lines
861 elif struct_name in union_enum_items:
862 map_complex_enum(struct_name, union_enum_items[struct_name], last_block_comment)
863 last_block_comment = None
864 elif is_unitary_enum:
865 map_unitary_enum(struct_name, field_lines, last_block_comment)
866 last_block_comment = None
867 elif len(trait_fn_lines) > 0:
868 trait_structs.add(struct_name)
869 map_trait(struct_name, field_var_lines, trait_fn_lines, last_block_comment)
870 elif struct_name == "LDKTxOut":
871 with open(f"{sys.argv[3]}/structs/TxOut{consts.file_ext}", "w") as out_java_struct:
872 out_java_struct.write(consts.hu_struct_file_prefix)
873 out_java_struct.write("public class TxOut extends CommonBase{\n")
874 out_java_struct.write("\tTxOut(java.lang.Object _dummy, long ptr) { super(ptr); }\n")
875 out_java_struct.write("\tlong to_c_ptr() { return 0; }\n")
876 out_java_struct.write("\t@Override @SuppressWarnings(\"deprecation\")\n")
877 out_java_struct.write("\tprotected void finalize() throws Throwable {\n")
878 out_java_struct.write("\t\tsuper.finalize();\n")
879 out_java_struct.write("\t\tif (ptr != 0) { bindings.TxOut_free(ptr); }\n")
880 out_java_struct.write("\t}\n")
882 out_java_struct.write("}")
884 pass # Everything remaining is a byte[] or some form
887 fn_ptr = fn_ptr_regex.match(line)
888 fn_ret_arr = fn_ret_arr_regex.match(line)
889 reg_fn = reg_fn_regex.match(line)
890 const_val = const_val_regex.match(line)
892 if line.startswith("#include <"):
894 elif line.startswith("/*"):
895 if not line.endswith("*/\n"):
896 block_comment = line.strip(" /*")
897 elif line.startswith("typedef enum "):
899 elif line.startswith("typedef struct "):
901 elif line.startswith("typedef union "):
903 elif fn_ptr is not None:
904 map_fn(line, fn_ptr, None, None, last_block_comment)
905 last_block_comment = None
906 elif fn_ret_arr is not None:
907 map_fn(line, fn_ret_arr, fn_ret_arr.group(4), None, last_block_comment)
908 last_block_comment = None
909 elif reg_fn is not None:
910 map_fn(line, reg_fn, None, None, last_block_comment)
911 last_block_comment = None
912 elif const_val_regex is not None:
913 # TODO Map const variables
918 out_java.write(consts.bindings_footer)
919 for struct_name in opaque_structs:
920 with open(f"{sys.argv[3]}/structs/{struct_name.replace('LDK', '')}{consts.file_ext}", "a") as out_java_struct:
921 out_java_struct.write("}\n")
922 for struct_name in trait_structs:
923 with open(f"{sys.argv[3]}/structs/{struct_name.replace('LDK', '')}{consts.file_ext}", "a") as out_java_struct:
924 out_java_struct.write("}\n")
926 with open(sys.argv[4], "w") as out_c:
927 out_c.write(consts.c_file_pfx)
928 out_c.write(consts.init_str())
930 with open(f"{sys.argv[3]}/structs/UtilMethods{consts.file_ext}", "a") as util:
931 util.write(consts.util_fn_sfx)