_ Git - ldk-java/blob - genbindings.py

   1 #!/usr/bin/env python3
   2 import sys, re
   3
   4 if len(sys.argv) != 4:
   5     print("USAGE: /path/to/lightning.h /path/to/bindings/output.java /path/to/bindings/output.c")
   6     sys.exit(1)
   7
   8 with open(sys.argv[1]) as in_h, open(sys.argv[2], "w") as out_java, open(sys.argv[3], "w") as out_c:
   9     opaque_structs = set()
  10
  11     var_is_arr_regex = re.compile("\(\*([A-za-z_]*)\)\[([0-9]*)\]")
  12     var_ty_regex = re.compile("([A-za-z_0-9]*)(.*)")
  13     def java_c_types(fn_arg, ret_arr_len):
  14         fn_arg = fn_arg.strip()
  15         if fn_arg.startswith("MUST_USE_RES "):
  16             fn_arg = fn_arg[13:]
  17         if fn_arg.startswith("const "):
  18             fn_arg = fn_arg[6:]
  19
  20         is_ptr = False
  21         if fn_arg.startswith("void"):
  22             java_ty = "void"
  23             c_ty = "void"
  24             fn_arg = fn_arg.strip("void ")
  25         elif fn_arg.startswith("bool"):
  26             java_ty = "boolean"
  27             c_ty = "jboolean"
  28             fn_arg = fn_arg.strip("bool ")
  29         elif fn_arg.startswith("uint8_t"):
  30             java_ty = "byte"
  31             c_ty = "jbyte"
  32             fn_arg = fn_arg.strip("uint8_t ")
  33         elif fn_arg.startswith("uint32_t"):
  34             java_ty = "int"
  35             c_ty = "jint"
  36             fn_arg = fn_arg.strip("uint32_t ")
  37         elif fn_arg.startswith("uint64_t"):
  38             java_ty = "long"
  39             c_ty = "jlong"
  40             fn_arg = fn_arg.strip("uint64_t ")
  41         else:
  42             ma = var_ty_regex.match(fn_arg)
  43             java_ty = "long"
  44             c_ty = "jlong"
  45             fn_arg = ma.group(2)
  46             is_ptr = True
  47
  48         var_is_arr = var_is_arr_regex.match(fn_arg)
  49         if var_is_arr is not None or ret_arr_len is not None:
  50             java_ty = java_ty + "[]"
  51             c_ty = c_ty + "Array"
  52         return (java_ty, c_ty, is_ptr)
  53
  54     def map_type(fn_arg, print_void, ret_arr_len, is_free):
  55         fn_arg = fn_arg.strip()
  56         if fn_arg.startswith("MUST_USE_RES "):
  57             fn_arg = fn_arg[13:]
  58         if fn_arg.startswith("const "):
  59             fn_arg = fn_arg[6:]
  60
  61         (java_ty, c_ty, is_ptr) = java_c_types(fn_arg, ret_arr_len)
  62         is_ptr_to_obj = None
  63         if fn_arg.startswith("void"):
  64             if not print_void:
  65                 return (None, None, None)
  66             fn_arg = fn_arg.strip("void ")
  67         elif not is_ptr:
  68             split = fn_arg.split(" ", 2)
  69             if len(split) > 1:
  70                 fn_arg = split[1]
  71             else:
  72                 fn_arg = ""
  73         else:
  74             ma = var_ty_regex.match(fn_arg)
  75             is_ptr_to_obj = ma.group(1)
  76             fn_arg = ma.group(2)
  77         assert(c_ty is not None)
  78         assert(java_ty is not None)
  79         out_c.write(c_ty)
  80         out_java.write(java_ty)
  81
  82         var_is_arr = var_is_arr_regex.match(fn_arg)
  83         no_ptr = fn_arg.replace('*', '')
  84         if var_is_arr is not None or ret_arr_len is not None:
  85             if var_is_arr is not None:
  86                 arr_name = var_is_arr.group(1)
  87                 arr_len = var_is_arr.group(2)
  88                 out_java.write(" " + arr_name)
  89                 out_c.write(" " + arr_name)
  90             else:
  91                 arr_name = "ret"
  92                 arr_len = ret_arr_len
  93             assert(c_ty == "jbyteArray")
  94             return ("unsigned char " + arr_name + "_arr[" + arr_len + "];\n" +
  95                     "(*_env)->GetByteArrayRegion (_env, """ + arr_name + ", 0, " + arr_len + ", " + arr_name + "_arr);\n" +
  96                     "unsigned char (*""" + arr_name + "_ref)[" + arr_len + "] = &" + arr_name + "_arr;",
  97                 (c_ty + " " + arr_name + "_arr = (*_env)->NewByteArray(_env, " + arr_len + ");\n" +
  98                     "(*_env)->SetByteArrayRegion(_env, " + arr_name + "_arr, 0, " + arr_len + ", *",
  99                     ");\nreturn ret_arr;"),
 100                 arr_name + "_ref")
 101         elif no_ptr.strip() != "":
 102             # If we have a parameter name, print it (noting that it may indicate its a pointer)
 103             out_java.write(" " + no_ptr.strip())
 104             out_c.write(" " + no_ptr.strip())
 105             if is_ptr_to_obj is not None:
 106                 if no_ptr == fn_arg:
 107                     base_conv = is_ptr_to_obj + " " + no_ptr.strip() + "_conv = *(" + is_ptr_to_obj + "*)" + no_ptr.strip() + ";\nfree((void*)" + no_ptr.strip() + ");";
 108                     if is_ptr_to_obj in opaque_structs:
 109                         return (base_conv + "\n" + no_ptr.strip() + "_conv._underlying_ref = false;",
 110                             "XXX2", no_ptr.strip() + "_conv")
 111                     return (base_conv, "XXX2", no_ptr.strip() + "_conv")
 112                 else:
 113                     assert(not is_free)
 114                     return (is_ptr_to_obj + "* " + no_ptr.strip() + "_conv = (" + is_ptr_to_obj + "*)" + no_ptr.strip() + ";",
 115                             "XXX2", no_ptr.strip() + "_conv")
 116             elif no_ptr != fn_arg:
 117                 return ("YYY1", "XXX3", no_ptr.strip())
 118             else:
 119                 return (None, "XXX4", no_ptr.strip())
 120         elif not print_void:
 121             # We don't have a parameter name, and want one, just call it arg
 122             out_java.write(" arg")
 123             out_c.write(" arg")
 124             if is_ptr_to_obj is not None:
 125                 assert(not is_free or is_ptr_to_obj not in opaque_structs);
 126                 return (is_ptr_to_obj + " arg_conv = *(" + is_ptr_to_obj + "*)arg;\nfree((void*)arg);", "XXX2", "arg_conv")
 127             else:
 128                 assert(not is_free)
 129                 return (None, "XXX6", "arg")
 130         else:
 131             # We don't have a parameter name, and don't want one (cause we're returning)
 132             if is_ptr_to_obj is not None:
 133                 if no_ptr == fn_arg:
 134                     if is_ptr_to_obj in opaque_structs:
 135                         # If we're returning a newly-allocated struct, we don't want Rust to ever
 136                         # free, instead relying on the Java GC to lose the ref. We undo this in
 137                         # any _free function.
 138                         # To avoid any issues, we first assert that the incoming object is non-ref.
 139                         return (None, (is_ptr_to_obj + "* ret = malloc(sizeof(" + is_ptr_to_obj + "));\n*ret = ", ";\nassert(!ret->_underlying_ref);\nret->_underlying_ref = true;\nreturn (long)ret;"), None)
 140                     else:
 141                         return (None, (is_ptr_to_obj + "* ret = malloc(sizeof(" + is_ptr_to_obj + "));\n*ret = ", ";\nreturn (long)ret;"), None)
 142                 else:
 143                     return (None, ("return (long) ", ";"), None)
 144             else:
 145                 return (None, None, None)
 146
 147     def map_fn(re_match, ret_arr_len):
 148         out_java.write("\t/// " + line)
 149         out_java.write("\tpublic static native ")
 150         out_c.write("JNIEXPORT ")
 151
 152         _, ret_conv, _ = map_type(re_match.group(1), True, ret_arr_len, False)
 153         if ret_conv is not None:
 154             ret_conv_pfx, ret_conv_sfx = ret_conv
 155
 156         out_java.write(" " + re_match.group(2) + "(")
 157         out_c.write(" JNICALL Java_org_ldk_impl_bindings_" + re_match.group(2).replace('_', '_1') + "(JNIEnv * _env, jclass _b")
 158
 159         arg_names = []
 160         for idx, arg in enumerate(re_match.group(3).split(',')):
 161             if idx != 0:
 162                 out_java.write(", ")
 163             if arg != "void":
 164                 out_c.write(", ")
 165             arg_names.append(map_type(arg, False, None, re_match.group(2).endswith("_free")))
 166
 167         out_java.write(");\n")
 168         out_c.write(") {\n")
 169
 170         for arg_conv, _, _ in arg_names:
 171             if arg_conv is not None:
 172                 out_c.write("\t" + arg_conv.replace('\n', "\n\t") + "\n");
 173
 174         if ret_conv is not None:
 175             out_c.write("\t" + ret_conv_pfx.replace('\n', '\n\t'));
 176         else:
 177             out_c.write("\treturn ");
 178
 179         out_c.write(re_match.group(2) + "(")
 180         for idx, (_, _, arg) in enumerate(arg_names):
 181             if arg is not None:
 182                 if idx != 0:
 183                     out_c.write(", ")
 184                 out_c.write(arg)
 185         out_c.write(")")
 186         if ret_conv is not None:
 187             out_c.write(ret_conv_sfx.replace('\n', '\n\t'))
 188         else:
 189             out_c.write(";")
 190         out_c.write("\n}\n\n")
 191
 192     out_java.write("""package org.ldk.impl;
 193
 194 public class bindings {
 195         static {
 196                 System.loadLibrary(\"lightningjni\");
 197         }
 198
 199 """)
 200     out_c.write("#include \"org_ldk_impl_bindings.h\"\n")
 201     out_c.write("#include <rust_types.h>\n")
 202     out_c.write("#include <lightning.h>\n")
 203     out_c.write("#include <assert.h>\n\n")
 204     out_c.write("#include <string.h>\n\n")
 205
 206     in_block_comment = False
 207     in_block_enum = False
 208     cur_block_struct = None
 209     in_block_union = False
 210
 211     fn_ptr_regex = re.compile("^extern const ([A-Za-z_0-9\* ]*) \(\*(.*)\)\((.*)\);$")
 212     fn_ret_arr_regex = re.compile("(.*) \(\*(.*)\((.*)\)\)\[([0-9]*)\];$")
 213     reg_fn_regex = re.compile("([A-Za-z_0-9\* ]* \*?)([a-zA-Z_0-9]*)\((.*)\);$")
 214     const_val_regex = re.compile("^extern const ([A-Za-z_0-9]*) ([A-Za-z_0-9]*);$")
 215
 216     line_indicates_opaque_regex = re.compile("^   bool _underlying_ref;$")
 217     line_indicates_trait_regex = re.compile("^   ([A-Za-z_0-9]* \*?)\(\*([A-Za-z_0-9]*)\)\((const )?void \*this_arg.*\);$")
 218     assert(line_indicates_trait_regex.match("   uintptr_t (*send_data)(void *this_arg, LDKu8slice data, bool resume_read);"))
 219     assert(line_indicates_trait_regex.match("   LDKCVec_MessageSendEventZ (*get_and_clear_pending_msg_events)(const void *this_arg);"))
 220     assert(line_indicates_trait_regex.match("   void *(*clone)(const void *this_arg);"))
 221     struct_name_regex = re.compile("^typedef struct (MUST_USE_STRUCT )?(LDK[A-Za-z_0-9]*) {$")
 222     assert(struct_name_regex.match("typedef struct LDKCVecTempl_u8 {"))
 223
 224     for line in in_h:
 225         if in_block_comment:
 226             #out_java.write("\t" + line)
 227             if line.endswith("*/\n"):
 228                 in_block_comment = False
 229         elif cur_block_struct is not None:
 230             cur_block_struct  = cur_block_struct + line
 231             if line.startswith("} "):
 232                 field_lines = []
 233                 struct_name = None
 234                 struct_lines = cur_block_struct.split("\n")
 235                 is_opaque = False
 236                 trait_fn_lines = []
 237
 238                 for idx, struct_line in enumerate(struct_lines):
 239                     if struct_line.strip().startswith("/*"):
 240                         in_block_comment = True
 241                     if in_block_comment:
 242                         if struct_line.endswith("*/"):
 243                             in_block_comment = False
 244                     else:
 245                         struct_name_match = struct_name_regex.match(struct_line)
 246                         if struct_name_match is not None:
 247                             struct_name = struct_name_match.group(2)
 248                         if line_indicates_opaque_regex.match(struct_line):
 249                             is_opaque = True
 250                         trait_fn_match = line_indicates_trait_regex.match(struct_line)
 251                         if trait_fn_match is not None:
 252                             trait_fn_lines.append(trait_fn_match)
 253                         field_lines.append(struct_line)
 254
 255                 assert(struct_name is not None)
 256                 assert(len(trait_fn_lines) == 0 or not is_opaque)
 257                 if is_opaque:
 258                     opaque_structs.add(struct_name)
 259                 if len(trait_fn_lines) > 0:
 260                     out_c.write("typedef struct " + struct_name + "_JCalls {\n")
 261                     out_c.write("\tJNIEnv *env;\n")
 262                     out_c.write("\tjobject o;\n")
 263                     for fn_line in trait_fn_lines:
 264                         if fn_line.group(2) != "free" and fn_line.group(2) != "clone":
 265                             out_c.write("\tjmethodID " + fn_line.group(2) + "_meth;\n")
 266                     out_c.write("} " + struct_name + "_JCalls;\n")
 267
 268                     out_java.write("\tpublic interface " + struct_name + " {\n")
 269                     for fn_line in trait_fn_lines:
 270                         if fn_line.group(2) != "free" and fn_line.group(2) != "clone":
 271                             (java_ty, c_ty, is_ptr) = java_c_types(fn_line.group(1), None)
 272
 273                             out_java.write("\t\t " + java_ty + " " + fn_line.group(2) + "(/* TODO */);\n")
 274
 275                             out_c.write(c_ty + " " + fn_line.group(2) + "_jcall(void* this_arg/* TODO */) {\n")
 276                             out_c.write("\t" + struct_name + "_JCalls *arg = (" + struct_name + "_JCalls*) this_arg;\n")
 277                             out_c.write("\treturn (*arg->env)->Call" + java_ty.title() + "Method(arg->env, arg->o, arg->" + fn_line.group(2) + "_meth);\n");
 278                             out_c.write("}\n")
 279                         elif fn_line.group(2) == "free":
 280                             out_c.write("void " + struct_name + "_JCalls_free(void* this_arg) {\n")
 281                             out_c.write("\t" + struct_name + "_JCalls *arg = (" + struct_name + "_JCalls*) this_arg;\n")
 282                             out_c.write("\t(*arg->env)->DeleteGlobalRef(arg->env, arg->o);\n")
 283                             out_c.write("\tfree(arg);\n")
 284                             out_c.write("}\n")
 285                         elif fn_line.group(2) == "clone":
 286                             out_c.write("void* " + struct_name + "_JCalls_clone(void* this_arg) {\n")
 287                             out_c.write("\t" + struct_name + "_JCalls *ret = malloc(sizeof(" + struct_name + "_JCalls));\n")
 288                             out_c.write("\tmemcpy(ret, this_arg, sizeof(" + struct_name + "_JCalls));\n")
 289                             out_c.write("\treturn ret;\n")
 290                             out_c.write("}\n")
 291                     out_java.write("\t}\n")
 292                     out_java.write("\tpublic static native long " + struct_name + "_new(" + struct_name + " impl);\n")
 293
 294                     out_c.write("JNIEXPORT long JNICALL Java_org_ldk_impl_bindings_" + struct_name.replace("_", "_1") + "_1new (JNIEnv * env, jclass _a, jobject o) {\n")
 295                     out_c.write("\tjclass c = (*env)->GetObjectClass(env, o);\n")
 296                     out_c.write("\tassert(c != NULL);\n")
 297                     out_c.write("\t" + struct_name + "_JCalls *calls = malloc(sizeof(" + struct_name + "_JCalls));\n")
 298                     out_c.write("\tcalls->env = env;\n")
 299                     out_c.write("\tcalls->o = (*env)->NewGlobalRef(env, o);\n")
 300                     for fn_line in trait_fn_lines:
 301                         if fn_line.group(2) != "free" and fn_line.group(2) != "clone":
 302                             out_c.write("\tcalls->" + fn_line.group(2) + "_meth = (*env)->GetMethodID(env, c, \"" + fn_line.group(2) + "\", \"" + "TODO" + "\");\n")
 303                             out_c.write("\tassert(calls->" + fn_line.group(2) + "_meth != NULL);\n")
 304                     out_c.write("\n\t" + struct_name + " *ret = malloc(sizeof(" + struct_name + "));\n")
 305                     out_c.write("\tret->this_arg = (void*) calls;\n")
 306                     for fn_line in trait_fn_lines:
 307                         if fn_line.group(2) != "free" and fn_line.group(2) != "clone":
 308                             out_c.write("\tret->" + fn_line.group(2) + " = " + fn_line.group(2) + "_jcall;\n")
 309                         elif fn_line.group(2) == "free":
 310                             out_c.write("\tret->free = " + struct_name + "_JCalls_free;\n")
 311                         else:
 312                             out_c.write("\tret->clone = " + struct_name + "_JCalls_clone;\n")
 313                     out_c.write("\treturn (long)ret;\n")
 314                     out_c.write("}\n\n")
 315
 316                     #out_java.write("/* " + "\n".join(field_lines) + "*/\n")
 317                 cur_block_struct = None
 318         elif in_block_union:
 319             if line.startswith("} "):
 320                 in_block_union = False
 321         elif in_block_enum:
 322             if line.startswith("} "):
 323                 in_block_enum = False
 324         else:
 325             fn_ptr = fn_ptr_regex.match(line)
 326             fn_ret_arr = fn_ret_arr_regex.match(line)
 327             reg_fn = reg_fn_regex.match(line)
 328             const_val = const_val_regex.match(line)
 329
 330             if line.startswith("#include <"):
 331                 pass
 332             elif line.startswith("/*"):
 333                 #out_java.write("\t" + line)
 334                 if not line.endswith("*/\n"):
 335                     in_block_comment = True
 336             elif line.startswith("typedef enum "):
 337                 in_block_enum = True
 338             elif line.startswith("typedef struct "):
 339                 cur_block_struct = line
 340             elif line.startswith("typedef union "):
 341                 in_block_union = True
 342             elif line.startswith("typedef "):
 343                 pass
 344             elif fn_ptr is not None:
 345                 map_fn(fn_ptr, None)
 346             elif fn_ret_arr is not None:
 347                 map_fn(fn_ret_arr, fn_ret_arr.group(4))
 348             elif reg_fn is not None:
 349                 map_fn(reg_fn, None)
 350             elif const_val_regex is not None:
 351                 # TODO Map const variables
 352                 pass
 353             else:
 354                 assert(line == "\n")
 355
 356     out_java.write("}\n")