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/.
43 #include "giochannel.h"
45 #include "gstrfuncs.h"
46 #include "gtestutils.h"
53 * @short_description: portable support for using files, pipes and
55 * @see_also: <para> <variablelist> <varlistentry>
56 * <term>g_io_add_watch(), g_io_add_watch_full(),
57 * g_source_remove()</term> <listitem><para> Convenience
58 * functions for creating #GIOChannel instances and adding
59 * them to the <link linkend="glib-The-Main-Event-Loop">main
60 * event loop</link>. </para></listitem> </varlistentry>
61 * </variablelist> </para>
63 * The #GIOChannel data type aims to provide a portable method for
64 * using file descriptors, pipes, and sockets, and integrating them
65 * into the <link linkend="glib-The-Main-Event-Loop">main event
66 * loop</link>. Currently full support is available on UNIX platforms,
67 * support for Windows is only partially complete.
69 * To create a new #GIOChannel on UNIX systems use
70 * g_io_channel_unix_new(). This works for plain file descriptors,
71 * pipes and sockets. Alternatively, a channel can be created for a
72 * file in a system independent manner using g_io_channel_new_file().
74 * Once a #GIOChannel has been created, it can be used in a generic
75 * manner with the functions g_io_channel_read_chars(),
76 * g_io_channel_write_chars(), g_io_channel_seek_position(), and
77 * g_io_channel_shutdown().
79 * To add a #GIOChannel to the <link
80 * linkend="glib-The-Main-Event-Loop">main event loop</link> use
81 * g_io_add_watch() or g_io_add_watch_full(). Here you specify which
82 * events you are interested in on the #GIOChannel, and provide a
83 * function to be called whenever these events occur.
85 * #GIOChannel instances are created with an initial reference count of
86 * 1. g_io_channel_ref() and g_io_channel_unref() can be used to
87 * increment or decrement the reference count respectively. When the
88 * reference count falls to 0, the #GIOChannel is freed. (Though it
89 * isn't closed automatically, unless it was created using
90 * g_io_channel_new_file().) Using g_io_add_watch() or
91 * g_io_add_watch_full() increments a channel's reference count.
93 * The new functions g_io_channel_read_chars(),
94 * g_io_channel_read_line(), g_io_channel_read_line_string(),
95 * g_io_channel_read_to_end(), g_io_channel_write_chars(),
96 * g_io_channel_seek_position(), and g_io_channel_flush() should not be
97 * mixed with the deprecated functions g_io_channel_read(),
98 * g_io_channel_write(), and g_io_channel_seek() on the same channel.
104 * A data structure representing an IO Channel. The fields should be
105 * considered private and should only be accessed with the following
111 * @io_read: reads raw bytes from the channel. This is called from
112 * various functions such as g_io_channel_read_chars() to
113 * read raw bytes from the channel. Encoding and buffering
114 * issues are dealt with at a higher level.
115 * @io_write: writes raw bytes to the channel. This is called from
116 * various functions such as g_io_channel_write_chars() to
117 * write raw bytes to the channel. Encoding and buffering
118 * issues are dealt with at a higher level.
119 * @io_seek: (optional) seeks the channel. This is called from
120 * g_io_channel_seek() on channels that support it.
121 * @io_close: closes the channel. This is called from
122 * g_io_channel_close() after flushing the buffers.
123 * @io_create_watch: creates a watch on the channel. This call
124 * corresponds directly to g_io_create_watch().
125 * @io_free: called from g_io_channel_unref() when the channel needs to
126 * be freed. This function must free the memory associated
127 * with the channel, including freeing the #GIOChannel
128 * structure itself. The channel buffers have been flushed
129 * and possibly @io_close has been called by the time this
130 * function is called.
131 * @io_set_flags: sets the #GIOFlags on the channel. This is called
132 * from g_io_channel_set_flags() with all flags except
133 * for %G_IO_FLAG_APPEND and %G_IO_FLAG_NONBLOCK masked
135 * @io_get_flags: gets the #GIOFlags for the channel. This function
136 * need only return the %G_IO_FLAG_APPEND and
137 * %G_IO_FLAG_NONBLOCK flags; g_io_channel_get_flags()
138 * automatically adds the others as appropriate.
140 * A table of functions used to handle different types of #GIOChannel
146 * @G_IO_STATUS_ERROR: An error occurred.
147 * @G_IO_STATUS_NORMAL: Success.
148 * @G_IO_STATUS_EOF: End of file.
149 * @G_IO_STATUS_AGAIN: Resource temporarily unavailable.
151 * Stati returned by most of the #GIOFuncs functions.
156 * @G_IO_ERROR_NONE: no error
157 * @G_IO_ERROR_AGAIN: an EAGAIN error occurred
158 * @G_IO_ERROR_INVAL: an EINVAL error occurred
159 * @G_IO_ERROR_UNKNOWN: another error occurred
161 * #GIOError is only used by the deprecated functions
162 * g_io_channel_read(), g_io_channel_write(), and g_io_channel_seek().
165 #define G_IO_NICE_BUF_SIZE 1024
167 /* This needs to be as wide as the largest character in any possible encoding */
168 #define MAX_CHAR_SIZE 10
170 /* Some simplifying macros, which reduce the need to worry whether the
171 * buffers have been allocated. These also make USE_BUF () an lvalue,
172 * which is used in g_io_channel_read_to_end ().
174 #define USE_BUF(channel) ((channel)->encoding ? (channel)->encoded_read_buf \
175 : (channel)->read_buf)
176 #define BUF_LEN(string) ((string) ? (string)->len : 0)
178 static GIOError
g_io_error_get_from_g_error (GIOStatus status
,
180 static void g_io_channel_purge (GIOChannel
*channel
);
181 static GIOStatus
g_io_channel_fill_buffer (GIOChannel
*channel
,
183 static GIOStatus
g_io_channel_read_line_backend (GIOChannel
*channel
,
185 gsize
*terminator_pos
,
190 * @channel: a #GIOChannel
192 * Initializes a #GIOChannel struct.
194 * This is called by each of the above functions when creating a
195 * #GIOChannel, and so is not often needed by the application
196 * programmer (unless you are creating a new type of #GIOChannel).
199 g_io_channel_init (GIOChannel
*channel
)
201 channel
->ref_count
= 1;
202 channel
->encoding
= g_strdup ("UTF-8");
203 channel
->line_term
= NULL
;
204 channel
->line_term_len
= 0;
205 channel
->buf_size
= G_IO_NICE_BUF_SIZE
;
206 channel
->read_cd
= (GIConv
) -1;
207 channel
->write_cd
= (GIConv
) -1;
208 channel
->read_buf
= NULL
; /* Lazy allocate buffers */
209 channel
->encoded_read_buf
= NULL
;
210 channel
->write_buf
= NULL
;
211 channel
->partial_write_buf
[0] = '\0';
212 channel
->use_buffer
= TRUE
;
213 channel
->do_encode
= FALSE
;
214 channel
->close_on_unref
= FALSE
;
219 * @channel: a #GIOChannel
221 * Increments the reference count of a #GIOChannel.
223 * Returns: the @channel that was passed in (since 2.6)
226 g_io_channel_ref (GIOChannel
*channel
)
228 g_return_val_if_fail (channel
!= NULL
, NULL
);
230 g_atomic_int_inc (&channel
->ref_count
);
236 * g_io_channel_unref:
237 * @channel: a #GIOChannel
239 * Decrements the reference count of a #GIOChannel.
242 g_io_channel_unref (GIOChannel
*channel
)
246 g_return_if_fail (channel
!= NULL
);
248 is_zero
= g_atomic_int_dec_and_test (&channel
->ref_count
);
250 if (G_UNLIKELY (is_zero
))
252 if (channel
->close_on_unref
)
253 g_io_channel_shutdown (channel
, TRUE
, NULL
);
255 g_io_channel_purge (channel
);
256 g_free (channel
->encoding
);
257 if (channel
->read_cd
!= (GIConv
) -1)
258 g_iconv_close (channel
->read_cd
);
259 if (channel
->write_cd
!= (GIConv
) -1)
260 g_iconv_close (channel
->write_cd
);
261 g_free (channel
->line_term
);
262 if (channel
->read_buf
)
263 g_string_free (channel
->read_buf
, TRUE
);
264 if (channel
->write_buf
)
265 g_string_free (channel
->write_buf
, TRUE
);
266 if (channel
->encoded_read_buf
)
267 g_string_free (channel
->encoded_read_buf
, TRUE
);
268 channel
->funcs
->io_free (channel
);
273 g_io_error_get_from_g_error (GIOStatus status
,
278 case G_IO_STATUS_NORMAL
:
279 case G_IO_STATUS_EOF
:
280 return G_IO_ERROR_NONE
;
281 case G_IO_STATUS_AGAIN
:
282 return G_IO_ERROR_AGAIN
;
283 case G_IO_STATUS_ERROR
:
284 g_return_val_if_fail (err
!= NULL
, G_IO_ERROR_UNKNOWN
);
286 if (err
->domain
!= G_IO_CHANNEL_ERROR
)
287 return G_IO_ERROR_UNKNOWN
;
290 case G_IO_CHANNEL_ERROR_INVAL
:
291 return G_IO_ERROR_INVAL
;
293 return G_IO_ERROR_UNKNOWN
;
296 g_assert_not_reached ();
302 * @channel: a #GIOChannel
303 * @buf: a buffer to read the data into (which should be at least
305 * @count: the number of bytes to read from the #GIOChannel
306 * @bytes_read: returns the number of bytes actually read
308 * Reads data from a #GIOChannel.
310 * Return value: %G_IO_ERROR_NONE if the operation was successful.
312 * Deprecated:2.2: Use g_io_channel_read_chars() instead.
315 g_io_channel_read (GIOChannel
*channel
,
324 g_return_val_if_fail (channel
!= NULL
, G_IO_ERROR_UNKNOWN
);
325 g_return_val_if_fail (bytes_read
!= NULL
, G_IO_ERROR_UNKNOWN
);
331 return G_IO_ERROR_NONE
;
334 g_return_val_if_fail (buf
!= NULL
, G_IO_ERROR_UNKNOWN
);
336 status
= channel
->funcs
->io_read (channel
, buf
, count
, bytes_read
, &err
);
338 error
= g_io_error_get_from_g_error (status
, err
);
347 * g_io_channel_write:
348 * @channel: a #GIOChannel
349 * @buf: the buffer containing the data to write
350 * @count: the number of bytes to write
351 * @bytes_written: the number of bytes actually written
353 * Writes data to a #GIOChannel.
355 * Return value: %G_IO_ERROR_NONE if the operation was successful.
357 * Deprecated:2.2: Use g_io_channel_write_chars() instead.
360 g_io_channel_write (GIOChannel
*channel
,
363 gsize
*bytes_written
)
369 g_return_val_if_fail (channel
!= NULL
, G_IO_ERROR_UNKNOWN
);
370 g_return_val_if_fail (bytes_written
!= NULL
, G_IO_ERROR_UNKNOWN
);
372 status
= channel
->funcs
->io_write (channel
, buf
, count
, bytes_written
, &err
);
374 error
= g_io_error_get_from_g_error (status
, err
);
384 * @channel: a #GIOChannel
385 * @offset: an offset, in bytes, which is added to the position specified
387 * @type: the position in the file, which can be %G_SEEK_CUR (the current
388 * position), %G_SEEK_SET (the start of the file), or %G_SEEK_END
389 * (the end of the file)
391 * Sets the current position in the #GIOChannel, similar to the standard
392 * library function fseek().
394 * Return value: %G_IO_ERROR_NONE if the operation was successful.
396 * Deprecated:2.2: Use g_io_channel_seek_position() instead.
399 g_io_channel_seek (GIOChannel
*channel
,
407 g_return_val_if_fail (channel
!= NULL
, G_IO_ERROR_UNKNOWN
);
408 g_return_val_if_fail (channel
->is_seekable
, G_IO_ERROR_UNKNOWN
);
417 g_warning ("g_io_channel_seek: unknown seek type");
418 return G_IO_ERROR_UNKNOWN
;
421 status
= channel
->funcs
->io_seek (channel
, offset
, type
, &err
);
423 error
= g_io_error_get_from_g_error (status
, err
);
431 /* The function g_io_channel_new_file() is prototyped in both
432 * giounix.c and giowin32.c, so we stick its documentation here.
436 * g_io_channel_new_file:
437 * @filename: A string containing the name of a file
438 * @mode: One of "r", "w", "a", "r+", "w+", "a+". These have
439 * the same meaning as in fopen()
440 * @error: A location to return an error of type %G_FILE_ERROR
442 * Open a file @filename as a #GIOChannel using mode @mode. This
443 * channel will be closed when the last reference to it is dropped,
444 * so there is no need to call g_io_channel_close() (though doing
445 * so will not cause problems, as long as no attempt is made to
446 * access the channel after it is closed).
448 * Return value: A #GIOChannel on success, %NULL on failure.
452 * g_io_channel_close:
453 * @channel: A #GIOChannel
455 * Close an IO channel. Any pending data to be written will be
456 * flushed, ignoring errors. The channel will not be freed until the
457 * last reference is dropped using g_io_channel_unref().
459 * Deprecated:2.2: Use g_io_channel_shutdown() instead.
462 g_io_channel_close (GIOChannel
*channel
)
466 g_return_if_fail (channel
!= NULL
);
468 g_io_channel_purge (channel
);
470 channel
->funcs
->io_close (channel
, &err
);
473 { /* No way to return the error */
474 g_warning ("Error closing channel: %s", err
->message
);
478 channel
->close_on_unref
= FALSE
; /* Because we already did */
479 channel
->is_readable
= FALSE
;
480 channel
->is_writeable
= FALSE
;
481 channel
->is_seekable
= FALSE
;
485 * g_io_channel_shutdown:
486 * @channel: a #GIOChannel
487 * @flush: if %TRUE, flush pending
488 * @err: location to store a #GIOChannelError
490 * Close an IO channel. Any pending data to be written will be
491 * flushed if @flush is %TRUE. The channel will not be freed until the
492 * last reference is dropped using g_io_channel_unref().
494 * Return value: the status of the operation.
497 g_io_channel_shutdown (GIOChannel
*channel
,
501 GIOStatus status
, result
;
502 GError
*tmperr
= NULL
;
504 g_return_val_if_fail (channel
!= NULL
, G_IO_STATUS_ERROR
);
505 g_return_val_if_fail (err
== NULL
|| *err
== NULL
, G_IO_STATUS_ERROR
);
507 if (channel
->write_buf
&& channel
->write_buf
->len
> 0)
513 /* Set the channel to blocking, to avoid a busy loop
515 flags
= g_io_channel_get_flags (channel
);
516 /* Ignore any errors here, they're irrelevant */
517 g_io_channel_set_flags (channel
, flags
& ~G_IO_FLAG_NONBLOCK
, NULL
);
519 result
= g_io_channel_flush (channel
, &tmperr
);
522 result
= G_IO_STATUS_NORMAL
;
524 g_string_truncate(channel
->write_buf
, 0);
527 result
= G_IO_STATUS_NORMAL
;
529 if (channel
->partial_write_buf
[0] != '\0')
532 g_warning ("Partial character at end of write buffer not flushed.\n");
533 channel
->partial_write_buf
[0] = '\0';
536 status
= channel
->funcs
->io_close (channel
, err
);
538 channel
->close_on_unref
= FALSE
; /* Because we already did */
539 channel
->is_readable
= FALSE
;
540 channel
->is_writeable
= FALSE
;
541 channel
->is_seekable
= FALSE
;
543 if (status
!= G_IO_STATUS_NORMAL
)
545 g_clear_error (&tmperr
);
548 else if (result
!= G_IO_STATUS_NORMAL
)
550 g_propagate_error (err
, tmperr
);
554 return G_IO_STATUS_NORMAL
;
557 /* This function is used for the final flush on close or unref */
559 g_io_channel_purge (GIOChannel
*channel
)
562 GIOStatus status G_GNUC_UNUSED
;
564 g_return_if_fail (channel
!= NULL
);
566 if (channel
->write_buf
&& channel
->write_buf
->len
> 0)
570 /* Set the channel to blocking, to avoid a busy loop
572 flags
= g_io_channel_get_flags (channel
);
573 g_io_channel_set_flags (channel
, flags
& ~G_IO_FLAG_NONBLOCK
, NULL
);
575 status
= g_io_channel_flush (channel
, &err
);
578 { /* No way to return the error */
579 g_warning ("Error flushing string: %s", err
->message
);
584 /* Flush these in case anyone tries to close without unrefing */
586 if (channel
->read_buf
)
587 g_string_truncate (channel
->read_buf
, 0);
588 if (channel
->write_buf
)
589 g_string_truncate (channel
->write_buf
, 0);
590 if (channel
->encoding
)
592 if (channel
->encoded_read_buf
)
593 g_string_truncate (channel
->encoded_read_buf
, 0);
595 if (channel
->partial_write_buf
[0] != '\0')
597 g_warning ("Partial character at end of write buffer not flushed.\n");
598 channel
->partial_write_buf
[0] = '\0';
605 * @channel: a #GIOChannel to watch
606 * @condition: conditions to watch for
608 * Creates a #GSource that's dispatched when @condition is met for the
609 * given @channel. For example, if condition is #G_IO_IN, the source will
610 * be dispatched when there's data available for reading.
612 * g_io_add_watch() is a simpler interface to this same functionality, for
613 * the case where you want to add the source to the default main loop context
614 * at the default priority.
616 * On Windows, polling a #GSource created to watch a channel for a socket
617 * puts the socket in non-blocking mode. This is a side-effect of the
618 * implementation and unavoidable.
620 * Returns: a new #GSource
623 g_io_create_watch (GIOChannel
*channel
,
624 GIOCondition condition
)
626 g_return_val_if_fail (channel
!= NULL
, NULL
);
628 return channel
->funcs
->io_create_watch (channel
, condition
);
632 * g_io_add_watch_full:
633 * @channel: a #GIOChannel
634 * @priority: the priority of the #GIOChannel source
635 * @condition: the condition to watch for
636 * @func: the function to call when the condition is satisfied
637 * @user_data: user data to pass to @func
638 * @notify: the function to call when the source is removed
640 * Adds the #GIOChannel into the default main loop context
641 * with the given priority.
643 * This internally creates a main loop source using g_io_create_watch()
644 * and attaches it to the main loop context with g_source_attach().
645 * You can do these steps manually if you need greater control.
647 * Returns: the event source id
648 * Rename to: g_io_add_watch
651 g_io_add_watch_full (GIOChannel
*channel
,
653 GIOCondition condition
,
656 GDestroyNotify notify
)
661 g_return_val_if_fail (channel
!= NULL
, 0);
663 source
= g_io_create_watch (channel
, condition
);
665 if (priority
!= G_PRIORITY_DEFAULT
)
666 g_source_set_priority (source
, priority
);
667 g_source_set_callback (source
, (GSourceFunc
)func
, user_data
, notify
);
669 id
= g_source_attach (source
, NULL
);
670 g_source_unref (source
);
677 * @channel: a #GIOChannel
678 * @condition: the condition to watch for
679 * @func: the function to call when the condition is satisfied
680 * @user_data: user data to pass to @func
682 * Adds the #GIOChannel into the default main loop context
683 * with the default priority.
685 * Returns: the event source id
689 * @source: the #GIOChannel event source
690 * @condition: the condition which has been satisfied
691 * @data: user data set in g_io_add_watch() or g_io_add_watch_full()
692 * @Returns: the function should return %FALSE if the event source
695 * Specifies the type of function passed to g_io_add_watch() or
696 * g_io_add_watch_full(), which is called when the requested condition
697 * on a #GIOChannel is satisfied.
701 * @G_IO_IN: There is data to read.
702 * @G_IO_OUT: Data can be written (without blocking).
703 * @G_IO_PRI: There is urgent data to read.
704 * @G_IO_ERR: Error condition.
705 * @G_IO_HUP: Hung up (the connection has been broken, usually for
706 * pipes and sockets).
707 * @G_IO_NVAL: Invalid request. The file descriptor is not open.
709 * A bitwise combination representing a condition to watch for on an
713 g_io_add_watch (GIOChannel
*channel
,
714 GIOCondition condition
,
718 return g_io_add_watch_full (channel
, G_PRIORITY_DEFAULT
, condition
, func
, user_data
, NULL
);
722 * g_io_channel_get_buffer_condition:
723 * @channel: A #GIOChannel
725 * This function returns a #GIOCondition depending on whether there
726 * is data to be read/space to write data in the internal buffers in
727 * the #GIOChannel. Only the flags %G_IO_IN and %G_IO_OUT may be set.
729 * Return value: A #GIOCondition
732 g_io_channel_get_buffer_condition (GIOChannel
*channel
)
734 GIOCondition condition
= 0;
736 if (channel
->encoding
)
738 if (channel
->encoded_read_buf
&& (channel
->encoded_read_buf
->len
> 0))
739 condition
|= G_IO_IN
; /* Only return if we have full characters */
743 if (channel
->read_buf
&& (channel
->read_buf
->len
> 0))
744 condition
|= G_IO_IN
;
747 if (channel
->write_buf
&& (channel
->write_buf
->len
< channel
->buf_size
))
748 condition
|= G_IO_OUT
;
754 * g_io_channel_error_from_errno:
755 * @en: an <literal>errno</literal> error number, e.g. <literal>EINVAL</literal>
757 * Converts an <literal>errno</literal> error number to a #GIOChannelError.
759 * Return value: a #GIOChannelError error number, e.g.
760 * %G_IO_CHANNEL_ERROR_INVAL.
763 g_io_channel_error_from_errno (gint en
)
766 g_return_val_if_fail (en
!= EAGAIN
, G_IO_CHANNEL_ERROR_FAILED
);
773 g_warning("Invalid file descriptor.\n");
774 return G_IO_CHANNEL_ERROR_FAILED
;
779 g_warning("Buffer outside valid address space.\n");
780 return G_IO_CHANNEL_ERROR_FAILED
;
785 return G_IO_CHANNEL_ERROR_FBIG
;
789 /* In general, we should catch EINTR before we get here,
790 * but close() is allowed to return EINTR by POSIX, so
791 * we need to catch it here; EINTR from close() is
792 * unrecoverable, because it's undefined whether
793 * the fd was actually closed or not, so we just return
794 * a generic error code.
797 return G_IO_CHANNEL_ERROR_FAILED
;
802 return G_IO_CHANNEL_ERROR_INVAL
;
807 return G_IO_CHANNEL_ERROR_IO
;
812 return G_IO_CHANNEL_ERROR_ISDIR
;
817 return G_IO_CHANNEL_ERROR_NOSPC
;
822 return G_IO_CHANNEL_ERROR_NXIO
;
827 return G_IO_CHANNEL_ERROR_OVERFLOW
;
832 return G_IO_CHANNEL_ERROR_PIPE
;
836 return G_IO_CHANNEL_ERROR_FAILED
;
841 * g_io_channel_set_buffer_size:
842 * @channel: a #GIOChannel
843 * @size: the size of the buffer, or 0 to let GLib pick a good size
845 * Sets the buffer size.
848 g_io_channel_set_buffer_size (GIOChannel
*channel
,
851 g_return_if_fail (channel
!= NULL
);
854 size
= G_IO_NICE_BUF_SIZE
;
856 if (size
< MAX_CHAR_SIZE
)
857 size
= MAX_CHAR_SIZE
;
859 channel
->buf_size
= size
;
863 * g_io_channel_get_buffer_size:
864 * @channel: a #GIOChannel
866 * Gets the buffer size.
868 * Return value: the size of the buffer.
871 g_io_channel_get_buffer_size (GIOChannel
*channel
)
873 g_return_val_if_fail (channel
!= NULL
, 0);
875 return channel
->buf_size
;
879 * g_io_channel_set_line_term:
880 * @channel: a #GIOChannel
881 * @line_term: The line termination string. Use %NULL for autodetect.
882 * Autodetection breaks on "\n", "\r\n", "\r", "\0", and
883 * the Unicode paragraph separator. Autodetection should
884 * not be used for anything other than file-based channels.
885 * @length: The length of the termination string. If -1 is passed, the
886 * string is assumed to be nul-terminated. This option allows
887 * termination strings with embedded nuls.
889 * This sets the string that #GIOChannel uses to determine
890 * where in the file a line break occurs.
893 g_io_channel_set_line_term (GIOChannel
*channel
,
894 const gchar
*line_term
,
897 g_return_if_fail (channel
!= NULL
);
898 g_return_if_fail (line_term
== NULL
|| length
!= 0); /* Disallow "" */
900 if (line_term
== NULL
)
903 length
= strlen (line_term
);
905 g_free (channel
->line_term
);
906 channel
->line_term
= line_term
? g_memdup (line_term
, length
) : NULL
;
907 channel
->line_term_len
= length
;
911 * g_io_channel_get_line_term:
912 * @channel: a #GIOChannel
913 * @length: a location to return the length of the line terminator
915 * This returns the string that #GIOChannel uses to determine
916 * where in the file a line break occurs. A value of %NULL
917 * indicates autodetection.
919 * Return value: The line termination string. This value
920 * is owned by GLib and must not be freed.
923 g_io_channel_get_line_term (GIOChannel
*channel
,
926 g_return_val_if_fail (channel
!= NULL
, NULL
);
929 *length
= channel
->line_term_len
;
931 return channel
->line_term
;
935 * g_io_channel_set_flags:
936 * @channel: a #GIOChannel
937 * @flags: the flags to set on the IO channel
938 * @error: A location to return an error of type #GIOChannelError
940 * Sets the (writeable) flags in @channel to (@flags & %G_IO_FLAG_SET_MASK).
942 * Return value: the status of the operation.
946 * @G_IO_FLAG_APPEND: turns on append mode, corresponds to <literal>O_APPEND</literal>
947 * (see the documentation of the UNIX open()
949 * @G_IO_FLAG_NONBLOCK: turns on nonblocking mode, corresponds to
950 * <literal>O_NONBLOCK</literal>/<literal>O_NDELAY</literal>
951 * (see the documentation of the UNIX open() syscall).
952 * @G_IO_FLAG_IS_READABLE: indicates that the io channel is readable.
953 * This flag cannot be changed.
954 * @G_IO_FLAG_IS_WRITABLE: indicates that the io channel is writable.
955 * This flag cannot be changed.
956 * @G_IO_FLAG_IS_SEEKABLE: indicates that the io channel is seekable,
957 * i.e. that g_io_channel_seek_position() can
958 * be used on it. This flag cannot be changed.
959 * @G_IO_FLAG_MASK: the mask that specifies all the valid flags.
960 * @G_IO_FLAG_GET_MASK: the mask of the flags that are returned from
961 * g_io_channel_get_flags().
962 * @G_IO_FLAG_SET_MASK: the mask of the flags that the user can modify
963 * with g_io_channel_set_flags().
965 * Specifies properties of a #GIOChannel. Some of the flags can only be
966 * read with g_io_channel_get_flags(), but not changed with
967 * g_io_channel_set_flags().
970 * G_IO_FLAG_IS_WRITEABLE:
972 * This is a misspelled version of G_IO_FLAG_IS_WRITABLE that existed
973 * before the spelling was fixed in GLib 2.30. It is kept here for
974 * compatibility reasons.
976 * Deprecated:2.30:Use G_IO_FLAG_IS_WRITABLE instead.
979 g_io_channel_set_flags (GIOChannel
*channel
,
983 g_return_val_if_fail (channel
!= NULL
, G_IO_STATUS_ERROR
);
984 g_return_val_if_fail ((error
== NULL
) || (*error
== NULL
),
987 return (*channel
->funcs
->io_set_flags
) (channel
,
988 flags
& G_IO_FLAG_SET_MASK
,
993 * g_io_channel_get_flags:
994 * @channel: a #GIOChannel
996 * Gets the current flags for a #GIOChannel, including read-only
997 * flags such as %G_IO_FLAG_IS_READABLE.
999 * The values of the flags %G_IO_FLAG_IS_READABLE and %G_IO_FLAG_IS_WRITABLE
1000 * are cached for internal use by the channel when it is created.
1001 * If they should change at some later point (e.g. partial shutdown
1002 * of a socket with the UNIX shutdown() function), the user
1003 * should immediately call g_io_channel_get_flags() to update
1004 * the internal values of these flags.
1006 * Return value: the flags which are set on the channel
1009 g_io_channel_get_flags (GIOChannel
*channel
)
1013 g_return_val_if_fail (channel
!= NULL
, 0);
1015 flags
= (* channel
->funcs
->io_get_flags
) (channel
);
1017 /* Cross implementation code */
1019 if (channel
->is_seekable
)
1020 flags
|= G_IO_FLAG_IS_SEEKABLE
;
1021 if (channel
->is_readable
)
1022 flags
|= G_IO_FLAG_IS_READABLE
;
1023 if (channel
->is_writeable
)
1024 flags
|= G_IO_FLAG_IS_WRITABLE
;
1030 * g_io_channel_set_close_on_unref:
1031 * @channel: a #GIOChannel
1032 * @do_close: Whether to close the channel on the final unref of
1033 * the GIOChannel data structure. The default value of
1034 * this is %TRUE for channels created by g_io_channel_new_file (),
1035 * and %FALSE for all other channels.
1037 * Setting this flag to %TRUE for a channel you have already closed
1038 * can cause problems.
1041 g_io_channel_set_close_on_unref (GIOChannel
*channel
,
1044 g_return_if_fail (channel
!= NULL
);
1046 channel
->close_on_unref
= do_close
;
1050 * g_io_channel_get_close_on_unref:
1051 * @channel: a #GIOChannel.
1053 * Returns whether the file/socket/whatever associated with @channel
1054 * will be closed when @channel receives its final unref and is
1055 * destroyed. The default value of this is %TRUE for channels created
1056 * by g_io_channel_new_file (), and %FALSE for all other channels.
1058 * Return value: Whether the channel will be closed on the final unref of
1059 * the GIOChannel data structure.
1062 g_io_channel_get_close_on_unref (GIOChannel
*channel
)
1064 g_return_val_if_fail (channel
!= NULL
, FALSE
);
1066 return channel
->close_on_unref
;
1070 * g_io_channel_seek_position:
1071 * @channel: a #GIOChannel
1072 * @offset: The offset in bytes from the position specified by @type
1073 * @type: a #GSeekType. The type %G_SEEK_CUR is only allowed in those
1074 * cases where a call to g_io_channel_set_encoding ()
1075 * is allowed. See the documentation for
1076 * g_io_channel_set_encoding () for details.
1077 * @error: A location to return an error of type #GIOChannelError
1079 * Replacement for g_io_channel_seek() with the new API.
1081 * Return value: the status of the operation.
1085 * @G_SEEK_CUR: the current position in the file.
1086 * @G_SEEK_SET: the start of the file.
1087 * @G_SEEK_END: the end of the file.
1089 * An enumeration specifying the base position for a
1090 * g_io_channel_seek_position() operation.
1093 g_io_channel_seek_position (GIOChannel
*channel
,
1100 /* For files, only one of the read and write buffers can contain data.
1101 * For sockets, both can contain data.
1104 g_return_val_if_fail (channel
!= NULL
, G_IO_STATUS_ERROR
);
1105 g_return_val_if_fail ((error
== NULL
) || (*error
== NULL
),
1107 g_return_val_if_fail (channel
->is_seekable
, G_IO_STATUS_ERROR
);
1111 case G_SEEK_CUR
: /* The user is seeking relative to the head of the buffer */
1112 if (channel
->use_buffer
)
1114 if (channel
->do_encode
&& channel
->encoded_read_buf
1115 && channel
->encoded_read_buf
->len
> 0)
1117 g_warning ("Seek type G_SEEK_CUR not allowed for this"
1118 " channel's encoding.\n");
1119 return G_IO_STATUS_ERROR
;
1121 if (channel
->read_buf
)
1122 offset
-= channel
->read_buf
->len
;
1123 if (channel
->encoded_read_buf
)
1125 g_assert (channel
->encoded_read_buf
->len
== 0 || !channel
->do_encode
);
1127 /* If there's anything here, it's because the encoding is UTF-8,
1128 * so we can just subtract the buffer length, the same as for
1129 * the unencoded data.
1132 offset
-= channel
->encoded_read_buf
->len
;
1140 g_warning ("g_io_channel_seek_position: unknown seek type");
1141 return G_IO_STATUS_ERROR
;
1144 if (channel
->use_buffer
)
1146 status
= g_io_channel_flush (channel
, error
);
1147 if (status
!= G_IO_STATUS_NORMAL
)
1151 status
= channel
->funcs
->io_seek (channel
, offset
, type
, error
);
1153 if ((status
== G_IO_STATUS_NORMAL
) && (channel
->use_buffer
))
1155 if (channel
->read_buf
)
1156 g_string_truncate (channel
->read_buf
, 0);
1158 /* Conversion state no longer matches position in file */
1159 if (channel
->read_cd
!= (GIConv
) -1)
1160 g_iconv (channel
->read_cd
, NULL
, NULL
, NULL
, NULL
);
1161 if (channel
->write_cd
!= (GIConv
) -1)
1162 g_iconv (channel
->write_cd
, NULL
, NULL
, NULL
, NULL
);
1164 if (channel
->encoded_read_buf
)
1166 g_assert (channel
->encoded_read_buf
->len
== 0 || !channel
->do_encode
);
1167 g_string_truncate (channel
->encoded_read_buf
, 0);
1170 if (channel
->partial_write_buf
[0] != '\0')
1172 g_warning ("Partial character at end of write buffer not flushed.\n");
1173 channel
->partial_write_buf
[0] = '\0';
1181 * g_io_channel_flush:
1182 * @channel: a #GIOChannel
1183 * @error: location to store an error of type #GIOChannelError
1185 * Flushes the write buffer for the GIOChannel.
1187 * Return value: the status of the operation: One of
1188 * #G_IO_STATUS_NORMAL, #G_IO_STATUS_AGAIN, or
1189 * #G_IO_STATUS_ERROR.
1192 g_io_channel_flush (GIOChannel
*channel
,
1196 gsize this_time
= 1, bytes_written
= 0;
1198 g_return_val_if_fail (channel
!= NULL
, G_IO_STATUS_ERROR
);
1199 g_return_val_if_fail ((error
== NULL
) || (*error
== NULL
), G_IO_STATUS_ERROR
);
1201 if (channel
->write_buf
== NULL
|| channel
->write_buf
->len
== 0)
1202 return G_IO_STATUS_NORMAL
;
1206 g_assert (this_time
> 0);
1208 status
= channel
->funcs
->io_write (channel
,
1209 channel
->write_buf
->str
+ bytes_written
,
1210 channel
->write_buf
->len
- bytes_written
,
1212 bytes_written
+= this_time
;
1214 while ((bytes_written
< channel
->write_buf
->len
)
1215 && (status
== G_IO_STATUS_NORMAL
));
1217 g_string_erase (channel
->write_buf
, 0, bytes_written
);
1223 * g_io_channel_set_buffered:
1224 * @channel: a #GIOChannel
1225 * @buffered: whether to set the channel buffered or unbuffered
1227 * The buffering state can only be set if the channel's encoding
1228 * is %NULL. For any other encoding, the channel must be buffered.
1230 * A buffered channel can only be set unbuffered if the channel's
1231 * internal buffers have been flushed. Newly created channels or
1232 * channels which have returned %G_IO_STATUS_EOF
1233 * not require such a flush. For write-only channels, a call to
1234 * g_io_channel_flush () is sufficient. For all other channels,
1235 * the buffers may be flushed by a call to g_io_channel_seek_position ().
1236 * This includes the possibility of seeking with seek type %G_SEEK_CUR
1237 * and an offset of zero. Note that this means that socket-based
1238 * channels cannot be set unbuffered once they have had data
1241 * On unbuffered channels, it is safe to mix read and write
1242 * calls from the new and old APIs, if this is necessary for
1243 * maintaining old code.
1245 * The default state of the channel is buffered.
1248 g_io_channel_set_buffered (GIOChannel
*channel
,
1251 g_return_if_fail (channel
!= NULL
);
1253 if (channel
->encoding
!= NULL
)
1255 g_warning ("Need to have NULL encoding to set the buffering state of the "
1260 g_return_if_fail (!channel
->read_buf
|| channel
->read_buf
->len
== 0);
1261 g_return_if_fail (!channel
->write_buf
|| channel
->write_buf
->len
== 0);
1263 channel
->use_buffer
= buffered
;
1267 * g_io_channel_get_buffered:
1268 * @channel: a #GIOChannel
1270 * Returns whether @channel is buffered.
1272 * Return Value: %TRUE if the @channel is buffered.
1275 g_io_channel_get_buffered (GIOChannel
*channel
)
1277 g_return_val_if_fail (channel
!= NULL
, FALSE
);
1279 return channel
->use_buffer
;
1283 * g_io_channel_set_encoding:
1284 * @channel: a #GIOChannel
1285 * @encoding: the encoding type
1286 * @error: location to store an error of type #GConvertError
1288 * Sets the encoding for the input/output of the channel.
1289 * The internal encoding is always UTF-8. The default encoding
1290 * for the external file is UTF-8.
1292 * The encoding %NULL is safe to use with binary data.
1294 * The encoding can only be set if one of the following conditions
1298 * The channel was just created, and has not been written to or read
1300 * </para></listitem>
1302 * The channel is write-only.
1303 * </para></listitem>
1305 * The channel is a file, and the file pointer was just
1306 * repositioned by a call to g_io_channel_seek_position().
1307 * (This flushes all the internal buffers.)
1308 * </para></listitem>
1310 * The current encoding is %NULL or UTF-8.
1311 * </para></listitem>
1313 * One of the (new API) read functions has just returned %G_IO_STATUS_EOF
1314 * (or, in the case of g_io_channel_read_to_end(), %G_IO_STATUS_NORMAL).
1315 * </para></listitem>
1317 * One of the functions g_io_channel_read_chars() or
1318 * g_io_channel_read_unichar() has returned %G_IO_STATUS_AGAIN or
1319 * %G_IO_STATUS_ERROR. This may be useful in the case of
1320 * %G_CONVERT_ERROR_ILLEGAL_SEQUENCE.
1321 * Returning one of these statuses from g_io_channel_read_line(),
1322 * g_io_channel_read_line_string(), or g_io_channel_read_to_end()
1323 * does <emphasis>not</emphasis> guarantee that the encoding can
1325 * </para></listitem>
1327 * Channels which do not meet one of the above conditions cannot call
1328 * g_io_channel_seek_position() with an offset of %G_SEEK_CUR, and, if
1329 * they are "seekable", cannot call g_io_channel_write_chars() after
1330 * calling one of the API "read" functions.
1332 * Return Value: %G_IO_STATUS_NORMAL if the encoding was successfully set.
1335 g_io_channel_set_encoding (GIOChannel
*channel
,
1336 const gchar
*encoding
,
1339 GIConv read_cd
, write_cd
;
1340 gboolean did_encode
;
1342 g_return_val_if_fail (channel
!= NULL
, G_IO_STATUS_ERROR
);
1343 g_return_val_if_fail ((error
== NULL
) || (*error
== NULL
), G_IO_STATUS_ERROR
);
1345 /* Make sure the encoded buffers are empty */
1347 g_return_val_if_fail (!channel
->do_encode
|| !channel
->encoded_read_buf
||
1348 channel
->encoded_read_buf
->len
== 0, G_IO_STATUS_ERROR
);
1350 if (!channel
->use_buffer
)
1352 g_warning ("Need to set the channel buffered before setting the encoding.\n");
1353 g_warning ("Assuming this is what you meant and acting accordingly.\n");
1355 channel
->use_buffer
= TRUE
;
1358 if (channel
->partial_write_buf
[0] != '\0')
1360 g_warning ("Partial character at end of write buffer not flushed.\n");
1361 channel
->partial_write_buf
[0] = '\0';
1364 did_encode
= channel
->do_encode
;
1366 if (!encoding
|| strcmp (encoding
, "UTF8") == 0 || strcmp (encoding
, "UTF-8") == 0)
1368 channel
->do_encode
= FALSE
;
1369 read_cd
= write_cd
= (GIConv
) -1;
1374 const gchar
*from_enc
= NULL
, *to_enc
= NULL
;
1376 if (channel
->is_readable
)
1378 read_cd
= g_iconv_open ("UTF-8", encoding
);
1380 if (read_cd
== (GIConv
) -1)
1383 from_enc
= encoding
;
1388 read_cd
= (GIConv
) -1;
1390 if (channel
->is_writeable
&& err
== 0)
1392 write_cd
= g_iconv_open (encoding
, "UTF-8");
1394 if (write_cd
== (GIConv
) -1)
1402 write_cd
= (GIConv
) -1;
1406 g_assert (from_enc
);
1410 g_set_error (error
, G_CONVERT_ERROR
, G_CONVERT_ERROR_NO_CONVERSION
,
1411 _("Conversion from character set '%s' to '%s' is not supported"),
1414 g_set_error (error
, G_CONVERT_ERROR
, G_CONVERT_ERROR_FAILED
,
1415 _("Could not open converter from '%s' to '%s': %s"),
1416 from_enc
, to_enc
, g_strerror (err
));
1418 if (read_cd
!= (GIConv
) -1)
1419 g_iconv_close (read_cd
);
1420 if (write_cd
!= (GIConv
) -1)
1421 g_iconv_close (write_cd
);
1423 return G_IO_STATUS_ERROR
;
1426 channel
->do_encode
= TRUE
;
1429 /* The encoding is ok, so set the fields in channel */
1431 if (channel
->read_cd
!= (GIConv
) -1)
1432 g_iconv_close (channel
->read_cd
);
1433 if (channel
->write_cd
!= (GIConv
) -1)
1434 g_iconv_close (channel
->write_cd
);
1436 if (channel
->encoded_read_buf
&& channel
->encoded_read_buf
->len
> 0)
1438 g_assert (!did_encode
); /* Encoding UTF-8, NULL doesn't use encoded_read_buf */
1440 /* This is just validated UTF-8, so we can copy it back into read_buf
1441 * so it can be encoded in whatever the new encoding is.
1444 g_string_prepend_len (channel
->read_buf
, channel
->encoded_read_buf
->str
,
1445 channel
->encoded_read_buf
->len
);
1446 g_string_truncate (channel
->encoded_read_buf
, 0);
1449 channel
->read_cd
= read_cd
;
1450 channel
->write_cd
= write_cd
;
1452 g_free (channel
->encoding
);
1453 channel
->encoding
= g_strdup (encoding
);
1455 return G_IO_STATUS_NORMAL
;
1459 * g_io_channel_get_encoding:
1460 * @channel: a #GIOChannel
1462 * Gets the encoding for the input/output of the channel.
1463 * The internal encoding is always UTF-8. The encoding %NULL
1464 * makes the channel safe for binary data.
1466 * Return value: A string containing the encoding, this string is
1467 * owned by GLib and must not be freed.
1470 g_io_channel_get_encoding (GIOChannel
*channel
)
1472 g_return_val_if_fail (channel
!= NULL
, NULL
);
1474 return channel
->encoding
;
1478 g_io_channel_fill_buffer (GIOChannel
*channel
,
1481 gsize read_size
, cur_len
, oldlen
;
1484 if (channel
->is_seekable
&& channel
->write_buf
&& channel
->write_buf
->len
> 0)
1486 status
= g_io_channel_flush (channel
, err
);
1487 if (status
!= G_IO_STATUS_NORMAL
)
1490 if (channel
->is_seekable
&& channel
->partial_write_buf
[0] != '\0')
1492 g_warning ("Partial character at end of write buffer not flushed.\n");
1493 channel
->partial_write_buf
[0] = '\0';
1496 if (!channel
->read_buf
)
1497 channel
->read_buf
= g_string_sized_new (channel
->buf_size
);
1499 cur_len
= channel
->read_buf
->len
;
1501 g_string_set_size (channel
->read_buf
, channel
->read_buf
->len
+ channel
->buf_size
);
1503 status
= channel
->funcs
->io_read (channel
, channel
->read_buf
->str
+ cur_len
,
1504 channel
->buf_size
, &read_size
, err
);
1506 g_assert ((status
== G_IO_STATUS_NORMAL
) || (read_size
== 0));
1508 g_string_truncate (channel
->read_buf
, read_size
+ cur_len
);
1510 if ((status
!= G_IO_STATUS_NORMAL
) &&
1511 ((status
!= G_IO_STATUS_EOF
) || (channel
->read_buf
->len
== 0)))
1514 g_assert (channel
->read_buf
->len
> 0);
1516 if (channel
->encoded_read_buf
)
1517 oldlen
= channel
->encoded_read_buf
->len
;
1521 if (channel
->encoding
)
1522 channel
->encoded_read_buf
= g_string_sized_new (channel
->buf_size
);
1525 if (channel
->do_encode
)
1527 gsize errnum
, inbytes_left
, outbytes_left
;
1528 gchar
*inbuf
, *outbuf
;
1531 g_assert (channel
->encoded_read_buf
);
1535 inbytes_left
= channel
->read_buf
->len
;
1536 outbytes_left
= MAX (channel
->read_buf
->len
,
1537 channel
->encoded_read_buf
->allocated_len
1538 - channel
->encoded_read_buf
->len
- 1); /* 1 for NULL */
1539 outbytes_left
= MAX (outbytes_left
, 6);
1541 inbuf
= channel
->read_buf
->str
;
1542 g_string_set_size (channel
->encoded_read_buf
,
1543 channel
->encoded_read_buf
->len
+ outbytes_left
);
1544 outbuf
= channel
->encoded_read_buf
->str
+ channel
->encoded_read_buf
->len
1547 errnum
= g_iconv (channel
->read_cd
, &inbuf
, &inbytes_left
,
1548 &outbuf
, &outbytes_left
);
1551 g_assert (inbuf
+ inbytes_left
== channel
->read_buf
->str
1552 + channel
->read_buf
->len
);
1553 g_assert (outbuf
+ outbytes_left
== channel
->encoded_read_buf
->str
1554 + channel
->encoded_read_buf
->len
);
1556 g_string_erase (channel
->read_buf
, 0,
1557 channel
->read_buf
->len
- inbytes_left
);
1558 g_string_truncate (channel
->encoded_read_buf
,
1559 channel
->encoded_read_buf
->len
- outbytes_left
);
1561 if (errnum
== (gsize
) -1)
1566 if ((oldlen
== channel
->encoded_read_buf
->len
)
1567 && (status
== G_IO_STATUS_EOF
))
1568 status
= G_IO_STATUS_EOF
;
1570 status
= G_IO_STATUS_NORMAL
;
1573 /* Buffer size at least 6, wrote at least on character */
1574 g_assert (inbuf
!= channel
->read_buf
->str
);
1577 if (oldlen
< channel
->encoded_read_buf
->len
)
1578 status
= G_IO_STATUS_NORMAL
;
1581 g_set_error_literal (err
, G_CONVERT_ERROR
,
1582 G_CONVERT_ERROR_ILLEGAL_SEQUENCE
,
1583 _("Invalid byte sequence in conversion input"));
1584 return G_IO_STATUS_ERROR
;
1588 g_assert (errval
!= EBADF
); /* The converter should be open */
1589 g_set_error (err
, G_CONVERT_ERROR
, G_CONVERT_ERROR_FAILED
,
1590 _("Error during conversion: %s"), g_strerror (errval
));
1591 return G_IO_STATUS_ERROR
;
1594 g_assert ((status
!= G_IO_STATUS_NORMAL
)
1595 || (channel
->encoded_read_buf
->len
> 0));
1597 else if (channel
->encoding
) /* UTF-8 */
1599 gchar
*nextchar
, *lastchar
;
1601 g_assert (channel
->encoded_read_buf
);
1603 nextchar
= channel
->read_buf
->str
;
1604 lastchar
= channel
->read_buf
->str
+ channel
->read_buf
->len
;
1606 while (nextchar
< lastchar
)
1610 val_char
= g_utf8_get_char_validated (nextchar
, lastchar
- nextchar
);
1615 /* stop, leave partial character in buffer */
1616 lastchar
= nextchar
;
1619 if (oldlen
< channel
->encoded_read_buf
->len
)
1620 status
= G_IO_STATUS_NORMAL
;
1623 g_set_error_literal (err
, G_CONVERT_ERROR
,
1624 G_CONVERT_ERROR_ILLEGAL_SEQUENCE
,
1625 _("Invalid byte sequence in conversion input"));
1626 status
= G_IO_STATUS_ERROR
;
1628 lastchar
= nextchar
;
1631 nextchar
= g_utf8_next_char (nextchar
);
1636 if (lastchar
> channel
->read_buf
->str
)
1638 gint copy_len
= lastchar
- channel
->read_buf
->str
;
1640 g_string_append_len (channel
->encoded_read_buf
, channel
->read_buf
->str
,
1642 g_string_erase (channel
->read_buf
, 0, copy_len
);
1650 * g_io_channel_read_line:
1651 * @channel: a #GIOChannel
1652 * @str_return: The line read from the #GIOChannel, including the
1653 * line terminator. This data should be freed with g_free()
1654 * when no longer needed. This is a nul-terminated string.
1655 * If a @length of zero is returned, this will be %NULL instead.
1656 * @length: (allow-none): location to store length of the read data, or %NULL
1657 * @terminator_pos: (allow-none): location to store position of line terminator, or %NULL
1658 * @error: A location to return an error of type #GConvertError
1659 * or #GIOChannelError
1661 * Reads a line, including the terminating character(s),
1662 * from a #GIOChannel into a newly-allocated string.
1663 * @str_return will contain allocated memory if the return
1664 * is %G_IO_STATUS_NORMAL.
1666 * Return value: the status of the operation.
1669 g_io_channel_read_line (GIOChannel
*channel
,
1672 gsize
*terminator_pos
,
1678 g_return_val_if_fail (channel
!= NULL
, G_IO_STATUS_ERROR
);
1679 g_return_val_if_fail (str_return
!= NULL
, G_IO_STATUS_ERROR
);
1680 g_return_val_if_fail ((error
== NULL
) || (*error
== NULL
),
1682 g_return_val_if_fail (channel
->is_readable
, G_IO_STATUS_ERROR
);
1684 status
= g_io_channel_read_line_backend (channel
, &got_length
, terminator_pos
, error
);
1687 *length
= got_length
;
1689 if (status
== G_IO_STATUS_NORMAL
)
1691 g_assert (USE_BUF (channel
));
1692 *str_return
= g_strndup (USE_BUF (channel
)->str
, got_length
);
1693 g_string_erase (USE_BUF (channel
), 0, got_length
);
1702 * g_io_channel_read_line_string:
1703 * @channel: a #GIOChannel
1704 * @buffer: a #GString into which the line will be written.
1705 * If @buffer already contains data, the old data will
1707 * @terminator_pos: (allow-none): location to store position of line terminator, or %NULL
1708 * @error: a location to store an error of type #GConvertError
1709 * or #GIOChannelError
1711 * Reads a line from a #GIOChannel, using a #GString as a buffer.
1713 * Return value: the status of the operation.
1716 g_io_channel_read_line_string (GIOChannel
*channel
,
1718 gsize
*terminator_pos
,
1724 g_return_val_if_fail (channel
!= NULL
, G_IO_STATUS_ERROR
);
1725 g_return_val_if_fail (buffer
!= NULL
, G_IO_STATUS_ERROR
);
1726 g_return_val_if_fail ((error
== NULL
) || (*error
== NULL
),
1728 g_return_val_if_fail (channel
->is_readable
, G_IO_STATUS_ERROR
);
1730 if (buffer
->len
> 0)
1731 g_string_truncate (buffer
, 0); /* clear out the buffer */
1733 status
= g_io_channel_read_line_backend (channel
, &length
, terminator_pos
, error
);
1735 if (status
== G_IO_STATUS_NORMAL
)
1737 g_assert (USE_BUF (channel
));
1738 g_string_append_len (buffer
, USE_BUF (channel
)->str
, length
);
1739 g_string_erase (USE_BUF (channel
), 0, length
);
1747 g_io_channel_read_line_backend (GIOChannel
*channel
,
1749 gsize
*terminator_pos
,
1753 gsize checked_to
, line_term_len
, line_length
, got_term_len
;
1754 gboolean first_time
= TRUE
;
1756 if (!channel
->use_buffer
)
1758 /* Can't do a raw read in read_line */
1759 g_set_error_literal (error
, G_CONVERT_ERROR
, G_CONVERT_ERROR_FAILED
,
1760 _("Can't do a raw read in g_io_channel_read_line_string"));
1761 return G_IO_STATUS_ERROR
;
1764 status
= G_IO_STATUS_NORMAL
;
1766 if (channel
->line_term
)
1767 line_term_len
= channel
->line_term_len
;
1770 /* This value used for setting checked_to, it's the longest of the four
1771 * we autodetect for.
1778 gchar
*nextchar
, *lastchar
;
1781 if (!first_time
|| (BUF_LEN (USE_BUF (channel
)) == 0))
1784 status
= g_io_channel_fill_buffer (channel
, error
);
1787 case G_IO_STATUS_NORMAL
:
1788 if (BUF_LEN (USE_BUF (channel
)) == 0)
1789 /* Can happen when using conversion and only read
1790 * part of a character
1797 case G_IO_STATUS_EOF
:
1798 if (BUF_LEN (USE_BUF (channel
)) == 0)
1803 if (channel
->encoding
&& channel
->read_buf
->len
!= 0)
1805 g_set_error_literal (error
, G_CONVERT_ERROR
,
1806 G_CONVERT_ERROR_PARTIAL_INPUT
,
1807 _("Leftover unconverted data in "
1809 return G_IO_STATUS_ERROR
;
1812 return G_IO_STATUS_EOF
;
1822 g_assert (BUF_LEN (USE_BUF (channel
)) != 0);
1824 use_buf
= USE_BUF (channel
); /* The buffer has been created by this point */
1828 lastchar
= use_buf
->str
+ use_buf
->len
;
1830 for (nextchar
= use_buf
->str
+ checked_to
; nextchar
< lastchar
;
1831 channel
->encoding
? nextchar
= g_utf8_next_char (nextchar
) : nextchar
++)
1833 if (channel
->line_term
)
1835 if (memcmp (channel
->line_term
, nextchar
, line_term_len
) == 0)
1837 line_length
= nextchar
- use_buf
->str
;
1838 got_term_len
= line_term_len
;
1842 else /* auto detect */
1846 case '\n': /* unix */
1847 line_length
= nextchar
- use_buf
->str
;
1850 case '\r': /* Warning: do not use with sockets */
1851 line_length
= nextchar
- use_buf
->str
;
1852 if ((nextchar
== lastchar
- 1) && (status
!= G_IO_STATUS_EOF
)
1853 && (lastchar
== use_buf
->str
+ use_buf
->len
))
1854 goto read_again
; /* Try to read more data */
1855 if ((nextchar
< lastchar
- 1) && (*(nextchar
+ 1) == '\n')) /* dos */
1860 case '\xe2': /* Unicode paragraph separator */
1861 if (strncmp ("\xe2\x80\xa9", nextchar
, 3) == 0)
1863 line_length
= nextchar
- use_buf
->str
;
1868 case '\0': /* Embeded null in input */
1869 line_length
= nextchar
- use_buf
->str
;
1872 default: /* no match */
1878 /* If encoding != NULL, valid UTF-8, didn't overshoot */
1879 g_assert (nextchar
== lastchar
);
1883 if (status
== G_IO_STATUS_EOF
)
1885 if (channel
->encoding
&& channel
->read_buf
->len
> 0)
1887 g_set_error_literal (error
, G_CONVERT_ERROR
, G_CONVERT_ERROR_PARTIAL_INPUT
,
1888 _("Channel terminates in a partial character"));
1889 return G_IO_STATUS_ERROR
;
1891 line_length
= use_buf
->len
;
1896 if (use_buf
->len
> line_term_len
- 1)
1897 checked_to
= use_buf
->len
- (line_term_len
- 1);
1905 *terminator_pos
= line_length
;
1908 *length
= line_length
+ got_term_len
;
1910 return G_IO_STATUS_NORMAL
;
1914 * g_io_channel_read_to_end:
1915 * @channel: a #GIOChannel
1916 * @str_return: Location to store a pointer to a string holding
1917 * the remaining data in the #GIOChannel. This data should
1918 * be freed with g_free() when no longer needed. This
1919 * data is terminated by an extra nul character, but there
1920 * may be other nuls in the intervening data.
1921 * @length: location to store length of the data
1922 * @error: location to return an error of type #GConvertError
1923 * or #GIOChannelError
1925 * Reads all the remaining data from the file.
1927 * Return value: %G_IO_STATUS_NORMAL on success.
1928 * This function never returns %G_IO_STATUS_EOF.
1931 g_io_channel_read_to_end (GIOChannel
*channel
,
1938 g_return_val_if_fail (channel
!= NULL
, G_IO_STATUS_ERROR
);
1939 g_return_val_if_fail ((error
== NULL
) || (*error
== NULL
),
1941 g_return_val_if_fail (channel
->is_readable
, G_IO_STATUS_ERROR
);
1948 if (!channel
->use_buffer
)
1950 g_set_error_literal (error
, G_CONVERT_ERROR
, G_CONVERT_ERROR_FAILED
,
1951 _("Can't do a raw read in g_io_channel_read_to_end"));
1952 return G_IO_STATUS_ERROR
;
1956 status
= g_io_channel_fill_buffer (channel
, error
);
1957 while (status
== G_IO_STATUS_NORMAL
);
1959 if (status
!= G_IO_STATUS_EOF
)
1962 if (channel
->encoding
&& channel
->read_buf
->len
> 0)
1964 g_set_error_literal (error
, G_CONVERT_ERROR
, G_CONVERT_ERROR_PARTIAL_INPUT
,
1965 _("Channel terminates in a partial character"));
1966 return G_IO_STATUS_ERROR
;
1969 if (USE_BUF (channel
) == NULL
)
1971 /* length is already set to zero */
1973 *str_return
= g_strdup ("");
1978 *length
= USE_BUF (channel
)->len
;
1981 *str_return
= g_string_free (USE_BUF (channel
), FALSE
);
1983 g_string_free (USE_BUF (channel
), TRUE
);
1985 if (channel
->encoding
)
1986 channel
->encoded_read_buf
= NULL
;
1988 channel
->read_buf
= NULL
;
1991 return G_IO_STATUS_NORMAL
;
1995 * g_io_channel_read_chars:
1996 * @channel: a #GIOChannel
1997 * @buf: a buffer to read data into
1998 * @count: the size of the buffer. Note that the buffer may not be
1999 * complelely filled even if there is data in the buffer if the
2000 * remaining data is not a complete character.
2001 * @bytes_read: (allow-none): The number of bytes read. This may be
2002 * zero even on success if count < 6 and the channel's encoding
2003 * is non-%NULL. This indicates that the next UTF-8 character is
2004 * too wide for the buffer.
2005 * @error: a location to return an error of type #GConvertError
2006 * or #GIOChannelError.
2008 * Replacement for g_io_channel_read() with the new API.
2010 * Return value: the status of the operation.
2013 g_io_channel_read_chars (GIOChannel
*channel
,
2022 g_return_val_if_fail (channel
!= NULL
, G_IO_STATUS_ERROR
);
2023 g_return_val_if_fail ((error
== NULL
) || (*error
== NULL
), G_IO_STATUS_ERROR
);
2024 g_return_val_if_fail (channel
->is_readable
, G_IO_STATUS_ERROR
);
2030 return G_IO_STATUS_NORMAL
;
2032 g_return_val_if_fail (buf
!= NULL
, G_IO_STATUS_ERROR
);
2034 if (!channel
->use_buffer
)
2038 g_assert (!channel
->read_buf
|| channel
->read_buf
->len
== 0);
2040 status
= channel
->funcs
->io_read (channel
, buf
, count
, &tmp_bytes
, error
);
2043 *bytes_read
= tmp_bytes
;
2048 status
= G_IO_STATUS_NORMAL
;
2050 while (BUF_LEN (USE_BUF (channel
)) < count
&& status
== G_IO_STATUS_NORMAL
)
2051 status
= g_io_channel_fill_buffer (channel
, error
);
2053 /* Only return an error if we have no data */
2055 if (BUF_LEN (USE_BUF (channel
)) == 0)
2057 g_assert (status
!= G_IO_STATUS_NORMAL
);
2059 if (status
== G_IO_STATUS_EOF
&& channel
->encoding
2060 && BUF_LEN (channel
->read_buf
) > 0)
2062 g_set_error_literal (error
, G_CONVERT_ERROR
,
2063 G_CONVERT_ERROR_PARTIAL_INPUT
,
2064 _("Leftover unconverted data in read buffer"));
2065 status
= G_IO_STATUS_ERROR
;
2074 if (status
== G_IO_STATUS_ERROR
)
2075 g_clear_error (error
);
2077 got_bytes
= MIN (count
, BUF_LEN (USE_BUF (channel
)));
2079 g_assert (got_bytes
> 0);
2081 if (channel
->encoding
)
2082 /* Don't validate for NULL encoding, binary safe */
2084 gchar
*nextchar
, *prevchar
;
2086 g_assert (USE_BUF (channel
) == channel
->encoded_read_buf
);
2088 nextchar
= channel
->encoded_read_buf
->str
;
2092 prevchar
= nextchar
;
2093 nextchar
= g_utf8_next_char (nextchar
);
2094 g_assert (nextchar
!= prevchar
); /* Possible for *prevchar of -1 or -2 */
2096 while (nextchar
< channel
->encoded_read_buf
->str
+ got_bytes
);
2098 if (nextchar
> channel
->encoded_read_buf
->str
+ got_bytes
)
2099 got_bytes
= prevchar
- channel
->encoded_read_buf
->str
;
2101 g_assert (got_bytes
> 0 || count
< 6);
2104 memcpy (buf
, USE_BUF (channel
)->str
, got_bytes
);
2105 g_string_erase (USE_BUF (channel
), 0, got_bytes
);
2108 *bytes_read
= got_bytes
;
2110 return G_IO_STATUS_NORMAL
;
2114 * g_io_channel_read_unichar:
2115 * @channel: a #GIOChannel
2116 * @thechar: a location to return a character
2117 * @error: a location to return an error of type #GConvertError
2118 * or #GIOChannelError
2120 * Reads a Unicode character from @channel.
2121 * This function cannot be called on a channel with %NULL encoding.
2123 * Return value: a #GIOStatus
2126 g_io_channel_read_unichar (GIOChannel
*channel
,
2130 GIOStatus status
= G_IO_STATUS_NORMAL
;
2132 g_return_val_if_fail (channel
!= NULL
, G_IO_STATUS_ERROR
);
2133 g_return_val_if_fail (channel
->encoding
!= NULL
, G_IO_STATUS_ERROR
);
2134 g_return_val_if_fail ((error
== NULL
) || (*error
== NULL
),
2136 g_return_val_if_fail (channel
->is_readable
, G_IO_STATUS_ERROR
);
2138 while (BUF_LEN (channel
->encoded_read_buf
) == 0 && status
== G_IO_STATUS_NORMAL
)
2139 status
= g_io_channel_fill_buffer (channel
, error
);
2141 /* Only return an error if we have no data */
2143 if (BUF_LEN (USE_BUF (channel
)) == 0)
2145 g_assert (status
!= G_IO_STATUS_NORMAL
);
2147 if (status
== G_IO_STATUS_EOF
&& BUF_LEN (channel
->read_buf
) > 0)
2149 g_set_error_literal (error
, G_CONVERT_ERROR
,
2150 G_CONVERT_ERROR_PARTIAL_INPUT
,
2151 _("Leftover unconverted data in read buffer"));
2152 status
= G_IO_STATUS_ERROR
;
2156 *thechar
= (gunichar
) -1;
2161 if (status
== G_IO_STATUS_ERROR
)
2162 g_clear_error (error
);
2165 *thechar
= g_utf8_get_char (channel
->encoded_read_buf
->str
);
2167 g_string_erase (channel
->encoded_read_buf
, 0,
2168 g_utf8_next_char (channel
->encoded_read_buf
->str
)
2169 - channel
->encoded_read_buf
->str
);
2171 return G_IO_STATUS_NORMAL
;
2175 * g_io_channel_write_chars:
2176 * @channel: a #GIOChannel
2177 * @buf: a buffer to write data from
2178 * @count: the size of the buffer. If -1, the buffer
2179 * is taken to be a nul-terminated string.
2180 * @bytes_written: The number of bytes written. This can be nonzero
2181 * even if the return value is not %G_IO_STATUS_NORMAL.
2182 * If the return value is %G_IO_STATUS_NORMAL and the
2183 * channel is blocking, this will always be equal
2184 * to @count if @count >= 0.
2185 * @error: a location to return an error of type #GConvertError
2186 * or #GIOChannelError
2188 * Replacement for g_io_channel_write() with the new API.
2190 * On seekable channels with encodings other than %NULL or UTF-8, generic
2191 * mixing of reading and writing is not allowed. A call to g_io_channel_write_chars ()
2192 * may only be made on a channel from which data has been read in the
2193 * cases described in the documentation for g_io_channel_set_encoding ().
2195 * Return value: the status of the operation.
2198 g_io_channel_write_chars (GIOChannel
*channel
,
2201 gsize
*bytes_written
,
2205 gssize wrote_bytes
= 0;
2207 g_return_val_if_fail (channel
!= NULL
, G_IO_STATUS_ERROR
);
2208 g_return_val_if_fail ((error
== NULL
) || (*error
== NULL
),
2210 g_return_val_if_fail (channel
->is_writeable
, G_IO_STATUS_ERROR
);
2212 if ((count
< 0) && buf
)
2213 count
= strlen (buf
);
2219 return G_IO_STATUS_NORMAL
;
2222 g_return_val_if_fail (buf
!= NULL
, G_IO_STATUS_ERROR
);
2223 g_return_val_if_fail (count
> 0, G_IO_STATUS_ERROR
);
2225 /* Raw write case */
2227 if (!channel
->use_buffer
)
2231 g_assert (!channel
->write_buf
|| channel
->write_buf
->len
== 0);
2232 g_assert (channel
->partial_write_buf
[0] == '\0');
2234 status
= channel
->funcs
->io_write (channel
, buf
, count
, &tmp_bytes
, error
);
2237 *bytes_written
= tmp_bytes
;
2244 if (channel
->is_seekable
&& (( BUF_LEN (channel
->read_buf
) > 0)
2245 || (BUF_LEN (channel
->encoded_read_buf
) > 0)))
2247 if (channel
->do_encode
&& BUF_LEN (channel
->encoded_read_buf
) > 0)
2249 g_warning("Mixed reading and writing not allowed on encoded files");
2250 return G_IO_STATUS_ERROR
;
2252 status
= g_io_channel_seek_position (channel
, 0, G_SEEK_CUR
, error
);
2253 if (status
!= G_IO_STATUS_NORMAL
)
2261 if (!channel
->write_buf
)
2262 channel
->write_buf
= g_string_sized_new (channel
->buf_size
);
2264 while (wrote_bytes
< count
)
2268 /* If the buffer is full, try a write immediately. In
2269 * the nonblocking case, this prevents the user from
2270 * writing just a little bit to the buffer every time
2271 * and never receiving an EAGAIN.
2274 if (channel
->write_buf
->len
>= channel
->buf_size
- MAX_CHAR_SIZE
)
2276 gsize did_write
= 0, this_time
;
2280 status
= channel
->funcs
->io_write (channel
, channel
->write_buf
->str
2281 + did_write
, channel
->write_buf
->len
2282 - did_write
, &this_time
, error
);
2283 did_write
+= this_time
;
2285 while (status
== G_IO_STATUS_NORMAL
&&
2286 did_write
< MIN (channel
->write_buf
->len
, MAX_CHAR_SIZE
));
2288 g_string_erase (channel
->write_buf
, 0, did_write
);
2290 if (status
!= G_IO_STATUS_NORMAL
)
2292 if (status
== G_IO_STATUS_AGAIN
&& wrote_bytes
> 0)
2293 status
= G_IO_STATUS_NORMAL
;
2295 *bytes_written
= wrote_bytes
;
2300 space_in_buf
= MAX (channel
->buf_size
, channel
->write_buf
->allocated_len
- 1)
2301 - channel
->write_buf
->len
; /* 1 for NULL */
2303 /* This is only true because g_io_channel_set_buffer_size ()
2304 * ensures that channel->buf_size >= MAX_CHAR_SIZE.
2306 g_assert (space_in_buf
>= MAX_CHAR_SIZE
);
2308 if (!channel
->encoding
)
2310 gssize write_this
= MIN (space_in_buf
, count
- wrote_bytes
);
2312 g_string_append_len (channel
->write_buf
, buf
, write_this
);
2314 wrote_bytes
+= write_this
;
2318 const gchar
*from_buf
;
2319 gsize from_buf_len
, from_buf_old_len
, left_len
;
2323 if (channel
->partial_write_buf
[0] != '\0')
2325 g_assert (wrote_bytes
== 0);
2327 from_buf
= channel
->partial_write_buf
;
2328 from_buf_old_len
= strlen (channel
->partial_write_buf
);
2329 g_assert (from_buf_old_len
> 0);
2330 from_buf_len
= MIN (6, from_buf_old_len
+ count
);
2332 memcpy (channel
->partial_write_buf
+ from_buf_old_len
, buf
,
2333 from_buf_len
- from_buf_old_len
);
2338 from_buf_len
= count
- wrote_bytes
;
2339 from_buf_old_len
= 0;
2344 if (!channel
->do_encode
) /* UTF-8 encoding */
2346 const gchar
*badchar
;
2347 gsize try_len
= MIN (from_buf_len
, space_in_buf
);
2349 /* UTF-8, just validate, emulate g_iconv */
2351 if (!g_utf8_validate (from_buf
, try_len
, &badchar
))
2354 gsize incomplete_len
= from_buf
+ try_len
- badchar
;
2356 left_len
= from_buf
+ from_buf_len
- badchar
;
2358 try_char
= g_utf8_get_char_validated (badchar
, incomplete_len
);
2363 g_assert (incomplete_len
< 6);
2364 if (try_len
== from_buf_len
)
2376 g_warning ("Invalid UTF-8 passed to g_io_channel_write_chars().");
2377 /* FIXME bail here? */
2382 g_assert_not_reached ();
2384 errnum
= 0; /* Don't confunse the compiler */
2391 left_len
= from_buf_len
- try_len
;
2394 g_string_append_len (channel
->write_buf
, from_buf
,
2395 from_buf_len
- left_len
);
2396 from_buf
+= from_buf_len
- left_len
;
2402 left_len
= from_buf_len
;
2403 g_string_set_size (channel
->write_buf
, channel
->write_buf
->len
2405 outbuf
= channel
->write_buf
->str
+ channel
->write_buf
->len
2407 err
= g_iconv (channel
->write_cd
, (gchar
**) &from_buf
, &left_len
,
2408 &outbuf
, &space_in_buf
);
2410 g_string_truncate (channel
->write_buf
, channel
->write_buf
->len
2414 if (err
== (gsize
) -1)
2419 g_assert (left_len
< 6);
2421 if (from_buf_old_len
== 0)
2423 /* Not from partial_write_buf */
2425 memcpy (channel
->partial_write_buf
, from_buf
, left_len
);
2426 channel
->partial_write_buf
[left_len
] = '\0';
2428 *bytes_written
= count
;
2429 return G_IO_STATUS_NORMAL
;
2432 /* Working in partial_write_buf */
2434 if (left_len
== from_buf_len
)
2436 /* Didn't convert anything, must still have
2437 * less than a full character
2440 g_assert (count
== from_buf_len
- from_buf_old_len
);
2442 channel
->partial_write_buf
[from_buf_len
] = '\0';
2445 *bytes_written
= count
;
2447 return G_IO_STATUS_NORMAL
;
2450 g_assert (from_buf_len
- left_len
>= from_buf_old_len
);
2452 /* We converted all the old data. This is fine */
2456 if (from_buf_len
== left_len
)
2458 /* Nothing was written, add enough space for
2459 * at least one character.
2461 space_in_buf
+= MAX_CHAR_SIZE
;
2466 g_set_error_literal (error
, G_CONVERT_ERROR
,
2467 G_CONVERT_ERROR_ILLEGAL_SEQUENCE
,
2468 _("Invalid byte sequence in conversion input"));
2469 if (from_buf_old_len
> 0 && from_buf_len
== left_len
)
2470 g_warning ("Illegal sequence due to partial character "
2471 "at the end of a previous write.\n");
2473 wrote_bytes
+= from_buf_len
- left_len
- from_buf_old_len
;
2475 *bytes_written
= wrote_bytes
;
2476 channel
->partial_write_buf
[0] = '\0';
2477 return G_IO_STATUS_ERROR
;
2479 g_set_error (error
, G_CONVERT_ERROR
, G_CONVERT_ERROR_FAILED
,
2480 _("Error during conversion: %s"), g_strerror (errnum
));
2481 if (from_buf_len
>= left_len
+ from_buf_old_len
)
2482 wrote_bytes
+= from_buf_len
- left_len
- from_buf_old_len
;
2484 *bytes_written
= wrote_bytes
;
2485 channel
->partial_write_buf
[0] = '\0';
2486 return G_IO_STATUS_ERROR
;
2490 g_assert (from_buf_len
- left_len
>= from_buf_old_len
);
2492 wrote_bytes
+= from_buf_len
- left_len
- from_buf_old_len
;
2494 if (from_buf_old_len
> 0)
2496 /* We were working in partial_write_buf */
2498 buf
+= from_buf_len
- left_len
- from_buf_old_len
;
2499 channel
->partial_write_buf
[0] = '\0';
2507 *bytes_written
= count
;
2509 return G_IO_STATUS_NORMAL
;
2513 * g_io_channel_write_unichar:
2514 * @channel: a #GIOChannel
2515 * @thechar: a character
2516 * @error: location to return an error of type #GConvertError
2517 * or #GIOChannelError
2519 * Writes a Unicode character to @channel.
2520 * This function cannot be called on a channel with %NULL encoding.
2522 * Return value: a #GIOStatus
2525 g_io_channel_write_unichar (GIOChannel
*channel
,
2530 gchar static_buf
[6];
2531 gsize char_len
, wrote_len
;
2533 g_return_val_if_fail (channel
!= NULL
, G_IO_STATUS_ERROR
);
2534 g_return_val_if_fail (channel
->encoding
!= NULL
, G_IO_STATUS_ERROR
);
2535 g_return_val_if_fail ((error
== NULL
) || (*error
== NULL
),
2537 g_return_val_if_fail (channel
->is_writeable
, G_IO_STATUS_ERROR
);
2539 char_len
= g_unichar_to_utf8 (thechar
, static_buf
);
2541 if (channel
->partial_write_buf
[0] != '\0')
2543 g_warning ("Partial charater written before writing unichar.\n");
2544 channel
->partial_write_buf
[0] = '\0';
2547 status
= g_io_channel_write_chars (channel
, static_buf
,
2548 char_len
, &wrote_len
, error
);
2550 /* We validate UTF-8, so we can't get a partial write */
2552 g_assert (wrote_len
== char_len
|| status
!= G_IO_STATUS_NORMAL
);
2558 * g_io_channel_error_quark:
2560 * Return value: the quark used as %G_IO_CHANNEL_ERROR
2563 * G_IO_CHANNEL_ERROR:
2565 * Error domain for #GIOChannel operations. Errors in this domain will
2566 * be from the #GIOChannelError enumeration. See #GError for
2567 * information on error domains.
2571 * @G_IO_CHANNEL_ERROR_FBIG: File too large.
2572 * @G_IO_CHANNEL_ERROR_INVAL: Invalid argument.
2573 * @G_IO_CHANNEL_ERROR_IO: IO error.
2574 * @G_IO_CHANNEL_ERROR_ISDIR: File is a directory.
2575 * @G_IO_CHANNEL_ERROR_NOSPC: No space left on device.
2576 * @G_IO_CHANNEL_ERROR_NXIO: No such device or address.
2577 * @G_IO_CHANNEL_ERROR_OVERFLOW: Value too large for defined datatype.
2578 * @G_IO_CHANNEL_ERROR_PIPE: Broken pipe.
2579 * @G_IO_CHANNEL_ERROR_FAILED: Some other error.
2581 * Error codes returned by #GIOChannel operations.
2584 g_io_channel_error_quark (void)
2586 return g_quark_from_static_string ("g-io-channel-error-quark");