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 #ifndef __G_IOCHANNEL_H__
28 #define __G_IOCHANNEL_H__
30 #include <glib/gconvert.h>
31 #include <glib/gmain.h>
32 #include <glib/gstring.h>
39 typedef struct _GIOChannel GIOChannel;
40 typedef struct _GIOFuncs GIOFuncs;
50 #define G_IO_CHANNEL_ERROR g_io_channel_error_quark()
54 /* Derived from errno */
55 G_IO_CHANNEL_ERROR_FBIG,
56 G_IO_CHANNEL_ERROR_INVAL,
57 G_IO_CHANNEL_ERROR_IO,
58 G_IO_CHANNEL_ERROR_ISDIR,
59 G_IO_CHANNEL_ERROR_NOSPC,
60 G_IO_CHANNEL_ERROR_NXIO,
61 G_IO_CHANNEL_ERROR_OVERFLOW,
62 G_IO_CHANNEL_ERROR_PIPE,
64 G_IO_CHANNEL_ERROR_PCHAR_FLUSH,
65 /* Unconverted partial UTF-8 chars in buffer during flush */
66 G_IO_CHANNEL_ERROR_FAILED
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
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,
116 gchar *line_term; /* String which indicates the end of a line of text */
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 */
124 /* Group the flags together, immediately after partial_write_buf, to save memory */
126 gboolean use_buffer : 1; /* The encoding uses the buffers */
127 gboolean do_encode : 1; /* The encoding uses the GIConv coverters */
131 gboolean close_on_unref : 1; /* Close the channel on final unref */
133 /* The is_readable and is_writeable flags should really be marked
134 * <protected> instead of <private>. Some applications of GIOChannel,
135 * like GNet which implements the unix shutdown function to partially
136 * or completely disconnect sockets, may need to set these. For most
137 * cases, people won't need to touch them.
142 gboolean is_readable : 1; /* Cached GIOFlag */
143 gboolean is_writeable : 1; /* ditto */
144 gboolean is_seekable : 1; /* ditto */
147 typedef gboolean (*GIOFunc) (GIOChannel *source,
148 GIOCondition condition,
152 GIOStatus (*io_read) (GIOChannel *channel,
157 GIOStatus (*io_write) (GIOChannel *channel,
160 gsize *bytes_written,
162 GIOStatus (*io_seek) (GIOChannel *channel,
166 GIOStatus (*io_close) (GIOChannel *channel,
168 GSource* (*io_create_watch) (GIOChannel *channel,
169 GIOCondition condition);
170 void (*io_free) (GIOChannel *channel);
171 GIOStatus (*io_set_flags) (GIOChannel *channel,
174 GIOFlags (*io_get_flags) (GIOChannel *channel);
177 void g_io_channel_init (GIOChannel *channel);
178 void g_io_channel_ref (GIOChannel *channel);
179 void g_io_channel_unref (GIOChannel *channel);
181 #ifndef G_DISABLE_DEPRECATED
182 GIOError g_io_channel_read (GIOChannel *channel,
186 GIOError g_io_channel_write (GIOChannel *channel,
189 gsize *bytes_written);
190 GIOError g_io_channel_seek (GIOChannel *channel,
193 void g_io_channel_close (GIOChannel *channel);
194 #endif /* G_DISABLE_DEPRECATED */
196 GIOStatus g_io_channel_shutdown (GIOChannel *channel,
199 guint g_io_add_watch_full (GIOChannel *channel,
201 GIOCondition condition,
204 GDestroyNotify notify);
205 GSource * g_io_create_watch (GIOChannel *channel,
206 GIOCondition condition);
207 guint g_io_add_watch (GIOChannel *channel,
208 GIOCondition condition,
212 /* character encoding conversion involved functions.
215 void g_io_channel_set_buffer_size (GIOChannel *channel,
217 gsize g_io_channel_get_buffer_size (GIOChannel *channel);
218 GIOCondition g_io_channel_get_buffer_condition (GIOChannel *channel);
219 GIOStatus g_io_channel_set_flags (GIOChannel *channel,
222 GIOFlags g_io_channel_get_flags (GIOChannel *channel);
223 void g_io_channel_set_line_term (GIOChannel *channel,
224 const gchar *line_term);
225 G_CONST_RETURN gchar* g_io_channel_get_line_term (GIOChannel *channel);
226 void g_io_channel_set_buffered (GIOChannel *channel,
228 gboolean g_io_channel_get_buffered (GIOChannel *channel);
229 GIOStatus g_io_channel_set_encoding (GIOChannel *channel,
230 const gchar *encoding,
232 G_CONST_RETURN gchar* g_io_channel_get_encoding (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_write_chars (GIOChannel *channel,
258 gsize *bytes_written,
260 GIOStatus g_io_channel_seek_position (GIOChannel *channel,
264 GIOChannel* g_io_channel_new_file (const gchar *filename,
270 GQuark g_io_channel_error_quark (void);
271 GIOChannelError g_io_channel_error_from_errno (gint en);
273 /* On Unix, IO channels created with this function for any file
274 * descriptor or socket.
276 * On Win32, this can be used either for files opened with the MSVCRT
277 * (the Microsoft run-time C library) _open() or _pipe, including file
278 * descriptors 0, 1 and 2 (corresponding to stdin, stdout and stderr),
279 * or for Winsock SOCKETs. If the parameter is a legal file
280 * descriptor, it is assumed to be such, otherwise it should be a
281 * SOCKET. This relies on SOCKETs and file descriptors not
282 * overlapping. If you want to be certain, call either
283 * g_io_channel_win32_new_fd() or g_io_channel_win32_new_socket()
284 * instead as appropriate.
286 * The term file descriptor as used in the context of Win32 refers to
287 * the emulated Unix-like file descriptors MSVCRT provides. The native
288 * corresponding concept is file HANDLE. There isn't as of yet a way to
289 * get GIOChannels for Win32 file HANDLEs.
291 GIOChannel* g_io_channel_unix_new (int fd);
292 gint g_io_channel_unix_get_fd (GIOChannel *channel);
296 #define G_WIN32_MSG_HANDLE 19981206
298 /* Use this to get a GPollFD from a GIOChannel, so that you can call
299 * g_io_channel_win32_poll(). After calling this you should only use
300 * g_io_channel_read() to read from the GIOChannel, i.e. never read()
301 * from the underlying file descriptor. For SOCKETs, it is possible to call
304 void g_io_channel_win32_make_pollfd (GIOChannel *channel,
305 GIOCondition condition,
308 /* This can be used to wait a until at least one of the channels is readable.
309 * On Unix you would do a select() on the file descriptors of the channels.
311 gint g_io_channel_win32_poll (GPollFD *fds,
315 /* This is used to add polling for Windows messages. GDK (GTk+) programs
316 * should *not* use this.
318 void g_main_poll_win32_msg_add (gint priority,
322 /* Create an IO channel for Windows messages for window handle hwnd. */
323 GIOChannel *g_io_channel_win32_new_messages (guint hwnd);
325 /* Create an IO channel for C runtime (emulated Unix-like) file
326 * descriptors. After calling g_io_add_watch() on a IO channel
327 * returned by this function, you shouldn't call read() on the file
328 * descriptor. This is because adding polling for a file descriptor is
329 * implemented on Win32 by starting a thread that sits blocked in a
330 * read() from the file descriptor most of the time. All reads from
331 * the file descriptor should be done by this internal GLib
332 * thread. Your code should call only g_io_channel_read().
334 GIOChannel* g_io_channel_win32_new_fd (gint fd);
336 /* Get the C runtime file descriptor of a channel. */
337 gint g_io_channel_win32_get_fd (GIOChannel *channel);
339 /* Create an IO channel for a winsock socket. The parameter should be
340 * a SOCKET. Contrary to IO channels for file descriptors (on *Win32),
341 * you can use normal recv() or recvfrom() on sockets even if GLib
344 GIOChannel *g_io_channel_win32_new_socket (gint socket);
350 #endif /* __G_IOCHANNEL_H__ */