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