2 * Copyright (C) 2009-2011 Red Hat Inc.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 (* Please read generator/README first. *)
26 open Generator_docstrings
27 open Generator_optgroups
28 open Generator_actions
29 open Generator_structs
32 (* Generate Java bindings GuestFS.java file. *)
33 let rec generate_java_java () =
34 generate_header CStyle LGPLv2plus;
37 package com.redhat.et.libguestfs;
39 import java.util.HashMap;
41 import com.redhat.et.libguestfs.LibGuestFSException;
42 import com.redhat.et.libguestfs.PV;
43 import com.redhat.et.libguestfs.VG;
44 import com.redhat.et.libguestfs.LV;
45 import com.redhat.et.libguestfs.Stat;
46 import com.redhat.et.libguestfs.StatVFS;
47 import com.redhat.et.libguestfs.IntBool;
48 import com.redhat.et.libguestfs.Dirent;
51 * The GuestFS object is a libguestfs handle.
55 public class GuestFS {
56 // Load the native code.
58 System.loadLibrary (\"guestfs_jni\");
62 * The native guestfs_h pointer.
67 * Create a libguestfs handle.
69 * @throws LibGuestFSException
71 public GuestFS () throws LibGuestFSException
75 private native long _create () throws LibGuestFSException;
78 * Close a libguestfs handle.
80 * You can also leave handles to be collected by the garbage
81 * collector, but this method ensures that the resources used
82 * by the handle are freed up immediately. If you call any
83 * other methods after closing the handle, you will get an
86 * @throws LibGuestFSException
88 public void close () throws LibGuestFSException
94 private native void _close (long g) throws LibGuestFSException;
96 public void finalize () throws LibGuestFSException
104 fun (name, (ret, args, optargs as style), _, flags, _, shortdesc, longdesc) ->
105 if not (List.mem NotInDocs flags); then (
106 let doc = replace_str longdesc "C<guestfs_" "C<g." in
108 if optargs <> [] then
109 doc ^ "\n\nOptional arguments are supplied in the final Map<String,Object> parameter, which is a hash of the argument name to its value (cast to Object). Pass an empty Map for no optional arguments."
112 if List.mem ProtocolLimitWarning flags then
113 doc ^ "\n\n" ^ protocol_limit_warning
116 if List.mem DangerWillRobinson flags then
117 doc ^ "\n\n" ^ danger_will_robinson
120 match deprecation_notice flags with
122 | Some txt -> doc ^ "\n\n" ^ txt in
123 let doc = pod2text ~width:60 name doc in
124 let doc = List.map ( (* RHBZ#501883 *)
127 | nonempty -> nonempty
129 let doc = String.concat "\n * " doc in
132 pr " * %s\n" shortdesc;
135 pr " * @throws LibGuestFSException\n";
139 generate_java_prototype ~public:true ~semicolon:false name style;
143 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
146 if ret <> RErr then pr "return ";
148 generate_java_call_args ~handle:"g" style;
152 generate_java_prototype ~privat:true ~native:true name style;
159 (* Generate Java call arguments, eg "(handle, foo, bar)" *)
160 and generate_java_call_args ~handle (_, args, optargs) =
162 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
163 if optargs <> [] then pr ", optargs";
166 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
167 ?(semicolon=true) name (ret, args, optargs) =
168 if privat then pr "private ";
169 if public then pr "public ";
170 if native then pr "native ";
174 | RErr -> pr "void ";
175 | RInt _ -> pr "int ";
176 | RInt64 _ -> pr "long ";
177 | RBool _ -> pr "boolean ";
178 | RConstString _ | RConstOptString _ | RString _
179 | RBufferOut _ -> pr "String ";
180 | RStringList _ -> pr "String[] ";
181 | RStruct (_, typ) ->
182 let name = java_name_of_struct typ in
184 | RStructList (_, typ) ->
185 let name = java_name_of_struct typ in
187 | RHashtable _ -> pr "Map<String,String> ";
190 if native then pr "_%s " name else pr "%s " name;
192 let needs_comma = ref false in
201 if !needs_comma then pr ", ";
206 | Device n | Dev_or_Path n
215 | StringList n | DeviceList n ->
221 | Int64 n | Pointer (_, n) ->
225 if optargs <> [] then (
226 if !needs_comma then pr ", ";
232 pr " throws LibGuestFSException";
233 if semicolon then pr ";"
235 and generate_java_struct jtyp cols () =
236 generate_header CStyle LGPLv2plus;
239 package com.redhat.et.libguestfs;
242 * Libguestfs %s structure.
254 | name, FBuffer -> pr " public String %s;\n" name
255 | name, (FBytes|FUInt64|FInt64) -> pr " public long %s;\n" name
256 | name, (FUInt32|FInt32) -> pr " public int %s;\n" name
257 | name, FChar -> pr " public char %s;\n" name
258 | name, FOptPercent ->
259 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
260 pr " public float %s;\n" name
265 and generate_java_c () =
266 generate_header CStyle LGPLv2plus;
273 #include \"com_redhat_et_libguestfs_GuestFS.h\"
274 #include \"guestfs.h\"
276 /* Note that this function returns. The exception is not thrown
277 * until after the wrapper function returns.
280 throw_exception (JNIEnv *env, const char *msg)
283 cl = (*env)->FindClass (env,
284 \"com/redhat/et/libguestfs/LibGuestFSException\");
285 (*env)->ThrowNew (env, cl, msg);
288 JNIEXPORT jlong JNICALL
289 Java_com_redhat_et_libguestfs_GuestFS__1create
290 (JNIEnv *env, jobject obj)
294 g = guestfs_create ();
296 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
299 guestfs_set_error_handler (g, NULL, NULL);
300 return (jlong) (long) g;
303 JNIEXPORT void JNICALL
304 Java_com_redhat_et_libguestfs_GuestFS__1close
305 (JNIEnv *env, jobject obj, jlong jg)
307 guestfs_h *g = (guestfs_h *) (long) jg;
314 fun (name, (ret, args, optargs as style), _, _, _, _, _) ->
317 | RErr -> pr "void ";
318 | RInt _ -> pr "jint ";
319 | RInt64 _ -> pr "jlong ";
320 | RBool _ -> pr "jboolean ";
321 | RConstString _ | RConstOptString _ | RString _
322 | RBufferOut _ -> pr "jstring ";
323 | RStruct _ | RHashtable _ ->
325 | RStringList _ | RStructList _ ->
329 pr "Java_com_redhat_et_libguestfs_GuestFS_";
330 pr "%s" (replace_str ("_" ^ name) "_" "_1");
332 pr " (JNIEnv *env, jobject obj, jlong jg";
336 | Device n | Dev_or_Path n
344 pr ", jbyteArray j%s" n
345 | StringList n | DeviceList n ->
346 pr ", jobjectArray j%s" n
348 pr ", jboolean j%s" n
351 | Int64 n | Pointer (_, n) ->
354 if optargs <> [] then
355 pr ", jobject joptargs";
358 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
359 let error_code, no_ret =
361 | RErr -> pr " int r;\n"; "-1", ""
363 | RInt _ -> pr " int r;\n"; "-1", "0"
364 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
365 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
366 | RConstOptString _ -> pr " const char *r;\n"; "NULL", "NULL"
369 pr " char *r;\n"; "NULL", "NULL"
371 pr " jobjectArray jr;\n";
374 pr " jstring jstr;\n";
375 pr " char **r;\n"; "NULL", "NULL"
376 | RStruct (_, typ) ->
379 pr " jfieldID fl;\n";
380 pr " struct guestfs_%s *r;\n" typ; "NULL", "NULL"
381 | RStructList (_, typ) ->
382 pr " jobjectArray jr;\n";
384 pr " jfieldID fl;\n";
385 pr " jobject jfl;\n";
386 pr " struct guestfs_%s_list *r;\n" typ; "NULL", "NULL"
387 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL"
391 pr " size_t size;\n";
396 | Device n | Dev_or_Path n
402 pr " const char *%s;\n" n
404 pr " jbyte *%s;\n" n;
405 pr " size_t %s_size;\n" n
406 | StringList n | DeviceList n ->
407 pr " int %s_len;\n" n;
408 pr " const char **%s;\n" n
413 pr " int64_t %s;\n" n
420 | RStringList _ | RStructList _ -> true
421 | RErr | RBool _ | RInt _ | RInt64 _ | RConstString _
423 | RString _ | RBufferOut _ | RStruct _ | RHashtable _ -> false) ||
424 List.exists (function
425 | StringList _ -> true
426 | DeviceList _ -> true
427 | _ -> false) args in
433 (* Get the parameters. *)
437 | Device n | Dev_or_Path n
442 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
444 (* This is completely undocumented, but Java null becomes
447 pr " %s = j%s ? (*env)->GetStringUTFChars (env, j%s, NULL) : NULL;\n" n n n
449 pr " %s = (*env)->GetByteArrayElements (env, j%s, NULL);\n" n n;
450 pr " %s_size = (*env)->GetArrayLength (env, j%s);\n" n n
451 | StringList n | DeviceList n ->
452 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
453 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
454 pr " for (i = 0; i < %s_len; ++i) {\n" n;
455 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
457 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
459 pr " %s[%s_len] = NULL;\n" n n;
463 pr " %s = j%s;\n" n n
465 pr " %s = (%s) j%s;\n" n t n
468 if optargs <> [] then (
470 pr " throw_exception (env, \"%s: internal error: please let us know how to read a Java HashMap parameter from JNI bindings!\");\n" name;
471 pr " return NULL;\n";
477 pr " r = guestfs_%s " name
479 pr " r = guestfs_%s_argv " name;
480 generate_c_call_args ~handle:"g" style;
483 (* Release the parameters. *)
487 | Device n | Dev_or_Path n
492 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
495 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
497 pr " (*env)->ReleaseByteArrayElements (env, j%s, %s, 0);\n" n n
498 | StringList n | DeviceList n ->
499 pr " for (i = 0; i < %s_len; ++i) {\n" n;
500 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
502 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
511 (* Check for errors. *)
512 pr " if (r == %s) {\n" error_code;
513 pr " throw_exception (env, guestfs_last_error (g));\n";
514 pr " return %s;\n" no_ret;
520 | RInt _ -> pr " return (jint) r;\n"
521 | RBool _ -> pr " return (jboolean) r;\n"
522 | RInt64 _ -> pr " return (jlong) r;\n"
523 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
524 | RConstOptString _ ->
525 pr " return (*env)->NewStringUTF (env, r); /* XXX r NULL? */\n"
527 pr " jr = (*env)->NewStringUTF (env, r);\n";
531 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
532 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
533 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
534 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
535 pr " for (i = 0; i < r_len; ++i) {\n";
536 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
537 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
538 pr " free (r[i]);\n";
542 | RStruct (_, typ) ->
543 let jtyp = java_name_of_struct typ in
544 let cols = cols_of_struct typ in
545 generate_java_struct_return typ jtyp cols
546 | RStructList (_, typ) ->
547 let jtyp = java_name_of_struct typ in
548 let cols = cols_of_struct typ in
549 generate_java_struct_list_return typ jtyp cols
552 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
555 pr " jr = (*env)->NewStringUTF (env, r); /* XXX size */\n";
560 if optargs <> [] then
567 and generate_java_struct_return typ jtyp cols =
568 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
569 pr " jr = (*env)->AllocObject (env, cl);\n";
573 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
574 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, r->%s));\n" name;
578 pr " memcpy (s, r->%s, 32);\n" name;
580 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
581 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
585 pr " int len = r->%s_len;\n" name;
586 pr " char s[len+1];\n";
587 pr " memcpy (s, r->%s, len);\n" name;
589 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
590 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
592 | name, (FBytes|FUInt64|FInt64) ->
593 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
594 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
595 | name, (FUInt32|FInt32) ->
596 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
597 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
598 | name, FOptPercent ->
599 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
600 pr " (*env)->SetFloatField (env, jr, fl, r->%s);\n" name;
602 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
603 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
608 and generate_java_struct_list_return typ jtyp cols =
609 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
610 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
611 pr " for (i = 0; i < r->len; ++i) {\n";
612 pr " jfl = (*env)->AllocObject (env, cl);\n";
616 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
617 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
621 pr " memcpy (s, r->val[i].%s, 32);\n" name;
623 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
624 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
628 pr " int len = r->val[i].%s_len;\n" name;
629 pr " char s[len+1];\n";
630 pr " memcpy (s, r->val[i].%s, len);\n" name;
632 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
633 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
635 | name, (FBytes|FUInt64|FInt64) ->
636 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
637 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
638 | name, (FUInt32|FInt32) ->
639 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
640 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
641 | name, FOptPercent ->
642 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
643 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
645 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
646 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
648 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
650 pr " guestfs_free_%s_list (r);\n" typ;
653 and generate_java_makefile_inc () =
654 generate_header HashStyle GPLv2plus;
656 pr "java_built_sources = \\\n";
659 pr "\tcom/redhat/et/libguestfs/%s.java \\\n" jtyp;
661 pr "\tcom/redhat/et/libguestfs/GuestFS.java\n"