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 fn_arg = fn_arg[9:].strip()
231 elif is_const and fn_arg.startswith("char *"):
234 fn_ty_arg = "Ljava/lang/String;"
235 fn_arg = fn_arg[6:].strip()
236 elif fn_arg.startswith("LDKStr"):
239 fn_ty_arg = "Ljava/lang/String;"
240 fn_arg = fn_arg[6:].strip()
244 ma = var_ty_regex.match(fn_arg)
245 if ma.group(1).strip() in unitary_enums:
246 java_ty = ma.group(1).strip()
247 c_ty = consts.result_c_ty
248 fn_ty_arg = "Lorg/ldk/enums/" + ma.group(1).strip() + ";"
249 fn_arg = ma.group(2).strip()
250 rust_obj = ma.group(1).strip()
251 elif ma.group(1).strip().startswith("LDKC2Tuple"):
252 c_ty = consts.ptr_c_ty
253 java_ty = consts.ptr_native_ty
254 java_hu_ty = "TwoTuple<"
255 if not ma.group(1).strip() in tuple_types:
256 assert java_c_types_none_allowed
258 for idx, ty_info in enumerate(tuple_types[ma.group(1).strip()][0]):
260 java_hu_ty = java_hu_ty + ", "
261 if ty_info.is_native_primitive:
262 if ty_info.java_hu_ty == "int":
263 java_hu_ty = java_hu_ty + "Integer" # Java concrete integer type is Integer, not Int
265 java_hu_ty = java_hu_ty + ty_info.java_hu_ty.title() # If we're a primitive, capitalize the first letter
267 java_hu_ty = java_hu_ty + ty_info.java_hu_ty
268 java_hu_ty = java_hu_ty + ">"
270 fn_arg = ma.group(2).strip()
271 rust_obj = ma.group(1).strip()
273 elif ma.group(1).strip().startswith("LDKC3Tuple"):
274 c_ty = consts.ptr_c_ty
275 java_ty = consts.ptr_native_ty
276 java_hu_ty = "ThreeTuple<"
277 if not ma.group(1).strip() in tuple_types:
278 assert java_c_types_none_allowed
280 for idx, ty_info in enumerate(tuple_types[ma.group(1).strip()][0]):
282 java_hu_ty = java_hu_ty + ", "
283 if ty_info.is_native_primitive:
284 if ty_info.java_hu_ty == "int":
285 java_hu_ty = java_hu_ty + "Integer" # Java concrete integer type is Integer, not Int
287 java_hu_ty = java_hu_ty + ty_info.java_hu_ty.title() # If we're a primitive, capitalize the first letter
289 java_hu_ty = java_hu_ty + ty_info.java_hu_ty
290 java_hu_ty = java_hu_ty + ">"
292 fn_arg = ma.group(2).strip()
293 rust_obj = ma.group(1).strip()
296 c_ty = consts.ptr_c_ty
297 java_ty = consts.ptr_native_ty
298 java_hu_ty = ma.group(1).strip().replace("LDKCResult", "Result").replace("LDK", "")
300 fn_arg = ma.group(2).strip()
301 rust_obj = ma.group(1).strip()
304 if fn_arg.startswith(" *") or fn_arg.startswith("*"):
305 fn_arg = fn_arg.replace("*", "").strip()
307 c_ty = consts.ptr_c_ty
308 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 rty.rust_obj is not None 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):
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) = 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)
409 out_java.write(out_java_delta)
412 assert len(argument_types) == 1
413 assert return_type_info.c_ty == "void"
414 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")
415 if argument_types[0].ty_info.passed_as_ptr and not argument_types[0].ty_info.rust_obj in opaque_structs:
416 write_c("\tif ((" + argument_types[0].ty_info.var_name + " & 1) != 0) return;\n")
418 for info in argument_types:
419 if info.arg_conv is not None:
420 write_c("\t" + info.arg_conv.replace('\n', "\n\t") + "\n")
421 assert c_call_string is None
422 write_c("\t" + method_name + "(")
423 if argument_types[0].arg_conv_name is not None:
424 write_c(argument_types[0].arg_conv_name)
426 for info in argument_types:
427 if info.arg_conv_cleanup is not None:
428 write_c("\n\t" + info.arg_conv_cleanup.replace("\n", "\n\t"))
433 out_java_struct = None
434 if ("LDK" + struct_meth in opaque_structs or "LDK" + struct_meth in trait_structs) and not is_free:
435 out_java_struct = open(f"{sys.argv[3]}/structs/{struct_meth}{consts.file_ext}", "a")
436 elif method_name.startswith("C2Tuple_") and method_name.endswith("_read"):
437 struct_meth = method_name.rsplit("_", 1)[0]
438 out_java_struct = open(f"{sys.argv[3]}/structs/UtilMethods{consts.file_ext}", "a")
439 if out_java_struct is not None:
440 out_java_struct.write(out_java_struct_delta)
442 def map_unitary_enum(struct_name, field_lines):
443 with open(f"{sys.argv[3]}/enums/{struct_name}{consts.file_ext}", "w") as out_java_enum:
444 unitary_enums.add(struct_name)
445 for idx, struct_line in enumerate(field_lines):
447 assert(struct_line == "typedef enum %s {" % struct_name)
448 elif idx == len(field_lines) - 3:
449 assert(struct_line.endswith("_Sentinel,"))
450 elif idx == len(field_lines) - 2:
451 assert(struct_line == "} %s;" % struct_name)
452 elif idx == len(field_lines) - 1:
453 assert(struct_line == "")
454 (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]])
456 out_java_enum.write(native_file_out)
457 out_java.write(native_out)
459 def map_complex_enum(struct_name, union_enum_items):
460 java_hu_type = struct_name.replace("LDK", "")
461 complex_enums.add(struct_name)
464 tag_field_lines = union_enum_items["field_lines"]
465 for idx, struct_line in enumerate(tag_field_lines):
467 assert(struct_line == "typedef enum %s_Tag {" % struct_name)
468 elif idx == len(tag_field_lines) - 3:
469 assert(struct_line.endswith("_Sentinel,"))
470 elif idx == len(tag_field_lines) - 2:
471 assert(struct_line == "} %s_Tag;" % struct_name)
472 elif idx == len(tag_field_lines) - 1:
473 assert(struct_line == "")
475 variant_name = struct_line.strip(' ,')[len(struct_name) + 1:]
477 if "LDK" + variant_name in union_enum_items:
478 enum_var_lines = union_enum_items["LDK" + variant_name]
479 for idx, field in enumerate(enum_var_lines):
480 if idx != 0 and idx < len(enum_var_lines) - 2:
481 fields.append(type_mapping_generator.map_type(field.strip(' ;'), False, None, False, True))
483 # TODO: Assert line format
486 # TODO: Assert line format
488 enum_variants.append(ComplexEnumVariantInfo(variant_name, fields))
490 with open(f"{sys.argv[3]}/structs/{java_hu_type}{consts.file_ext}", "w") as out_java_enum:
491 (out_java_addendum, out_java_enum_addendum, out_c_addendum) = consts.map_complex_enum(struct_name, enum_variants, camel_to_snake)
493 out_java_enum.write(out_java_enum_addendum)
494 out_java.write(out_java_addendum)
495 write_c(out_c_addendum)
497 def map_trait(struct_name, field_var_lines, trait_fn_lines):
498 with open(f"{sys.argv[3]}/structs/{struct_name.replace('LDK', '')}{consts.file_ext}", "w") as out_java_trait:
500 for var_line in field_var_lines:
501 if var_line.group(1) in trait_structs:
502 field_var_convs.append((var_line.group(1), var_line.group(2)))
504 field_var_convs.append(
505 type_mapping_generator.map_type(var_line.group(1) + " " + var_line.group(2), False, None, False, False))
508 for fn_line in trait_fn_lines:
509 ret_ty_info = type_mapping_generator.map_type(fn_line.group(2), True, None, False, False)
510 is_const = fn_line.group(4) is not None
513 for idx, arg in enumerate(fn_line.group(5).split(',')):
516 arg_conv_info = type_mapping_generator.map_type(arg, True, None, False, False)
517 arg_tys.append(arg_conv_info)
518 field_fns.append(TraitMethInfo(fn_line.group(3), is_const, ret_ty_info, arg_tys))
520 (out_java_addendum, out_java_trait_addendum, out_c_addendum) = consts.native_c_map_trait(struct_name, field_var_convs, field_fns)
521 write_c(out_c_addendum)
522 out_java_trait.write(out_java_trait_addendum)
523 out_java.write(out_java_addendum)
525 for fn_line in trait_fn_lines:
526 # For now, just disable enabling the _call_log - we don't know how to inverse-map String
527 is_log = fn_line.group(3) == "log" and struct_name == "LDKLogger"
528 if fn_line.group(3) != "free" and fn_line.group(3) != "clone" and fn_line.group(3) != "eq" and not is_log:
529 dummy_line = fn_line.group(2) + struct_name.replace("LDK", "") + "_" + fn_line.group(3) + " " + struct_name + "* this_arg" + fn_line.group(5) + "\n"
530 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")
531 for idx, var_line in enumerate(field_var_lines):
532 if var_line.group(1) not in trait_structs:
533 write_c(var_line.group(1) + " " + struct_name + "_set_get_" + var_line.group(2) + "(" + struct_name + "* this_arg) {\n")
534 write_c("\tif (this_arg->set_" + var_line.group(2) + " != NULL)\n")
535 write_c("\t\tthis_arg->set_" + var_line.group(2) + "(this_arg);\n")
536 write_c("\treturn this_arg->" + var_line.group(2) + ";\n")
538 dummy_line = var_line.group(1) + " " + struct_name.replace("LDK", "") + "_get_" + var_line.group(2) + " " + struct_name + "* this_arg" + fn_line.group(5) + "\n"
539 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")
541 def map_result(struct_name, res_ty, err_ty):
542 result_types.add(struct_name)
543 human_ty = struct_name.replace("LDKCResult", "Result")
544 with open(f"{sys.argv[3]}/structs/{human_ty}{consts.file_ext}", "w") as out_java_struct:
545 out_java_struct.write(consts.hu_struct_file_prefix)
546 out_java_struct.write("public class " + human_ty + " extends CommonBase {\n")
547 out_java_struct.write("\tprivate " + human_ty + "(Object _dummy, long ptr) { super(ptr); }\n")
548 out_java_struct.write("\tprotected void finalize() throws Throwable {\n")
549 out_java_struct.write("\t\tif (ptr != 0) { bindings." + struct_name.replace("LDK","") + "_free(ptr); } super.finalize();\n")
550 out_java_struct.write("\t}\n\n")
551 out_java_struct.write("\tstatic " + human_ty + " constr_from_ptr(long ptr) {\n")
552 out_java_struct.write("\t\tif (bindings." + struct_name + "_result_ok(ptr)) {\n")
553 out_java_struct.write("\t\t\treturn new " + human_ty + "_OK(null, ptr);\n")
554 out_java_struct.write("\t\t} else {\n")
555 out_java_struct.write("\t\t\treturn new " + human_ty + "_Err(null, ptr);\n")
556 out_java_struct.write("\t\t}\n")
557 out_java_struct.write("\t}\n")
559 res_map = type_mapping_generator.map_type(res_ty + " res", True, None, False, True)
560 err_map = type_mapping_generator.map_type(err_ty + " err", True, None, False, True)
562 if not res_map.is_native_primitive and (res_map.rust_obj.replace("LDK", "") + "_clone" not in clone_fns):
564 if not err_map.is_native_primitive and (err_map.rust_obj.replace("LDK", "") + "_clone" not in clone_fns):
567 out_java.write("\tpublic static native boolean " + struct_name + "_result_ok(long arg);\n")
568 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")
569 write_c("\treturn ((" + struct_name + "*)arg)->result_ok;\n")
572 out_java.write("\tpublic static native " + res_map.java_ty + " " + struct_name + "_get_ok(long arg);\n")
573 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")
574 write_c("\t" + struct_name + " *val = (" + struct_name + "*)(arg & ~1);\n")
575 write_c("\tCHECK(val->result_ok);\n\t")
576 out_java_struct.write("\tpublic static final class " + human_ty + "_OK extends " + human_ty + " {\n")
577 if res_map.ret_conv is not None:
578 write_c(res_map.ret_conv[0].replace("\n", "\n\t") + "(*val->contents.result)")
579 write_c(res_map.ret_conv[1].replace("\n", "\n\t") + "\n\treturn " + res_map.ret_conv_name)
581 write_c("return *val->contents.result")
584 if res_map.java_hu_ty != "void":
585 out_java_struct.write("\t\tpublic final " + res_map.java_hu_ty + " res;\n")
586 out_java_struct.write("\t\tprivate " + human_ty + "_OK(Object _dummy, long ptr) {\n")
587 out_java_struct.write("\t\t\tsuper(_dummy, ptr);\n")
588 if res_map.java_hu_ty == "void":
590 elif res_map.to_hu_conv is not None:
591 out_java_struct.write("\t\t\t" + res_map.java_ty + " res = bindings." + struct_name + "_get_ok(ptr);\n")
592 out_java_struct.write("\t\t\t" + res_map.to_hu_conv.replace("\n", "\n\t\t\t"))
593 out_java_struct.write("\n\t\t\tthis.res = " + res_map.to_hu_conv_name + ";\n")
595 out_java_struct.write("\t\t\tthis.res = bindings." + struct_name + "_get_ok(ptr);\n")
596 out_java_struct.write("\t\t}\n")
597 if struct_name.startswith("LDKCResult_None"):
598 out_java_struct.write("\t\tpublic " + human_ty + "_OK() {\n\t\t\tthis(null, bindings.C" + human_ty + "_ok());\n")
600 out_java_struct.write("\t\tpublic " + human_ty + "_OK(" + res_map.java_hu_ty + " res) {\n")
601 if res_map.from_hu_conv is not None:
602 out_java_struct.write("\t\t\tthis(null, bindings.C" + human_ty + "_ok(" + res_map.from_hu_conv[0] + "));\n")
603 if res_map.from_hu_conv[1] != "":
604 out_java_struct.write("\t\t\t" + res_map.from_hu_conv[1].replace("\n", "\n\t\t\t") + ";\n")
606 out_java_struct.write("\t\t\tthis(null, bindings.C" + human_ty + "_ok(res));\n")
607 out_java_struct.write("\t\t}\n\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 if struct_name.endswith("NoneZ"):
636 out_java_struct.write("\t\tpublic " + human_ty + "_Err() {\n\t\t\tthis(null, bindings.C" + human_ty + "_err());\n")
638 out_java_struct.write("\t\tpublic " + human_ty + "_Err(" + err_map.java_hu_ty + " err) {\n")
639 if err_map.from_hu_conv is not None:
640 out_java_struct.write("\t\t\tthis(null, bindings.C" + human_ty + "_err(" + err_map.from_hu_conv[0] + "));\n")
641 if err_map.from_hu_conv[1] != "":
642 out_java_struct.write("\t\t\t" + err_map.from_hu_conv[1].replace("\n", "\n\t\t\t") + ";\n")
644 out_java_struct.write("\t\t\tthis(null, bindings.C" + human_ty + "_err(err));\n")
645 out_java_struct.write("\t\t}\n\t}\n}\n")
647 def map_tuple(struct_name, field_lines):
648 out_java.write("\tpublic static native long " + struct_name + "_new(")
649 write_c(consts.c_fn_ty_pfx + consts.ptr_c_ty + " " + consts.c_fn_name_define_pfx(struct_name + "_new", len(field_lines) > 3))
651 for idx, line in enumerate(field_lines):
652 if idx != 0 and idx < len(field_lines) - 2:
653 ty_info = java_c_types(line.strip(';'), None)
657 e = chr(ord('a') + idx - 1)
658 out_java.write(ty_info.java_ty + " " + e)
659 write_c(ty_info.c_ty + " " + e)
660 ty_list.append(ty_info)
661 tuple_types[struct_name] = (ty_list, struct_name)
662 out_java.write(");\n")
664 write_c("\t" + struct_name + "* ret = MALLOC(sizeof(" + struct_name + "), \"" + struct_name + "\");\n")
665 for idx, line in enumerate(field_lines):
666 if idx != 0 and idx < len(field_lines) - 2:
667 ty_info = type_mapping_generator.map_type(line.strip(';'), False, None, False, False)
668 e = chr(ord('a') + idx - 1)
669 if ty_info.arg_conv is not None:
670 write_c("\t" + ty_info.arg_conv.replace("\n", "\n\t"))
671 write_c("\n\tret->" + e + " = " + ty_info.arg_conv_name + ";\n")
673 write_c("\tret->" + e + " = " + e + ";\n")
674 if ty_info.arg_conv_cleanup is not None:
675 write_c("\t//TODO: Really need to call " + ty_info.arg_conv_cleanup + " here\n")
676 write_c("\treturn (long)ret;\n")
679 for idx, ty_info in enumerate(ty_list):
680 e = chr(ord('a') + idx)
681 out_java.write("\tpublic static native " + ty_info.java_ty + " " + struct_name + "_get_" + e + "(long ptr);\n")
682 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")
683 write_c("\t" + struct_name + " *tuple = (" + struct_name + "*)(ptr & ~1);\n")
684 conv_info = type_mapping_generator.map_type_with_info(ty_info, False, None, False, True)
685 if conv_info.ret_conv is not None:
686 write_c("\t" + conv_info.ret_conv[0].replace("\n", "\n\t") + "tuple->" + e + conv_info.ret_conv[1].replace("\n", "\n\t") + "\n")
687 write_c("\treturn " + conv_info.ret_conv_name + ";\n")
689 write_c("\treturn tuple->" + e + ";\n")
692 out_java.write(consts.bindings_header)
694 with open(f"{sys.argv[3]}/structs/CommonBase{consts.file_ext}", "w") as out_java_struct:
695 out_java_struct.write(consts.common_base)
697 in_block_comment = False
700 const_val_regex = re.compile("^extern const ([A-Za-z_0-9]*) ([A-Za-z_0-9]*);$")
702 line_indicates_result_regex = re.compile("^ union (LDKCResult_[A-Za-z_0-9]*Ptr) contents;$")
703 line_indicates_vec_regex = re.compile("^ (struct |enum |union )?([A-Za-z_0-9]*) \*data;$")
704 line_indicates_opaque_regex = re.compile("^ bool is_owned;$")
705 line_indicates_trait_regex = re.compile("^ (struct |enum |union )?([A-Za-z_0-9]* \*?)\(\*([A-Za-z_0-9]*)\)\((const )?void \*this_arg(.*)\);$")
706 assert(line_indicates_trait_regex.match(" uintptr_t (*send_data)(void *this_arg, LDKu8slice data, bool resume_read);"))
707 assert(line_indicates_trait_regex.match(" struct LDKCVec_MessageSendEventZ (*get_and_clear_pending_msg_events)(const void *this_arg);"))
708 assert(line_indicates_trait_regex.match(" void *(*clone)(const void *this_arg);"))
709 assert(line_indicates_trait_regex.match(" struct LDKCVec_u8Z (*write)(const void *this_arg);"))
710 line_field_var_regex = re.compile("^ struct ([A-Za-z_0-9]*) ([A-Za-z_0-9]*);$")
711 assert(line_field_var_regex.match(" struct LDKMessageSendEventsProvider MessageSendEventsProvider;"))
712 assert(line_field_var_regex.match(" struct LDKChannelPublicKeys pubkeys;"))
713 struct_name_regex = re.compile("^typedef (struct|enum|union) (MUST_USE_STRUCT )?(LDK[A-Za-z_0-9]*) {$")
714 assert(struct_name_regex.match("typedef struct LDKCVec_u8Z {"))
715 assert(struct_name_regex.match("typedef enum LDKNetwork {"))
717 union_enum_items = {}
718 result_ptr_struct_items = {}
721 if line.endswith("*/\n"):
722 in_block_comment = False
723 elif cur_block_obj is not None:
724 cur_block_obj = cur_block_obj + line
725 if line.startswith("} "):
729 obj_lines = cur_block_obj.split("\n")
731 result_contents = None
732 is_unitary_enum = False
733 is_union_enum = False
739 for idx, struct_line in enumerate(obj_lines):
740 if struct_line.strip().startswith("/*"):
741 in_block_comment = True
743 if struct_line.endswith("*/"):
744 in_block_comment = False
746 struct_name_match = struct_name_regex.match(struct_line)
747 if struct_name_match is not None:
748 struct_name = struct_name_match.group(3)
749 if struct_name_match.group(1) == "enum":
750 if not struct_name.endswith("_Tag"):
751 is_unitary_enum = True
754 elif struct_name_match.group(1) == "union":
756 if line_indicates_opaque_regex.match(struct_line):
758 result_match = line_indicates_result_regex.match(struct_line)
759 if result_match is not None:
760 result_contents = result_match.group(1)
761 vec_ty_match = line_indicates_vec_regex.match(struct_line)
762 if vec_ty_match is not None and struct_name.startswith("LDKCVec_"):
763 vec_ty = vec_ty_match.group(2)
764 elif struct_name.startswith("LDKC2Tuple_") or struct_name.startswith("LDKC3Tuple_"):
766 trait_fn_match = line_indicates_trait_regex.match(struct_line)
767 if trait_fn_match is not None:
768 trait_fn_lines.append(trait_fn_match)
769 field_var_match = line_field_var_regex.match(struct_line)
770 if field_var_match is not None:
771 field_var_lines.append(field_var_match)
772 field_lines.append(struct_line)
774 assert(struct_name is not None)
775 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))
776 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))
777 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))
778 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))
779 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))
780 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))
781 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))
784 opaque_structs.add(struct_name)
785 with open(f"{sys.argv[3]}/structs/{struct_name.replace('LDK', '')}{consts.file_ext}", "w") as out_java_struct:
786 out_opaque_struct_human = consts.map_opaque_struct(struct_name)
787 out_java_struct.write(out_opaque_struct_human)
788 elif result_contents is not None:
789 assert result_contents in result_ptr_struct_items
790 res_ty, err_ty = result_ptr_struct_items[result_contents]
791 map_result(struct_name, res_ty, err_ty)
792 elif struct_name.startswith("LDKCResult_") and struct_name.endswith("ZPtr"):
793 for line in field_lines:
794 if line.endswith("*result;"):
795 res_ty = line[:-8].strip()
796 elif line.endswith("*err;"):
797 err_ty = line[:-5].strip()
798 result_ptr_struct_items[struct_name] = (res_ty, err_ty)
799 result_types.add(struct_name[:-3])
801 map_tuple(struct_name, field_lines)
802 elif vec_ty is not None:
803 ty_info = type_mapping_generator.map_type(vec_ty + " arr_elem", False, None, False, False)
804 if len(ty_info.java_fn_ty_arg) == 1: # ie we're a primitive of some form
805 out_java.write("\tpublic static native long " + struct_name + "_new(" + ty_info.java_ty + "[] elems);\n")
806 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")
807 write_c("\t" + struct_name + " *ret = MALLOC(sizeof(" + struct_name + "), \"" + struct_name + "\");\n")
808 write_c("\tret->datalen = " + consts.get_native_arr_len_call[0] + "elems" + consts.get_native_arr_len_call[1] + ";\n")
809 write_c("\tif (ret->datalen == 0) {\n")
810 write_c("\t\tret->data = NULL;\n")
811 write_c("\t} else {\n")
812 write_c("\t\tret->data = MALLOC(sizeof(" + vec_ty + ") * ret->datalen, \"" + struct_name + " Data\");\n")
813 native_arr_ptr_call = consts.get_native_arr_ptr_call(ty_info.ty_info)
814 write_c("\t\t" + ty_info.c_ty + " *java_elems = " + native_arr_ptr_call[0] + "elems" + native_arr_ptr_call[1] + ";\n")
815 write_c("\t\tfor (size_t i = 0; i < ret->datalen; i++) {\n")
816 if ty_info.arg_conv is not None:
817 write_c("\t\t\t" + ty_info.c_ty + " arr_elem = java_elems[i];\n")
818 write_c("\t\t\t" + ty_info.arg_conv.replace("\n", "\n\t\t\t") + "\n")
819 write_c("\t\t\tret->data[i] = " + ty_info.arg_conv_name + ";\n")
820 assert ty_info.arg_conv_cleanup is None
822 write_c("\t\t\tret->data[i] = java_elems[i];\n")
824 cleanup = consts.release_native_arr_ptr_call(ty_info.ty_info, "elems", "java_elems")
825 if cleanup is not None:
826 write_c("\t\t" + cleanup + ";\n")
828 write_c("\treturn (long)ret;\n")
831 if ty_info.is_native_primitive:
832 clone_fns.add(struct_name.replace("LDK", "") + "_clone")
833 write_c("static inline " + struct_name + " " + struct_name.replace("LDK", "") + "_clone(const " + struct_name + " *orig) {\n")
834 write_c("\t" + struct_name + " ret = { .data = MALLOC(sizeof(" + ty_info.c_ty + ") * orig->datalen, \"" + struct_name + " clone bytes\"), .datalen = orig->datalen };\n")
835 write_c("\tmemcpy(ret.data, orig->data, sizeof(" + ty_info.c_ty + ") * ret.datalen);\n")
836 write_c("\treturn ret;\n}\n")
837 elif (ty_info.rust_obj.replace("LDK", "") + "_clone") in clone_fns:
838 ty_name = "CVec_" + ty_info.rust_obj.replace("LDK", "") + "Z";
839 clone_fns.add(ty_name + "_clone")
840 write_c("static inline " + struct_name + " " + ty_name + "_clone(const " + struct_name + " *orig) {\n")
841 write_c("\t" + struct_name + " ret = { .data = MALLOC(sizeof(" + ty_info.rust_obj + ") * orig->datalen, \"" + struct_name + " clone bytes\"), .datalen = orig->datalen };\n")
842 write_c("\tfor (size_t i = 0; i < ret.datalen; i++) {\n")
843 write_c("\t\tret.data[i] = " + ty_info.rust_obj.replace("LDK", "") + "_clone(&orig->data[i]);\n")
844 write_c("\t}\n\treturn ret;\n}\n")
846 assert(struct_name.endswith("_Tag"))
847 struct_name = struct_name[:-4]
848 union_enum_items[struct_name] = {"field_lines": field_lines}
849 elif struct_name.endswith("_Body") and struct_name.split("_")[0] in union_enum_items:
850 enum_var_name = struct_name.split("_")
851 union_enum_items[enum_var_name[0]][enum_var_name[1]] = field_lines
852 elif struct_name in union_enum_items:
853 map_complex_enum(struct_name, union_enum_items[struct_name])
854 elif is_unitary_enum:
855 map_unitary_enum(struct_name, field_lines)
856 elif len(trait_fn_lines) > 0:
857 trait_structs.add(struct_name)
858 map_trait(struct_name, field_var_lines, trait_fn_lines)
859 elif struct_name == "LDKTxOut":
860 with open(f"{sys.argv[3]}/structs/TxOut{consts.file_ext}", "w") as out_java_struct:
861 out_java_struct.write(consts.hu_struct_file_prefix)
862 out_java_struct.write("public class TxOut extends CommonBase{\n")
863 out_java_struct.write("\tTxOut(java.lang.Object _dummy, long ptr) { super(ptr); }\n")
864 out_java_struct.write("\tlong to_c_ptr() { return 0; }\n")
865 out_java_struct.write("\t@Override @SuppressWarnings(\"deprecation\")\n")
866 out_java_struct.write("\tprotected void finalize() throws Throwable {\n")
867 out_java_struct.write("\t\tsuper.finalize();\n")
868 out_java_struct.write("\t\tif (ptr != 0) { bindings.TxOut_free(ptr); }\n")
869 out_java_struct.write("\t}\n")
871 out_java_struct.write("}")
873 pass # Everything remaining is a byte[] or some form
876 fn_ptr = fn_ptr_regex.match(line)
877 fn_ret_arr = fn_ret_arr_regex.match(line)
878 reg_fn = reg_fn_regex.match(line)
879 const_val = const_val_regex.match(line)
881 if line.startswith("#include <"):
883 elif line.startswith("/*"):
884 #out_java.write("\t" + line)
885 if not line.endswith("*/\n"):
886 in_block_comment = True
887 elif line.startswith("typedef enum "):
889 elif line.startswith("typedef struct "):
891 elif line.startswith("typedef union "):
893 elif fn_ptr is not None:
894 map_fn(line, fn_ptr, None, None)
895 elif fn_ret_arr is not None:
896 map_fn(line, fn_ret_arr, fn_ret_arr.group(4), None)
897 elif reg_fn is not None:
898 map_fn(line, reg_fn, None, None)
899 elif const_val_regex is not None:
900 # TODO Map const variables
905 out_java.write(consts.bindings_footer)
906 for struct_name in opaque_structs:
907 with open(f"{sys.argv[3]}/structs/{struct_name.replace('LDK', '')}{consts.file_ext}", "a") as out_java_struct:
908 out_java_struct.write("}\n")
909 for struct_name in trait_structs:
910 with open(f"{sys.argv[3]}/structs/{struct_name.replace('LDK', '')}{consts.file_ext}", "a") as out_java_struct:
911 out_java_struct.write("}\n")
913 with open(sys.argv[4], "w") as out_c:
914 out_c.write(consts.c_file_pfx)
915 out_c.write(consts.init_str())
917 with open(f"{sys.argv[3]}/structs/UtilMethods{consts.file_ext}", "a") as util:
918 util.write(consts.util_fn_sfx)