mirrors/libguestfs
1
0
Fork 0
mirror of https://github.com/libguestfs/libguestfs.git synced 2026-03-21 22:53:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

generator: Generate guestfs_user_cancel.

Browse Source 
This function is now generated, so bindings in various languages
are made automatically.

Note that the function previously returned void, but now it returns
int (although always 0).  We don't believe that this is an ABI break
since existing programs will continue to work.
This commit is contained in:
Richard W.M. Jones
2013-03-04 13:28:15 +00:00
parent ac2f6c4ef2
commit d08f5ebd9a
10 changed files with 42 additions and 108 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
generator/actions.ml
View File

@@ -2717,6 +2717,39 @@ This internal function adds E<lt>seclabel model=selinux relabel=noE<gt>
to all application disks. It is only used by the libvirt attach method
and is ignored by other attach methods." };
{ defaults with
name = "user_cancel";
style = RErr, [], [];
blocking = false; wrapper = false;
shortdesc = "cancel the current upload or download operation";
longdesc = "\
This function cancels the current upload or download operation.
Unlike most other libguestfs calls, this function is signal safe and
thread safe. You can call it from a signal handler or from another
thread, without needing to do any locking.
The transfer that was in progress (if there is one) will stop shortly
afterwards, and will return an error. The errno (see
L</guestfs_last_errno>) is set to C<EINTR>, so you can test for this
to find out if the operation was cancelled or failed because of
another error.
No cleanup is performed: for example, if a file was being uploaded
then after cancellation there may be a partially uploaded file. It is
the caller's responsibility to clean up if necessary.
There are two common places that you might call C<guestfs_user_cancel>:
In an interactive text-based program, you might call it from a
C<SIGINT> signal handler so that pressing C<^C> cancels the current
operation. (You also need to call L</guestfs_set_pgroup> so that
child processes don't receive the C<^C> signal).
In a graphical program, when the main thread is displaying a progress
bar with a cancel button, wire up the cancel button to call this
function." };
]
(* daemon_functions are any functions which cause some action

6
generator/c.ml
View File

@@ -558,10 +558,6 @@ extern GUESTFS_DLL_PUBLIC void guestfs_set_close_callback (guestfs_h *g, guestfs
extern GUESTFS_DLL_PUBLIC void guestfs_set_progress_callback (guestfs_h *g, guestfs_progress_cb cb, void *opaque)
GUESTFS_DEPRECATED_BY(\"set_event_callback\");
/* User cancellation. */
#define GUESTFS_HAVE_USER_CANCEL 1
extern GUESTFS_DLL_PUBLIC void guestfs_user_cancel (guestfs_h *g);
/* Private data area. */
#define GUESTFS_HAVE_SET_PRIVATE 1
extern GUESTFS_DLL_PUBLIC void guestfs_set_private (guestfs_h *g, const char *key, void *data);
@@ -738,7 +734,6 @@ pr "\
#define LIBGUESTFS_HAVE_DELETE_EVENT_CALLBACK 1
#define LIBGUESTFS_HAVE_SET_CLOSE_CALLBACK 1
#define LIBGUESTFS_HAVE_SET_PROGRESS_CALLBACK 1
#define LIBGUESTFS_HAVE_USER_CANCEL 1
#define LIBGUESTFS_HAVE_SET_PRIVATE 1
#define LIBGUESTFS_HAVE_GET_PRIVATE 1
#define LIBGUESTFS_HAVE_FIRST_PRIVATE 1
@@ -1833,7 +1828,6 @@ and generate_linker_script () =
"guestfs_set_private";
"guestfs_set_progress_callback";
"guestfs_set_subprocess_quit_callback";
"guestfs_user_cancel";
(* Unofficial parts of the API: the bindings code use these
* functions, so it is useful to export them.

13
generator/lua.ml
View File

@@ -292,18 +292,6 @@ free_per_handle_table (lua_State *L, guestfs_h *g)
lua_settable (L, LUA_REGISTRYINDEX);
}
/* User cancel. */
static int
guestfs_lua_user_cancel (lua_State *L)
{
struct userdata *u = get_handle (L, 1);
if (u->g)
guestfs_user_cancel (u->g);
return 0;
}
/* Set an event callback. */
static int
guestfs_lua_set_event_callback (lua_State *L)
@@ -885,7 +873,6 @@ static luaL_Reg functions[] = {
/* Methods. */
static luaL_Reg methods[] = {
{ \"close\", guestfs_lua_close },
{ \"user_cancel\", guestfs_lua_user_cancel },
{ \"set_event_callback\", guestfs_lua_set_event_callback },
{ \"delete_event_callback\", guestfs_lua_delete_event_callback },

8
generator/ocaml.ml
View File

@@ -125,10 +125,6 @@ val last_errno : t -> int
so if you want to capture the errno correctly, you must call this
in the {!Error} exception handler, before any other operation on [g]. *)
val user_cancel : t -> unit
(** Cancel current transfer. This is safe to call from OCaml signal
handlers and threads. *)
";
generate_ocaml_structure_decls ();
@@ -186,7 +182,6 @@ class guestfs : ?environment:bool -> ?close_on_exit:bool -> unit -> object
method set_event_callback : event_callback -> event list -> event_handle
method delete_event_callback : event_handle -> unit
method last_errno : unit -> int
method user_cancel : unit -> unit
method ocaml_handle : t
";
@@ -258,8 +253,6 @@ external event_to_string : event list -> string
external last_errno : t -> int = \"ocaml_guestfs_last_errno\"
external user_cancel : t -> unit = \"ocaml_guestfs_user_cancel\" \"noalloc\"
(* Give the exceptions names, so they can be raised from the C code. *)
let () =
Callback.register_exception \"ocaml_guestfs_error\" (Error \"\");
@@ -285,7 +278,6 @@ class guestfs ?environment ?close_on_exit () =
method set_event_callback = set_event_callback g
method delete_event_callback = delete_event_callback g
method last_errno () = last_errno g
method user_cancel () = user_cancel g
method ocaml_handle = g
";

11
generator/perl.ml
View File

@@ -321,12 +321,6 @@ PREINIT:
OUTPUT:
RETVAL
void
user_cancel (g)
guestfs_h *g;
PPCODE:
guestfs_user_cancel (g);
";
List.iter (
@@ -872,11 +866,6 @@ errnos:
# mkdir failed because the directory exists already.
}
=item $g->user_cancel ();
Cancel current transfer. This is safe to call from Perl signal
handlers and threads.
=cut
";

22
generator/ruby.ml
View File

@@ -403,26 +403,6 @@ get_all_event_callbacks (guestfs_h *g, size_t *len_rtn)
return r;
}
/*
* call-seq:
* g.user_cancel() -> nil
*
* Call
* +guestfs_user_cancel+[http://libguestfs.org/guestfs.3.html#guestfs_user_cancel]
* to cancel the current transfer. This is safe to call from Ruby
* signal handlers and threads.
*/
static VALUE
ruby_user_cancel (VALUE gv)
{
guestfs_h *g;
Data_Get_Struct (gv, guestfs_h, g);
if (g)
guestfs_user_cancel (g);
return Qnil;
}
";
List.iter (
@@ -731,8 +711,6 @@ Init__guestfs (void)
ruby_delete_event_callback, 1);
rb_define_module_function (m_guestfs, \"event_to_string\",
ruby_event_to_string, 1);
rb_define_method (c_guestfs, \"user_cancel\",
ruby_user_cancel, 0);
";

11
ocaml/guestfs-c.c
View File

@@ -63,7 +63,6 @@ value ocaml_guestfs_set_event_callback (value gv, value closure, value events);
value ocaml_guestfs_delete_event_callback (value gv, value eh);
value ocaml_guestfs_event_to_string (value events);
value ocaml_guestfs_last_errno (value gv);
value ocaml_guestfs_user_cancel (value gv);
/* Allocate handles and deal with finalization. */
static void
@@ -439,13 +438,3 @@ ocaml_guestfs_last_errno (value gv)
rv = Val_int (r);
CAMLreturn (rv);
}
/* NB: This is and must remain a "noalloc" function. */
value
ocaml_guestfs_user_cancel (value gv)
{
guestfs_h *g = Guestfs_val (gv);
if (g)
guestfs_user_cancel (g);
return Val_unit;
}

33
src/guestfs.pod
View File

@@ -2778,37 +2778,8 @@ progress. Currently only operations that involve uploading or
downloading data can be cancelled (technically: operations that have
C<FileIn> or C<FileOut> parameters in the generator).
=head2 guestfs_user_cancel
void guestfs_user_cancel (guestfs_h *g);
C<guestfs_user_cancel> cancels the current upload or download
operation.
Unlike most other libguestfs calls, this function is signal safe and
thread safe. You can call it from a signal handler or from another
thread, without needing to do any locking.
The transfer that was in progress (if there is one) will stop shortly
afterwards, and will return an error. The errno (see
L</guestfs_last_errno>) is set to C<EINTR>, so you can test for this
to find out if the operation was cancelled or failed because of
another error.
No cleanup is performed: for example, if a file was being uploaded
then after cancellation there may be a partially uploaded file. It is
the caller's responsibility to clean up if necessary.
There are two common places that you might call C<guestfs_user_cancel>.
In an interactive text-based program, you might call it from a
C<SIGINT> signal handler so that pressing C<^C> cancels the current
operation. (You also need to call L</guestfs_set_pgroup> so that
child processes don't receive the C<^C> signal).
In a graphical program, when the main thread is displaying a progress
bar with a cancel button, wire up the cancel button to call this
function.
To cancel the transfer, call L</guestfs_user_cancel>. For more
information, read the description of L</guestfs_user_cancel>.
=head1 PRIVATE DATA AREA

6
src/handle.c
View File

@@ -394,12 +394,6 @@ close_handles (void)
while (handles) guestfs_close (handles);
}
void
guestfs_user_cancel (guestfs_h *g)
{
g->user_cancel = 1;
}
int
guestfs__set_verbose (guestfs_h *g, int v)
{

7
src/proto.c
View File

@@ -1219,3 +1219,10 @@ receive_file_data (guestfs_h *g, void **buf_r)
return chunk.data.data_len;
}
int
guestfs_user_cancel (guestfs_h *g)
{
g->user_cancel = 1;
return 0;
}