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/.
49 GHashTable *const_table;
62 * @v2: a key to compare with @v1.
64 * Compares two strings and returns %TRUE if they are equal.
65 * It can be passed to g_hash_table_new() as the @key_equal_func
66 * parameter, when using strings as keys in a #GHashTable.
68 * Returns: %TRUE if the two keys match.
71 g_str_equal (gconstpointer v1,
74 const gchar *string1 = v1;
75 const gchar *string2 = v2;
77 return strcmp (string1, string2) == 0;
84 * Converts a string to a hash value.
85 * It can be passed to g_hash_table_new() as the @hash_func parameter,
86 * when using strings as keys in a #GHashTable.
88 * Returns: a hash value corresponding to the key.
91 g_str_hash (gconstpointer v)
93 /* 31 bit hash function */
94 const signed char *p = v;
98 for (p += 1; *p != '\0'; p++)
99 h = (h << 5) - h + *p;
104 #define MY_MAXSIZE ((gsize)-1)
107 nearest_power (gsize base, gsize num)
109 if (num > MY_MAXSIZE / 2)
128 * g_string_chunk_new:
129 * @size: the default size of the blocks of memory which are
130 * allocated to store the strings. If a particular string
131 * is larger than this default size, a larger block of
132 * memory will be allocated for it.
134 * Creates a new #GStringChunk.
136 * Returns: a new #GStringChunk
139 g_string_chunk_new (gsize size)
141 GStringChunk *new_chunk = g_new (GStringChunk, 1);
142 gsize actual_size = 1;
144 actual_size = nearest_power (1, size);
146 new_chunk->const_table = NULL;
147 new_chunk->storage_list = NULL;
148 new_chunk->storage_next = actual_size;
149 new_chunk->default_size = actual_size;
150 new_chunk->this_size = actual_size;
156 * g_string_chunk_free:
157 * @chunk: a #GStringChunk
159 * Frees all memory allocated by the #GStringChunk.
160 * After calling g_string_chunk_free() it is not safe to
161 * access any of the strings which were contained within it.
164 g_string_chunk_free (GStringChunk *chunk)
168 g_return_if_fail (chunk != NULL);
170 if (chunk->storage_list)
172 for (tmp_list = chunk->storage_list; tmp_list; tmp_list = tmp_list->next)
173 g_free (tmp_list->data);
175 g_slist_free (chunk->storage_list);
178 if (chunk->const_table)
179 g_hash_table_destroy (chunk->const_table);
185 * g_string_chunk_clear:
186 * @chunk: a #GStringChunk
188 * Frees all strings contained within the #GStringChunk.
189 * After calling g_string_chunk_clear() it is not safe to
190 * access any of the strings which were contained within it.
195 g_string_chunk_clear (GStringChunk *chunk)
199 g_return_if_fail (chunk != NULL);
201 if (chunk->storage_list)
203 for (tmp_list = chunk->storage_list; tmp_list; tmp_list = tmp_list->next)
204 g_free (tmp_list->data);
206 g_slist_free (chunk->storage_list);
208 chunk->storage_list = NULL;
209 chunk->storage_next = chunk->default_size;
210 chunk->this_size = chunk->default_size;
213 if (chunk->const_table)
214 g_hash_table_remove_all (chunk->const_table);
218 * g_string_chunk_insert:
219 * @chunk: a #GStringChunk
220 * @string: the string to add
222 * Adds a copy of @string to the #GStringChunk.
223 * It returns a pointer to the new copy of the string
224 * in the #GStringChunk. The characters in the string
225 * can be changed, if necessary, though you should not
226 * change anything after the end of the string.
228 * Unlike g_string_chunk_insert_const(), this function
229 * does not check for duplicates. Also strings added
230 * with g_string_chunk_insert() will not be searched
231 * by g_string_chunk_insert_const() when looking for
234 * Returns: a pointer to the copy of @string within
238 g_string_chunk_insert (GStringChunk *chunk,
241 g_return_val_if_fail (chunk != NULL, NULL);
243 return g_string_chunk_insert_len (chunk, string, -1);
247 * g_string_chunk_insert_const:
248 * @chunk: a #GStringChunk
249 * @string: the string to add
251 * Adds a copy of @string to the #GStringChunk, unless
252 * the same string has already been added to the #GStringChunk
253 * with g_string_chunk_insert_const().
255 * This function is useful if you need to copy a large number
256 * of strings but do not want to waste space storing duplicates.
257 * But you must remember that there may be several pointers to
258 * the same string, and so any changes made to the strings
259 * should be done very carefully.
261 * Note that g_string_chunk_insert_const() will not return a
262 * pointer to a string added with g_string_chunk_insert(), even
265 * Returns: a pointer to the new or existing copy of @string
266 * within the #GStringChunk
269 g_string_chunk_insert_const (GStringChunk *chunk,
274 g_return_val_if_fail (chunk != NULL, NULL);
276 if (!chunk->const_table)
277 chunk->const_table = g_hash_table_new (g_str_hash, g_str_equal);
279 lookup = (char*) g_hash_table_lookup (chunk->const_table, (gchar *)string);
283 lookup = g_string_chunk_insert (chunk, string);
284 g_hash_table_insert (chunk->const_table, lookup, lookup);
291 * g_string_chunk_insert_len:
292 * @chunk: a #GStringChunk
293 * @string: bytes to insert
294 * @len: number of bytes of @string to insert, or -1 to insert a
295 * nul-terminated string.
297 * Adds a copy of the first @len bytes of @string to the #GStringChunk. The
298 * copy is nul-terminated.
300 * Since this function does not stop at nul bytes, it is the caller's
301 * responsibility to ensure that @string has at least @len addressable bytes.
303 * The characters in the returned string can be changed, if necessary, though
304 * you should not change anything after the end of the string.
306 * Return value: a pointer to the copy of @string within the #GStringChunk
311 g_string_chunk_insert_len (GStringChunk *chunk,
318 g_return_val_if_fail (chunk != NULL, NULL);
321 size = strlen (string);
325 if ((chunk->storage_next + size + 1) > chunk->this_size)
327 gsize new_size = nearest_power (chunk->default_size, size + 1);
329 chunk->storage_list = g_slist_prepend (chunk->storage_list,
330 g_new (gchar, new_size));
332 chunk->this_size = new_size;
333 chunk->storage_next = 0;
336 pos = ((gchar *) chunk->storage_list->data) + chunk->storage_next;
338 *(pos + size) = '\0';
340 strncpy (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 string.
420 * @len: length of @init to use.
422 * Creates a new #GString with @len bytes of the
423 * @init buffer. Because a length is provided, @init
424 * need not be nul-terminated, and can contain embedded
427 * Since this function does not stop at nul bytes, it is the caller's
428 * responsibility to ensure that @init has at least @len addressable bytes.
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
492 * length and contain the same bytes.
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.
555 * Returns: the destination #GString.
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 the #GString
581 * Cuts off the end of the GString, leaving the first @len bytes.
583 * Returns: the #GString
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 the caller's
639 * responsibility to ensure that @val has at least @len addressable bytes.
641 * Returns: the #GString
644 g_string_insert_len (GString *string,
649 g_return_val_if_fail (string != NULL, NULL);
650 g_return_val_if_fail (val != NULL, string);
658 g_return_val_if_fail (pos <= string->len, string);
660 /* Check whether val represents a substring of string. This test
661 probably violates chapter and verse of the C standards, since
662 ">=" and "<=" are only valid when val really is a substring.
663 In practice, it will work on modern archs. */
664 if (val >= string->str && val <= string->str + string->len)
666 gsize offset = val - string->str;
669 g_string_maybe_expand (string, len);
670 val = string->str + offset;
671 /* At this point, val is valid again. */
673 /* Open up space where we are going to insert. */
674 if (pos < string->len)
675 g_memmove (string->str + pos + len, string->str + pos, string->len - pos);
677 /* Move the source part before the gap, if any. */
680 precount = MIN (len, pos - offset);
681 memcpy (string->str + pos, val, precount);
684 /* Move the source part after the gap, if any. */
686 memcpy (string->str + pos + precount,
687 val + /* Already moved: */ precount + /* Space opened up: */ len,
692 g_string_maybe_expand (string, len);
694 /* If we aren't appending at the end, move a hunk
695 * of the old string to the end, opening up space
697 if (pos < string->len)
698 g_memmove (string->str + pos + len, string->str + pos, string->len - pos);
700 /* insert the new string */
702 string->str[pos] = *val;
704 memcpy (string->str + pos, val, len);
709 string->str[string->len] = 0;
716 * @string: a #GString.
717 * @val: the string to append onto the end of the #GString.
719 * Adds a string onto the end of a #GString, expanding it if necessary.
721 * Returns: the #GString.
724 g_string_append (GString *string,
727 g_return_val_if_fail (string != NULL, NULL);
728 g_return_val_if_fail (val != NULL, string);
730 return g_string_insert_len (string, -1, val, -1);
734 * g_string_append_len:
735 * @string: a #GString
736 * @val: bytes to append
737 * @len: number of bytes of @val to use.
739 * Appends @len bytes of @val to @string.
740 * Because @len is provided, @val may contain
741 * embedded nuls and need not be nul-terminated.
743 * Since this function does not stop at nul bytes, it is the caller's
744 * responsibility to ensure that @val has at least @len addressable bytes.
746 * Returns: the #GString
749 g_string_append_len (GString *string,
753 g_return_val_if_fail (string != NULL, NULL);
754 g_return_val_if_fail (val != NULL, string);
756 return g_string_insert_len (string, -1, val, len);
761 * @string: a #GString.
762 * @c: the byte to append onto the end of the #GString.
764 * Adds a byte onto the end of a #GString, expanding it if necessary.
766 * Returns: the #GString.
768 #undef g_string_append_c
770 g_string_append_c (GString *string,
773 g_return_val_if_fail (string != NULL, NULL);
775 return g_string_insert_c (string, -1, c);
779 * g_string_append_unichar:
780 * @string: a #GString
781 * @wc: a Unicode character
783 * Converts a Unicode character into UTF-8, and appends it
786 * Return value: @string
789 g_string_append_unichar (GString *string,
792 g_return_val_if_fail (string != NULL, NULL);
794 return g_string_insert_unichar (string, -1, wc);
799 * @string: a #GString
800 * @val: the string to prepend on the start of the #GString
802 * Adds a string on to the start of a #GString,
803 * expanding it if necessary.
805 * Returns: the #GString
808 g_string_prepend (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, 0, val, -1);
818 * g_string_prepend_len:
819 * @string: a #GString
820 * @val: bytes to prepend
821 * @len: number of bytes in @val to prepend
823 * Prepends @len bytes of @val to @string.
824 * Because @len is provided, @val may contain
825 * embedded nuls and need not be nul-terminated.
827 * Since this function does not stop at nul bytes, it is the caller's
828 * responsibility to ensure that @val has at least @len addressable bytes.
830 * Returns: the #GString passed in
833 g_string_prepend_len (GString *string,
837 g_return_val_if_fail (string != NULL, NULL);
838 g_return_val_if_fail (val != NULL, string);
840 return g_string_insert_len (string, 0, val, len);
844 * g_string_prepend_c:
845 * @string: a #GString
846 * @c: the byte to prepend on the start of the #GString
848 * Adds a byte onto the start of a #GString,
849 * expanding it if necessary.
851 * Returns: the #GString
854 g_string_prepend_c (GString *string,
857 g_return_val_if_fail (string != NULL, NULL);
859 return g_string_insert_c (string, 0, c);
863 * g_string_prepend_unichar:
864 * @string: a #GString.
865 * @wc: a Unicode character.
867 * Converts a Unicode character into UTF-8, and prepends it
870 * Return value: @string.
873 g_string_prepend_unichar (GString *string,
876 g_return_val_if_fail (string != NULL, NULL);
878 return g_string_insert_unichar (string, 0, wc);
883 * @string: a #GString
884 * @pos: the position to insert the copy of the string
885 * @val: the string to insert
887 * Inserts a copy of a string into a #GString,
888 * expanding it if necessary.
890 * Returns: the #GString
893 g_string_insert (GString *string,
897 g_return_val_if_fail (string != NULL, NULL);
898 g_return_val_if_fail (val != NULL, string);
900 g_return_val_if_fail (pos <= string->len, string);
902 return g_string_insert_len (string, pos, val, -1);
907 * @string: a #GString
908 * @pos: the position to insert the byte
909 * @c: the byte to insert
911 * Inserts a byte into a #GString, expanding it if necessary.
913 * Returns: the #GString
916 g_string_insert_c (GString *string,
920 g_return_val_if_fail (string != NULL, NULL);
922 g_string_maybe_expand (string, 1);
927 g_return_val_if_fail (pos <= string->len, string);
929 /* If not just an append, move the old stuff */
930 if (pos < string->len)
931 g_memmove (string->str + pos + 1, string->str + pos, string->len - pos);
933 string->str[pos] = c;
937 string->str[string->len] = 0;
943 * g_string_insert_unichar:
944 * @string: a #GString
945 * @pos: the position at which to insert character, or -1 to
946 * append at the end of the string.
947 * @wc: a Unicode character
949 * Converts a Unicode character into UTF-8, and insert it
950 * into the string at the given position.
952 * Return value: @string
955 g_string_insert_unichar (GString *string,
959 gint charlen, first, i;
962 g_return_val_if_fail (string != NULL, NULL);
964 /* Code copied from g_unichar_to_utf() */
975 else if (wc < 0x10000)
980 else if (wc < 0x200000)
985 else if (wc < 0x4000000)
995 /* End of copied code */
997 g_string_maybe_expand (string, charlen);
1002 g_return_val_if_fail (pos <= string->len, string);
1004 /* If not just an append, move the old stuff */
1005 if (pos < string->len)
1006 g_memmove (string->str + pos + charlen, string->str + pos, string->len - pos);
1008 dest = string->str + pos;
1009 /* Code copied from g_unichar_to_utf() */
1010 for (i = charlen - 1; i > 0; --i)
1012 dest[i] = (wc & 0x3f) | 0x80;
1015 dest[0] = wc | first;
1016 /* End of copied code */
1018 string->len += charlen;
1020 string->str[string->len] = 0;
1027 * @string: a #GString
1028 * @pos: the position of the content to remove
1029 * @len: the number of bytes to remove, or -1 to remove all
1032 * Removes @len bytes from a #GString, starting at position @pos.
1033 * The rest of the #GString is shifted down to fill the gap.
1035 * Returns: the #GString
1038 g_string_erase (GString *string,
1042 g_return_val_if_fail (string != NULL, NULL);
1043 g_return_val_if_fail (pos >= 0, string);
1044 g_return_val_if_fail (pos <= string->len, string);
1047 len = string->len - pos;
1050 g_return_val_if_fail (pos + len <= string->len, string);
1052 if (pos + len < string->len)
1053 g_memmove (string->str + pos, string->str + pos + len, string->len - (pos + len));
1058 string->str[string->len] = 0;
1064 * g_string_ascii_down:
1065 * @string: a GString
1067 * Converts all upper case ASCII letters to lower case ASCII letters.
1069 * Return value: passed-in @string pointer, with all the upper case
1070 * characters converted to lower case in place, with
1071 * semantics that exactly match g_ascii_tolower.
1074 g_string_ascii_down (GString *string)
1079 g_return_val_if_fail (string != NULL, NULL);
1086 *s = g_ascii_tolower (*s);
1095 * g_string_ascii_up:
1096 * @string: a GString
1098 * Converts all lower case ASCII letters to upper case ASCII letters.
1100 * Return value: passed-in @string pointer, with all the lower case
1101 * characters converted to upper case in place, with
1102 * semantics that exactly match g_ascii_toupper.
1105 g_string_ascii_up (GString *string)
1110 g_return_val_if_fail (string != NULL, NULL);
1117 *s = g_ascii_toupper (*s);
1127 * @string: a #GString
1129 * Converts a #GString to lowercase.
1131 * Returns: the #GString.
1133 * Deprecated:2.2: This function uses the locale-specific tolower() function,
1134 * which is almost never the right thing. Use g_string_ascii_down() or
1135 * g_utf8_strdown() instead.
1138 g_string_down (GString *string)
1143 g_return_val_if_fail (string != NULL, NULL);
1146 s = (guchar *) string->str;
1161 * @string: a #GString
1163 * Converts a #GString to uppercase.
1165 * Return value: the #GString
1167 * Deprecated:2.2: This function uses the locale-specific toupper() function,
1168 * which is almost never the right thing. Use g_string_ascii_up() or
1169 * g_utf8_strup() instead.
1172 g_string_up (GString *string)
1177 g_return_val_if_fail (string != NULL, NULL);
1180 s = (guchar *) string->str;
1194 g_string_append_printf_internal (GString *string,
1201 length = g_vasprintf (&buffer, fmt, args);
1202 g_string_append_len (string, buffer, length);
1208 * @string: a #GString.
1209 * @format: the string format. See the sprintf() documentation.
1210 * @Varargs: the parameters to insert into the format string.
1212 * Writes a formatted string into a #GString.
1213 * This is similar to the standard sprintf() function,
1214 * except that the #GString buffer automatically expands
1215 * to contain the results. The previous contents of the
1216 * #GString are destroyed.
1218 * Deprecated: This function has been renamed to g_string_printf().
1223 * @string: a #GString.
1224 * @format: the string format. See the printf() documentation.
1225 * @Varargs: the parameters to insert into the format string.
1227 * Writes a formatted string into a #GString.
1228 * This is similar to the standard sprintf() function,
1229 * except that the #GString buffer automatically expands
1230 * to contain the results. The previous contents of the
1231 * #GString are destroyed.
1234 g_string_printf (GString *string,
1240 g_string_truncate (string, 0);
1242 va_start (args, fmt);
1243 g_string_append_printf_internal (string, fmt, args);
1248 * g_string_sprintfa:
1249 * @string: a #GString.
1250 * @format: the string format. See the sprintf() documentation.
1251 * @Varargs: the parameters to insert into the format string.
1253 * Appends a formatted string onto the end of a #GString.
1254 * This function is is similar to g_string_sprintf() except that
1255 * the text is appended to the #GString.
1257 * Deprecated: This function has been renamed to
1258 * g_string_append_printf().
1262 * g_string_append_printf:
1263 * @string: a #GString.
1264 * @format: the string format. See the printf() documentation.
1265 * @Varargs: the parameters to insert into the format string.
1267 * Appends a formatted string onto the end of a #GString.
1268 * This function is is similar to g_string_printf() except
1269 * that the text is appended to the #GString.
1272 g_string_append_printf (GString *string,
1278 va_start (args, fmt);
1279 g_string_append_printf_internal (string, fmt, args);
1283 #define __G_STRING_C__
1284 #include "galiasdef.c"