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 ruby bindings. *)
33 let rec generate_ruby_c () =
34 generate_header CStyle LGPLv2plus;
42 #include \"guestfs.h\"
44 #include \"extconf.h\"
48 #define RARRAY_LEN(r) (RARRAY((r))->len)
51 static VALUE m_guestfs; /* guestfs module */
52 static VALUE c_guestfs; /* guestfs_h handle */
53 static VALUE e_Error; /* used for all errors */
55 static void ruby_guestfs_free (void *p)
58 guestfs_close ((guestfs_h *) p);
61 static VALUE ruby_guestfs_create (VALUE m)
65 g = guestfs_create ();
67 rb_raise (e_Error, \"failed to create guestfs handle\");
69 /* Don't print error messages to stderr by default. */
70 guestfs_set_error_handler (g, NULL, NULL);
72 /* Wrap it, and make sure the close function is called when the
75 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
78 static VALUE ruby_guestfs_close (VALUE gv)
81 Data_Get_Struct (gv, guestfs_h, g);
83 ruby_guestfs_free (g);
92 fun (name, (ret, args, optargs as style), _, _, _, _, _) ->
93 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
94 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) args;
95 (* XXX This makes the hash mandatory, meaning that you have
96 * to specify {} for no arguments. We could make it so this
97 * can be omitted. However that is a load of hassle because
98 * you have to completely change the way that arguments are
100 * http://www.redhat.com/archives/libvir-list/2008-April/msg00004.html
102 if optargs <> [] then
103 pr ", VALUE optargsv";
106 pr " guestfs_h *g;\n";
107 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
109 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
115 | Pathname n | Device n | Dev_or_Path n | String n | Key n
116 | FileIn n | FileOut n ->
117 pr " Check_Type (%sv, T_STRING);\n" n;
118 pr " const char *%s = StringValueCStr (%sv);\n" n n;
120 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
121 pr " \"%s\", \"%s\");\n" n name
123 pr " Check_Type (%sv, T_STRING);\n" n;
124 pr " const char *%s = RSTRING (%sv)->ptr;\n" n n;
126 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
127 pr " \"%s\", \"%s\");\n" n name;
128 pr " size_t %s_size = RSTRING (%sv)->len;\n" n n
130 pr " const char *%s = !NIL_P (%sv) ? StringValueCStr (%sv) : NULL;\n" n n n
131 | StringList n | DeviceList n ->
132 pr " char **%s;\n" n;
133 pr " Check_Type (%sv, T_ARRAY);\n" n;
135 pr " size_t i, len;\n";
136 pr " len = RARRAY_LEN (%sv);\n" n;
137 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (len+1));\n"
139 pr " for (i = 0; i < len; ++i) {\n";
140 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
141 pr " %s[i] = StringValueCStr (v);\n" n;
143 pr " %s[len] = NULL;\n" n;
146 pr " int %s = RTEST (%sv);\n" n n
148 pr " int %s = NUM2INT (%sv);\n" n n
150 pr " long long %s = NUM2LL (%sv);\n" n n
152 pr " %s %s = (%s) (intptr_t) NUM2LL (%sv);\n" t n t n
156 (* Optional arguments are passed in a final hash parameter. *)
157 if optargs <> [] then (
158 let uc_name = String.uppercase name in
159 pr " Check_Type (optargsv, T_HASH);\n";
160 pr " struct guestfs_%s_argv optargs_s = { .bitmask = 0 };\n" name;
161 pr " struct guestfs_%s_argv *optargs = &optargs_s;\n" name;
165 let n = name_of_argt argt in
166 let uc_n = String.uppercase n in
167 pr " v = rb_hash_lookup (optargsv, ID2SYM (rb_intern (\"%s\")));\n" n;
168 pr " if (v != Qnil) {\n";
171 pr " optargs_s.%s = RTEST (v);\n" n;
173 pr " optargs_s.%s = NUM2INT (v);\n" n;
175 pr " optargs_s.%s = NUM2LL (v);\n" n;
177 pr " Check_Type (v, T_STRING);\n";
178 pr " optargs_s.%s = StringValueCStr (v);\n" n
181 pr " optargs_s.bitmask |= GUESTFS_%s_%s_BITMASK;\n" uc_name uc_n;
188 | RErr | RInt _ | RBool _ -> pr " int r;\n"
189 | RInt64 _ -> pr " int64_t r;\n"
190 | RConstString _ | RConstOptString _ ->
191 pr " const char *r;\n"
192 | RString _ -> pr " char *r;\n"
193 | RStringList _ | RHashtable _ -> pr " char **r;\n"
194 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ
195 | RStructList (_, typ) ->
196 pr " struct guestfs_%s_list *r;\n" typ
204 pr " r = guestfs_%s " name
206 pr " r = guestfs_%s_argv " name;
207 generate_c_call_args ~handle:"g" style;
212 | Pathname _ | Device _ | Dev_or_Path _ | String _ | Key _
213 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _
214 | BufferIn _ | Pointer _ -> ()
215 | StringList n | DeviceList n ->
219 (match errcode_of_ret ret with
220 | `CannotReturnError -> ()
221 | `ErrorIsMinusOne ->
222 pr " if (r == -1)\n";
223 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n"
225 pr " if (r == NULL)\n";
226 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n"
233 | RInt _ | RBool _ ->
234 pr " return INT2NUM (r);\n"
236 pr " return ULL2NUM (r);\n"
238 pr " return rb_str_new2 (r);\n";
239 | RConstOptString _ ->
241 pr " return rb_str_new2 (r);\n";
243 pr " return Qnil;\n";
245 pr " VALUE rv = rb_str_new2 (r);\n";
249 pr " size_t i, len = 0;\n";
250 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
251 pr " VALUE rv = rb_ary_new2 (len);\n";
252 pr " for (i = 0; r[i] != NULL; ++i) {\n";
253 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
254 pr " free (r[i]);\n";
258 | RStruct (_, typ) ->
259 let cols = cols_of_struct typ in
260 generate_ruby_struct_code typ cols
261 | RStructList (_, typ) ->
262 let cols = cols_of_struct typ in
263 generate_ruby_struct_list_code typ cols
265 pr " VALUE rv = rb_hash_new ();\n";
267 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
268 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
269 pr " free (r[i]);\n";
270 pr " free (r[i+1]);\n";
275 pr " VALUE rv = rb_str_new (r, size);\n";
285 /* Initialize the module. */
286 void Init__guestfs ()
288 m_guestfs = rb_define_module (\"Guestfs\");
289 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
290 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
292 #ifdef HAVE_RB_DEFINE_ALLOC_FUNC
293 rb_define_alloc_func (c_guestfs, ruby_guestfs_create);
296 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
297 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
300 (* Define the rest of the methods. *)
302 fun (name, (_, args, optargs), _, _, _, _, _) ->
303 let nr_args = List.length args + if optargs <> [] then 1 else 0 in
304 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
305 pr " ruby_guestfs_%s, %d);\n" name nr_args
310 (* Ruby code to return a struct. *)
311 and generate_ruby_struct_code typ cols =
312 pr " VALUE rv = rb_hash_new ();\n";
316 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->%s));\n" name name
318 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, r->%s_len));\n" name name name
320 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, 32));\n" name name
321 | name, (FBytes|FUInt64) ->
322 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
324 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), LL2NUM (r->%s));\n" name name
326 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), UINT2NUM (r->%s));\n" name name
328 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), INT2NUM (r->%s));\n" name name
329 | name, FOptPercent ->
330 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->%s));\n" name name
331 | name, FChar -> (* XXX wrong? *)
332 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
334 pr " guestfs_free_%s (r);\n" typ;
337 (* Ruby code to return a struct list. *)
338 and generate_ruby_struct_list_code typ cols =
339 pr " VALUE rv = rb_ary_new2 (r->len);\n";
341 pr " for (i = 0; i < r->len; ++i) {\n";
342 pr " VALUE hv = rb_hash_new ();\n";
346 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
348 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, r->val[i].%s_len));\n" name name name
350 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
351 | name, (FBytes|FUInt64) ->
352 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
354 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), LL2NUM (r->val[i].%s));\n" name name
356 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), UINT2NUM (r->val[i].%s));\n" name name
358 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), INT2NUM (r->val[i].%s));\n" name name
359 | name, FOptPercent ->
360 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
361 | name, FChar -> (* XXX wrong? *)
362 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
364 pr " rb_ary_push (rv, hv);\n";
366 pr " guestfs_free_%s_list (r);\n" typ;