1 /* GLIB - Library of useful routines for C programming
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GLib Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GLib Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GLib at ftp://ftp.gtk.org/pub/gtk/.
48 * SECTION: string_chunks
49 * @title: String Chunks
50 * @short_description: efficient storage of groups of strings
52 * String chunks are used to store groups of strings. Memory is
53 * allocated in blocks, and as strings are added to the #GStringChunk
54 * they are copied into the next free position in a block. When a block
55 * is full a new block is allocated.
57 * When storing a large number of strings, string chunks are more
58 * efficient than using g_strdup() since fewer calls to malloc() are
59 * needed, and less memory is wasted in memory allocation overheads.
61 * By adding strings with g_string_chunk_insert_const() it is also
62 * possible to remove duplicates.
64 * To create a new #GStringChunk use g_string_chunk_new().
66 * To add strings to a #GStringChunk use g_string_chunk_insert().
68 * To add strings to a #GStringChunk, but without duplicating strings
69 * which are already in the #GStringChunk, use
70 * g_string_chunk_insert_const().
72 * To free the entire #GStringChunk use g_string_chunk_free(). It is
73 * not possible to free individual strings.
79 * An opaque data structure representing String Chunks. It should only
80 * be accessed by using the following functions.
84 GHashTable
*const_table
;
97 * @v2: a key to compare with @v1
99 * Compares two strings for byte-by-byte equality and returns %TRUE
100 * if they are equal. It can be passed to g_hash_table_new() as the
101 * @key_equal_func parameter, when using strings as keys in a #GHashTable.
103 * Note that this function is primarily meant as a hash table comparison
104 * function. For a general-purpose, %NULL-safe string comparison function,
107 * Returns: %TRUE if the two keys match
110 g_str_equal (gconstpointer v1
,
113 const gchar
*string1
= v1
;
114 const gchar
*string2
= v2
;
116 return strcmp (string1
, string2
) == 0;
123 * Converts a string to a hash value.
125 * This function implements the widely used "djb" hash apparently posted
126 * by Daniel Bernstein to comp.lang.c some time ago. The 32 bit
127 * unsigned hash value starts at 5381 and for each byte 'c' in the
128 * string, is updated: <literal>hash = hash * 33 + c</literal>. This
129 * function uses the signed value of each byte.
131 * It can be passed to g_hash_table_new() as the @hash_func parameter,
132 * when using strings as keys in a #GHashTable.
134 * Returns: a hash value corresponding to the key
137 g_str_hash (gconstpointer v
)
139 const signed char *p
;
142 for (p
= v
; *p
!= '\0'; p
++)
143 h
= (h
<< 5) + h
+ *p
;
148 #define MY_MAXSIZE ((gsize)-1)
151 nearest_power (gsize base
, gsize num
)
153 if (num
> MY_MAXSIZE
/ 2)
172 * g_string_chunk_new:
173 * @size: the default size of the blocks of memory which are
174 * allocated to store the strings. If a particular string
175 * is larger than this default size, a larger block of
176 * memory will be allocated for it.
178 * Creates a new #GStringChunk.
180 * Returns: a new #GStringChunk
183 g_string_chunk_new (gsize size
)
185 GStringChunk
*new_chunk
= g_new (GStringChunk
, 1);
186 gsize actual_size
= 1;
188 actual_size
= nearest_power (1, size
);
190 new_chunk
->const_table
= NULL
;
191 new_chunk
->storage_list
= NULL
;
192 new_chunk
->storage_next
= actual_size
;
193 new_chunk
->default_size
= actual_size
;
194 new_chunk
->this_size
= actual_size
;
200 * g_string_chunk_free:
201 * @chunk: a #GStringChunk
203 * Frees all memory allocated by the #GStringChunk.
204 * After calling g_string_chunk_free() it is not safe to
205 * access any of the strings which were contained within it.
208 g_string_chunk_free (GStringChunk
*chunk
)
212 g_return_if_fail (chunk
!= NULL
);
214 if (chunk
->storage_list
)
216 for (tmp_list
= chunk
->storage_list
; tmp_list
; tmp_list
= tmp_list
->next
)
217 g_free (tmp_list
->data
);
219 g_slist_free (chunk
->storage_list
);
222 if (chunk
->const_table
)
223 g_hash_table_destroy (chunk
->const_table
);
229 * g_string_chunk_clear:
230 * @chunk: a #GStringChunk
232 * Frees all strings contained within the #GStringChunk.
233 * After calling g_string_chunk_clear() it is not safe to
234 * access any of the strings which were contained within it.
239 g_string_chunk_clear (GStringChunk
*chunk
)
243 g_return_if_fail (chunk
!= NULL
);
245 if (chunk
->storage_list
)
247 for (tmp_list
= chunk
->storage_list
; tmp_list
; tmp_list
= tmp_list
->next
)
248 g_free (tmp_list
->data
);
250 g_slist_free (chunk
->storage_list
);
252 chunk
->storage_list
= NULL
;
253 chunk
->storage_next
= chunk
->default_size
;
254 chunk
->this_size
= chunk
->default_size
;
257 if (chunk
->const_table
)
258 g_hash_table_remove_all (chunk
->const_table
);
262 * g_string_chunk_insert:
263 * @chunk: a #GStringChunk
264 * @string: the string to add
266 * Adds a copy of @string to the #GStringChunk.
267 * It returns a pointer to the new copy of the string
268 * in the #GStringChunk. The characters in the string
269 * can be changed, if necessary, though you should not
270 * change anything after the end of the string.
272 * Unlike g_string_chunk_insert_const(), this function
273 * does not check for duplicates. Also strings added
274 * with g_string_chunk_insert() will not be searched
275 * by g_string_chunk_insert_const() when looking for
278 * Returns: a pointer to the copy of @string within
282 g_string_chunk_insert (GStringChunk
*chunk
,
285 g_return_val_if_fail (chunk
!= NULL
, NULL
);
287 return g_string_chunk_insert_len (chunk
, string
, -1);
291 * g_string_chunk_insert_const:
292 * @chunk: a #GStringChunk
293 * @string: the string to add
295 * Adds a copy of @string to the #GStringChunk, unless the same
296 * string has already been added to the #GStringChunk with
297 * g_string_chunk_insert_const().
299 * This function is useful if you need to copy a large number
300 * of strings but do not want to waste space storing duplicates.
301 * But you must remember that there may be several pointers to
302 * the same string, and so any changes made to the strings
303 * should be done very carefully.
305 * Note that g_string_chunk_insert_const() will not return a
306 * pointer to a string added with g_string_chunk_insert(), even
309 * Returns: a pointer to the new or existing copy of @string
310 * within the #GStringChunk
313 g_string_chunk_insert_const (GStringChunk
*chunk
,
318 g_return_val_if_fail (chunk
!= NULL
, NULL
);
320 if (!chunk
->const_table
)
321 chunk
->const_table
= g_hash_table_new (g_str_hash
, g_str_equal
);
323 lookup
= (char*) g_hash_table_lookup (chunk
->const_table
, (gchar
*)string
);
327 lookup
= g_string_chunk_insert (chunk
, string
);
328 g_hash_table_insert (chunk
->const_table
, lookup
, lookup
);
335 * g_string_chunk_insert_len:
336 * @chunk: a #GStringChunk
337 * @string: bytes to insert
338 * @len: number of bytes of @string to insert, or -1 to insert a
339 * nul-terminated string
341 * Adds a copy of the first @len bytes of @string to the #GStringChunk.
342 * The copy is nul-terminated.
344 * Since this function does not stop at nul bytes, it is the caller's
345 * responsibility to ensure that @string has at least @len addressable
348 * The characters in the returned string can be changed, if necessary,
349 * though you should not change anything after the end of the string.
351 * Return value: a pointer to the copy of @string within the #GStringChunk
356 g_string_chunk_insert_len (GStringChunk
*chunk
,
363 g_return_val_if_fail (chunk
!= NULL
, NULL
);
366 size
= strlen (string
);
370 if ((chunk
->storage_next
+ size
+ 1) > chunk
->this_size
)
372 gsize new_size
= nearest_power (chunk
->default_size
, size
+ 1);
374 chunk
->storage_list
= g_slist_prepend (chunk
->storage_list
,
375 g_new (gchar
, new_size
));
377 chunk
->this_size
= new_size
;
378 chunk
->storage_next
= 0;
381 pos
= ((gchar
*) chunk
->storage_list
->data
) + chunk
->storage_next
;
383 *(pos
+ size
) = '\0';
385 memcpy (pos
, string
, size
);
387 chunk
->storage_next
+= size
+ 1;
395 g_string_maybe_expand (GString
* string
,
398 if (string
->len
+ len
>= string
->allocated_len
)
400 string
->allocated_len
= nearest_power (1, string
->len
+ len
+ 1);
401 string
->str
= g_realloc (string
->str
, string
->allocated_len
);
406 * g_string_sized_new:
407 * @dfl_size: the default size of the space allocated to
410 * Creates a new #GString, with enough space for @dfl_size
411 * bytes. This is useful if you are going to add a lot of
412 * text to the string and don't want it to be reallocated
415 * Returns: the new #GString
418 g_string_sized_new (gsize dfl_size
)
420 GString
*string
= g_slice_new (GString
);
422 string
->allocated_len
= 0;
426 g_string_maybe_expand (string
, MAX (dfl_size
, 2));
434 * @init: the initial text to copy into the string
436 * Creates a new #GString, initialized with the given string.
438 * Returns: the new #GString
441 g_string_new (const gchar
*init
)
445 if (init
== NULL
|| *init
== '\0')
446 string
= g_string_sized_new (2);
452 string
= g_string_sized_new (len
+ 2);
454 g_string_append_len (string
, init
, len
);
462 * @init: initial contents of the string
463 * @len: length of @init to use
465 * Creates a new #GString with @len bytes of the @init buffer.
466 * Because a length is provided, @init need not be nul-terminated,
467 * and can contain embedded nul bytes.
469 * Since this function does not stop at nul bytes, it is the caller's
470 * responsibility to ensure that @init has at least @len addressable
473 * Returns: a new #GString
476 g_string_new_len (const gchar
*init
,
482 return g_string_new (init
);
485 string
= g_string_sized_new (len
);
488 g_string_append_len (string
, init
, len
);
496 * @string: a #GString
497 * @free_segment: if %TRUE the actual character data is freed as well
499 * Frees the memory allocated for the #GString.
500 * If @free_segment is %TRUE it also frees the character data.
502 * Returns: the character data of @string
503 * (i.e. %NULL if @free_segment is %TRUE)
506 g_string_free (GString
*string
,
507 gboolean free_segment
)
511 g_return_val_if_fail (string
!= NULL
, NULL
);
515 g_free (string
->str
);
519 segment
= string
->str
;
521 g_slice_free (GString
, string
);
529 * @v2: another #GString
531 * Compares two strings for equality, returning %TRUE if they are equal.
532 * For use with #GHashTable.
534 * Returns: %TRUE if they strings are the same length and contain the
538 g_string_equal (const GString
*v
,
542 GString
*string1
= (GString
*) v
;
543 GString
*string2
= (GString
*) v2
;
544 gsize i
= string1
->len
;
546 if (i
!= string2
->len
)
564 * @str: a string to hash
566 * Creates a hash code for @str; for use with #GHashTable.
568 * Returns: hash code for @str
570 /* 31 bit hash function */
572 g_string_hash (const GString
*str
)
574 const gchar
*p
= str
->str
;
580 h
= (h
<< 5) - h
+ *p
;
589 * @string: the destination #GString. Its current contents
591 * @rval: the string to copy into @string
593 * Copies the bytes from a string into a #GString,
594 * destroying any previous contents. It is rather like
595 * the standard strcpy() function, except that you do not
596 * have to worry about having enough space to copy the string.
601 g_string_assign (GString
*string
,
604 g_return_val_if_fail (string
!= NULL
, NULL
);
605 g_return_val_if_fail (rval
!= NULL
, string
);
607 /* Make sure assigning to itself doesn't corrupt the string. */
608 if (string
->str
!= rval
)
610 /* Assigning from substring should be ok since g_string_truncate
612 g_string_truncate (string
, 0);
613 g_string_append (string
, rval
);
621 * @string: a #GString
622 * @len: the new size of @string
624 * Cuts off the end of the GString, leaving the first @len bytes.
629 g_string_truncate (GString
*string
,
632 g_return_val_if_fail (string
!= NULL
, NULL
);
634 string
->len
= MIN (len
, string
->len
);
635 string
->str
[string
->len
] = 0;
642 * @string: a #GString
643 * @len: the new length
645 * Sets the length of a #GString. If the length is less than
646 * the current length, the string will be truncated. If the
647 * length is greater than the current length, the contents
648 * of the newly added area are undefined. (However, as
649 * always, string->str[string->len] will be a nul byte.)
651 * Return value: @string
654 g_string_set_size (GString
*string
,
657 g_return_val_if_fail (string
!= NULL
, NULL
);
659 if (len
>= string
->allocated_len
)
660 g_string_maybe_expand (string
, len
- string
->len
);
663 string
->str
[len
] = 0;
669 * g_string_insert_len:
670 * @string: a #GString
671 * @pos: position in @string where insertion should
672 * happen, or -1 for at the end
673 * @val: bytes to insert
674 * @len: number of bytes of @val to insert
676 * Inserts @len bytes of @val into @string at @pos.
677 * Because @len is provided, @val may contain embedded
678 * nuls and need not be nul-terminated. If @pos is -1,
679 * bytes are inserted at the end of the string.
681 * Since this function does not stop at nul bytes, it is
682 * the caller's responsibility to ensure that @val has at
683 * least @len addressable bytes.
688 g_string_insert_len (GString
*string
,
693 g_return_val_if_fail (string
!= NULL
, NULL
);
694 g_return_val_if_fail (len
== 0 || val
!= NULL
, string
);
705 g_return_val_if_fail (pos
<= string
->len
, string
);
707 /* Check whether val represents a substring of string. This test
708 probably violates chapter and verse of the C standards, since
709 ">=" and "<=" are only valid when val really is a substring.
710 In practice, it will work on modern archs. */
711 if (val
>= string
->str
&& val
<= string
->str
+ string
->len
)
713 gsize offset
= val
- string
->str
;
716 g_string_maybe_expand (string
, len
);
717 val
= string
->str
+ offset
;
718 /* At this point, val is valid again. */
720 /* Open up space where we are going to insert. */
721 if (pos
< string
->len
)
722 g_memmove (string
->str
+ pos
+ len
, string
->str
+ pos
, string
->len
- pos
);
724 /* Move the source part before the gap, if any. */
727 precount
= MIN (len
, pos
- offset
);
728 memcpy (string
->str
+ pos
, val
, precount
);
731 /* Move the source part after the gap, if any. */
733 memcpy (string
->str
+ pos
+ precount
,
734 val
+ /* Already moved: */ precount
+ /* Space opened up: */ len
,
739 g_string_maybe_expand (string
, len
);
741 /* If we aren't appending at the end, move a hunk
742 * of the old string to the end, opening up space
744 if (pos
< string
->len
)
745 g_memmove (string
->str
+ pos
+ len
, string
->str
+ pos
, string
->len
- pos
);
747 /* insert the new string */
749 string
->str
[pos
] = *val
;
751 memcpy (string
->str
+ pos
, val
, len
);
756 string
->str
[string
->len
] = 0;
761 #define SUB_DELIM_CHARS "!$&'()*+,;="
764 is_valid (char c
, const char *reserved_chars_allowed
)
766 if (g_ascii_isalnum (c
) ||
773 if (reserved_chars_allowed
&&
774 strchr (reserved_chars_allowed
, c
) != NULL
)
781 gunichar_ok (gunichar c
)
784 (c
!= (gunichar
) -2) &&
785 (c
!= (gunichar
) -1);
789 * g_string_append_uri_escaped:
790 * @string: a #GString
791 * @unescaped: a string
792 * @reserved_chars_allowed: a string of reserved characters allowed to be used, or %NULL
793 * @allow_utf8: set %TRUE if the escaped string may include UTF8 characters
795 * Appends @unescaped to @string, escaped any characters that
796 * are reserved in URIs using URI-style escape sequences.
803 g_string_append_uri_escaped (GString
*string
,
804 const char *unescaped
,
805 const char *reserved_chars_allowed
,
810 static const gchar hex
[16] = "0123456789ABCDEF";
812 g_return_val_if_fail (string
!= NULL
, NULL
);
813 g_return_val_if_fail (unescaped
!= NULL
, NULL
);
815 end
= unescaped
+ strlen (unescaped
);
817 while ((c
= *unescaped
) != 0)
819 if (c
>= 0x80 && allow_utf8
&&
820 gunichar_ok (g_utf8_get_char_validated (unescaped
, end
- unescaped
)))
822 int len
= g_utf8_skip
[c
];
823 g_string_append_len (string
, unescaped
, len
);
826 else if (is_valid (c
, reserved_chars_allowed
))
828 g_string_append_c (string
, c
);
833 g_string_append_c (string
, '%');
834 g_string_append_c (string
, hex
[((guchar
)c
) >> 4]);
835 g_string_append_c (string
, hex
[((guchar
)c
) & 0xf]);
845 * @string: a #GString
846 * @val: the string to append onto the end of @string
848 * Adds a string onto the end of a #GString, expanding
854 g_string_append (GString
*string
,
857 g_return_val_if_fail (string
!= NULL
, NULL
);
858 g_return_val_if_fail (val
!= NULL
, string
);
860 return g_string_insert_len (string
, -1, val
, -1);
864 * g_string_append_len:
865 * @string: a #GString
866 * @val: bytes to append
867 * @len: number of bytes of @val to use
869 * Appends @len bytes of @val to @string. Because @len is
870 * provided, @val may contain embedded nuls and need not
873 * Since this function does not stop at nul bytes, it is
874 * the caller's responsibility to ensure that @val has at
875 * least @len addressable bytes.
880 g_string_append_len (GString
*string
,
884 g_return_val_if_fail (string
!= NULL
, NULL
);
885 g_return_val_if_fail (len
== 0 || val
!= NULL
, string
);
887 return g_string_insert_len (string
, -1, val
, len
);
892 * @string: a #GString
893 * @c: the byte to append onto the end of @string
895 * Adds a byte onto the end of a #GString, expanding
900 #undef g_string_append_c
902 g_string_append_c (GString
*string
,
905 g_return_val_if_fail (string
!= NULL
, NULL
);
907 return g_string_insert_c (string
, -1, c
);
911 * g_string_append_unichar:
912 * @string: a #GString
913 * @wc: a Unicode character
915 * Converts a Unicode character into UTF-8, and appends it
918 * Return value: @string
921 g_string_append_unichar (GString
*string
,
924 g_return_val_if_fail (string
!= NULL
, NULL
);
926 return g_string_insert_unichar (string
, -1, wc
);
931 * @string: a #GString
932 * @val: the string to prepend on the start of @string
934 * Adds a string on to the start of a #GString,
935 * expanding it if necessary.
940 g_string_prepend (GString
*string
,
943 g_return_val_if_fail (string
!= NULL
, NULL
);
944 g_return_val_if_fail (val
!= NULL
, string
);
946 return g_string_insert_len (string
, 0, val
, -1);
950 * g_string_prepend_len:
951 * @string: a #GString
952 * @val: bytes to prepend
953 * @len: number of bytes in @val to prepend
955 * Prepends @len bytes of @val to @string.
956 * Because @len is provided, @val may contain
957 * embedded nuls and need not be nul-terminated.
959 * Since this function does not stop at nul bytes,
960 * it is the caller's responsibility to ensure that
961 * @val has at least @len addressable bytes.
966 g_string_prepend_len (GString
*string
,
970 g_return_val_if_fail (string
!= NULL
, NULL
);
971 g_return_val_if_fail (val
!= NULL
, string
);
973 return g_string_insert_len (string
, 0, val
, len
);
977 * g_string_prepend_c:
978 * @string: a #GString
979 * @c: the byte to prepend on the start of the #GString
981 * Adds a byte onto the start of a #GString,
982 * expanding it if necessary.
987 g_string_prepend_c (GString
*string
,
990 g_return_val_if_fail (string
!= NULL
, NULL
);
992 return g_string_insert_c (string
, 0, c
);
996 * g_string_prepend_unichar:
997 * @string: a #GString
998 * @wc: a Unicode character
1000 * Converts a Unicode character into UTF-8, and prepends it
1003 * Return value: @string
1006 g_string_prepend_unichar (GString
*string
,
1009 g_return_val_if_fail (string
!= NULL
, NULL
);
1011 return g_string_insert_unichar (string
, 0, wc
);
1016 * @string: a #GString
1017 * @pos: the position to insert the copy of the string
1018 * @val: the string to insert
1020 * Inserts a copy of a string into a #GString,
1021 * expanding it if necessary.
1026 g_string_insert (GString
*string
,
1030 g_return_val_if_fail (string
!= NULL
, NULL
);
1031 g_return_val_if_fail (val
!= NULL
, string
);
1033 g_return_val_if_fail (pos
<= string
->len
, string
);
1035 return g_string_insert_len (string
, pos
, val
, -1);
1039 * g_string_insert_c:
1040 * @string: a #GString
1041 * @pos: the position to insert the byte
1042 * @c: the byte to insert
1044 * Inserts a byte into a #GString, expanding it if necessary.
1049 g_string_insert_c (GString
*string
,
1053 g_return_val_if_fail (string
!= NULL
, NULL
);
1055 g_string_maybe_expand (string
, 1);
1060 g_return_val_if_fail (pos
<= string
->len
, string
);
1062 /* If not just an append, move the old stuff */
1063 if (pos
< string
->len
)
1064 g_memmove (string
->str
+ pos
+ 1, string
->str
+ pos
, string
->len
- pos
);
1066 string
->str
[pos
] = c
;
1070 string
->str
[string
->len
] = 0;
1076 * g_string_insert_unichar:
1077 * @string: a #GString
1078 * @pos: the position at which to insert character, or -1 to
1079 * append at the end of the string
1080 * @wc: a Unicode character
1082 * Converts a Unicode character into UTF-8, and insert it
1083 * into the string at the given position.
1085 * Return value: @string
1088 g_string_insert_unichar (GString
*string
,
1092 gint charlen
, first
, i
;
1095 g_return_val_if_fail (string
!= NULL
, NULL
);
1097 /* Code copied from g_unichar_to_utf() */
1103 else if (wc
< 0x800)
1108 else if (wc
< 0x10000)
1113 else if (wc
< 0x200000)
1118 else if (wc
< 0x4000000)
1128 /* End of copied code */
1130 g_string_maybe_expand (string
, charlen
);
1135 g_return_val_if_fail (pos
<= string
->len
, string
);
1137 /* If not just an append, move the old stuff */
1138 if (pos
< string
->len
)
1139 g_memmove (string
->str
+ pos
+ charlen
, string
->str
+ pos
, string
->len
- pos
);
1141 dest
= string
->str
+ pos
;
1142 /* Code copied from g_unichar_to_utf() */
1143 for (i
= charlen
- 1; i
> 0; --i
)
1145 dest
[i
] = (wc
& 0x3f) | 0x80;
1148 dest
[0] = wc
| first
;
1149 /* End of copied code */
1151 string
->len
+= charlen
;
1153 string
->str
[string
->len
] = 0;
1159 * g_string_overwrite:
1160 * @string: a #GString
1161 * @pos: the position at which to start overwriting
1162 * @val: the string that will overwrite the @string starting at @pos
1164 * Overwrites part of a string, lengthening it if necessary.
1166 * Return value: @string
1171 g_string_overwrite (GString
*string
,
1175 g_return_val_if_fail (val
!= NULL
, string
);
1176 return g_string_overwrite_len (string
, pos
, val
, strlen (val
));
1180 * g_string_overwrite_len:
1181 * @string: a #GString
1182 * @pos: the position at which to start overwriting
1183 * @val: the string that will overwrite the @string starting at @pos
1184 * @len: the number of bytes to write from @val
1186 * Overwrites part of a string, lengthening it if necessary.
1187 * This function will work with embedded nuls.
1189 * Return value: @string
1194 g_string_overwrite_len (GString
*string
,
1201 g_return_val_if_fail (string
!= NULL
, NULL
);
1206 g_return_val_if_fail (val
!= NULL
, string
);
1207 g_return_val_if_fail (pos
<= string
->len
, string
);
1214 if (end
> string
->len
)
1215 g_string_maybe_expand (string
, end
- string
->len
);
1217 memcpy (string
->str
+ pos
, val
, len
);
1219 if (end
> string
->len
)
1221 string
->str
[end
] = '\0';
1230 * @string: a #GString
1231 * @pos: the position of the content to remove
1232 * @len: the number of bytes to remove, or -1 to remove all
1235 * Removes @len bytes from a #GString, starting at position @pos.
1236 * The rest of the #GString is shifted down to fill the gap.
1241 g_string_erase (GString
*string
,
1245 g_return_val_if_fail (string
!= NULL
, NULL
);
1246 g_return_val_if_fail (pos
>= 0, string
);
1247 g_return_val_if_fail (pos
<= string
->len
, string
);
1250 len
= string
->len
- pos
;
1253 g_return_val_if_fail (pos
+ len
<= string
->len
, string
);
1255 if (pos
+ len
< string
->len
)
1256 g_memmove (string
->str
+ pos
, string
->str
+ pos
+ len
, string
->len
- (pos
+ len
));
1261 string
->str
[string
->len
] = 0;
1267 * g_string_ascii_down:
1268 * @string: a GString
1270 * Converts all upper case ASCII letters to lower case ASCII letters.
1272 * Return value: passed-in @string pointer, with all the upper case
1273 * characters converted to lower case in place, with
1274 * semantics that exactly match g_ascii_tolower().
1277 g_string_ascii_down (GString
*string
)
1282 g_return_val_if_fail (string
!= NULL
, NULL
);
1289 *s
= g_ascii_tolower (*s
);
1298 * g_string_ascii_up:
1299 * @string: a GString
1301 * Converts all lower case ASCII letters to upper case ASCII letters.
1303 * Return value: passed-in @string pointer, with all the lower case
1304 * characters converted to upper case in place, with
1305 * semantics that exactly match g_ascii_toupper().
1308 g_string_ascii_up (GString
*string
)
1313 g_return_val_if_fail (string
!= NULL
, NULL
);
1320 *s
= g_ascii_toupper (*s
);
1330 * @string: a #GString
1332 * Converts a #GString to lowercase.
1334 * Returns: the #GString.
1336 * Deprecated:2.2: This function uses the locale-specific
1337 * tolower() function, which is almost never the right thing.
1338 * Use g_string_ascii_down() or g_utf8_strdown() instead.
1341 g_string_down (GString
*string
)
1346 g_return_val_if_fail (string
!= NULL
, NULL
);
1349 s
= (guchar
*) string
->str
;
1364 * @string: a #GString
1366 * Converts a #GString to uppercase.
1368 * Return value: @string
1370 * Deprecated:2.2: This function uses the locale-specific
1371 * toupper() function, which is almost never the right thing.
1372 * Use g_string_ascii_up() or g_utf8_strup() instead.
1375 g_string_up (GString
*string
)
1380 g_return_val_if_fail (string
!= NULL
, NULL
);
1383 s
= (guchar
*) string
->str
;
1397 * g_string_append_vprintf:
1398 * @string: a #GString
1399 * @format: the string format. See the printf() documentation
1400 * @args: the list of arguments to insert in the output
1402 * Appends a formatted string onto the end of a #GString.
1403 * This function is similar to g_string_append_printf()
1404 * except that the arguments to the format string are passed
1410 g_string_append_vprintf (GString
*string
,
1411 const gchar
*format
,
1417 g_return_if_fail (string
!= NULL
);
1418 g_return_if_fail (format
!= NULL
);
1420 len
= g_vasprintf (&buf
, format
, args
);
1424 g_string_maybe_expand (string
, len
);
1425 memcpy (string
->str
+ string
->len
, buf
, len
+ 1);
1433 * @string: a #GString
1434 * @format: the string format. See the printf() documentation
1435 * @args: the parameters to insert into the format string
1437 * Writes a formatted string into a #GString.
1438 * This function is similar to g_string_printf() except that
1439 * the arguments to the format string are passed as a va_list.
1444 g_string_vprintf (GString
*string
,
1445 const gchar
*format
,
1448 g_string_truncate (string
, 0);
1449 g_string_append_vprintf (string
, format
, args
);
1454 * @string: a #GString
1455 * @format: the string format. See the sprintf() documentation
1456 * @Varargs: the parameters to insert into the format string
1458 * Writes a formatted string into a #GString.
1459 * This is similar to the standard sprintf() function,
1460 * except that the #GString buffer automatically expands
1461 * to contain the results. The previous contents of the
1462 * #GString are destroyed.
1464 * Deprecated: This function has been renamed to g_string_printf().
1469 * @string: a #GString
1470 * @format: the string format. See the printf() documentation
1471 * @Varargs: the parameters to insert into the format string
1473 * Writes a formatted string into a #GString.
1474 * This is similar to the standard sprintf() function,
1475 * except that the #GString buffer automatically expands
1476 * to contain the results. The previous contents of the
1477 * #GString are destroyed.
1480 g_string_printf (GString
*string
,
1481 const gchar
*format
,
1486 g_string_truncate (string
, 0);
1488 va_start (args
, format
);
1489 g_string_append_vprintf (string
, format
, args
);
1494 * g_string_sprintfa:
1495 * @string: a #GString
1496 * @format: the string format. See the sprintf() documentation
1497 * @Varargs: the parameters to insert into the format string
1499 * Appends a formatted string onto the end of a #GString.
1500 * This function is similar to g_string_sprintf() except that
1501 * the text is appended to the #GString.
1503 * Deprecated: This function has been renamed to g_string_append_printf()
1507 * g_string_append_printf:
1508 * @string: a #GString
1509 * @format: the string format. See the printf() documentation
1510 * @Varargs: the parameters to insert into the format string
1512 * Appends a formatted string onto the end of a #GString.
1513 * This function is similar to g_string_printf() except
1514 * that the text is appended to the #GString.
1517 g_string_append_printf (GString
*string
,
1518 const gchar
*format
,
1523 va_start (args
, format
);
1524 g_string_append_vprintf (string
, format
, args
);