Update contrib.
     1 /* GLIB - Library of useful routines for C programming
 
     2  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
 
     3  * Portions copyright (c) 2006-2009 Nokia Corporation.  All rights reserved.
 
     5  * This library is free software; you can redistribute it and/or
 
     6  * modify it under the terms of the GNU Lesser General Public
 
     7  * License as published by the Free Software Foundation; either
 
     8  * version 2 of the License, or (at your option) any later version.
 
    10  * This library is distributed in the hope that it will be useful,
 
    11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
 
    12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 
    13  * Lesser General Public License for more details.
 
    15  * You should have received a copy of the GNU Lesser General Public
 
    16  * License along with this library; if not, write to the
 
    17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 
    18  * Boston, MA 02111-1307, USA.
 
    22  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
 
    23  * file for a list of people on the GLib Team.  See the ChangeLog
 
    24  * files for a list of changes.  These files are distributed with
 
    25  * GLib at ftp://ftp.gtk.org/pub/gtk/. 
 
    50   GHashTable *const_table;
 
    63  * @v2: a key to compare with @v1
 
    65  * Compares two strings for byte-by-byte equality and returns %TRUE 
 
    66  * if they are equal. It can be passed to g_hash_table_new() as the 
 
    67  * @key_equal_func parameter, when using strings as keys in a #GHashTable.
 
    69  * Returns: %TRUE if the two keys match
 
    72 g_str_equal (gconstpointer v1,
 
    75   const gchar *string1 = v1;
 
    76   const gchar *string2 = v2;
 
    78   return strcmp (string1, string2) == 0;
 
    85  * Converts a string to a hash value.
 
    86  * It can be passed to g_hash_table_new() as the @hash_func 
 
    87  * parameter, when using strings as keys in a #GHashTable.
 
    89  * Returns: a hash value corresponding to the key
 
    92 g_str_hash (gconstpointer v)
 
    94   /* 31 bit hash function */
 
    95   const signed char *p = v;
 
    99     for (p += 1; *p != '\0'; p++)
 
   100       h = (h << 5) - h + *p;
 
   105 #define MY_MAXSIZE ((gsize)-1)
 
   108 nearest_power (gsize base, gsize num)    
 
   110   if (num > MY_MAXSIZE / 2)
 
   129  * g_string_chunk_new:
 
   130  * @size: the default size of the blocks of memory which are 
 
   131  *        allocated to store the strings. If a particular string 
 
   132  *        is larger than this default size, a larger block of 
 
   133  *        memory will be allocated for it.
 
   135  * Creates a new #GStringChunk. 
 
   137  * Returns: a new #GStringChunk
 
   139 EXPORT_C GStringChunk*
 
   140 g_string_chunk_new (gsize size)    
 
   142   GStringChunk *new_chunk = g_new (GStringChunk, 1);
 
   143   gsize actual_size = 1;    
 
   145   actual_size = nearest_power (1, size);
 
   147   new_chunk->const_table       = NULL;
 
   148   new_chunk->storage_list      = NULL;
 
   149   new_chunk->storage_next      = actual_size;
 
   150   new_chunk->default_size      = actual_size;
 
   151   new_chunk->this_size         = actual_size;
 
   157  * g_string_chunk_free:
 
   158  * @chunk: a #GStringChunk 
 
   160  * Frees all memory allocated by the #GStringChunk.
 
   161  * After calling g_string_chunk_free() it is not safe to
 
   162  * access any of the strings which were contained within it.
 
   165 g_string_chunk_free (GStringChunk *chunk)
 
   169   g_return_if_fail (chunk != NULL);
 
   171   if (chunk->storage_list)
 
   173       for (tmp_list = chunk->storage_list; tmp_list; tmp_list = tmp_list->next)
 
   174 	g_free (tmp_list->data);
 
   176       g_slist_free (chunk->storage_list);
 
   179   if (chunk->const_table)
 
   180     g_hash_table_destroy (chunk->const_table);
 
   186  * g_string_chunk_clear:
 
   187  * @chunk: a #GStringChunk
 
   189  * Frees all strings contained within the #GStringChunk.
 
   190  * After calling g_string_chunk_clear() it is not safe to
 
   191  * access any of the strings which were contained within it.
 
   196 g_string_chunk_clear (GStringChunk *chunk)
 
   200   g_return_if_fail (chunk != NULL);
 
   202   if (chunk->storage_list)
 
   204       for (tmp_list = chunk->storage_list; tmp_list; tmp_list = tmp_list->next)
 
   205         g_free (tmp_list->data);
 
   207       g_slist_free (chunk->storage_list);
 
   209       chunk->storage_list       = NULL;
 
   210       chunk->storage_next       = chunk->default_size;
 
   211       chunk->this_size          = chunk->default_size;
 
   214   if (chunk->const_table)
 
   215       g_hash_table_remove_all (chunk->const_table);
 
   219  * g_string_chunk_insert:
 
   220  * @chunk: a #GStringChunk
 
   221  * @string: the string to add
 
   223  * Adds a copy of @string to the #GStringChunk.
 
   224  * It returns a pointer to the new copy of the string 
 
   225  * in the #GStringChunk. The characters in the string 
 
   226  * can be changed, if necessary, though you should not 
 
   227  * change anything after the end of the string.
 
   229  * Unlike g_string_chunk_insert_const(), this function 
 
   230  * does not check for duplicates. Also strings added 
 
   231  * with g_string_chunk_insert() will not be searched 
 
   232  * by g_string_chunk_insert_const() when looking for 
 
   235  * Returns: a pointer to the copy of @string within 
 
   239 g_string_chunk_insert (GStringChunk *chunk,
 
   242   g_return_val_if_fail (chunk != NULL, NULL);
 
   244   return g_string_chunk_insert_len (chunk, string, -1);
 
   248  * g_string_chunk_insert_const:
 
   249  * @chunk: a #GStringChunk
 
   250  * @string: the string to add
 
   252  * Adds a copy of @string to the #GStringChunk, unless the same
 
   253  * string has already been added to the #GStringChunk with
 
   254  * g_string_chunk_insert_const().
 
   256  * This function is useful if you need to copy a large number
 
   257  * of strings but do not want to waste space storing duplicates.
 
   258  * But you must remember that there may be several pointers to
 
   259  * the same string, and so any changes made to the strings
 
   260  * should be done very carefully.
 
   262  * Note that g_string_chunk_insert_const() will not return a
 
   263  * pointer to a string added with g_string_chunk_insert(), even
 
   266  * Returns: a pointer to the new or existing copy of @string
 
   267  *          within the #GStringChunk
 
   270 g_string_chunk_insert_const (GStringChunk *chunk,
 
   275   g_return_val_if_fail (chunk != NULL, NULL);
 
   277   if (!chunk->const_table)
 
   278     chunk->const_table = g_hash_table_new (g_str_hash, g_str_equal);
 
   280   lookup = (char*) g_hash_table_lookup (chunk->const_table, (gchar *)string);
 
   284       lookup = g_string_chunk_insert (chunk, string);
 
   285       g_hash_table_insert (chunk->const_table, lookup, lookup);
 
   292  * g_string_chunk_insert_len:
 
   293  * @chunk: a #GStringChunk
 
   294  * @string: bytes to insert
 
   295  * @len: number of bytes of @string to insert, or -1 to insert a
 
   296  *     nul-terminated string
 
   298  * Adds a copy of the first @len bytes of @string to the #GStringChunk.
 
   299  * The copy is nul-terminated.
 
   301  * Since this function does not stop at nul bytes, it is the caller's
 
   302  * responsibility to ensure that @string has at least @len addressable
 
   305  * The characters in the returned string can be changed, if necessary,
 
   306  * though you should not change anything after the end of the string.
 
   308  * Return value: a pointer to the copy of @string within the #GStringChunk
 
   313 g_string_chunk_insert_len (GStringChunk *chunk,
 
   320   g_return_val_if_fail (chunk != NULL, NULL);
 
   323     size = strlen (string);
 
   327   if ((chunk->storage_next + size + 1) > chunk->this_size)
 
   329       gsize new_size = nearest_power (chunk->default_size, size + 1);
 
   331       chunk->storage_list = g_slist_prepend (chunk->storage_list,
 
   332 					     g_new (gchar, new_size));
 
   334       chunk->this_size = new_size;
 
   335       chunk->storage_next = 0;
 
   338   pos = ((gchar *) chunk->storage_list->data) + chunk->storage_next;
 
   340   *(pos + size) = '\0';
 
   342   memcpy (pos, string, size);
 
   344   chunk->storage_next += size + 1;
 
   352 g_string_maybe_expand (GString* string,
 
   355   if (string->len + len >= string->allocated_len)
 
   357       string->allocated_len = nearest_power (1, string->len + len + 1);
 
   358       string->str = g_realloc (string->str, string->allocated_len);
 
   363  * g_string_sized_new:
 
   364  * @dfl_size: the default size of the space allocated to 
 
   367  * Creates a new #GString, with enough space for @dfl_size 
 
   368  * bytes. This is useful if you are going to add a lot of 
 
   369  * text to the string and don't want it to be reallocated 
 
   372  * Returns: the new #GString
 
   375 g_string_sized_new (gsize dfl_size)    
 
   377   GString *string = g_slice_new (GString);
 
   379   string->allocated_len = 0;
 
   383   g_string_maybe_expand (string, MAX (dfl_size, 2));
 
   391  * @init: the initial text to copy into the string
 
   393  * Creates a new #GString, initialized with the given string.
 
   395  * Returns: the new #GString
 
   398 g_string_new (const gchar *init)
 
   402   if (init == NULL || *init == '\0')
 
   403     string = g_string_sized_new (2);
 
   409       string = g_string_sized_new (len + 2);
 
   411       g_string_append_len (string, init, len);
 
   419  * @init: initial contents of the string
 
   420  * @len: length of @init to use
 
   422  * Creates a new #GString with @len bytes of the @init buffer.  
 
   423  * Because a length is provided, @init need not be nul-terminated,
 
   424  * and can contain embedded nul bytes.
 
   426  * Since this function does not stop at nul bytes, it is the caller's
 
   427  * responsibility to ensure that @init has at least @len addressable 
 
   430  * Returns: a new #GString
 
   433 g_string_new_len (const gchar *init,
 
   439     return g_string_new (init);
 
   442       string = g_string_sized_new (len);
 
   445         g_string_append_len (string, init, len);
 
   453  * @string: a #GString
 
   454  * @free_segment: if %TRUE the actual character data is freed as well
 
   456  * Frees the memory allocated for the #GString.
 
   457  * If @free_segment is %TRUE it also frees the character data.
 
   459  * Returns: the character data of @string 
 
   460  *          (i.e. %NULL if @free_segment is %TRUE)
 
   463 g_string_free (GString *string,
 
   464 	       gboolean free_segment)
 
   468   g_return_val_if_fail (string != NULL, NULL);
 
   472       g_free (string->str);
 
   476     segment = string->str;
 
   478   g_slice_free (GString, string);
 
   486  * @v2: another #GString
 
   488  * Compares two strings for equality, returning %TRUE if they are equal. 
 
   489  * For use with #GHashTable.
 
   491  * Returns: %TRUE if they strings are the same length and contain the 
 
   495 g_string_equal (const GString *v,
 
   499   GString *string1 = (GString *) v;
 
   500   GString *string2 = (GString *) v2;
 
   501   gsize i = string1->len;    
 
   503   if (i != string2->len)
 
   521  * @str: a string to hash
 
   523  * Creates a hash code for @str; for use with #GHashTable.
 
   525  * Returns: hash code for @str
 
   527 /* 31 bit hash function */
 
   529 g_string_hash (const GString *str)
 
   531   const gchar *p = str->str;
 
   537       h = (h << 5) - h + *p;
 
   546  * @string: the destination #GString. Its current contents 
 
   548  * @rval: the string to copy into @string
 
   550  * Copies the bytes from a string into a #GString, 
 
   551  * destroying any previous contents. It is rather like 
 
   552  * the standard strcpy() function, except that you do not 
 
   553  * have to worry about having enough space to copy the string.
 
   558 g_string_assign (GString     *string,
 
   561   g_return_val_if_fail (string != NULL, NULL);
 
   562   g_return_val_if_fail (rval != NULL, string);
 
   564   /* Make sure assigning to itself doesn't corrupt the string.  */
 
   565   if (string->str != rval)
 
   567       /* Assigning from substring should be ok since g_string_truncate
 
   569       g_string_truncate (string, 0);
 
   570       g_string_append (string, rval);
 
   578  * @string: a #GString
 
   579  * @len: the new size of @string
 
   581  * Cuts off the end of the GString, leaving the first @len bytes. 
 
   586 g_string_truncate (GString *string,
 
   589   g_return_val_if_fail (string != NULL, NULL);
 
   591   string->len = MIN (len, string->len);
 
   592   string->str[string->len] = 0;
 
   599  * @string: a #GString
 
   600  * @len: the new length
 
   602  * Sets the length of a #GString. If the length is less than
 
   603  * the current length, the string will be truncated. If the
 
   604  * length is greater than the current length, the contents
 
   605  * of the newly added area are undefined. (However, as
 
   606  * always, string->str[string->len] will be a nul byte.) 
 
   608  * Return value: @string
 
   611 g_string_set_size (GString *string,
 
   614   g_return_val_if_fail (string != NULL, NULL);
 
   616   if (len >= string->allocated_len)
 
   617     g_string_maybe_expand (string, len - string->len);
 
   620   string->str[len] = 0;
 
   626  * g_string_insert_len:
 
   627  * @string: a #GString
 
   628  * @pos: position in @string where insertion should 
 
   629  *       happen, or -1 for at the end
 
   630  * @val: bytes to insert
 
   631  * @len: number of bytes of @val to insert
 
   633  * Inserts @len bytes of @val into @string at @pos.  
 
   634  * Because @len is provided, @val may contain embedded 
 
   635  * nuls and need not be nul-terminated. If @pos is -1, 
 
   636  * bytes are inserted at the end of the string.
 
   638  * Since this function does not stop at nul bytes, it is 
 
   639  * the caller's responsibility to ensure that @val has at 
 
   640  * least @len addressable bytes.
 
   645 g_string_insert_len (GString     *string,
 
   650   g_return_val_if_fail (string != NULL, NULL);
 
   651   g_return_val_if_fail (val != NULL, string);
 
   659     g_return_val_if_fail (pos <= string->len, string);
 
   661   /* Check whether val represents a substring of string.  This test
 
   662      probably violates chapter and verse of the C standards, since
 
   663      ">=" and "<=" are only valid when val really is a substring.
 
   664      In practice, it will work on modern archs.  */
 
   665   if (val >= string->str && val <= string->str + string->len)
 
   667       gsize offset = val - string->str;
 
   670       g_string_maybe_expand (string, len);
 
   671       val = string->str + offset;
 
   672       /* At this point, val is valid again.  */
 
   674       /* Open up space where we are going to insert.  */
 
   675       if (pos < string->len)
 
   676 	g_memmove (string->str + pos + len, string->str + pos, string->len - pos);
 
   678       /* Move the source part before the gap, if any.  */
 
   681 	  precount = MIN (len, pos - offset);
 
   682 	  memcpy (string->str + pos, val, precount);
 
   685       /* Move the source part after the gap, if any.  */
 
   687 	memcpy (string->str + pos + precount,
 
   688 		val + /* Already moved: */ precount + /* Space opened up: */ len,
 
   693       g_string_maybe_expand (string, len);
 
   695       /* If we aren't appending at the end, move a hunk
 
   696        * of the old string to the end, opening up space
 
   698       if (pos < string->len)
 
   699 	g_memmove (string->str + pos + len, string->str + pos, string->len - pos);
 
   701       /* insert the new string */
 
   703         string->str[pos] = *val;
 
   705         memcpy (string->str + pos, val, len);
 
   710   string->str[string->len] = 0;
 
   715 #define SUB_DELIM_CHARS  "!$&'()*+,;="
 
   718 is_valid (char c, const char *reserved_chars_allowed)
 
   720   if (g_ascii_isalnum (c) ||
 
   727   if (reserved_chars_allowed &&
 
   728       strchr (reserved_chars_allowed, c) != NULL)
 
   735 gunichar_ok (gunichar c)
 
   738     (c != (gunichar) -2) &&
 
   739     (c != (gunichar) -1);
 
   743  * g_string_append_uri_escaped:
 
   744  * @string: a #GString
 
   745  * @unescaped: a string
 
   746  * @reserved_chars_allowed: a string of reserved characters allowed to be used
 
   747  * @allow_utf8: set %TRUE if the escaped string may include UTF8 characters
 
   749  * Appends @unescaped to @string, escaped any characters that
 
   750  * are reserved in URIs using URI-style escape sequences.
 
   757 g_string_append_uri_escaped (GString *string,
 
   758 			     const char *unescaped,
 
   759 			     const char *reserved_chars_allowed,
 
   764   static const gchar hex[16] = "0123456789ABCDEF";
 
   766   g_return_val_if_fail (string != NULL, NULL);
 
   767   g_return_val_if_fail (unescaped != NULL, NULL);
 
   769   end = unescaped + strlen (unescaped);
 
   771   while ((c = *unescaped) != 0)
 
   773       if (c >= 0x80 && allow_utf8 &&
 
   774 	  gunichar_ok (g_utf8_get_char_validated (unescaped, end - unescaped)))
 
   776 	  int len = g_utf8_skip [c];
 
   777 	  g_string_append_len (string, unescaped, len);
 
   780       else if (is_valid (c, reserved_chars_allowed))
 
   782 	  g_string_append_c (string, c);
 
   787 	  g_string_append_c (string, '%');
 
   788 	  g_string_append_c (string, hex[((guchar)c) >> 4]);
 
   789 	  g_string_append_c (string, hex[((guchar)c) & 0xf]);
 
   799  * @string: a #GString
 
   800  * @val: the string to append onto the end of @string
 
   802  * Adds a string onto the end of a #GString, expanding 
 
   808 g_string_append (GString     *string,
 
   811   g_return_val_if_fail (string != NULL, NULL);
 
   812   g_return_val_if_fail (val != NULL, string);
 
   814   return g_string_insert_len (string, -1, val, -1);
 
   818  * g_string_append_len:
 
   819  * @string: a #GString
 
   820  * @val: bytes to append
 
   821  * @len: number of bytes of @val to use
 
   823  * Appends @len bytes of @val to @string. Because @len is 
 
   824  * provided, @val may contain embedded nuls and need not 
 
   827  * Since this function does not stop at nul bytes, it is 
 
   828  * the caller's responsibility to ensure that @val has at 
 
   829  * least @len addressable bytes.
 
   834 g_string_append_len (GString	 *string,
 
   838   g_return_val_if_fail (string != NULL, NULL);
 
   839   g_return_val_if_fail (val != NULL, string);
 
   841   return g_string_insert_len (string, -1, val, len);
 
   846  * @string: a #GString
 
   847  * @c: the byte to append onto the end of @string
 
   849  * Adds a byte onto the end of a #GString, expanding 
 
   854 #undef g_string_append_c
 
   856 g_string_append_c (GString *string,
 
   859   g_return_val_if_fail (string != NULL, NULL);
 
   861   return g_string_insert_c (string, -1, c);
 
   865  * g_string_append_unichar:
 
   866  * @string: a #GString
 
   867  * @wc: a Unicode character
 
   869  * Converts a Unicode character into UTF-8, and appends it
 
   872  * Return value: @string
 
   875 g_string_append_unichar (GString  *string,
 
   878   g_return_val_if_fail (string != NULL, NULL);
 
   880   return g_string_insert_unichar (string, -1, wc);
 
   885  * @string: a #GString
 
   886  * @val: the string to prepend on the start of @string
 
   888  * Adds a string on to the start of a #GString, 
 
   889  * expanding it if necessary.
 
   894 g_string_prepend (GString     *string,
 
   897   g_return_val_if_fail (string != NULL, NULL);
 
   898   g_return_val_if_fail (val != NULL, string);
 
   900   return g_string_insert_len (string, 0, val, -1);
 
   904  * g_string_prepend_len:
 
   905  * @string: a #GString
 
   906  * @val: bytes to prepend
 
   907  * @len: number of bytes in @val to prepend
 
   909  * Prepends @len bytes of @val to @string. 
 
   910  * Because @len is provided, @val may contain 
 
   911  * embedded nuls and need not be nul-terminated.
 
   913  * Since this function does not stop at nul bytes, 
 
   914  * it is the caller's responsibility to ensure that 
 
   915  * @val has at least @len addressable bytes.
 
   920 g_string_prepend_len (GString	  *string,
 
   924   g_return_val_if_fail (string != NULL, NULL);
 
   925   g_return_val_if_fail (val != NULL, string);
 
   927   return g_string_insert_len (string, 0, val, len);
 
   931  * g_string_prepend_c:
 
   932  * @string: a #GString
 
   933  * @c: the byte to prepend on the start of the #GString
 
   935  * Adds a byte onto the start of a #GString, 
 
   936  * expanding it if necessary.
 
   941 g_string_prepend_c (GString *string,
 
   944   g_return_val_if_fail (string != NULL, NULL);
 
   946   return g_string_insert_c (string, 0, c);
 
   950  * g_string_prepend_unichar:
 
   951  * @string: a #GString
 
   952  * @wc: a Unicode character
 
   954  * Converts a Unicode character into UTF-8, and prepends it
 
   957  * Return value: @string
 
   960 g_string_prepend_unichar (GString  *string,
 
   963   g_return_val_if_fail (string != NULL, NULL);
 
   965   return g_string_insert_unichar (string, 0, wc);
 
   970  * @string: a #GString
 
   971  * @pos: the position to insert the copy of the string
 
   972  * @val: the string to insert
 
   974  * Inserts a copy of a string into a #GString, 
 
   975  * expanding it if necessary.
 
   980 g_string_insert (GString     *string,
 
   984   g_return_val_if_fail (string != NULL, NULL);
 
   985   g_return_val_if_fail (val != NULL, string);
 
   987     g_return_val_if_fail (pos <= string->len, string);
 
   989   return g_string_insert_len (string, pos, val, -1);
 
   994  * @string: a #GString
 
   995  * @pos: the position to insert the byte
 
   996  * @c: the byte to insert
 
   998  * Inserts a byte into a #GString, expanding it if necessary.
 
  1003 g_string_insert_c (GString *string,
 
  1007   g_return_val_if_fail (string != NULL, NULL);
 
  1009   g_string_maybe_expand (string, 1);
 
  1014     g_return_val_if_fail (pos <= string->len, string);
 
  1016   /* If not just an append, move the old stuff */
 
  1017   if (pos < string->len)
 
  1018     g_memmove (string->str + pos + 1, string->str + pos, string->len - pos);
 
  1020   string->str[pos] = c;
 
  1024   string->str[string->len] = 0;
 
  1030  * g_string_insert_unichar:
 
  1031  * @string: a #GString
 
  1032  * @pos: the position at which to insert character, or -1 to
 
  1033  *       append at the end of the string
 
  1034  * @wc: a Unicode character
 
  1036  * Converts a Unicode character into UTF-8, and insert it
 
  1037  * into the string at the given position.
 
  1039  * Return value: @string
 
  1042 g_string_insert_unichar (GString *string,
 
  1046   gint charlen, first, i;
 
  1049   g_return_val_if_fail (string != NULL, NULL);
 
  1051   /* Code copied from g_unichar_to_utf() */
 
  1057   else if (wc < 0x800)
 
  1062   else if (wc < 0x10000)
 
  1067    else if (wc < 0x200000)
 
  1072   else if (wc < 0x4000000)
 
  1082   /* End of copied code */
 
  1084   g_string_maybe_expand (string, charlen);
 
  1089     g_return_val_if_fail (pos <= string->len, string);
 
  1091   /* If not just an append, move the old stuff */
 
  1092   if (pos < string->len)
 
  1093     g_memmove (string->str + pos + charlen, string->str + pos, string->len - pos);
 
  1095   dest = string->str + pos;
 
  1096   /* Code copied from g_unichar_to_utf() */
 
  1097   for (i = charlen - 1; i > 0; --i)
 
  1099       dest[i] = (wc & 0x3f) | 0x80;
 
  1102   dest[0] = wc | first;
 
  1103   /* End of copied code */
 
  1105   string->len += charlen;
 
  1107   string->str[string->len] = 0;
 
  1113  * g_string_overwrite:
 
  1114  * @string: a #GString
 
  1115  * @pos: the position at which to start overwriting
 
  1116  * @val: the string that will overwrite the @string starting at @pos
 
  1118  * Overwrites part of a string, lengthening it if necessary.
 
  1120  * Return value: @string
 
  1125 g_string_overwrite (GString     *string,
 
  1129   g_return_val_if_fail (val != NULL, string);
 
  1130   return g_string_overwrite_len (string, pos, val, strlen (val));
 
  1134  * g_string_overwrite_len:
 
  1135  * @string: a #GString
 
  1136  * @pos: the position at which to start overwriting
 
  1137  * @val: the string that will overwrite the @string starting at @pos
 
  1138  * @len: the number of bytes to write from @val
 
  1140  * Overwrites part of a string, lengthening it if necessary. 
 
  1141  * This function will work with embedded nuls.
 
  1143  * Return value: @string
 
  1148 g_string_overwrite_len (GString     *string,
 
  1155   g_return_val_if_fail (string != NULL, NULL);
 
  1160   g_return_val_if_fail (val != NULL, string);
 
  1161   g_return_val_if_fail (pos <= string->len, string);
 
  1168   if (end > string->len)
 
  1169     g_string_maybe_expand (string, end - string->len);
 
  1171   memcpy (string->str + pos, val, len);
 
  1173   if (end > string->len)
 
  1175       string->str[end] = '\0';
 
  1184  * @string: a #GString
 
  1185  * @pos: the position of the content to remove
 
  1186  * @len: the number of bytes to remove, or -1 to remove all
 
  1189  * Removes @len bytes from a #GString, starting at position @pos.
 
  1190  * The rest of the #GString is shifted down to fill the gap.
 
  1195 g_string_erase (GString *string,
 
  1199   g_return_val_if_fail (string != NULL, NULL);
 
  1200   g_return_val_if_fail (pos >= 0, string);
 
  1201   g_return_val_if_fail (pos <= string->len, string);
 
  1204     len = string->len - pos;
 
  1207       g_return_val_if_fail (pos + len <= string->len, string);
 
  1209       if (pos + len < string->len)
 
  1210 	g_memmove (string->str + pos, string->str + pos + len, string->len - (pos + len));
 
  1215   string->str[string->len] = 0;
 
  1221  * g_string_ascii_down:
 
  1222  * @string: a GString
 
  1224  * Converts all upper case ASCII letters to lower case ASCII letters.
 
  1226  * Return value: passed-in @string pointer, with all the upper case
 
  1227  *               characters converted to lower case in place, with
 
  1228  *               semantics that exactly match g_ascii_tolower().
 
  1231 g_string_ascii_down (GString *string)
 
  1236   g_return_val_if_fail (string != NULL, NULL);
 
  1243       *s = g_ascii_tolower (*s);
 
  1252  * g_string_ascii_up:
 
  1253  * @string: a GString
 
  1255  * Converts all lower case ASCII letters to upper case ASCII letters.
 
  1257  * Return value: passed-in @string pointer, with all the lower case
 
  1258  *               characters converted to upper case in place, with
 
  1259  *               semantics that exactly match g_ascii_toupper().
 
  1262 g_string_ascii_up (GString *string)
 
  1267   g_return_val_if_fail (string != NULL, NULL);
 
  1274       *s = g_ascii_toupper (*s);
 
  1284  * @string: a #GString
 
  1286  * Converts a #GString to lowercase.
 
  1288  * Returns: the #GString.
 
  1290  * Deprecated:2.2: This function uses the locale-specific 
 
  1291  *   tolower() function, which is almost never the right thing. 
 
  1292  *   Use g_string_ascii_down() or g_utf8_strdown() instead.
 
  1295 g_string_down (GString *string)
 
  1300   g_return_val_if_fail (string != NULL, NULL);
 
  1303   s = (guchar *) string->str;
 
  1318  * @string: a #GString 
 
  1320  * Converts a #GString to uppercase.
 
  1322  * Return value: @string
 
  1324  * Deprecated:2.2: This function uses the locale-specific 
 
  1325  *   toupper() function, which is almost never the right thing. 
 
  1326  *   Use g_string_ascii_up() or g_utf8_strup() instead.
 
  1329 g_string_up (GString *string)
 
  1334   g_return_val_if_fail (string != NULL, NULL);
 
  1337   s = (guchar *) string->str;
 
  1351  * g_string_append_vprintf:
 
  1352  * @string: a #GString
 
  1353  * @format: the string format. See the printf() documentation
 
  1354  * @args: the list of arguments to insert in the output
 
  1356  * Appends a formatted string onto the end of a #GString.
 
  1357  * This function is similar to g_string_append_printf()
 
  1358  * except that the arguments to the format string are passed
 
  1364 g_string_append_vprintf (GString     *string,
 
  1365 			 const gchar *format,
 
  1371   g_return_if_fail (string != NULL);
 
  1372   g_return_if_fail (format != NULL);
 
  1374   len = g_vasprintf (&buf, format, args);
 
  1378       g_string_maybe_expand (string, len);
 
  1379       memcpy (string->str + string->len, buf, len + 1);
 
  1387  * @string: a #GString
 
  1388  * @format: the string format. See the printf() documentation
 
  1389  * @args: the parameters to insert into the format string
 
  1391  * Writes a formatted string into a #GString. 
 
  1392  * This function is similar to g_string_printf() except that 
 
  1393  * the arguments to the format string are passed as a va_list.
 
  1398 g_string_vprintf (GString     *string,
 
  1399 		  const gchar *format,
 
  1402   g_string_truncate (string, 0);
 
  1403   g_string_append_vprintf (string, format, args);
 
  1408  * @string: a #GString
 
  1409  * @format: the string format. See the sprintf() documentation
 
  1410  * @Varargs: the parameters to insert into the format string
 
  1412  * Writes a formatted string into a #GString.
 
  1413  * This is similar to the standard sprintf() function,
 
  1414  * except that the #GString buffer automatically expands 
 
  1415  * to contain the results. The previous contents of the 
 
  1416  * #GString are destroyed. 
 
  1418  * Deprecated: This function has been renamed to g_string_printf().
 
  1423  * @string: a #GString
 
  1424  * @format: the string format. See the printf() documentation
 
  1425  * @Varargs: the parameters to insert into the format string
 
  1427  * Writes a formatted string into a #GString.
 
  1428  * This is similar to the standard sprintf() function,
 
  1429  * except that the #GString buffer automatically expands 
 
  1430  * to contain the results. The previous contents of the 
 
  1431  * #GString are destroyed.
 
  1434 g_string_printf (GString     *string,
 
  1435 		 const gchar *format,
 
  1440   g_string_truncate (string, 0);
 
  1442   va_start (args, format);
 
  1443   g_string_append_vprintf (string, format, args);
 
  1448  * g_string_sprintfa:
 
  1449  * @string: a #GString
 
  1450  * @format: the string format. See the sprintf() documentation
 
  1451  * @Varargs: the parameters to insert into the format string
 
  1453  * Appends a formatted string onto the end of a #GString.
 
  1454  * This function is similar to g_string_sprintf() except that
 
  1455  * the text is appended to the #GString. 
 
  1457  * Deprecated: This function has been renamed to g_string_append_printf()
 
  1461  * g_string_append_printf:
 
  1462  * @string: a #GString
 
  1463  * @format: the string format. See the printf() documentation
 
  1464  * @Varargs: the parameters to insert into the format string
 
  1466  * Appends a formatted string onto the end of a #GString.
 
  1467  * This function is similar to g_string_printf() except 
 
  1468  * that the text is appended to the #GString.
 
  1471 g_string_append_printf (GString     *string,
 
  1472 			const gchar *format,
 
  1477   va_start (args, format);
 
  1478   g_string_append_vprintf (string, format, args);
 
  1482 #define __G_STRING_C__
 
  1483 #include "galiasdef.c"