#!/usr/bin/env python3
-import sys, re
+import os, sys, re, subprocess
if len(sys.argv) < 7:
print("USAGE: /path/to/lightning.h /path/to/bindings/output /path/to/bindings/ /path/to/bindings/output.c debug lang")
consts = Consts(DEBUG, target=target)
+local_git_version = os.getenv("LDK_GARBAGECOLLECTED_GIT_OVERRIDE")
+if local_git_version is None:
+ local_git_version = subprocess.check_output(["git", "describe", '--tag', '--dirty']).decode("utf-8").strip()
+
from bindingstypes import *
c_file = ""
lastund = True
return (ret + lastchar.lower()).strip("_")
+def doc_to_field_nullable(doc):
+ if doc is None:
+ return False
+ for line in doc.splitlines():
+ if "Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None" in line:
+ return True
+ return False
+
+def doc_to_params_ret_nullable(doc):
+ if doc is None:
+ return (set(), False)
+ params = set()
+ ret_null = False
+ for line in doc.splitlines():
+ if "may be NULL or all-0s to represent None" not in line:
+ continue
+ if "Note that the return value" in line:
+ ret_null = True
+ elif "Note that " in line:
+ param = line.split("Note that ")[1].split(" ")[0]
+ params.add(param)
+ return (params, ret_null)
+
unitary_enums = set()
complex_enums = set()
opaque_structs = set()
-trait_structs = set()
+trait_structs = {}
result_types = set()
tuple_types = {}
fn_arg = fn_arg[7:]
if fn_arg.startswith("enum "):
fn_arg = fn_arg[5:]
+ nonnull_ptr = "NONNULL_PTR" in fn_arg
fn_arg = fn_arg.replace("NONNULL_PTR", "")
is_ptr = False
assert var_is_arr_regex.match(fn_arg[8:])
rust_obj = "LDKThirtyTwoBytes"
arr_access = "data"
+ elif fn_arg.startswith("LDKTxid"):
+ fn_arg = "uint8_t (*" + fn_arg[8:] + ")[32]"
+ assert var_is_arr_regex.match(fn_arg[8:])
+ rust_obj = "LDKThirtyTwoBytes"
+ arr_access = "data"
elif fn_arg.startswith("LDKPublicKey"):
fn_arg = "uint8_t (*" + fn_arg[13:] + ")[33]"
assert var_is_arr_regex.match(fn_arg[8:])
assert var_is_arr_regex.match(fn_arg[8:])
rust_obj = "LDKSignature"
arr_access = "compact_form"
+ elif fn_arg.startswith("LDKRecoverableSignature"):
+ fn_arg = "uint8_t (*" + fn_arg[25:] + ")[68]"
+ assert var_is_arr_regex.match(fn_arg[8:])
+ rust_obj = "LDKRecoverableSignature"
+ arr_access = "serialized_form"
elif fn_arg.startswith("LDKThreeBytes"):
fn_arg = "uint8_t (*" + fn_arg[14:] + ")[3]"
assert var_is_arr_regex.match(fn_arg[8:])
assert var_is_arr_regex.match(fn_arg[8:])
rust_obj = "LDKSixteenBytes"
arr_access = "data"
+ elif fn_arg.startswith("LDKTwentyBytes"):
+ fn_arg = "uint8_t (*" + fn_arg[15:] + ")[20]"
+ assert var_is_arr_regex.match(fn_arg[8:])
+ rust_obj = "LDKTwentyBytes"
+ arr_access = "data"
elif fn_arg.startswith("LDKTenBytes"):
fn_arg = "uint8_t (*" + fn_arg[12:] + ")[10]"
assert var_is_arr_regex.match(fn_arg[8:])
rust_obj = "LDKCVec_u8Z"
assert var_is_arr_regex.match(fn_arg[8:])
arr_access = "data"
- elif fn_arg.startswith("LDKTransaction"):
+ elif fn_arg.startswith("LDKTransaction ") or fn_arg == "LDKTransaction":
fn_arg = "uint8_t (*" + fn_arg[15:] + ")[datalen]"
rust_obj = "LDKTransaction"
assert var_is_arr_regex.match(fn_arg[8:])
res.pass_by_ref = True
if res.is_native_primitive or res.passed_as_ptr:
return TypeInfo(rust_obj=fn_arg.split(" ")[0], java_ty=res.java_ty + "[]", java_hu_ty=res.java_hu_ty + "[]",
- java_fn_ty_arg="[" + res.java_fn_ty_arg, c_ty=res.c_ty + "Array", passed_as_ptr=False, is_ptr=is_ptr, is_const=is_const,
+ java_fn_ty_arg="[" + res.java_fn_ty_arg, c_ty=res.c_ty + "Array", passed_as_ptr=False, is_ptr=is_ptr,
+ nonnull_ptr=nonnull_ptr, is_const=is_const,
var_name=res.var_name, arr_len="datalen", arr_access="data", subty=res, is_native_primitive=False)
else:
return TypeInfo(rust_obj=fn_arg.split(" ")[0], java_ty=res.java_ty + "[]", java_hu_ty=res.java_hu_ty + "[]",
- java_fn_ty_arg="[" + res.java_fn_ty_arg, c_ty=consts.ptr_arr, passed_as_ptr=False, is_ptr=is_ptr, is_const=is_const,
+ java_fn_ty_arg="[" + res.java_fn_ty_arg, c_ty=consts.ptr_arr, passed_as_ptr=False, is_ptr=is_ptr,
+ nonnull_ptr=nonnull_ptr, is_const=is_const,
var_name=res.var_name, arr_len="datalen", arr_access="data", subty=res, is_native_primitive=False)
is_primitive = False
fn_ty_arg = "B"
fn_arg = fn_arg[7:].strip()
is_primitive = True
+ elif fn_arg.startswith("LDKu5"):
+ java_ty = consts.c_type_map['uint8_t'][0]
+ java_hu_ty = "UInt5"
+ rust_obj = "LDKu5"
+ c_ty = "int8_t"
+ fn_ty_arg = "B"
+ fn_arg = fn_arg[6:].strip()
elif fn_arg.startswith("uint16_t"):
mapped_type = consts.c_type_map['uint16_t']
java_ty = mapped_type[0]
fn_ty_arg = "Ljava/lang/String;"
fn_arg = fn_arg[6:].strip()
elif fn_arg.startswith("LDKStr"):
+ rust_obj = "LDKStr"
java_ty = "String"
c_ty = "jstring"
fn_ty_arg = "Ljava/lang/String;"
else:
ma = var_ty_regex.match(fn_arg)
if ma.group(1).strip() in unitary_enums:
- java_ty = ma.group(1).strip()
+ assert ma.group(1).strip().startswith("LDK")
+ java_ty = ma.group(1).strip()[3:]
+ java_hu_ty = java_ty
c_ty = consts.result_c_ty
- fn_ty_arg = "Lorg/ldk/enums/" + ma.group(1).strip() + ";"
+ fn_ty_arg = "Lorg/ldk/enums/" + java_ty + ";"
fn_arg = ma.group(2).strip()
rust_obj = ma.group(1).strip()
elif ma.group(1).strip().startswith("LDKC2Tuple"):
else:
c_ty = consts.ptr_c_ty
java_ty = consts.ptr_native_ty
- java_hu_ty = ma.group(1).strip().replace("LDKCResult", "Result").replace("LDK", "")
+ java_hu_ty = ma.group(1).strip().replace("LDKCOption", "Option").replace("LDKCResult", "Result").replace("LDK", "")
fn_ty_arg = "J"
fn_arg = ma.group(2).strip()
rust_obj = ma.group(1).strip()
if var_is_arr is not None:
if var_is_arr.group(1) == "":
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,
- passed_as_ptr=False, is_ptr=False, var_name="arg", arr_len=var_is_arr.group(2), arr_access=arr_access, is_native_primitive=False)
+ passed_as_ptr=False, is_ptr=False, nonnull_ptr=nonnull_ptr, var_name="arg",
+ arr_len=var_is_arr.group(2), arr_access=arr_access, is_native_primitive=False)
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,
- passed_as_ptr=False, is_ptr=False, var_name=var_is_arr.group(1), arr_len=var_is_arr.group(2), arr_access=arr_access, is_native_primitive=False)
+ passed_as_ptr=False, is_ptr=False, nonnull_ptr=nonnull_ptr, var_name=var_is_arr.group(1),
+ arr_len=var_is_arr.group(2), arr_access=arr_access, is_native_primitive=False)
if java_hu_ty is None:
java_hu_ty = java_ty
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,
- is_const=is_const, is_ptr=is_ptr, var_name=fn_arg, arr_len=arr_len, arr_access=arr_access, is_native_primitive=is_primitive)
+ 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)
fn_ptr_regex = re.compile("^extern const ([A-Za-z_0-9\* ]*) \(\*(.*)\)\((.*)\);$")
fn_ret_arr_regex = re.compile("(.*) \(\*(.*)\((.*)\)\)\[([0-9]*)\];$")
with open(sys.argv[1]) as in_h, open(sys.argv[2], "w") as out_java:
# Map a top-level function
- def map_fn(line, re_match, ret_arr_len, c_call_string):
+ def map_fn(line, re_match, ret_arr_len, c_call_string, doc_comment):
method_return_type = re_match.group(1)
method_name = re_match.group(2)
+ orig_method_name = str(method_name)
method_comma_separated_arguments = re_match.group(3)
method_arguments = method_comma_separated_arguments.split(',')
is_free = method_name.endswith("_free")
- struct_meth = method_name.split("_")[0]
+ if method_name.startswith("COption") or method_name.startswith("CResult"):
+ struct_meth = method_name.rsplit("Z", 1)[0][1:] + "Z"
+ else:
+ struct_meth = method_name.split("_")[0]
- return_type_info = type_mapping_generator.map_type(method_return_type, True, ret_arr_len, False, False)
+ return_type_info = type_mapping_generator.map_type(method_return_type.strip() + " ret", True, ret_arr_len, False, False)
+
+ (params_nullable, ret_nullable) = doc_to_params_ret_nullable(doc_comment)
+ if ret_nullable:
+ return_type_info.nullable = True
argument_types = []
default_constructor_args = {}
takes_self = False
+ takes_self_ptr = False
args_known = True
for argument_index, argument in enumerate(method_arguments):
argument_conversion_info = type_mapping_generator.map_type(argument, False, None, is_free, True)
if argument_index == 0 and argument_conversion_info.java_hu_ty == struct_meth:
takes_self = True
+ if argument_conversion_info.ty_info.is_ptr:
+ takes_self_ptr = True
+ elif argument_conversion_info.arg_name in params_nullable:
+ argument_conversion_info.nullable = True
+ if argument_conversion_info.arg_conv is not None and "Warning" in argument_conversion_info.arg_conv:
+ arg_ty_info = java_c_types(argument, None)
+ print("WARNING: Remapping argument " + arg_ty_info.var_name + " of function " + method_name + " to a reference")
+ print(" The argument appears to require a move, or not clonable, and is nullable.")
+ print(" Normally for arguments that require a move and are not clonable, we split")
+ print(" the argument into the type's constructor's arguments and just use those to")
+ print(" construct a new object on the fly.")
+ print(" However, because the object is nullable, doing so would mean we can no")
+ print(" longer allow the user to pass null, as we now have an argument list instead.")
+ print(" Thus, we blindly assume its really an Option<&Type> instead of an Option<Type>.")
+ print(" It may or may not actually be a reference, but its the simplest mapping option")
+ print(" and also the only use of this code today.")
+ arg_ty_info.requires_clone = False
+ argument_conversion_info = type_mapping_generator.map_type_with_info(arg_ty_info, False, None, is_free, True)
+ assert argument_conversion_info.arg_conv is not None and "Warning" not in argument_conversion_info.arg_conv
+
if argument_conversion_info.arg_conv is not None and "Warning" in argument_conversion_info.arg_conv:
if argument_conversion_info.rust_obj in constructor_fns:
assert not is_free
default_constructor_args[argument_conversion_info.arg_name] = []
default_constructor_args[argument_conversion_info.arg_name].append(explode_arg_conv)
argument_types.append(argument_conversion_info)
+ if not takes_self and return_type_info.java_hu_ty != struct_meth:
+ if not return_type_info.java_hu_ty.startswith("Result_" + struct_meth):
+ method_name = orig_method_name
+ struct_meth = ""
out_java.write("\t// " + line)
- (out_java_delta, out_c_delta, out_java_struct_delta) = consts.map_function(argument_types, c_call_string, method_name, return_type_info, struct_meth, default_constructor_args, takes_self, args_known, type_mapping_generator)
+ (out_java_delta, out_c_delta, out_java_struct_delta) = \
+ consts.map_function(argument_types, c_call_string, method_name, return_type_info, struct_meth, default_constructor_args, takes_self, takes_self_ptr, args_known, type_mapping_generator, doc_comment)
out_java.write(out_java_delta)
if is_free:
write_c(out_c_delta)
out_java_struct = None
- if ("LDK" + struct_meth in opaque_structs or "LDK" + struct_meth in trait_structs) and not is_free:
+ expected_struct = "LDK" + struct_meth
+ expected_cstruct = "LDKC" + struct_meth
+ if (expected_struct in opaque_structs or expected_struct in trait_structs
+ or expected_struct in complex_enums or expected_cstruct in complex_enums
+ or expected_cstruct in result_types) and not is_free:
out_java_struct = open(f"{sys.argv[3]}/structs/{struct_meth}{consts.file_ext}", "a")
- elif method_name.startswith("C2Tuple_") and method_name.endswith("_read"):
- struct_meth = method_name.rsplit("_", 1)[0]
- out_java_struct = open(f"{sys.argv[3]}/structs/UtilMethods{consts.file_ext}", "a")
- if out_java_struct is not None:
out_java_struct.write(out_java_struct_delta)
+ elif (not is_free and not method_name.endswith("_clone") and
+ not method_name.startswith("TxOut") and
+ not method_name.startswith("_") and
+ method_name != "check_platform" and method_name != "Result_read" and
+ not expected_struct in unitary_enums and
+ ((not method_name.startswith("C2Tuple_") and not method_name.startswith("C3Tuple_"))
+ or method_name.endswith("_read"))):
+ out_java_struct = open(f"{sys.argv[3]}/structs/UtilMethods{consts.file_ext}", "a")
+ for line in out_java_struct_delta.splitlines():
+ if not line.strip().startswith("this."):
+ out_java_struct.write(line + "\n")
+ else:
+ out_java_struct.write("\t\t// " + line.strip() + "\n")
- def map_unitary_enum(struct_name, field_lines):
- with open(f"{sys.argv[3]}/enums/{struct_name}{consts.file_ext}", "w") as out_java_enum:
+ def map_unitary_enum(struct_name, field_lines, enum_doc_comment):
+ assert struct_name.startswith("LDK")
+ with open(f"{sys.argv[3]}/enums/{struct_name[3:]}{consts.file_ext}", "w") as out_java_enum:
unitary_enums.add(struct_name)
- for idx, struct_line in enumerate(field_lines):
+ for idx, (struct_line, _) in enumerate(field_lines):
if idx == 0:
assert(struct_line == "typedef enum %s {" % struct_name)
elif idx == len(field_lines) - 3:
assert(struct_line == "} %s;" % struct_name)
elif idx == len(field_lines) - 1:
assert(struct_line == "")
- (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]])
+ assert struct_name.startswith("LDK")
+ (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)
write_c(c_out)
out_java_enum.write(native_file_out)
out_java.write(native_out)
- def map_complex_enum(struct_name, union_enum_items):
- java_hu_type = struct_name.replace("LDK", "")
+ def map_complex_enum(struct_name, union_enum_items, inline_enum_variants, enum_doc_comment):
+ java_hu_type = struct_name.replace("LDK", "").replace("COption", "Option")
complex_enums.add(struct_name)
enum_variants = []
tag_field_lines = union_enum_items["field_lines"]
- for idx, struct_line in enumerate(tag_field_lines):
+ for idx, (struct_line, _) in enumerate(tag_field_lines):
if idx == 0:
assert(struct_line == "typedef enum %s_Tag {" % struct_name)
elif idx == len(tag_field_lines) - 3:
fields = []
if "LDK" + variant_name in union_enum_items:
enum_var_lines = union_enum_items["LDK" + variant_name]
- for idx, field in enumerate(enum_var_lines):
- if idx != 0 and idx < len(enum_var_lines) - 2:
- fields.append(type_mapping_generator.map_type(field.strip(' ;'), False, None, False, True))
- else:
- # TODO: Assert line format
- pass
+ for idx, (field, field_docs) in enumerate(enum_var_lines):
+ if idx != 0 and idx < len(enum_var_lines) - 2 and field.strip() != "":
+ field_ty = type_mapping_generator.map_type(field.strip(' ;'), False, None, False, True)
+ if field_docs is not None and doc_to_field_nullable(field_docs):
+ field_ty.nullable = True
+ fields.append((field_ty, field_docs))
+ enum_variants.append(ComplexEnumVariantInfo(variant_name, fields, False))
+ elif camel_to_snake(variant_name) in inline_enum_variants:
+ # TODO: If we ever have a rust enum Variant(Option<Struct>) we need to pipe
+ # docs through to there, and then potentially mark the field nullable.
+ 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))
+ enum_variants.append(ComplexEnumVariantInfo(variant_name, fields, True))
else:
- # TODO: Assert line format
- pass
- enum_variants.append(ComplexEnumVariantInfo(variant_name, fields))
+ enum_variants.append(ComplexEnumVariantInfo(variant_name, fields, True))
with open(f"{sys.argv[3]}/structs/{java_hu_type}{consts.file_ext}", "w") as out_java_enum:
- (out_java_addendum, out_java_enum_addendum, out_c_addendum) = consts.map_complex_enum(struct_name, enum_variants, camel_to_snake)
+ (out_java_addendum, out_java_enum_addendum, out_c_addendum) = consts.map_complex_enum(struct_name, enum_variants, camel_to_snake, enum_doc_comment)
out_java_enum.write(out_java_enum_addendum)
out_java.write(out_java_addendum)
write_c(out_c_addendum)
- def map_trait(struct_name, field_var_lines, trait_fn_lines):
+ def map_trait(struct_name, field_var_lines, trait_fn_lines, trait_doc_comment):
with open(f"{sys.argv[3]}/structs/{struct_name.replace('LDK', '')}{consts.file_ext}", "w") as out_java_trait:
field_var_convs = []
+ flattened_field_var_convs = []
for var_line in field_var_lines:
if var_line.group(1) in trait_structs:
- field_var_convs.append((var_line.group(1), var_line.group(2)))
+ field_var_convs.append((var_line.group(1), var_line.group(2), trait_structs[var_line.group(1)]))
+ flattened_field_var_convs.append((var_line.group(1), var_line.group(2), ))
+ flattened_field_var_convs.extend(trait_structs[var_line.group(1)])
else:
- field_var_convs.append(
- type_mapping_generator.map_type(var_line.group(1) + " " + var_line.group(2), False, None, False, False))
+ mapped = type_mapping_generator.map_type(var_line.group(1) + " " + var_line.group(2), False, None, False, False)
+ field_var_convs.append(mapped)
+ flattened_field_var_convs.append(mapped)
+ trait_structs[struct_name] = field_var_convs
field_fns = []
- for fn_line in trait_fn_lines:
- ret_ty_info = type_mapping_generator.map_type(fn_line.group(2), True, None, False, False)
- is_const = fn_line.group(4) is not None
-
- arg_tys = []
- for idx, arg in enumerate(fn_line.group(5).split(',')):
- if arg == "":
- continue
- arg_conv_info = type_mapping_generator.map_type(arg, True, None, False, False)
- arg_tys.append(arg_conv_info)
- field_fns.append(TraitMethInfo(fn_line.group(3), is_const, ret_ty_info, arg_tys))
-
- (out_java_addendum, out_java_trait_addendum, out_c_addendum) = consts.native_c_map_trait(struct_name, field_var_convs, field_fns)
+ for fn_docs, fn_line in trait_fn_lines:
+ if fn_line == "cloned":
+ ret_ty_info = type_mapping_generator.map_type("void", True, None, False, False)
+ field_fns.append(TraitMethInfo("cloned", False, ret_ty_info, [], fn_docs))
+ else:
+ ret_ty_info = type_mapping_generator.map_type(fn_line.group(2).strip() + " ret", True, None, False, False)
+ is_const = fn_line.group(4) is not None
+ (nullable_params, ret_nullable) = doc_to_params_ret_nullable(fn_docs)
+ if ret_nullable:
+ assert False # This isn't yet handled on the Java side
+ ret_ty_info.nullable = True
+
+ arg_tys = []
+ for idx, arg in enumerate(fn_line.group(5).split(',')):
+ if arg == "":
+ continue
+ arg_conv_info = type_mapping_generator.map_type(arg, True, None, False, False)
+ if arg_conv_info.arg_name in nullable_params:
+ # Types that are actually null instead of all-0s aren't yet handled on the Java side:
+ assert arg_conv_info.rust_obj == "LDKPublicKey"
+ arg_conv_info.nullable = True
+ arg_tys.append(arg_conv_info)
+ field_fns.append(TraitMethInfo(fn_line.group(3), is_const, ret_ty_info, arg_tys, fn_docs))
+
+ (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)
write_c(out_c_addendum)
out_java_trait.write(out_java_trait_addendum)
out_java.write(out_java_addendum)
- for fn_line in trait_fn_lines:
+ for fn_docs, fn_line in trait_fn_lines:
+ if fn_line == "cloned":
+ continue
# For now, just disable enabling the _call_log - we don't know how to inverse-map String
is_log = fn_line.group(3) == "log" and struct_name == "LDKLogger"
- if fn_line.group(3) != "free" and fn_line.group(3) != "clone" and fn_line.group(3) != "eq" and not is_log:
- dummy_line = fn_line.group(2) + struct_name.replace("LDK", "") + "_" + fn_line.group(3) + " " + struct_name + "* this_arg" + fn_line.group(5) + "\n"
- 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")
+ if fn_line.group(3) != "free" and fn_line.group(3) != "eq" and not is_log:
+ 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"
+ 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)
for idx, var_line in enumerate(field_var_lines):
if var_line.group(1) not in trait_structs:
write_c(var_line.group(1) + " " + struct_name + "_set_get_" + var_line.group(2) + "(" + struct_name + "* this_arg) {\n")
write_c("\t\tthis_arg->set_" + var_line.group(2) + "(this_arg);\n")
write_c("\treturn this_arg->" + var_line.group(2) + ";\n")
write_c("}\n")
- dummy_line = var_line.group(1) + " " + struct_name.replace("LDK", "") + "_get_" + var_line.group(2) + " " + struct_name + "* this_arg" + fn_line.group(5) + "\n"
- 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")
+ 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"
+ 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)
def map_result(struct_name, res_ty, err_ty):
result_types.add(struct_name)
else:
out_java_struct.write("\t\t\tthis.res = bindings." + struct_name + "_get_ok(ptr);\n")
out_java_struct.write("\t\t}\n")
- if struct_name.startswith("LDKCResult_None"):
- out_java_struct.write("\t\tpublic " + human_ty + "_OK() {\n\t\t\tthis(null, bindings.C" + human_ty + "_ok());\n")
- else:
- out_java_struct.write("\t\tpublic " + human_ty + "_OK(" + res_map.java_hu_ty + " res) {\n")
- if res_map.from_hu_conv is not None:
- out_java_struct.write("\t\t\tthis(null, bindings.C" + human_ty + "_ok(" + res_map.from_hu_conv[0] + "));\n")
- if res_map.from_hu_conv[1] != "":
- out_java_struct.write("\t\t\t" + res_map.from_hu_conv[1].replace("\n", "\n\t\t\t") + ";\n")
- else:
- out_java_struct.write("\t\t\tthis(null, bindings.C" + human_ty + "_ok(res));\n")
- out_java_struct.write("\t\t}\n\t}\n\n")
+ out_java_struct.write("\t}\n\n")
out_java.write("\tpublic static native " + err_map.java_ty + " " + struct_name + "_get_err(long arg);\n")
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")
out_java_struct.write("\t\t\tthis.err = bindings." + struct_name + "_get_err(ptr);\n")
out_java_struct.write("\t\t}\n")
- if struct_name.endswith("NoneZ"):
- out_java_struct.write("\t\tpublic " + human_ty + "_Err() {\n\t\t\tthis(null, bindings.C" + human_ty + "_err());\n")
- else:
- out_java_struct.write("\t\tpublic " + human_ty + "_Err(" + err_map.java_hu_ty + " err) {\n")
- if err_map.from_hu_conv is not None:
- out_java_struct.write("\t\t\tthis(null, bindings.C" + human_ty + "_err(" + err_map.from_hu_conv[0] + "));\n")
- if err_map.from_hu_conv[1] != "":
- out_java_struct.write("\t\t\t" + err_map.from_hu_conv[1].replace("\n", "\n\t\t\t") + ";\n")
- else:
- out_java_struct.write("\t\t\tthis(null, bindings.C" + human_ty + "_err(err));\n")
- out_java_struct.write("\t\t}\n\t}\n}\n")
+ out_java_struct.write("\t}\n\n")
def map_tuple(struct_name, field_lines):
out_java.write("\tpublic static native long " + struct_name + "_new(")
write_c(consts.c_fn_ty_pfx + consts.ptr_c_ty + " " + consts.c_fn_name_define_pfx(struct_name + "_new", len(field_lines) > 3))
ty_list = []
- for idx, line in enumerate(field_lines):
+ for idx, (line, _) in enumerate(field_lines):
if idx != 0 and idx < len(field_lines) - 2:
ty_info = java_c_types(line.strip(';'), None)
if idx != 1:
out_java.write(");\n")
write_c(") {\n")
write_c("\t" + struct_name + "* ret = MALLOC(sizeof(" + struct_name + "), \"" + struct_name + "\");\n")
- for idx, line in enumerate(field_lines):
+ for idx, (line, _) in enumerate(field_lines):
if idx != 0 and idx < len(field_lines) - 2:
ty_info = type_mapping_generator.map_type(line.strip(';'), False, None, False, False)
e = chr(ord('a') + idx - 1)
write_c("\tret->" + e + " = " + e + ";\n")
if ty_info.arg_conv_cleanup is not None:
write_c("\t//TODO: Really need to call " + ty_info.arg_conv_cleanup + " here\n")
- write_c("\treturn (long)ret;\n")
+ write_c("\treturn (uint64_t)ret;\n")
write_c("}\n")
for idx, ty_info in enumerate(ty_list):
write_c("\treturn tuple->" + e + ";\n")
write_c("}\n")
- out_java.write(consts.bindings_header)
+ out_java.write(consts.bindings_header.replace('<git_version_ldk_garbagecollected>', local_git_version))
with open(f"{sys.argv[3]}/structs/CommonBase{consts.file_ext}", "w") as out_java_struct:
out_java_struct.write(consts.common_base)
- in_block_comment = False
+ block_comment = None
+ last_block_comment = None
cur_block_obj = None
const_val_regex = re.compile("^extern const ([A-Za-z_0-9]*) ([A-Za-z_0-9]*);$")
line_indicates_trait_regex = re.compile("^ (struct |enum |union )?([A-Za-z_0-9]* \*?)\(\*([A-Za-z_0-9]*)\)\((const )?void \*this_arg(.*)\);$")
assert(line_indicates_trait_regex.match(" uintptr_t (*send_data)(void *this_arg, LDKu8slice data, bool resume_read);"))
assert(line_indicates_trait_regex.match(" struct LDKCVec_MessageSendEventZ (*get_and_clear_pending_msg_events)(const void *this_arg);"))
- assert(line_indicates_trait_regex.match(" void *(*clone)(const void *this_arg);"))
assert(line_indicates_trait_regex.match(" struct LDKCVec_u8Z (*write)(const void *this_arg);"))
+ line_indicates_trait_clone_regex = re.compile("^ void \(\*cloned\)\(struct ([A-Za-z0-9])* \*NONNULL_PTR new_[A-Za-z0-9]*\);$")
+ assert(line_indicates_trait_clone_regex.match(" void (*cloned)(struct LDKSign *NONNULL_PTR new_Sign);"))
line_field_var_regex = re.compile("^ struct ([A-Za-z_0-9]*) ([A-Za-z_0-9]*);$")
assert(line_field_var_regex.match(" struct LDKMessageSendEventsProvider MessageSendEventsProvider;"))
assert(line_field_var_regex.match(" struct LDKChannelPublicKeys pubkeys;"))
union_enum_items = {}
result_ptr_struct_items = {}
for line in in_h:
- if in_block_comment:
+ if block_comment is not None:
if line.endswith("*/\n"):
- in_block_comment = False
+ last_block_comment = block_comment.strip("\n")
+ block_comment = None
+ else:
+ block_comment = block_comment + line.strip(" /*")
elif cur_block_obj is not None:
cur_block_obj = cur_block_obj + line
if line.startswith("} "):
is_tuple = False
trait_fn_lines = []
field_var_lines = []
+ last_struct_block_comment = None
for idx, struct_line in enumerate(obj_lines):
if struct_line.strip().startswith("/*"):
- in_block_comment = True
- if in_block_comment:
+ block_comment = struct_line.strip(" /*")
+ if block_comment is not None:
if struct_line.endswith("*/"):
- in_block_comment = False
+ last_struct_block_comment = block_comment.strip("\n")
+ block_comment = None
+ else:
+ block_comment = block_comment + "\n" + struct_line.strip(" /*")
else:
struct_name_match = struct_name_regex.match(struct_line)
if struct_name_match is not None:
is_tuple = True
trait_fn_match = line_indicates_trait_regex.match(struct_line)
if trait_fn_match is not None:
- trait_fn_lines.append(trait_fn_match)
+ trait_fn_lines.append((last_struct_block_comment, trait_fn_match))
+ trait_clone_fn_match = line_indicates_trait_clone_regex.match(struct_line)
+ if trait_clone_fn_match is not None:
+ trait_fn_lines.append((last_struct_block_comment, "cloned"))
field_var_match = line_field_var_regex.match(struct_line)
if field_var_match is not None:
field_var_lines.append(field_var_match)
- field_lines.append(struct_line)
+ field_lines.append((struct_line, last_struct_block_comment))
+ last_struct_block_comment = None
assert(struct_name is not None)
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))
if is_opaque:
opaque_structs.add(struct_name)
with open(f"{sys.argv[3]}/structs/{struct_name.replace('LDK', '')}{consts.file_ext}", "w") as out_java_struct:
- out_opaque_struct_human = consts.map_opaque_struct(struct_name)
+ out_opaque_struct_human = consts.map_opaque_struct(struct_name, last_block_comment)
+ last_block_comment = None
out_java_struct.write(out_opaque_struct_human)
elif result_contents is not None:
assert result_contents in result_ptr_struct_items
res_ty, err_ty = result_ptr_struct_items[result_contents]
map_result(struct_name, res_ty, err_ty)
elif struct_name.startswith("LDKCResult_") and struct_name.endswith("ZPtr"):
- for line in field_lines:
+ for line, _ in field_lines:
if line.endswith("*result;"):
res_ty = line[:-8].strip()
elif line.endswith("*err;"):
if cleanup is not None:
write_c("\t\t" + cleanup + ";\n")
write_c("\t}\n")
- write_c("\treturn (long)ret;\n")
+ write_c("\treturn (uint64_t)ret;\n")
write_c("}\n")
if ty_info.is_native_primitive:
enum_var_name = struct_name.split("_")
union_enum_items[enum_var_name[0]][enum_var_name[1]] = field_lines
elif struct_name in union_enum_items:
- map_complex_enum(struct_name, union_enum_items[struct_name])
+ tuple_variants = {}
+ elem_items = -1
+ for line, _ in field_lines:
+ if line == " struct {":
+ elem_items = 0
+ elif line == " };":
+ elem_items = -1
+ elif elem_items > -1:
+ line = line.strip()
+ if line.startswith("struct "):
+ line = line[7:]
+ elif line.startswith("enum "):
+ line = line[5:]
+ split = line.split(" ")
+ assert len(split) == 2
+ tuple_variants[split[1].strip(";")] = split[0]
+ elem_items += 1
+ if elem_items > 1:
+ # We don't currently support tuple variant with more than one element
+ assert False
+ map_complex_enum(struct_name, union_enum_items[struct_name], tuple_variants, last_block_comment)
+ last_block_comment = None
elif is_unitary_enum:
- map_unitary_enum(struct_name, field_lines)
+ map_unitary_enum(struct_name, field_lines, last_block_comment)
+ last_block_comment = None
elif len(trait_fn_lines) > 0:
- trait_structs.add(struct_name)
- map_trait(struct_name, field_var_lines, trait_fn_lines)
+ map_trait(struct_name, field_var_lines, trait_fn_lines, last_block_comment)
elif struct_name == "LDKTxOut":
with open(f"{sys.argv[3]}/structs/TxOut{consts.file_ext}", "w") as out_java_struct:
out_java_struct.write(consts.hu_struct_file_prefix)
out_java_struct.write("public class TxOut extends CommonBase{\n")
- out_java_struct.write("\tTxOut(java.lang.Object _dummy, long ptr) { super(ptr); }\n")
- out_java_struct.write("\tlong to_c_ptr() { return 0; }\n")
+ out_java_struct.write("\t/** The script_pubkey in this output */\n")
+ out_java_struct.write("\tpublic final byte[] script_pubkey;\n")
+ out_java_struct.write("\t/** The value, in satoshis, of this output */\n")
+ out_java_struct.write("\tpublic final long value;\n")
+ out_java_struct.write("\n")
+ out_java_struct.write("\tTxOut(java.lang.Object _dummy, long ptr) {\n")
+ out_java_struct.write("\t\tsuper(ptr);\n")
+ out_java_struct.write("\t\tthis.script_pubkey = bindings.TxOut_get_script_pubkey(ptr);\n")
+ out_java_struct.write("\t\tthis.value = bindings.TxOut_get_value(ptr);\n")
+ out_java_struct.write("\t}\n")
+ out_java_struct.write("\tpublic TxOut(long value, byte[] script_pubkey) {\n")
+ out_java_struct.write("\t\tsuper(bindings.TxOut_new(script_pubkey, value));\n")
+ out_java_struct.write("\t\tthis.script_pubkey = bindings.TxOut_get_script_pubkey(ptr);\n")
+ out_java_struct.write("\t\tthis.value = bindings.TxOut_get_value(ptr);\n")
+ out_java_struct.write("\t}\n")
+ out_java_struct.write("\n")
out_java_struct.write("\t@Override @SuppressWarnings(\"deprecation\")\n")
out_java_struct.write("\tprotected void finalize() throws Throwable {\n")
out_java_struct.write("\t\tsuper.finalize();\n")
out_java_struct.write("\t\tif (ptr != 0) { bindings.TxOut_free(ptr); }\n")
out_java_struct.write("\t}\n")
- # TODO: TxOut body
+ out_java_struct.write("\n")
out_java_struct.write("}")
+ fn_line = "struct LDKCVec_u8Z TxOut_get_script_pubkey (struct LDKTxOut* thing)"
+ write_c(fn_line + " {")
+ write_c("\treturn CVec_u8Z_clone(&thing->script_pubkey);")
+ write_c("}")
+ map_fn(fn_line + "\n", re.compile("(.*) (TxOut_get_script_pubkey) \((.*)\)").match(fn_line), None, None, None)
+ fn_line = "uint64_t TxOut_get_value (struct LDKTxOut* thing)"
+ write_c(fn_line + " {")
+ write_c("\treturn thing->value;")
+ write_c("}")
+ map_fn(fn_line + "\n", re.compile("(.*) (TxOut_get_value) \((.*)\)").match(fn_line), None, None, None)
else:
pass # Everything remaining is a byte[] or some form
cur_block_obj = None
if line.startswith("#include <"):
pass
elif line.startswith("/*"):
- #out_java.write("\t" + line)
if not line.endswith("*/\n"):
- in_block_comment = True
+ block_comment = line.strip(" /*")
elif line.startswith("typedef enum "):
cur_block_obj = line
elif line.startswith("typedef struct "):
elif line.startswith("typedef union "):
cur_block_obj = line
elif fn_ptr is not None:
- map_fn(line, fn_ptr, None, None)
+ map_fn(line, fn_ptr, None, None, last_block_comment)
+ last_block_comment = None
elif fn_ret_arr is not None:
- map_fn(line, fn_ret_arr, fn_ret_arr.group(4), None)
+ map_fn(line, fn_ret_arr, fn_ret_arr.group(4), None, last_block_comment)
+ last_block_comment = None
elif reg_fn is not None:
- map_fn(line, reg_fn, None, None)
+ map_fn(line, reg_fn, None, None, last_block_comment)
+ last_block_comment = None
elif const_val_regex is not None:
# TODO Map const variables
pass
for struct_name in trait_structs:
with open(f"{sys.argv[3]}/structs/{struct_name.replace('LDK', '')}{consts.file_ext}", "a") as out_java_struct:
out_java_struct.write("}\n")
+ for struct_name in complex_enums:
+ with open(f"{sys.argv[3]}/structs/{struct_name.replace('LDK', '').replace('COption', 'Option')}{consts.file_ext}", "a") as out_java_struct:
+ out_java_struct.write("}\n")
+ for struct_name in result_types:
+ with open(f"{sys.argv[3]}/structs/{struct_name.replace('LDKCResult', 'Result')}{consts.file_ext}", "a") as out_java_struct:
+ out_java_struct.write("}\n")
with open(sys.argv[4], "w") as out_c:
- out_c.write(consts.c_file_pfx)
+ out_c.write(consts.c_file_pfx.replace('<git_version_ldk_garbagecollected>', local_git_version))
out_c.write(consts.init_str())
out_c.write(c_file)
with open(f"{sys.argv[3]}/structs/UtilMethods{consts.file_ext}", "a") as util: