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("LDKTxid"):
105 fn_arg = "uint8_t (*" + fn_arg[8:] + ")[32]"
106 assert var_is_arr_regex.match(fn_arg[8:])
107 rust_obj = "LDKThirtyTwoBytes"
109 elif fn_arg.startswith("LDKPublicKey"):
110 fn_arg = "uint8_t (*" + fn_arg[13:] + ")[33]"
111 assert var_is_arr_regex.match(fn_arg[8:])
112 rust_obj = "LDKPublicKey"
113 arr_access = "compressed_form"
114 elif fn_arg.startswith("LDKSecretKey"):
115 fn_arg = "uint8_t (*" + fn_arg[13:] + ")[32]"
116 assert var_is_arr_regex.match(fn_arg[8:])
117 rust_obj = "LDKSecretKey"
119 elif fn_arg.startswith("LDKSignature"):
120 fn_arg = "uint8_t (*" + fn_arg[13:] + ")[64]"
121 assert var_is_arr_regex.match(fn_arg[8:])
122 rust_obj = "LDKSignature"
123 arr_access = "compact_form"
124 elif fn_arg.startswith("LDKRecoverableSignature"):
125 fn_arg = "uint8_t (*" + fn_arg[25:] + ")[68]"
126 assert var_is_arr_regex.match(fn_arg[8:])
127 rust_obj = "LDKRecoverableSignature"
128 arr_access = "serialized_form"
129 elif fn_arg.startswith("LDKThreeBytes"):
130 fn_arg = "uint8_t (*" + fn_arg[14:] + ")[3]"
131 assert var_is_arr_regex.match(fn_arg[8:])
132 rust_obj = "LDKThreeBytes"
134 elif fn_arg.startswith("LDKFourBytes"):
135 fn_arg = "uint8_t (*" + fn_arg[13:] + ")[4]"
136 assert var_is_arr_regex.match(fn_arg[8:])
137 rust_obj = "LDKFourBytes"
139 elif fn_arg.startswith("LDKSixteenBytes"):
140 fn_arg = "uint8_t (*" + fn_arg[16:] + ")[16]"
141 assert var_is_arr_regex.match(fn_arg[8:])
142 rust_obj = "LDKSixteenBytes"
144 elif fn_arg.startswith("LDKTwentyBytes"):
145 fn_arg = "uint8_t (*" + fn_arg[15:] + ")[20]"
146 assert var_is_arr_regex.match(fn_arg[8:])
147 rust_obj = "LDKTwentyBytes"
149 elif fn_arg.startswith("LDKTenBytes"):
150 fn_arg = "uint8_t (*" + fn_arg[12:] + ")[10]"
151 assert var_is_arr_regex.match(fn_arg[8:])
152 rust_obj = "LDKTenBytes"
154 elif fn_arg.startswith("LDKu8slice"):
155 fn_arg = "uint8_t (*" + fn_arg[11:] + ")[datalen]"
156 assert var_is_arr_regex.match(fn_arg[8:])
157 rust_obj = "LDKu8slice"
159 elif fn_arg.startswith("LDKCVec_u8Z"):
160 fn_arg = "uint8_t (*" + fn_arg[12:] + ")[datalen]"
161 rust_obj = "LDKCVec_u8Z"
162 assert var_is_arr_regex.match(fn_arg[8:])
164 elif fn_arg.startswith("LDKTransaction ") or fn_arg == "LDKTransaction":
165 fn_arg = "uint8_t (*" + fn_arg[15:] + ")[datalen]"
166 rust_obj = "LDKTransaction"
167 assert var_is_arr_regex.match(fn_arg[8:])
169 elif fn_arg.startswith("LDKCVec_"):
172 fn_arg = fn_arg.replace("*", "")
175 tyn = fn_arg[8:].split(" ")
176 assert tyn[0].endswith("Z")
180 new_arg = "LDK" + tyn[0][:-1]
182 new_arg = new_arg + " " + a
183 res = java_c_types(new_arg, ret_arr_len)
185 assert java_c_types_none_allowed
188 res.pass_by_ref = True
189 if res.is_native_primitive or res.passed_as_ptr:
190 return TypeInfo(rust_obj=fn_arg.split(" ")[0], java_ty=res.java_ty + "[]", java_hu_ty=res.java_hu_ty + "[]",
191 java_fn_ty_arg="[" + res.java_fn_ty_arg, c_ty=res.c_ty + "Array", passed_as_ptr=False, is_ptr=is_ptr,
192 nonnull_ptr=nonnull_ptr, is_const=is_const,
193 var_name=res.var_name, arr_len="datalen", arr_access="data", subty=res, is_native_primitive=False)
195 return TypeInfo(rust_obj=fn_arg.split(" ")[0], java_ty=res.java_ty + "[]", java_hu_ty=res.java_hu_ty + "[]",
196 java_fn_ty_arg="[" + res.java_fn_ty_arg, c_ty=consts.ptr_arr, passed_as_ptr=False, is_ptr=is_ptr,
197 nonnull_ptr=nonnull_ptr, is_const=is_const,
198 var_name=res.var_name, arr_len="datalen", arr_access="data", subty=res, is_native_primitive=False)
203 java_type_plural = None
204 if fn_arg.startswith("void"):
208 fn_arg = fn_arg[4:].strip()
210 elif fn_arg.startswith("bool"):
214 fn_arg = fn_arg[4:].strip()
216 elif fn_arg.startswith("uint8_t"):
217 mapped_type = consts.c_type_map['uint8_t']
218 java_ty = mapped_type[0]
221 fn_arg = fn_arg[7:].strip()
223 elif fn_arg.startswith("LDKu5"):
224 java_ty = consts.c_type_map['uint8_t'][0]
229 fn_arg = fn_arg[6:].strip()
230 elif fn_arg.startswith("uint16_t"):
231 mapped_type = consts.c_type_map['uint16_t']
232 java_ty = mapped_type[0]
235 fn_arg = fn_arg[8:].strip()
237 elif fn_arg.startswith("uint32_t"):
238 mapped_type = consts.c_type_map['uint32_t']
239 java_ty = mapped_type[0]
242 fn_arg = fn_arg[8:].strip()
244 elif fn_arg.startswith("uint64_t") or fn_arg.startswith("uintptr_t"):
245 # TODO: uintptr_t is arch-dependent :(
246 mapped_type = consts.c_type_map['uint64_t']
247 java_ty = mapped_type[0]
249 if fn_arg.startswith("uint64_t"):
251 fn_arg = fn_arg[8:].strip()
254 rust_obj = "uintptr_t"
255 fn_arg = fn_arg[9:].strip()
257 elif is_const and fn_arg.startswith("char *"):
260 fn_ty_arg = "Ljava/lang/String;"
261 fn_arg = fn_arg[6:].strip()
262 elif fn_arg.startswith("LDKStr"):
265 fn_ty_arg = "Ljava/lang/String;"
266 fn_arg = fn_arg[6:].strip()
270 ma = var_ty_regex.match(fn_arg)
271 if ma.group(1).strip() in unitary_enums:
272 java_ty = ma.group(1).strip()
273 c_ty = consts.result_c_ty
274 fn_ty_arg = "Lorg/ldk/enums/" + ma.group(1).strip() + ";"
275 fn_arg = ma.group(2).strip()
276 rust_obj = ma.group(1).strip()
277 elif ma.group(1).strip().startswith("LDKC2Tuple"):
278 c_ty = consts.ptr_c_ty
279 java_ty = consts.ptr_native_ty
280 java_hu_ty = "TwoTuple<"
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()
299 elif ma.group(1).strip().startswith("LDKC3Tuple"):
300 c_ty = consts.ptr_c_ty
301 java_ty = consts.ptr_native_ty
302 java_hu_ty = "ThreeTuple<"
303 if not ma.group(1).strip() in tuple_types:
304 assert java_c_types_none_allowed
306 for idx, ty_info in enumerate(tuple_types[ma.group(1).strip()][0]):
308 java_hu_ty = java_hu_ty + ", "
309 if ty_info.is_native_primitive:
310 if ty_info.java_hu_ty == "int":
311 java_hu_ty = java_hu_ty + "Integer" # Java concrete integer type is Integer, not Int
313 java_hu_ty = java_hu_ty + ty_info.java_hu_ty.title() # If we're a primitive, capitalize the first letter
315 java_hu_ty = java_hu_ty + ty_info.java_hu_ty
316 java_hu_ty = java_hu_ty + ">"
318 fn_arg = ma.group(2).strip()
319 rust_obj = ma.group(1).strip()
322 c_ty = consts.ptr_c_ty
323 java_ty = consts.ptr_native_ty
324 java_hu_ty = ma.group(1).strip().replace("LDKCOption", "Option").replace("LDKCResult", "Result").replace("LDK", "")
326 fn_arg = ma.group(2).strip()
327 rust_obj = ma.group(1).strip()
330 if fn_arg.startswith(" *") or fn_arg.startswith("*"):
331 fn_arg = fn_arg.replace("*", "").strip()
333 c_ty = consts.ptr_c_ty
334 java_ty = consts.ptr_native_ty
337 var_is_arr = var_is_arr_regex.match(fn_arg)
338 if var_is_arr is not None or ret_arr_len is not None:
339 assert(not take_by_ptr)
341 # is there a special case for plurals?
342 if len(mapped_type) == 2:
343 java_ty = mapped_type[1]
345 java_ty = java_ty + "[]"
346 c_ty = c_ty + "Array"
347 if var_is_arr is not None:
348 if var_is_arr.group(1) == "":
349 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,
350 passed_as_ptr=False, is_ptr=False, nonnull_ptr=nonnull_ptr, var_name="arg",
351 arr_len=var_is_arr.group(2), arr_access=arr_access, is_native_primitive=False)
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=var_is_arr.group(1),
354 arr_len=var_is_arr.group(2), arr_access=arr_access, is_native_primitive=False)
356 if java_hu_ty is None:
358 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,
359 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)
361 fn_ptr_regex = re.compile("^extern const ([A-Za-z_0-9\* ]*) \(\*(.*)\)\((.*)\);$")
362 fn_ret_arr_regex = re.compile("(.*) \(\*(.*)\((.*)\)\)\[([0-9]*)\];$")
363 reg_fn_regex = re.compile("([A-Za-z_0-9\* ]* \*?)([a-zA-Z_0-9]*)\((.*)\);$")
367 from gen_type_mapping import TypeMappingGenerator
368 type_mapping_generator = TypeMappingGenerator(java_c_types, consts, opaque_structs, clone_fns, unitary_enums, trait_structs, complex_enums, result_types, tuple_types)
370 with open(sys.argv[1]) as in_h:
372 reg_fn = reg_fn_regex.match(line)
373 if reg_fn is not None:
374 if reg_fn.group(2).endswith("_clone"):
375 clone_fns.add(reg_fn.group(2))
377 rty = java_c_types(reg_fn.group(1), None)
378 if rty is not None and not rty.is_native_primitive and reg_fn.group(2) == rty.java_hu_ty + "_new":
379 constructor_fns[rty.rust_obj] = reg_fn.group(3)
381 arr_fn = fn_ret_arr_regex.match(line)
382 if arr_fn is not None:
383 if arr_fn.group(2).endswith("_clone"):
384 clone_fns.add(arr_fn.group(2))
385 # No object constructors return arrays, as then they wouldn't be an object constructor
388 # Define some manual clones...
389 clone_fns.add("ThirtyTwoBytes_clone")
390 write_c("static inline struct LDKThirtyTwoBytes ThirtyTwoBytes_clone(const struct LDKThirtyTwoBytes *orig) { struct LDKThirtyTwoBytes ret; memcpy(ret.data, orig->data, 32); return ret; }\n")
392 java_c_types_none_allowed = False # C structs created by cbindgen are declared in dependency order
394 with open(f"{sys.argv[3]}/structs/UtilMethods{consts.file_ext}", "a") as util:
395 util.write(consts.util_fn_pfx)
397 with open(sys.argv[1]) as in_h, open(sys.argv[2], "w") as out_java:
398 # Map a top-level function
399 def map_fn(line, re_match, ret_arr_len, c_call_string, doc_comment):
400 method_return_type = re_match.group(1)
401 method_name = re_match.group(2)
402 method_comma_separated_arguments = re_match.group(3)
403 method_arguments = method_comma_separated_arguments.split(',')
405 is_free = method_name.endswith("_free")
406 if method_name.startswith("COption") or method_name.startswith("CResult"):
407 struct_meth = method_name.rsplit("Z", 1)[0][1:] + "Z"
409 struct_meth = method_name.split("_")[0]
411 return_type_info = type_mapping_generator.map_type(method_return_type.strip() + " ret", True, ret_arr_len, False, False)
414 default_constructor_args = {}
418 for argument_index, argument in enumerate(method_arguments):
419 argument_conversion_info = type_mapping_generator.map_type(argument, False, None, is_free, True)
420 if argument_index == 0 and argument_conversion_info.java_hu_ty == struct_meth:
422 if argument_conversion_info.arg_conv is not None and "Warning" in argument_conversion_info.arg_conv:
423 if argument_conversion_info.rust_obj in constructor_fns:
425 for explode_arg in constructor_fns[argument_conversion_info.rust_obj].split(','):
426 explode_arg_conv = type_mapping_generator.map_type(explode_arg, False, None, False, True)
427 if explode_arg_conv.c_ty == "void":
428 # We actually want to handle this case, but for now its only used in NetGraphMsgHandler::new()
429 # which ends up resulting in a redundant constructor - both without arguments for the NetworkGraph.
432 if not argument_conversion_info.arg_name in default_constructor_args:
433 default_constructor_args[argument_conversion_info.arg_name] = []
434 default_constructor_args[argument_conversion_info.arg_name].append(explode_arg_conv)
435 argument_types.append(argument_conversion_info)
437 out_java.write("\t// " + line)
438 (out_java_delta, out_c_delta, out_java_struct_delta) = \
439 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)
440 out_java.write(out_java_delta)
443 assert len(argument_types) == 1
444 assert return_type_info.c_ty == "void"
445 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")
446 if argument_types[0].ty_info.passed_as_ptr and not argument_types[0].ty_info.rust_obj in opaque_structs:
447 write_c("\tif ((" + argument_types[0].ty_info.var_name + " & 1) != 0) return;\n")
449 for info in argument_types:
450 if info.arg_conv is not None:
451 write_c("\t" + info.arg_conv.replace('\n', "\n\t") + "\n")
452 assert c_call_string is None
453 write_c("\t" + method_name + "(")
454 if argument_types[0].arg_conv_name is not None:
455 write_c(argument_types[0].arg_conv_name)
457 for info in argument_types:
458 if info.arg_conv_cleanup is not None:
459 write_c("\n\t" + info.arg_conv_cleanup.replace("\n", "\n\t"))
464 out_java_struct = None
465 expected_struct = "LDK" + struct_meth
466 expected_cstruct = "LDKC" + struct_meth
467 if (expected_struct in opaque_structs or expected_struct in trait_structs
468 or expected_struct in complex_enums or expected_cstruct in complex_enums
469 or expected_cstruct in result_types) and not is_free:
470 out_java_struct = open(f"{sys.argv[3]}/structs/{struct_meth}{consts.file_ext}", "a")
471 elif (method_name.startswith("C2Tuple_") and method_name.endswith("_read")) or \
472 (return_type_info.rust_obj is not None and "Result" in return_type_info.rust_obj and "from" in method_name):
473 out_java_struct = open(f"{sys.argv[3]}/structs/UtilMethods{consts.file_ext}", "a")
474 if out_java_struct is not None:
475 out_java_struct.write(out_java_struct_delta)
477 def map_unitary_enum(struct_name, field_lines, enum_doc_comment):
478 with open(f"{sys.argv[3]}/enums/{struct_name}{consts.file_ext}", "w") as out_java_enum:
479 unitary_enums.add(struct_name)
480 for idx, struct_line in enumerate(field_lines):
482 assert(struct_line == "typedef enum %s {" % struct_name)
483 elif idx == len(field_lines) - 3:
484 assert(struct_line.endswith("_Sentinel,"))
485 elif idx == len(field_lines) - 2:
486 assert(struct_line == "} %s;" % struct_name)
487 elif idx == len(field_lines) - 1:
488 assert(struct_line == "")
489 (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)
491 out_java_enum.write(native_file_out)
492 out_java.write(native_out)
494 def map_complex_enum(struct_name, union_enum_items, inline_enum_variants, enum_doc_comment):
495 java_hu_type = struct_name.replace("LDK", "").replace("COption", "Option")
496 complex_enums.add(struct_name)
499 tag_field_lines = union_enum_items["field_lines"]
500 for idx, struct_line in enumerate(tag_field_lines):
502 assert(struct_line == "typedef enum %s_Tag {" % struct_name)
503 elif idx == len(tag_field_lines) - 3:
504 assert(struct_line.endswith("_Sentinel,"))
505 elif idx == len(tag_field_lines) - 2:
506 assert(struct_line == "} %s_Tag;" % struct_name)
507 elif idx == len(tag_field_lines) - 1:
508 assert(struct_line == "")
510 variant_name = struct_line.strip(' ,')[len(struct_name) + 1:]
512 if "LDK" + variant_name in union_enum_items:
513 enum_var_lines = union_enum_items["LDK" + variant_name]
514 for idx, field in enumerate(enum_var_lines):
515 if idx != 0 and idx < len(enum_var_lines) - 2:
516 fields.append(type_mapping_generator.map_type(field.strip(' ;'), False, None, False, True))
517 enum_variants.append(ComplexEnumVariantInfo(variant_name, fields, False))
518 elif camel_to_snake(variant_name) in inline_enum_variants:
519 fields.append(type_mapping_generator.map_type(inline_enum_variants[camel_to_snake(variant_name)] + " " + camel_to_snake(variant_name), False, None, False, True))
520 enum_variants.append(ComplexEnumVariantInfo(variant_name, fields, True))
522 enum_variants.append(ComplexEnumVariantInfo(variant_name, fields, True))
524 with open(f"{sys.argv[3]}/structs/{java_hu_type}{consts.file_ext}", "w") as out_java_enum:
525 (out_java_addendum, out_java_enum_addendum, out_c_addendum) = consts.map_complex_enum(struct_name, enum_variants, camel_to_snake, enum_doc_comment)
527 out_java_enum.write(out_java_enum_addendum)
528 out_java.write(out_java_addendum)
529 write_c(out_c_addendum)
531 def map_trait(struct_name, field_var_lines, trait_fn_lines, trait_doc_comment):
532 with open(f"{sys.argv[3]}/structs/{struct_name.replace('LDK', '')}{consts.file_ext}", "w") as out_java_trait:
534 flattened_field_var_convs = []
535 for var_line in field_var_lines:
536 if var_line.group(1) in trait_structs:
537 field_var_convs.append((var_line.group(1), var_line.group(2), trait_structs[var_line.group(1)]))
538 flattened_field_var_convs.append((var_line.group(1), var_line.group(2), ))
539 flattened_field_var_convs.extend(trait_structs[var_line.group(1)])
541 mapped = type_mapping_generator.map_type(var_line.group(1) + " " + var_line.group(2), False, None, False, False)
542 field_var_convs.append(mapped)
543 flattened_field_var_convs.append(mapped)
544 trait_structs[struct_name] = field_var_convs
547 for fn_docs, fn_line in trait_fn_lines:
548 ret_ty_info = type_mapping_generator.map_type(fn_line.group(2).strip() + " ret", True, None, False, False)
549 is_const = fn_line.group(4) is not None
552 for idx, arg in enumerate(fn_line.group(5).split(',')):
555 arg_conv_info = type_mapping_generator.map_type(arg, True, None, False, False)
556 arg_tys.append(arg_conv_info)
557 field_fns.append(TraitMethInfo(fn_line.group(3), is_const, ret_ty_info, arg_tys, fn_docs))
559 (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)
560 write_c(out_c_addendum)
561 out_java_trait.write(out_java_trait_addendum)
562 out_java.write(out_java_addendum)
564 for fn_docs, fn_line in trait_fn_lines:
565 # For now, just disable enabling the _call_log - we don't know how to inverse-map String
566 is_log = fn_line.group(3) == "log" and struct_name == "LDKLogger"
567 if fn_line.group(3) != "free" and fn_line.group(3) != "clone" and fn_line.group(3) != "eq" and not is_log:
568 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"
569 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)
570 for idx, var_line in enumerate(field_var_lines):
571 if var_line.group(1) not in trait_structs:
572 write_c(var_line.group(1) + " " + struct_name + "_set_get_" + var_line.group(2) + "(" + struct_name + "* this_arg) {\n")
573 write_c("\tif (this_arg->set_" + var_line.group(2) + " != NULL)\n")
574 write_c("\t\tthis_arg->set_" + var_line.group(2) + "(this_arg);\n")
575 write_c("\treturn this_arg->" + var_line.group(2) + ";\n")
577 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"
578 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)
580 def map_result(struct_name, res_ty, err_ty):
581 result_types.add(struct_name)
582 human_ty = struct_name.replace("LDKCResult", "Result")
583 with open(f"{sys.argv[3]}/structs/{human_ty}{consts.file_ext}", "w") as out_java_struct:
584 out_java_struct.write(consts.hu_struct_file_prefix)
585 out_java_struct.write("public class " + human_ty + " extends CommonBase {\n")
586 out_java_struct.write("\tprivate " + human_ty + "(Object _dummy, long ptr) { super(ptr); }\n")
587 out_java_struct.write("\tprotected void finalize() throws Throwable {\n")
588 out_java_struct.write("\t\tif (ptr != 0) { bindings." + struct_name.replace("LDK","") + "_free(ptr); } super.finalize();\n")
589 out_java_struct.write("\t}\n\n")
590 out_java_struct.write("\tstatic " + human_ty + " constr_from_ptr(long ptr) {\n")
591 out_java_struct.write("\t\tif (bindings." + struct_name + "_result_ok(ptr)) {\n")
592 out_java_struct.write("\t\t\treturn new " + human_ty + "_OK(null, ptr);\n")
593 out_java_struct.write("\t\t} else {\n")
594 out_java_struct.write("\t\t\treturn new " + human_ty + "_Err(null, ptr);\n")
595 out_java_struct.write("\t\t}\n")
596 out_java_struct.write("\t}\n")
598 res_map = type_mapping_generator.map_type(res_ty + " res", True, None, False, True)
599 err_map = type_mapping_generator.map_type(err_ty + " err", True, None, False, True)
601 if not res_map.is_native_primitive and (res_map.rust_obj.replace("LDK", "") + "_clone" not in clone_fns):
603 if not err_map.is_native_primitive and (err_map.rust_obj.replace("LDK", "") + "_clone" not in clone_fns):
606 out_java.write("\tpublic static native boolean " + struct_name + "_result_ok(long arg);\n")
607 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")
608 write_c("\treturn ((" + struct_name + "*)arg)->result_ok;\n")
611 out_java.write("\tpublic static native " + res_map.java_ty + " " + struct_name + "_get_ok(long arg);\n")
612 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")
613 write_c("\t" + struct_name + " *val = (" + struct_name + "*)(arg & ~1);\n")
614 write_c("\tCHECK(val->result_ok);\n\t")
615 out_java_struct.write("\tpublic static final class " + human_ty + "_OK extends " + human_ty + " {\n")
616 if res_map.ret_conv is not None:
617 write_c(res_map.ret_conv[0].replace("\n", "\n\t") + "(*val->contents.result)")
618 write_c(res_map.ret_conv[1].replace("\n", "\n\t") + "\n\treturn " + res_map.ret_conv_name)
620 write_c("return *val->contents.result")
623 if res_map.java_hu_ty != "void":
624 out_java_struct.write("\t\tpublic final " + res_map.java_hu_ty + " res;\n")
625 out_java_struct.write("\t\tprivate " + human_ty + "_OK(Object _dummy, long ptr) {\n")
626 out_java_struct.write("\t\t\tsuper(_dummy, ptr);\n")
627 if res_map.java_hu_ty == "void":
629 elif res_map.to_hu_conv is not None:
630 out_java_struct.write("\t\t\t" + res_map.java_ty + " res = bindings." + struct_name + "_get_ok(ptr);\n")
631 out_java_struct.write("\t\t\t" + res_map.to_hu_conv.replace("\n", "\n\t\t\t"))
632 out_java_struct.write("\n\t\t\tthis.res = " + res_map.to_hu_conv_name + ";\n")
634 out_java_struct.write("\t\t\tthis.res = bindings." + struct_name + "_get_ok(ptr);\n")
635 out_java_struct.write("\t\t}\n")
636 out_java_struct.write("\t}\n\n")
638 out_java.write("\tpublic static native " + err_map.java_ty + " " + struct_name + "_get_err(long arg);\n")
639 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")
640 write_c("\t" + struct_name + " *val = (" + struct_name + "*)(arg & ~1);\n")
641 write_c("\tCHECK(!val->result_ok);\n\t")
642 out_java_struct.write("\tpublic static final class " + human_ty + "_Err extends " + human_ty + " {\n")
643 if err_map.ret_conv is not None:
644 write_c(err_map.ret_conv[0].replace("\n", "\n\t") + "(*val->contents.err)")
645 write_c(err_map.ret_conv[1].replace("\n", "\n\t") + "\n\treturn " + err_map.ret_conv_name)
647 write_c("return *val->contents.err")
650 if err_map.java_hu_ty != "void":
651 out_java_struct.write("\t\tpublic final " + err_map.java_hu_ty + " err;\n")
652 out_java_struct.write("\t\tprivate " + human_ty + "_Err(Object _dummy, long ptr) {\n")
653 out_java_struct.write("\t\t\tsuper(_dummy, ptr);\n")
654 if err_map.java_hu_ty == "void":
656 elif err_map.to_hu_conv is not None:
657 out_java_struct.write("\t\t\t" + err_map.java_ty + " err = bindings." + struct_name + "_get_err(ptr);\n")
658 out_java_struct.write("\t\t\t" + err_map.to_hu_conv.replace("\n", "\n\t\t\t"))
659 out_java_struct.write("\n\t\t\tthis.err = " + err_map.to_hu_conv_name + ";\n")
661 out_java_struct.write("\t\t\tthis.err = bindings." + struct_name + "_get_err(ptr);\n")
662 out_java_struct.write("\t\t}\n")
664 out_java_struct.write("\t}\n\n")
666 def map_tuple(struct_name, field_lines):
667 out_java.write("\tpublic static native long " + struct_name + "_new(")
668 write_c(consts.c_fn_ty_pfx + consts.ptr_c_ty + " " + consts.c_fn_name_define_pfx(struct_name + "_new", len(field_lines) > 3))
670 for idx, line in enumerate(field_lines):
671 if idx != 0 and idx < len(field_lines) - 2:
672 ty_info = java_c_types(line.strip(';'), None)
676 e = chr(ord('a') + idx - 1)
677 out_java.write(ty_info.java_ty + " " + e)
678 write_c(ty_info.c_ty + " " + e)
679 ty_list.append(ty_info)
680 tuple_types[struct_name] = (ty_list, struct_name)
681 out_java.write(");\n")
683 write_c("\t" + struct_name + "* ret = MALLOC(sizeof(" + struct_name + "), \"" + struct_name + "\");\n")
684 for idx, line in enumerate(field_lines):
685 if idx != 0 and idx < len(field_lines) - 2:
686 ty_info = type_mapping_generator.map_type(line.strip(';'), False, None, False, False)
687 e = chr(ord('a') + idx - 1)
688 if ty_info.arg_conv is not None:
689 write_c("\t" + ty_info.arg_conv.replace("\n", "\n\t"))
690 write_c("\n\tret->" + e + " = " + ty_info.arg_conv_name + ";\n")
692 write_c("\tret->" + e + " = " + e + ";\n")
693 if ty_info.arg_conv_cleanup is not None:
694 write_c("\t//TODO: Really need to call " + ty_info.arg_conv_cleanup + " here\n")
695 write_c("\treturn (long)ret;\n")
698 for idx, ty_info in enumerate(ty_list):
699 e = chr(ord('a') + idx)
700 out_java.write("\tpublic static native " + ty_info.java_ty + " " + struct_name + "_get_" + e + "(long ptr);\n")
701 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")
702 write_c("\t" + struct_name + " *tuple = (" + struct_name + "*)(ptr & ~1);\n")
703 conv_info = type_mapping_generator.map_type_with_info(ty_info, False, None, False, True)
704 if conv_info.ret_conv is not None:
705 write_c("\t" + conv_info.ret_conv[0].replace("\n", "\n\t") + "tuple->" + e + conv_info.ret_conv[1].replace("\n", "\n\t") + "\n")
706 write_c("\treturn " + conv_info.ret_conv_name + ";\n")
708 write_c("\treturn tuple->" + e + ";\n")
711 out_java.write(consts.bindings_header)
713 with open(f"{sys.argv[3]}/structs/CommonBase{consts.file_ext}", "w") as out_java_struct:
714 out_java_struct.write(consts.common_base)
717 last_block_comment = None
720 const_val_regex = re.compile("^extern const ([A-Za-z_0-9]*) ([A-Za-z_0-9]*);$")
722 line_indicates_result_regex = re.compile("^ union (LDKCResult_[A-Za-z_0-9]*Ptr) contents;$")
723 line_indicates_vec_regex = re.compile("^ (struct |enum |union )?([A-Za-z_0-9]*) \*data;$")
724 line_indicates_opaque_regex = re.compile("^ bool is_owned;$")
725 line_indicates_trait_regex = re.compile("^ (struct |enum |union )?([A-Za-z_0-9]* \*?)\(\*([A-Za-z_0-9]*)\)\((const )?void \*this_arg(.*)\);$")
726 assert(line_indicates_trait_regex.match(" uintptr_t (*send_data)(void *this_arg, LDKu8slice data, bool resume_read);"))
727 assert(line_indicates_trait_regex.match(" struct LDKCVec_MessageSendEventZ (*get_and_clear_pending_msg_events)(const void *this_arg);"))
728 assert(line_indicates_trait_regex.match(" void *(*clone)(const void *this_arg);"))
729 assert(line_indicates_trait_regex.match(" struct LDKCVec_u8Z (*write)(const void *this_arg);"))
730 line_field_var_regex = re.compile("^ struct ([A-Za-z_0-9]*) ([A-Za-z_0-9]*);$")
731 assert(line_field_var_regex.match(" struct LDKMessageSendEventsProvider MessageSendEventsProvider;"))
732 assert(line_field_var_regex.match(" struct LDKChannelPublicKeys pubkeys;"))
733 struct_name_regex = re.compile("^typedef (struct|enum|union) (MUST_USE_STRUCT )?(LDK[A-Za-z_0-9]*) {$")
734 assert(struct_name_regex.match("typedef struct LDKCVec_u8Z {"))
735 assert(struct_name_regex.match("typedef enum LDKNetwork {"))
737 union_enum_items = {}
738 result_ptr_struct_items = {}
740 if block_comment is not None:
741 if line.endswith("*/\n"):
742 last_block_comment = block_comment.strip("\n")
745 block_comment = block_comment + line.strip(" /*")
746 elif cur_block_obj is not None:
747 cur_block_obj = cur_block_obj + line
748 if line.startswith("} "):
752 obj_lines = cur_block_obj.split("\n")
754 result_contents = None
755 is_unitary_enum = False
756 is_union_enum = False
762 for idx, struct_line in enumerate(obj_lines):
763 if struct_line.strip().startswith("/*"):
764 block_comment = struct_line.strip(" /*")
765 if block_comment is not None:
766 if struct_line.endswith("*/"):
767 last_struct_block_comment = block_comment.strip("\n")
770 block_comment = block_comment + "\n" + struct_line.strip(" /*")
772 struct_name_match = struct_name_regex.match(struct_line)
773 if struct_name_match is not None:
774 struct_name = struct_name_match.group(3)
775 if struct_name_match.group(1) == "enum":
776 if not struct_name.endswith("_Tag"):
777 is_unitary_enum = True
780 elif struct_name_match.group(1) == "union":
782 if line_indicates_opaque_regex.match(struct_line):
784 result_match = line_indicates_result_regex.match(struct_line)
785 if result_match is not None:
786 result_contents = result_match.group(1)
787 vec_ty_match = line_indicates_vec_regex.match(struct_line)
788 if vec_ty_match is not None and struct_name.startswith("LDKCVec_"):
789 vec_ty = vec_ty_match.group(2)
790 elif struct_name.startswith("LDKC2Tuple_") or struct_name.startswith("LDKC3Tuple_"):
792 trait_fn_match = line_indicates_trait_regex.match(struct_line)
793 if trait_fn_match is not None:
794 trait_fn_lines.append((last_struct_block_comment, trait_fn_match))
795 field_var_match = line_field_var_regex.match(struct_line)
796 if field_var_match is not None:
797 field_var_lines.append(field_var_match)
798 field_lines.append(struct_line)
800 assert(struct_name is not None)
801 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))
802 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))
803 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))
804 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))
805 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))
806 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))
807 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))
810 opaque_structs.add(struct_name)
811 with open(f"{sys.argv[3]}/structs/{struct_name.replace('LDK', '')}{consts.file_ext}", "w") as out_java_struct:
812 out_opaque_struct_human = consts.map_opaque_struct(struct_name, last_block_comment)
813 last_block_comment = None
814 out_java_struct.write(out_opaque_struct_human)
815 elif result_contents is not None:
816 assert result_contents in result_ptr_struct_items
817 res_ty, err_ty = result_ptr_struct_items[result_contents]
818 map_result(struct_name, res_ty, err_ty)
819 elif struct_name.startswith("LDKCResult_") and struct_name.endswith("ZPtr"):
820 for line in field_lines:
821 if line.endswith("*result;"):
822 res_ty = line[:-8].strip()
823 elif line.endswith("*err;"):
824 err_ty = line[:-5].strip()
825 result_ptr_struct_items[struct_name] = (res_ty, err_ty)
826 result_types.add(struct_name[:-3])
828 map_tuple(struct_name, field_lines)
829 elif vec_ty is not None:
830 ty_info = type_mapping_generator.map_type(vec_ty + " arr_elem", False, None, False, False)
831 if len(ty_info.java_fn_ty_arg) == 1: # ie we're a primitive of some form
832 out_java.write("\tpublic static native long " + struct_name + "_new(" + ty_info.java_ty + "[] elems);\n")
833 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")
834 write_c("\t" + struct_name + " *ret = MALLOC(sizeof(" + struct_name + "), \"" + struct_name + "\");\n")
835 write_c("\tret->datalen = " + consts.get_native_arr_len_call[0] + "elems" + consts.get_native_arr_len_call[1] + ";\n")
836 write_c("\tif (ret->datalen == 0) {\n")
837 write_c("\t\tret->data = NULL;\n")
838 write_c("\t} else {\n")
839 write_c("\t\tret->data = MALLOC(sizeof(" + vec_ty + ") * ret->datalen, \"" + struct_name + " Data\");\n")
840 native_arr_ptr_call = consts.get_native_arr_ptr_call(ty_info.ty_info)
841 write_c("\t\t" + ty_info.c_ty + " *java_elems = " + native_arr_ptr_call[0] + "elems" + native_arr_ptr_call[1] + ";\n")
842 write_c("\t\tfor (size_t i = 0; i < ret->datalen; i++) {\n")
843 if ty_info.arg_conv is not None:
844 write_c("\t\t\t" + ty_info.c_ty + " arr_elem = java_elems[i];\n")
845 write_c("\t\t\t" + ty_info.arg_conv.replace("\n", "\n\t\t\t") + "\n")
846 write_c("\t\t\tret->data[i] = " + ty_info.arg_conv_name + ";\n")
847 assert ty_info.arg_conv_cleanup is None
849 write_c("\t\t\tret->data[i] = java_elems[i];\n")
851 cleanup = consts.release_native_arr_ptr_call(ty_info.ty_info, "elems", "java_elems")
852 if cleanup is not None:
853 write_c("\t\t" + cleanup + ";\n")
855 write_c("\treturn (long)ret;\n")
858 if ty_info.is_native_primitive:
859 clone_fns.add(struct_name.replace("LDK", "") + "_clone")
860 write_c("static inline " + struct_name + " " + struct_name.replace("LDK", "") + "_clone(const " + struct_name + " *orig) {\n")
861 write_c("\t" + struct_name + " ret = { .data = MALLOC(sizeof(" + ty_info.c_ty + ") * orig->datalen, \"" + struct_name + " clone bytes\"), .datalen = orig->datalen };\n")
862 write_c("\tmemcpy(ret.data, orig->data, sizeof(" + ty_info.c_ty + ") * ret.datalen);\n")
863 write_c("\treturn ret;\n}\n")
864 elif (ty_info.rust_obj.replace("LDK", "") + "_clone") in clone_fns:
865 ty_name = "CVec_" + ty_info.rust_obj.replace("LDK", "") + "Z";
866 clone_fns.add(ty_name + "_clone")
867 write_c("static inline " + struct_name + " " + ty_name + "_clone(const " + struct_name + " *orig) {\n")
868 write_c("\t" + struct_name + " ret = { .data = MALLOC(sizeof(" + ty_info.rust_obj + ") * orig->datalen, \"" + struct_name + " clone bytes\"), .datalen = orig->datalen };\n")
869 write_c("\tfor (size_t i = 0; i < ret.datalen; i++) {\n")
870 write_c("\t\tret.data[i] = " + ty_info.rust_obj.replace("LDK", "") + "_clone(&orig->data[i]);\n")
871 write_c("\t}\n\treturn ret;\n}\n")
873 assert(struct_name.endswith("_Tag"))
874 struct_name = struct_name[:-4]
875 union_enum_items[struct_name] = {"field_lines": field_lines}
876 elif struct_name.endswith("_Body") and struct_name.split("_")[0] in union_enum_items:
877 enum_var_name = struct_name.split("_")
878 union_enum_items[enum_var_name[0]][enum_var_name[1]] = field_lines
879 elif struct_name in union_enum_items:
882 for line in field_lines:
883 if line == " struct {":
887 elif elem_items > -1:
889 if line.startswith("struct "):
891 split = line.split(" ")
892 assert len(split) == 2
893 tuple_variants[split[1].strip(";")] = split[0]
896 # We don't currently support tuple variant with more than one element
898 map_complex_enum(struct_name, union_enum_items[struct_name], tuple_variants, last_block_comment)
899 last_block_comment = None
900 elif is_unitary_enum:
901 map_unitary_enum(struct_name, field_lines, last_block_comment)
902 last_block_comment = None
903 elif len(trait_fn_lines) > 0:
904 map_trait(struct_name, field_var_lines, trait_fn_lines, last_block_comment)
905 elif struct_name == "LDKTxOut":
906 with open(f"{sys.argv[3]}/structs/TxOut{consts.file_ext}", "w") as out_java_struct:
907 out_java_struct.write(consts.hu_struct_file_prefix)
908 out_java_struct.write("public class TxOut extends CommonBase{\n")
909 out_java_struct.write("\tTxOut(java.lang.Object _dummy, long ptr) { super(ptr); }\n")
910 out_java_struct.write("\tlong to_c_ptr() { return 0; }\n")
911 out_java_struct.write("\t@Override @SuppressWarnings(\"deprecation\")\n")
912 out_java_struct.write("\tprotected void finalize() throws Throwable {\n")
913 out_java_struct.write("\t\tsuper.finalize();\n")
914 out_java_struct.write("\t\tif (ptr != 0) { bindings.TxOut_free(ptr); }\n")
915 out_java_struct.write("\t}\n")
917 out_java_struct.write("}")
919 pass # Everything remaining is a byte[] or some form
922 fn_ptr = fn_ptr_regex.match(line)
923 fn_ret_arr = fn_ret_arr_regex.match(line)
924 reg_fn = reg_fn_regex.match(line)
925 const_val = const_val_regex.match(line)
927 if line.startswith("#include <"):
929 elif line.startswith("/*"):
930 if not line.endswith("*/\n"):
931 block_comment = line.strip(" /*")
932 elif line.startswith("typedef enum "):
934 elif line.startswith("typedef struct "):
936 elif line.startswith("typedef union "):
938 elif fn_ptr is not None:
939 map_fn(line, fn_ptr, None, None, last_block_comment)
940 last_block_comment = None
941 elif fn_ret_arr is not None:
942 map_fn(line, fn_ret_arr, fn_ret_arr.group(4), None, last_block_comment)
943 last_block_comment = None
944 elif reg_fn is not None:
945 map_fn(line, reg_fn, None, None, last_block_comment)
946 last_block_comment = None
947 elif const_val_regex is not None:
948 # TODO Map const variables
953 out_java.write(consts.bindings_footer)
954 for struct_name in opaque_structs:
955 with open(f"{sys.argv[3]}/structs/{struct_name.replace('LDK', '')}{consts.file_ext}", "a") as out_java_struct:
956 out_java_struct.write("}\n")
957 for struct_name in trait_structs:
958 with open(f"{sys.argv[3]}/structs/{struct_name.replace('LDK', '')}{consts.file_ext}", "a") as out_java_struct:
959 out_java_struct.write("}\n")
960 for struct_name in complex_enums:
961 with open(f"{sys.argv[3]}/structs/{struct_name.replace('LDK', '').replace('COption', 'Option')}{consts.file_ext}", "a") as out_java_struct:
962 out_java_struct.write("}\n")
963 for struct_name in result_types:
964 with open(f"{sys.argv[3]}/structs/{struct_name.replace('LDKCResult', 'Result')}{consts.file_ext}", "a") as out_java_struct:
965 out_java_struct.write("}\n")
967 with open(sys.argv[4], "w") as out_c:
968 out_c.write(consts.c_file_pfx)
969 out_c.write(consts.init_str())
971 with open(f"{sys.argv[3]}/structs/UtilMethods{consts.file_ext}", "a") as util:
972 util.write(consts.util_fn_sfx)