gsubprocess.h 8.4 KB
Newer Older
1 2 3 4 5 6 7
/* GIO - GLib Input, Output and Streaming Library
 *
 * Copyright (C) 2012 Colin Walters <walters@verbum.org>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
8
 * version 2.1 of the License, or (at your option) any later version.
9 10 11 12 13 14 15
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General
16
 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51
 *
 * Author: Colin Walters <walters@verbum.org>
 */

#if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
#error "Only <gio/gio.h> can be included directly."
#endif

#ifndef __G_SUBPROCESS_H__
#define __G_SUBPROCESS_H__

#include <gio/giotypes.h>

G_BEGIN_DECLS

#define G_TYPE_SUBPROCESS         (g_subprocess_get_type ())
#define G_SUBPROCESS(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_SUBPROCESS, GSubprocess))
#define G_IS_SUBPROCESS(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_SUBPROCESS))

GLIB_AVAILABLE_IN_2_40
GType            g_subprocess_get_type                  (void) G_GNUC_CONST;

/**** Core API ****/

GLIB_AVAILABLE_IN_2_40
GSubprocess *    g_subprocess_new                       (GSubprocessFlags        flags,
                                                         GError                **error,
                                                         const gchar            *argv0,
                                                         ...) G_GNUC_NULL_TERMINATED;
GLIB_AVAILABLE_IN_2_40
GSubprocess *    g_subprocess_newv                      (const gchar * const  *argv,
                                                         GSubprocessFlags      flags,
                                                         GError              **error);

GLIB_AVAILABLE_IN_2_40
52
GOutputStream *  g_subprocess_get_stdin_pipe            (GSubprocess          *subprocess);
53 54

GLIB_AVAILABLE_IN_2_40
55
GInputStream *   g_subprocess_get_stdout_pipe           (GSubprocess          *subprocess);
56 57

GLIB_AVAILABLE_IN_2_40
58
GInputStream *   g_subprocess_get_stderr_pipe           (GSubprocess          *subprocess);
59 60

GLIB_AVAILABLE_IN_2_40
61
const gchar *    g_subprocess_get_identifier            (GSubprocess          *subprocess);
62 63 64

#ifdef G_OS_UNIX
GLIB_AVAILABLE_IN_2_40
65
void             g_subprocess_send_signal               (GSubprocess          *subprocess,
66 67 68 69
                                                         gint                  signal_num);
#endif

GLIB_AVAILABLE_IN_2_40
70
void             g_subprocess_force_exit                (GSubprocess          *subprocess);
71 72

GLIB_AVAILABLE_IN_2_40
73
gboolean         g_subprocess_wait                      (GSubprocess          *subprocess,
74 75 76 77
                                                         GCancellable         *cancellable,
                                                         GError              **error);

GLIB_AVAILABLE_IN_2_40
78
void             g_subprocess_wait_async                (GSubprocess          *subprocess,
79 80 81 82 83
                                                         GCancellable         *cancellable,
                                                         GAsyncReadyCallback   callback,
                                                         gpointer              user_data);

GLIB_AVAILABLE_IN_2_40
84
gboolean         g_subprocess_wait_finish               (GSubprocess          *subprocess,
85 86 87 88
                                                         GAsyncResult         *result,
                                                         GError              **error);

GLIB_AVAILABLE_IN_2_40
89
gboolean         g_subprocess_wait_check                (GSubprocess          *subprocess,
90 91 92 93
                                                         GCancellable         *cancellable,
                                                         GError              **error);

GLIB_AVAILABLE_IN_2_40
94
void             g_subprocess_wait_check_async          (GSubprocess          *subprocess,
95 96 97 98 99
                                                         GCancellable         *cancellable,
                                                         GAsyncReadyCallback   callback,
                                                         gpointer              user_data);

GLIB_AVAILABLE_IN_2_40
100
gboolean         g_subprocess_wait_check_finish         (GSubprocess          *subprocess,
101 102 103 104 105
                                                         GAsyncResult         *result,
                                                         GError              **error);


GLIB_AVAILABLE_IN_2_40
106
gint             g_subprocess_get_status                (GSubprocess          *subprocess);
107 108

GLIB_AVAILABLE_IN_2_40
109
gboolean         g_subprocess_get_successful            (GSubprocess          *subprocess);
110 111

GLIB_AVAILABLE_IN_2_40
112
gboolean         g_subprocess_get_if_exited             (GSubprocess          *subprocess);
113 114

GLIB_AVAILABLE_IN_2_40
115
gint             g_subprocess_get_exit_status           (GSubprocess          *subprocess);
116 117

GLIB_AVAILABLE_IN_2_40
118
gboolean         g_subprocess_get_if_signaled           (GSubprocess          *subprocess);
119 120

GLIB_AVAILABLE_IN_2_40
121
gint             g_subprocess_get_term_sig              (GSubprocess          *subprocess);
122 123 124

GLIB_AVAILABLE_IN_2_40
gboolean         g_subprocess_communicate               (GSubprocess          *subprocess,
125
                                                         GBytes               *stdin_buf,
126
                                                         GCancellable         *cancellable,
127 128
                                                         GBytes              **stdout_buf,
                                                         GBytes              **stderr_buf,
129 130 131
                                                         GError              **error);
GLIB_AVAILABLE_IN_2_40
void            g_subprocess_communicate_async          (GSubprocess          *subprocess,
132
                                                         GBytes               *stdin_buf,
133 134 135 136 137 138 139
                                                         GCancellable         *cancellable,
                                                         GAsyncReadyCallback   callback,
                                                         gpointer              user_data);

GLIB_AVAILABLE_IN_2_40
gboolean        g_subprocess_communicate_finish         (GSubprocess          *subprocess,
                                                         GAsyncResult         *result,
140 141
                                                         GBytes              **stdout_buf,
                                                         GBytes              **stderr_buf,
142 143
                                                         GError              **error);

144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
GLIB_AVAILABLE_IN_2_40
gboolean         g_subprocess_communicate_utf8          (GSubprocess          *subprocess,
                                                         const char           *stdin_buf,
                                                         GCancellable         *cancellable,
                                                         char                **stdout_buf,
                                                         char                **stderr_buf,
                                                         GError              **error);
GLIB_AVAILABLE_IN_2_40
void            g_subprocess_communicate_utf8_async     (GSubprocess          *subprocess,
                                                         const char           *stdin_buf,
                                                         GCancellable         *cancellable,
                                                         GAsyncReadyCallback   callback,
                                                         gpointer              user_data);

GLIB_AVAILABLE_IN_2_40
gboolean        g_subprocess_communicate_utf8_finish    (GSubprocess          *subprocess,
                                                         GAsyncResult         *result,
                                                         char                **stdout_buf,
                                                         char                **stderr_buf,
                                                         GError              **error);

165 166 167
G_END_DECLS

#endif /* __G_SUBPROCESS_H__ */