Files
glib/docs/reference/glib/tmpl/strings.sgml

370 lines
4.3 KiB
Plaintext
Raw Normal View History

1999-08-16 17:58:30 +00:00
<!-- ##### SECTION Title ##### -->
Strings
<!-- ##### SECTION Short_Description ##### -->
text buffers which grow automatically as text is added
1999-08-16 17:58:30 +00:00
<!-- ##### SECTION Long_Description ##### -->
<para>
A #GString is an object that handles the memory management of a C string
for you. You can think of it as similar to a Java StringBuffer.
In addition to the string itself, GString stores the length of the string,
so can be used for binary data with embedded nul bytes. To access the C
string managed by the GString @string, simply use @string->str.
1999-08-16 17:58:30 +00:00
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
2005-05-01 22:02:16 +00:00
<!-- ##### SECTION Stability_Level ##### -->
2010-04-19 17:30:42 -04:00
<!-- ##### SECTION Image ##### -->
1999-08-16 17:58:30 +00:00
<!-- ##### STRUCT GString ##### -->
<para>
The #GString struct contains the public fields of a #GString.
1999-08-16 17:58:30 +00:00
</para>
@str: points to the character data. It may move as text is added.
The <structfield>str</structfield> field is nul-terminated and so
can be used as an ordinary C string.
@len: contains the length of the string, not including the
terminating nul byte.
@allocated_len: the number of bytes that can be stored in the
string before it needs to be reallocated. May be larger than @len.
1999-08-16 17:58:30 +00:00
<!-- ##### FUNCTION g_string_new ##### -->
<para>
1999-08-16 17:58:30 +00:00
</para>
@init:
2006-12-28 14:14:29 +00:00
@Returns:
1999-08-16 17:58:30 +00:00
<!-- ##### FUNCTION g_string_new_len ##### -->
<para>
</para>
@init:
@len:
@Returns:
1999-08-16 17:58:30 +00:00
<!-- ##### FUNCTION g_string_sized_new ##### -->
<para>
1999-08-16 17:58:30 +00:00
</para>
2006-12-28 14:14:29 +00:00
@dfl_size:
@Returns:
1999-08-16 17:58:30 +00:00
<!-- ##### FUNCTION g_string_assign ##### -->
<para>
1999-08-16 17:58:30 +00:00
</para>
@string:
@rval:
2006-12-28 14:14:29 +00:00
@Returns:
1999-08-16 17:58:30 +00:00
changed prototype of g_boxed_type_register_static() to contain an optional Wed Mar 7 09:36:33 2001 Tim Janik <timj@gtk.org> * gboxed.[hc]: changed prototype of g_boxed_type_register_static() to contain an optional init function and a hint at whether the boxed structure uses ref counting internally. added g_value_set_boxed_take_ownership(). made G_TYPE_BOXED an abstract value type. * genums.[hc]: made G_TYPE_ENUM and G_TYPE_FLAGS abstract value types. * glib-genmarshal.c: argument type changes, preparation for third-party arg specification. * gobject.[hc]: cleaned up get/set property code. added g_strdup_value_contents() to improve warnings. * gparam.[hc]: added g_param_value_convert(), taking over responsibility of the old g_value_convert(). added G_PARAM_LAX_VALIDATION flag so validation alterations may be valid a part of the property setting process. * gparamspecs.[hc]: made value comparisons stable (for sort applications). added GParamSpecValueArray, a param spec for value arrays and GParamSpecClosure. nuked the value exchange functions and GParamSpecCCallback. * gtype.[hc]: catch unintialized usages of the type system with g_return_val_if_uninitialized(). introduced G_TYPE_FLAG_VALUE_ABSTRACT to flag types that introduce a value table, but can't be used for g_value_init(). cleaned up reserved type ids. * gvalue.[hc]: code cleanups and saner checking. nuked the value exchange API. implemented value transformations, we can't really "convert" values, rather transforms are an anylogy to C casts, real conversions need a param spec for validation, which is why g_param_value_convert() does real conversions now. * gvaluearray.[hc]: new files that implement a GValueArray, a struct that can hold inhomogeneous arrays of value (to that extend that it also allowes undefined values, i.e. G_VALUE_TYPE(value)==0). this is exposed to the type system as a boxed type. * gvaluetransform.c: new file implementing most of the former value exchange functions as single-sided transformations. * gvaluetypes.[hc]: nuked G_TYPE_CCALLBACK, added g_value_set_string_take_ownership(). * *.h: s/G_IS_VALUE_/G_VALUE_HOLDS_/. * *.[hc]: many fixes and cleanups. * many warning improvements. Tue Feb 27 18:35:15 2001 Tim Janik <timj@gtk.org> * gobject.c (g_object_get_valist): urg, pass G_VALUE_NOCOPY_CONTENTS into G_VALUE_LCOPY(), this needs proper documenting. * gparam.c: fixed G_PARAM_USER_MASK. * gtype.c (type_data_make_W): (type_data_last_unref_Wm): fixed invalid memory freeing. * gobject.c (g_object_last_unref): destroy signal handlers associated with object, right before finalization. * gsignal.c (g_signal_parse_name): catch destroyed nodes or signals that don't actually support details. * gobject.[hc]: got rid of property trailers. nuked GObject properties "data" and the "signal" variants. (g_object_connect): new convenience function to do multiple signal connections at once. (g_object_disconnect): likewise, for disconnections. * gparam.[hc] (g_param_spec_pool_lookup): took out trailer support. * gvalue.[hc]: marked g_value_fits_pointer() and g_value_peek_pointer() as private (the latter got renamed from g_value_get_as_pointer()). Wed Mar 7 09:32:06 2001 Tim Janik <timj@gtk.org> * glib-object.h: add gvaluearray.h. * gstring.[hc]: fixup naming of g_string_sprint*. * gtypes.h: fixed GCompareDataFunc naming. Wed Mar 7 09:33:27 2001 Tim Janik <timj@gtk.org> * gobject/Makefile.am: shuffled rules to avoid excessive rebuilds. * gobject/gobject-sections.txt: updates. * gobject/tmpl/*: bunch of updates, added another patch from Eric Lemings <eric.b.lemings@lmco.com>.
2001-03-07 14:46:45 +00:00
<!-- ##### MACRO g_string_sprintf ##### -->
1999-08-16 17:58:30 +00:00
<para>
</para>
1999-08-16 17:58:30 +00:00
2006-12-28 14:14:29 +00:00
changed prototype of g_boxed_type_register_static() to contain an optional Wed Mar 7 09:36:33 2001 Tim Janik <timj@gtk.org> * gboxed.[hc]: changed prototype of g_boxed_type_register_static() to contain an optional init function and a hint at whether the boxed structure uses ref counting internally. added g_value_set_boxed_take_ownership(). made G_TYPE_BOXED an abstract value type. * genums.[hc]: made G_TYPE_ENUM and G_TYPE_FLAGS abstract value types. * glib-genmarshal.c: argument type changes, preparation for third-party arg specification. * gobject.[hc]: cleaned up get/set property code. added g_strdup_value_contents() to improve warnings. * gparam.[hc]: added g_param_value_convert(), taking over responsibility of the old g_value_convert(). added G_PARAM_LAX_VALIDATION flag so validation alterations may be valid a part of the property setting process. * gparamspecs.[hc]: made value comparisons stable (for sort applications). added GParamSpecValueArray, a param spec for value arrays and GParamSpecClosure. nuked the value exchange functions and GParamSpecCCallback. * gtype.[hc]: catch unintialized usages of the type system with g_return_val_if_uninitialized(). introduced G_TYPE_FLAG_VALUE_ABSTRACT to flag types that introduce a value table, but can't be used for g_value_init(). cleaned up reserved type ids. * gvalue.[hc]: code cleanups and saner checking. nuked the value exchange API. implemented value transformations, we can't really "convert" values, rather transforms are an anylogy to C casts, real conversions need a param spec for validation, which is why g_param_value_convert() does real conversions now. * gvaluearray.[hc]: new files that implement a GValueArray, a struct that can hold inhomogeneous arrays of value (to that extend that it also allowes undefined values, i.e. G_VALUE_TYPE(value)==0). this is exposed to the type system as a boxed type. * gvaluetransform.c: new file implementing most of the former value exchange functions as single-sided transformations. * gvaluetypes.[hc]: nuked G_TYPE_CCALLBACK, added g_value_set_string_take_ownership(). * *.h: s/G_IS_VALUE_/G_VALUE_HOLDS_/. * *.[hc]: many fixes and cleanups. * many warning improvements. Tue Feb 27 18:35:15 2001 Tim Janik <timj@gtk.org> * gobject.c (g_object_get_valist): urg, pass G_VALUE_NOCOPY_CONTENTS into G_VALUE_LCOPY(), this needs proper documenting. * gparam.c: fixed G_PARAM_USER_MASK. * gtype.c (type_data_make_W): (type_data_last_unref_Wm): fixed invalid memory freeing. * gobject.c (g_object_last_unref): destroy signal handlers associated with object, right before finalization. * gsignal.c (g_signal_parse_name): catch destroyed nodes or signals that don't actually support details. * gobject.[hc]: got rid of property trailers. nuked GObject properties "data" and the "signal" variants. (g_object_connect): new convenience function to do multiple signal connections at once. (g_object_disconnect): likewise, for disconnections. * gparam.[hc] (g_param_spec_pool_lookup): took out trailer support. * gvalue.[hc]: marked g_value_fits_pointer() and g_value_peek_pointer() as private (the latter got renamed from g_value_get_as_pointer()). Wed Mar 7 09:32:06 2001 Tim Janik <timj@gtk.org> * glib-object.h: add gvaluearray.h. * gstring.[hc]: fixup naming of g_string_sprint*. * gtypes.h: fixed GCompareDataFunc naming. Wed Mar 7 09:33:27 2001 Tim Janik <timj@gtk.org> * gobject/Makefile.am: shuffled rules to avoid excessive rebuilds. * gobject/gobject-sections.txt: updates. * gobject/tmpl/*: bunch of updates, added another patch from Eric Lemings <eric.b.lemings@lmco.com>.
2001-03-07 14:46:45 +00:00
<!-- ##### MACRO g_string_sprintfa ##### -->
1999-08-16 17:58:30 +00:00
<para>
</para>
1999-08-16 17:58:30 +00:00
2006-12-28 14:14:29 +00:00
2007-06-18 17:31:49 +00:00
<!-- ##### FUNCTION g_string_vprintf ##### -->
<para>
</para>
@string:
@format:
@args:
<!-- ##### FUNCTION g_string_append_vprintf ##### -->
<para>
</para>
@string:
@format:
@args:
<!-- ##### FUNCTION g_string_printf ##### -->
<para>
</para>
2006-12-28 14:14:29 +00:00
@string:
@format:
@Varargs:
<!-- ##### FUNCTION g_string_append_printf ##### -->
<para>
</para>
2006-12-28 14:14:29 +00:00
@string:
@format:
2006-12-28 14:14:29 +00:00
@Varargs:
1999-08-16 17:58:30 +00:00
<!-- ##### FUNCTION g_string_append ##### -->
<para>
1999-08-16 17:58:30 +00:00
</para>
2006-12-28 14:14:29 +00:00
@string:
@val:
@Returns:
1999-08-16 17:58:30 +00:00
<!-- ##### FUNCTION g_string_append_c ##### -->
<para>
1999-08-16 17:58:30 +00:00
</para>
@string:
@c:
@Returns:
2000-09-06 00:04:49 +00:00
<!-- ##### FUNCTION g_string_append_unichar ##### -->
<para>
</para>
@string:
@wc:
@Returns:
2000-09-06 00:04:49 +00:00
<!-- ##### FUNCTION g_string_append_len ##### -->
<para>
2000-09-06 00:04:49 +00:00
</para>
2006-12-28 14:14:29 +00:00
@string:
@val:
@len:
2006-12-28 14:14:29 +00:00
@Returns:
1999-08-16 17:58:30 +00:00
2007-12-21 00:37:41 +00:00
<!-- ##### FUNCTION g_string_append_uri_escaped ##### -->
<para>
</para>
@string:
@unescaped:
@reserved_chars_allowed:
@allow_utf8:
@Returns:
1999-08-16 17:58:30 +00:00
<!-- ##### FUNCTION g_string_prepend ##### -->
<para>
1999-08-16 17:58:30 +00:00
</para>
@string:
@val:
2006-12-28 14:14:29 +00:00
@Returns:
1999-08-16 17:58:30 +00:00
<!-- ##### FUNCTION g_string_prepend_c ##### -->
<para>
1999-08-16 17:58:30 +00:00
</para>
@string:
2006-12-28 14:14:29 +00:00
@c:
@Returns:
2000-09-06 00:04:49 +00:00
<!-- ##### FUNCTION g_string_prepend_unichar ##### -->
<para>
</para>
@string:
@wc:
@Returns:
2000-09-06 00:04:49 +00:00
<!-- ##### FUNCTION g_string_prepend_len ##### -->
<para>
2000-09-06 00:04:49 +00:00
</para>
@string:
@val:
@len:
2006-12-28 14:14:29 +00:00
@Returns:
1999-08-16 17:58:30 +00:00
<!-- ##### FUNCTION g_string_insert ##### -->
<para>
1999-08-16 17:58:30 +00:00
</para>
2006-12-28 14:14:29 +00:00
@string:
@pos:
@val:
@Returns:
1999-08-16 17:58:30 +00:00
<!-- ##### FUNCTION g_string_insert_c ##### -->
<para>
1999-08-16 17:58:30 +00:00
</para>
@string:
@pos:
@c:
@Returns:
2000-09-06 00:04:49 +00:00
<!-- ##### FUNCTION g_string_insert_unichar ##### -->
<para>
</para>
@string:
@pos:
@wc:
2006-12-28 14:14:29 +00:00
@Returns:
2000-09-06 00:04:49 +00:00
<!-- ##### FUNCTION g_string_insert_len ##### -->
<para>
</para>
1999-08-16 17:58:30 +00:00
@string:
@pos:
@val:
@len:
2006-12-28 14:14:29 +00:00
@Returns:
<!-- ##### FUNCTION g_string_overwrite ##### -->
<para>
</para>
@string:
@pos:
@val:
@Returns:
<!-- ##### FUNCTION g_string_overwrite_len ##### -->
<para>
</para>
@string:
@pos:
@val:
@len:
@Returns:
1999-08-16 17:58:30 +00:00
2006-12-28 14:14:29 +00:00
1999-08-16 17:58:30 +00:00
<!-- ##### FUNCTION g_string_erase ##### -->
<para>
1999-08-16 17:58:30 +00:00
</para>
2006-12-28 14:14:29 +00:00
@string:
@pos:
@len:
2006-12-28 14:14:29 +00:00
@Returns:
1999-08-16 17:58:30 +00:00
<!-- ##### FUNCTION g_string_truncate ##### -->
<para>
1999-08-16 17:58:30 +00:00
</para>
2006-12-28 14:14:29 +00:00
@string:
@len:
2006-12-28 14:14:29 +00:00
@Returns:
1999-08-16 17:58:30 +00:00
<!-- ##### FUNCTION g_string_set_size ##### -->
<para>
</para>
@string:
@len:
@Returns:
1999-08-16 17:58:30 +00:00
<!-- ##### FUNCTION g_string_free ##### -->
<para>
1999-08-16 17:58:30 +00:00
</para>
@string:
2006-12-28 14:14:29 +00:00
@free_segment:
@Returns:
1999-08-16 17:58:30 +00:00
<!-- ##### FUNCTION g_string_up ##### -->
<para>
</para>
@string:
@Returns:
1999-08-16 17:58:30 +00:00
<!-- ##### FUNCTION g_string_down ##### -->
<para>
2000-09-06 00:04:49 +00:00
</para>
@string:
@Returns:
2000-09-06 00:04:49 +00:00
<!-- ##### FUNCTION g_string_hash ##### -->
<para>
2000-09-06 00:04:49 +00:00
</para>
2006-12-28 14:14:29 +00:00
@str:
@Returns:
2000-09-06 00:04:49 +00:00
<!-- ##### FUNCTION g_string_equal ##### -->
<para>
1999-08-16 17:58:30 +00:00
</para>
@v:
@v2:
@Returns:
1999-08-16 17:58:30 +00:00