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