Add docs for and mark nullable complex enum fields
[ldk-java] / genbindings.py
1 #!/usr/bin/env python3
2 import os, sys, re, subprocess
3
4 if len(sys.argv) < 7:
5     print("USAGE: /path/to/lightning.h /path/to/bindings/output /path/to/bindings/ /path/to/bindings/output.c debug lang")
6     sys.exit(1)
7
8 if sys.argv[5] == "false":
9     DEBUG = False
10 elif sys.argv[5] == "true":
11     DEBUG = True
12 else:
13     print("debug should be true or false and indicates whether to track allocations and ensure we don't leak")
14     sys.exit(1)
15
16 target = None
17 if sys.argv[6] == "java" or sys.argv[6] == "android":
18     import java_strings
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
29 else:
30     print("Only java or typescript can be set for lang")
31     sys.exit(1)
32
33
34 consts = Consts(DEBUG, target=target)
35
36 local_git_version = os.getenv("LDK_GARBAGECOLLECTED_GIT_OVERRIDE")
37 if local_git_version is None:
38     local_git_version = subprocess.check_output(["git", "describe", '--tag', '--dirty']).decode("utf-8").strip()
39
40 from bindingstypes import *
41
42 c_file = ""
43 def write_c(s):
44     global c_file
45     c_file += s
46
47 def camel_to_snake(s):
48     # Convert camel case to snake case, in a way that appears to match cbindgen
49     con = "_"
50     ret = ""
51     lastchar = ""
52     lastund = False
53     for char in s:
54         if lastchar.isupper():
55             if not char.isupper() and not lastund:
56                 ret = ret + "_"
57                 lastund = True
58             else:
59                 lastund = False
60             ret = ret + lastchar.lower()
61         else:
62             ret = ret + lastchar
63             if char.isupper() and not lastund:
64                 ret = ret + "_"
65                 lastund = True
66             else:
67                 lastund = False
68         lastchar = char
69         if char.isnumeric():
70             lastund = True
71     return (ret + lastchar.lower()).strip("_")
72
73 def doc_to_field_nullable(doc):
74     if doc is None:
75         return False
76     for line in doc.splitlines():
77         if "Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None" in line:
78             return True
79     return False
80
81 def doc_to_params_ret_nullable(doc):
82     if doc is None:
83         return (set(), False)
84     params = set()
85     ret_null = False
86     for line in doc.splitlines():
87         if "may be NULL or all-0s to represent None" not in line:
88             continue
89         if "Note that the return value" in line:
90             ret_null = True
91         elif "Note that " in line:
92             param = line.split("Note that ")[1].split(" ")[0]
93             params.add(param)
94     return (params, ret_null)
95
96 unitary_enums = set()
97 complex_enums = set()
98 opaque_structs = set()
99 trait_structs = {}
100 result_types = set()
101 tuple_types = {}
102
103 var_is_arr_regex = re.compile("\(\*([A-za-z0-9_]*)\)\[([a-z0-9]*)\]")
104 var_ty_regex = re.compile("([A-za-z_0-9]*)(.*)")
105 java_c_types_none_allowed = True # Unset when we do the real pass that populates the above sets
106 def java_c_types(fn_arg, ret_arr_len):
107     fn_arg = fn_arg.strip()
108     if fn_arg.startswith("MUST_USE_RES "):
109         fn_arg = fn_arg[13:]
110     is_const = False
111     if fn_arg.startswith("const "):
112         fn_arg = fn_arg[6:]
113         is_const = True
114     if fn_arg.startswith("struct "):
115         fn_arg = fn_arg[7:]
116     if fn_arg.startswith("enum "):
117         fn_arg = fn_arg[5:]
118     nonnull_ptr = "NONNULL_PTR" in fn_arg
119     fn_arg = fn_arg.replace("NONNULL_PTR", "")
120
121     is_ptr = False
122     take_by_ptr = False
123     rust_obj = None
124     arr_access = None
125     java_hu_ty = None
126     if fn_arg.startswith("LDKThirtyTwoBytes"):
127         fn_arg = "uint8_t (*" + fn_arg[18:] + ")[32]"
128         assert var_is_arr_regex.match(fn_arg[8:])
129         rust_obj = "LDKThirtyTwoBytes"
130         arr_access = "data"
131     elif fn_arg.startswith("LDKTxid"):
132         fn_arg = "uint8_t (*" + fn_arg[8:] + ")[32]"
133         assert var_is_arr_regex.match(fn_arg[8:])
134         rust_obj = "LDKThirtyTwoBytes"
135         arr_access = "data"
136     elif fn_arg.startswith("LDKPublicKey"):
137         fn_arg = "uint8_t (*" + fn_arg[13:] + ")[33]"
138         assert var_is_arr_regex.match(fn_arg[8:])
139         rust_obj = "LDKPublicKey"
140         arr_access = "compressed_form"
141     elif fn_arg.startswith("LDKSecretKey"):
142         fn_arg = "uint8_t (*" + fn_arg[13:] + ")[32]"
143         assert var_is_arr_regex.match(fn_arg[8:])
144         rust_obj = "LDKSecretKey"
145         arr_access = "bytes"
146     elif fn_arg.startswith("LDKSignature"):
147         fn_arg = "uint8_t (*" + fn_arg[13:] + ")[64]"
148         assert var_is_arr_regex.match(fn_arg[8:])
149         rust_obj = "LDKSignature"
150         arr_access = "compact_form"
151     elif fn_arg.startswith("LDKRecoverableSignature"):
152         fn_arg = "uint8_t (*" + fn_arg[25:] + ")[68]"
153         assert var_is_arr_regex.match(fn_arg[8:])
154         rust_obj = "LDKRecoverableSignature"
155         arr_access = "serialized_form"
156     elif fn_arg.startswith("LDKThreeBytes"):
157         fn_arg = "uint8_t (*" + fn_arg[14:] + ")[3]"
158         assert var_is_arr_regex.match(fn_arg[8:])
159         rust_obj = "LDKThreeBytes"
160         arr_access = "data"
161     elif fn_arg.startswith("LDKFourBytes"):
162         fn_arg = "uint8_t (*" + fn_arg[13:] + ")[4]"
163         assert var_is_arr_regex.match(fn_arg[8:])
164         rust_obj = "LDKFourBytes"
165         arr_access = "data"
166     elif fn_arg.startswith("LDKSixteenBytes"):
167         fn_arg = "uint8_t (*" + fn_arg[16:] + ")[16]"
168         assert var_is_arr_regex.match(fn_arg[8:])
169         rust_obj = "LDKSixteenBytes"
170         arr_access = "data"
171     elif fn_arg.startswith("LDKTwentyBytes"):
172         fn_arg = "uint8_t (*" + fn_arg[15:] + ")[20]"
173         assert var_is_arr_regex.match(fn_arg[8:])
174         rust_obj = "LDKTwentyBytes"
175         arr_access = "data"
176     elif fn_arg.startswith("LDKTenBytes"):
177         fn_arg = "uint8_t (*" + fn_arg[12:] + ")[10]"
178         assert var_is_arr_regex.match(fn_arg[8:])
179         rust_obj = "LDKTenBytes"
180         arr_access = "data"
181     elif fn_arg.startswith("LDKu8slice"):
182         fn_arg = "uint8_t (*" + fn_arg[11:] + ")[datalen]"
183         assert var_is_arr_regex.match(fn_arg[8:])
184         rust_obj = "LDKu8slice"
185         arr_access = "data"
186     elif fn_arg.startswith("LDKCVec_u8Z"):
187         fn_arg = "uint8_t (*" + fn_arg[12:] + ")[datalen]"
188         rust_obj = "LDKCVec_u8Z"
189         assert var_is_arr_regex.match(fn_arg[8:])
190         arr_access = "data"
191     elif fn_arg.startswith("LDKTransaction ") or fn_arg == "LDKTransaction":
192         fn_arg = "uint8_t (*" + fn_arg[15:] + ")[datalen]"
193         rust_obj = "LDKTransaction"
194         assert var_is_arr_regex.match(fn_arg[8:])
195         arr_access = "data"
196     elif fn_arg.startswith("LDKCVec_"):
197         is_ptr = False
198         if "*" in fn_arg:
199             fn_arg = fn_arg.replace("*", "")
200             is_ptr = True
201
202         tyn = fn_arg[8:].split(" ")
203         assert tyn[0].endswith("Z")
204         if tyn[0] == "u64Z":
205             new_arg = "uint64_t"
206         else:
207             new_arg = "LDK" + tyn[0][:-1]
208         for a in tyn[1:]:
209             new_arg = new_arg + " " + a
210         res = java_c_types(new_arg, ret_arr_len)
211         if res is None:
212             assert java_c_types_none_allowed
213             return None
214         if is_ptr:
215             res.pass_by_ref = True
216         if res.is_native_primitive or res.passed_as_ptr:
217             return TypeInfo(rust_obj=fn_arg.split(" ")[0], java_ty=res.java_ty + "[]", java_hu_ty=res.java_hu_ty + "[]",
218                 java_fn_ty_arg="[" + res.java_fn_ty_arg, c_ty=res.c_ty + "Array", passed_as_ptr=False, is_ptr=is_ptr,
219                 nonnull_ptr=nonnull_ptr, is_const=is_const,
220                 var_name=res.var_name, arr_len="datalen", arr_access="data", subty=res, is_native_primitive=False)
221         else:
222             return TypeInfo(rust_obj=fn_arg.split(" ")[0], java_ty=res.java_ty + "[]", java_hu_ty=res.java_hu_ty + "[]",
223                 java_fn_ty_arg="[" + res.java_fn_ty_arg, c_ty=consts.ptr_arr, passed_as_ptr=False, is_ptr=is_ptr,
224                 nonnull_ptr=nonnull_ptr, is_const=is_const,
225                 var_name=res.var_name, arr_len="datalen", arr_access="data", subty=res, is_native_primitive=False)
226
227     is_primitive = False
228     arr_len = None
229     mapped_type = []
230     java_type_plural = None
231     if fn_arg.startswith("void"):
232         java_ty = "void"
233         c_ty = "void"
234         fn_ty_arg = "V"
235         fn_arg = fn_arg[4:].strip()
236         is_primitive = True
237     elif fn_arg.startswith("bool"):
238         java_ty = "boolean"
239         c_ty = "jboolean"
240         fn_ty_arg = "Z"
241         fn_arg = fn_arg[4:].strip()
242         is_primitive = True
243     elif fn_arg.startswith("uint8_t"):
244         mapped_type = consts.c_type_map['uint8_t']
245         java_ty = mapped_type[0]
246         c_ty = "int8_t"
247         fn_ty_arg = "B"
248         fn_arg = fn_arg[7:].strip()
249         is_primitive = True
250     elif fn_arg.startswith("LDKu5"):
251         java_ty = consts.c_type_map['uint8_t'][0]
252         java_hu_ty = "UInt5"
253         rust_obj = "LDKu5"
254         c_ty = "int8_t"
255         fn_ty_arg = "B"
256         fn_arg = fn_arg[6:].strip()
257     elif fn_arg.startswith("uint16_t"):
258         mapped_type = consts.c_type_map['uint16_t']
259         java_ty = mapped_type[0]
260         c_ty = "int16_t"
261         fn_ty_arg = "S"
262         fn_arg = fn_arg[8:].strip()
263         is_primitive = True
264     elif fn_arg.startswith("uint32_t"):
265         mapped_type = consts.c_type_map['uint32_t']
266         java_ty = mapped_type[0]
267         c_ty = "int32_t"
268         fn_ty_arg = "I"
269         fn_arg = fn_arg[8:].strip()
270         is_primitive = True
271     elif fn_arg.startswith("uint64_t") or fn_arg.startswith("uintptr_t"):
272         # TODO: uintptr_t is arch-dependent :(
273         mapped_type = consts.c_type_map['uint64_t']
274         java_ty = mapped_type[0]
275         fn_ty_arg = "J"
276         if fn_arg.startswith("uint64_t"):
277             c_ty = "int64_t"
278             fn_arg = fn_arg[8:].strip()
279         else:
280             c_ty = "int64_t"
281             rust_obj = "uintptr_t"
282             fn_arg = fn_arg[9:].strip()
283         is_primitive = True
284     elif is_const and fn_arg.startswith("char *"):
285         java_ty = "String"
286         c_ty = "const char*"
287         fn_ty_arg = "Ljava/lang/String;"
288         fn_arg = fn_arg[6:].strip()
289     elif fn_arg.startswith("LDKStr"):
290         rust_obj = "LDKStr"
291         java_ty = "String"
292         c_ty = "jstring"
293         fn_ty_arg = "Ljava/lang/String;"
294         fn_arg = fn_arg[6:].strip()
295         arr_access = "chars"
296         arr_len = "len"
297     else:
298         ma = var_ty_regex.match(fn_arg)
299         if ma.group(1).strip() in unitary_enums:
300             assert ma.group(1).strip().startswith("LDK")
301             java_ty = ma.group(1).strip()[3:]
302             java_hu_ty = java_ty
303             c_ty = consts.result_c_ty
304             fn_ty_arg = "Lorg/ldk/enums/" + java_ty + ";"
305             fn_arg = ma.group(2).strip()
306             rust_obj = ma.group(1).strip()
307         elif ma.group(1).strip().startswith("LDKC2Tuple"):
308             c_ty = consts.ptr_c_ty
309             java_ty = consts.ptr_native_ty
310             java_hu_ty = "TwoTuple<"
311             if not ma.group(1).strip() in tuple_types:
312                 assert java_c_types_none_allowed
313                 return None
314             for idx, ty_info in enumerate(tuple_types[ma.group(1).strip()][0]):
315                 if idx != 0:
316                     java_hu_ty = java_hu_ty + ", "
317                 if ty_info.is_native_primitive:
318                     if ty_info.java_hu_ty == "int":
319                         java_hu_ty = java_hu_ty + "Integer" # Java concrete integer type is Integer, not Int
320                     else:
321                         java_hu_ty = java_hu_ty + ty_info.java_hu_ty.title() # If we're a primitive, capitalize the first letter
322                 else:
323                     java_hu_ty = java_hu_ty + ty_info.java_hu_ty
324             java_hu_ty = java_hu_ty + ">"
325             fn_ty_arg = "J"
326             fn_arg = ma.group(2).strip()
327             rust_obj = ma.group(1).strip()
328             take_by_ptr = True
329         elif ma.group(1).strip().startswith("LDKC3Tuple"):
330             c_ty = consts.ptr_c_ty
331             java_ty = consts.ptr_native_ty
332             java_hu_ty = "ThreeTuple<"
333             if not ma.group(1).strip() in tuple_types:
334                 assert java_c_types_none_allowed
335                 return None
336             for idx, ty_info in enumerate(tuple_types[ma.group(1).strip()][0]):
337                 if idx != 0:
338                     java_hu_ty = java_hu_ty + ", "
339                 if ty_info.is_native_primitive:
340                     if ty_info.java_hu_ty == "int":
341                         java_hu_ty = java_hu_ty + "Integer" # Java concrete integer type is Integer, not Int
342                     else:
343                         java_hu_ty = java_hu_ty + ty_info.java_hu_ty.title() # If we're a primitive, capitalize the first letter
344                 else:
345                     java_hu_ty = java_hu_ty + ty_info.java_hu_ty
346             java_hu_ty = java_hu_ty + ">"
347             fn_ty_arg = "J"
348             fn_arg = ma.group(2).strip()
349             rust_obj = ma.group(1).strip()
350             take_by_ptr = True
351         else:
352             c_ty = consts.ptr_c_ty
353             java_ty = consts.ptr_native_ty
354             java_hu_ty = ma.group(1).strip().replace("LDKCOption", "Option").replace("LDKCResult", "Result").replace("LDK", "")
355             fn_ty_arg = "J"
356             fn_arg = ma.group(2).strip()
357             rust_obj = ma.group(1).strip()
358             take_by_ptr = True
359
360     if fn_arg.startswith(" *") or fn_arg.startswith("*"):
361         fn_arg = fn_arg.replace("*", "").strip()
362         is_ptr = True
363         c_ty = consts.ptr_c_ty
364         java_ty = consts.ptr_native_ty
365         fn_ty_arg = "J"
366
367     var_is_arr = var_is_arr_regex.match(fn_arg)
368     if var_is_arr is not None or ret_arr_len is not None:
369         assert(not take_by_ptr)
370         assert(not is_ptr)
371         # is there a special case for plurals?
372         if len(mapped_type) == 2:
373             java_ty = mapped_type[1]
374         else:
375             java_ty = java_ty + "[]"
376         c_ty = c_ty + "Array"
377         if var_is_arr is not None:
378             if var_is_arr.group(1) == "":
379                 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,
380                     passed_as_ptr=False, is_ptr=False, nonnull_ptr=nonnull_ptr, var_name="arg",
381                     arr_len=var_is_arr.group(2), arr_access=arr_access, is_native_primitive=False)
382             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,
383                 passed_as_ptr=False, is_ptr=False, nonnull_ptr=nonnull_ptr, var_name=var_is_arr.group(1),
384                 arr_len=var_is_arr.group(2), arr_access=arr_access, is_native_primitive=False)
385
386     if java_hu_ty is None:
387         java_hu_ty = java_ty
388     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,
389         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)
390
391 fn_ptr_regex = re.compile("^extern const ([A-Za-z_0-9\* ]*) \(\*(.*)\)\((.*)\);$")
392 fn_ret_arr_regex = re.compile("(.*) \(\*(.*)\((.*)\)\)\[([0-9]*)\];$")
393 reg_fn_regex = re.compile("([A-Za-z_0-9\* ]* \*?)([a-zA-Z_0-9]*)\((.*)\);$")
394 clone_fns = set()
395 constructor_fns = {}
396
397 from gen_type_mapping import TypeMappingGenerator
398 type_mapping_generator = TypeMappingGenerator(java_c_types, consts, opaque_structs, clone_fns, unitary_enums, trait_structs, complex_enums, result_types, tuple_types)
399
400 with open(sys.argv[1]) as in_h:
401     for line in in_h:
402         reg_fn = reg_fn_regex.match(line)
403         if reg_fn is not None:
404             if reg_fn.group(2).endswith("_clone"):
405                 clone_fns.add(reg_fn.group(2))
406             else:
407                 rty = java_c_types(reg_fn.group(1), None)
408                 if rty is not None and not rty.is_native_primitive and reg_fn.group(2) == rty.java_hu_ty + "_new":
409                     constructor_fns[rty.rust_obj] = reg_fn.group(3)
410             continue
411         arr_fn = fn_ret_arr_regex.match(line)
412         if arr_fn is not None:
413             if arr_fn.group(2).endswith("_clone"):
414                 clone_fns.add(arr_fn.group(2))
415             # No object constructors return arrays, as then they wouldn't be an object constructor
416             continue
417
418 # Define some manual clones...
419 clone_fns.add("ThirtyTwoBytes_clone")
420 write_c("static inline struct LDKThirtyTwoBytes ThirtyTwoBytes_clone(const struct LDKThirtyTwoBytes *orig) { struct LDKThirtyTwoBytes ret; memcpy(ret.data, orig->data, 32); return ret; }\n")
421
422 java_c_types_none_allowed = False # C structs created by cbindgen are declared in dependency order
423
424 with open(f"{sys.argv[3]}/structs/UtilMethods{consts.file_ext}", "a") as util:
425     util.write(consts.util_fn_pfx)
426
427 with open(sys.argv[1]) as in_h, open(sys.argv[2], "w") as out_java:
428     # Map a top-level function
429     def map_fn(line, re_match, ret_arr_len, c_call_string, doc_comment):
430         method_return_type = re_match.group(1)
431         method_name = re_match.group(2)
432         orig_method_name = str(method_name)
433         method_comma_separated_arguments = re_match.group(3)
434         method_arguments = method_comma_separated_arguments.split(',')
435
436         is_free = method_name.endswith("_free")
437         if method_name.startswith("COption") or method_name.startswith("CResult"):
438             struct_meth = method_name.rsplit("Z", 1)[0][1:] + "Z"
439         else:
440             struct_meth = method_name.split("_")[0]
441
442         return_type_info = type_mapping_generator.map_type(method_return_type.strip() + " ret", True, ret_arr_len, False, False)
443
444         (params_nullable, ret_nullable) = doc_to_params_ret_nullable(doc_comment)
445         if ret_nullable:
446             return_type_info.nullable = True
447
448         argument_types = []
449         default_constructor_args = {}
450         takes_self = False
451         takes_self_ptr = False
452         args_known = True
453
454         for argument_index, argument in enumerate(method_arguments):
455             argument_conversion_info = type_mapping_generator.map_type(argument, False, None, is_free, True)
456             if argument_index == 0 and argument_conversion_info.java_hu_ty == struct_meth:
457                 takes_self = True
458                 if argument_conversion_info.ty_info.is_ptr:
459                     takes_self_ptr = True
460             elif argument_conversion_info.arg_name in params_nullable:
461                 argument_conversion_info.nullable = True
462             if argument_conversion_info.arg_conv is not None and "Warning" in argument_conversion_info.arg_conv:
463                 assert not argument_conversion_info.arg_name in params_nullable
464                 if argument_conversion_info.rust_obj in constructor_fns:
465                     assert not is_free
466                     for explode_arg in constructor_fns[argument_conversion_info.rust_obj].split(','):
467                         explode_arg_conv = type_mapping_generator.map_type(explode_arg, False, None, False, True)
468                         if explode_arg_conv.c_ty == "void":
469                             # We actually want to handle this case, but for now its only used in NetGraphMsgHandler::new()
470                             # which ends up resulting in a redundant constructor - both without arguments for the NetworkGraph.
471                             args_known = False
472                             pass
473                         if not argument_conversion_info.arg_name in default_constructor_args:
474                             default_constructor_args[argument_conversion_info.arg_name] = []
475                         default_constructor_args[argument_conversion_info.arg_name].append(explode_arg_conv)
476             argument_types.append(argument_conversion_info)
477         if not takes_self and return_type_info.java_hu_ty != struct_meth:
478             if not return_type_info.java_hu_ty.startswith("Result_" + struct_meth):
479                 method_name = orig_method_name
480                 struct_meth = ""
481
482         out_java.write("\t// " + line)
483         (out_java_delta, out_c_delta, out_java_struct_delta) = \
484             consts.map_function(argument_types, c_call_string, method_name, return_type_info, struct_meth, default_constructor_args, takes_self, takes_self_ptr, args_known, type_mapping_generator, doc_comment)
485         out_java.write(out_java_delta)
486
487         if is_free:
488             assert len(argument_types) == 1
489             assert return_type_info.c_ty == "void"
490             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")
491             if argument_types[0].ty_info.passed_as_ptr and not argument_types[0].ty_info.rust_obj in opaque_structs:
492                 write_c("\tif ((" + argument_types[0].ty_info.var_name + " & 1) != 0) return;\n")
493
494             for info in argument_types:
495                 if info.arg_conv is not None:
496                     write_c("\t" + info.arg_conv.replace('\n', "\n\t") + "\n")
497             assert c_call_string is None
498             write_c("\t" + method_name + "(")
499             if argument_types[0].arg_conv_name is not None:
500                 write_c(argument_types[0].arg_conv_name)
501             write_c(");")
502             for info in argument_types:
503                 if info.arg_conv_cleanup is not None:
504                     write_c("\n\t" + info.arg_conv_cleanup.replace("\n", "\n\t"))
505             write_c("\n}\n\n")
506         else:
507             write_c(out_c_delta)
508
509         out_java_struct = None
510         expected_struct = "LDK" + struct_meth
511         expected_cstruct = "LDKC" + struct_meth
512         if (expected_struct in opaque_structs or expected_struct in trait_structs
513                 or expected_struct in complex_enums or expected_cstruct in complex_enums
514                 or expected_cstruct in result_types) and not is_free:
515             out_java_struct = open(f"{sys.argv[3]}/structs/{struct_meth}{consts.file_ext}", "a")
516             out_java_struct.write(out_java_struct_delta)
517         elif (not is_free and not method_name.endswith("_clone") and
518                 not method_name.startswith("_") and
519                 method_name != "check_platform" and method_name != "Result_read" and
520                 not expected_struct in unitary_enums and
521                 ((not method_name.startswith("C2Tuple_") and not method_name.startswith("C3Tuple_"))
522                   or method_name.endswith("_read"))):
523             out_java_struct = open(f"{sys.argv[3]}/structs/UtilMethods{consts.file_ext}", "a")
524             for line in out_java_struct_delta.splitlines():
525                 if not line.strip().startswith("this."):
526                     out_java_struct.write(line + "\n")
527                 else:
528                     out_java_struct.write("\t\t// " + line.strip() + "\n")
529
530     def map_unitary_enum(struct_name, field_lines, enum_doc_comment):
531         assert struct_name.startswith("LDK")
532         with open(f"{sys.argv[3]}/enums/{struct_name[3:]}{consts.file_ext}", "w") as out_java_enum:
533             unitary_enums.add(struct_name)
534             for idx, (struct_line, _) in enumerate(field_lines):
535                 if idx == 0:
536                     assert(struct_line == "typedef enum %s {" % struct_name)
537                 elif idx == len(field_lines) - 3:
538                     assert(struct_line.endswith("_Sentinel,"))
539                 elif idx == len(field_lines) - 2:
540                     assert(struct_line == "} %s;" % struct_name)
541                 elif idx == len(field_lines) - 1:
542                     assert(struct_line == "")
543             assert struct_name.startswith("LDK")
544             (c_out, native_file_out, native_out) = consts.native_c_unitary_enum_map(struct_name[3:], [x.strip().strip(",") for x, _ in field_lines[1:-3]], enum_doc_comment)
545             write_c(c_out)
546             out_java_enum.write(native_file_out)
547             out_java.write(native_out)
548
549     def map_complex_enum(struct_name, union_enum_items, inline_enum_variants, enum_doc_comment):
550         java_hu_type = struct_name.replace("LDK", "").replace("COption", "Option")
551         complex_enums.add(struct_name)
552
553         enum_variants = []
554         tag_field_lines = union_enum_items["field_lines"]
555         for idx, (struct_line, _) in enumerate(tag_field_lines):
556             if idx == 0:
557                 assert(struct_line == "typedef enum %s_Tag {" % struct_name)
558             elif idx == len(tag_field_lines) - 3:
559                 assert(struct_line.endswith("_Sentinel,"))
560             elif idx == len(tag_field_lines) - 2:
561                 assert(struct_line == "} %s_Tag;" % struct_name)
562             elif idx == len(tag_field_lines) - 1:
563                 assert(struct_line == "")
564             else:
565                 variant_name = struct_line.strip(' ,')[len(struct_name) + 1:]
566                 fields = []
567                 if "LDK" + variant_name in union_enum_items:
568                     enum_var_lines = union_enum_items["LDK" + variant_name]
569                     for idx, (field, field_docs) in enumerate(enum_var_lines):
570                         if idx != 0 and idx < len(enum_var_lines) - 2 and field.strip() != "":
571                             field_ty = type_mapping_generator.map_type(field.strip(' ;'), False, None, False, True)
572                             if field_docs is not None and doc_to_field_nullable(field_docs):
573                                 field_ty.nullable = True
574                             fields.append((field_ty, field_docs))
575                     enum_variants.append(ComplexEnumVariantInfo(variant_name, fields, False))
576                 elif camel_to_snake(variant_name) in inline_enum_variants:
577                     # TODO: If we ever have a rust enum Variant(Option<Struct>) we need to pipe
578                     # docs through to there, and then potentially mark the field nullable.
579                     fields.append((type_mapping_generator.map_type(inline_enum_variants[camel_to_snake(variant_name)] + " " + camel_to_snake(variant_name), False, None, False, True), None))
580                     enum_variants.append(ComplexEnumVariantInfo(variant_name, fields, True))
581                 else:
582                     enum_variants.append(ComplexEnumVariantInfo(variant_name, fields, True))
583
584         with open(f"{sys.argv[3]}/structs/{java_hu_type}{consts.file_ext}", "w") as out_java_enum:
585             (out_java_addendum, out_java_enum_addendum, out_c_addendum) = consts.map_complex_enum(struct_name, enum_variants, camel_to_snake, enum_doc_comment)
586
587             out_java_enum.write(out_java_enum_addendum)
588             out_java.write(out_java_addendum)
589             write_c(out_c_addendum)
590
591     def map_trait(struct_name, field_var_lines, trait_fn_lines, trait_doc_comment):
592         with open(f"{sys.argv[3]}/structs/{struct_name.replace('LDK', '')}{consts.file_ext}", "w") as out_java_trait:
593             field_var_convs = []
594             flattened_field_var_convs = []
595             for var_line in field_var_lines:
596                 if var_line.group(1) in trait_structs:
597                     field_var_convs.append((var_line.group(1), var_line.group(2), trait_structs[var_line.group(1)]))
598                     flattened_field_var_convs.append((var_line.group(1), var_line.group(2), ))
599                     flattened_field_var_convs.extend(trait_structs[var_line.group(1)])
600                 else:
601                     mapped = type_mapping_generator.map_type(var_line.group(1) + " " + var_line.group(2), False, None, False, False)
602                     field_var_convs.append(mapped)
603                     flattened_field_var_convs.append(mapped)
604             trait_structs[struct_name] = field_var_convs
605
606             field_fns = []
607             for fn_docs, fn_line in trait_fn_lines:
608                 if fn_line == "cloned":
609                     ret_ty_info = type_mapping_generator.map_type("void", True, None, False, False)
610                     field_fns.append(TraitMethInfo("cloned", False, ret_ty_info, [], fn_docs))
611                 else:
612                     ret_ty_info = type_mapping_generator.map_type(fn_line.group(2).strip() + " ret", True, None, False, False)
613                     is_const = fn_line.group(4) is not None
614                     (nullable_params, ret_nullable) = doc_to_params_ret_nullable(fn_docs)
615                     if ret_nullable:
616                         assert False # This isn't yet handled on the Java side
617                         ret_ty_info.nullable = True
618
619                     arg_tys = []
620                     for idx, arg in enumerate(fn_line.group(5).split(',')):
621                         if arg == "":
622                             continue
623                         arg_conv_info = type_mapping_generator.map_type(arg, True, None, False, False)
624                         if arg_conv_info.arg_name in nullable_params:
625                             # Types that are actually null instead of all-0s aren't yet handled on the Java side:
626                             assert arg_conv_info.rust_obj == "LDKPublicKey"
627                             arg_conv_info.nullable = True
628                         arg_tys.append(arg_conv_info)
629                     field_fns.append(TraitMethInfo(fn_line.group(3), is_const, ret_ty_info, arg_tys, fn_docs))
630
631             (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)
632             write_c(out_c_addendum)
633             out_java_trait.write(out_java_trait_addendum)
634             out_java.write(out_java_addendum)
635
636         for fn_docs, fn_line in trait_fn_lines:
637             if fn_line == "cloned":
638                 continue
639             # For now, just disable enabling the _call_log - we don't know how to inverse-map String
640             is_log = fn_line.group(3) == "log" and struct_name == "LDKLogger"
641             if fn_line.group(3) != "free" and fn_line.group(3) != "eq" and not is_log:
642                 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"
643                 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)
644         for idx, var_line in enumerate(field_var_lines):
645             if var_line.group(1) not in trait_structs:
646                 write_c(var_line.group(1) + " " + struct_name + "_set_get_" + var_line.group(2) + "(" + struct_name + "* this_arg) {\n")
647                 write_c("\tif (this_arg->set_" + var_line.group(2) + " != NULL)\n")
648                 write_c("\t\tthis_arg->set_" + var_line.group(2) + "(this_arg);\n")
649                 write_c("\treturn this_arg->" + var_line.group(2) + ";\n")
650                 write_c("}\n")
651                 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"
652                 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)
653
654     def map_result(struct_name, res_ty, err_ty):
655         result_types.add(struct_name)
656         human_ty = struct_name.replace("LDKCResult", "Result")
657         with open(f"{sys.argv[3]}/structs/{human_ty}{consts.file_ext}", "w") as out_java_struct:
658             out_java_struct.write(consts.hu_struct_file_prefix)
659             out_java_struct.write("public class " + human_ty + " extends CommonBase {\n")
660             out_java_struct.write("\tprivate " + human_ty + "(Object _dummy, long ptr) { super(ptr); }\n")
661             out_java_struct.write("\tprotected void finalize() throws Throwable {\n")
662             out_java_struct.write("\t\tif (ptr != 0) { bindings." + struct_name.replace("LDK","") + "_free(ptr); } super.finalize();\n")
663             out_java_struct.write("\t}\n\n")
664             out_java_struct.write("\tstatic " + human_ty + " constr_from_ptr(long ptr) {\n")
665             out_java_struct.write("\t\tif (bindings." + struct_name + "_result_ok(ptr)) {\n")
666             out_java_struct.write("\t\t\treturn new " + human_ty + "_OK(null, ptr);\n")
667             out_java_struct.write("\t\t} else {\n")
668             out_java_struct.write("\t\t\treturn new " + human_ty + "_Err(null, ptr);\n")
669             out_java_struct.write("\t\t}\n")
670             out_java_struct.write("\t}\n")
671
672             res_map = type_mapping_generator.map_type(res_ty + " res", True, None, False, True)
673             err_map = type_mapping_generator.map_type(err_ty + " err", True, None, False, True)
674             can_clone = True
675             if not res_map.is_native_primitive and (res_map.rust_obj.replace("LDK", "") + "_clone" not in clone_fns):
676                 can_clone = False
677             if not err_map.is_native_primitive and (err_map.rust_obj.replace("LDK", "") + "_clone" not in clone_fns):
678                 can_clone = False
679
680             out_java.write("\tpublic static native boolean " + struct_name + "_result_ok(long arg);\n")
681             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")
682             write_c("\treturn ((" + struct_name + "*)arg)->result_ok;\n")
683             write_c("}\n")
684
685             out_java.write("\tpublic static native " + res_map.java_ty + " " + struct_name + "_get_ok(long arg);\n")
686             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")
687             write_c("\t" + struct_name + " *val = (" + struct_name + "*)(arg & ~1);\n")
688             write_c("\tCHECK(val->result_ok);\n\t")
689             out_java_struct.write("\tpublic static final class " + human_ty + "_OK extends " + human_ty + " {\n")
690             if res_map.ret_conv is not None:
691                 write_c(res_map.ret_conv[0].replace("\n", "\n\t") + "(*val->contents.result)")
692                 write_c(res_map.ret_conv[1].replace("\n", "\n\t") + "\n\treturn " + res_map.ret_conv_name)
693             else:
694                 write_c("return *val->contents.result")
695             write_c(";\n}\n")
696
697             if res_map.java_hu_ty != "void":
698                 out_java_struct.write("\t\tpublic final " + res_map.java_hu_ty + " res;\n")
699             out_java_struct.write("\t\tprivate " + human_ty + "_OK(Object _dummy, long ptr) {\n")
700             out_java_struct.write("\t\t\tsuper(_dummy, ptr);\n")
701             if res_map.java_hu_ty == "void":
702                 pass
703             elif res_map.to_hu_conv is not None:
704                 out_java_struct.write("\t\t\t" + res_map.java_ty + " res = bindings." + struct_name + "_get_ok(ptr);\n")
705                 out_java_struct.write("\t\t\t" + res_map.to_hu_conv.replace("\n", "\n\t\t\t"))
706                 out_java_struct.write("\n\t\t\tthis.res = " + res_map.to_hu_conv_name + ";\n")
707             else:
708                 out_java_struct.write("\t\t\tthis.res = bindings." + struct_name + "_get_ok(ptr);\n")
709             out_java_struct.write("\t\t}\n")
710             out_java_struct.write("\t}\n\n")
711
712             out_java.write("\tpublic static native " + err_map.java_ty + " " + struct_name + "_get_err(long arg);\n")
713             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")
714             write_c("\t" + struct_name + " *val = (" + struct_name + "*)(arg & ~1);\n")
715             write_c("\tCHECK(!val->result_ok);\n\t")
716             out_java_struct.write("\tpublic static final class " + human_ty + "_Err extends " + human_ty + " {\n")
717             if err_map.ret_conv is not None:
718                 write_c(err_map.ret_conv[0].replace("\n", "\n\t") + "(*val->contents.err)")
719                 write_c(err_map.ret_conv[1].replace("\n", "\n\t") + "\n\treturn " + err_map.ret_conv_name)
720             else:
721                 write_c("return *val->contents.err")
722             write_c(";\n}\n")
723
724             if err_map.java_hu_ty != "void":
725                 out_java_struct.write("\t\tpublic final " + err_map.java_hu_ty + " err;\n")
726             out_java_struct.write("\t\tprivate " + human_ty + "_Err(Object _dummy, long ptr) {\n")
727             out_java_struct.write("\t\t\tsuper(_dummy, ptr);\n")
728             if err_map.java_hu_ty == "void":
729                 pass
730             elif err_map.to_hu_conv is not None:
731                 out_java_struct.write("\t\t\t" + err_map.java_ty + " err = bindings." + struct_name + "_get_err(ptr);\n")
732                 out_java_struct.write("\t\t\t" + err_map.to_hu_conv.replace("\n", "\n\t\t\t"))
733                 out_java_struct.write("\n\t\t\tthis.err = " + err_map.to_hu_conv_name + ";\n")
734             else:
735                 out_java_struct.write("\t\t\tthis.err = bindings." + struct_name + "_get_err(ptr);\n")
736             out_java_struct.write("\t\t}\n")
737
738             out_java_struct.write("\t}\n\n")
739
740     def map_tuple(struct_name, field_lines):
741         out_java.write("\tpublic static native long " + struct_name + "_new(")
742         write_c(consts.c_fn_ty_pfx + consts.ptr_c_ty + " " + consts.c_fn_name_define_pfx(struct_name + "_new", len(field_lines) > 3))
743         ty_list = []
744         for idx, (line, _) in enumerate(field_lines):
745             if idx != 0 and idx < len(field_lines) - 2:
746                 ty_info = java_c_types(line.strip(';'), None)
747                 if idx != 1:
748                     out_java.write(", ")
749                     write_c(", ")
750                 e = chr(ord('a') + idx - 1)
751                 out_java.write(ty_info.java_ty + " " + e)
752                 write_c(ty_info.c_ty + " " + e)
753                 ty_list.append(ty_info)
754         tuple_types[struct_name] = (ty_list, struct_name)
755         out_java.write(");\n")
756         write_c(") {\n")
757         write_c("\t" + struct_name + "* ret = MALLOC(sizeof(" + struct_name + "), \"" + struct_name + "\");\n")
758         for idx, (line, _) in enumerate(field_lines):
759             if idx != 0 and idx < len(field_lines) - 2:
760                 ty_info = type_mapping_generator.map_type(line.strip(';'), False, None, False, False)
761                 e = chr(ord('a') + idx - 1)
762                 if ty_info.arg_conv is not None:
763                     write_c("\t" + ty_info.arg_conv.replace("\n", "\n\t"))
764                     write_c("\n\tret->" + e + " = " + ty_info.arg_conv_name + ";\n")
765                 else:
766                     write_c("\tret->" + e + " = " + e + ";\n")
767                 if ty_info.arg_conv_cleanup is not None:
768                     write_c("\t//TODO: Really need to call " + ty_info.arg_conv_cleanup + " here\n")
769         write_c("\treturn (uint64_t)ret;\n")
770         write_c("}\n")
771
772         for idx, ty_info in enumerate(ty_list):
773             e = chr(ord('a') + idx)
774             out_java.write("\tpublic static native " + ty_info.java_ty + " " + struct_name + "_get_" + e + "(long ptr);\n")
775             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")
776             write_c("\t" + struct_name + " *tuple = (" + struct_name + "*)(ptr & ~1);\n")
777             conv_info = type_mapping_generator.map_type_with_info(ty_info, False, None, False, True)
778             if conv_info.ret_conv is not None:
779                 write_c("\t" + conv_info.ret_conv[0].replace("\n", "\n\t") + "tuple->" + e + conv_info.ret_conv[1].replace("\n", "\n\t") + "\n")
780                 write_c("\treturn " + conv_info.ret_conv_name + ";\n")
781             else:
782                 write_c("\treturn tuple->" + e + ";\n")
783             write_c("}\n")
784
785     out_java.write(consts.bindings_header.replace('<git_version_ldk_garbagecollected>', local_git_version))
786
787     with open(f"{sys.argv[3]}/structs/CommonBase{consts.file_ext}", "w") as out_java_struct:
788         out_java_struct.write(consts.common_base)
789
790     block_comment = None
791     last_block_comment = None
792     cur_block_obj = None
793
794     const_val_regex = re.compile("^extern const ([A-Za-z_0-9]*) ([A-Za-z_0-9]*);$")
795
796     line_indicates_result_regex = re.compile("^   union (LDKCResult_[A-Za-z_0-9]*Ptr) contents;$")
797     line_indicates_vec_regex = re.compile("^   (struct |enum |union )?([A-Za-z_0-9]*) \*data;$")
798     line_indicates_opaque_regex = re.compile("^   bool is_owned;$")
799     line_indicates_trait_regex = re.compile("^   (struct |enum |union )?([A-Za-z_0-9]* \*?)\(\*([A-Za-z_0-9]*)\)\((const )?void \*this_arg(.*)\);$")
800     assert(line_indicates_trait_regex.match("   uintptr_t (*send_data)(void *this_arg, LDKu8slice data, bool resume_read);"))
801     assert(line_indicates_trait_regex.match("   struct LDKCVec_MessageSendEventZ (*get_and_clear_pending_msg_events)(const void *this_arg);"))
802     assert(line_indicates_trait_regex.match("   struct LDKCVec_u8Z (*write)(const void *this_arg);"))
803     line_indicates_trait_clone_regex = re.compile("^   void \(\*cloned\)\(struct ([A-Za-z0-9])* \*NONNULL_PTR new_[A-Za-z0-9]*\);$")
804     assert(line_indicates_trait_clone_regex.match("   void (*cloned)(struct LDKSign *NONNULL_PTR new_Sign);"))
805     line_field_var_regex = re.compile("^   struct ([A-Za-z_0-9]*) ([A-Za-z_0-9]*);$")
806     assert(line_field_var_regex.match("   struct LDKMessageSendEventsProvider MessageSendEventsProvider;"))
807     assert(line_field_var_regex.match("   struct LDKChannelPublicKeys pubkeys;"))
808     struct_name_regex = re.compile("^typedef (struct|enum|union) (MUST_USE_STRUCT )?(LDK[A-Za-z_0-9]*) {$")
809     assert(struct_name_regex.match("typedef struct LDKCVec_u8Z {"))
810     assert(struct_name_regex.match("typedef enum LDKNetwork {"))
811
812     union_enum_items = {}
813     result_ptr_struct_items = {}
814     for line in in_h:
815         if block_comment is not None:
816             if line.endswith("*/\n"):
817                 last_block_comment = block_comment.strip("\n")
818                 block_comment = None
819             else:
820                 block_comment = block_comment + line.strip(" /*")
821         elif cur_block_obj is not None:
822             cur_block_obj  = cur_block_obj + line
823             if line.startswith("} "):
824                 field_lines = []
825                 struct_name = None
826                 vec_ty = None
827                 obj_lines = cur_block_obj.split("\n")
828                 is_opaque = False
829                 result_contents = None
830                 is_unitary_enum = False
831                 is_union_enum = False
832                 is_union = False
833                 is_tuple = False
834                 trait_fn_lines = []
835                 field_var_lines = []
836                 last_struct_block_comment = None
837
838                 for idx, struct_line in enumerate(obj_lines):
839                     if struct_line.strip().startswith("/*"):
840                         block_comment = struct_line.strip(" /*")
841                     if block_comment is not None:
842                         if struct_line.endswith("*/"):
843                             last_struct_block_comment = block_comment.strip("\n")
844                             block_comment = None
845                         else:
846                             block_comment = block_comment + "\n" + struct_line.strip(" /*")
847                     else:
848                         struct_name_match = struct_name_regex.match(struct_line)
849                         if struct_name_match is not None:
850                             struct_name = struct_name_match.group(3)
851                             if struct_name_match.group(1) == "enum":
852                                 if not struct_name.endswith("_Tag"):
853                                     is_unitary_enum = True
854                                 else:
855                                     is_union_enum = True
856                             elif struct_name_match.group(1) == "union":
857                                 is_union = True
858                         if line_indicates_opaque_regex.match(struct_line):
859                             is_opaque = True
860                         result_match = line_indicates_result_regex.match(struct_line)
861                         if result_match is not None:
862                             result_contents = result_match.group(1)
863                         vec_ty_match = line_indicates_vec_regex.match(struct_line)
864                         if vec_ty_match is not None and struct_name.startswith("LDKCVec_"):
865                             vec_ty = vec_ty_match.group(2)
866                         elif struct_name.startswith("LDKC2Tuple_") or struct_name.startswith("LDKC3Tuple_"):
867                             is_tuple = True
868                         trait_fn_match = line_indicates_trait_regex.match(struct_line)
869                         if trait_fn_match is not None:
870                             trait_fn_lines.append((last_struct_block_comment, trait_fn_match))
871                         trait_clone_fn_match = line_indicates_trait_clone_regex.match(struct_line)
872                         if trait_clone_fn_match is not None:
873                             trait_fn_lines.append((last_struct_block_comment, "cloned"))
874                         field_var_match = line_field_var_regex.match(struct_line)
875                         if field_var_match is not None:
876                             field_var_lines.append(field_var_match)
877                         field_lines.append((struct_line, last_struct_block_comment))
878                         last_struct_block_comment = None
879
880                 assert(struct_name is not None)
881                 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))
882                 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))
883                 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))
884                 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))
885                 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))
886                 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))
887                 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))
888
889                 if is_opaque:
890                     opaque_structs.add(struct_name)
891                     with open(f"{sys.argv[3]}/structs/{struct_name.replace('LDK', '')}{consts.file_ext}", "w") as out_java_struct:
892                         out_opaque_struct_human = consts.map_opaque_struct(struct_name, last_block_comment)
893                         last_block_comment = None
894                         out_java_struct.write(out_opaque_struct_human)
895                 elif result_contents is not None:
896                     assert result_contents in result_ptr_struct_items
897                     res_ty, err_ty = result_ptr_struct_items[result_contents]
898                     map_result(struct_name, res_ty, err_ty)
899                 elif struct_name.startswith("LDKCResult_") and struct_name.endswith("ZPtr"):
900                     for line, _ in field_lines:
901                         if line.endswith("*result;"):
902                             res_ty = line[:-8].strip()
903                         elif line.endswith("*err;"):
904                             err_ty = line[:-5].strip()
905                     result_ptr_struct_items[struct_name] = (res_ty, err_ty)
906                     result_types.add(struct_name[:-3])
907                 elif is_tuple:
908                     map_tuple(struct_name, field_lines)
909                 elif vec_ty is not None:
910                     ty_info = type_mapping_generator.map_type(vec_ty + " arr_elem", False, None, False, False)
911                     if len(ty_info.java_fn_ty_arg) == 1: # ie we're a primitive of some form
912                         out_java.write("\tpublic static native long " + struct_name + "_new(" + ty_info.java_ty + "[] elems);\n")
913                         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")
914                         write_c("\t" + struct_name + " *ret = MALLOC(sizeof(" + struct_name + "), \"" + struct_name + "\");\n")
915                         write_c("\tret->datalen = " + consts.get_native_arr_len_call[0] + "elems" + consts.get_native_arr_len_call[1] + ";\n")
916                         write_c("\tif (ret->datalen == 0) {\n")
917                         write_c("\t\tret->data = NULL;\n")
918                         write_c("\t} else {\n")
919                         write_c("\t\tret->data = MALLOC(sizeof(" + vec_ty + ") * ret->datalen, \"" + struct_name + " Data\");\n")
920                         native_arr_ptr_call = consts.get_native_arr_ptr_call(ty_info.ty_info)
921                         write_c("\t\t" + ty_info.c_ty + " *java_elems = " + native_arr_ptr_call[0] + "elems" + native_arr_ptr_call[1] + ";\n")
922                         write_c("\t\tfor (size_t i = 0; i < ret->datalen; i++) {\n")
923                         if ty_info.arg_conv is not None:
924                             write_c("\t\t\t" + ty_info.c_ty + " arr_elem = java_elems[i];\n")
925                             write_c("\t\t\t" + ty_info.arg_conv.replace("\n", "\n\t\t\t") + "\n")
926                             write_c("\t\t\tret->data[i] = " + ty_info.arg_conv_name + ";\n")
927                             assert ty_info.arg_conv_cleanup is None
928                         else:
929                             write_c("\t\t\tret->data[i] = java_elems[i];\n")
930                         write_c("\t\t}\n")
931                         cleanup = consts.release_native_arr_ptr_call(ty_info.ty_info, "elems", "java_elems")
932                         if cleanup is not None:
933                             write_c("\t\t" + cleanup + ";\n")
934                         write_c("\t}\n")
935                         write_c("\treturn (uint64_t)ret;\n")
936                         write_c("}\n")
937
938                     if ty_info.is_native_primitive:
939                         clone_fns.add(struct_name.replace("LDK", "") + "_clone")
940                         write_c("static inline " + struct_name + " " + struct_name.replace("LDK", "") + "_clone(const " + struct_name + " *orig) {\n")
941                         write_c("\t" + struct_name + " ret = { .data = MALLOC(sizeof(" + ty_info.c_ty + ") * orig->datalen, \"" + struct_name + " clone bytes\"), .datalen = orig->datalen };\n")
942                         write_c("\tmemcpy(ret.data, orig->data, sizeof(" + ty_info.c_ty + ") * ret.datalen);\n")
943                         write_c("\treturn ret;\n}\n")
944                     elif (ty_info.rust_obj.replace("LDK", "") + "_clone") in clone_fns:
945                         ty_name = "CVec_" + ty_info.rust_obj.replace("LDK", "") + "Z";
946                         clone_fns.add(ty_name + "_clone")
947                         write_c("static inline " + struct_name + " " + ty_name + "_clone(const " + struct_name + " *orig) {\n")
948                         write_c("\t" + struct_name + " ret = { .data = MALLOC(sizeof(" + ty_info.rust_obj + ") * orig->datalen, \"" + struct_name + " clone bytes\"), .datalen = orig->datalen };\n")
949                         write_c("\tfor (size_t i = 0; i < ret.datalen; i++) {\n")
950                         write_c("\t\tret.data[i] = " + ty_info.rust_obj.replace("LDK", "") + "_clone(&orig->data[i]);\n")
951                         write_c("\t}\n\treturn ret;\n}\n")
952                 elif is_union_enum:
953                     assert(struct_name.endswith("_Tag"))
954                     struct_name = struct_name[:-4]
955                     union_enum_items[struct_name] = {"field_lines": field_lines}
956                 elif struct_name.endswith("_Body") and struct_name.split("_")[0] in union_enum_items:
957                     enum_var_name = struct_name.split("_")
958                     union_enum_items[enum_var_name[0]][enum_var_name[1]] = field_lines
959                 elif struct_name in union_enum_items:
960                     tuple_variants = {}
961                     elem_items = -1
962                     for line, _ in field_lines:
963                         if line == "      struct {":
964                             elem_items = 0
965                         elif line == "      };":
966                             elem_items = -1
967                         elif elem_items > -1:
968                             line = line.strip()
969                             if line.startswith("struct "):
970                                 line = line[7:]
971                             elif line.startswith("enum "):
972                                 line = line[5:]
973                             split = line.split(" ")
974                             assert len(split) == 2
975                             tuple_variants[split[1].strip(";")] = split[0]
976                             elem_items += 1
977                             if elem_items > 1:
978                                 # We don't currently support tuple variant with more than one element
979                                 assert False
980                     map_complex_enum(struct_name, union_enum_items[struct_name], tuple_variants, last_block_comment)
981                     last_block_comment = None
982                 elif is_unitary_enum:
983                     map_unitary_enum(struct_name, field_lines, last_block_comment)
984                     last_block_comment = None
985                 elif len(trait_fn_lines) > 0:
986                     map_trait(struct_name, field_var_lines, trait_fn_lines, last_block_comment)
987                 elif struct_name == "LDKTxOut":
988                     with open(f"{sys.argv[3]}/structs/TxOut{consts.file_ext}", "w") as out_java_struct:
989                         out_java_struct.write(consts.hu_struct_file_prefix)
990                         out_java_struct.write("public class TxOut extends CommonBase{\n")
991                         out_java_struct.write("\tTxOut(java.lang.Object _dummy, long ptr) { super(ptr); }\n")
992                         out_java_struct.write("\tlong to_c_ptr() { return 0; }\n")
993                         out_java_struct.write("\t@Override @SuppressWarnings(\"deprecation\")\n")
994                         out_java_struct.write("\tprotected void finalize() throws Throwable {\n")
995                         out_java_struct.write("\t\tsuper.finalize();\n")
996                         out_java_struct.write("\t\tif (ptr != 0) { bindings.TxOut_free(ptr); }\n")
997                         out_java_struct.write("\t}\n")
998                         # TODO: TxOut body
999                         out_java_struct.write("}")
1000                 else:
1001                     pass # Everything remaining is a byte[] or some form
1002                 cur_block_obj = None
1003         else:
1004             fn_ptr = fn_ptr_regex.match(line)
1005             fn_ret_arr = fn_ret_arr_regex.match(line)
1006             reg_fn = reg_fn_regex.match(line)
1007             const_val = const_val_regex.match(line)
1008
1009             if line.startswith("#include <"):
1010                 pass
1011             elif line.startswith("/*"):
1012                 if not line.endswith("*/\n"):
1013                     block_comment = line.strip(" /*")
1014             elif line.startswith("typedef enum "):
1015                 cur_block_obj = line
1016             elif line.startswith("typedef struct "):
1017                 cur_block_obj = line
1018             elif line.startswith("typedef union "):
1019                 cur_block_obj = line
1020             elif fn_ptr is not None:
1021                 map_fn(line, fn_ptr, None, None, last_block_comment)
1022                 last_block_comment = None
1023             elif fn_ret_arr is not None:
1024                 map_fn(line, fn_ret_arr, fn_ret_arr.group(4), None, last_block_comment)
1025                 last_block_comment = None
1026             elif reg_fn is not None:
1027                 map_fn(line, reg_fn, None, None, last_block_comment)
1028                 last_block_comment = None
1029             elif const_val_regex is not None:
1030                 # TODO Map const variables
1031                 pass
1032             else:
1033                 assert(line == "\n")
1034
1035     out_java.write(consts.bindings_footer)
1036     for struct_name in opaque_structs:
1037         with open(f"{sys.argv[3]}/structs/{struct_name.replace('LDK', '')}{consts.file_ext}", "a") as out_java_struct:
1038             out_java_struct.write("}\n")
1039     for struct_name in trait_structs:
1040         with open(f"{sys.argv[3]}/structs/{struct_name.replace('LDK', '')}{consts.file_ext}", "a") as out_java_struct:
1041             out_java_struct.write("}\n")
1042     for struct_name in complex_enums:
1043         with open(f"{sys.argv[3]}/structs/{struct_name.replace('LDK', '').replace('COption', 'Option')}{consts.file_ext}", "a") as out_java_struct:
1044             out_java_struct.write("}\n")
1045     for struct_name in result_types:
1046         with open(f"{sys.argv[3]}/structs/{struct_name.replace('LDKCResult', 'Result')}{consts.file_ext}", "a") as out_java_struct:
1047             out_java_struct.write("}\n")
1048
1049 with open(sys.argv[4], "w") as out_c:
1050     out_c.write(consts.c_file_pfx.replace('<git_version_ldk_garbagecollected>', local_git_version))
1051     out_c.write(consts.init_str())
1052     out_c.write(c_file)
1053 with open(f"{sys.argv[3]}/structs/UtilMethods{consts.file_ext}", "a") as util:
1054     util.write(consts.util_fn_sfx)