luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-01-26 05:56:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

Coding style cleanups and doc improvements. (#491975, Areg Beketovski)

Browse Source 
2007-11-09  Matthias Clasen <mclasen@redhat.com>

        * glib/giochannel.c: Coding style cleanups and doc
        improvements.  (#491975, Areg Beketovski)



svn path=/trunk/; revision=5851
This commit is contained in:
Matthias Clasen 2007-11-10 01:11:58 +00:00 committed by Matthias Clasen
parent 4abb6c13be
commit 897cf88edf
2 changed files with 157 additions and 140 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
ChangeLog
View File

@ -1,3 +1,8 @@
2007-11-09 Matthias Clasen <mclasen@redhat.com>
* glib/giochannel.c: Coding style cleanups and doc
improvements. (#491975, Areg Beketovski)
2007-11-09 Matthias Clasen <mclasen@redhat.com> 2007-11-09 Matthias Clasen <mclasen@redhat.com>
* glib/gmain.c (g_main_context_iteration): Improve the * glib/gmain.c (g_main_context_iteration): Improve the

162
glib/giochannel.c
View File

@ -164,10 +164,11 @@ g_io_error_get_from_g_error (GIOStatus status,
/** /**
* g_io_channel_read: * g_io_channel_read:
* @channel: a #GIOChannel. * @channel: a #GIOChannel
* @buf: a buffer to read the data into (which should be at least count bytes long). * @buf: a buffer to read the data into (which should be at least
* @count: the number of bytes to read from the #GIOChannel. * count bytes long)
* @bytes_read: returns the number of bytes actually read. * @count: the number of bytes to read from the #GIOChannel
* @bytes_read: returns the number of bytes actually read
* *
* Reads data from a #GIOChannel. * Reads data from a #GIOChannel.
* *
@ -209,10 +210,10 @@ g_io_channel_read (GIOChannel *channel,
/** /**
* g_io_channel_write: * g_io_channel_write:
* @channel: a #GIOChannel. * @channel: a #GIOChannel
* @buf: the buffer containing the data to write. * @buf: the buffer containing the data to write
* @count: the number of bytes to write. * @count: the number of bytes to write
* @bytes_written: the number of bytes actually written. * @bytes_written: the number of bytes actually written
* *
* Writes data to a #GIOChannel. * Writes data to a #GIOChannel.
* *
@ -245,14 +246,15 @@ g_io_channel_write (GIOChannel *channel,
/** /**
* g_io_channel_seek: * g_io_channel_seek:
* @channel: a #GIOChannel. * @channel: a #GIOChannel
* @offset: an offset, in bytes, which is added to the position specified by @type * @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 * @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 * position), %G_SEEK_SET (the start of the file), or %G_SEEK_END
* file). * (the end of the file)
* *
* Sets the current position in the #GIOChannel, similar to the standard library * Sets the current position in the #GIOChannel, similar to the standard
* function fseek(). * library function fseek().
* *
* Return value: %G_IO_ERROR_NONE if the operation was successful. * Return value: %G_IO_ERROR_NONE if the operation was successful.
* *
@ -297,10 +299,10 @@ g_io_channel_seek (GIOChannel *channel,
/** /**
* g_io_channel_new_file: * g_io_channel_new_file:
* @filename: A string containing the name of a file. * @filename: A string containing the name of a file
* @mode: One of "r", "w", "a", "r+", "w+", "a+". These have * @mode: One of "r", "w", "a", "r+", "w+", "a+". These have
* the same meaning as in fopen(). * the same meaning as in fopen()
* @error: A location to return an error of type %G_FILE_ERROR. * @error: A location to return an error of type %G_FILE_ERROR
* *
* Open a file @filename as a #GIOChannel using mode @mode. This * Open a file @filename as a #GIOChannel using mode @mode. This
* channel will be closed when the last reference to it is dropped, * channel will be closed when the last reference to it is dropped,
@ -511,9 +513,8 @@ g_io_add_watch (GIOChannel *channel,
* @channel: A #GIOChannel * @channel: A #GIOChannel
* *
* This function returns a #GIOCondition depending on whether there * This function returns a #GIOCondition depending on whether there
* is data to be read/space to write data in the * is data to be read/space to write data in the internal buffers in
* internal buffers in the #GIOChannel. Only the flags %G_IO_IN and * the #GIOChannel. Only the flags %G_IO_IN and %G_IO_OUT may be set.
* %G_IO_OUT may be set.
* *
* Return value: A #GIOCondition * Return value: A #GIOCondition
**/ **/
@ -541,11 +542,12 @@ g_io_channel_get_buffer_condition (GIOChannel *channel)
/** /**
* g_io_channel_error_from_errno: * g_io_channel_error_from_errno:
* @en: an <literal>errno</literal> error number, e.g. %EINVAL. * @en: an <literal>errno</literal> error number, e.g. %EINVAL
* *
* Converts an <literal>errno</literal> error number to a #GIOChannelError. * Converts an <literal>errno</literal> error number to a #GIOChannelError.
* *
* Return value: a #GIOChannelError error number, e.g. %G_IO_CHANNEL_ERROR_INVAL. * Return value: a #GIOChannelError error number, e.g.
* %G_IO_CHANNEL_ERROR_INVAL.
**/ **/
GIOChannelError GIOChannelError
g_io_channel_error_from_errno (gint en) g_io_channel_error_from_errno (gint en)
@ -628,7 +630,7 @@ g_io_channel_error_from_errno (gint en)
/** /**
* g_io_channel_set_buffer_size: * g_io_channel_set_buffer_size:
* @channel: a #GIOChannel * @channel: a #GIOChannel
* @size: the size of the buffer. 0 == pick a good size * @size: the size of the buffer, or 0 to let GLib pick a good size
* *
* Sets the buffer size. * Sets the buffer size.
**/ **/
@ -666,13 +668,13 @@ g_io_channel_get_buffer_size (GIOChannel *channel)
/** /**
* g_io_channel_set_line_term: * g_io_channel_set_line_term:
* @channel: a #GIOChannel * @channel: a #GIOChannel
* @line_term: The line termination string. Use %NULL for auto detect. * @line_term: The line termination string. Use %NULL for autodetect.
* Auto detection breaks on "\n", "\r\n", "\r", "\0", and * Autodetection breaks on "\n", "\r\n", "\r", "\0", and
* the Unicode paragraph separator. Auto detection should * the Unicode paragraph separator. Autodetection should
* not be used for anything other than file-based channels. * not be used for anything other than file-based channels.
* @length: The length of the termination string. If -1 is passed, the * @length: The length of the termination string. If -1 is passed, the
* string is assumed to be nul-terminated. This option allows * string is assumed to be nul-terminated. This option allows
* termination strings with embeded nuls. * termination strings with embedded nuls.
* *
* This sets the string that #GIOChannel uses to determine * This sets the string that #GIOChannel uses to determine
* where in the file a line break occurs. * where in the file a line break occurs.
@ -702,7 +704,7 @@ g_io_channel_set_line_term (GIOChannel *channel,
* *
* This returns the string that #GIOChannel uses to determine * This returns the string that #GIOChannel uses to determine
* where in the file a line break occurs. A value of %NULL * where in the file a line break occurs. A value of %NULL
* indicates auto detection. * indicates autodetection.
* *
* Return value: The line termination string. This value * Return value: The line termination string. This value
* is owned by GLib and must not be freed. * is owned by GLib and must not be freed.
@ -721,9 +723,9 @@ g_io_channel_get_line_term (GIOChannel *channel,
/** /**
* g_io_channel_set_flags: * g_io_channel_set_flags:
* @channel: a #GIOChannel. * @channel: a #GIOChannel
* @flags: the flags to set on the IO channel. * @flags: the flags to set on the IO channel
* @error: A location to return an error of type #GIOChannelError. * @error: A location to return an error of type #GIOChannelError
* *
* Sets the (writeable) flags in @channel to (@flags & %G_IO_CHANNEL_SET_MASK). * Sets the (writeable) flags in @channel to (@flags & %G_IO_CHANNEL_SET_MASK).
* *
@ -738,7 +740,7 @@ g_io_channel_set_flags (GIOChannel *channel,
g_return_val_if_fail ((error == NULL) || (*error == NULL), g_return_val_if_fail ((error == NULL) || (*error == NULL),
G_IO_STATUS_ERROR); G_IO_STATUS_ERROR);
return (* channel->funcs->io_set_flags)(channel, return (*channel->funcs->io_set_flags) (channel,
flags & G_IO_FLAG_SET_MASK, flags & G_IO_FLAG_SET_MASK,
error); error);
} }
@ -754,7 +756,7 @@ g_io_channel_set_flags (GIOChannel *channel,
* are cached for internal use by the channel when it is created. * are cached for internal use by the channel when it is created.
* If they should change at some later point (e.g. partial shutdown * If they should change at some later point (e.g. partial shutdown
* of a socket with the UNIX shutdown() function), the user * of a socket with the UNIX shutdown() function), the user
* should immediately call g_io_channel_get_flags () to update * should immediately call g_io_channel_get_flags() to update
* the internal values of these flags. * the internal values of these flags.
* *
* Return value: the flags which are set on the channel * Return value: the flags which are set on the channel
@ -835,7 +837,7 @@ g_io_channel_get_close_on_unref (GIOChannel *channel)
* Return value: the status of the operation. * Return value: the status of the operation.
**/ **/
GIOStatus GIOStatus
g_io_channel_seek_position (GIOChannel* channel, g_io_channel_seek_position (GIOChannel *channel,
gint64 offset, gint64 offset,
GSeekType type, GSeekType type,
GError **error) GError **error)
@ -1010,7 +1012,7 @@ g_io_channel_set_buffered (GIOChannel *channel,
/** /**
* g_io_channel_get_buffered: * g_io_channel_get_buffered:
* @channel: a #GIOChannel. * @channel: a #GIOChannel
* *
* Returns whether @channel is buffered. * Returns whether @channel is buffered.
* *
@ -1028,43 +1030,51 @@ g_io_channel_get_buffered (GIOChannel *channel)
* g_io_channel_set_encoding: * g_io_channel_set_encoding:
* @channel: a #GIOChannel * @channel: a #GIOChannel
* @encoding: the encoding type * @encoding: the encoding type
* @error: location to store an error of type #GConvertError. * @error: location to store an error of type #GConvertError
* *
* Sets the encoding for the input/output of the channel. The internal * Sets the encoding for the input/output of the channel.
* encoding is always UTF-8. The default encoding for the * The internal encoding is always UTF-8. The default encoding
* external file is UTF-8. * for the external file is UTF-8.
* *
* The encoding %NULL is safe to use with binary data. * The encoding %NULL is safe to use with binary data.
* *
* The encoding can only be set if one of the following conditions * The encoding can only be set if one of the following conditions
* is true: * is true:
* * <itemizedlist>
* 1. The channel was just created, and has not been written to * <listitem><para>
* or read from yet. * The channel was just created, and has not been written to or read
* * from yet.
* 2. The channel is write-only. * </para></listitem>
* * <listitem><para>
* 3. The channel is a file, and the file pointer was just * The channel is write-only.
* </para></listitem>
* <listitem><para>
* The channel is a file, and the file pointer was just
* repositioned by a call to g_io_channel_seek_position(). * repositioned by a call to g_io_channel_seek_position().
* (This flushes all the internal buffers.) * (This flushes all the internal buffers.)
* * </para></listitem>
* 4. The current encoding is %NULL or UTF-8. * <listitem><para>
* * The current encoding is %NULL or UTF-8.
* 5. One of the (new API) read functions has just returned %G_IO_STATUS_EOF * </para></listitem>
* (or, in the case of g_io_channel_read_to_end (), %G_IO_STATUS_NORMAL). * <listitem><para>
* * One of the (new API) read functions has just returned %G_IO_STATUS_EOF
* 6. One of the functions g_io_channel_read_chars () or g_io_channel_read_unichar () * (or, in the case of g_io_channel_read_to_end(), %G_IO_STATUS_NORMAL).
* has returned %G_IO_STATUS_AGAIN or %G_IO_STATUS_ERROR. This may be * </para></listitem>
* useful in the case of %G_CONVERT_ERROR_ILLEGAL_SEQUENCE. * <listitem><para>
* Returning one of these statuses from g_io_channel_read_line (), * One of the functions g_io_channel_read_chars() or
* g_io_channel_read_line_string (), or g_io_channel_read_to_end () * g_io_channel_read_unichar() has returned %G_IO_STATUS_AGAIN or
* does <emphasis>not</emphasis> guarantee that the encoding can be changed. * %G_IO_STATUS_ERROR. This may be useful in the case of
* * %G_CONVERT_ERROR_ILLEGAL_SEQUENCE.
* Returning one of these statuses from g_io_channel_read_line(),
* g_io_channel_read_line_string(), or g_io_channel_read_to_end()
* does <emphasis>not</emphasis> guarantee that the encoding can
* be changed.
* </para></listitem>
* </itemizedlist>
* Channels which do not meet one of the above conditions cannot call * Channels which do not meet one of the above conditions cannot call
* g_io_channel_seek_position () with an offset of %G_SEEK_CUR, * g_io_channel_seek_position() with an offset of %G_SEEK_CUR, and, if
* and, if they are "seekable", cannot * they are "seekable", cannot call g_io_channel_write_chars() after
* call g_io_channel_write_chars () after calling one * calling one of the API "read" functions.
* of the API "read" functions.
* *
* Return Value: %G_IO_STATUS_NORMAL if the encoding was successfully set. * Return Value: %G_IO_STATUS_NORMAL if the encoding was successfully set.
**/ **/
@ -1196,9 +1206,9 @@ g_io_channel_set_encoding (GIOChannel *channel,
* g_io_channel_get_encoding: * g_io_channel_get_encoding:
* @channel: a #GIOChannel * @channel: a #GIOChannel
* *
* Gets the encoding for the input/output of the channel. The internal * Gets the encoding for the input/output of the channel.
* encoding is always UTF-8. The encoding %NULL makes the * The internal encoding is always UTF-8. The encoding %NULL
* channel safe for binary data. * makes the channel safe for binary data.
* *
* Return value: A string containing the encoding, this string is * Return value: A string containing the encoding, this string is
* owned by GLib and must not be freed. * owned by GLib and must not be freed.
@ -1244,8 +1254,8 @@ g_io_channel_fill_buffer (GIOChannel *channel,
g_string_truncate (channel->read_buf, read_size + cur_len); g_string_truncate (channel->read_buf, read_size + cur_len);
if ((status != G_IO_STATUS_NORMAL) if ((status != G_IO_STATUS_NORMAL) &&
&& ((status != G_IO_STATUS_EOF) || (channel->read_buf->len == 0))) ((status != G_IO_STATUS_EOF) || (channel->read_buf->len == 0)))
return status; return status;
g_assert (channel->read_buf->len > 0); g_assert (channel->read_buf->len > 0);
@ -1654,8 +1664,8 @@ done:
* be freed with g_free() when no longer needed. This * be freed with g_free() when no longer needed. This
* data is terminated by an extra nul character, but there * data is terminated by an extra nul character, but there
* may be other nuls in the intervening data. * may be other nuls in the intervening data.
* @length: Location to store length of the data * @length: location to store length of the data
* @error: A location to return an error of type #GConvertError * @error: location to return an error of type #GConvertError
* or #GIOChannelError * or #GIOChannelError
* *
* Reads all the remaining data from the file. * Reads all the remaining data from the file.
@ -1739,7 +1749,7 @@ g_io_channel_read_to_end (GIOChannel *channel,
* success if count < 6 and the channel's encoding is non-%NULL. * success if count < 6 and the channel's encoding is non-%NULL.
* This indicates that the next UTF-8 character is too wide for * This indicates that the next UTF-8 character is too wide for
* the buffer. * the buffer.
* @error: A location to return an error of type #GConvertError * @error: a location to return an error of type #GConvertError
* or #GIOChannelError. * or #GIOChannelError.
* *
* Replacement for g_io_channel_read() with the new API. * Replacement for g_io_channel_read() with the new API.
@ -1851,9 +1861,10 @@ g_io_channel_read_chars (GIOChannel *channel,
* g_io_channel_read_unichar: * g_io_channel_read_unichar:
* @channel: a #GIOChannel * @channel: a #GIOChannel
* @thechar: a location to return a character * @thechar: a location to return a character
* @error: A location to return an error of type #GConvertError * @error: a location to return an error of type #GConvertError
* or #GIOChannelError * or #GIOChannelError
* *
* Reads a Unicode character from @channel.
* This function cannot be called on a channel with %NULL encoding. * This function cannot be called on a channel with %NULL encoding.
* *
* Return value: a #GIOStatus * Return value: a #GIOStatus
@ -1918,7 +1929,7 @@ g_io_channel_read_unichar (GIOChannel *channel,
* If the return value is %G_IO_STATUS_NORMAL and the * If the return value is %G_IO_STATUS_NORMAL and the
* channel is blocking, this will always be equal * channel is blocking, this will always be equal
* to @count if @count >= 0. * to @count if @count >= 0.
* @error: A location to return an error of type #GConvertError * @error: a location to return an error of type #GConvertError
* or #GIOChannelError * or #GIOChannelError
* *
* Replacement for g_io_channel_write() with the new API. * Replacement for g_io_channel_write() with the new API.
@ -2249,9 +2260,10 @@ reconvert:
* g_io_channel_write_unichar: * g_io_channel_write_unichar:
* @channel: a #GIOChannel * @channel: a #GIOChannel
* @thechar: a character * @thechar: a character
* @error: A location to return an error of type #GConvertError * @error: location to return an error of type #GConvertError
* or #GIOChannelError * or #GIOChannelError
* *
* Writes a Unicode character to @channel.
* This function cannot be called on a channel with %NULL encoding. * This function cannot be called on a channel with %NULL encoding.
* *
* Return value: a #GIOStatus * Return value: a #GIOStatus
@ -2292,7 +2304,7 @@ g_io_channel_write_unichar (GIOChannel *channel,
/** /**
* g_io_channel_error_quark: * g_io_channel_error_quark:
* *
* Return value: The quark used as %G_IO_CHANNEL_ERROR * Return value: the quark used as %G_IO_CHANNEL_ERROR
**/ **/
GQuark GQuark
g_io_channel_error_quark (void) g_io_channel_error_quark (void)