GString: cosmetic cleanups

This commit is contained in:
Matthias Clasen 2011-10-01 23:23:40 -04:00
parent 7154d44c5c
commit 459b14d89a
2 changed files with 357 additions and 358 deletions

View File

@ -71,14 +71,14 @@
*
* To free the entire #GStringChunk use g_string_chunk_free(). It is
* not possible to free individual strings.
**/
*/
/**
* GStringChunk:
*
* An opaque data structure representing String Chunks. It should only
* be accessed by using the following functions.
**/
*/
struct _GStringChunk
{
GHashTable *const_table;
@ -132,7 +132,7 @@ g_str_equal (gconstpointer v1,
* when using strings as keys in a #GHashTable.
*
* Returns: a hash value corresponding to the key
**/
*/
guint
g_str_hash (gconstpointer v)
{
@ -494,7 +494,7 @@ g_string_new_len (const gchar *init,
/**
* g_string_free:
* @string: a #GString
* @free_segment: if %TRUE the actual character data is freed as well
* @free_segment: if %TRUE, the actual character data is freed as well
*
* Frees the memory allocated for the #GString.
* If @free_segment is %TRUE it also frees the character data. If
@ -569,7 +569,6 @@ g_string_equal (const GString *v,
*
* Returns: hash code for @str
*/
/* 31 bit hash function */
guint
g_string_hash (const GString *str)
{
@ -577,6 +576,7 @@ g_string_hash (const GString *str)
gsize n = str->len;
guint h = 0;
/* 31 bit hash function */
while (n--)
{
h = (h << 5) - h + *p;
@ -609,8 +609,9 @@ g_string_assign (GString *string,
/* Make sure assigning to itself doesn't corrupt the string. */
if (string->str != rval)
{
/* Assigning from substring should be ok since g_string_truncate
does not realloc. */
/* Assigning from substring should be ok, since
* g_string_truncate() does not reallocate.
*/
g_string_truncate (string, 0);
g_string_append (string, rval);
}
@ -651,7 +652,7 @@ g_string_truncate (GString *string,
* always, string->str[string->len] will be a nul byte.)
*
* Return value: @string
**/
*/
GString *
g_string_set_size (GString *string,
gsize len)
@ -706,10 +707,11 @@ g_string_insert_len (GString *string,
else
g_return_val_if_fail (pos <= string->len, string);
/* Check whether val represents a substring of string. This test
probably violates chapter and verse of the C standards, since
">=" and "<=" are only valid when val really is a substring.
In practice, it will work on modern archs. */
/* Check whether val represents a substring of string.
* This test probably violates chapter and verse of the C standards,
* since ">=" and "<=" are only valid when val really is a substring.
* In practice, it will work on modern archs.
*/
if (val >= string->str && val <= string->str + string->len)
{
gsize offset = val - string->str;
@ -763,7 +765,8 @@ g_string_insert_len (GString *string,
#define SUB_DELIM_CHARS "!$&'()*+,;="
static gboolean
is_valid (char c, const char *reserved_chars_allowed)
is_valid (char c,
const char *reserved_chars_allowed)
{
if (g_ascii_isalnum (c) ||
c == '-' ||
@ -791,7 +794,8 @@ gunichar_ok (gunichar c)
* g_string_append_uri_escaped:
* @string: a #GString
* @unescaped: a string
* @reserved_chars_allowed: a string of reserved characters allowed to be used, or %NULL
* @reserved_chars_allowed: a string of reserved characters allowed
* to be used, or %NULL
* @allow_utf8: set %TRUE if the escaped string may include UTF8 characters
*
* Appends @unescaped to @string, escaped any characters that
@ -800,15 +804,15 @@ gunichar_ok (gunichar c)
* Returns: @string
*
* Since: 2.16
**/
*/
GString *
g_string_append_uri_escaped (GString *string,
const char *unescaped,
const char *reserved_chars_allowed,
const gchar *unescaped,
const gchar *reserved_chars_allowed,
gboolean allow_utf8)
{
unsigned char c;
const char *end;
const gchar *end;
static const gchar hex[16] = "0123456789ABCDEF";
g_return_val_if_fail (string != NULL, NULL);
@ -918,7 +922,7 @@ g_string_append_c (GString *string,
* to the string.
*
* Return value: @string
**/
*/
GString *
g_string_append_unichar (GString *string,
gunichar wc)
@ -1003,7 +1007,7 @@ g_string_prepend_c (GString *string,
* to the string.
*
* Return value: @string
**/
*/
GString *
g_string_prepend_unichar (GString *string,
gunichar wc)
@ -1031,6 +1035,7 @@ g_string_insert (GString *string,
{
g_return_val_if_fail (string != NULL, NULL);
g_return_val_if_fail (val != NULL, string);
if (pos >= 0)
g_return_val_if_fail (pos <= string->len, string);
@ -1077,15 +1082,15 @@ g_string_insert_c (GString *string,
/**
* g_string_insert_unichar:
* @string: a #GString
* @pos: the position at which to insert character, or -1 to
* append at the end of the string
* @pos: the position at which to insert character, or -1
* to append at the end of the string
* @wc: a Unicode character
*
* Converts a Unicode character into UTF-8, and insert it
* into the string at the given position.
*
* Return value: @string
**/
*/
GString *
g_string_insert_unichar (GString *string,
gssize pos,
@ -1168,7 +1173,7 @@ g_string_insert_unichar (GString *string,
* Return value: @string
*
* Since: 2.14
**/
*/
GString *
g_string_overwrite (GString *string,
gsize pos,
@ -1191,7 +1196,7 @@ g_string_overwrite (GString *string,
* Return value: @string
*
* Since: 2.14
**/
*/
GString *
g_string_overwrite_len (GString *string,
gsize pos,
@ -1271,10 +1276,10 @@ g_string_erase (GString *string,
*
* Converts all uppercase ASCII letters to lowercase ASCII letters.
*
* Return value: passed-in @string pointer, with all the upper case
* characters converted to lower case in place, with
* semantics that exactly match g_ascii_tolower().
**/
* Return value: passed-in @string pointer, with all the
* uppercase characters converted to lowercase in place,
* with semantics that exactly match g_ascii_tolower().
*/
GString *
g_string_ascii_down (GString *string)
{
@ -1302,10 +1307,10 @@ g_string_ascii_down (GString *string)
*
* Converts all lowercase ASCII letters to uppercase ASCII letters.
*
* Return value: passed-in @string pointer, with all the lower case
* characters converted to upper case in place, with
* semantics that exactly match g_ascii_toupper().
**/
* Return value: passed-in @string pointer, with all the
* lowercase characters converted to uppercase in place,
* with semantics that exactly match g_ascii_toupper().
*/
GString *
g_string_ascii_up (GString *string)
{
@ -1333,7 +1338,7 @@ g_string_ascii_up (GString *string)
*
* Converts a #GString to lowercase.
*
* Returns: the #GString.
* Returns: the #GString
*
* Deprecated:2.2: This function uses the locale-specific
* tolower() function, which is almost never the right thing.
@ -1372,7 +1377,7 @@ g_string_down (GString *string)
* Deprecated:2.2: This function uses the locale-specific
* toupper() function, which is almost never the right thing.
* Use g_string_ascii_up() or g_utf8_strup() instead.
**/
*/
GString *
g_string_up (GString *string)
{

View File

@ -146,8 +146,8 @@ void g_string_append_printf (GString *string,
const gchar *format,
...) G_GNUC_PRINTF (2, 3);
GString* g_string_append_uri_escaped (GString *string,
const char *unescaped,
const char *reserved_chars_allowed,
const gchar *unescaped,
const gchar *reserved_chars_allowed,
gboolean allow_utf8);
/* -- optimize g_strig_append_c --- */
@ -171,15 +171,9 @@ g_string_append_c_inline (GString *gstring,
#ifndef G_DISABLE_DEPRECATED
/* The following two functions are deprecated and will be removed in
* the next major release. They use the locale-specific tolower and
* toupper, which is almost never the right thing.
*/
GString* g_string_down (GString *string);
GString* g_string_up (GString *string);
/* These aliases are included for compatibility. */
#define g_string_sprintf g_string_printf
#define g_string_sprintfa g_string_append_printf