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