2 import sys, re, subprocess
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 local_git_version = subprocess.check_output(["git", "describe", '--tag', '--dirty']).decode("utf-8").strip()
38 from bindingstypes import *
45 def camel_to_snake(s):
46 # Convert camel case to snake case, in a way that appears to match cbindgen
52 if lastchar.isupper():
53 if not char.isupper() and not lastund:
58 ret = ret + lastchar.lower()
61 if char.isupper() and not lastund:
69 return (ret + lastchar.lower()).strip("_")
73 opaque_structs = set()
78 var_is_arr_regex = re.compile("\(\*([A-za-z0-9_]*)\)\[([a-z0-9]*)\]")
79 var_ty_regex = re.compile("([A-za-z_0-9]*)(.*)")
80 java_c_types_none_allowed = True # Unset when we do the real pass that populates the above sets
81 def java_c_types(fn_arg, ret_arr_len):
82 fn_arg = fn_arg.strip()
83 if fn_arg.startswith("MUST_USE_RES "):
86 if fn_arg.startswith("const "):
89 if fn_arg.startswith("struct "):
91 if fn_arg.startswith("enum "):
93 nonnull_ptr = "NONNULL_PTR" in fn_arg
94 fn_arg = fn_arg.replace("NONNULL_PTR", "")
101 if fn_arg.startswith("LDKThirtyTwoBytes"):
102 fn_arg = "uint8_t (*" + fn_arg[18:] + ")[32]"
103 assert var_is_arr_regex.match(fn_arg[8:])
104 rust_obj = "LDKThirtyTwoBytes"
106 elif fn_arg.startswith("LDKTxid"):
107 fn_arg = "uint8_t (*" + fn_arg[8:] + ")[32]"
108 assert var_is_arr_regex.match(fn_arg[8:])
109 rust_obj = "LDKThirtyTwoBytes"
111 elif fn_arg.startswith("LDKPublicKey"):
112 fn_arg = "uint8_t (*" + fn_arg[13:] + ")[33]"
113 assert var_is_arr_regex.match(fn_arg[8:])
114 rust_obj = "LDKPublicKey"
115 arr_access = "compressed_form"
116 elif fn_arg.startswith("LDKSecretKey"):
117 fn_arg = "uint8_t (*" + fn_arg[13:] + ")[32]"
118 assert var_is_arr_regex.match(fn_arg[8:])
119 rust_obj = "LDKSecretKey"
121 elif fn_arg.startswith("LDKSignature"):
122 fn_arg = "uint8_t (*" + fn_arg[13:] + ")[64]"
123 assert var_is_arr_regex.match(fn_arg[8:])
124 rust_obj = "LDKSignature"
125 arr_access = "compact_form"
126 elif fn_arg.startswith("LDKRecoverableSignature"):
127 fn_arg = "uint8_t (*" + fn_arg[25:] + ")[68]"
128 assert var_is_arr_regex.match(fn_arg[8:])
129 rust_obj = "LDKRecoverableSignature"
130 arr_access = "serialized_form"
131 elif fn_arg.startswith("LDKThreeBytes"):
132 fn_arg = "uint8_t (*" + fn_arg[14:] + ")[3]"
133 assert var_is_arr_regex.match(fn_arg[8:])
134 rust_obj = "LDKThreeBytes"
136 elif fn_arg.startswith("LDKFourBytes"):
137 fn_arg = "uint8_t (*" + fn_arg[13:] + ")[4]"
138 assert var_is_arr_regex.match(fn_arg[8:])
139 rust_obj = "LDKFourBytes"
141 elif fn_arg.startswith("LDKSixteenBytes"):
142 fn_arg = "uint8_t (*" + fn_arg[16:] + ")[16]"
143 assert var_is_arr_regex.match(fn_arg[8:])
144 rust_obj = "LDKSixteenBytes"
146 elif fn_arg.startswith("LDKTwentyBytes"):
147 fn_arg = "uint8_t (*" + fn_arg[15:] + ")[20]"
148 assert var_is_arr_regex.match(fn_arg[8:])
149 rust_obj = "LDKTwentyBytes"
151 elif fn_arg.startswith("LDKTenBytes"):
152 fn_arg = "uint8_t (*" + fn_arg[12:] + ")[10]"
153 assert var_is_arr_regex.match(fn_arg[8:])
154 rust_obj = "LDKTenBytes"
156 elif fn_arg.startswith("LDKu8slice"):
157 fn_arg = "uint8_t (*" + fn_arg[11:] + ")[datalen]"
158 assert var_is_arr_regex.match(fn_arg[8:])
159 rust_obj = "LDKu8slice"
161 elif fn_arg.startswith("LDKCVec_u8Z"):
162 fn_arg = "uint8_t (*" + fn_arg[12:] + ")[datalen]"
163 rust_obj = "LDKCVec_u8Z"
164 assert var_is_arr_regex.match(fn_arg[8:])
166 elif fn_arg.startswith("LDKTransaction ") or fn_arg == "LDKTransaction":
167 fn_arg = "uint8_t (*" + fn_arg[15:] + ")[datalen]"
168 rust_obj = "LDKTransaction"
169 assert var_is_arr_regex.match(fn_arg[8:])
171 elif fn_arg.startswith("LDKCVec_"):
174 fn_arg = fn_arg.replace("*", "")
177 tyn = fn_arg[8:].split(" ")
178 assert tyn[0].endswith("Z")
182 new_arg = "LDK" + tyn[0][:-1]
184 new_arg = new_arg + " " + a
185 res = java_c_types(new_arg, ret_arr_len)
187 assert java_c_types_none_allowed
190 res.pass_by_ref = True
191 if res.is_native_primitive or res.passed_as_ptr:
192 return TypeInfo(rust_obj=fn_arg.split(" ")[0], java_ty=res.java_ty + "[]", java_hu_ty=res.java_hu_ty + "[]",
193 java_fn_ty_arg="[" + res.java_fn_ty_arg, c_ty=res.c_ty + "Array", passed_as_ptr=False, is_ptr=is_ptr,
194 nonnull_ptr=nonnull_ptr, is_const=is_const,
195 var_name=res.var_name, arr_len="datalen", arr_access="data", subty=res, is_native_primitive=False)
197 return TypeInfo(rust_obj=fn_arg.split(" ")[0], java_ty=res.java_ty + "[]", java_hu_ty=res.java_hu_ty + "[]",
198 java_fn_ty_arg="[" + res.java_fn_ty_arg, c_ty=consts.ptr_arr, passed_as_ptr=False, is_ptr=is_ptr,
199 nonnull_ptr=nonnull_ptr, is_const=is_const,
200 var_name=res.var_name, arr_len="datalen", arr_access="data", subty=res, is_native_primitive=False)
205 java_type_plural = None
206 if fn_arg.startswith("void"):
210 fn_arg = fn_arg[4:].strip()
212 elif fn_arg.startswith("bool"):
216 fn_arg = fn_arg[4:].strip()
218 elif fn_arg.startswith("uint8_t"):
219 mapped_type = consts.c_type_map['uint8_t']
220 java_ty = mapped_type[0]
223 fn_arg = fn_arg[7:].strip()
225 elif fn_arg.startswith("LDKu5"):
226 java_ty = consts.c_type_map['uint8_t'][0]
231 fn_arg = fn_arg[6:].strip()
232 elif fn_arg.startswith("uint16_t"):
233 mapped_type = consts.c_type_map['uint16_t']
234 java_ty = mapped_type[0]
237 fn_arg = fn_arg[8:].strip()
239 elif fn_arg.startswith("uint32_t"):
240 mapped_type = consts.c_type_map['uint32_t']
241 java_ty = mapped_type[0]
244 fn_arg = fn_arg[8:].strip()
246 elif fn_arg.startswith("uint64_t") or fn_arg.startswith("uintptr_t"):
247 # TODO: uintptr_t is arch-dependent :(
248 mapped_type = consts.c_type_map['uint64_t']
249 java_ty = mapped_type[0]
251 if fn_arg.startswith("uint64_t"):
253 fn_arg = fn_arg[8:].strip()
256 rust_obj = "uintptr_t"
257 fn_arg = fn_arg[9:].strip()
259 elif is_const and fn_arg.startswith("char *"):
262 fn_ty_arg = "Ljava/lang/String;"
263 fn_arg = fn_arg[6:].strip()
264 elif fn_arg.startswith("LDKStr"):
268 fn_ty_arg = "Ljava/lang/String;"
269 fn_arg = fn_arg[6:].strip()
273 ma = var_ty_regex.match(fn_arg)
274 if ma.group(1).strip() in unitary_enums:
275 java_ty = ma.group(1).strip()
276 c_ty = consts.result_c_ty
277 fn_ty_arg = "Lorg/ldk/enums/" + ma.group(1).strip() + ";"
278 fn_arg = ma.group(2).strip()
279 rust_obj = ma.group(1).strip()
280 elif ma.group(1).strip().startswith("LDKC2Tuple"):
281 c_ty = consts.ptr_c_ty
282 java_ty = consts.ptr_native_ty
283 java_hu_ty = "TwoTuple<"
284 if not ma.group(1).strip() in tuple_types:
285 assert java_c_types_none_allowed
287 for idx, ty_info in enumerate(tuple_types[ma.group(1).strip()][0]):
289 java_hu_ty = java_hu_ty + ", "
290 if ty_info.is_native_primitive:
291 if ty_info.java_hu_ty == "int":
292 java_hu_ty = java_hu_ty + "Integer" # Java concrete integer type is Integer, not Int
294 java_hu_ty = java_hu_ty + ty_info.java_hu_ty.title() # If we're a primitive, capitalize the first letter
296 java_hu_ty = java_hu_ty + ty_info.java_hu_ty
297 java_hu_ty = java_hu_ty + ">"
299 fn_arg = ma.group(2).strip()
300 rust_obj = ma.group(1).strip()
302 elif ma.group(1).strip().startswith("LDKC3Tuple"):
303 c_ty = consts.ptr_c_ty
304 java_ty = consts.ptr_native_ty
305 java_hu_ty = "ThreeTuple<"
306 if not ma.group(1).strip() in tuple_types:
307 assert java_c_types_none_allowed
309 for idx, ty_info in enumerate(tuple_types[ma.group(1).strip()][0]):
311 java_hu_ty = java_hu_ty + ", "
312 if ty_info.is_native_primitive:
313 if ty_info.java_hu_ty == "int":
314 java_hu_ty = java_hu_ty + "Integer" # Java concrete integer type is Integer, not Int
316 java_hu_ty = java_hu_ty + ty_info.java_hu_ty.title() # If we're a primitive, capitalize the first letter
318 java_hu_ty = java_hu_ty + ty_info.java_hu_ty
319 java_hu_ty = java_hu_ty + ">"
321 fn_arg = ma.group(2).strip()
322 rust_obj = ma.group(1).strip()
325 c_ty = consts.ptr_c_ty
326 java_ty = consts.ptr_native_ty
327 java_hu_ty = ma.group(1).strip().replace("LDKCOption", "Option").replace("LDKCResult", "Result").replace("LDK", "")
329 fn_arg = ma.group(2).strip()
330 rust_obj = ma.group(1).strip()
333 if fn_arg.startswith(" *") or fn_arg.startswith("*"):
334 fn_arg = fn_arg.replace("*", "").strip()
336 c_ty = consts.ptr_c_ty
337 java_ty = consts.ptr_native_ty
340 var_is_arr = var_is_arr_regex.match(fn_arg)
341 if var_is_arr is not None or ret_arr_len is not None:
342 assert(not take_by_ptr)
344 # is there a special case for plurals?
345 if len(mapped_type) == 2:
346 java_ty = mapped_type[1]
348 java_ty = java_ty + "[]"
349 c_ty = c_ty + "Array"
350 if var_is_arr is not None:
351 if var_is_arr.group(1) == "":
352 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,
353 passed_as_ptr=False, is_ptr=False, nonnull_ptr=nonnull_ptr, var_name="arg",
354 arr_len=var_is_arr.group(2), arr_access=arr_access, is_native_primitive=False)
355 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,
356 passed_as_ptr=False, is_ptr=False, nonnull_ptr=nonnull_ptr, var_name=var_is_arr.group(1),
357 arr_len=var_is_arr.group(2), arr_access=arr_access, is_native_primitive=False)
359 if java_hu_ty is None:
361 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,
362 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)
364 fn_ptr_regex = re.compile("^extern const ([A-Za-z_0-9\* ]*) \(\*(.*)\)\((.*)\);$")
365 fn_ret_arr_regex = re.compile("(.*) \(\*(.*)\((.*)\)\)\[([0-9]*)\];$")
366 reg_fn_regex = re.compile("([A-Za-z_0-9\* ]* \*?)([a-zA-Z_0-9]*)\((.*)\);$")
370 from gen_type_mapping import TypeMappingGenerator
371 type_mapping_generator = TypeMappingGenerator(java_c_types, consts, opaque_structs, clone_fns, unitary_enums, trait_structs, complex_enums, result_types, tuple_types)
373 with open(sys.argv[1]) as in_h:
375 reg_fn = reg_fn_regex.match(line)
376 if reg_fn is not None:
377 if reg_fn.group(2).endswith("_clone"):
378 clone_fns.add(reg_fn.group(2))
380 rty = java_c_types(reg_fn.group(1), None)
381 if rty is not None and not rty.is_native_primitive and reg_fn.group(2) == rty.java_hu_ty + "_new":
382 constructor_fns[rty.rust_obj] = reg_fn.group(3)
384 arr_fn = fn_ret_arr_regex.match(line)
385 if arr_fn is not None:
386 if arr_fn.group(2).endswith("_clone"):
387 clone_fns.add(arr_fn.group(2))
388 # No object constructors return arrays, as then they wouldn't be an object constructor
391 # Define some manual clones...
392 clone_fns.add("ThirtyTwoBytes_clone")
393 write_c("static inline struct LDKThirtyTwoBytes ThirtyTwoBytes_clone(const struct LDKThirtyTwoBytes *orig) { struct LDKThirtyTwoBytes ret; memcpy(ret.data, orig->data, 32); return ret; }\n")
395 java_c_types_none_allowed = False # C structs created by cbindgen are declared in dependency order
397 with open(f"{sys.argv[3]}/structs/UtilMethods{consts.file_ext}", "a") as util:
398 util.write(consts.util_fn_pfx)
400 with open(sys.argv[1]) as in_h, open(sys.argv[2], "w") as out_java:
401 # Map a top-level function
402 def map_fn(line, re_match, ret_arr_len, c_call_string, doc_comment):
403 method_return_type = re_match.group(1)
404 method_name = re_match.group(2)
405 method_comma_separated_arguments = re_match.group(3)
406 method_arguments = method_comma_separated_arguments.split(',')
408 is_free = method_name.endswith("_free")
409 if method_name.startswith("COption") or method_name.startswith("CResult"):
410 struct_meth = method_name.rsplit("Z", 1)[0][1:] + "Z"
412 struct_meth = method_name.split("_")[0]
414 return_type_info = type_mapping_generator.map_type(method_return_type.strip() + " ret", True, ret_arr_len, False, False)
417 default_constructor_args = {}
421 for argument_index, argument in enumerate(method_arguments):
422 argument_conversion_info = type_mapping_generator.map_type(argument, False, None, is_free, True)
423 if argument_index == 0 and argument_conversion_info.java_hu_ty == struct_meth:
425 if argument_conversion_info.arg_conv is not None and "Warning" in argument_conversion_info.arg_conv:
426 if argument_conversion_info.rust_obj in constructor_fns:
428 for explode_arg in constructor_fns[argument_conversion_info.rust_obj].split(','):
429 explode_arg_conv = type_mapping_generator.map_type(explode_arg, False, None, False, True)
430 if explode_arg_conv.c_ty == "void":
431 # We actually want to handle this case, but for now its only used in NetGraphMsgHandler::new()
432 # which ends up resulting in a redundant constructor - both without arguments for the NetworkGraph.
435 if not argument_conversion_info.arg_name in default_constructor_args:
436 default_constructor_args[argument_conversion_info.arg_name] = []
437 default_constructor_args[argument_conversion_info.arg_name].append(explode_arg_conv)
438 argument_types.append(argument_conversion_info)
440 out_java.write("\t// " + line)
441 (out_java_delta, out_c_delta, out_java_struct_delta) = \
442 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)
443 out_java.write(out_java_delta)
446 assert len(argument_types) == 1
447 assert return_type_info.c_ty == "void"
448 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")
449 if argument_types[0].ty_info.passed_as_ptr and not argument_types[0].ty_info.rust_obj in opaque_structs:
450 write_c("\tif ((" + argument_types[0].ty_info.var_name + " & 1) != 0) return;\n")
452 for info in argument_types:
453 if info.arg_conv is not None:
454 write_c("\t" + info.arg_conv.replace('\n', "\n\t") + "\n")
455 assert c_call_string is None
456 write_c("\t" + method_name + "(")
457 if argument_types[0].arg_conv_name is not None:
458 write_c(argument_types[0].arg_conv_name)
460 for info in argument_types:
461 if info.arg_conv_cleanup is not None:
462 write_c("\n\t" + info.arg_conv_cleanup.replace("\n", "\n\t"))
467 out_java_struct = None
468 expected_struct = "LDK" + struct_meth
469 expected_cstruct = "LDKC" + struct_meth
470 if (expected_struct in opaque_structs or expected_struct in trait_structs
471 or expected_struct in complex_enums or expected_cstruct in complex_enums
472 or expected_cstruct in result_types) and not is_free:
473 out_java_struct = open(f"{sys.argv[3]}/structs/{struct_meth}{consts.file_ext}", "a")
474 elif (method_name.startswith("C2Tuple_") and method_name.endswith("_read")) or \
475 (return_type_info.rust_obj is not None and "Result" in return_type_info.rust_obj and "from" in method_name):
476 out_java_struct = open(f"{sys.argv[3]}/structs/UtilMethods{consts.file_ext}", "a")
477 if out_java_struct is not None:
478 out_java_struct.write(out_java_struct_delta)
480 def map_unitary_enum(struct_name, field_lines, enum_doc_comment):
481 with open(f"{sys.argv[3]}/enums/{struct_name}{consts.file_ext}", "w") as out_java_enum:
482 unitary_enums.add(struct_name)
483 for idx, struct_line in enumerate(field_lines):
485 assert(struct_line == "typedef enum %s {" % struct_name)
486 elif idx == len(field_lines) - 3:
487 assert(struct_line.endswith("_Sentinel,"))
488 elif idx == len(field_lines) - 2:
489 assert(struct_line == "} %s;" % struct_name)
490 elif idx == len(field_lines) - 1:
491 assert(struct_line == "")
492 (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)
494 out_java_enum.write(native_file_out)
495 out_java.write(native_out)
497 def map_complex_enum(struct_name, union_enum_items, inline_enum_variants, enum_doc_comment):
498 java_hu_type = struct_name.replace("LDK", "").replace("COption", "Option")
499 complex_enums.add(struct_name)
502 tag_field_lines = union_enum_items["field_lines"]
503 for idx, struct_line in enumerate(tag_field_lines):
505 assert(struct_line == "typedef enum %s_Tag {" % struct_name)
506 elif idx == len(tag_field_lines) - 3:
507 assert(struct_line.endswith("_Sentinel,"))
508 elif idx == len(tag_field_lines) - 2:
509 assert(struct_line == "} %s_Tag;" % struct_name)
510 elif idx == len(tag_field_lines) - 1:
511 assert(struct_line == "")
513 variant_name = struct_line.strip(' ,')[len(struct_name) + 1:]
515 if "LDK" + variant_name in union_enum_items:
516 enum_var_lines = union_enum_items["LDK" + variant_name]
517 for idx, field in enumerate(enum_var_lines):
518 if idx != 0 and idx < len(enum_var_lines) - 2 and field.strip() != "":
519 fields.append(type_mapping_generator.map_type(field.strip(' ;'), False, None, False, True))
520 enum_variants.append(ComplexEnumVariantInfo(variant_name, fields, False))
521 elif camel_to_snake(variant_name) in inline_enum_variants:
522 fields.append(type_mapping_generator.map_type(inline_enum_variants[camel_to_snake(variant_name)] + " " + camel_to_snake(variant_name), False, None, False, True))
523 enum_variants.append(ComplexEnumVariantInfo(variant_name, fields, True))
525 enum_variants.append(ComplexEnumVariantInfo(variant_name, fields, True))
527 with open(f"{sys.argv[3]}/structs/{java_hu_type}{consts.file_ext}", "w") as out_java_enum:
528 (out_java_addendum, out_java_enum_addendum, out_c_addendum) = consts.map_complex_enum(struct_name, enum_variants, camel_to_snake, enum_doc_comment)
530 out_java_enum.write(out_java_enum_addendum)
531 out_java.write(out_java_addendum)
532 write_c(out_c_addendum)
534 def map_trait(struct_name, field_var_lines, trait_fn_lines, trait_doc_comment):
535 with open(f"{sys.argv[3]}/structs/{struct_name.replace('LDK', '')}{consts.file_ext}", "w") as out_java_trait:
537 flattened_field_var_convs = []
538 for var_line in field_var_lines:
539 if var_line.group(1) in trait_structs:
540 field_var_convs.append((var_line.group(1), var_line.group(2), trait_structs[var_line.group(1)]))
541 flattened_field_var_convs.append((var_line.group(1), var_line.group(2), ))
542 flattened_field_var_convs.extend(trait_structs[var_line.group(1)])
544 mapped = type_mapping_generator.map_type(var_line.group(1) + " " + var_line.group(2), False, None, False, False)
545 field_var_convs.append(mapped)
546 flattened_field_var_convs.append(mapped)
547 trait_structs[struct_name] = field_var_convs
550 for fn_docs, fn_line in trait_fn_lines:
551 ret_ty_info = type_mapping_generator.map_type(fn_line.group(2).strip() + " ret", True, None, False, False)
552 is_const = fn_line.group(4) is not None
555 for idx, arg in enumerate(fn_line.group(5).split(',')):
558 arg_conv_info = type_mapping_generator.map_type(arg, True, None, False, False)
559 arg_tys.append(arg_conv_info)
560 field_fns.append(TraitMethInfo(fn_line.group(3), is_const, ret_ty_info, arg_tys, fn_docs))
562 (out_java_addendum, out_java_trait_addendum, out_c_addendum) = consts.native_c_map_trait(struct_name, field_var_convs, flattened_field_var_convs, field_fns, trait_doc_comment)
563 write_c(out_c_addendum)
564 out_java_trait.write(out_java_trait_addendum)
565 out_java.write(out_java_addendum)
567 for fn_docs, fn_line in trait_fn_lines:
568 # For now, just disable enabling the _call_log - we don't know how to inverse-map String
569 is_log = fn_line.group(3) == "log" and struct_name == "LDKLogger"
570 if fn_line.group(3) != "free" and fn_line.group(3) != "clone" and fn_line.group(3) != "eq" and not is_log:
571 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"
572 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)
573 for idx, var_line in enumerate(field_var_lines):
574 if var_line.group(1) not in trait_structs:
575 write_c(var_line.group(1) + " " + struct_name + "_set_get_" + var_line.group(2) + "(" + struct_name + "* this_arg) {\n")
576 write_c("\tif (this_arg->set_" + var_line.group(2) + " != NULL)\n")
577 write_c("\t\tthis_arg->set_" + var_line.group(2) + "(this_arg);\n")
578 write_c("\treturn this_arg->" + var_line.group(2) + ";\n")
580 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"
581 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)
583 def map_result(struct_name, res_ty, err_ty):
584 result_types.add(struct_name)
585 human_ty = struct_name.replace("LDKCResult", "Result")
586 with open(f"{sys.argv[3]}/structs/{human_ty}{consts.file_ext}", "w") as out_java_struct:
587 out_java_struct.write(consts.hu_struct_file_prefix)
588 out_java_struct.write("public class " + human_ty + " extends CommonBase {\n")
589 out_java_struct.write("\tprivate " + human_ty + "(Object _dummy, long ptr) { super(ptr); }\n")
590 out_java_struct.write("\tprotected void finalize() throws Throwable {\n")
591 out_java_struct.write("\t\tif (ptr != 0) { bindings." + struct_name.replace("LDK","") + "_free(ptr); } super.finalize();\n")
592 out_java_struct.write("\t}\n\n")
593 out_java_struct.write("\tstatic " + human_ty + " constr_from_ptr(long ptr) {\n")
594 out_java_struct.write("\t\tif (bindings." + struct_name + "_result_ok(ptr)) {\n")
595 out_java_struct.write("\t\t\treturn new " + human_ty + "_OK(null, ptr);\n")
596 out_java_struct.write("\t\t} else {\n")
597 out_java_struct.write("\t\t\treturn new " + human_ty + "_Err(null, ptr);\n")
598 out_java_struct.write("\t\t}\n")
599 out_java_struct.write("\t}\n")
601 res_map = type_mapping_generator.map_type(res_ty + " res", True, None, False, True)
602 err_map = type_mapping_generator.map_type(err_ty + " err", True, None, False, True)
604 if not res_map.is_native_primitive and (res_map.rust_obj.replace("LDK", "") + "_clone" not in clone_fns):
606 if not err_map.is_native_primitive and (err_map.rust_obj.replace("LDK", "") + "_clone" not in clone_fns):
609 out_java.write("\tpublic static native boolean " + struct_name + "_result_ok(long arg);\n")
610 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")
611 write_c("\treturn ((" + struct_name + "*)arg)->result_ok;\n")
614 out_java.write("\tpublic static native " + res_map.java_ty + " " + struct_name + "_get_ok(long arg);\n")
615 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")
616 write_c("\t" + struct_name + " *val = (" + struct_name + "*)(arg & ~1);\n")
617 write_c("\tCHECK(val->result_ok);\n\t")
618 out_java_struct.write("\tpublic static final class " + human_ty + "_OK extends " + human_ty + " {\n")
619 if res_map.ret_conv is not None:
620 write_c(res_map.ret_conv[0].replace("\n", "\n\t") + "(*val->contents.result)")
621 write_c(res_map.ret_conv[1].replace("\n", "\n\t") + "\n\treturn " + res_map.ret_conv_name)
623 write_c("return *val->contents.result")
626 if res_map.java_hu_ty != "void":
627 out_java_struct.write("\t\tpublic final " + res_map.java_hu_ty + " res;\n")
628 out_java_struct.write("\t\tprivate " + human_ty + "_OK(Object _dummy, long ptr) {\n")
629 out_java_struct.write("\t\t\tsuper(_dummy, ptr);\n")
630 if res_map.java_hu_ty == "void":
632 elif res_map.to_hu_conv is not None:
633 out_java_struct.write("\t\t\t" + res_map.java_ty + " res = bindings." + struct_name + "_get_ok(ptr);\n")
634 out_java_struct.write("\t\t\t" + res_map.to_hu_conv.replace("\n", "\n\t\t\t"))
635 out_java_struct.write("\n\t\t\tthis.res = " + res_map.to_hu_conv_name + ";\n")
637 out_java_struct.write("\t\t\tthis.res = bindings." + struct_name + "_get_ok(ptr);\n")
638 out_java_struct.write("\t\t}\n")
639 out_java_struct.write("\t}\n\n")
641 out_java.write("\tpublic static native " + err_map.java_ty + " " + struct_name + "_get_err(long arg);\n")
642 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")
643 write_c("\t" + struct_name + " *val = (" + struct_name + "*)(arg & ~1);\n")
644 write_c("\tCHECK(!val->result_ok);\n\t")
645 out_java_struct.write("\tpublic static final class " + human_ty + "_Err extends " + human_ty + " {\n")
646 if err_map.ret_conv is not None:
647 write_c(err_map.ret_conv[0].replace("\n", "\n\t") + "(*val->contents.err)")
648 write_c(err_map.ret_conv[1].replace("\n", "\n\t") + "\n\treturn " + err_map.ret_conv_name)
650 write_c("return *val->contents.err")
653 if err_map.java_hu_ty != "void":
654 out_java_struct.write("\t\tpublic final " + err_map.java_hu_ty + " err;\n")
655 out_java_struct.write("\t\tprivate " + human_ty + "_Err(Object _dummy, long ptr) {\n")
656 out_java_struct.write("\t\t\tsuper(_dummy, ptr);\n")
657 if err_map.java_hu_ty == "void":
659 elif err_map.to_hu_conv is not None:
660 out_java_struct.write("\t\t\t" + err_map.java_ty + " err = bindings." + struct_name + "_get_err(ptr);\n")
661 out_java_struct.write("\t\t\t" + err_map.to_hu_conv.replace("\n", "\n\t\t\t"))
662 out_java_struct.write("\n\t\t\tthis.err = " + err_map.to_hu_conv_name + ";\n")
664 out_java_struct.write("\t\t\tthis.err = bindings." + struct_name + "_get_err(ptr);\n")
665 out_java_struct.write("\t\t}\n")
667 out_java_struct.write("\t}\n\n")
669 def map_tuple(struct_name, field_lines):
670 out_java.write("\tpublic static native long " + struct_name + "_new(")
671 write_c(consts.c_fn_ty_pfx + consts.ptr_c_ty + " " + consts.c_fn_name_define_pfx(struct_name + "_new", len(field_lines) > 3))
673 for idx, line in enumerate(field_lines):
674 if idx != 0 and idx < len(field_lines) - 2:
675 ty_info = java_c_types(line.strip(';'), None)
679 e = chr(ord('a') + idx - 1)
680 out_java.write(ty_info.java_ty + " " + e)
681 write_c(ty_info.c_ty + " " + e)
682 ty_list.append(ty_info)
683 tuple_types[struct_name] = (ty_list, struct_name)
684 out_java.write(");\n")
686 write_c("\t" + struct_name + "* ret = MALLOC(sizeof(" + struct_name + "), \"" + struct_name + "\");\n")
687 for idx, line in enumerate(field_lines):
688 if idx != 0 and idx < len(field_lines) - 2:
689 ty_info = type_mapping_generator.map_type(line.strip(';'), False, None, False, False)
690 e = chr(ord('a') + idx - 1)
691 if ty_info.arg_conv is not None:
692 write_c("\t" + ty_info.arg_conv.replace("\n", "\n\t"))
693 write_c("\n\tret->" + e + " = " + ty_info.arg_conv_name + ";\n")
695 write_c("\tret->" + e + " = " + e + ";\n")
696 if ty_info.arg_conv_cleanup is not None:
697 write_c("\t//TODO: Really need to call " + ty_info.arg_conv_cleanup + " here\n")
698 write_c("\treturn (uint64_t)ret;\n")
701 for idx, ty_info in enumerate(ty_list):
702 e = chr(ord('a') + idx)
703 out_java.write("\tpublic static native " + ty_info.java_ty + " " + struct_name + "_get_" + e + "(long ptr);\n")
704 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")
705 write_c("\t" + struct_name + " *tuple = (" + struct_name + "*)(ptr & ~1);\n")
706 conv_info = type_mapping_generator.map_type_with_info(ty_info, False, None, False, True)
707 if conv_info.ret_conv is not None:
708 write_c("\t" + conv_info.ret_conv[0].replace("\n", "\n\t") + "tuple->" + e + conv_info.ret_conv[1].replace("\n", "\n\t") + "\n")
709 write_c("\treturn " + conv_info.ret_conv_name + ";\n")
711 write_c("\treturn tuple->" + e + ";\n")
714 out_java.write(consts.bindings_header.replace('<git_version_ldk_garbagecollected>', local_git_version))
716 with open(f"{sys.argv[3]}/structs/CommonBase{consts.file_ext}", "w") as out_java_struct:
717 out_java_struct.write(consts.common_base)
720 last_block_comment = None
723 const_val_regex = re.compile("^extern const ([A-Za-z_0-9]*) ([A-Za-z_0-9]*);$")
725 line_indicates_result_regex = re.compile("^ union (LDKCResult_[A-Za-z_0-9]*Ptr) contents;$")
726 line_indicates_vec_regex = re.compile("^ (struct |enum |union )?([A-Za-z_0-9]*) \*data;$")
727 line_indicates_opaque_regex = re.compile("^ bool is_owned;$")
728 line_indicates_trait_regex = re.compile("^ (struct |enum |union )?([A-Za-z_0-9]* \*?)\(\*([A-Za-z_0-9]*)\)\((const )?void \*this_arg(.*)\);$")
729 assert(line_indicates_trait_regex.match(" uintptr_t (*send_data)(void *this_arg, LDKu8slice data, bool resume_read);"))
730 assert(line_indicates_trait_regex.match(" struct LDKCVec_MessageSendEventZ (*get_and_clear_pending_msg_events)(const void *this_arg);"))
731 assert(line_indicates_trait_regex.match(" void *(*clone)(const void *this_arg);"))
732 assert(line_indicates_trait_regex.match(" struct LDKCVec_u8Z (*write)(const void *this_arg);"))
733 line_field_var_regex = re.compile("^ struct ([A-Za-z_0-9]*) ([A-Za-z_0-9]*);$")
734 assert(line_field_var_regex.match(" struct LDKMessageSendEventsProvider MessageSendEventsProvider;"))
735 assert(line_field_var_regex.match(" struct LDKChannelPublicKeys pubkeys;"))
736 struct_name_regex = re.compile("^typedef (struct|enum|union) (MUST_USE_STRUCT )?(LDK[A-Za-z_0-9]*) {$")
737 assert(struct_name_regex.match("typedef struct LDKCVec_u8Z {"))
738 assert(struct_name_regex.match("typedef enum LDKNetwork {"))
740 union_enum_items = {}
741 result_ptr_struct_items = {}
743 if block_comment is not None:
744 if line.endswith("*/\n"):
745 last_block_comment = block_comment.strip("\n")
748 block_comment = block_comment + line.strip(" /*")
749 elif cur_block_obj is not None:
750 cur_block_obj = cur_block_obj + line
751 if line.startswith("} "):
755 obj_lines = cur_block_obj.split("\n")
757 result_contents = None
758 is_unitary_enum = False
759 is_union_enum = False
765 for idx, struct_line in enumerate(obj_lines):
766 if struct_line.strip().startswith("/*"):
767 block_comment = struct_line.strip(" /*")
768 if block_comment is not None:
769 if struct_line.endswith("*/"):
770 last_struct_block_comment = block_comment.strip("\n")
773 block_comment = block_comment + "\n" + struct_line.strip(" /*")
775 struct_name_match = struct_name_regex.match(struct_line)
776 if struct_name_match is not None:
777 struct_name = struct_name_match.group(3)
778 if struct_name_match.group(1) == "enum":
779 if not struct_name.endswith("_Tag"):
780 is_unitary_enum = True
783 elif struct_name_match.group(1) == "union":
785 if line_indicates_opaque_regex.match(struct_line):
787 result_match = line_indicates_result_regex.match(struct_line)
788 if result_match is not None:
789 result_contents = result_match.group(1)
790 vec_ty_match = line_indicates_vec_regex.match(struct_line)
791 if vec_ty_match is not None and struct_name.startswith("LDKCVec_"):
792 vec_ty = vec_ty_match.group(2)
793 elif struct_name.startswith("LDKC2Tuple_") or struct_name.startswith("LDKC3Tuple_"):
795 trait_fn_match = line_indicates_trait_regex.match(struct_line)
796 if trait_fn_match is not None:
797 trait_fn_lines.append((last_struct_block_comment, trait_fn_match))
798 field_var_match = line_field_var_regex.match(struct_line)
799 if field_var_match is not None:
800 field_var_lines.append(field_var_match)
801 field_lines.append(struct_line)
803 assert(struct_name is not None)
804 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))
805 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))
806 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))
807 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))
808 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))
809 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))
810 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))
813 opaque_structs.add(struct_name)
814 with open(f"{sys.argv[3]}/structs/{struct_name.replace('LDK', '')}{consts.file_ext}", "w") as out_java_struct:
815 out_opaque_struct_human = consts.map_opaque_struct(struct_name, last_block_comment)
816 last_block_comment = None
817 out_java_struct.write(out_opaque_struct_human)
818 elif result_contents is not None:
819 assert result_contents in result_ptr_struct_items
820 res_ty, err_ty = result_ptr_struct_items[result_contents]
821 map_result(struct_name, res_ty, err_ty)
822 elif struct_name.startswith("LDKCResult_") and struct_name.endswith("ZPtr"):
823 for line in field_lines:
824 if line.endswith("*result;"):
825 res_ty = line[:-8].strip()
826 elif line.endswith("*err;"):
827 err_ty = line[:-5].strip()
828 result_ptr_struct_items[struct_name] = (res_ty, err_ty)
829 result_types.add(struct_name[:-3])
831 map_tuple(struct_name, field_lines)
832 elif vec_ty is not None:
833 ty_info = type_mapping_generator.map_type(vec_ty + " arr_elem", False, None, False, False)
834 if len(ty_info.java_fn_ty_arg) == 1: # ie we're a primitive of some form
835 out_java.write("\tpublic static native long " + struct_name + "_new(" + ty_info.java_ty + "[] elems);\n")
836 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")
837 write_c("\t" + struct_name + " *ret = MALLOC(sizeof(" + struct_name + "), \"" + struct_name + "\");\n")
838 write_c("\tret->datalen = " + consts.get_native_arr_len_call[0] + "elems" + consts.get_native_arr_len_call[1] + ";\n")
839 write_c("\tif (ret->datalen == 0) {\n")
840 write_c("\t\tret->data = NULL;\n")
841 write_c("\t} else {\n")
842 write_c("\t\tret->data = MALLOC(sizeof(" + vec_ty + ") * ret->datalen, \"" + struct_name + " Data\");\n")
843 native_arr_ptr_call = consts.get_native_arr_ptr_call(ty_info.ty_info)
844 write_c("\t\t" + ty_info.c_ty + " *java_elems = " + native_arr_ptr_call[0] + "elems" + native_arr_ptr_call[1] + ";\n")
845 write_c("\t\tfor (size_t i = 0; i < ret->datalen; i++) {\n")
846 if ty_info.arg_conv is not None:
847 write_c("\t\t\t" + ty_info.c_ty + " arr_elem = java_elems[i];\n")
848 write_c("\t\t\t" + ty_info.arg_conv.replace("\n", "\n\t\t\t") + "\n")
849 write_c("\t\t\tret->data[i] = " + ty_info.arg_conv_name + ";\n")
850 assert ty_info.arg_conv_cleanup is None
852 write_c("\t\t\tret->data[i] = java_elems[i];\n")
854 cleanup = consts.release_native_arr_ptr_call(ty_info.ty_info, "elems", "java_elems")
855 if cleanup is not None:
856 write_c("\t\t" + cleanup + ";\n")
858 write_c("\treturn (uint64_t)ret;\n")
861 if ty_info.is_native_primitive:
862 clone_fns.add(struct_name.replace("LDK", "") + "_clone")
863 write_c("static inline " + struct_name + " " + struct_name.replace("LDK", "") + "_clone(const " + struct_name + " *orig) {\n")
864 write_c("\t" + struct_name + " ret = { .data = MALLOC(sizeof(" + ty_info.c_ty + ") * orig->datalen, \"" + struct_name + " clone bytes\"), .datalen = orig->datalen };\n")
865 write_c("\tmemcpy(ret.data, orig->data, sizeof(" + ty_info.c_ty + ") * ret.datalen);\n")
866 write_c("\treturn ret;\n}\n")
867 elif (ty_info.rust_obj.replace("LDK", "") + "_clone") in clone_fns:
868 ty_name = "CVec_" + ty_info.rust_obj.replace("LDK", "") + "Z";
869 clone_fns.add(ty_name + "_clone")
870 write_c("static inline " + struct_name + " " + ty_name + "_clone(const " + struct_name + " *orig) {\n")
871 write_c("\t" + struct_name + " ret = { .data = MALLOC(sizeof(" + ty_info.rust_obj + ") * orig->datalen, \"" + struct_name + " clone bytes\"), .datalen = orig->datalen };\n")
872 write_c("\tfor (size_t i = 0; i < ret.datalen; i++) {\n")
873 write_c("\t\tret.data[i] = " + ty_info.rust_obj.replace("LDK", "") + "_clone(&orig->data[i]);\n")
874 write_c("\t}\n\treturn ret;\n}\n")
876 assert(struct_name.endswith("_Tag"))
877 struct_name = struct_name[:-4]
878 union_enum_items[struct_name] = {"field_lines": field_lines}
879 elif struct_name.endswith("_Body") and struct_name.split("_")[0] in union_enum_items:
880 enum_var_name = struct_name.split("_")
881 union_enum_items[enum_var_name[0]][enum_var_name[1]] = field_lines
882 elif struct_name in union_enum_items:
885 for line in field_lines:
886 if line == " struct {":
890 elif elem_items > -1:
892 if line.startswith("struct "):
894 elif line.startswith("enum "):
896 split = line.split(" ")
897 assert len(split) == 2
898 tuple_variants[split[1].strip(";")] = split[0]
901 # We don't currently support tuple variant with more than one element
903 map_complex_enum(struct_name, union_enum_items[struct_name], tuple_variants, last_block_comment)
904 last_block_comment = None
905 elif is_unitary_enum:
906 map_unitary_enum(struct_name, field_lines, last_block_comment)
907 last_block_comment = None
908 elif len(trait_fn_lines) > 0:
909 map_trait(struct_name, field_var_lines, trait_fn_lines, last_block_comment)
910 elif struct_name == "LDKTxOut":
911 with open(f"{sys.argv[3]}/structs/TxOut{consts.file_ext}", "w") as out_java_struct:
912 out_java_struct.write(consts.hu_struct_file_prefix)
913 out_java_struct.write("public class TxOut extends CommonBase{\n")
914 out_java_struct.write("\tTxOut(java.lang.Object _dummy, long ptr) { super(ptr); }\n")
915 out_java_struct.write("\tlong to_c_ptr() { return 0; }\n")
916 out_java_struct.write("\t@Override @SuppressWarnings(\"deprecation\")\n")
917 out_java_struct.write("\tprotected void finalize() throws Throwable {\n")
918 out_java_struct.write("\t\tsuper.finalize();\n")
919 out_java_struct.write("\t\tif (ptr != 0) { bindings.TxOut_free(ptr); }\n")
920 out_java_struct.write("\t}\n")
922 out_java_struct.write("}")
924 pass # Everything remaining is a byte[] or some form
927 fn_ptr = fn_ptr_regex.match(line)
928 fn_ret_arr = fn_ret_arr_regex.match(line)
929 reg_fn = reg_fn_regex.match(line)
930 const_val = const_val_regex.match(line)
932 if line.startswith("#include <"):
934 elif line.startswith("/*"):
935 if not line.endswith("*/\n"):
936 block_comment = line.strip(" /*")
937 elif line.startswith("typedef enum "):
939 elif line.startswith("typedef struct "):
941 elif line.startswith("typedef union "):
943 elif fn_ptr is not None:
944 map_fn(line, fn_ptr, None, None, last_block_comment)
945 last_block_comment = None
946 elif fn_ret_arr is not None:
947 map_fn(line, fn_ret_arr, fn_ret_arr.group(4), None, last_block_comment)
948 last_block_comment = None
949 elif reg_fn is not None:
950 map_fn(line, reg_fn, None, None, last_block_comment)
951 last_block_comment = None
952 elif const_val_regex is not None:
953 # TODO Map const variables
958 out_java.write(consts.bindings_footer)
959 for struct_name in opaque_structs:
960 with open(f"{sys.argv[3]}/structs/{struct_name.replace('LDK', '')}{consts.file_ext}", "a") as out_java_struct:
961 out_java_struct.write("}\n")
962 for struct_name in trait_structs:
963 with open(f"{sys.argv[3]}/structs/{struct_name.replace('LDK', '')}{consts.file_ext}", "a") as out_java_struct:
964 out_java_struct.write("}\n")
965 for struct_name in complex_enums:
966 with open(f"{sys.argv[3]}/structs/{struct_name.replace('LDK', '').replace('COption', 'Option')}{consts.file_ext}", "a") as out_java_struct:
967 out_java_struct.write("}\n")
968 for struct_name in result_types:
969 with open(f"{sys.argv[3]}/structs/{struct_name.replace('LDKCResult', 'Result')}{consts.file_ext}", "a") as out_java_struct:
970 out_java_struct.write("}\n")
972 with open(sys.argv[4], "w") as out_c:
973 out_c.write(consts.c_file_pfx.replace('<git_version_ldk_garbagecollected>', local_git_version))
974 out_c.write(consts.init_str())
976 with open(f"{sys.argv[3]}/structs/UtilMethods{consts.file_ext}", "a") as util:
977 util.write(consts.util_fn_sfx)