luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-07-24 10:57:53 +02:00
Code Issues Packages Projects Releases Wiki Activity

Jun 29 13:36:39 2001 Owen Taylor <otaylor@redhat.com>

Browse Source 
* glib/gstring.[ch] (g_string_set_size): Add function to
        allow setting the length of a string greater than the
        current length (for buffering usage)

        * glib/gstring.[ch]: Expose string->allocated_len, since
        that is useful when using GString simply as a buffer.
        (Renamed from string->alloc)

        * glib/giochannel.[ch] glib/giounix.c glib/giowin32.c:
        Major patch from Hidetoshi Tajima and Ron Steinke
        reworking GIOChannel to have:

         - Buffering
         - Sane and useful error reporting
         - Streaming encoding conversion with iconv
         - Convenience functions to read by lines or
           an entire file.

        Also fix remaining 64 bit cleanliness issues.

        * tests/iochannel-test.c tests/Makefile.am: Test case
        for IO channel streaming conversion. Still needs
        some fixing up.
This commit is contained in:
Owen Taylor
2001-06-30 15:22:13 +00:00
parent f571f74616
commit 42a23950f5
22 changed files with 2931 additions and 276 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
docs/reference/glib/glib-sections.txt
View File

@@ -589,18 +589,29 @@ GIOChannel
g_io_channel_unix_new
g_io_channel_unix_get_fd
<SUBSECTION>
g_io_channel_init
<SUBSECTION>
g_io_channel_read
GIOError
g_io_channel_write
g_io_channel_seek
g_io_channel_new_file
GIOFileMode
g_io_channel_read_chars
g_io_channel_read_line
g_io_channel_read_line_string
g_io_channel_read_to_end
g_io_channel_write_chars
g_io_channel_flush
g_io_channel_seek_position
GSeekType
g_io_channel_close
<SUBSECTION>
GChannelStatus
GChannelError
G_CHANNEL_ERROR
g_channel_error_quark
g_channel_error_from_errno
<SUBSECTION>
g_io_channel_ref
g_io_channel_unref
@@ -615,6 +626,23 @@ GIOFunc
<SUBSECTION>
GIOFuncs
<SUBSECTION>
g_io_channel_get_buffer_size
g_io_channel_set_buffer_size
g_io_channel_get_buffer_condition
g_io_channel_get_flags
g_io_channel_set_flags
GIOFlags
g_io_channel_get_line_term
g_io_channel_set_line_term
G_IO_CHANNEL_UNIX_LINE_TERM
G_IO_CHANNEL_DOS_LINE_TERM
G_IO_CHANNEL_MACINTOSH_LINE_TERM
G_IO_CHANNEL_DEFAULT_LINE_TERM
g_io_channel_get_encoding
g_io_channel_set_encoding
G_IO_CHANNEL_ENCODE_RAW
<SUBSECTION Private>
g_io_channel_win32_new_fd
g_io_channel_win32_new_messages
@@ -622,6 +650,12 @@ g_io_channel_win32_new_socket
g_io_channel_win32_poll
g_io_channel_win32_make_pollfd
g_io_channel_win32_get_fd
<SUBSECTION>
g_io_channel_read
GIOError
g_io_channel_write
g_io_channel_seek
</SECTION>
<SECTION>
@@ -1395,6 +1429,7 @@ g_string_insert_c
g_string_insert_len
g_string_erase
g_string_truncate
g_string_set_size
g_string_free
<SUBSECTION>

48
docs/reference/glib/tmpl/glib-unused.sgml
View File

