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