luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-26 07:26:15 +01:00
Code Issues Packages Projects Releases Wiki Activity

Mark g_subprocess_get_std{in,out,err}_pipe() return value as nullable

Browse Source 
Previously it was considered a programming error to call these on
subprocesses created without the correct flags, but for bindings this
distinction is difficult to handle automatically.

Returning NULL instead does not cause any inconsistent behaviour and
simplifies the API.
This commit is contained in:
Sebastian Dröge 2020-11-10 19:50:51 +02:00
parent e2fbb74301
commit ec9fb90b2b
1 changed files with 9 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
gio/gsubprocess.c
View File

@ -773,10 +773,10 @@ g_subprocess_get_identifier (GSubprocess *subprocess)
* 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.
* The process must have been created with %G_SUBPROCESS_FLAGS_STDIN_PIPE and
* not %G_SUBPROCESS_FLAGS_STDIN_INHERIT, otherwise %NULL will be returned.
*
* Returns: (transfer none): the stdout pipe
* Returns: (nullable) (transfer none): the stdout pipe
*
* Since: 2.40
**/
@ -784,7 +784,6 @@ GOutputStream *
g_subprocess_get_stdin_pipe (GSubprocess *subprocess)
{
g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), NULL);
g_return_val_if_fail (subprocess->stdin_pipe, NULL);
return subprocess->stdin_pipe;
}
@ -796,10 +795,10 @@ g_subprocess_get_stdin_pipe (GSubprocess *subprocess)
* Gets the #GInputStream from which to read the stdout output of
* @subprocess.
*
* The process must have been created with
* %G_SUBPROCESS_FLAGS_STDOUT_PIPE.
* The process must have been created with %G_SUBPROCESS_FLAGS_STDOUT_PIPE,
* otherwise %NULL will be returned.
*
* Returns: (transfer none): the stdout pipe
* Returns: (nullable) (transfer none): the stdout pipe
*
* Since: 2.40
**/
@ -807,7 +806,6 @@ GInputStream *
g_subprocess_get_stdout_pipe (GSubprocess *subprocess)
{
g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), NULL);
g_return_val_if_fail (subprocess->stdout_pipe, NULL);
return subprocess->stdout_pipe;
}
@ -819,10 +817,10 @@ g_subprocess_get_stdout_pipe (GSubprocess *subprocess)
* Gets the #GInputStream from which to read the stderr output of
* @subprocess.
*
* The process must have been created with
* %G_SUBPROCESS_FLAGS_STDERR_PIPE.
* The process must have been created with %G_SUBPROCESS_FLAGS_STDERR_PIPE,
* otherwise %NULL will be returned.
*
* Returns: (transfer none): the stderr pipe
* Returns: (nullable) (transfer none): the stderr pipe
*
* Since: 2.40
**/
@ -830,7 +828,6 @@ GInputStream *
g_subprocess_get_stderr_pipe (GSubprocess *subprocess)
{
g_return_val_if_fail (G_IS_SUBPROCESS (subprocess), NULL);
g_return_val_if_fail (subprocess->stderr_pipe, NULL);
return subprocess->stderr_pipe;
}