@@ -1,3 +1,37 @@
<!-- ##### ENUM GChannelError ##### -->
<para>
</para>
@G_CHANNEL_ERROR_ACCES:
@G_CHANNEL_ERROR_BADF:
@G_CHANNEL_ERROR_DEADLK:
@G_CHANNEL_ERROR_FAULT:
@G_CHANNEL_ERROR_INVAL:
@G_CHANNEL_ERROR_IO:
@G_CHANNEL_ERROR_ISDIR:
@G_CHANNEL_ERROR_MFILE:
@G_CHANNEL_ERROR_NOLCK:
@G_CHANNEL_ERROR_NOSPC:
@G_CHANNEL_ERROR_PERM:
@G_CHANNEL_ERROR_PIPE:
@G_CHANNEL_ERROR_SPIPE:
@G_CHANNEL_ERROR_ENCODE_RW:
@G_CHANNEL_ERROR_FAILED:
<!-- ##### ENUM GChannelStatus ##### -->
<para>
</para>
@G_CHANNEL_STATUS_NORMAL:
@G_CHANNEL_STATUS_EOF:
@G_CHANNEL_STATUS_PARTIAL_CHARS:
@G_CHANNEL_STATUS_AGAIN:
@G_CHANNEL_STATUS_INTR:
@G_CHANNEL_STATUS_ERROR:
@G_CHANNEL_STATUS_BAD_INPUT:
<!-- ##### USER_FUNCTION GCompareFuncData ##### -->
<para>
@@ -25,12 +59,26 @@
@hook_list:
@hook:
<!-- ##### MACRO G_CHANNEL_ERROR ##### -->
<para>
</para>
<!-- ##### MACRO G_HOOK_DEFERRED_DESTROY ##### -->
<para>
</para>
<!-- ##### MACRO G_IO_CHANNEL_DEFAULT_LINE_TERM ##### -->
<para>
One of %G_IO_CHANNEL_UNIX_LINE_TERM, %G_IO_CHANNEL_DOS_LINE_TERM,
or %G_IO_CHANNEL_MACINTOSH_LINE_TERM (unimplemented)
depending on the system type.
</para>
<!-- ##### MACRO access ##### -->
<para>

354
docs/reference/glib/tmpl/iochannels.sgml
View File

