glib-2.0/gio/gsubprocess.h

0001 /* GIO - GLib Input, Output and Streaming Library
0002  *
0003  * Copyright (C) 2012 Colin Walters <walters@verbum.org>
0004  *
0005  * SPDX-License-Identifier: LGPL-2.1-or-later
0006  *
0007  * This library is free software; you can redistribute it and/or
0008  * modify it under the terms of the GNU Lesser General Public
0009  * License as published by the Free Software Foundation; either
0010  * version 2.1 of the License, or (at your option) any later version.
0011  *
0012  * This library is distributed in the hope that it will be useful,
0013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0015  * Lesser General Public License for more details.
0016  *
0017  * You should have received a copy of the GNU Lesser General
0018  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
0019  *
0020  * Author: Colin Walters <walters@verbum.org>
0021  */
0022
0023 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
0024 #error "Only <gio/gio.h> can be included directly."
0025 #endif
0026
0027 #ifndef __G_SUBPROCESS_H__
0028 #define __G_SUBPROCESS_H__
0029
0030 #include <gio/giotypes.h>
0031
0032 G_BEGIN_DECLS
0033
0034 #define G_TYPE_SUBPROCESS         (g_subprocess_get_type ())
0035 #define G_SUBPROCESS(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_SUBPROCESS, GSubprocess))
0036 #define G_IS_SUBPROCESS(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_SUBPROCESS))
0037
0038 GIO_AVAILABLE_IN_2_40
0039 GType            g_subprocess_get_type                  (void) G_GNUC_CONST;
0040
0041 /**** Core API ****/
0042
0043 GIO_AVAILABLE_IN_2_40
0044 GSubprocess *    g_subprocess_new                       (GSubprocessFlags        flags,
0045                                                          GError                **error,
0046                                                          const gchar            *argv0,
0047                                                          ...) G_GNUC_NULL_TERMINATED;
0048 GIO_AVAILABLE_IN_2_40
0049 GSubprocess *    g_subprocess_newv                      (const gchar * const  *argv,
0050                                                          GSubprocessFlags      flags,
0051                                                          GError              **error);
0052
0053 GIO_AVAILABLE_IN_2_40
0054 GOutputStream *  g_subprocess_get_stdin_pipe            (GSubprocess          *subprocess);
0055
0056 GIO_AVAILABLE_IN_2_40
0057 GInputStream *   g_subprocess_get_stdout_pipe           (GSubprocess          *subprocess);
0058
0059 GIO_AVAILABLE_IN_2_40
0060 GInputStream *   g_subprocess_get_stderr_pipe           (GSubprocess          *subprocess);
0061
0062 GIO_AVAILABLE_IN_2_40
0063 const gchar *    g_subprocess_get_identifier            (GSubprocess          *subprocess);
0064
0065 #ifdef G_OS_UNIX
0066 GIO_AVAILABLE_IN_2_40
0067 void             g_subprocess_send_signal               (GSubprocess          *subprocess,
0068                                                          gint                  signal_num);
0069 #endif
0070
0071 GIO_AVAILABLE_IN_2_40
0072 void             g_subprocess_force_exit                (GSubprocess          *subprocess);
0073
0074 GIO_AVAILABLE_IN_2_40
0075 gboolean         g_subprocess_wait                      (GSubprocess          *subprocess,
0076                                                          GCancellable         *cancellable,
0077                                                          GError              **error);
0078
0079 GIO_AVAILABLE_IN_2_40
0080 void             g_subprocess_wait_async                (GSubprocess          *subprocess,
0081                                                          GCancellable         *cancellable,
0082                                                          GAsyncReadyCallback   callback,
0083                                                          gpointer              user_data);
0084
0085 GIO_AVAILABLE_IN_2_40
0086 gboolean         g_subprocess_wait_finish               (GSubprocess          *subprocess,
0087                                                          GAsyncResult         *result,
0088                                                          GError              **error);
0089
0090 GIO_AVAILABLE_IN_2_40
0091 gboolean         g_subprocess_wait_check                (GSubprocess          *subprocess,
0092                                                          GCancellable         *cancellable,
0093                                                          GError              **error);
0094
0095 GIO_AVAILABLE_IN_2_40
0096 void             g_subprocess_wait_check_async          (GSubprocess          *subprocess,
0097                                                          GCancellable         *cancellable,
0098                                                          GAsyncReadyCallback   callback,
0099                                                          gpointer              user_data);
0100
0101 GIO_AVAILABLE_IN_2_40
0102 gboolean         g_subprocess_wait_check_finish         (GSubprocess          *subprocess,
0103                                                          GAsyncResult         *result,
0104                                                          GError              **error);
0105
0106
0107 GIO_AVAILABLE_IN_2_40
0108 gint             g_subprocess_get_status                (GSubprocess          *subprocess);
0109
0110 GIO_AVAILABLE_IN_2_40
0111 gboolean         g_subprocess_get_successful            (GSubprocess          *subprocess);
0112
0113 GIO_AVAILABLE_IN_2_40
0114 gboolean         g_subprocess_get_if_exited             (GSubprocess          *subprocess);
0115
0116 GIO_AVAILABLE_IN_2_40
0117 gint             g_subprocess_get_exit_status           (GSubprocess          *subprocess);
0118
0119 GIO_AVAILABLE_IN_2_40
0120 gboolean         g_subprocess_get_if_signaled           (GSubprocess          *subprocess);
0121
0122 GIO_AVAILABLE_IN_2_40
0123 gint             g_subprocess_get_term_sig              (GSubprocess          *subprocess);
0124
0125 GIO_AVAILABLE_IN_2_40
0126 gboolean         g_subprocess_communicate               (GSubprocess          *subprocess,
0127                                                          GBytes               *stdin_buf,
0128                                                          GCancellable         *cancellable,
0129                                                          GBytes              **stdout_buf,
0130                                                          GBytes              **stderr_buf,
0131                                                          GError              **error);
0132 GIO_AVAILABLE_IN_2_40
0133 void            g_subprocess_communicate_async          (GSubprocess          *subprocess,
0134                                                          GBytes               *stdin_buf,
0135                                                          GCancellable         *cancellable,
0136                                                          GAsyncReadyCallback   callback,
0137                                                          gpointer              user_data);
0138
0139 GIO_AVAILABLE_IN_2_40
0140 gboolean        g_subprocess_communicate_finish         (GSubprocess          *subprocess,
0141                                                          GAsyncResult         *result,
0142                                                          GBytes              **stdout_buf,
0143                                                          GBytes              **stderr_buf,
0144                                                          GError              **error);
0145
0146 GIO_AVAILABLE_IN_2_40
0147 gboolean         g_subprocess_communicate_utf8          (GSubprocess          *subprocess,
0148                                                          const char           *stdin_buf,
0149                                                          GCancellable         *cancellable,
0150                                                          char                **stdout_buf,
0151                                                          char                **stderr_buf,
0152                                                          GError              **error);
0153 GIO_AVAILABLE_IN_2_40
0154 void            g_subprocess_communicate_utf8_async     (GSubprocess          *subprocess,
0155                                                          const char           *stdin_buf,
0156                                                          GCancellable         *cancellable,
0157                                                          GAsyncReadyCallback   callback,
0158                                                          gpointer              user_data);
0159
0160 GIO_AVAILABLE_IN_2_40
0161 gboolean        g_subprocess_communicate_utf8_finish    (GSubprocess          *subprocess,
0162                                                          GAsyncResult         *result,
0163                                                          char                **stdout_buf,
0164                                                          char                **stderr_buf,
0165                                                          GError              **error);
0166
0167 G_END_DECLS
0168
0169 #endif /* __G_SUBPROCESS_H__ */