mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2025-02-19 08:42:09 +01:00
110c6cbac8
2000-11-05 Havoc Pennington <hp@pobox.com>
* glib/tmpl/spawn.sgml, glib/tmpl/markup.sgml,
glib/tmpl/fileutils.sgml: Added
* glib/Makefile.am: Add new files
* glib/glib-sections.txt: Add stuff from -unused
2000-11-05 Havoc Pennington <hp@pobox.com>
* gutils.c (g_find_program_in_path): cleanup docs, sync param
names to those in the header
* gfileutils.c (g_mkstemp): clean up docs
* gshell.h: sync param names with param names in .c file
* gfileutils.h (enum GFileTest): remove trailing comma from last
member, confuses gtk-doc
* gmarkup.h: s/GMarkupErrorType/GMarkupError/g; to follow
convention
274 lines
5.9 KiB
Plaintext
274 lines
5.9 KiB
Plaintext
<!-- ##### SECTION Title ##### -->
|
|
Strings
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
|
text buffers which grow automatically as text is added.
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
<para>
|
|
A #GString is similar to a standard C string, except that it grows
|
|
automatically as text is appended or inserted.
|
|
</para>
|
|
<para>
|
|
The space allocated for the string is always a power of two, so as the
|
|
string grows it will occupy 2, 4, 8, 16, 32, 64, 128 etc. characters.
|
|
</para>
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### STRUCT GString ##### -->
|
|
<para>
|
|
The #GString struct contains the public fields of a #GString.
|
|
The <structfield>str</structfield> field points to the character data.
|
|
It may move as text is added.
|
|
The <structfield>len</structfield> field contains the length of the string,
|
|
not including the terminating null character.
|
|
</para>
|
|
<para>
|
|
The str field is zero-terminated and so can be used as an ordinary C
|
|
string. But it may be moved when text is appended or inserted into the
|
|
string.
|
|
</para>
|
|
|
|
@str:
|
|
@len:
|
|
|
|
<!-- ##### FUNCTION g_string_new ##### -->
|
|
<para>
|
|
Creates a new #GString, initialized with the given string.
|
|
</para>
|
|
|
|
@init: the initial text to copy into the string.
|
|
@Returns: the new #GString.
|
|
|
|
|
|
<!-- ##### FUNCTION g_string_new_len ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@init:
|
|
@len:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION g_string_sized_new ##### -->
|
|
<para>
|
|
Creates a new GString, with enough space for @dfl_size characters.
|
|
This is useful if you are going to add a lot of text to the string and
|
|
don't want it to be reallocated too often.
|
|
</para>
|
|
|
|
@dfl_size: the default size of the space allocated to hold the string.
|
|
@Returns: the new #GString.
|
|
|
|
|
|
<!-- ##### FUNCTION g_string_assign ##### -->
|
|
<para>
|
|
Copies the characters from one #GString into another, destroying any previous
|
|
contents. It is rather like the standard strcpy() function, except that
|
|
you do not have to worry about having enough space to copy the string.
|
|
</para>
|
|
|
|
@string: the destination #GString. Its current contents are destroyed.
|
|
@rval: the source #GString.
|
|
@Returns: the destination #GString.
|
|
|
|
|
|
<!-- ##### FUNCTION g_string_sprintf ##### -->
|
|
<para>
|
|
Writes a formatted string into a #GString.
|
|
This is similar to the standard <function>sprintf()</function> function,
|
|
except that the GString buffer automatically expands to contain the results.
|
|
The previous contents of the GString are destroyed.
|
|
</para>
|
|
|
|
@string: a #GString.
|
|
@format: the string format. See the <function>sprintf()</function>
|
|
documentation.
|
|
@Varargs: the parameters to insert into the format string.
|
|
|
|
|
|
<!-- ##### FUNCTION g_string_sprintfa ##### -->
|
|
<para>
|
|
Appends a formatted string onto the end of a #GString.
|
|
This function is is similar to g_string_sprintf() except that
|
|
the text is appended to the GString.
|
|
</para>
|
|
|
|
@string: a #GString.
|
|
@format: the string format. See the <function>sprintf()</function>
|
|
documentation.
|
|
@Varargs: the parameters to insert into the format string.
|
|
|
|
|
|
<!-- ##### FUNCTION g_string_append ##### -->
|
|
<para>
|
|
Adds a string onto the end of a #GString, expanding it if necessary.
|
|
</para>
|
|
|
|
@string: a #GString.
|
|
@val: the string to append onto the end of the #GString.
|
|
@Returns: the #GString.
|
|
|
|
|
|
<!-- ##### FUNCTION g_string_append_c ##### -->
|
|
<para>
|
|
Adds a character onto the end of a #GString, expanding it if necessary.
|
|
</para>
|
|
|
|
@string: a #GString.
|
|
@c: the character to append onto the end of the #GString.
|
|
@Returns: the #GString.
|
|
|
|
|
|
<!-- ##### FUNCTION g_string_append_len ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@string:
|
|
@val:
|
|
@len:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION g_string_prepend ##### -->
|
|
<para>
|
|
Adds a string on to the start of a #GString, expanding it if necessary.
|
|
</para>
|
|
|
|
@string: a #GString.
|
|
@val: the string to prepend on the start of the #GString.
|
|
@Returns: the #GString.
|
|
|
|
|
|
<!-- ##### FUNCTION g_string_prepend_c ##### -->
|
|
<para>
|
|
Adds a character onto the start of a #GString, expanding it if necessary.
|
|
</para>
|
|
|
|
@string: a #GString.
|
|
@c: the character to prepend on the start of the #GString.
|
|
@Returns: the #GString.
|
|
|
|
|
|
<!-- ##### FUNCTION g_string_prepend_len ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@string:
|
|
@val:
|
|
@len:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION g_string_insert ##### -->
|
|
<para>
|
|
Inserts a copy of a string into a #GString, expanding it if necessary.
|
|
</para>
|
|
|
|
@string: a #GString.
|
|
@pos: the position to insert the copy of the string.
|
|
@val: the string to insert.
|
|
@Returns: the #GString.
|
|
|
|
|
|
<!-- ##### FUNCTION g_string_insert_c ##### -->
|
|
<para>
|
|
Inserts a character into a #GString, expanding it if necessary.
|
|
</para>
|
|
|
|
@string: a #GString.
|
|
@pos: the position to insert the character.
|
|
@c: the character to insert.
|
|
@Returns: the #GString.
|
|
|
|
|
|
<!-- ##### FUNCTION g_string_insert_len ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@string:
|
|
@pos:
|
|
@val:
|
|
@len:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION g_string_erase ##### -->
|
|
<para>
|
|
Removes @len characters from a #GString, starting at position @pos.
|
|
The rest of the #GString is shifted down to fill the gap.
|
|
</para>
|
|
|
|
@string: a #GString.
|
|
@pos: the position of the characters to remove.
|
|
@len: the number of characters to remove.
|
|
@Returns: the #GString.
|
|
|
|
|
|
<!-- ##### FUNCTION g_string_truncate ##### -->
|
|
<para>
|
|
Cuts off the end of the GString, leaving the first @len characters.
|
|
</para>
|
|
|
|
@string: a #GString.
|
|
@len: the new size of the #GString.
|
|
@Returns: the #GString.
|
|
|
|
|
|
<!-- ##### FUNCTION g_string_free ##### -->
|
|
<para>
|
|
Frees the memory allocated for the #GString.
|
|
If free_segment is TRUE it also frees the character data.
|
|
</para>
|
|
|
|
@string: a #GString.
|
|
@free_segment: if TRUE the actual character data is freed as well.
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION g_string_up ##### -->
|
|
<para>
|
|
Converts a #GString to upper case.
|
|
</para>
|
|
|
|
@string: a #GString.
|
|
@Returns: the #GString.
|
|
|
|
|
|
<!-- ##### FUNCTION g_string_down ##### -->
|
|
<para>
|
|
Converts a #GString to lower case.
|
|
</para>
|
|
|
|
@string: a #GString.
|
|
@Returns: the #GString.
|
|
|
|
|
|
<!-- ##### FUNCTION g_string_hash ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@str:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION g_string_equal ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@v:
|
|
@v2:
|
|
@Returns:
|
|
|
|
|