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()
with open(f"{sys.argv[3]}/structs/UtilMethods{consts.file_ext}", "a") as util:
util.write(consts.util_fn_pfx)
-with open(sys.argv[1]) as in_h, open(sys.argv[2], "w") as out_java:
+with open(sys.argv[1]) as in_h, open(f"{sys.argv[2]}/bindings{consts.file_ext}", "w") as out_java:
# Map a top-level function
def map_fn(line, re_match, ret_arr_len, c_call_string, doc_comment):
method_return_type = re_match.group(1)
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 = 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
out_java_struct = open(f"{sys.argv[3]}/structs/{struct_meth}{consts.file_ext}", "a")
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
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:
elif idx == len(field_lines) - 1:
assert(struct_line == "")
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)
+ (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)
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):
+ for idx, (field, field_docs) in enumerate(enum_var_lines):
if idx != 0 and idx < len(enum_var_lines) - 2 and field.strip() != "":
- fields.append(type_mapping_generator.map_type(field.strip(' ;'), False, None, False, True))
+ 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:
- fields.append(type_mapping_generator.map_type(inline_enum_variants[camel_to_snake(variant_name)] + " " + camel_to_snake(variant_name), False, None, False, True))
+ # 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:
enum_variants.append(ComplexEnumVariantInfo(variant_name, fields, True))
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.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("\treturn tuple->" + e + ";\n")
write_c("}\n")
- out_java.write(consts.bindings_header.replace('<git_version_ldk_garbagecollected>', local_git_version))
+ out_java.write(consts.bindings_header)
+ with open(f"{sys.argv[2]}/version{consts.file_ext}", "w") as out_java_version:
+ out_java_version.write(consts.bindings_version_file.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)
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("/*"):
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))
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;"):
elif struct_name in union_enum_items:
tuple_variants = {}
elem_items = -1
- for line in field_lines:
+ for line, _ in field_lines:
if line == " struct {":
elem_items = 0
elif line == " };":
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
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.replace('<git_version_ldk_garbagecollected>', local_git_version))
+with open(f"{sys.argv[4]}/bindings.c.body", "w") as out_c:
+ out_c.write(consts.c_file_pfx)
out_c.write(consts.init_str())
out_c.write(c_file)
+with open(f"{sys.argv[4]}/version.c", "w") as out_c:
+ out_c.write(consts.c_version_file.replace('<git_version_ldk_garbagecollected>', local_git_version))
with open(f"{sys.argv[3]}/structs/UtilMethods{consts.file_ext}", "a") as util:
util.write(consts.util_fn_sfx)
projects / ldk-java / blobdiff