1 /* GLIB - Library of useful routines for C programming
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * giochannel.c: IO Channel abstraction
5 * Copyright 1998 Owen Taylor
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
24 * Modified by the GLib Team and others 1997-2000. See the AUTHORS
25 * file for a list of people on the GLib Team. See the ChangeLog
26 * files for a list of changes. These files are distributed with
27 * GLib at ftp://ftp.gtk.org/pub/gtk/.
35 #include "giochannel.h"
44 #undef G_DISABLE_DEPRECATED
50 #define G_IO_NICE_BUF_SIZE 1024
52 /* This needs to be as wide as the largest character in any possible encoding */
53 #define MAX_CHAR_SIZE 10
55 /* Some simplifying macros, which reduce the need to worry whether the
56 * buffers have been allocated. These also make USE_BUF () an lvalue,
57 * which is used in g_io_channel_read_to_end ().
59 #define USE_BUF(channel) ((channel)->encoding ? (channel)->encoded_read_buf \
60 : (channel)->read_buf)
61 #define BUF_LEN(string) ((string) ? (string)->len : 0)
63 static GIOError g_io_error_get_from_g_error (GIOStatus status,
65 static void g_io_channel_purge (GIOChannel *channel);
66 static GIOStatus g_io_channel_fill_buffer (GIOChannel *channel,
68 static GIOStatus g_io_channel_read_line_backend (GIOChannel *channel,
70 gsize *terminator_pos,
74 g_io_channel_init (GIOChannel *channel)
76 channel->ref_count = 1;
77 channel->encoding = g_strdup ("UTF-8");
78 channel->line_term = NULL;
79 channel->buf_size = G_IO_NICE_BUF_SIZE;
80 channel->read_cd = (GIConv) -1;
81 channel->write_cd = (GIConv) -1;
82 channel->read_buf = NULL; /* Lazy allocate buffers */
83 channel->encoded_read_buf = NULL;
84 channel->write_buf = NULL;
85 channel->partial_write_buf[0] = '\0';
86 channel->use_buffer = TRUE;
87 channel->do_encode = FALSE;
88 channel->close_on_unref = FALSE;
92 g_io_channel_ref (GIOChannel *channel)
94 g_return_if_fail (channel != NULL);
100 g_io_channel_unref (GIOChannel *channel)
102 g_return_if_fail (channel != NULL);
104 channel->ref_count--;
105 if (channel->ref_count == 0)
107 if (channel->close_on_unref)
108 g_io_channel_shutdown (channel, TRUE, NULL);
110 g_io_channel_purge (channel);
111 g_free (channel->encoding);
112 if (channel->read_cd != (GIConv) -1)
113 g_iconv_close (channel->read_cd);
114 if (channel->write_cd != (GIConv) -1)
115 g_iconv_close (channel->write_cd);
116 g_free (channel->line_term);
117 if (channel->read_buf)
118 g_string_free (channel->read_buf, TRUE);
119 if (channel->write_buf)
120 g_string_free (channel->write_buf, TRUE);
121 if (channel->encoded_read_buf)
122 g_string_free (channel->encoded_read_buf, TRUE);
123 channel->funcs->io_free (channel);
128 g_io_error_get_from_g_error (GIOStatus status,
133 case G_IO_STATUS_NORMAL:
134 case G_IO_STATUS_EOF:
135 return G_IO_ERROR_NONE;
136 case G_IO_STATUS_AGAIN:
137 return G_IO_ERROR_AGAIN;
138 case G_IO_STATUS_ERROR:
139 if (err->domain != G_IO_CHANNEL_ERROR)
140 return G_IO_ERROR_UNKNOWN;
143 case G_IO_CHANNEL_ERROR_INVAL:
144 return G_IO_ERROR_INVAL;
146 return G_IO_ERROR_UNKNOWN;
149 g_assert_not_reached ();
150 return G_IO_ERROR_UNKNOWN; /* Keep the compiler happy */
156 * @channel: a #GIOChannel.
157 * @buf: a buffer to read the data into (which should be at least count bytes long).
158 * @count: the number of bytes to read from the #GIOChannel.
159 * @bytes_read: returns the number of bytes actually read.
161 * Reads data from a #GIOChannel. This function is depricated. New code should
162 * use g_io_channel_read_chars() instead.
164 * Return value: %G_IO_ERROR_NONE if the operation was successful.
167 g_io_channel_read (GIOChannel *channel,
176 g_return_val_if_fail (channel != NULL, G_IO_ERROR_UNKNOWN);
177 g_return_val_if_fail (bytes_read != NULL, G_IO_ERROR_UNKNOWN);
179 status = channel->funcs->io_read (channel, buf, count, bytes_read, &err);
181 error = g_io_error_get_from_g_error (status, err);
190 * g_io_channel_write:
191 * @channel: a #GIOChannel.
192 * @buf: the buffer containing the data to write.
193 * @count: the number of bytes to write.
194 * @bytes_written: the number of bytes actually written.
196 * Writes data to a #GIOChannel. This function is depricated. New code should
197 * use g_io_channel_write_chars() instead.
199 * Return value: %G_IO_ERROR_NONE if the operation was successful.
202 g_io_channel_write (GIOChannel *channel,
205 gsize *bytes_written)
211 g_return_val_if_fail (channel != NULL, G_IO_ERROR_UNKNOWN);
212 g_return_val_if_fail (bytes_written != NULL, G_IO_ERROR_UNKNOWN);
214 status = channel->funcs->io_write (channel, buf, count, bytes_written, &err);
216 error = g_io_error_get_from_g_error (status, err);
226 * @channel: a #GIOChannel.
227 * @offset: an offset, in bytes, which is added to the position specified by @type
228 * @type: the position in the file, which can be %G_SEEK_CUR (the current
229 * position), %G_SEEK_SET (the start of the file), or %G_SEEK_END (the end of the
232 * Sets the current position in the #GIOChannel, similar to the standard library
233 * function fseek(). This function is depricated. New code should
234 * use g_io_channel_seek_position() instead.
236 * Return value: %G_IO_ERROR_NONE if the operation was successful.
239 g_io_channel_seek (GIOChannel *channel,
247 g_return_val_if_fail (channel != NULL, G_IO_ERROR_UNKNOWN);
248 g_return_val_if_fail (channel->is_seekable, G_IO_ERROR_UNKNOWN);
257 g_warning ("g_io_channel_seek: unknown seek type");
258 return G_IO_ERROR_UNKNOWN;
261 status = channel->funcs->io_seek (channel, offset, type, &err);
263 error = g_io_error_get_from_g_error (status, err);
271 /* The function g_io_channel_new_file() is prototyped in both
272 * giounix.c and giowin32.c, so we stick its documentation here.
276 * g_io_channel_new_file:
277 * @filename: A string containing the name of a file.
278 * @mode: One of "r", "w", "a", "r+", "w+", "a+". These have
279 * the same meaning as in fopen().
280 * @error: A location to return an error of type %G_IO_FILE_ERROR.
282 * Open a file @filename as a #GIOChannel using mode @mode. This
283 * channel will be closed when the last reference to it is dropped,
284 * so there is no need to call g_io_channel_close() (though doing
285 * so will not cause problems, as long as no attempt is made to
286 * access the channel after it is closed).
288 * Return value: A #GIOChannel on success, %NULL on failure.
292 * g_io_channel_close:
293 * @channel: A #GIOChannel
295 * Close an IO channel. Any pending data to be written will be
296 * flushed, ignoring errors. The channel will not be freed until the
297 * last reference is dropped using g_io_channel_unref(). This
298 * function is deprecated: you should use g_io_channel_shutdown()
302 g_io_channel_close (GIOChannel *channel)
306 g_return_if_fail (channel != NULL);
308 g_io_channel_purge (channel);
310 channel->funcs->io_close (channel, &err);
313 { /* No way to return the error */
314 g_warning ("Error closing channel: %s", err->message);
318 channel->close_on_unref = FALSE; /* Because we already did */
319 channel->is_readable = FALSE;
320 channel->is_writeable = FALSE;
321 channel->is_seekable = FALSE;
325 * g_io_channel_shutdown:
326 * @channel: a #GIOChannel
327 * @flush: if %TRUE, flush pending
328 * @err: location to store a #GIOChannelError
330 * Close an IO channel. Any pending data to be written will be
331 * flushed. The channel will not be freed until the
332 * last reference is dropped using g_io_channel_unref().
337 g_io_channel_shutdown (GIOChannel *channel,
341 GIOStatus status, result;
342 GError *tmperr = NULL;
344 g_return_val_if_fail (channel != NULL, G_IO_STATUS_ERROR);
345 g_return_val_if_fail (err == NULL || *err == NULL, G_IO_STATUS_ERROR);
347 if (flush && channel->write_buf && channel->write_buf->len > 0)
351 /* Set the channel to blocking, to avoid a busy loop
353 flags = g_io_channel_get_flags (channel);
354 /* Ignore any errors here, they're irrelevant */
355 g_io_channel_set_flags (channel, flags & ~G_IO_FLAG_NONBLOCK, NULL);
357 result = g_io_channel_flush (channel, &tmperr);
359 if (channel->partial_write_buf[0] != '\0')
361 g_warning ("Partial character at end of write buffer not flushed.\n");
362 channel->partial_write_buf[0] = '\0';
366 result = G_IO_STATUS_NORMAL;
368 status = channel->funcs->io_close (channel, err);
370 channel->close_on_unref = FALSE; /* Because we already did */
371 channel->is_readable = FALSE;
372 channel->is_writeable = FALSE;
373 channel->is_seekable = FALSE;
375 if (status != G_IO_STATUS_NORMAL)
377 g_clear_error (&tmperr);
380 else if (result != G_IO_STATUS_NORMAL)
382 g_propagate_error (err, tmperr);
386 return G_IO_STATUS_NORMAL;
389 /* This function is used for the final flush on close or unref */
391 g_io_channel_purge (GIOChannel *channel)
396 g_return_if_fail (channel != NULL);
398 if (channel->write_buf && channel->write_buf->len > 0)
402 /* Set the channel to blocking, to avoid a busy loop
404 flags = g_io_channel_get_flags (channel);
405 g_io_channel_set_flags (channel, flags & ~G_IO_FLAG_NONBLOCK, NULL);
407 status = g_io_channel_flush (channel, &err);
410 { /* No way to return the error */
411 g_warning ("Error flushing string: %s", err->message);
416 /* Flush these in case anyone tries to close without unrefing */
418 if (channel->read_buf)
419 g_string_truncate (channel->read_buf, 0);
420 if (channel->write_buf)
421 g_string_truncate (channel->write_buf, 0);
422 if (channel->encoding)
424 if (channel->encoded_read_buf)
425 g_string_truncate (channel->encoded_read_buf, 0);
427 if (channel->partial_write_buf[0] != '\0')
429 g_warning ("Partial character at end of write buffer not flushed.\n");
430 channel->partial_write_buf[0] = '\0';
436 g_io_create_watch (GIOChannel *channel,
437 GIOCondition condition)
439 g_return_val_if_fail (channel != NULL, NULL);
441 return channel->funcs->io_create_watch (channel, condition);
445 g_io_add_watch_full (GIOChannel *channel,
447 GIOCondition condition,
450 GDestroyNotify notify)
455 g_return_val_if_fail (channel != NULL, 0);
457 source = g_io_create_watch (channel, condition);
459 if (priority != G_PRIORITY_DEFAULT)
460 g_source_set_priority (source, priority);
461 g_source_set_callback (source, (GSourceFunc)func, user_data, notify);
463 id = g_source_attach (source, NULL);
464 g_source_unref (source);
470 g_io_add_watch (GIOChannel *channel,
471 GIOCondition condition,
475 return g_io_add_watch_full (channel, G_PRIORITY_DEFAULT, condition, func, user_data, NULL);
479 * g_io_channel_get_buffer_condition:
480 * @channel: A #GIOChannel
482 * This function returns a #GIOCondition depending on the status of the
483 * internal buffers in the #GIOChannel. Only the flags %G_IO_IN and
484 * %G_IO_OUT will be set.
486 * Return value: A #GIOCondition
489 g_io_channel_get_buffer_condition (GIOChannel *channel)
491 GIOCondition condition = 0;
493 if (channel->encoding)
495 if (channel->encoded_read_buf && (channel->encoded_read_buf->len > 0))
496 condition |= G_IO_IN; /* Only return if we have full characters */
500 if (channel->read_buf && (channel->read_buf->len > 0))
501 condition |= G_IO_IN;
504 if (channel->write_buf && (channel->write_buf->len < channel->buf_size))
505 condition |= G_IO_OUT;
511 * g_io_channel_error_from_errno:
512 * @en: An errno error number, e.g. EINVAL
514 * Return value: A #GIOChannelError error number, e.g. %G_IO_CHANNEL_ERROR_INVAL
517 g_io_channel_error_from_errno (gint en)
520 g_return_val_if_fail (en != EAGAIN, G_IO_CHANNEL_ERROR_FAILED);
523 g_return_val_if_fail (en != EINTR, G_IO_CHANNEL_ERROR_FAILED);
530 g_warning("Invalid file descriptor.\n");
531 return G_IO_CHANNEL_ERROR_FAILED;
536 g_warning("File descriptor outside valid address space.\n");
537 return G_IO_CHANNEL_ERROR_FAILED;
542 return G_IO_CHANNEL_ERROR_FBIG;
547 return G_IO_CHANNEL_ERROR_INVAL;
552 return G_IO_CHANNEL_ERROR_IO;
557 return G_IO_CHANNEL_ERROR_ISDIR;
562 return G_IO_CHANNEL_ERROR_NOSPC;
567 return G_IO_CHANNEL_ERROR_NXIO;
572 return G_IO_CHANNEL_ERROR_OVERFLOW;
577 return G_IO_CHANNEL_ERROR_PIPE;
581 return G_IO_CHANNEL_ERROR_FAILED;
586 * g_io_channel_set_buffer_size:
587 * @channel: a #GIOChannel
588 * @size: the size of the buffer. 0 == pick a good size
590 * Set the buffer size.
593 g_io_channel_set_buffer_size (GIOChannel *channel,
596 g_return_if_fail (channel != NULL);
599 size = G_IO_NICE_BUF_SIZE;
601 if (size < MAX_CHAR_SIZE)
602 size = MAX_CHAR_SIZE;
604 channel->buf_size = size;
608 * g_io_channel_get_buffer_size:
609 * @channel: a #GIOChannel
611 * Get the buffer size.
613 * Return value: the size of the buffer.
616 g_io_channel_get_buffer_size (GIOChannel *channel)
618 g_return_val_if_fail (channel != NULL, 0);
620 return channel->buf_size;
624 * g_io_channel_set_line_term:
625 * @channel: a #GIOChannel
626 * @line_term: The line termination string. Use %NULL for auto detect.
628 * This sets the string that #GIOChannel uses to determine
629 * where in the file a line break occurs.
632 g_io_channel_set_line_term (GIOChannel *channel,
633 const gchar *line_term)
635 g_return_if_fail (channel != NULL);
636 g_return_if_fail (!line_term || line_term[0]); /* Disallow "" */
637 g_return_if_fail (!line_term || g_utf8_validate (line_term, -1, NULL));
638 /* Require valid UTF-8 */
640 g_free (channel->line_term);
641 channel->line_term = g_strdup (line_term);
645 * g_io_channel_get_line_term:
646 * @channel: a #GIOChannel
648 * This returns the string that #GIOChannel uses to determine
649 * where in the file a line break occurs. A value of %NULL
650 * indicates auto detection.
652 * Return value: The line termination string. This value
653 * is owned by GLib and must not be freed.
655 G_CONST_RETURN gchar*
656 g_io_channel_get_line_term (GIOChannel *channel)
658 g_return_val_if_fail (channel != NULL, 0);
660 return channel->line_term;
664 * g_io_channel_set_flags:
665 * @channel: a #GIOChannel
666 * @flags: the flags to set on the channel
667 * @error: A location to return an error of type #GIOChannelError
672 g_io_channel_set_flags (GIOChannel *channel,
676 g_return_val_if_fail (channel != NULL, G_IO_STATUS_ERROR);
677 g_return_val_if_fail ((error == NULL) || (*error == NULL),
680 return (* channel->funcs->io_set_flags)(channel,
681 flags & G_IO_FLAG_SET_MASK,
686 * g_io_channel_get_flags:
687 * @channel: a #GIOChannel
689 * Gets the current flags for a #GIOChannel, including read-only
690 * flags such as %G_IO_FLAG_IS_READABLE.
692 * Return value: the flags which are set on the channel
695 g_io_channel_get_flags (GIOChannel *channel)
699 g_return_val_if_fail (channel != NULL, G_IO_STATUS_ERROR);
701 flags = (* channel->funcs->io_get_flags) (channel);
703 /* Cross implementation code */
705 if (channel->is_seekable)
706 flags |= G_IO_FLAG_IS_SEEKABLE;
707 if (channel->is_readable)
708 flags |= G_IO_FLAG_IS_READABLE;
709 if (channel->is_writeable)
710 flags |= G_IO_FLAG_IS_WRITEABLE;
716 * g_io_channel_seek_position:
717 * @channel: a #GIOChannel
718 * @offset: The offset in bytes from the position specified by @type
719 * @type: a #GSeekType. The type %G_SEEK_CUR is only allowed if
720 * the channel has the default encoding or the
721 * encoding %G_IO_CHANNEL_ENCODE_RAW for raw file access.
722 * @error: A location to return an error of type #GIOChannelError
724 * Replacement for g_io_channel_seek() with the new API.
729 g_io_channel_seek_position (GIOChannel* channel,
736 /* For files, only one of the read and write buffers can contain data.
737 * For sockets, both can contain data.
740 g_return_val_if_fail (channel != NULL, G_IO_STATUS_ERROR);
741 g_return_val_if_fail ((error == NULL) || (*error == NULL),
743 g_return_val_if_fail (channel->is_seekable, G_IO_STATUS_ERROR);
747 case G_SEEK_CUR: /* The user is seeking relative to the head of the buffer */
748 if (channel->use_buffer)
750 if (channel->do_encode && channel->encoded_read_buf
751 && channel->encoded_read_buf->len > 0)
753 g_warning ("Seek type G_SEEK_CUR not allowed for this"
754 " channel's encoding.\n");
755 return G_IO_STATUS_ERROR;
757 if (channel->read_buf)
758 offset -= channel->read_buf->len;
759 if (channel->encoded_read_buf)
761 g_assert (channel->encoded_read_buf->len == 0 || !channel->do_encode);
763 /* If there's anything here, it's because the encoding is UTF-8,
764 * so we can just subtract the buffer length, the same as for
765 * the unencoded data.
768 offset -= channel->encoded_read_buf->len;
776 g_warning ("g_io_channel_seek_position: unknown seek type");
777 return G_IO_STATUS_ERROR;
780 if (channel->use_buffer)
782 status = g_io_channel_flush (channel, error);
783 if (status != G_IO_STATUS_NORMAL)
787 status = channel->funcs->io_seek (channel, offset, type, error);
789 if ((status == G_IO_STATUS_NORMAL) && (channel->use_buffer))
791 if (channel->read_buf)
792 g_string_truncate (channel->read_buf, 0);
794 /* Conversion state no longer matches position in file */
795 if (channel->read_cd != (GIConv) -1)
796 g_iconv (channel->read_cd, NULL, NULL, NULL, NULL);
797 if (channel->write_cd != (GIConv) -1)
798 g_iconv (channel->write_cd, NULL, NULL, NULL, NULL);
800 if (channel->encoded_read_buf)
802 g_assert (channel->encoded_read_buf->len == 0 || !channel->do_encode);
803 g_string_truncate (channel->encoded_read_buf, 0);
806 if (channel->partial_write_buf[0] != '\0')
808 g_warning ("Partial character at end of write buffer not flushed.\n");
809 channel->partial_write_buf[0] = '\0';
817 * g_io_channel_flush:
818 * @channel: a #GIOChannel
819 * @error: location to store an error of type #GIOChannelError
821 * Flush the write buffer for the GIOChannel.
823 * Return value: the status of the operation: One of
824 * G_IO_CHANNEL_NORMAL, G_IO_CHANNEL_AGAIN, or
825 * G_IO_CHANNEL_ERROR.
828 g_io_channel_flush (GIOChannel *channel,
832 gsize this_time = 1, bytes_written = 0;
834 g_return_val_if_fail (channel != NULL, G_IO_STATUS_ERROR);
835 g_return_val_if_fail ((error == NULL) || (*error == NULL), G_IO_STATUS_ERROR);
837 if (channel->write_buf == NULL || channel->write_buf->len == 0)
838 return G_IO_STATUS_NORMAL;
842 g_assert (this_time > 0);
844 status = channel->funcs->io_write (channel,
845 channel->write_buf->str + bytes_written,
846 channel->write_buf->len - bytes_written,
848 bytes_written += this_time;
850 while ((bytes_written < channel->write_buf->len)
851 && (status == G_IO_STATUS_NORMAL));
853 g_string_erase (channel->write_buf, 0, bytes_written);
859 * g_io_channel_set_buffered:
860 * @channel: a #GIOChannel
861 * @buffered: whether to set the channel buffered or unbuffered
863 * The buffering state can only be set if the channel's encoding
864 * is %NULL. For any other encoding, the channel must be buffered.
866 * The default state of the channel is buffered.
869 g_io_channel_set_buffered (GIOChannel *channel,
872 g_return_if_fail (channel != NULL);
874 if (channel->encoding != NULL)
876 g_warning ("Need to have NULL encoding to set the buffering state of the "
881 g_return_if_fail (!channel->read_buf || channel->read_buf->len == 0);
882 g_return_if_fail (!channel->write_buf || channel->write_buf->len == 0);
884 channel->use_buffer = buffered;
888 * g_io_channel_get_buffered:
889 * @channel: a #GIOChannel
891 * Return Value: the buffering state of the channel
894 g_io_channel_get_buffered (GIOChannel *channel)
896 g_return_val_if_fail (channel != NULL, FALSE);
898 return channel->use_buffer;
902 * g_io_channel_set_encoding:
903 * @channel: a #GIOChannel
904 * @encoding: the encoding type
905 * @error: location to store an error of type #GConvertError.
907 * Set the encoding for the input/output of the channel. The internal
908 * encoding is always UTF-8. The default encoding for the
909 * external file is UTF-8.
911 * The encoding %NULL is safe to use with binary data.
912 * Encodings other than %NULL must use a buffered channel.
913 * Encodings other than %NULL and UTF-8 cannot
914 * use g_io_channel_seek_position() with seek type %G_SEEK_CUR,
915 * and cannot mix reading and writing if the channel is
916 * a file without first doing a seek of type %G_SEEK_SET or
919 * The encoding can only be set under three conditions:
921 * 1. The channel was just created, and has not been written to
924 * 2. The channel is a file, and the file pointer was just
925 * repositioned by a call to g_io_channel_seek_position().
926 * (This flushes all the internal buffers.)
928 * 3. The current encoding is %NULL or UTF-8.
930 * Return Value: %G_IO_STATUS_NORMAL if the encoding was succesfully set.
933 g_io_channel_set_encoding (GIOChannel *channel,
934 const gchar *encoding,
937 GIConv read_cd, write_cd;
940 g_return_val_if_fail (channel != NULL, G_IO_STATUS_ERROR);
941 g_return_val_if_fail ((error == NULL) || (*error == NULL), G_IO_STATUS_ERROR);
943 /* Make sure the encoded buffers are empty */
945 g_return_val_if_fail (!channel->do_encode || !channel->encoded_read_buf ||
946 channel->encoded_read_buf->len == 0, G_IO_STATUS_ERROR);
948 if (!channel->use_buffer)
950 g_warning ("Need to set the channel buffered before setting the encoding.\n");
951 g_warning ("Assuming this is what you meant and acting accordingly.\n");
953 channel->use_buffer = TRUE;
956 if (channel->partial_write_buf[0] != '\0')
958 g_warning ("Partial character at end of write buffer not flushed.\n");
959 channel->partial_write_buf[0] = '\0';
962 did_encode = channel->do_encode;
964 if (!encoding || strcmp (encoding, "UTF8") == 0 || strcmp (encoding, "UTF-8") == 0)
966 channel->do_encode = FALSE;
967 read_cd = write_cd = (GIConv) -1;
972 const gchar *from_enc = NULL, *to_enc = NULL;
974 if (channel->is_readable)
976 read_cd = g_iconv_open ("UTF-8", encoding);
978 if (read_cd == (GIConv) -1)
986 read_cd = (GIConv) -1;
988 if (channel->is_writeable && err == 0)
990 write_cd = g_iconv_open (encoding, "UTF-8");
992 if (write_cd == (GIConv) -1)
1000 write_cd = (GIConv) -1;
1004 g_assert (from_enc);
1008 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_NO_CONVERSION,
1009 _("Conversion from character set `%s' to `%s' is not supported"),
1012 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_FAILED,
1013 _("Could not open converter from `%s' to `%s': %s"),
1014 from_enc, to_enc, strerror (err));
1016 if (read_cd != (GIConv) -1)
1017 g_iconv_close (read_cd);
1018 if (write_cd != (GIConv) -1)
1019 g_iconv_close (write_cd);
1021 return G_IO_STATUS_ERROR;
1024 channel->do_encode = TRUE;
1027 /* The encoding is ok, so set the fields in channel */
1029 if (channel->read_cd != (GIConv) -1)
1030 g_iconv_close (channel->read_cd);
1031 if (channel->write_cd != (GIConv) -1)
1032 g_iconv_close (channel->write_cd);
1034 if (channel->encoded_read_buf && channel->encoded_read_buf->len > 0)
1036 g_assert (!did_encode); /* Encoding UTF-8, NULL doesn't use encoded_read_buf */
1038 /* This is just validated UTF-8, so we can copy it back into read_buf
1039 * so it can be encoded in whatever the new encoding is.
1042 g_string_prepend_len (channel->read_buf, channel->encoded_read_buf->str,
1043 channel->encoded_read_buf->len);
1044 g_string_truncate (channel->encoded_read_buf, 0);
1047 channel->read_cd = read_cd;
1048 channel->write_cd = write_cd;
1050 g_free (channel->encoding);
1051 channel->encoding = g_strdup (encoding);
1053 return G_IO_STATUS_NORMAL;
1057 * g_io_channel_get_encoding:
1058 * @channel: a #GIOChannel
1060 * Get the encoding for the input/output of the channel. The internal
1061 * encoding is always UTF-8. The encoding %G_IO_CHANNEL_ENCODE_RAW
1062 * disables encoding and turns off internal buffering. Both
1063 * %G_IO_CHANNEL_ENCODE_RAW and the default (no encoding, but buffered)
1064 * are safe to use with binary data.
1066 * Return value: A string containing the encoding, this string is
1067 * owned by GLib and must not be freed.
1069 G_CONST_RETURN gchar*
1070 g_io_channel_get_encoding (GIOChannel *channel)
1072 g_return_val_if_fail (channel != NULL, NULL);
1074 return channel->encoding;
1078 g_io_channel_fill_buffer (GIOChannel *channel,
1081 gsize read_size, cur_len, oldlen;
1084 if (channel->is_seekable && channel->write_buf && channel->write_buf->len > 0)
1086 status = g_io_channel_flush (channel, err);
1087 if (status != G_IO_STATUS_NORMAL)
1090 if (channel->is_seekable && channel->partial_write_buf[0] != '\0')
1092 g_warning ("Partial character at end of write buffer not flushed.\n");
1093 channel->partial_write_buf[0] = '\0';
1096 if (!channel->read_buf)
1097 channel->read_buf = g_string_sized_new (channel->buf_size);
1099 cur_len = channel->read_buf->len;
1101 g_string_set_size (channel->read_buf, channel->read_buf->len + channel->buf_size);
1103 status = channel->funcs->io_read (channel, channel->read_buf->str + cur_len,
1104 channel->buf_size, &read_size, err);
1106 g_assert ((status == G_IO_STATUS_NORMAL) || (read_size == 0));
1108 g_string_truncate (channel->read_buf, read_size + cur_len);
1110 if ((status != G_IO_STATUS_NORMAL)
1111 && ((status != G_IO_STATUS_EOF) || (channel->read_buf->len == 0)))
1114 g_assert (channel->read_buf->len > 0);
1116 if (channel->encoded_read_buf)
1117 oldlen = channel->encoded_read_buf->len;
1121 if (channel->encoding)
1122 channel->encoded_read_buf = g_string_sized_new (channel->buf_size);
1125 if (channel->do_encode)
1127 size_t errnum, inbytes_left, outbytes_left;
1128 gchar *inbuf, *outbuf;
1131 g_assert (channel->encoded_read_buf);
1135 inbytes_left = channel->read_buf->len;
1136 outbytes_left = MAX (6, MAX (channel->read_buf->len,
1137 channel->encoded_read_buf->allocated_len
1138 - channel->encoded_read_buf->len));
1140 inbuf = channel->read_buf->str;
1141 outbuf = channel->encoded_read_buf->str + channel->encoded_read_buf->len;
1143 g_string_set_size (channel->encoded_read_buf,
1144 channel->encoded_read_buf->len + outbytes_left);
1146 errnum = g_iconv (channel->read_cd, &inbuf, &inbytes_left,
1147 &outbuf, &outbytes_left);
1150 g_assert (inbuf + inbytes_left == channel->read_buf->str
1151 + channel->read_buf->len);
1152 g_assert (outbuf + outbytes_left == channel->encoded_read_buf->str
1153 + channel->encoded_read_buf->len);
1155 g_string_erase (channel->read_buf, 0,
1156 channel->read_buf->len - inbytes_left);
1157 g_string_truncate (channel->encoded_read_buf,
1158 channel->encoded_read_buf->len - outbytes_left);
1160 if (errnum == (size_t) -1)
1165 if ((oldlen == channel->encoded_read_buf->len)
1166 && (status == G_IO_STATUS_EOF))
1167 status = G_IO_STATUS_EOF;
1169 status = G_IO_STATUS_NORMAL;
1172 /* Buffer size at least 6, wrote at least on character */
1173 g_assert (inbuf != channel->read_buf->str);
1176 if (oldlen < channel->encoded_read_buf->len)
1177 status = G_IO_STATUS_NORMAL;
1180 g_set_error (err, G_CONVERT_ERROR,
1181 G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
1182 _("Invalid byte sequence in conversion input"));
1183 return G_IO_STATUS_ERROR;
1187 g_assert (errval != EBADF); /* The converter should be open */
1188 g_set_error (err, G_CONVERT_ERROR, G_CONVERT_ERROR_FAILED,
1189 _("Error during conversion: %s"), strerror (errval));
1190 return G_IO_STATUS_ERROR;
1193 g_assert ((status != G_IO_STATUS_NORMAL)
1194 || (channel->encoded_read_buf->len > 0));
1196 else if (channel->encoding) /* UTF-8 */
1198 gchar *nextchar, *lastchar;
1200 g_assert (channel->encoded_read_buf);
1202 nextchar = channel->read_buf->str;
1203 lastchar = channel->read_buf->str + channel->read_buf->len;
1205 while (nextchar < lastchar)
1209 val_char = g_utf8_get_char_validated (nextchar, lastchar - nextchar);
1214 /* stop, leave partial character in buffer */
1215 lastchar = nextchar;
1218 if (oldlen < channel->encoded_read_buf->len)
1219 status = G_IO_STATUS_NORMAL;
1222 g_set_error (err, G_CONVERT_ERROR,
1223 G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
1224 _("Invalid byte sequence in conversion input"));
1225 status = G_IO_STATUS_ERROR;
1227 lastchar = nextchar;
1230 nextchar = g_utf8_next_char (nextchar);
1235 if (lastchar > channel->read_buf->str)
1237 gint copy_len = lastchar - channel->read_buf->str;
1239 g_string_append_len (channel->encoded_read_buf, channel->read_buf->str,
1241 g_string_erase (channel->read_buf, 0, copy_len);
1249 * g_io_channel_read_line:
1250 * @channel: a #GIOChannel
1251 * @str_return: The line read from the #GIOChannel, not including the
1252 * line terminator. This data should be freed with g_free()
1253 * when no longer needed. This
1254 * is a null terminated string. If a @length of zero is
1255 * returned, this will be %NULL instead.
1256 * @length: location to store length of the read data, or %NULL
1257 * @terminator_pos: location to store position of line terminator, or %NULL
1258 * @error: A location to return an error of type #GConvertError
1259 * or #GIOChannelError
1261 * Read a line, not including the terminating character(s),
1262 * from a #GIOChannel into a newly allocated string.
1263 * @length will contain allocated memory if the return
1264 * is %G_IO_STATUS_NORMAL.
1266 * Return value: a newly allocated string. Free this string
1267 * with g_free() when you are done with it.
1270 g_io_channel_read_line (GIOChannel *channel,
1273 gsize *terminator_pos,
1279 g_return_val_if_fail (channel != NULL, G_IO_STATUS_ERROR);
1280 g_return_val_if_fail (str_return != NULL, G_IO_STATUS_ERROR);
1281 g_return_val_if_fail ((error == NULL) || (*error == NULL),
1283 g_return_val_if_fail (channel->is_readable, G_IO_STATUS_ERROR);
1285 status = g_io_channel_read_line_backend (channel, &got_length, terminator_pos, error);
1288 *length = got_length;
1290 if (status == G_IO_STATUS_NORMAL)
1292 g_assert (USE_BUF (channel));
1293 *str_return = g_strndup (USE_BUF (channel)->str, got_length);
1294 g_string_erase (USE_BUF (channel), 0, got_length);
1303 * g_io_channel_read_line_string:
1304 * @channel: a #GIOChannel
1305 * @buffer: a #GString into which the line will be written.
1306 * If @buffer already contains data, the new data will
1307 * be appended to it.
1308 * @terminator_pos: location to store position of line terminator, or %NULL
1309 * @error: a location to store an error of type #GConvertError
1310 * or #GIOChannelError
1312 * Read a line from a #GIOChannel, using a #GString as a buffer.
1317 g_io_channel_read_line_string (GIOChannel *channel,
1319 gsize *terminator_pos,
1325 g_return_val_if_fail (channel != NULL, G_IO_STATUS_ERROR);
1326 g_return_val_if_fail (buffer != NULL, G_IO_STATUS_ERROR);
1327 g_return_val_if_fail ((error == NULL) || (*error == NULL),
1329 g_return_val_if_fail (channel->is_readable, G_IO_STATUS_ERROR);
1331 if (buffer->len > 0)
1332 g_string_truncate (buffer, 0); /* clear out the buffer */
1334 status = g_io_channel_read_line_backend (channel, &length, terminator_pos, error);
1336 if (status == G_IO_STATUS_NORMAL)
1338 g_assert (USE_BUF (channel));
1339 g_string_append_len (buffer, USE_BUF (channel)->str, length);
1340 g_string_erase (USE_BUF (channel), 0, length);
1348 g_io_channel_read_line_backend (GIOChannel *channel,
1350 gsize *terminator_pos,
1354 gsize checked_to, line_term_len, line_length, got_term_len;
1355 gboolean first_time = TRUE;
1357 if (!channel->use_buffer)
1359 /* Can't do a raw read in read_line */
1360 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_FAILED,
1361 _("Can't do a raw read in g_io_channel_read_line_string"));
1362 return G_IO_STATUS_ERROR;
1365 status = G_IO_STATUS_NORMAL;
1367 if (channel->line_term)
1368 line_term_len = strlen (channel->line_term);
1371 /* This value used for setting checked_to, it's the longest of the four
1372 * we autodetect for.
1379 gchar *nextchar, *lastchar;
1382 if (!first_time || (BUF_LEN (USE_BUF (channel)) == 0))
1385 status = g_io_channel_fill_buffer (channel, error);
1388 case G_IO_STATUS_NORMAL:
1389 if (BUF_LEN (USE_BUF (channel)) == 0)
1390 /* Can happen when using conversion and only read
1391 * part of a character
1398 case G_IO_STATUS_EOF:
1399 if (BUF_LEN (USE_BUF (channel)) == 0)
1404 if (channel->encoding && channel->read_buf->len != 0)
1406 g_set_error (error, G_CONVERT_ERROR,
1407 G_CONVERT_ERROR_PARTIAL_INPUT,
1408 "Leftover unconverted data in read buffer");
1409 return G_IO_STATUS_ERROR;
1412 return G_IO_STATUS_EOF;
1422 g_assert (BUF_LEN (USE_BUF (channel)) != 0);
1424 use_buf = USE_BUF (channel); /* The buffer has been created by this point */
1428 lastchar = use_buf->str + strlen (use_buf->str);
1430 for (nextchar = use_buf->str + checked_to; nextchar < lastchar;
1431 channel->encoding ? nextchar = g_utf8_next_char (nextchar) : nextchar++)
1433 if (channel->line_term)
1435 if (strncmp (channel->line_term, nextchar, line_term_len) == 0)
1437 line_length = nextchar - use_buf->str;
1438 got_term_len = line_term_len;
1442 else /* auto detect */
1446 case '\n': /* unix */
1447 line_length = nextchar - use_buf->str;
1450 case '\r': /* Warning: do not use with sockets */
1451 line_length = nextchar - use_buf->str;
1452 if ((nextchar == lastchar - 1) && (status != G_IO_STATUS_EOF)
1453 && (lastchar == use_buf->str + use_buf->len))
1454 goto read_again; /* Try to read more data */
1455 if ((nextchar < lastchar - 1) && (*(nextchar + 1) == '\n')) /* dos */
1460 case '\xe2': /* Unicode paragraph separator */
1461 if (strncmp ("\xe2\x80\xa9", nextchar, 3) == 0)
1463 line_length = nextchar - use_buf->str;
1468 default: /* no match */
1474 g_assert (nextchar == lastchar); /* Valid UTF-8, didn't overshoot */
1476 /* Also terminate on '\0' */
1478 line_length = lastchar - use_buf->str;
1479 if (line_length < use_buf->len)
1487 if (status == G_IO_STATUS_EOF)
1489 if (channel->encoding && channel->read_buf->len > 0)
1491 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_PARTIAL_INPUT,
1492 "Channel terminates in a partial character");
1493 return G_IO_STATUS_ERROR;
1495 line_length = use_buf->len;
1500 if (use_buf->len > line_term_len - 1)
1501 checked_to = use_buf->len - (line_term_len - 1);
1509 *terminator_pos = line_length;
1512 *length = line_length + got_term_len;
1514 return G_IO_STATUS_NORMAL;
1518 * g_io_channel_read_to_end:
1519 * @channel: a #GIOChannel
1520 * @str_return: Location to store a pointer to a string holding
1521 * the remaining data in the #GIOChannel. This data should
1522 * be freed with g_free() when no longer needed. This
1523 * data is terminated by an extra null, but there may be other
1524 * nulls in the intervening data.
1525 * @length: Location to store length of the data
1526 * @error: A location to return an error of type #GConvertError
1527 * or #GIOChannelError
1529 * Read all the remaining data from the file. Parameters as
1530 * for g_io_channel_read_line.
1532 * Return value: One of #G_IO_STATUS_EOF or #G_IO_STATUS_PARTIAL_CHARS
1536 g_io_channel_read_to_end (GIOChannel *channel,
1543 g_return_val_if_fail (channel != NULL, G_IO_STATUS_ERROR);
1544 g_return_val_if_fail ((error == NULL) || (*error == NULL),
1546 g_return_val_if_fail (channel->is_readable, G_IO_STATUS_ERROR);
1553 if (!channel->use_buffer)
1555 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_FAILED,
1556 _("Can't do a raw read in g_io_channel_read_to_end"));
1557 return G_IO_STATUS_ERROR;
1561 status = g_io_channel_fill_buffer (channel, error);
1562 while (status == G_IO_STATUS_NORMAL);
1564 if (status != G_IO_STATUS_EOF)
1567 if (channel->encoding && channel->read_buf->len > 0)
1569 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_PARTIAL_INPUT,
1570 "Channel terminates in a partial character");
1571 return G_IO_STATUS_ERROR;
1574 if (USE_BUF (channel) == NULL)
1576 /* length is already set to zero */
1578 *str_return = g_strdup ("");
1583 *length = USE_BUF (channel)->len;
1586 *str_return = g_string_free (USE_BUF (channel), FALSE);
1588 g_string_free (USE_BUF (channel), TRUE);
1590 /* This only works because USE_BUF () is a macro */
1591 USE_BUF (channel) = NULL;
1594 return G_IO_STATUS_NORMAL;
1598 * g_io_channel_read_chars:
1599 * @channel: a #GIOChannel
1600 * @buf: a buffer to read data into
1601 * @count: the size of the buffer. Note that the buffer may
1602 * not be complelely filled even if there is data
1603 * in the buffer if the remaining data is not a
1604 * complete character.
1605 * @bytes_read: The number of bytes read.
1606 * @error: A location to return an error of type #GConvertError
1607 * or #GIOChannelError.
1609 * Replacement for g_io_channel_read() with the new API.
1614 g_io_channel_read_chars (GIOChannel *channel,
1623 g_return_val_if_fail (channel != NULL, G_IO_STATUS_ERROR);
1624 g_return_val_if_fail ((error == NULL) || (*error == NULL),
1626 g_return_val_if_fail (channel->is_readable, G_IO_STATUS_ERROR);
1631 return G_IO_STATUS_NORMAL;
1633 g_return_val_if_fail (buf != NULL, G_IO_STATUS_ERROR);
1635 if (!channel->use_buffer)
1637 g_assert (!channel->read_buf || channel->read_buf->len == 0);
1639 return channel->funcs->io_read (channel, buf, count, bytes_read, error);
1642 status = G_IO_STATUS_NORMAL;
1644 while (BUF_LEN (USE_BUF (channel)) < count && status == G_IO_STATUS_NORMAL)
1645 status = g_io_channel_fill_buffer (channel, error);
1647 /* Only return an error if we have no data */
1649 if (BUF_LEN (USE_BUF (channel)) == 0)
1651 g_assert (status != G_IO_STATUS_NORMAL);
1653 if (status == G_IO_STATUS_EOF && channel->encoding
1654 && BUF_LEN (channel->read_buf) > 0)
1656 g_set_error (error, G_CONVERT_ERROR,
1657 G_CONVERT_ERROR_PARTIAL_INPUT,
1658 "Leftover unconverted data in read buffer");
1659 status = G_IO_STATUS_ERROR;
1668 if (status == G_IO_STATUS_ERROR)
1669 g_clear_error (error);
1671 got_bytes = MIN (count, BUF_LEN (USE_BUF (channel)));
1673 g_assert (got_bytes > 0);
1675 if (channel->encoding)
1676 /* Don't validate for NULL encoding, binary safe */
1678 gchar *nextchar, *prevchar;
1680 g_assert (USE_BUF (channel) == channel->encoded_read_buf);
1682 nextchar = channel->encoded_read_buf->str;
1686 prevchar = nextchar;
1687 nextchar = g_utf8_next_char (nextchar);
1688 g_assert (nextchar != prevchar); /* Posibile for *prevchar of -1 or -2 */
1690 while (nextchar < channel->encoded_read_buf->str + got_bytes);
1692 if (nextchar > channel->encoded_read_buf->str + got_bytes)
1693 got_bytes = prevchar - channel->encoded_read_buf->str;
1695 g_assert (got_bytes > 0 || count < 6);
1698 memcpy (buf, USE_BUF (channel)->str, got_bytes);
1699 g_string_erase (USE_BUF (channel), 0, got_bytes);
1702 *bytes_read = got_bytes;
1704 return G_IO_STATUS_NORMAL;
1708 * g_io_channel_read_unichar:
1709 * @channel: a #GIOChannel
1710 * @thechar: a location to return a character
1711 * @error: A location to return an error of type #GConvertError
1712 * or #GIOChannelError
1714 * This function cannot be called on a channel with %NULL encoding.
1716 * Return value: a #GIOStatus
1719 g_io_channel_read_unichar (GIOChannel *channel,
1723 GIOStatus status = G_IO_STATUS_NORMAL;
1725 g_return_val_if_fail (channel != NULL, G_IO_STATUS_ERROR);
1726 g_return_val_if_fail (channel->encoding != NULL, G_IO_STATUS_ERROR);
1727 g_return_val_if_fail ((error == NULL) || (*error == NULL),
1729 g_return_val_if_fail (channel->is_readable, G_IO_STATUS_ERROR);
1731 while (BUF_LEN (channel->encoded_read_buf) == 0 && status == G_IO_STATUS_NORMAL)
1732 status = g_io_channel_fill_buffer (channel, error);
1734 /* Only return an error if we have no data */
1736 if (BUF_LEN (USE_BUF (channel)) == 0)
1738 g_assert (status != G_IO_STATUS_NORMAL);
1740 if (status == G_IO_STATUS_EOF && BUF_LEN (channel->read_buf) > 0)
1742 g_set_error (error, G_CONVERT_ERROR,
1743 G_CONVERT_ERROR_PARTIAL_INPUT,
1744 "Leftover unconverted data in read buffer");
1745 status = G_IO_STATUS_ERROR;
1749 *thechar = (gunichar) -1;
1754 if (status == G_IO_STATUS_ERROR)
1755 g_clear_error (error);
1758 *thechar = g_utf8_get_char (channel->encoded_read_buf->str);
1760 g_string_erase (channel->encoded_read_buf, 0,
1761 g_utf8_next_char (channel->encoded_read_buf->str)
1762 - channel->encoded_read_buf->str);
1764 return G_IO_STATUS_NORMAL;
1768 * g_io_channel_write_chars:
1769 * @channel: a #GIOChannel
1770 * @buf: a buffer to write data from
1771 * @count: the size of the buffer. If -1, the buffer
1772 * is taken to be a nul terminated string.
1773 * @bytes_written: The number of bytes written. This can be nonzero
1774 * even if the return value is not %G_IO_STATUS_NORMAL.
1775 * @error: A location to return an error of type #GConvertError
1776 * or #GIOChannelError
1778 * Replacement for g_io_channel_write() with the new API.
1783 g_io_channel_write_chars (GIOChannel *channel,
1786 gsize *bytes_written,
1790 gssize wrote_bytes = 0;
1792 g_return_val_if_fail (channel != NULL, G_IO_STATUS_ERROR);
1793 g_return_val_if_fail ((error == NULL) || (*error == NULL),
1795 g_return_val_if_fail (channel->is_writeable, G_IO_STATUS_ERROR);
1797 if ((count < 0) && buf)
1798 count = strlen (buf);
1801 return G_IO_STATUS_NORMAL;
1803 g_return_val_if_fail (buf != NULL, G_IO_STATUS_ERROR);
1804 g_return_val_if_fail (count > 0, G_IO_STATUS_ERROR);
1806 /* Raw write case */
1808 if (!channel->use_buffer)
1810 g_assert (!channel->write_buf || channel->write_buf->len == 0);
1811 g_assert (channel->partial_write_buf[0] == '\0');
1812 return channel->funcs->io_write (channel, buf, count, bytes_written, error);
1817 if (channel->is_seekable && (( BUF_LEN (channel->read_buf) > 0)
1818 || (BUF_LEN (channel->encoded_read_buf) > 0)))
1820 if (channel->do_encode && BUF_LEN (channel->encoded_read_buf) > 0)
1822 g_warning("Mixed reading and writing not allowed on encoded files");
1823 return G_IO_STATUS_ERROR;
1825 status = g_io_channel_seek_position (channel, 0, G_SEEK_CUR, error);
1826 if (status != G_IO_STATUS_NORMAL)
1830 if (!channel->write_buf)
1831 channel->write_buf = g_string_sized_new (channel->buf_size);
1833 while (wrote_bytes < count)
1837 /* If the buffer is full, try a write immediately. In
1838 * the nonblocking case, this prevents the user from
1839 * writing just a little bit to the buffer every time
1840 * and never receiving an EAGAIN.
1843 if (channel->write_buf->len >= channel->buf_size)
1845 gsize did_write = 0, this_time;
1849 status = channel->funcs->io_write (channel, channel->write_buf->str
1850 + did_write, channel->write_buf->len
1851 - did_write, &this_time, error);
1852 did_write += this_time;
1854 while (status == G_IO_STATUS_NORMAL &&
1855 did_write < MIN (channel->write_buf->len, MAX_CHAR_SIZE));
1857 g_string_erase (channel->write_buf, 0, did_write);
1859 if (status != G_IO_STATUS_NORMAL)
1861 if (status == G_IO_STATUS_AGAIN && wrote_bytes > 0)
1862 status = G_IO_STATUS_NORMAL;
1864 *bytes_written = wrote_bytes;
1869 space_in_buf = MAX (channel->buf_size, channel->write_buf->allocated_len)
1870 - channel->write_buf->len;
1872 /* This is only true because g_io_channel_set_buffer_size ()
1873 * ensures that channel->buf_size >= MAX_CHAR_SIZE.
1875 g_assert (space_in_buf >= MAX_CHAR_SIZE);
1877 if (!channel->encoding)
1879 gssize write_this = MIN (space_in_buf, count - wrote_bytes);
1881 g_string_append_len (channel->write_buf, buf, write_this);
1883 wrote_bytes += write_this;
1887 const gchar *from_buf;
1888 gsize from_buf_len, from_buf_old_len, left_len;
1892 if (channel->partial_write_buf[0] != '\0')
1894 g_assert (wrote_bytes == 0);
1896 from_buf = channel->partial_write_buf;
1897 from_buf_old_len = strlen (channel->partial_write_buf);
1898 g_assert (from_buf_old_len > 0);
1899 from_buf_len = MIN (6, from_buf_old_len + count);
1901 memcpy (channel->partial_write_buf + from_buf_old_len, buf,
1902 from_buf_len - from_buf_old_len);
1907 from_buf_len = count - wrote_bytes;
1908 from_buf_old_len = 0;
1913 if (!channel->do_encode)
1915 const gchar *badchar;
1917 /* UTF-8, just validate, emulate g_iconv */
1919 if (!g_utf8_validate (from_buf, from_buf_len, &badchar))
1923 left_len = from_buf + from_buf_len - badchar;
1925 try_char = g_utf8_get_char_validated (badchar, left_len);
1930 g_assert (left_len < 6);
1937 g_assert_not_reached ();
1938 errnum = 0; /* Don't confunse the compiler */
1949 g_string_append_len (channel->write_buf, from_buf,
1950 from_buf_len - left_len);
1951 from_buf += from_buf_len - left_len;
1957 left_len = from_buf_len;
1958 outbuf = channel->write_buf->str + channel->write_buf->len;
1959 g_string_set_size (channel->write_buf, channel->write_buf->len
1961 err = g_iconv (channel->write_cd, (gchar **) &from_buf, &left_len,
1962 &outbuf, &space_in_buf);
1964 g_string_truncate (channel->write_buf, channel->write_buf->len
1968 if (err == (size_t) -1)
1973 g_assert (left_len < 6);
1975 if (from_buf_old_len == 0)
1977 /* Not from partial_write_buf */
1979 memcpy (channel->partial_write_buf, from_buf, left_len);
1980 channel->partial_write_buf[left_len] = '\0';
1981 return G_IO_STATUS_NORMAL;
1984 /* Working in partial_write_buf */
1986 if (left_len == from_buf_len)
1988 /* Didn't convert anything, must still have
1989 * less than a full character
1992 g_assert (count == from_buf_len - from_buf_old_len);
1994 channel->partial_write_buf[from_buf_len] = '\0';
1997 *bytes_written = count;
1999 return G_IO_STATUS_NORMAL;
2002 g_assert (from_buf_len - left_len >= from_buf_old_len);
2004 /* We converted all the old data. This is fine */
2008 if (from_buf_len == left_len)
2010 /* Nothing was written, add enough space for
2011 * at least one character.
2013 space_in_buf += MAX_CHAR_SIZE;
2018 g_set_error (error, G_CONVERT_ERROR,
2019 G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
2020 _("Invalid byte sequence in conversion input"));
2021 if (from_buf_old_len > 0 && from_buf_len == left_len)
2022 g_warning ("Illegal sequence due to partial character "
2023 "at the end of a previous write.\n");
2025 wrote_bytes += from_buf_len - left_len - from_buf_old_len;
2027 *bytes_written = wrote_bytes;
2028 channel->partial_write_buf[0] = '\0';
2029 return G_IO_STATUS_ERROR;
2031 g_set_error (error, G_CONVERT_ERROR, G_CONVERT_ERROR_FAILED,
2032 _("Error during conversion: %s"), strerror (errnum));
2033 if (from_buf_len >= left_len + from_buf_old_len)
2034 wrote_bytes += from_buf_len - left_len - from_buf_old_len;
2036 *bytes_written = wrote_bytes;
2037 channel->partial_write_buf[0] = '\0';
2038 return G_IO_STATUS_ERROR;
2042 g_assert (from_buf_len - left_len >= from_buf_old_len);
2044 wrote_bytes += from_buf_len - left_len - from_buf_old_len;
2046 if (from_buf_old_len > 0)
2048 /* We were working in partial_write_buf */
2050 buf += from_buf_len - left_len - from_buf_old_len;
2051 channel->partial_write_buf[0] = '\0';
2059 *bytes_written = wrote_bytes;
2061 return G_IO_STATUS_NORMAL;
2065 * g_io_channel_write_unichar:
2066 * @channel: a #GIOChannel
2067 * @thechar: a character
2068 * @error: A location to return an error of type #GConvertError
2069 * or #GIOChannelError
2071 * This function cannot be called on a channel with %NULL encoding.
2073 * Return value: a #GIOStatus
2076 g_io_channel_write_unichar (GIOChannel *channel,
2081 gchar static_buf[6];
2082 gsize char_len, wrote_len;
2084 g_return_val_if_fail (channel != NULL, G_IO_STATUS_ERROR);
2085 g_return_val_if_fail (channel->encoding != NULL, G_IO_STATUS_ERROR);
2086 g_return_val_if_fail ((error == NULL) || (*error == NULL),
2088 g_return_val_if_fail (channel->is_writeable, G_IO_STATUS_ERROR);
2090 char_len = g_unichar_to_utf8 (thechar, static_buf);
2092 if (channel->partial_write_buf[0] != '\0')
2094 g_warning ("Partial charater written before writing unichar.\n");
2095 channel->partial_write_buf[0] = '\0';
2098 status = g_io_channel_write_chars (channel, static_buf,
2099 char_len, &wrote_len, error);
2101 /* We validate UTF-8, so we can't get a partial write */
2103 g_assert (wrote_len == char_len || status != G_IO_STATUS_NORMAL);
2109 * g_io_channel_error_quark:
2111 * Return value: The quark used as %G_IO_CHANNEL_ERROR
2114 g_io_channel_error_quark (void)
2116 static GQuark q = 0;
2118 q = g_quark_from_static_string ("g-io-channel-error-quark");