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