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 nonnull_ptr = "NONNULL_PTR" in fn_arg
92 fn_arg = fn_arg.replace("NONNULL_PTR", "")
99 if fn_arg.startswith("LDKThirtyTwoBytes"):
100 fn_arg = "uint8_t (*" + fn_arg[18:] + ")[32]"
101 assert var_is_arr_regex.match(fn_arg[8:])
102 rust_obj = "LDKThirtyTwoBytes"
104 elif fn_arg.startswith("LDKPublicKey"):
105 fn_arg = "uint8_t (*" + fn_arg[13:] + ")[33]"
106 assert var_is_arr_regex.match(fn_arg[8:])
107 rust_obj = "LDKPublicKey"
108 arr_access = "compressed_form"
109 elif fn_arg.startswith("LDKSecretKey"):
110 fn_arg = "uint8_t (*" + fn_arg[13:] + ")[32]"
111 assert var_is_arr_regex.match(fn_arg[8:])
112 rust_obj = "LDKSecretKey"
114 elif fn_arg.startswith("LDKSignature"):
115 fn_arg = "uint8_t (*" + fn_arg[13:] + ")[64]"
116 assert var_is_arr_regex.match(fn_arg[8:])
117 rust_obj = "LDKSignature"
118 arr_access = "compact_form"
119 elif fn_arg.startswith("LDKThreeBytes"):
120 fn_arg = "uint8_t (*" + fn_arg[14:] + ")[3]"
121 assert var_is_arr_regex.match(fn_arg[8:])
122 rust_obj = "LDKThreeBytes"
124 elif fn_arg.startswith("LDKFourBytes"):
125 fn_arg = "uint8_t (*" + fn_arg[13:] + ")[4]"
126 assert var_is_arr_regex.match(fn_arg[8:])
127 rust_obj = "LDKFourBytes"
129 elif fn_arg.startswith("LDKSixteenBytes"):
130 fn_arg = "uint8_t (*" + fn_arg[16:] + ")[16]"
131 assert var_is_arr_regex.match(fn_arg[8:])
132 rust_obj = "LDKSixteenBytes"
134 elif fn_arg.startswith("LDKTenBytes"):
135 fn_arg = "uint8_t (*" + fn_arg[12:] + ")[10]"
136 assert var_is_arr_regex.match(fn_arg[8:])
137 rust_obj = "LDKTenBytes"
139 elif fn_arg.startswith("LDKu8slice"):
140 fn_arg = "uint8_t (*" + fn_arg[11:] + ")[datalen]"
141 assert var_is_arr_regex.match(fn_arg[8:])
142 rust_obj = "LDKu8slice"
144 elif fn_arg.startswith("LDKCVec_u8Z"):
145 fn_arg = "uint8_t (*" + fn_arg[12:] + ")[datalen]"
146 rust_obj = "LDKCVec_u8Z"
147 assert var_is_arr_regex.match(fn_arg[8:])
149 elif fn_arg.startswith("LDKTransaction"):
150 fn_arg = "uint8_t (*" + fn_arg[15:] + ")[datalen]"
151 rust_obj = "LDKTransaction"
152 assert var_is_arr_regex.match(fn_arg[8:])
154 elif fn_arg.startswith("LDKCVec_"):
157 fn_arg = fn_arg.replace("*", "")
160 tyn = fn_arg[8:].split(" ")
161 assert tyn[0].endswith("Z")
165 new_arg = "LDK" + tyn[0][:-1]
167 new_arg = new_arg + " " + a
168 res = java_c_types(new_arg, ret_arr_len)
170 assert java_c_types_none_allowed
173 res.pass_by_ref = True
174 if res.is_native_primitive or res.passed_as_ptr:
175 return TypeInfo(rust_obj=fn_arg.split(" ")[0], java_ty=res.java_ty + "[]", java_hu_ty=res.java_hu_ty + "[]",
176 java_fn_ty_arg="[" + res.java_fn_ty_arg, c_ty=res.c_ty + "Array", passed_as_ptr=False, is_ptr=is_ptr,
177 nonnull_ptr=nonnull_ptr, is_const=is_const,
178 var_name=res.var_name, arr_len="datalen", arr_access="data", subty=res, is_native_primitive=False)
180 return TypeInfo(rust_obj=fn_arg.split(" ")[0], java_ty=res.java_ty + "[]", java_hu_ty=res.java_hu_ty + "[]",
181 java_fn_ty_arg="[" + res.java_fn_ty_arg, c_ty=consts.ptr_arr, passed_as_ptr=False, is_ptr=is_ptr,
182 nonnull_ptr=nonnull_ptr, is_const=is_const,
183 var_name=res.var_name, arr_len="datalen", arr_access="data", subty=res, is_native_primitive=False)
188 java_type_plural = None
189 if fn_arg.startswith("void"):
193 fn_arg = fn_arg[4:].strip()
195 elif fn_arg.startswith("bool"):
199 fn_arg = fn_arg[4:].strip()
201 elif fn_arg.startswith("uint8_t"):
202 mapped_type = consts.c_type_map['uint8_t']
203 java_ty = mapped_type[0]
206 fn_arg = fn_arg[7:].strip()
208 elif fn_arg.startswith("uint16_t"):
209 mapped_type = consts.c_type_map['uint16_t']
210 java_ty = mapped_type[0]
213 fn_arg = fn_arg[8:].strip()
215 elif fn_arg.startswith("uint32_t"):
216 mapped_type = consts.c_type_map['uint32_t']
217 java_ty = mapped_type[0]
220 fn_arg = fn_arg[8:].strip()
222 elif fn_arg.startswith("uint64_t") or fn_arg.startswith("uintptr_t"):
223 # TODO: uintptr_t is arch-dependent :(
224 mapped_type = consts.c_type_map['uint64_t']
225 java_ty = mapped_type[0]
227 if fn_arg.startswith("uint64_t"):
229 fn_arg = fn_arg[8:].strip()
232 rust_obj = "uintptr_t"
233 fn_arg = fn_arg[9:].strip()
235 elif is_const and fn_arg.startswith("char *"):
238 fn_ty_arg = "Ljava/lang/String;"
239 fn_arg = fn_arg[6:].strip()
240 elif fn_arg.startswith("LDKStr"):
243 fn_ty_arg = "Ljava/lang/String;"
244 fn_arg = fn_arg[6:].strip()
248 ma = var_ty_regex.match(fn_arg)
249 if ma.group(1).strip() in unitary_enums:
250 java_ty = ma.group(1).strip()
251 c_ty = consts.result_c_ty
252 fn_ty_arg = "Lorg/ldk/enums/" + ma.group(1).strip() + ";"
253 fn_arg = ma.group(2).strip()
254 rust_obj = ma.group(1).strip()
255 elif ma.group(1).strip().startswith("LDKC2Tuple"):
256 c_ty = consts.ptr_c_ty
257 java_ty = consts.ptr_native_ty
258 java_hu_ty = "TwoTuple<"
259 if not ma.group(1).strip() in tuple_types:
260 assert java_c_types_none_allowed
262 for idx, ty_info in enumerate(tuple_types[ma.group(1).strip()][0]):
264 java_hu_ty = java_hu_ty + ", "
265 if ty_info.is_native_primitive:
266 if ty_info.java_hu_ty == "int":
267 java_hu_ty = java_hu_ty + "Integer" # Java concrete integer type is Integer, not Int
269 java_hu_ty = java_hu_ty + ty_info.java_hu_ty.title() # If we're a primitive, capitalize the first letter
271 java_hu_ty = java_hu_ty + ty_info.java_hu_ty
272 java_hu_ty = java_hu_ty + ">"
274 fn_arg = ma.group(2).strip()
275 rust_obj = ma.group(1).strip()
277 elif ma.group(1).strip().startswith("LDKC3Tuple"):
278 c_ty = consts.ptr_c_ty
279 java_ty = consts.ptr_native_ty
280 java_hu_ty = "ThreeTuple<"
281 if not ma.group(1).strip() in tuple_types:
282 assert java_c_types_none_allowed
284 for idx, ty_info in enumerate(tuple_types[ma.group(1).strip()][0]):
286 java_hu_ty = java_hu_ty + ", "
287 if ty_info.is_native_primitive:
288 if ty_info.java_hu_ty == "int":
289 java_hu_ty = java_hu_ty + "Integer" # Java concrete integer type is Integer, not Int
291 java_hu_ty = java_hu_ty + ty_info.java_hu_ty.title() # If we're a primitive, capitalize the first letter
293 java_hu_ty = java_hu_ty + ty_info.java_hu_ty
294 java_hu_ty = java_hu_ty + ">"
296 fn_arg = ma.group(2).strip()
297 rust_obj = ma.group(1).strip()
300 c_ty = consts.ptr_c_ty
301 java_ty = consts.ptr_native_ty
302 java_hu_ty = ma.group(1).strip().replace("LDKCOption", "Option").replace("LDKCResult", "Result").replace("LDK", "")
304 fn_arg = ma.group(2).strip()
305 rust_obj = ma.group(1).strip()
308 if fn_arg.startswith(" *") or fn_arg.startswith("*"):
309 fn_arg = fn_arg.replace("*", "").strip()
311 c_ty = consts.ptr_c_ty
312 java_ty = consts.ptr_native_ty
315 var_is_arr = var_is_arr_regex.match(fn_arg)
316 if var_is_arr is not None or ret_arr_len is not None:
317 assert(not take_by_ptr)
319 # is there a special case for plurals?
320 if len(mapped_type) == 2:
321 java_ty = mapped_type[1]
323 java_ty = java_ty + "[]"
324 c_ty = c_ty + "Array"
325 if var_is_arr is not None:
326 if var_is_arr.group(1) == "":
327 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,
328 passed_as_ptr=False, is_ptr=False, nonnull_ptr=nonnull_ptr, var_name="arg",
329 arr_len=var_is_arr.group(2), arr_access=arr_access, is_native_primitive=False)
330 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,
331 passed_as_ptr=False, is_ptr=False, nonnull_ptr=nonnull_ptr, var_name=var_is_arr.group(1),
332 arr_len=var_is_arr.group(2), arr_access=arr_access, is_native_primitive=False)
334 if java_hu_ty is None:
336 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,
337 is_const=is_const, is_ptr=is_ptr, nonnull_ptr=nonnull_ptr, var_name=fn_arg, arr_len=arr_len, arr_access=arr_access, is_native_primitive=is_primitive)
339 fn_ptr_regex = re.compile("^extern const ([A-Za-z_0-9\* ]*) \(\*(.*)\)\((.*)\);$")
340 fn_ret_arr_regex = re.compile("(.*) \(\*(.*)\((.*)\)\)\[([0-9]*)\];$")
341 reg_fn_regex = re.compile("([A-Za-z_0-9\* ]* \*?)([a-zA-Z_0-9]*)\((.*)\);$")
345 from gen_type_mapping import TypeMappingGenerator
346 type_mapping_generator = TypeMappingGenerator(java_c_types, consts, opaque_structs, clone_fns, unitary_enums, trait_structs, complex_enums, result_types, tuple_types)
348 with open(sys.argv[1]) as in_h:
350 reg_fn = reg_fn_regex.match(line)
351 if reg_fn is not None:
352 if reg_fn.group(2).endswith("_clone"):
353 clone_fns.add(reg_fn.group(2))
355 rty = java_c_types(reg_fn.group(1), None)
356 if rty is not None and not rty.is_native_primitive and reg_fn.group(2) == rty.java_hu_ty + "_new":
357 constructor_fns[rty.rust_obj] = reg_fn.group(3)
359 arr_fn = fn_ret_arr_regex.match(line)
360 if arr_fn is not None:
361 if arr_fn.group(2).endswith("_clone"):
362 clone_fns.add(arr_fn.group(2))
363 # No object constructors return arrays, as then they wouldn't be an object constructor
366 # Define some manual clones...
367 clone_fns.add("ThirtyTwoBytes_clone")
368 write_c("static inline struct LDKThirtyTwoBytes ThirtyTwoBytes_clone(const struct LDKThirtyTwoBytes *orig) { struct LDKThirtyTwoBytes ret; memcpy(ret.data, orig->data, 32); return ret; }\n")
370 java_c_types_none_allowed = False # C structs created by cbindgen are declared in dependency order
372 with open(f"{sys.argv[3]}/structs/UtilMethods{consts.file_ext}", "a") as util:
373 util.write(consts.util_fn_pfx)
375 with open(sys.argv[1]) as in_h, open(sys.argv[2], "w") as out_java:
376 # Map a top-level function
377 def map_fn(line, re_match, ret_arr_len, c_call_string, doc_comment):
378 method_return_type = re_match.group(1)
379 method_name = re_match.group(2)
380 method_comma_separated_arguments = re_match.group(3)
381 method_arguments = method_comma_separated_arguments.split(',')
383 is_free = method_name.endswith("_free")
384 if method_name.startswith("COption") or method_name.startswith("CResult"):
385 struct_meth = method_name.rsplit("Z", 1)[0][1:] + "Z"
387 struct_meth = method_name.split("_")[0]
389 return_type_info = type_mapping_generator.map_type(method_return_type, True, ret_arr_len, False, False)
392 default_constructor_args = {}
396 for argument_index, argument in enumerate(method_arguments):
397 argument_conversion_info = type_mapping_generator.map_type(argument, False, None, is_free, True)
398 if argument_index == 0 and argument_conversion_info.java_hu_ty == struct_meth:
400 if argument_conversion_info.arg_conv is not None and "Warning" in argument_conversion_info.arg_conv:
401 if argument_conversion_info.rust_obj in constructor_fns:
403 for explode_arg in constructor_fns[argument_conversion_info.rust_obj].split(','):
404 explode_arg_conv = type_mapping_generator.map_type(explode_arg, False, None, False, True)
405 if explode_arg_conv.c_ty == "void":
406 # We actually want to handle this case, but for now its only used in NetGraphMsgHandler::new()
407 # which ends up resulting in a redundant constructor - both without arguments for the NetworkGraph.
410 if not argument_conversion_info.arg_name in default_constructor_args:
411 default_constructor_args[argument_conversion_info.arg_name] = []
412 default_constructor_args[argument_conversion_info.arg_name].append(explode_arg_conv)
413 argument_types.append(argument_conversion_info)
415 out_java.write("\t// " + line)
416 (out_java_delta, out_c_delta, out_java_struct_delta) = \
417 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)
418 out_java.write(out_java_delta)
421 assert len(argument_types) == 1
422 assert return_type_info.c_ty == "void"
423 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")
424 if argument_types[0].ty_info.passed_as_ptr and not argument_types[0].ty_info.rust_obj in opaque_structs:
425 write_c("\tif ((" + argument_types[0].ty_info.var_name + " & 1) != 0) return;\n")
427 for info in argument_types:
428 if info.arg_conv is not None:
429 write_c("\t" + info.arg_conv.replace('\n', "\n\t") + "\n")
430 assert c_call_string is None
431 write_c("\t" + method_name + "(")
432 if argument_types[0].arg_conv_name is not None:
433 write_c(argument_types[0].arg_conv_name)
435 for info in argument_types:
436 if info.arg_conv_cleanup is not None:
437 write_c("\n\t" + info.arg_conv_cleanup.replace("\n", "\n\t"))
442 out_java_struct = None
443 if ("LDK" + struct_meth in opaque_structs or "LDK" + struct_meth in trait_structs
444 or "LDK" + struct_meth in complex_enums or "LDKC" + struct_meth in complex_enums
445 or "LDKC" + struct_meth in result_types) and not is_free:
446 out_java_struct = open(f"{sys.argv[3]}/structs/{struct_meth}{consts.file_ext}", "a")
447 elif method_name.startswith("C2Tuple_") and method_name.endswith("_read"):
448 struct_meth = method_name.rsplit("_", 1)[0]
449 out_java_struct = open(f"{sys.argv[3]}/structs/UtilMethods{consts.file_ext}", "a")
450 if out_java_struct is not None:
451 out_java_struct.write(out_java_struct_delta)
453 def map_unitary_enum(struct_name, field_lines, enum_doc_comment):
454 with open(f"{sys.argv[3]}/enums/{struct_name}{consts.file_ext}", "w") as out_java_enum:
455 unitary_enums.add(struct_name)
456 for idx, struct_line in enumerate(field_lines):
458 assert(struct_line == "typedef enum %s {" % struct_name)
459 elif idx == len(field_lines) - 3:
460 assert(struct_line.endswith("_Sentinel,"))
461 elif idx == len(field_lines) - 2:
462 assert(struct_line == "} %s;" % struct_name)
463 elif idx == len(field_lines) - 1:
464 assert(struct_line == "")
465 (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)
467 out_java_enum.write(native_file_out)
468 out_java.write(native_out)
470 def map_complex_enum(struct_name, union_enum_items, inline_enum_variants, enum_doc_comment):
471 java_hu_type = struct_name.replace("LDK", "").replace("COption", "Option")
472 complex_enums.add(struct_name)
475 tag_field_lines = union_enum_items["field_lines"]
476 for idx, struct_line in enumerate(tag_field_lines):
478 assert(struct_line == "typedef enum %s_Tag {" % struct_name)
479 elif idx == len(tag_field_lines) - 3:
480 assert(struct_line.endswith("_Sentinel,"))
481 elif idx == len(tag_field_lines) - 2:
482 assert(struct_line == "} %s_Tag;" % struct_name)
483 elif idx == len(tag_field_lines) - 1:
484 assert(struct_line == "")
486 variant_name = struct_line.strip(' ,')[len(struct_name) + 1:]
488 if "LDK" + variant_name in union_enum_items:
489 enum_var_lines = union_enum_items["LDK" + variant_name]
490 for idx, field in enumerate(enum_var_lines):
491 if idx != 0 and idx < len(enum_var_lines) - 2:
492 fields.append(type_mapping_generator.map_type(field.strip(' ;'), False, None, False, True))
493 enum_variants.append(ComplexEnumVariantInfo(variant_name, fields, False))
494 elif camel_to_snake(variant_name) in inline_enum_variants:
495 fields.append(type_mapping_generator.map_type(inline_enum_variants[camel_to_snake(variant_name)] + " " + camel_to_snake(variant_name), False, None, False, True))
496 enum_variants.append(ComplexEnumVariantInfo(variant_name, fields, True))
498 enum_variants.append(ComplexEnumVariantInfo(variant_name, fields, True))
500 with open(f"{sys.argv[3]}/structs/{java_hu_type}{consts.file_ext}", "w") as out_java_enum:
501 (out_java_addendum, out_java_enum_addendum, out_c_addendum) = consts.map_complex_enum(struct_name, enum_variants, camel_to_snake, enum_doc_comment)
503 out_java_enum.write(out_java_enum_addendum)
504 out_java.write(out_java_addendum)
505 write_c(out_c_addendum)
507 def map_trait(struct_name, field_var_lines, trait_fn_lines, trait_doc_comment):
508 with open(f"{sys.argv[3]}/structs/{struct_name.replace('LDK', '')}{consts.file_ext}", "w") as out_java_trait:
510 for var_line in field_var_lines:
511 if var_line.group(1) in trait_structs:
512 field_var_convs.append((var_line.group(1), var_line.group(2)))
514 field_var_convs.append(
515 type_mapping_generator.map_type(var_line.group(1) + " " + var_line.group(2), False, None, False, False))
518 for fn_docs, fn_line in trait_fn_lines:
519 ret_ty_info = type_mapping_generator.map_type(fn_line.group(2), True, None, False, False)
520 is_const = fn_line.group(4) is not None
523 for idx, arg in enumerate(fn_line.group(5).split(',')):
526 arg_conv_info = type_mapping_generator.map_type(arg, True, None, False, False)
527 arg_tys.append(arg_conv_info)
528 field_fns.append(TraitMethInfo(fn_line.group(3), is_const, ret_ty_info, arg_tys, fn_docs))
530 (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)
531 write_c(out_c_addendum)
532 out_java_trait.write(out_java_trait_addendum)
533 out_java.write(out_java_addendum)
535 for fn_docs, fn_line in trait_fn_lines:
536 # For now, just disable enabling the _call_log - we don't know how to inverse-map String
537 is_log = fn_line.group(3) == "log" and struct_name == "LDKLogger"
538 if fn_line.group(3) != "free" and fn_line.group(3) != "clone" and fn_line.group(3) != "eq" and not is_log:
539 dummy_line = fn_line.group(2) + struct_name.replace("LDK", "") + "_" + fn_line.group(3) + " " + struct_name + " *NONNULL_PTR 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, "(this_arg_conv->" + fn_line.group(3) + ")(this_arg_conv->this_arg", fn_docs)
541 for idx, var_line in enumerate(field_var_lines):
542 if var_line.group(1) not in trait_structs:
543 write_c(var_line.group(1) + " " + struct_name + "_set_get_" + var_line.group(2) + "(" + struct_name + "* this_arg) {\n")
544 write_c("\tif (this_arg->set_" + var_line.group(2) + " != NULL)\n")
545 write_c("\t\tthis_arg->set_" + var_line.group(2) + "(this_arg);\n")
546 write_c("\treturn this_arg->" + var_line.group(2) + ";\n")
548 dummy_line = var_line.group(1) + " " + struct_name.replace("LDK", "") + "_get_" + var_line.group(2) + " " + struct_name + " *NONNULL_PTR this_arg" + fn_line.group(5) + "\n"
549 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)
551 def map_result(struct_name, res_ty, err_ty):
552 result_types.add(struct_name)
553 human_ty = struct_name.replace("LDKCResult", "Result")
554 with open(f"{sys.argv[3]}/structs/{human_ty}{consts.file_ext}", "w") as out_java_struct:
555 out_java_struct.write(consts.hu_struct_file_prefix)
556 out_java_struct.write("public class " + human_ty + " extends CommonBase {\n")
557 out_java_struct.write("\tprivate " + human_ty + "(Object _dummy, long ptr) { super(ptr); }\n")
558 out_java_struct.write("\tprotected void finalize() throws Throwable {\n")
559 out_java_struct.write("\t\tif (ptr != 0) { bindings." + struct_name.replace("LDK","") + "_free(ptr); } super.finalize();\n")
560 out_java_struct.write("\t}\n\n")
561 out_java_struct.write("\tstatic " + human_ty + " constr_from_ptr(long ptr) {\n")
562 out_java_struct.write("\t\tif (bindings." + struct_name + "_result_ok(ptr)) {\n")
563 out_java_struct.write("\t\t\treturn new " + human_ty + "_OK(null, ptr);\n")
564 out_java_struct.write("\t\t} else {\n")
565 out_java_struct.write("\t\t\treturn new " + human_ty + "_Err(null, ptr);\n")
566 out_java_struct.write("\t\t}\n")
567 out_java_struct.write("\t}\n")
569 res_map = type_mapping_generator.map_type(res_ty + " res", True, None, False, True)
570 err_map = type_mapping_generator.map_type(err_ty + " err", True, None, False, True)
572 if not res_map.is_native_primitive and (res_map.rust_obj.replace("LDK", "") + "_clone" not in clone_fns):
574 if not err_map.is_native_primitive and (err_map.rust_obj.replace("LDK", "") + "_clone" not in clone_fns):
577 out_java.write("\tpublic static native boolean " + struct_name + "_result_ok(long arg);\n")
578 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")
579 write_c("\treturn ((" + struct_name + "*)arg)->result_ok;\n")
582 out_java.write("\tpublic static native " + res_map.java_ty + " " + struct_name + "_get_ok(long arg);\n")
583 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")
584 write_c("\t" + struct_name + " *val = (" + struct_name + "*)(arg & ~1);\n")
585 write_c("\tCHECK(val->result_ok);\n\t")
586 out_java_struct.write("\tpublic static final class " + human_ty + "_OK extends " + human_ty + " {\n")
587 if res_map.ret_conv is not None:
588 write_c(res_map.ret_conv[0].replace("\n", "\n\t") + "(*val->contents.result)")
589 write_c(res_map.ret_conv[1].replace("\n", "\n\t") + "\n\treturn " + res_map.ret_conv_name)
591 write_c("return *val->contents.result")
594 if res_map.java_hu_ty != "void":
595 out_java_struct.write("\t\tpublic final " + res_map.java_hu_ty + " res;\n")
596 out_java_struct.write("\t\tprivate " + human_ty + "_OK(Object _dummy, long ptr) {\n")
597 out_java_struct.write("\t\t\tsuper(_dummy, ptr);\n")
598 if res_map.java_hu_ty == "void":
600 elif res_map.to_hu_conv is not None:
601 out_java_struct.write("\t\t\t" + res_map.java_ty + " res = bindings." + struct_name + "_get_ok(ptr);\n")
602 out_java_struct.write("\t\t\t" + res_map.to_hu_conv.replace("\n", "\n\t\t\t"))
603 out_java_struct.write("\n\t\t\tthis.res = " + res_map.to_hu_conv_name + ";\n")
605 out_java_struct.write("\t\t\tthis.res = bindings." + struct_name + "_get_ok(ptr);\n")
606 out_java_struct.write("\t\t}\n")
607 out_java_struct.write("\t}\n\n")
609 out_java.write("\tpublic static native " + err_map.java_ty + " " + struct_name + "_get_err(long arg);\n")
610 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")
611 write_c("\t" + struct_name + " *val = (" + struct_name + "*)(arg & ~1);\n")
612 write_c("\tCHECK(!val->result_ok);\n\t")
613 out_java_struct.write("\tpublic static final class " + human_ty + "_Err extends " + human_ty + " {\n")
614 if err_map.ret_conv is not None:
615 write_c(err_map.ret_conv[0].replace("\n", "\n\t") + "(*val->contents.err)")
616 write_c(err_map.ret_conv[1].replace("\n", "\n\t") + "\n\treturn " + err_map.ret_conv_name)
618 write_c("return *val->contents.err")
621 if err_map.java_hu_ty != "void":
622 out_java_struct.write("\t\tpublic final " + err_map.java_hu_ty + " err;\n")
623 out_java_struct.write("\t\tprivate " + human_ty + "_Err(Object _dummy, long ptr) {\n")
624 out_java_struct.write("\t\t\tsuper(_dummy, ptr);\n")
625 if err_map.java_hu_ty == "void":
627 elif err_map.to_hu_conv is not None:
628 out_java_struct.write("\t\t\t" + err_map.java_ty + " err = bindings." + struct_name + "_get_err(ptr);\n")
629 out_java_struct.write("\t\t\t" + err_map.to_hu_conv.replace("\n", "\n\t\t\t"))
630 out_java_struct.write("\n\t\t\tthis.err = " + err_map.to_hu_conv_name + ";\n")
632 out_java_struct.write("\t\t\tthis.err = bindings." + struct_name + "_get_err(ptr);\n")
633 out_java_struct.write("\t\t}\n")
635 out_java_struct.write("\t}\n\n")
637 def map_tuple(struct_name, field_lines):
638 out_java.write("\tpublic static native long " + struct_name + "_new(")
639 write_c(consts.c_fn_ty_pfx + consts.ptr_c_ty + " " + consts.c_fn_name_define_pfx(struct_name + "_new", len(field_lines) > 3))
641 for idx, line in enumerate(field_lines):
642 if idx != 0 and idx < len(field_lines) - 2:
643 ty_info = java_c_types(line.strip(';'), None)
647 e = chr(ord('a') + idx - 1)
648 out_java.write(ty_info.java_ty + " " + e)
649 write_c(ty_info.c_ty + " " + e)
650 ty_list.append(ty_info)
651 tuple_types[struct_name] = (ty_list, struct_name)
652 out_java.write(");\n")
654 write_c("\t" + struct_name + "* ret = MALLOC(sizeof(" + struct_name + "), \"" + struct_name + "\");\n")
655 for idx, line in enumerate(field_lines):
656 if idx != 0 and idx < len(field_lines) - 2:
657 ty_info = type_mapping_generator.map_type(line.strip(';'), False, None, False, False)
658 e = chr(ord('a') + idx - 1)
659 if ty_info.arg_conv is not None:
660 write_c("\t" + ty_info.arg_conv.replace("\n", "\n\t"))
661 write_c("\n\tret->" + e + " = " + ty_info.arg_conv_name + ";\n")
663 write_c("\tret->" + e + " = " + e + ";\n")
664 if ty_info.arg_conv_cleanup is not None:
665 write_c("\t//TODO: Really need to call " + ty_info.arg_conv_cleanup + " here\n")
666 write_c("\treturn (long)ret;\n")
669 for idx, ty_info in enumerate(ty_list):
670 e = chr(ord('a') + idx)
671 out_java.write("\tpublic static native " + ty_info.java_ty + " " + struct_name + "_get_" + e + "(long ptr);\n")
672 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")
673 write_c("\t" + struct_name + " *tuple = (" + struct_name + "*)(ptr & ~1);\n")
674 conv_info = type_mapping_generator.map_type_with_info(ty_info, False, None, False, True)
675 if conv_info.ret_conv is not None:
676 write_c("\t" + conv_info.ret_conv[0].replace("\n", "\n\t") + "tuple->" + e + conv_info.ret_conv[1].replace("\n", "\n\t") + "\n")
677 write_c("\treturn " + conv_info.ret_conv_name + ";\n")
679 write_c("\treturn tuple->" + e + ";\n")
682 out_java.write(consts.bindings_header)
684 with open(f"{sys.argv[3]}/structs/CommonBase{consts.file_ext}", "w") as out_java_struct:
685 out_java_struct.write(consts.common_base)
688 last_block_comment = None
691 const_val_regex = re.compile("^extern const ([A-Za-z_0-9]*) ([A-Za-z_0-9]*);$")
693 line_indicates_result_regex = re.compile("^ union (LDKCResult_[A-Za-z_0-9]*Ptr) contents;$")
694 line_indicates_vec_regex = re.compile("^ (struct |enum |union )?([A-Za-z_0-9]*) \*data;$")
695 line_indicates_opaque_regex = re.compile("^ bool is_owned;$")
696 line_indicates_trait_regex = re.compile("^ (struct |enum |union )?([A-Za-z_0-9]* \*?)\(\*([A-Za-z_0-9]*)\)\((const )?void \*this_arg(.*)\);$")
697 assert(line_indicates_trait_regex.match(" uintptr_t (*send_data)(void *this_arg, LDKu8slice data, bool resume_read);"))
698 assert(line_indicates_trait_regex.match(" struct LDKCVec_MessageSendEventZ (*get_and_clear_pending_msg_events)(const void *this_arg);"))
699 assert(line_indicates_trait_regex.match(" void *(*clone)(const void *this_arg);"))
700 assert(line_indicates_trait_regex.match(" struct LDKCVec_u8Z (*write)(const void *this_arg);"))
701 line_field_var_regex = re.compile("^ struct ([A-Za-z_0-9]*) ([A-Za-z_0-9]*);$")
702 assert(line_field_var_regex.match(" struct LDKMessageSendEventsProvider MessageSendEventsProvider;"))
703 assert(line_field_var_regex.match(" struct LDKChannelPublicKeys pubkeys;"))
704 struct_name_regex = re.compile("^typedef (struct|enum|union) (MUST_USE_STRUCT )?(LDK[A-Za-z_0-9]*) {$")
705 assert(struct_name_regex.match("typedef struct LDKCVec_u8Z {"))
706 assert(struct_name_regex.match("typedef enum LDKNetwork {"))
708 union_enum_items = {}
709 result_ptr_struct_items = {}
711 if block_comment is not None:
712 if line.endswith("*/\n"):
713 last_block_comment = block_comment.strip("\n")
716 block_comment = block_comment + line.strip(" /*")
717 elif cur_block_obj is not None:
718 cur_block_obj = cur_block_obj + line
719 if line.startswith("} "):
723 obj_lines = cur_block_obj.split("\n")
725 result_contents = None
726 is_unitary_enum = False
727 is_union_enum = False
733 for idx, struct_line in enumerate(obj_lines):
734 if struct_line.strip().startswith("/*"):
735 block_comment = struct_line.strip(" /*")
736 if block_comment is not None:
737 if struct_line.endswith("*/"):
738 last_struct_block_comment = block_comment.strip("\n")
741 block_comment = block_comment + "\n" + struct_line.strip(" /*")
743 struct_name_match = struct_name_regex.match(struct_line)
744 if struct_name_match is not None:
745 struct_name = struct_name_match.group(3)
746 if struct_name_match.group(1) == "enum":
747 if not struct_name.endswith("_Tag"):
748 is_unitary_enum = True
751 elif struct_name_match.group(1) == "union":
753 if line_indicates_opaque_regex.match(struct_line):
755 result_match = line_indicates_result_regex.match(struct_line)
756 if result_match is not None:
757 result_contents = result_match.group(1)
758 vec_ty_match = line_indicates_vec_regex.match(struct_line)
759 if vec_ty_match is not None and struct_name.startswith("LDKCVec_"):
760 vec_ty = vec_ty_match.group(2)
761 elif struct_name.startswith("LDKC2Tuple_") or struct_name.startswith("LDKC3Tuple_"):
763 trait_fn_match = line_indicates_trait_regex.match(struct_line)
764 if trait_fn_match is not None:
765 trait_fn_lines.append((last_struct_block_comment, trait_fn_match))
766 field_var_match = line_field_var_regex.match(struct_line)
767 if field_var_match is not None:
768 field_var_lines.append(field_var_match)
769 field_lines.append(struct_line)
771 assert(struct_name is not None)
772 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))
773 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))
774 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))
775 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))
776 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))
777 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))
778 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))
781 opaque_structs.add(struct_name)
782 with open(f"{sys.argv[3]}/structs/{struct_name.replace('LDK', '')}{consts.file_ext}", "w") as out_java_struct:
783 out_opaque_struct_human = consts.map_opaque_struct(struct_name, last_block_comment)
784 last_block_comment = None
785 out_java_struct.write(out_opaque_struct_human)
786 elif result_contents is not None:
787 assert result_contents in result_ptr_struct_items
788 res_ty, err_ty = result_ptr_struct_items[result_contents]
789 map_result(struct_name, res_ty, err_ty)
790 elif struct_name.startswith("LDKCResult_") and struct_name.endswith("ZPtr"):
791 for line in field_lines:
792 if line.endswith("*result;"):
793 res_ty = line[:-8].strip()
794 elif line.endswith("*err;"):
795 err_ty = line[:-5].strip()
796 result_ptr_struct_items[struct_name] = (res_ty, err_ty)
797 result_types.add(struct_name[:-3])
799 map_tuple(struct_name, field_lines)
800 elif vec_ty is not None:
801 ty_info = type_mapping_generator.map_type(vec_ty + " arr_elem", False, None, False, False)
802 if len(ty_info.java_fn_ty_arg) == 1: # ie we're a primitive of some form
803 out_java.write("\tpublic static native long " + struct_name + "_new(" + ty_info.java_ty + "[] elems);\n")
804 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")
805 write_c("\t" + struct_name + " *ret = MALLOC(sizeof(" + struct_name + "), \"" + struct_name + "\");\n")
806 write_c("\tret->datalen = " + consts.get_native_arr_len_call[0] + "elems" + consts.get_native_arr_len_call[1] + ";\n")
807 write_c("\tif (ret->datalen == 0) {\n")
808 write_c("\t\tret->data = NULL;\n")
809 write_c("\t} else {\n")
810 write_c("\t\tret->data = MALLOC(sizeof(" + vec_ty + ") * ret->datalen, \"" + struct_name + " Data\");\n")
811 native_arr_ptr_call = consts.get_native_arr_ptr_call(ty_info.ty_info)
812 write_c("\t\t" + ty_info.c_ty + " *java_elems = " + native_arr_ptr_call[0] + "elems" + native_arr_ptr_call[1] + ";\n")
813 write_c("\t\tfor (size_t i = 0; i < ret->datalen; i++) {\n")
814 if ty_info.arg_conv is not None:
815 write_c("\t\t\t" + ty_info.c_ty + " arr_elem = java_elems[i];\n")
816 write_c("\t\t\t" + ty_info.arg_conv.replace("\n", "\n\t\t\t") + "\n")
817 write_c("\t\t\tret->data[i] = " + ty_info.arg_conv_name + ";\n")
818 assert ty_info.arg_conv_cleanup is None
820 write_c("\t\t\tret->data[i] = java_elems[i];\n")
822 cleanup = consts.release_native_arr_ptr_call(ty_info.ty_info, "elems", "java_elems")
823 if cleanup is not None:
824 write_c("\t\t" + cleanup + ";\n")
826 write_c("\treturn (long)ret;\n")
829 if ty_info.is_native_primitive:
830 clone_fns.add(struct_name.replace("LDK", "") + "_clone")
831 write_c("static inline " + struct_name + " " + struct_name.replace("LDK", "") + "_clone(const " + struct_name + " *orig) {\n")
832 write_c("\t" + struct_name + " ret = { .data = MALLOC(sizeof(" + ty_info.c_ty + ") * orig->datalen, \"" + struct_name + " clone bytes\"), .datalen = orig->datalen };\n")
833 write_c("\tmemcpy(ret.data, orig->data, sizeof(" + ty_info.c_ty + ") * ret.datalen);\n")
834 write_c("\treturn ret;\n}\n")
835 elif (ty_info.rust_obj.replace("LDK", "") + "_clone") in clone_fns:
836 ty_name = "CVec_" + ty_info.rust_obj.replace("LDK", "") + "Z";
837 clone_fns.add(ty_name + "_clone")
838 write_c("static inline " + struct_name + " " + ty_name + "_clone(const " + struct_name + " *orig) {\n")
839 write_c("\t" + struct_name + " ret = { .data = MALLOC(sizeof(" + ty_info.rust_obj + ") * orig->datalen, \"" + struct_name + " clone bytes\"), .datalen = orig->datalen };\n")
840 write_c("\tfor (size_t i = 0; i < ret.datalen; i++) {\n")
841 write_c("\t\tret.data[i] = " + ty_info.rust_obj.replace("LDK", "") + "_clone(&orig->data[i]);\n")
842 write_c("\t}\n\treturn ret;\n}\n")
844 assert(struct_name.endswith("_Tag"))
845 struct_name = struct_name[:-4]
846 union_enum_items[struct_name] = {"field_lines": field_lines}
847 elif struct_name.endswith("_Body") and struct_name.split("_")[0] in union_enum_items:
848 enum_var_name = struct_name.split("_")
849 union_enum_items[enum_var_name[0]][enum_var_name[1]] = field_lines
850 elif struct_name in union_enum_items:
853 for line in field_lines:
854 if line == " struct {":
858 elif elem_items > -1:
860 if line.startswith("struct "):
862 split = line.split(" ")
863 assert len(split) == 2
864 tuple_variants[split[1].strip(";")] = split[0]
867 # We don't currently support tuple variant with more than one element
869 map_complex_enum(struct_name, union_enum_items[struct_name], tuple_variants, last_block_comment)
870 last_block_comment = None
871 elif is_unitary_enum:
872 map_unitary_enum(struct_name, field_lines, last_block_comment)
873 last_block_comment = None
874 elif len(trait_fn_lines) > 0:
875 trait_structs.add(struct_name)
876 map_trait(struct_name, field_var_lines, trait_fn_lines, last_block_comment)
877 elif struct_name == "LDKTxOut":
878 with open(f"{sys.argv[3]}/structs/TxOut{consts.file_ext}", "w") as out_java_struct:
879 out_java_struct.write(consts.hu_struct_file_prefix)
880 out_java_struct.write("public class TxOut extends CommonBase{\n")
881 out_java_struct.write("\tTxOut(java.lang.Object _dummy, long ptr) { super(ptr); }\n")
882 out_java_struct.write("\tlong to_c_ptr() { return 0; }\n")
883 out_java_struct.write("\t@Override @SuppressWarnings(\"deprecation\")\n")
884 out_java_struct.write("\tprotected void finalize() throws Throwable {\n")
885 out_java_struct.write("\t\tsuper.finalize();\n")
886 out_java_struct.write("\t\tif (ptr != 0) { bindings.TxOut_free(ptr); }\n")
887 out_java_struct.write("\t}\n")
889 out_java_struct.write("}")
891 pass # Everything remaining is a byte[] or some form
894 fn_ptr = fn_ptr_regex.match(line)
895 fn_ret_arr = fn_ret_arr_regex.match(line)
896 reg_fn = reg_fn_regex.match(line)
897 const_val = const_val_regex.match(line)
899 if line.startswith("#include <"):
901 elif line.startswith("/*"):
902 if not line.endswith("*/\n"):
903 block_comment = line.strip(" /*")
904 elif line.startswith("typedef enum "):
906 elif line.startswith("typedef struct "):
908 elif line.startswith("typedef union "):
910 elif fn_ptr is not None:
911 map_fn(line, fn_ptr, None, None, last_block_comment)
912 last_block_comment = None
913 elif fn_ret_arr is not None:
914 map_fn(line, fn_ret_arr, fn_ret_arr.group(4), None, last_block_comment)
915 last_block_comment = None
916 elif reg_fn is not None:
917 map_fn(line, reg_fn, None, None, last_block_comment)
918 last_block_comment = None
919 elif const_val_regex is not None:
920 # TODO Map const variables
925 out_java.write(consts.bindings_footer)
926 for struct_name in opaque_structs:
927 with open(f"{sys.argv[3]}/structs/{struct_name.replace('LDK', '')}{consts.file_ext}", "a") as out_java_struct:
928 out_java_struct.write("}\n")
929 for struct_name in trait_structs:
930 with open(f"{sys.argv[3]}/structs/{struct_name.replace('LDK', '')}{consts.file_ext}", "a") as out_java_struct:
931 out_java_struct.write("}\n")
932 for struct_name in complex_enums:
933 with open(f"{sys.argv[3]}/structs/{struct_name.replace('LDK', '').replace('COption', 'Option')}{consts.file_ext}", "a") as out_java_struct:
934 out_java_struct.write("}\n")
935 for struct_name in result_types:
936 with open(f"{sys.argv[3]}/structs/{struct_name.replace('LDKCResult', 'Result')}{consts.file_ext}", "a") as out_java_struct:
937 out_java_struct.write("}\n")
939 with open(sys.argv[4], "w") as out_c:
940 out_c.write(consts.c_file_pfx)
941 out_c.write(consts.init_str())
943 with open(f"{sys.argv[3]}/structs/UtilMethods{consts.file_ext}", "a") as util:
944 util.write(consts.util_fn_sfx)