2 * Copyright (C) 2009-2010 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;
40 import com.redhat.et.libguestfs.LibGuestFSException;
41 import com.redhat.et.libguestfs.PV;
42 import com.redhat.et.libguestfs.VG;
43 import com.redhat.et.libguestfs.LV;
44 import com.redhat.et.libguestfs.Stat;
45 import com.redhat.et.libguestfs.StatVFS;
46 import com.redhat.et.libguestfs.IntBool;
47 import com.redhat.et.libguestfs.Dirent;
50 * The GuestFS object is a libguestfs handle.
54 public class GuestFS {
55 // Load the native code.
57 System.loadLibrary (\"guestfs_jni\");
61 * The native guestfs_h pointer.
66 * Create a libguestfs handle.
68 * @throws LibGuestFSException
70 public GuestFS () throws LibGuestFSException
74 private native long _create () throws LibGuestFSException;
77 * Close a libguestfs handle.
79 * You can also leave handles to be collected by the garbage
80 * collector, but this method ensures that the resources used
81 * by the handle are freed up immediately. If you call any
82 * other methods after closing the handle, you will get an
85 * @throws LibGuestFSException
87 public void close () throws LibGuestFSException
93 private native void _close (long g) throws LibGuestFSException;
95 public void finalize () throws LibGuestFSException
103 fun (name, (ret, args, optargs as style), _, flags, _, shortdesc, longdesc) ->
104 if not (List.mem NotInDocs flags); then (
105 let doc = replace_str longdesc "C<guestfs_" "C<g." in
107 if optargs <> [] then
108 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."
111 if List.mem ProtocolLimitWarning flags then
112 doc ^ "\n\n" ^ protocol_limit_warning
115 if List.mem DangerWillRobinson flags then
116 doc ^ "\n\n" ^ danger_will_robinson
119 match deprecation_notice flags with
121 | Some txt -> doc ^ "\n\n" ^ txt in
122 let doc = pod2text ~width:60 name doc in
123 let doc = List.map ( (* RHBZ#501883 *)
126 | nonempty -> nonempty
128 let doc = String.concat "\n * " doc in
131 pr " * %s\n" shortdesc;
134 pr " * @throws LibGuestFSException\n";
138 generate_java_prototype ~public:true ~semicolon:false name style;
142 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
145 if ret <> RErr then pr "return ";
147 generate_java_call_args ~handle:"g" style;
151 generate_java_prototype ~privat:true ~native:true name style;
158 (* Generate Java call arguments, eg "(handle, foo, bar)" *)
159 and generate_java_call_args ~handle (_, args, optargs) =
161 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
162 if optargs <> [] then pr ", optargs";
165 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
166 ?(semicolon=true) name (ret, args, optargs) =
167 if privat then pr "private ";
168 if public then pr "public ";
169 if native then pr "native ";
173 | RErr -> pr "void ";
174 | RInt _ -> pr "int ";
175 | RInt64 _ -> pr "long ";
176 | RBool _ -> pr "boolean ";
177 | RConstString _ | RConstOptString _ | RString _
178 | RBufferOut _ -> pr "String ";
179 | RStringList _ -> pr "String[] ";
180 | RStruct (_, typ) ->
181 let name = java_name_of_struct typ in
183 | RStructList (_, typ) ->
184 let name = java_name_of_struct typ in
186 | RHashtable _ -> pr "HashMap<String,String> ";
189 if native then pr "_%s " name else pr "%s " name;
191 let needs_comma = ref false in
200 if !needs_comma then pr ", ";
205 | Device n | Dev_or_Path n
214 | StringList n | DeviceList n ->
224 if optargs <> [] then (
225 if !needs_comma then pr ", ";
231 pr " throws LibGuestFSException";
232 if semicolon then pr ";"
234 and generate_java_struct jtyp cols () =
235 generate_header CStyle LGPLv2plus;
238 package com.redhat.et.libguestfs;
241 * Libguestfs %s structure.
253 | name, FBuffer -> pr " public String %s;\n" name
254 | name, (FBytes|FUInt64|FInt64) -> pr " public long %s;\n" name
255 | name, (FUInt32|FInt32) -> pr " public int %s;\n" name
256 | name, FChar -> pr " public char %s;\n" name
257 | name, FOptPercent ->
258 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
259 pr " public float %s;\n" name
264 and generate_java_c () =
265 generate_header CStyle LGPLv2plus;
272 #include \"com_redhat_et_libguestfs_GuestFS.h\"
273 #include \"guestfs.h\"
275 /* Note that this function returns. The exception is not thrown
276 * until after the wrapper function returns.
279 throw_exception (JNIEnv *env, const char *msg)
282 cl = (*env)->FindClass (env,
283 \"com/redhat/et/libguestfs/LibGuestFSException\");
284 (*env)->ThrowNew (env, cl, msg);
287 JNIEXPORT jlong JNICALL
288 Java_com_redhat_et_libguestfs_GuestFS__1create
289 (JNIEnv *env, jobject obj)
293 g = guestfs_create ();
295 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
298 guestfs_set_error_handler (g, NULL, NULL);
299 return (jlong) (long) g;
302 JNIEXPORT void JNICALL
303 Java_com_redhat_et_libguestfs_GuestFS__1close
304 (JNIEnv *env, jobject obj, jlong jg)
306 guestfs_h *g = (guestfs_h *) (long) jg;
313 fun (name, (ret, args, optargs as style), _, _, _, _, _) ->
316 | RErr -> pr "void ";
317 | RInt _ -> pr "jint ";
318 | RInt64 _ -> pr "jlong ";
319 | RBool _ -> pr "jboolean ";
320 | RConstString _ | RConstOptString _ | RString _
321 | RBufferOut _ -> pr "jstring ";
322 | RStruct _ | RHashtable _ ->
324 | RStringList _ | RStructList _ ->
328 pr "Java_com_redhat_et_libguestfs_GuestFS_";
329 pr "%s" (replace_str ("_" ^ name) "_" "_1");
331 pr " (JNIEnv *env, jobject obj, jlong jg";
335 | Device n | Dev_or_Path n
343 pr ", jbyteArray j%s" n
344 | StringList n | DeviceList n ->
345 pr ", jobjectArray j%s" n
347 pr ", jboolean j%s" n
353 if optargs <> [] then
354 pr ", jobject joptargs";
357 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
358 let error_code, no_ret =
360 | RErr -> pr " int r;\n"; "-1", ""
362 | RInt _ -> pr " int r;\n"; "-1", "0"
363 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
364 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
365 | RConstOptString _ -> pr " const char *r;\n"; "NULL", "NULL"
368 pr " char *r;\n"; "NULL", "NULL"
370 pr " jobjectArray jr;\n";
373 pr " jstring jstr;\n";
374 pr " char **r;\n"; "NULL", "NULL"
375 | RStruct (_, typ) ->
378 pr " jfieldID fl;\n";
379 pr " struct guestfs_%s *r;\n" typ; "NULL", "NULL"
380 | RStructList (_, typ) ->
381 pr " jobjectArray jr;\n";
383 pr " jfieldID fl;\n";
384 pr " jobject jfl;\n";
385 pr " struct guestfs_%s_list *r;\n" typ; "NULL", "NULL"
386 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL"
390 pr " size_t size;\n";
395 | Device n | Dev_or_Path n
401 pr " const char *%s;\n" n
403 pr " jbyte *%s;\n" n;
404 pr " size_t %s_size;\n" n
405 | StringList n | DeviceList n ->
406 pr " int %s_len;\n" n;
407 pr " const char **%s;\n" n
412 pr " int64_t %s;\n" n
417 | RStringList _ | RStructList _ -> true
418 | RErr | RBool _ | RInt _ | RInt64 _ | RConstString _
420 | RString _ | RBufferOut _ | RStruct _ | RHashtable _ -> false) ||
421 List.exists (function
422 | StringList _ -> true
423 | DeviceList _ -> true
424 | _ -> false) args in
430 (* Get the parameters. *)
434 | Device n | Dev_or_Path n
439 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
441 (* This is completely undocumented, but Java null becomes
444 pr " %s = j%s ? (*env)->GetStringUTFChars (env, j%s, NULL) : NULL;\n" n n n
446 pr " %s = (*env)->GetByteArrayElements (env, j%s, NULL);\n" n n;
447 pr " %s_size = (*env)->GetArrayLength (env, j%s);\n" n n
448 | StringList n | DeviceList n ->
449 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
450 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
451 pr " for (i = 0; i < %s_len; ++i) {\n" n;
452 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
454 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
456 pr " %s[%s_len] = NULL;\n" n n;
460 pr " %s = j%s;\n" n n
463 if optargs <> [] then (
465 pr " throw_exception (env, \"%s: internal error: please let us know how to read a Java HashMap parameter from JNI bindings!\");\n" name;
466 pr " return NULL;\n";
472 pr " r = guestfs_%s " name
474 pr " r = guestfs_%s_argv " name;
475 generate_c_call_args ~handle:"g" style;
478 (* Release the parameters. *)
482 | Device n | Dev_or_Path n
487 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
490 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
492 pr " (*env)->ReleaseByteArrayElements (env, j%s, %s, 0);\n" n n
493 | StringList n | DeviceList n ->
494 pr " for (i = 0; i < %s_len; ++i) {\n" n;
495 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
497 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
505 (* Check for errors. *)
506 pr " if (r == %s) {\n" error_code;
507 pr " throw_exception (env, guestfs_last_error (g));\n";
508 pr " return %s;\n" no_ret;
514 | RInt _ -> pr " return (jint) r;\n"
515 | RBool _ -> pr " return (jboolean) r;\n"
516 | RInt64 _ -> pr " return (jlong) r;\n"
517 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
518 | RConstOptString _ ->
519 pr " return (*env)->NewStringUTF (env, r); /* XXX r NULL? */\n"
521 pr " jr = (*env)->NewStringUTF (env, r);\n";
525 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
526 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
527 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
528 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
529 pr " for (i = 0; i < r_len; ++i) {\n";
530 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
531 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
532 pr " free (r[i]);\n";
536 | RStruct (_, typ) ->
537 let jtyp = java_name_of_struct typ in
538 let cols = cols_of_struct typ in
539 generate_java_struct_return typ jtyp cols
540 | RStructList (_, typ) ->
541 let jtyp = java_name_of_struct typ in
542 let cols = cols_of_struct typ in
543 generate_java_struct_list_return typ jtyp cols
546 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
549 pr " jr = (*env)->NewStringUTF (env, r); /* XXX size */\n";
554 if optargs <> [] then
561 and generate_java_struct_return typ jtyp cols =
562 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
563 pr " jr = (*env)->AllocObject (env, cl);\n";
567 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
568 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, r->%s));\n" name;
572 pr " memcpy (s, r->%s, 32);\n" name;
574 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
575 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
579 pr " int len = r->%s_len;\n" name;
580 pr " char s[len+1];\n";
581 pr " memcpy (s, r->%s, len);\n" name;
583 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
584 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
586 | name, (FBytes|FUInt64|FInt64) ->
587 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
588 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
589 | name, (FUInt32|FInt32) ->
590 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
591 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
592 | name, FOptPercent ->
593 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
594 pr " (*env)->SetFloatField (env, jr, fl, r->%s);\n" name;
596 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
597 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
602 and generate_java_struct_list_return typ jtyp cols =
603 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
604 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
605 pr " for (i = 0; i < r->len; ++i) {\n";
606 pr " jfl = (*env)->AllocObject (env, cl);\n";
610 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
611 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
615 pr " memcpy (s, r->val[i].%s, 32);\n" name;
617 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
618 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
622 pr " int len = r->val[i].%s_len;\n" name;
623 pr " char s[len+1];\n";
624 pr " memcpy (s, r->val[i].%s, len);\n" name;
626 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
627 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
629 | name, (FBytes|FUInt64|FInt64) ->
630 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
631 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
632 | name, (FUInt32|FInt32) ->
633 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
634 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
635 | name, FOptPercent ->
636 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
637 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
639 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
640 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
642 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
644 pr " guestfs_free_%s_list (r);\n" typ;
647 and generate_java_makefile_inc () =
648 generate_header HashStyle GPLv2plus;
650 pr "java_built_sources = \\\n";
653 pr "\tcom/redhat/et/libguestfs/%s.java \\\n" jtyp;
655 pr "\tcom/redhat/et/libguestfs/GuestFS.java\n"