|
1 /* GLIB - Library of useful routines for C programming |
|
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald |
|
3 * Portions copyright (c) 2006 Nokia Corporation. All rights reserved. |
|
4 * |
|
5 * This library is free software; you can redistribute it and/or |
|
6 * modify it under the terms of the GNU Lesser General Public |
|
7 * License as published by the Free Software Foundation; either |
|
8 * version 2 of the License, or (at your option) any later version. |
|
9 * |
|
10 * This library is distributed in the hope that it will be useful, |
|
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|
13 * Lesser General Public License for more details. |
|
14 * |
|
15 * You should have received a copy of the GNU Lesser General Public |
|
16 * License along with this library; if not, write to the |
|
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330, |
|
18 * Boston, MA 02111-1307, USA. |
|
19 */ |
|
20 |
|
21 /* |
|
22 * Modified by the GLib Team and others 1997-2000. See the AUTHORS |
|
23 * file for a list of people on the GLib Team. See the ChangeLog |
|
24 * files for a list of changes. These files are distributed with |
|
25 * GLib at ftp://ftp.gtk.org/pub/gtk/. |
|
26 */ |
|
27 |
|
28 #ifndef __G_IOCHANNEL_H__ |
|
29 #define __G_IOCHANNEL_H__ |
|
30 |
|
31 #include <_ansi.h> |
|
32 #include <glib/gconvert.h> |
|
33 #include <glib/gmain.h> |
|
34 #include <glib/gstring.h> |
|
35 |
|
36 G_BEGIN_DECLS |
|
37 |
|
38 /* GIOChannel |
|
39 */ |
|
40 |
|
41 typedef struct _GIOChannel GIOChannel; |
|
42 typedef struct _GIOFuncs GIOFuncs; |
|
43 |
|
44 typedef enum |
|
45 { |
|
46 G_IO_ERROR_NONE, |
|
47 G_IO_ERROR_AGAIN, |
|
48 G_IO_ERROR_INVAL, |
|
49 G_IO_ERROR_UNKNOWN |
|
50 } GIOError; |
|
51 |
|
52 #define G_IO_CHANNEL_ERROR g_io_channel_error_quark() |
|
53 |
|
54 typedef enum |
|
55 { |
|
56 /* Derived from errno */ |
|
57 G_IO_CHANNEL_ERROR_FBIG, |
|
58 G_IO_CHANNEL_ERROR_INVAL, |
|
59 G_IO_CHANNEL_ERROR_IO, |
|
60 G_IO_CHANNEL_ERROR_ISDIR, |
|
61 G_IO_CHANNEL_ERROR_NOSPC, |
|
62 G_IO_CHANNEL_ERROR_NXIO, |
|
63 G_IO_CHANNEL_ERROR_OVERFLOW, |
|
64 G_IO_CHANNEL_ERROR_PIPE, |
|
65 /* Other */ |
|
66 G_IO_CHANNEL_ERROR_FAILED |
|
67 } GIOChannelError; |
|
68 |
|
69 typedef enum |
|
70 { |
|
71 G_IO_STATUS_ERROR, |
|
72 G_IO_STATUS_NORMAL, |
|
73 G_IO_STATUS_EOF, |
|
74 G_IO_STATUS_AGAIN |
|
75 } GIOStatus; |
|
76 |
|
77 typedef enum |
|
78 { |
|
79 G_SEEK_CUR, |
|
80 G_SEEK_SET, |
|
81 G_SEEK_END |
|
82 } GSeekType; |
|
83 |
|
84 typedef enum |
|
85 { |
|
86 G_IO_IN GLIB_SYSDEF_POLLIN, |
|
87 G_IO_OUT GLIB_SYSDEF_POLLOUT, |
|
88 G_IO_PRI GLIB_SYSDEF_POLLPRI, |
|
89 G_IO_ERR GLIB_SYSDEF_POLLERR, |
|
90 G_IO_HUP GLIB_SYSDEF_POLLHUP, |
|
91 G_IO_NVAL GLIB_SYSDEF_POLLNVAL |
|
92 } GIOCondition; |
|
93 |
|
94 typedef enum |
|
95 { |
|
96 G_IO_FLAG_APPEND = 1 << 0, |
|
97 G_IO_FLAG_NONBLOCK = 1 << 1, |
|
98 G_IO_FLAG_IS_READABLE = 1 << 2, /* Read only flag */ |
|
99 G_IO_FLAG_IS_WRITEABLE = 1 << 3, /* Read only flag */ |
|
100 G_IO_FLAG_IS_SEEKABLE = 1 << 4, /* Read only flag */ |
|
101 G_IO_FLAG_MASK = (1 << 5) - 1, |
|
102 G_IO_FLAG_GET_MASK = G_IO_FLAG_MASK, |
|
103 G_IO_FLAG_SET_MASK = G_IO_FLAG_APPEND | G_IO_FLAG_NONBLOCK |
|
104 } GIOFlags; |
|
105 |
|
106 struct _GIOChannel |
|
107 { |
|
108 /*< private >*/ |
|
109 guint ref_count; |
|
110 GIOFuncs *funcs; |
|
111 |
|
112 gchar *encoding; |
|
113 GIConv read_cd; |
|
114 GIConv write_cd; |
|
115 gchar *line_term; /* String which indicates the end of a line of text */ |
|
116 guint line_term_len; /* So we can have null in the line term */ |
|
117 |
|
118 gsize buf_size; |
|
119 GString *read_buf; /* Raw data from the channel */ |
|
120 GString *encoded_read_buf; /* Channel data converted to UTF-8 */ |
|
121 GString *write_buf; /* Data ready to be written to the file */ |
|
122 gchar partial_write_buf[6]; /* UTF-8 partial characters, null terminated */ |
|
123 |
|
124 /* Group the flags together, immediately after partial_write_buf, to save memory */ |
|
125 |
|
126 guint use_buffer : 1; /* The encoding uses the buffers */ |
|
127 guint do_encode : 1; /* The encoding uses the GIConv coverters */ |
|
128 guint close_on_unref : 1; /* Close the channel on final unref */ |
|
129 guint is_readable : 1; /* Cached GIOFlag */ |
|
130 guint is_writeable : 1; /* ditto */ |
|
131 guint is_seekable : 1; /* ditto */ |
|
132 |
|
133 gpointer reserved1; |
|
134 gpointer reserved2; |
|
135 }; |
|
136 |
|
137 typedef gboolean (*GIOFunc) (GIOChannel *source, |
|
138 GIOCondition condition, |
|
139 gpointer data); |
|
140 struct _GIOFuncs |
|
141 { |
|
142 GIOStatus (*io_read) (GIOChannel *channel, |
|
143 gchar *buf, |
|
144 gsize count, |
|
145 gsize *bytes_read, |
|
146 GError **err); |
|
147 GIOStatus (*io_write) (GIOChannel *channel, |
|
148 const gchar *buf, |
|
149 gsize count, |
|
150 gsize *bytes_written, |
|
151 GError **err); |
|
152 GIOStatus (*io_seek) (GIOChannel *channel, |
|
153 gint64 offset, |
|
154 GSeekType type, |
|
155 GError **err); |
|
156 GIOStatus (*io_close) (GIOChannel *channel, |
|
157 GError **err); |
|
158 GSource* (*io_create_watch) (GIOChannel *channel, |
|
159 GIOCondition condition); |
|
160 void (*io_free) (GIOChannel *channel); |
|
161 GIOStatus (*io_set_flags) (GIOChannel *channel, |
|
162 GIOFlags flags, |
|
163 GError **err); |
|
164 GIOFlags (*io_get_flags) (GIOChannel *channel); |
|
165 }; |
|
166 |
|
167 IMPORT_C void g_io_channel_init (GIOChannel *channel); |
|
168 IMPORT_C GIOChannel *g_io_channel_ref (GIOChannel *channel); |
|
169 IMPORT_C void g_io_channel_unref (GIOChannel *channel); |
|
170 |
|
171 #ifndef G_DISABLE_DEPRECATED |
|
172 IMPORT_C GIOError g_io_channel_read (GIOChannel *channel, |
|
173 gchar *buf, |
|
174 gsize count, |
|
175 gsize *bytes_read); |
|
176 IMPORT_C GIOError g_io_channel_write (GIOChannel *channel, |
|
177 const gchar *buf, |
|
178 gsize count, |
|
179 gsize *bytes_written); |
|
180 IMPORT_C GIOError g_io_channel_seek (GIOChannel *channel, |
|
181 gint64 offset, |
|
182 GSeekType type); |
|
183 IMPORT_C void g_io_channel_close (GIOChannel *channel); |
|
184 #endif /* G_DISABLE_DEPRECATED */ |
|
185 |
|
186 IMPORT_C GIOStatus g_io_channel_shutdown (GIOChannel *channel, |
|
187 gboolean flush, |
|
188 GError **err); |
|
189 IMPORT_C guint g_io_add_watch_full (GIOChannel *channel, |
|
190 gint priority, |
|
191 GIOCondition condition, |
|
192 GIOFunc func, |
|
193 gpointer user_data, |
|
194 GDestroyNotify notify); |
|
195 IMPORT_C GSource * g_io_create_watch (GIOChannel *channel, |
|
196 GIOCondition condition); |
|
197 IMPORT_C guint g_io_add_watch (GIOChannel *channel, |
|
198 GIOCondition condition, |
|
199 GIOFunc func, |
|
200 gpointer user_data); |
|
201 |
|
202 /* character encoding conversion involved functions. |
|
203 */ |
|
204 |
|
205 IMPORT_C void g_io_channel_set_buffer_size (GIOChannel *channel, |
|
206 gsize size); |
|
207 IMPORT_C gsize g_io_channel_get_buffer_size (GIOChannel *channel); |
|
208 IMPORT_C GIOCondition g_io_channel_get_buffer_condition (GIOChannel *channel); |
|
209 IMPORT_C GIOStatus g_io_channel_set_flags (GIOChannel *channel, |
|
210 GIOFlags flags, |
|
211 GError **error); |
|
212 IMPORT_C GIOFlags g_io_channel_get_flags (GIOChannel *channel); |
|
213 IMPORT_C void g_io_channel_set_line_term (GIOChannel *channel, |
|
214 const gchar *line_term, |
|
215 gint length); |
|
216 IMPORT_C G_CONST_RETURN gchar* g_io_channel_get_line_term (GIOChannel *channel, |
|
217 gint *length); |
|
218 IMPORT_C void g_io_channel_set_buffered (GIOChannel *channel, |
|
219 gboolean buffered); |
|
220 IMPORT_C gboolean g_io_channel_get_buffered (GIOChannel *channel); |
|
221 IMPORT_C GIOStatus g_io_channel_set_encoding (GIOChannel *channel, |
|
222 const gchar *encoding, |
|
223 GError **error); |
|
224 IMPORT_C G_CONST_RETURN gchar* g_io_channel_get_encoding (GIOChannel *channel); |
|
225 IMPORT_C void g_io_channel_set_close_on_unref (GIOChannel *channel, |
|
226 gboolean do_close); |
|
227 IMPORT_C gboolean g_io_channel_get_close_on_unref (GIOChannel *channel); |
|
228 |
|
229 |
|
230 IMPORT_C GIOStatus g_io_channel_flush (GIOChannel *channel, |
|
231 GError **error); |
|
232 IMPORT_C GIOStatus g_io_channel_read_line (GIOChannel *channel, |
|
233 gchar **str_return, |
|
234 gsize *length, |
|
235 gsize *terminator_pos, |
|
236 GError **error); |
|
237 IMPORT_C GIOStatus g_io_channel_read_line_string (GIOChannel *channel, |
|
238 GString *buffer, |
|
239 gsize *terminator_pos, |
|
240 GError **error); |
|
241 IMPORT_C GIOStatus g_io_channel_read_to_end (GIOChannel *channel, |
|
242 gchar **str_return, |
|
243 gsize *length, |
|
244 GError **error); |
|
245 IMPORT_C GIOStatus g_io_channel_read_chars (GIOChannel *channel, |
|
246 gchar *buf, |
|
247 gsize count, |
|
248 gsize *bytes_read, |
|
249 GError **error); |
|
250 IMPORT_C GIOStatus g_io_channel_read_unichar (GIOChannel *channel, |
|
251 gunichar *thechar, |
|
252 GError **error); |
|
253 IMPORT_C GIOStatus g_io_channel_write_chars (GIOChannel *channel, |
|
254 const gchar *buf, |
|
255 gssize count, |
|
256 gsize *bytes_written, |
|
257 GError **error); |
|
258 IMPORT_C GIOStatus g_io_channel_write_unichar (GIOChannel *channel, |
|
259 gunichar thechar, |
|
260 GError **error); |
|
261 IMPORT_C GIOStatus g_io_channel_seek_position (GIOChannel *channel, |
|
262 gint64 offset, |
|
263 GSeekType type, |
|
264 GError **error); |
|
265 #ifdef G_OS_WIN32 |
|
266 #define g_io_channel_new_file g_io_channel_new_file_utf8 |
|
267 #endif |
|
268 |
|
269 IMPORT_C GIOChannel* g_io_channel_new_file (const gchar *filename, |
|
270 const gchar *mode, |
|
271 GError **error); |
|
272 |
|
273 /* Error handling */ |
|
274 |
|
275 IMPORT_C GQuark g_io_channel_error_quark (void); |
|
276 IMPORT_C GIOChannelError g_io_channel_error_from_errno (gint en); |
|
277 |
|
278 /* On Unix, IO channels created with this function for any file |
|
279 * descriptor or socket. |
|
280 * |
|
281 * On Win32, this can be used either for files opened with the MSVCRT |
|
282 * (the Microsoft run-time C library) _open() or _pipe, including file |
|
283 * descriptors 0, 1 and 2 (corresponding to stdin, stdout and stderr), |
|
284 * or for Winsock SOCKETs. If the parameter is a legal file |
|
285 * descriptor, it is assumed to be such, otherwise it should be a |
|
286 * SOCKET. This relies on SOCKETs and file descriptors not |
|
287 * overlapping. If you want to be certain, call either |
|
288 * g_io_channel_win32_new_fd() or g_io_channel_win32_new_socket() |
|
289 * instead as appropriate. |
|
290 * |
|
291 * The term file descriptor as used in the context of Win32 refers to |
|
292 * the emulated Unix-like file descriptors MSVCRT provides. The native |
|
293 * corresponding concept is file HANDLE. There isn't as of yet a way to |
|
294 * get GIOChannels for Win32 file HANDLEs. |
|
295 */ |
|
296 IMPORT_C GIOChannel* g_io_channel_unix_new (int fd); |
|
297 IMPORT_C gint g_io_channel_unix_get_fd (GIOChannel *channel); |
|
298 |
|
299 |
|
300 /* Hook for GClosure / GSource integration. Don't touch */ |
|
301 GLIB_VAR GSourceFuncs g_io_watch_funcs; |
|
302 |
|
303 #ifdef __SYMBIAN32__ |
|
304 IMPORT_C GSourceFuncs * _g_io_watch_funcs(); |
|
305 #endif /* __SYMBIAN32__ */ |
|
306 |
|
307 #ifdef G_OS_WIN32 |
|
308 |
|
309 /* You can use this "pseudo file descriptor" in a GPollFD to add |
|
310 * polling for Windows messages. GTK applications should not do that. |
|
311 */ |
|
312 |
|
313 #define G_WIN32_MSG_HANDLE 19981206 |
|
314 |
|
315 /* Use this to get a GPollFD from a GIOChannel, so that you can call |
|
316 * g_io_channel_win32_poll(). After calling this you should only use |
|
317 * g_io_channel_read() to read from the GIOChannel, i.e. never read() |
|
318 * from the underlying file descriptor. For SOCKETs, it is possible to call |
|
319 * recv(). |
|
320 */ |
|
321 void g_io_channel_win32_make_pollfd (GIOChannel *channel, |
|
322 GIOCondition condition, |
|
323 GPollFD *fd); |
|
324 |
|
325 /* This can be used to wait a until at least one of the channels is readable. |
|
326 * On Unix you would do a select() on the file descriptors of the channels. |
|
327 */ |
|
328 gint g_io_channel_win32_poll (GPollFD *fds, |
|
329 gint n_fds, |
|
330 gint timeout_); |
|
331 |
|
332 /* Create an IO channel for Windows messages for window handle hwnd. */ |
|
333 GIOChannel *g_io_channel_win32_new_messages (guint hwnd); |
|
334 |
|
335 /* Create an IO channel for C runtime (emulated Unix-like) file |
|
336 * descriptors. After calling g_io_add_watch() on a IO channel |
|
337 * returned by this function, you shouldn't call read() on the file |
|
338 * descriptor. This is because adding polling for a file descriptor is |
|
339 * implemented on Win32 by starting a thread that sits blocked in a |
|
340 * read() from the file descriptor most of the time. All reads from |
|
341 * the file descriptor should be done by this internal GLib |
|
342 * thread. Your code should call only g_io_channel_read(). |
|
343 */ |
|
344 GIOChannel* g_io_channel_win32_new_fd (gint fd); |
|
345 |
|
346 /* Get the C runtime file descriptor of a channel. */ |
|
347 gint g_io_channel_win32_get_fd (GIOChannel *channel); |
|
348 |
|
349 /* Create an IO channel for a winsock socket. The parameter should be |
|
350 * a SOCKET. Contrary to IO channels for file descriptors (on *Win32), |
|
351 * you can use normal recv() or recvfrom() on sockets even if GLib |
|
352 * is polling them. |
|
353 */ |
|
354 GIOChannel *g_io_channel_win32_new_socket (gint socket); |
|
355 |
|
356 #endif |
|
357 |
|
358 G_END_DECLS |
|
359 |
|
360 #endif /* __G_IOCHANNEL_H__ */ |