@@ -15,11 +15,13 @@ Windows is only partially complete.
<para>
To create a new #GIOChannel on Unix systems use g_io_channel_unix_new().
This works for plain file descriptors, pipes and sockets.
Alternately, a channel can be created for a file in a system independent
manner using g_io_channel_new_file().
</para>
<para>
Once a #GIOChannel has been created, it can be used in a generic manner
with the functions g_io_channel_read(), g_io_channel_write(),
g_io_channel_seek(), and g_io_channel_close().
with the functions g_io_channel_read_chars(), g_io_channel_write_chars(),
g_io_channel_seek_position(), and g_io_channel_close().
</para>
<para>
To add a #GIOChannel to the
@@ -32,7 +34,8 @@ called whenever these events occur.
#GIOChannel instances are created with an initial reference count of 1.
g_io_channel_ref() and g_io_channel_unref() can be used to increment or
decrement the reference count respectively. When the reference count falls
to 0, the #GIOChannel is freed. (Though it isn't closed automatically.)
to 0, the #GIOChannel is freed. (Though it isn't closed automatically,
unless it was created using g_io_channel_new_from_file().)
Using g_io_add_watch() or g_io_add_watch_full() increments a channel's
reference count.
</para>
@@ -43,6 +46,14 @@ which creates a #GIOChannel from a file descriptor and adds it to the
The event source can later be removed with gtk_input_remove().
Similar functions can also be found in GDK.
</para>
<para>
The new functions g_io_channel_read_chars(), g_io_channel_read_line(),
g_io_channel_read_line_string(), g_io_channel_read_to_end(),
g_io_channel_write_chars(), g_io_channel_seek_position(),
and g_io_channel_flush() should not be mixed with the
depricated functions g_io_channel_read(), g_io_channel_write(),
and g_io_channel_seek() on the same channel.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
@@ -69,6 +80,21 @@ private and should only be accessed with the following functions.
@channel_flags:
@ref_count:
@funcs:
@encoding:
@read_cd:
@write_cd:
@line_term:
@buf_size:
@read_buf:
@encoded_read_buf:
@write_buf:
@use_buffer:
@do_encode:
@ready_to_read:
@ready_to_write:
@close_on_unref:
@seekable_cached:
@is_seekable:
<!-- ##### FUNCTION g_io_channel_unix_new ##### -->
<para>
@@ -102,59 +128,120 @@ programmer (unless you are creating a new type of #GIOChannel).
@channel: a #GIOChannel.
<!-- ##### FUNCTION g_io_channel_read ##### -->
<!-- ##### FUNCTION g_io_channel_new_file ##### -->
<para>
Reads data from a #GIOChannel.
</para>
@channel: a #GIOChannel.
@buf: a buffer to read the data into (which should be at least count bytes
long).
@count: the number of bytes to read from the #GIOChannel.
@bytes_read: returns the number of bytes actually read.
@Returns: %G_IO_ERROR_NONE if the operation was successful.
@filename:
@mode:
@error:
@Returns:
<!-- ##### ENUM GIOError ##### -->
<!-- ##### ENUM GIOFileMode ##### -->
<para>
</para>
@G_IO_ERROR_NONE:
@G_IO_ERROR_AGAIN:
@G_IO_ERROR_INVAL:
@G_IO_ERROR_UNKNOWN:
@G_IO_FILE_MODE_READ:
@G_IO_FILE_MODE_WRITE:
@G_IO_FILE_MODE_APPEND:
@G_IO_FILE_MODE_READ_WRITE:
@G_IO_FILE_MODE_READ_WRITE_TRUNCATE:
@G_IO_FILE_MODE_READ_WRITE_APPEND:
<!-- ##### FUNCTION g_io_channel_write ##### -->
<!-- ##### FUNCTION g_io_channel_read_chars ##### -->
<para>
Writes data to a #GIOChannel.
</para>
@channel: a #GIOChannel.
@buf: the buffer containing the data to write.
@count: the number of bytes to write.
@bytes_written: the number of bytes actually written.
@Returns: %G_IO_ERROR_NONE if the operation was successful.
@channel:
@buf:
@count:
@bytes_read:
@error:
@Returns:
<!-- ##### FUNCTION g_io_channel_seek ##### -->
<!-- ##### FUNCTION g_io_channel_read_line ##### -->
<para>
Sets the current position in the #GIOChannel, similar to the standard system
call <function>fseek()</function>.
</para>
@channel: a #GIOChannel.
@offset: an offset, in bytes, which is added to the position specified by
@type.
@type: the position in the file, which can be %G_SEEK_CUR (the current
position), %G_SEEK_SET (the start of the file), or %G_SEEK_END (the end of the
file).
@Returns: %G_IO_ERROR_NONE if the operation was successful.
@channel:
@str_return:
@length:
@terminator_pos:
@error:
@Returns:
<!-- ##### FUNCTION g_io_channel_read_line_string ##### -->
<para>
</para>
@channel:
@buffer:
@terminator_pos:
@error:
@Returns:
<!-- ##### FUNCTION g_io_channel_read_to_end ##### -->
<para>
</para>
@channel:
@str_return:
@length:
@error:
@Returns:
<!-- ##### FUNCTION g_io_channel_write_chars ##### -->
<para>
</para>
@channel:
@buf:
@count:
@bytes_written:
@error:
@Returns:
<!-- ##### FUNCTION g_io_channel_flush ##### -->
<para>
</para>
@channel:
@error:
@Returns:
<!-- # Unused Parameters # -->
@err:
<!-- ##### FUNCTION g_io_channel_seek_position ##### -->
<para>
</para>
@channel:
@offset:
@type:
@error:
@Returns:
<!-- # Unused Parameters # -->
@err:
<!-- ##### ENUM GSeekType ##### -->
<para>
An enumeration specifying the base position for a g_io_channel_seek()
An enumeration specifying the base position for a g_io_channel_seek_position()
operation.
<informaltable pgwide=1 frame="none" role="enum">
@@ -186,11 +273,26 @@ operation.
<!-- ##### FUNCTION g_io_channel_close ##### -->
<para>
Closes a #GIOChannel.
The #GIOChannel will be freed when its reference count drops to 0.
</para>
@channel: a #GIOChannel.
@channel:
<!-- ##### FUNCTION g_channel_error_quark ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION g_channel_error_from_errno ##### -->
<para>
</para>
@en:
@Returns:
<!-- ##### FUNCTION g_io_channel_ref ##### -->
@@ -330,4 +432,182 @@ generic way.
@io_close:
@io_create_watch:
@io_free:
@io_set_flags:
@io_get_flags:
<!-- ##### FUNCTION g_io_channel_get_buffer_size ##### -->
<para>
</para>
@channel:
@Returns:
<!-- ##### FUNCTION g_io_channel_set_buffer_size ##### -->
<para>
</para>
@channel:
@size:
<!-- ##### FUNCTION g_io_channel_get_buffer_condition ##### -->
<para>
</para>
@channel:
@Returns:
<!-- ##### FUNCTION g_io_channel_get_flags ##### -->
<para>
</para>
@channel:
@Returns:
<!-- # Unused Parameters # -->
@flags:
@error:
<!-- ##### FUNCTION g_io_channel_set_flags ##### -->
<para>
</para>
@channel:
@flags:
@error:
@Returns:
<!-- ##### ENUM GIOFlags ##### -->
<para>
</para>
@G_IO_FLAG_APPEND:
@G_IO_FLAG_NONBLOCK:
@G_IO_FLAG_IS_READABLE:
@G_IO_FLAG_IS_WRITEABLE:
@G_IO_FLAG_IS_SEEKABLE:
@G_IO_FLAG_MASK:
@G_IO_FLAG_GET_MASK:
@G_IO_FLAG_SET_MASK:
<!-- ##### FUNCTION g_io_channel_get_line_term ##### -->
<para>
</para>
@channel:
@Returns:
<!-- ##### FUNCTION g_io_channel_set_line_term ##### -->
<para>
</para>
@channel:
@line_term:
<!-- ##### MACRO G_IO_CHANNEL_UNIX_LINE_TERM ##### -->
<para>
</para>
<!-- ##### MACRO G_IO_CHANNEL_DOS_LINE_TERM ##### -->
<para>
</para>
<!-- ##### MACRO G_IO_CHANNEL_MACINTOSH_LINE_TERM ##### -->
<para>
</para>
<!-- ##### FUNCTION g_io_channel_get_encoding ##### -->
<para>
</para>
@channel:
@Returns:
<!-- ##### FUNCTION g_io_channel_set_encoding ##### -->
<para>
</para>
@channel:
@encoding:
@error:
@Returns:
<!-- ##### MACRO G_IO_CHANNEL_ENCODE_RAW ##### -->
<para>
Encoding for nonbuffered IO. With this encoding, data must be
read using g_io_channel_read_chars(); the other functions will
not work.
</para>
<!-- ##### FUNCTION g_io_channel_read ##### -->
<para>
</para>
@channel:
@buf:
@count:
@bytes_read:
@Returns:
<!-- ##### ENUM GIOError ##### -->
<para>
#GIOError is only used by the depricated functions g_io_channel_read(),
g_io_channel_write(), and g_io_channel_seek().
</para>
@G_IO_ERROR_NONE:
@G_IO_ERROR_AGAIN:
@G_IO_ERROR_INVAL:
@G_IO_ERROR_UNKNOWN:
<!-- ##### FUNCTION g_io_channel_write ##### -->
<para>
</para>
@channel:
@buf:
@count:
@bytes_written:
@Returns:
<!-- ##### FUNCTION g_io_channel_seek ##### -->
<para>
</para>
@channel:
@offset:
@type.
@type:
@Returns:

11
docs/reference/glib/tmpl/strings.sgml
View File

@@ -32,6 +32,7 @@ string.
@str:
@len:
@alloc:
<!-- ##### FUNCTION g_string_new ##### -->
<para>
@@ -247,6 +248,16 @@ Cuts off the end of the GString, leaving the first @len characters.
@Returns: the #GString.
<!-- ##### FUNCTION g_string_set_size ##### -->
<para>
</para>
@string:
@len:
@Returns:
<!-- ##### FUNCTION g_string_free ##### -->
<para>
Frees the memory allocated for the #GString.