luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-01-11 23:16:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fixup GSubprocess documentation bits

Browse Source
This commit is contained in:
Ryan Lortie 2013-10-17 15:01:42 -04:00
parent 9318d5a429
commit 542ad4db03
5 changed files with 277 additions and 144 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/reference/gio/Makefile.am
View File

@ -69,6 +69,7 @@ IGNORE_HFILES = \
gsocks4aproxy.h \ gsocks4aproxy.h \
gsocks4proxy.h \ gsocks4proxy.h \
gsocks5proxy.h \ gsocks5proxy.h \
gsubprocesslauncher-private.h \
gthreadedresolver.h \ gthreadedresolver.h \
gunionvolumemonitor.h \ gunionvolumemonitor.h \
gunixmount.h \ gunixmount.h \

38
docs/reference/gio/gio-sections.txt
View File

@ -4081,18 +4081,20 @@ g_simple_proxy_resolver_get_type
<FILE>gsubprocess</FILE> <FILE>gsubprocess</FILE>
<TITLE>GSubprocess</TITLE> <TITLE>GSubprocess</TITLE>
GSubprocess GSubprocess
GSubprocessFlags
g_subprocess_new g_subprocess_new
g_subprocess_newv g_subprocess_newv
g_subprocess_get_identifier
<SUBSECTION IO> <SUBSECTION IO>
g_subprocess_get_stdin_pipe g_subprocess_get_stdin_pipe
g_subprocess_get_stdout_pipe g_subprocess_get_stdout_pipe
g_subprocess_get_stderr_pipe g_subprocess_get_stderr_pipe
<SUBSECTION Waiting> <SUBSECTION Waiting>
g_subprocess_wait g_subprocess_wait
g_subprocess_wait_sync g_subprocess_wait_async
g_subprocess_wait_finish g_subprocess_wait_finish
g_subprocess_wait_check g_subprocess_wait_check
g_subprocess_wait_check_sync g_subprocess_wait_check_async
g_subprocess_wait_check_finish g_subprocess_wait_check_finish
<SUBSECTION Status> <SUBSECTION Status>
g_subprocess_get_successful g_subprocess_get_successful
@ -4104,10 +4106,40 @@ g_subprocess_get_status
<SUBSECTION Control> <SUBSECTION Control>
g_subprocess_send_signal g_subprocess_send_signal
g_subprocess_force_exit g_subprocess_force_exit
<SUBSECTION communicate>
g_subprocess_communicate
g_subprocess_communicate_async
g_subprocess_communicate_finish
g_subprocess_communicate_utf8
g_subprocess_communicate_utf8_async
g_subprocess_communicate_utf8_finish
<SUBSECTION Launcher>
g_subprocess_launcher_getenv
g_subprocess_launcher_new
g_subprocess_launcher_set_child_setup
g_subprocess_launcher_set_cwd
g_subprocess_launcher_set_environ
g_subprocess_launcher_set_flags
g_subprocess_launcher_set_stderr_file_path
g_subprocess_launcher_set_stdin_file_path
g_subprocess_launcher_set_stdout_file_path
g_subprocess_launcher_setenv
g_subprocess_launcher_spawn
g_subprocess_launcher_spawnv
g_subprocess_launcher_take_fd
g_subprocess_launcher_take_stderr_fd
g_subprocess_launcher_take_stdin_fd
g_subprocess_launcher_take_stdout_fd
g_subprocess_launcher_unsetenv
<SUBSECTION Standard> <SUBSECTION Standard>
GSubprocessLauncher
G_IS_SUBPROCESS G_IS_SUBPROCESS
G_TYPE_SUBPROCESS G_TYPE_SUBPROCESS
G_SUBPROCESS G_SUBPROCESS
<SUBSECTION Private>
g_subprocess_get_type g_subprocess_get_type
G_IS_SUBPROCESS_LAUNCHER
G_SUBPROCESS_LAUNCHER
G_TYPE_SUBPROCESS_FLAGS
G_TYPE_SUBPROCESS_LAUNCHER
g_subprocess_launcher_get_type
</SECTION> </SECTION>

343
gio/gsubprocess.c
View File

