1 /* GLIB - Library of useful routines for C programming
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GLib Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GLib Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GLib at ftp://ftp.gtk.org/pub/gtk/.
27 #if defined(G_DISABLE_SINGLE_INCLUDES) && !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
28 #error "Only <glib.h> can be included directly."
31 #ifndef __G_IOCHANNEL_H__
32 #define __G_IOCHANNEL_H__
34 #include <glib/gconvert.h>
35 #include <glib/gmain.h>
36 #include <glib/gstring.h>
43 typedef struct _GIOChannel GIOChannel;
44 typedef struct _GIOFuncs GIOFuncs;
54 #define G_IO_CHANNEL_ERROR g_io_channel_error_quark()
58 /* Derived from errno */
59 G_IO_CHANNEL_ERROR_FBIG,
60 G_IO_CHANNEL_ERROR_INVAL,
61 G_IO_CHANNEL_ERROR_IO,
62 G_IO_CHANNEL_ERROR_ISDIR,
63 G_IO_CHANNEL_ERROR_NOSPC,
64 G_IO_CHANNEL_ERROR_NXIO,
65 G_IO_CHANNEL_ERROR_OVERFLOW,
66 G_IO_CHANNEL_ERROR_PIPE,
68 G_IO_CHANNEL_ERROR_FAILED
86 typedef enum /*< flags >*/
88 G_IO_IN GLIB_SYSDEF_POLLIN,
89 G_IO_OUT GLIB_SYSDEF_POLLOUT,
90 G_IO_PRI GLIB_SYSDEF_POLLPRI,
91 G_IO_ERR GLIB_SYSDEF_POLLERR,
92 G_IO_HUP GLIB_SYSDEF_POLLHUP,
93 G_IO_NVAL GLIB_SYSDEF_POLLNVAL
98 G_IO_FLAG_APPEND = 1 << 0,
99 G_IO_FLAG_NONBLOCK = 1 << 1,
100 G_IO_FLAG_IS_READABLE = 1 << 2, /* Read only flag */
101 G_IO_FLAG_IS_WRITABLE = 1 << 3, /* Read only flag */
102 G_IO_FLAG_IS_SEEKABLE = 1 << 4, /* Read only flag */
103 G_IO_FLAG_MASK = (1 << 5) - 1,
104 G_IO_FLAG_GET_MASK = G_IO_FLAG_MASK,
105 G_IO_FLAG_SET_MASK = G_IO_FLAG_APPEND | G_IO_FLAG_NONBLOCK
108 /* Misspelling in enum in 2.29.10 and earlier */
109 #define G_IO_FLAG_IS_WRITEABLE (G_IO_FLAG_IS_WRITABLE)
120 gchar *line_term; /* String which indicates the end of a line of text */
121 guint line_term_len; /* So we can have null in the line term */
124 GString *read_buf; /* Raw data from the channel */
125 GString *encoded_read_buf; /* Channel data converted to UTF-8 */
126 GString *write_buf; /* Data ready to be written to the file */
127 gchar partial_write_buf[6]; /* UTF-8 partial characters, null terminated */
129 /* Group the flags together, immediately after partial_write_buf, to save memory */
131 guint use_buffer : 1; /* The encoding uses the buffers */
132 guint do_encode : 1; /* The encoding uses the GIConv coverters */
133 guint close_on_unref : 1; /* Close the channel on final unref */
134 guint is_readable : 1; /* Cached GIOFlag */
135 guint is_writeable : 1; /* ditto */
136 guint is_seekable : 1; /* ditto */
142 typedef gboolean (*GIOFunc) (GIOChannel *source,
143 GIOCondition condition,
147 GIOStatus (*io_read) (GIOChannel *channel,
152 GIOStatus (*io_write) (GIOChannel *channel,
155 gsize *bytes_written,
157 GIOStatus (*io_seek) (GIOChannel *channel,
161 GIOStatus (*io_close) (GIOChannel *channel,
163 GSource* (*io_create_watch) (GIOChannel *channel,
164 GIOCondition condition);
165 void (*io_free) (GIOChannel *channel);
166 GIOStatus (*io_set_flags) (GIOChannel *channel,
169 GIOFlags (*io_get_flags) (GIOChannel *channel);
172 void g_io_channel_init (GIOChannel *channel);
173 GIOChannel *g_io_channel_ref (GIOChannel *channel);
174 void g_io_channel_unref (GIOChannel *channel);
176 #ifndef G_DISABLE_DEPRECATED
177 GIOError g_io_channel_read (GIOChannel *channel,
181 GIOError g_io_channel_write (GIOChannel *channel,
184 gsize *bytes_written);
185 GIOError g_io_channel_seek (GIOChannel *channel,
188 void g_io_channel_close (GIOChannel *channel);
189 #endif /* G_DISABLE_DEPRECATED */
191 GIOStatus g_io_channel_shutdown (GIOChannel *channel,
194 guint g_io_add_watch_full (GIOChannel *channel,
196 GIOCondition condition,
199 GDestroyNotify notify);
200 GSource * g_io_create_watch (GIOChannel *channel,
201 GIOCondition condition);
202 guint g_io_add_watch (GIOChannel *channel,
203 GIOCondition condition,
207 /* character encoding conversion involved functions.
210 void g_io_channel_set_buffer_size (GIOChannel *channel,
212 gsize g_io_channel_get_buffer_size (GIOChannel *channel);
213 GIOCondition g_io_channel_get_buffer_condition (GIOChannel *channel);
214 GIOStatus g_io_channel_set_flags (GIOChannel *channel,
217 GIOFlags g_io_channel_get_flags (GIOChannel *channel);
218 void g_io_channel_set_line_term (GIOChannel *channel,
219 const gchar *line_term,
221 const gchar * g_io_channel_get_line_term (GIOChannel *channel,
223 void g_io_channel_set_buffered (GIOChannel *channel,
225 gboolean g_io_channel_get_buffered (GIOChannel *channel);
226 GIOStatus g_io_channel_set_encoding (GIOChannel *channel,
227 const gchar *encoding,
229 const gchar * g_io_channel_get_encoding (GIOChannel *channel);
230 void g_io_channel_set_close_on_unref (GIOChannel *channel,
232 gboolean g_io_channel_get_close_on_unref (GIOChannel *channel);
235 GIOStatus g_io_channel_flush (GIOChannel *channel,
237 GIOStatus g_io_channel_read_line (GIOChannel *channel,
240 gsize *terminator_pos,
242 GIOStatus g_io_channel_read_line_string (GIOChannel *channel,
244 gsize *terminator_pos,
246 GIOStatus g_io_channel_read_to_end (GIOChannel *channel,
250 GIOStatus g_io_channel_read_chars (GIOChannel *channel,
255 GIOStatus g_io_channel_read_unichar (GIOChannel *channel,
258 GIOStatus g_io_channel_write_chars (GIOChannel *channel,
261 gsize *bytes_written,
263 GIOStatus g_io_channel_write_unichar (GIOChannel *channel,
266 GIOStatus g_io_channel_seek_position (GIOChannel *channel,
271 #define g_io_channel_new_file g_io_channel_new_file_utf8
274 GIOChannel* g_io_channel_new_file (const gchar *filename,
280 GQuark g_io_channel_error_quark (void);
281 GIOChannelError g_io_channel_error_from_errno (gint en);
283 /* On Unix, IO channels created with this function for any file
284 * descriptor or socket.
286 * On Win32, this can be used either for files opened with the MSVCRT
287 * (the Microsoft run-time C library) _open() or _pipe, including file
288 * descriptors 0, 1 and 2 (corresponding to stdin, stdout and stderr),
289 * or for Winsock SOCKETs. If the parameter is a legal file
290 * descriptor, it is assumed to be such, otherwise it should be a
291 * SOCKET. This relies on SOCKETs and file descriptors not
292 * overlapping. If you want to be certain, call either
293 * g_io_channel_win32_new_fd() or g_io_channel_win32_new_socket()
294 * instead as appropriate.
296 * The term file descriptor as used in the context of Win32 refers to
297 * the emulated Unix-like file descriptors MSVCRT provides. The native
298 * corresponding concept is file HANDLE. There isn't as of yet a way to
299 * get GIOChannels for Win32 file HANDLEs.
301 GIOChannel* g_io_channel_unix_new (int fd);
302 gint g_io_channel_unix_get_fd (GIOChannel *channel);
305 /* Hook for GClosure / GSource integration. Don't touch */
306 GLIB_VAR GSourceFuncs g_io_watch_funcs;
310 /* You can use this "pseudo file descriptor" in a GPollFD to add
311 * polling for Windows messages. GTK applications should not do that.
314 #define G_WIN32_MSG_HANDLE 19981206
316 /* Use this to get a GPollFD from a GIOChannel, so that you can call
317 * g_io_channel_win32_poll(). After calling this you should only use
318 * g_io_channel_read() to read from the GIOChannel, i.e. never read()
319 * from the underlying file descriptor. For SOCKETs, it is possible to call
322 void g_io_channel_win32_make_pollfd (GIOChannel *channel,
323 GIOCondition condition,
326 /* This can be used to wait a until at least one of the channels is readable.
327 * On Unix you would do a select() on the file descriptors of the channels.
329 gint g_io_channel_win32_poll (GPollFD *fds,
333 /* Create an IO channel for Windows messages for window handle hwnd. */
334 #if GLIB_SIZEOF_VOID_P == 8
335 /* We use gsize here so that it is still an integer type and not a
336 * pointer, like the guint in the traditional prototype. We can't use
337 * intptr_t as that is not portable enough.
339 GIOChannel *g_io_channel_win32_new_messages (gsize hwnd);
341 GIOChannel *g_io_channel_win32_new_messages (guint hwnd);
344 /* Create an IO channel for C runtime (emulated Unix-like) file
345 * descriptors. After calling g_io_add_watch() on a IO channel
346 * returned by this function, you shouldn't call read() on the file
347 * descriptor. This is because adding polling for a file descriptor is
348 * implemented on Win32 by starting a thread that sits blocked in a
349 * read() from the file descriptor most of the time. All reads from
350 * the file descriptor should be done by this internal GLib
351 * thread. Your code should call only g_io_channel_read_chars().
353 GIOChannel* g_io_channel_win32_new_fd (gint fd);
355 /* Get the C runtime file descriptor of a channel. */
356 gint g_io_channel_win32_get_fd (GIOChannel *channel);
358 /* Create an IO channel for a winsock socket. The parameter should be
359 * a SOCKET. Contrary to IO channels for file descriptors (on *Win32),
360 * you can use normal recv() or recvfrom() on sockets even if GLib
363 GIOChannel *g_io_channel_win32_new_socket (gint socket);
369 #endif /* __G_IOCHANNEL_H__ */