@ -1,7 +1,7 @@
/* GIO - GLib Input, Output and Streaming Library /* GIO - GLib Input, Output and Streaming Library
* *
* Copyright © 2012 Red Hat, Inc. * Copyright © 2012, 2013 Red Hat, Inc.
* Copyright © 2012-2013 Canonical Limited * Copyright © 2012, 2013 Canonical Limited
* *
* This program is free software: you can redistribute it and/or modify * This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published * it under the terms of the GNU Lesser General Public License as published
@ -76,7 +76,7 @@
* checked using functions such as g_subprocess_get_if_exited() (which * checked using functions such as g_subprocess_get_if_exited() (which
* are similar to the familiar WIFEXITED-style POSIX macros). * are similar to the familiar WIFEXITED-style POSIX macros).
* *
* Since: 2.36 * Since: 2.40
**/ **/
#include "config.h" #include "config.h"
@ -602,7 +602,7 @@ g_subprocess_class_init (GSubprocessClass *class)
* Returns: A newly created #GSubprocess, or %NULL on error (and @error * Returns: A newly created #GSubprocess, or %NULL on error (and @error
* will be set) * will be set)
* *
* Since: 2.36 * Since: 2.40
*/ */
GSubprocess * GSubprocess *
g_subprocess_new (GSubprocessFlags flags, g_subprocess_new (GSubprocessFlags flags,
@ -643,7 +643,7 @@ g_subprocess_new (GSubprocessFlags flags,
* Returns: A newly created #GSubprocess, or %NULL on error (and @error * Returns: A newly created #GSubprocess, or %NULL on error (and @error
* will be set) * will be set)
* *
* Since: 2.36 * Since: 2.40
* Rename to: g_subprocess_new * Rename to: g_subprocess_new
*/ */
GSubprocess * GSubprocess *
@ -660,41 +660,83 @@ g_subprocess_newv (const gchar * const *argv,
} }
const gchar * const gchar *
g_subprocess_get_identifier (GSubprocess *self) g_subprocess_get_identifier (GSubprocess *subprocess)
{ {
g_return_val_if_fail (G_IS_SUBPROCESS (self), NULL); g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), NULL);
if (self->pid) if (subprocess->pid)
return self->identifier; return subprocess->identifier;
else else
return NULL; return NULL;
} }
/**
* g_subprocess_get_stdin_pipe:
* @subprocess: a #GSubprocess
*
* Gets the #GOutputStream that you can write to in order to give data
* to the stdin of @subprocess.
*
* The process must have been created with
* %G_SUBPROCESS_FLAGS_STDIN_PIPE.
*
* Returns: the stdout pipe
*
* Since: 2.40
**/
GOutputStream * GOutputStream *
g_subprocess_get_stdin_pipe (GSubprocess *self) g_subprocess_get_stdin_pipe (GSubprocess *subprocess)
{ {
g_return_val_if_fail (G_IS_SUBPROCESS (self), NULL); g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), NULL);
g_return_val_if_fail (self->stdin_pipe, NULL); g_return_val_if_fail (subprocess->stdin_pipe, NULL);
return self->stdin_pipe; return subprocess->stdin_pipe;
} }
/**
* g_subprocess_get_stdout_pipe:
* @subprocess: a #GSubprocess
*
* Gets the #GInputStream from which to read the stdout output of
* @subprocess.
*
* The process must have been created with
* %G_SUBPROCESS_FLAGS_STDOUT_PIPE.
*
* Returns: the stdout pipe
*
* Since: 2.40
**/
GInputStream * GInputStream *
g_subprocess_get_stdout_pipe (GSubprocess *self) g_subprocess_get_stdout_pipe (GSubprocess *subprocess)
{ {
g_return_val_if_fail (G_IS_SUBPROCESS (self), NULL); g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), NULL);
g_return_val_if_fail (self->stdout_pipe, NULL); g_return_val_if_fail (subprocess->stdout_pipe, NULL);
return self->stdout_pipe; return subprocess->stdout_pipe;
} }
/**
* g_subprocess_get_stderr_pipe:
* @subprocess: a #GSubprocess
*
* Gets the #GInputStream from which to read the stderr output of
* @subprocess.
*
* The process must have been created with
* %G_SUBPROCESS_FLAGS_STDERR_PIPE.
*
* Returns: the stderr pipe
*
* Since: 2.40
**/
GInputStream * GInputStream *
g_subprocess_get_stderr_pipe (GSubprocess *self) g_subprocess_get_stderr_pipe (GSubprocess *subprocess)
{ {
g_return_val_if_fail (G_IS_SUBPROCESS (self), NULL); g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), NULL);
g_return_val_if_fail (self->stderr_pipe, NULL); g_return_val_if_fail (subprocess->stderr_pipe, NULL);
return self->stderr_pipe; return subprocess->stderr_pipe;
} }
static void static void
@ -714,18 +756,31 @@ g_subprocess_wait_cancelled (GCancellable *cancellable,
g_object_unref (task); g_object_unref (task);
} }
/**
* g_subprocess_wait_async:
* @subprocess: a #GSubprocess
* @cancellable: a #GCancellable, or %NULL
* @callback: a #GAsyncReadyCallback to call when the operation is complete
* @user_data: user_data for @callback
*
* Wait for the subprocess to terminate.
*
* This is the asynchronous version of g_subprocess_wait().
*
* Since: 2.40
*/
void void
g_subprocess_wait_async (GSubprocess *self, g_subprocess_wait_async (GSubprocess *subprocess,
GCancellable *cancellable, GCancellable *cancellable,
GAsyncReadyCallback callback, GAsyncReadyCallback callback,
gpointer user_data) gpointer user_data)
{ {
GTask *task; GTask *task;
task = g_task_new (self, cancellable, callback, user_data); task = g_task_new (subprocess, cancellable, callback, user_data);
g_mutex_lock (&self->pending_waits_lock); g_mutex_lock (&subprocess->pending_waits_lock);
if (self->pid) if (subprocess->pid)
{ {
/* Only bother with cancellable if we're putting it in the list. /* Only bother with cancellable if we're putting it in the list.
* If not, it's going to dispatch immediately anyway and we will * If not, it's going to dispatch immediately anyway and we will
@ -734,10 +789,10 @@ g_subprocess_wait_async (GSubprocess *self,
if (cancellable) if (cancellable)
g_signal_connect_object (cancellable, "cancelled", G_CALLBACK (g_subprocess_wait_cancelled), task, 0); g_signal_connect_object (cancellable, "cancelled", G_CALLBACK (g_subprocess_wait_cancelled), task, 0);
self->pending_waits = g_slist_prepend (self->pending_waits, task); subprocess->pending_waits = g_slist_prepend (subprocess->pending_waits, task);
task = NULL; task = NULL;
} }
g_mutex_unlock (&self->pending_waits_lock); g_mutex_unlock (&subprocess->pending_waits_lock);
/* If we still have task then it's because did_exit is already TRUE */ /* If we still have task then it's because did_exit is already TRUE */
if (task != NULL) if (task != NULL)
@ -747,8 +802,21 @@ g_subprocess_wait_async (GSubprocess *self,
} }
} }
/**
* g_subprocess_wait_finish:
* @subprocess: a #GSubprocess
* @result: the #GAsyncResult passed to your #GAsyncReadyCallback
* @error: a pointer to a %NULL #GError, or %NULL
*
* Collects the result of a previous call to
* g_subprocess_wait_async().
*
* Returns: %TRUE if successful, or %FALSE with @error set
*
* Since: 2.40
*/
gboolean gboolean
g_subprocess_wait_finish (GSubprocess *self, g_subprocess_wait_finish (GSubprocess *subprocess,
GAsyncResult *result, GAsyncResult *result,
GError **error) GError **error)
{ {
@ -788,28 +856,32 @@ g_subprocess_sync_complete (GAsyncResult **result)
/** /**
* g_subprocess_wait: * g_subprocess_wait:
* @self: a #GSubprocess * @subprocess: a #GSubprocess
* @cancellable: a #GCancellable * @cancellable: a #GCancellable
* @error: a #GError * @error: a #GError
* *
* Synchronously wait for the subprocess to terminate, returning the * Synchronously wait for the subprocess to terminate.
* status code in @out_exit_status. See the documentation of *
* g_spawn_check_exit_status() for how to interpret it. Note that if * After the process terminates you can query its exit status with
* @error is set, then @out_exit_status will be left uninitialized. * functions such as g_subprocess_get_if_exited() and
* g_subprocess_get_exit_status().
*
* This function does not fail in the case of the subprocess having
* abnormal termination. See g_subprocess_wait_check() for that.
* *
* Returns: %TRUE on success, %FALSE if @cancellable was cancelled * Returns: %TRUE on success, %FALSE if @cancellable was cancelled
* *
* Since: 2.36 * Since: 2.40
*/ */
gboolean gboolean
g_subprocess_wait (GSubprocess *self, g_subprocess_wait (GSubprocess *subprocess,
GCancellable *cancellable, GCancellable *cancellable,
GError **error) GError **error)
{ {
GAsyncResult *result = NULL; GAsyncResult *result = NULL;
gboolean success; gboolean success;
g_return_val_if_fail (G_IS_SUBPROCESS (self), FALSE); g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), FALSE);
/* Synchronous waits are actually the 'more difficult' case because we /* Synchronous waits are actually the 'more difficult' case because we
* need to deal with the possibility of cancellation. That more or * need to deal with the possibility of cancellation. That more or
@ -825,56 +897,83 @@ g_subprocess_wait (GSubprocess *self,
/* We can shortcut in the case that the process already quit (but only /* We can shortcut in the case that the process already quit (but only
* after we checked the cancellable). * after we checked the cancellable).
*/ */
if (self->pid == 0) if (subprocess->pid == 0)
return TRUE; return TRUE;
/* Otherwise, we need to do this the long way... */ /* Otherwise, we need to do this the long way... */
g_subprocess_sync_setup (); g_subprocess_sync_setup ();
g_subprocess_wait_async (self, cancellable, g_subprocess_sync_done, &result); g_subprocess_wait_async (subprocess, cancellable, g_subprocess_sync_done, &result);
g_subprocess_sync_complete (&result); g_subprocess_sync_complete (&result);
success = g_subprocess_wait_finish (self, result, error); success = g_subprocess_wait_finish (subprocess, result, error);
g_object_unref (result); g_object_unref (result);
return success; return success;
} }
/** /**
* g_subprocess_wait_sync_check: * g_subprocess_wait_check:
* @self: a #GSubprocess * @subprocess: a #GSubprocess
* @cancellable: a #GCancellable * @cancellable: a #GCancellable
* @error: a #GError * @error: a #GError
* *
* Combines g_subprocess_wait_sync() with g_spawn_check_exit_status(). * Combines g_subprocess_wait() with g_spawn_check_exit_status().
* *
* Returns: %TRUE on success, %FALSE if process exited abnormally, or @cancellable was cancelled * Returns: %TRUE on success, %FALSE if process exited abnormally, or
* @cancellable was cancelled
* *
* Since: 2.36 * Since: 2.40
*/ */
gboolean gboolean
g_subprocess_wait_check (GSubprocess *self, g_subprocess_wait_check (GSubprocess *subprocess,
GCancellable *cancellable, GCancellable *cancellable,
GError **error) GError **error)
{ {
return g_subprocess_wait (self, cancellable, error) && return g_subprocess_wait (subprocess, cancellable, error) &&
g_spawn_check_exit_status (self->status, error); g_spawn_check_exit_status (subprocess->status, error);
} }
/**
* g_subprocess_wait_check_async:
* @subprocess: a #GSubprocess
* @cancellable: a #GCancellable, or %NULL
* @callback: a #GAsyncReadyCallback to call when the operation is complete
* @user_data: user_data for @callback
*
* Combines g_subprocess_wait_async() with g_spawn_check_exit_status().
*
* This is the asynchronous version of g_subprocess_wait_check().
*
* Since: 2.40
*/
void void
g_subprocess_wait_check_async (GSubprocess *self, g_subprocess_wait_check_async (GSubprocess *subprocess,
GCancellable *cancellable, GCancellable *cancellable,
GAsyncReadyCallback callback, GAsyncReadyCallback callback,
gpointer user_data) gpointer user_data)
{ {
g_subprocess_wait_async (self, cancellable, callback, user_data); g_subprocess_wait_async (subprocess, cancellable, callback, user_data);
} }
/**
* g_subprocess_wait_check_finish:
* @subprocess: a #GSubprocess
* @result: the #GAsyncResult passed to your #GAsyncReadyCallback
* @error: a pointer to a %NULL #GError, or %NULL
*
* Collects the result of a previous call to
* g_subprocess_wait_check_async().
*
* Returns: %TRUE if successful, or %FALSE with @error set
*
* Since: 2.40
*/
gboolean gboolean
g_subprocess_wait_check_finish (GSubprocess *self, g_subprocess_wait_check_finish (GSubprocess *subprocess,
GAsyncResult *result, GAsyncResult *result,
GError **error) GError **error)
{ {
return g_subprocess_wait_finish (self, result, error) && return g_subprocess_wait_finish (subprocess, result, error) &&
g_spawn_check_exit_status (self->status, error); g_spawn_check_exit_status (subprocess->status, error);
} }
#ifdef G_OS_UNIX #ifdef G_OS_UNIX
@ -903,12 +1002,12 @@ g_subprocess_actually_send_signal (gpointer user_data)
} }
static void static void
g_subprocess_dispatch_signal (GSubprocess *self, g_subprocess_dispatch_signal (GSubprocess *subprocess,
gint signalnum) gint signalnum)
{ {
SignalRecord signal_record = { g_object_ref (self), signalnum }; SignalRecord signal_record = { g_object_ref (subprocess), signalnum };
g_return_if_fail (G_IS_SUBPROCESS (self)); g_return_if_fail (G_IS_SUBPROCESS (subprocess));
/* This MUST be a lower priority than the priority that the child /* This MUST be a lower priority than the priority that the child
* watch source uses in initable_init(). * watch source uses in initable_init().
@ -930,7 +1029,7 @@ g_subprocess_dispatch_signal (GSubprocess *self,
/** /**
* g_subprocess_send_signal: * g_subprocess_send_signal:
* @self: a #GSubprocess * @subprocess: a #GSubprocess
* @signal_num: the signal number to send * @signal_num: the signal number to send
* *
* Sends the UNIX signal @signal_num to the subprocess, if it is still * Sends the UNIX signal @signal_num to the subprocess, if it is still
@ -941,21 +1040,21 @@ g_subprocess_dispatch_signal (GSubprocess *self,
* *
* This API is not available on Windows. * This API is not available on Windows.
* *
* Since: 2.36 * Since: 2.40
**/ **/
void void
g_subprocess_send_signal (GSubprocess *self, g_subprocess_send_signal (GSubprocess *subprocess,
gint signal_num) gint signal_num)
{ {
g_return_if_fail (G_IS_SUBPROCESS (self)); g_return_if_fail (G_IS_SUBPROCESS (subprocess));
g_subprocess_dispatch_signal (self, signal_num); g_subprocess_dispatch_signal (subprocess, signal_num);
} }
#endif #endif
/** /**
* g_subprocess_force_exit: * g_subprocess_force_exit:
* @self: a #GSubprocess * @subprocess: a #GSubprocess
* *
* Use an operating-system specific method to attempt an immediate, * Use an operating-system specific method to attempt an immediate,
* forceful termination of the process. There is no mechanism to * forceful termination of the process. There is no mechanism to
@ -965,23 +1064,23 @@ g_subprocess_send_signal (GSubprocess *self,
* *
* On Unix, this function sends %SIGKILL. * On Unix, this function sends %SIGKILL.
* *
* Since: 2.36 * Since: 2.40
**/ **/
void void
g_subprocess_force_exit (GSubprocess *self) g_subprocess_force_exit (GSubprocess *subprocess)
{ {
g_return_if_fail (G_IS_SUBPROCESS (self)); g_return_if_fail (G_IS_SUBPROCESS (subprocess));
#ifdef G_OS_UNIX #ifdef G_OS_UNIX
g_subprocess_dispatch_signal (self, SIGKILL); g_subprocess_dispatch_signal (subprocess, SIGKILL);
#else #else
TerminateProcess (self->pid, 1); TerminateProcess (subprocess->pid, 1);
#endif #endif
} }
/** /**
* g_subprocess_get_status: * g_subprocess_get_status:
* @self: a #GSubprocess * @subprocess: a #GSubprocess
* *
* Gets the raw status code of the process, as from waitpid(). * Gets the raw status code of the process, as from waitpid().
* *
@ -997,20 +1096,20 @@ g_subprocess_force_exit (GSubprocess *self)
* *
* Returns: the (meaningless) waitpid() exit status from the kernel * Returns: the (meaningless) waitpid() exit status from the kernel
* *
* Since: 2.36 * Since: 2.40
**/ **/
gint gint
g_subprocess_get_status (GSubprocess *self) g_subprocess_get_status (GSubprocess *subprocess)
{ {
g_return_val_if_fail (G_IS_SUBPROCESS (self), FALSE); g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), FALSE);
g_return_val_if_fail (self->pid == 0, FALSE); g_return_val_if_fail (subprocess->pid == 0, FALSE);
return self->status; return subprocess->status;
} }
/** /**
* g_subprocess_get_successful: * g_subprocess_get_successful:
* @self: a #GSubprocess * @subprocess: a #GSubprocess
* *
* Checks if the process was "successful". A process is considered * Checks if the process was "successful". A process is considered
* successful if it exited cleanly with an exit status of 0, either by * successful if it exited cleanly with an exit status of 0, either by
@ -1021,20 +1120,20 @@ g_subprocess_get_status (GSubprocess *self)
* *
* Returns: %TRUE if the process exited cleanly with a exit status of 0 * Returns: %TRUE if the process exited cleanly with a exit status of 0
* *
* Since: 2.36 * Since: 2.40
**/ **/
gboolean gboolean
g_subprocess_get_successful (GSubprocess *self) g_subprocess_get_successful (GSubprocess *subprocess)
{ {
g_return_val_if_fail (G_IS_SUBPROCESS (self), FALSE); g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), FALSE);
g_return_val_if_fail (self->pid == 0, FALSE); g_return_val_if_fail (subprocess->pid == 0, FALSE);
return WIFEXITED (self->status) && WEXITSTATUS (self->status) == 0; return WIFEXITED (subprocess->status) && WEXITSTATUS (subprocess->status) == 0;
} }
/** /**
* g_subprocess_get_if_exited: * g_subprocess_get_if_exited:
* @self: a #GSubprocess * @subprocess: a #GSubprocess
* *
* Check if the given subprocess exited normally (ie: by way of exit() * Check if the given subprocess exited normally (ie: by way of exit()
* or return from main()). * or return from main()).
@ -1046,20 +1145,20 @@ g_subprocess_get_successful (GSubprocess *self)
* *
* Returns: %TRUE if the case of a normal exit * Returns: %TRUE if the case of a normal exit
* *
* Since: 2.36 * Since: 2.40
**/ **/
gboolean gboolean
g_subprocess_get_if_exited (GSubprocess *self) g_subprocess_get_if_exited (GSubprocess *subprocess)
{ {
g_return_val_if_fail (G_IS_SUBPROCESS (self), FALSE); g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), FALSE);
g_return_val_if_fail (self->pid == 0, FALSE); g_return_val_if_fail (subprocess->pid == 0, FALSE);
return WIFEXITED (self->status); return WIFEXITED (subprocess->status);
} }
/** /**
* g_subprocess_get_exit_status: * g_subprocess_get_exit_status:
* @self: a #GSubprocess * @subprocess: a #GSubprocess
* *
* Check the exit status of the subprocess, given that it exited * Check the exit status of the subprocess, given that it exited
* normally. This is the value passed to the exit() system call or the * normally. This is the value passed to the exit() system call or the
@ -1072,21 +1171,21 @@ g_subprocess_get_if_exited (GSubprocess *self)
* *
* Returns: the exit status * Returns: the exit status
* *
* Since: 2.36 * Since: 2.40
**/ **/
gint gint
g_subprocess_get_exit_status (GSubprocess *self) g_subprocess_get_exit_status (GSubprocess *subprocess)
{ {
g_return_val_if_fail (G_IS_SUBPROCESS (self), 1); g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), 1);
g_return_val_if_fail (self->pid == 0, 1); g_return_val_if_fail (subprocess->pid == 0, 1);
g_return_val_if_fail (WIFEXITED (self->status), 1); g_return_val_if_fail (WIFEXITED (subprocess->status), 1);
return WEXITSTATUS (self->status); return WEXITSTATUS (subprocess->status);
} }
/** /**
* g_subprocess_get_if_signaled: * g_subprocess_get_if_signaled:
* @self: a #GSubprocess * @subprocess: a #GSubprocess
* *
* Check if the given subprocess terminated in response to a signal. * Check if the given subprocess terminated in response to a signal.
* *
@ -1097,20 +1196,20 @@ g_subprocess_get_exit_status (GSubprocess *self)
* *
* Returns: %TRUE if the case of termination due to a signal * Returns: %TRUE if the case of termination due to a signal
* *
* Since: 2.36 * Since: 2.40
**/ **/
gboolean gboolean
g_subprocess_get_if_signaled (GSubprocess *self) g_subprocess_get_if_signaled (GSubprocess *subprocess)
{ {
g_return_val_if_fail (G_IS_SUBPROCESS (self), FALSE); g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), FALSE);
g_return_val_if_fail (self->pid == 0, FALSE); g_return_val_if_fail (subprocess->pid == 0, FALSE);
return WIFSIGNALED (self->status); return WIFSIGNALED (subprocess->status);
} }
/** /**
* g_subprocess_get_term_sig: * g_subprocess_get_term_sig:
* @self: a #GSubprocess * @subprocess: a #GSubprocess
* *
* Get the signal number that caused the subprocess to terminate, given * Get the signal number that caused the subprocess to terminate, given
* that it terminated due to a signal. * that it terminated due to a signal.
@ -1122,16 +1221,16 @@ g_subprocess_get_if_signaled (GSubprocess *self)
* *
* Returns: the signal causing termination * Returns: the signal causing termination
* *
* Since: 2.36 * Since: 2.40
**/ **/
gint gint
g_subprocess_get_term_sig (GSubprocess *self) g_subprocess_get_term_sig (GSubprocess *subprocess)
{ {
g_return_val_if_fail (G_IS_SUBPROCESS (self), 0); g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), 0);
g_return_val_if_fail (self->pid == 0, 0); g_return_val_if_fail (subprocess->pid == 0, 0);
g_return_val_if_fail (WIFSIGNALED (self->status), 0); g_return_val_if_fail (WIFSIGNALED (subprocess->status), 0);
return WTERMSIG (self->status); return WTERMSIG (subprocess->status);
} }
/*< private >*/ /*< private >*/
@ -1371,7 +1470,7 @@ g_subprocess_communicate_internal (GSubprocess *subprocess,
/** /**
* g_subprocess_communicate: * g_subprocess_communicate:
* @self: a #GSubprocess * @subprocess: a #GSubprocess
* @stdin_buf: data to send to the stdin of the subprocess, or %NULL * @stdin_buf: data to send to the stdin of the subprocess, or %NULL
* @cancellable: a #GCancellable * @cancellable: a #GCancellable
* @stdout_buf: (out): data read from the subprocess stdout * @stdout_buf: (out): data read from the subprocess stdout
@ -1518,7 +1617,7 @@ g_subprocess_communicate_finish (GSubprocess *subprocess,
/** /**
* g_subprocess_communicate_utf8: * g_subprocess_communicate_utf8:
* @self: a #GSubprocess * @subprocess: a #GSubprocess
* @stdin_buf: data to send to the stdin of the subprocess, or %NULL * @stdin_buf: data to send to the stdin of the subprocess, or %NULL
* @cancellable: a #GCancellable * @cancellable: a #GCancellable
* @stdout_buf: (out): data read from the subprocess stdout * @stdout_buf: (out): data read from the subprocess stdout
@ -1529,12 +1628,12 @@ g_subprocess_communicate_finish (GSubprocess *subprocess,
* process as UTF-8, and returns it as a regular NUL terminated string. * process as UTF-8, and returns it as a regular NUL terminated string.
*/ */
gboolean gboolean
g_subprocess_communicate_utf8 (GSubprocess *subprocess, g_subprocess_communicate_utf8 (GSubprocess *subprocess,
const char *stdin_buf, const char *stdin_buf,
GCancellable *cancellable, GCancellable *cancellable,
char **stdout_buf, char **stdout_buf,
char **stderr_buf, char **stderr_buf,
GError **error) GError **error)
{ {
GAsyncResult *result = NULL; GAsyncResult *result = NULL;
gboolean success; gboolean success;
@ -1570,11 +1669,11 @@ g_subprocess_communicate_utf8 (GSubprocess *subprocess,
* invocation with g_subprocess_communicate_utf8_finish(). * invocation with g_subprocess_communicate_utf8_finish().
*/ */
void void
g_subprocess_communicate_utf8_async (GSubprocess *subprocess, g_subprocess_communicate_utf8_async (GSubprocess *subprocess,
const char *stdin_buf, const char *stdin_buf,
GCancellable *cancellable, GCancellable *cancellable,
GAsyncReadyCallback callback, GAsyncReadyCallback callback,
gpointer user_data) gpointer user_data)
{ {
GBytes *stdin_bytes; GBytes *stdin_bytes;
@ -1627,11 +1726,11 @@ communicate_result_validate_utf8 (const char *stream_name,
* Complete an invocation of g_subprocess_communicate_utf8_async(). * Complete an invocation of g_subprocess_communicate_utf8_async().
*/ */
gboolean gboolean
g_subprocess_communicate_utf8_finish (GSubprocess *subprocess, g_subprocess_communicate_utf8_finish (GSubprocess *subprocess,
GAsyncResult *result, GAsyncResult *result,
char **stdout_buf, char **stdout_buf,
char **stderr_buf, char **stderr_buf,
GError **error) GError **error)
{ {
gboolean ret = FALSE; gboolean ret = FALSE;
CommunicateState *state; CommunicateState *state;

36
gio/gsubprocess.h
View File

@ -51,76 +51,76 @@ GSubprocess * g_subprocess_newv (const gchar * const *a
GError **error); GError **error);
GLIB_AVAILABLE_IN_2_40 GLIB_AVAILABLE_IN_2_40
GOutputStream * g_subprocess_get_stdin_pipe (GSubprocess *self); GOutputStream * g_subprocess_get_stdin_pipe (GSubprocess *subprocess);
GLIB_AVAILABLE_IN_2_40 GLIB_AVAILABLE_IN_2_40
GInputStream * g_subprocess_get_stdout_pipe (GSubprocess *self); GInputStream * g_subprocess_get_stdout_pipe (GSubprocess *subprocess);
GLIB_AVAILABLE_IN_2_40 GLIB_AVAILABLE_IN_2_40
GInputStream * g_subprocess_get_stderr_pipe (GSubprocess *self); GInputStream * g_subprocess_get_stderr_pipe (GSubprocess *subprocess);
GLIB_AVAILABLE_IN_2_40 GLIB_AVAILABLE_IN_2_40
const gchar * g_subprocess_get_identifier (GSubprocess *self); const gchar * g_subprocess_get_identifier (GSubprocess *subprocess);
#ifdef G_OS_UNIX #ifdef G_OS_UNIX
GLIB_AVAILABLE_IN_2_40 GLIB_AVAILABLE_IN_2_40
void g_subprocess_send_signal (GSubprocess *self, void g_subprocess_send_signal (GSubprocess *subprocess,
gint signal_num); gint signal_num);
#endif #endif
GLIB_AVAILABLE_IN_2_40 GLIB_AVAILABLE_IN_2_40
void g_subprocess_force_exit (GSubprocess *self); void g_subprocess_force_exit (GSubprocess *subprocess);
GLIB_AVAILABLE_IN_2_40 GLIB_AVAILABLE_IN_2_40
gboolean g_subprocess_wait (GSubprocess *self, gboolean g_subprocess_wait (GSubprocess *subprocess,
GCancellable *cancellable, GCancellable *cancellable,
GError **error); GError **error);
GLIB_AVAILABLE_IN_2_40 GLIB_AVAILABLE_IN_2_40
void g_subprocess_wait_async (GSubprocess *self, void g_subprocess_wait_async (GSubprocess *subprocess,
GCancellable *cancellable, GCancellable *cancellable,
GAsyncReadyCallback callback, GAsyncReadyCallback callback,
gpointer user_data); gpointer user_data);
GLIB_AVAILABLE_IN_2_40 GLIB_AVAILABLE_IN_2_40
gboolean g_subprocess_wait_finish (GSubprocess *self, gboolean g_subprocess_wait_finish (GSubprocess *subprocess,
GAsyncResult *result, GAsyncResult *result,
GError **error); GError **error);
GLIB_AVAILABLE_IN_2_40 GLIB_AVAILABLE_IN_2_40
gboolean g_subprocess_wait_check (GSubprocess *self, gboolean g_subprocess_wait_check (GSubprocess *subprocess,
GCancellable *cancellable, GCancellable *cancellable,
GError **error); GError **error);
GLIB_AVAILABLE_IN_2_40 GLIB_AVAILABLE_IN_2_40
void g_subprocess_wait_check_async (GSubprocess *self, void g_subprocess_wait_check_async (GSubprocess *subprocess,
GCancellable *cancellable, GCancellable *cancellable,
GAsyncReadyCallback callback, GAsyncReadyCallback callback,
gpointer user_data); gpointer user_data);
GLIB_AVAILABLE_IN_2_40 GLIB_AVAILABLE_IN_2_40
gboolean g_subprocess_wait_check_finish (GSubprocess *self, gboolean g_subprocess_wait_check_finish (GSubprocess *subprocess,
GAsyncResult *result, GAsyncResult *result,
GError **error); GError **error);
GLIB_AVAILABLE_IN_2_40 GLIB_AVAILABLE_IN_2_40
gint g_subprocess_get_status (GSubprocess *self); gint g_subprocess_get_status (GSubprocess *subprocess);
GLIB_AVAILABLE_IN_2_40 GLIB_AVAILABLE_IN_2_40
gboolean g_subprocess_get_successful (GSubprocess *self); gboolean g_subprocess_get_successful (GSubprocess *subprocess);
GLIB_AVAILABLE_IN_2_40 GLIB_AVAILABLE_IN_2_40
gboolean g_subprocess_get_if_exited (GSubprocess *self); gboolean g_subprocess_get_if_exited (GSubprocess *subprocess);
GLIB_AVAILABLE_IN_2_40 GLIB_AVAILABLE_IN_2_40
gint g_subprocess_get_exit_status (GSubprocess *self); gint g_subprocess_get_exit_status (GSubprocess *subprocess);
GLIB_AVAILABLE_IN_2_40 GLIB_AVAILABLE_IN_2_40
gboolean g_subprocess_get_if_signaled (GSubprocess *self); gboolean g_subprocess_get_if_signaled (GSubprocess *subprocess);
GLIB_AVAILABLE_IN_2_40 GLIB_AVAILABLE_IN_2_40
gint g_subprocess_get_term_sig (GSubprocess *self); gint g_subprocess_get_term_sig (GSubprocess *subprocess);
GLIB_AVAILABLE_IN_2_40 GLIB_AVAILABLE_IN_2_40
gboolean g_subprocess_communicate (GSubprocess *subprocess, gboolean g_subprocess_communicate (GSubprocess *subprocess,

3
gio/gsubprocesslauncher.c
View File

@ -199,6 +199,7 @@ g_subprocess_launcher_class_init (GSubprocessLauncherClass *class)
/** /**
* g_subprocess_launcher_new: * g_subprocess_launcher_new:
* @flags: #GSubprocessFlags
* *
* Creates a new #GSubprocessLauncher. * Creates a new #GSubprocessLauncher.
* *
@ -275,7 +276,7 @@ g_subprocess_launcher_setenv (GSubprocessLauncher *self,
} }
/** /**
* g_subprocess_launcher_unsetsenv: * g_subprocess_launcher_unsetenv:
* @self: a #GSubprocess * @self: a #GSubprocess
* @variable: the environment variable to unset, must not contain '=' * @variable: the environment variable to unset, must not contain '='
* *