[glibmm] glibmm: Regenerate the defs and xml doc files.
- From: Josà Alburquerque <jaalburqu src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glibmm] glibmm: Regenerate the defs and xml doc files.
- Date: Tue, 14 Jun 2011 22:06:19 +0000 (UTC)
commit 026ef4d9484202e1f9c1e713e4600f398c86c3ce
Author: Josà Alburquerque <jaalburqu svn gnome org>
Date: Tue Jun 14 17:52:41 2011 -0400
glibmm: Regenerate the defs and xml doc files.
* glib/src/glib_docs.xml:
* glib/src/glib_enums.defs:
* glib/src/glib_functions.defs:
* glib/src/gobject_enums.defs:
* glib/src/gobject_functions.defs: Regenerate with Glib 2.29.8 to get
the new functions enums and docs.
* configure.ac: Increase the Glib requirement to 2.29.8.
ChangeLog | 14 +
configure.ac | 2 +-
glib/src/glib_docs.xml |40372 ++++++++++++++++++++++++---------------
glib/src/glib_enums.defs | 120 +-
glib/src/glib_functions.defs | 698 +-
glib/src/gobject_enums.defs | 31 +-
glib/src/gobject_functions.defs | 237 +-
7 files changed, 26024 insertions(+), 15450 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index adc3552..49053cd 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,17 @@
+2011-06-14 Josà Alburquerque <jaalburqu svn gnome org>
+
+
+ glibmm: Regenerate the defs and xml doc files.
+
+ * glib/src/glib_docs.xml:
+ * glib/src/glib_enums.defs:
+ * glib/src/glib_functions.defs:
+ * glib/src/gobject_enums.defs:
+ * glib/src/gobject_functions.defs: Regenerate with Glib 2.29.8 to get
+ the new functions enums and docs.
+
+ * configure.ac: Increase the Glib requirement to 2.29.8.
+
2.28.1:
2011-06-13 Kalev Lember <kalev smartlink ee>
diff --git a/configure.ac b/configure.ac
index f5aaa3c..32f8fd4 100644
--- a/configure.ac
+++ b/configure.ac
@@ -61,7 +61,7 @@ AS_IF([test "x$enable_static" = xyes],
AC_DEFINE([GIOMM_STATIC_LIB], [1], [Define if giomm is built as a static library])
])
-glibreq='2.0 >= 2.28.0'
+glibreq='2.0 >= 2.29.8'
GLIBMM_MODULES="sigc++-2.0 >= 2.0 glib-$glibreq gobject-$glibreq gmodule-$glibreq"
GIOMM_MODULES="$GLIBMM_MODULES gio-$glibreq"
test "x$glibmm_host_windows" = xyes || GIOMM_MODULES="$GIOMM_MODULES gio-unix-$glibreq"
diff --git a/glib/src/glib_docs.xml b/glib/src/glib_docs.xml
index 5d4f054..dbbb027 100644
--- a/glib/src/glib_docs.xml
+++ b/glib/src/glib_docs.xml
@@ -489,7 +489,10 @@ than second arg, zero for equal, greater zero if first arg is
greater than second arg).
If two array elements compare equal, their order in the sorted array
-is undefined.
+is undefined. If you want equal elements to keep their order &#8211; i.e.
+you want a stable sort &#8211; you can write a comparison function that,
+if two elements would otherwise compare equal, compares them by
+their addresses.
</description>
<parameters>
@@ -1489,185 +1492,450 @@ program.
<function name="g_atomic_int_add">
<description>
-Atomically adds @val to the integer pointed to by @atomic.
-Also acts as a memory barrier.
+Atomically adds @val to the value of @atomic.
+
+Think of this operation as an atomic version of
+<literal>{ tmp = *atomic; * atomic += @val; return tmp; }</literal>
+
+This call acts as a full compiler and hardware memory barrier.
Since: 2.4
</description>
<parameters>
<parameter name="atomic">
-<parameter_description> a pointer to an integer
+<parameter_description> a pointer to a #gint or #guint
</parameter_description>
</parameter>
<parameter name="val">
-<parameter_description> the value to add to * atomic
+<parameter_description> the value to add
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the value of @atomic before the add, signed
+
+</return>
+</function>
+
+<function name="g_atomic_int_and">
+<description>
+Performs an atomic bitwise 'and' of the value of @atomic and @val,
+storing the result back in @atomic.
+
+This call acts as a full compiler and hardware memory barrier.
+
+Think of this operation as an atomic version of
+<literal>{ tmp = *atomic; * atomic &= @val; return tmp; }</literal>
+
+Since: 2.30
+
+</description>
+<parameters>
+<parameter name="atomic">
+<parameter_description> a pointer to a #gint or #guint
+</parameter_description>
+</parameter>
+<parameter name="val">
+<parameter_description> the value to 'and'
+</parameter_description>
+</parameter>
+</parameters>
+<return> the value of @atomic before the operation, unsigned
+
+</return>
</function>
<function name="g_atomic_int_compare_and_exchange">
<description>
-Compares @oldval with the integer pointed to by @atomic and
-if they are equal, atomically exchanges * atomic with @newval.
-Also acts as a memory barrier.
+Compares @atomic to @oldval and, if equal, sets it to @newval.
+If @atomic was not equal to @oldval then no change occurs.
+
+This compare and exchange is done atomically.
+
+Think of this operation as an atomic version of
+<literal>{ if (* atomic == @oldval) { * atomic = @newval; return TRUE; } else return FALSE; }</literal>
+
+This call acts as a full compiler and hardware memory barrier.
Since: 2.4
</description>
<parameters>
<parameter name="atomic">
-<parameter_description> a pointer to an integer
+<parameter_description> a pointer to a #gint or #guint
</parameter_description>
</parameter>
<parameter name="oldval">
-<parameter_description> the assumed old value of * atomic
+<parameter_description> the value to compare with
</parameter_description>
</parameter>
<parameter name="newval">
-<parameter_description> the new value of * atomic
+<parameter_description> the value to conditionally replace with
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the exchange took place
+
+</return>
+</function>
+
+<function name="g_atomic_int_dec_and_test">
+<description>
+Decrements the value of @atomic by 1.
+
+Think of this operation as an atomic version of
+<literal>{ * atomic -= 1; return (* atomic == 0); }</literal>
+
+This call acts as a full compiler and hardware memory barrier.
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="atomic">
+<parameter_description> a pointer to a #gint or #guint
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE, if * atomic was equal @oldval. %FALSE otherwise.
+<return> %TRUE if the resultant value is zero
</return>
</function>
<function name="g_atomic_int_exchange_and_add">
<description>
-Atomically adds @val to the integer pointed to by @atomic.
-It returns the value of * atomic just before the addition
-took place. Also acts as a memory barrier.
+This function existed before g_atomic_int_add() returned the prior
+value of the integer (which it now does). It is retained only for
+compatibility reasons. Don't use this function in new code.
Since: 2.4
+Deprecated: 2.30: Use g_atomic_int_add() instead.
</description>
<parameters>
<parameter name="atomic">
-<parameter_description> a pointer to an integer
+<parameter_description> a pointer to a #gint
</parameter_description>
</parameter>
<parameter name="val">
-<parameter_description> the value to add to * atomic
+<parameter_description> the value to add
</parameter_description>
</parameter>
</parameters>
-<return> the value of * atomic before the addition.
-
+<return> the value of @atomic before the add, signed
</return>
</function>
<function name="g_atomic_int_get">
<description>
-Reads the value of the integer pointed to by @atomic.
-Also acts as a memory barrier.
+Gets the current value of @atomic.
+
+This call acts as a full compiler and hardware
+memory barrier (before the get).
Since: 2.4
</description>
<parameters>
<parameter name="atomic">
-<parameter_description> a pointer to an integer
+<parameter_description> a pointer to a #gint or #guint
</parameter_description>
</parameter>
</parameters>
-<return> the value of * atomic
+<return> the value of the integer
+
+</return>
+</function>
+
+<function name="g_atomic_int_inc">
+<description>
+Increments the value of @atomic by 1.
+
+Think of this operation as an atomic version of
+<literal>{ * atomic += 1; }</literal>
+
+This call acts as a full compiler and hardware memory barrier.
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="atomic">
+<parameter_description> a pointer to a #gint or #guint
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_atomic_int_or">
+<description>
+Performs an atomic bitwise 'or' of the value of @atomic and @val,
+storing the result back in @atomic.
+
+Think of this operation as an atomic version of
+<literal>{ tmp = *atomic; * atomic |= @val; return tmp; }</literal>
+
+This call acts as a full compiler and hardware memory barrier.
+
+Since: 2.30
+
+</description>
+<parameters>
+<parameter name="atomic">
+<parameter_description> a pointer to a #gint or #guint
+</parameter_description>
+</parameter>
+<parameter name="val">
+<parameter_description> the value to 'or'
+</parameter_description>
+</parameter>
+</parameters>
+<return> the value of @atomic before the operation, unsigned
</return>
</function>
<function name="g_atomic_int_set">
<description>
-Sets the value of the integer pointed to by @atomic.
-Also acts as a memory barrier.
+Sets the value of @atomic to @newval.
-Since: 2.10
+This call acts as a full compiler and hardware
+memory barrier (after the set).
+
+Since: 2.4
</description>
<parameters>
<parameter name="atomic">
-<parameter_description> a pointer to an integer
+<parameter_description> a pointer to a #gint or #guint
</parameter_description>
</parameter>
<parameter name="newval">
-<parameter_description> the new value
+<parameter_description> a new value to store
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
+<function name="g_atomic_int_xor">
+<description>
+Performs an atomic bitwise 'xor' of the value of @atomic and @val,
+storing the result back in @atomic.
+
+Think of this operation as an atomic version of
+<literal>{ tmp = *atomic; * atomic ^= @val; return tmp; }</literal>
+
+This call acts as a full compiler and hardware memory barrier.
+
+Since: 2.30
+
+</description>
+<parameters>
+<parameter name="atomic">
+<parameter_description> a pointer to a #gint or #guint
+</parameter_description>
+</parameter>
+<parameter name="val">
+<parameter_description> the value to 'xor'
+</parameter_description>
+</parameter>
+</parameters>
+<return> the value of @atomic before the operation, unsigned
+
+</return>
+</function>
+
+<function name="g_atomic_pointer_add">
+<description>
+Atomically adds @val to the value of @atomic.
+
+Think of this operation as an atomic version of
+<literal>{ tmp = *atomic; * atomic += @val; return tmp; }</literal>
+
+This call acts as a full compiler and hardware memory barrier.
+
+Since: 2.30
+
+</description>
+<parameters>
+<parameter name="atomic">
+<parameter_description> a pointer to a #gpointer-sized value
+</parameter_description>
+</parameter>
+<parameter name="val">
+<parameter_description> the value to add
+</parameter_description>
+</parameter>
+</parameters>
+<return> the value of @atomic before the add, signed
+
+</return>
+</function>
+
+<function name="g_atomic_pointer_and">
+<description>
+Performs an atomic bitwise 'and' of the value of @atomic and @val,
+storing the result back in @atomic.
+
+Think of this operation as an atomic version of
+<literal>{ tmp = *atomic; * atomic &= @val; return tmp; }</literal>
+
+This call acts as a full compiler and hardware memory barrier.
+
+Since: 2.30
+
+</description>
+<parameters>
+<parameter name="atomic">
+<parameter_description> a pointer to a #gpointer-sized value
+</parameter_description>
+</parameter>
+<parameter name="val">
+<parameter_description> the value to 'and'
+</parameter_description>
+</parameter>
+</parameters>
+<return> the value of @atomic before the operation, unsigned
+
+</return>
+</function>
+
<function name="g_atomic_pointer_compare_and_exchange">
<description>
-Compares @oldval with the pointer pointed to by @atomic and
-if they are equal, atomically exchanges * atomic with @newval.
-Also acts as a memory barrier.
+Compares @atomic to @oldval and, if equal, sets it to @newval.
+If @atomic was not equal to @oldval then no change occurs.
+
+This compare and exchange is done atomically.
+
+Think of this operation as an atomic version of
+<literal>{ if (* atomic == @oldval) { * atomic = @newval; return TRUE; } else return FALSE; }</literal>
+
+This call acts as a full compiler and hardware memory barrier.
Since: 2.4
</description>
<parameters>
<parameter name="atomic">
-<parameter_description> a pointer to a #gpointer
+<parameter_description> a pointer to a #gpointer-sized value
</parameter_description>
</parameter>
<parameter name="oldval">
-<parameter_description> the assumed old value of * atomic
+<parameter_description> the value to compare with
</parameter_description>
</parameter>
<parameter name="newval">
-<parameter_description> the new value of * atomic
+<parameter_description> the value to conditionally replace with
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE, if * atomic was equal @oldval. %FALSE otherwise.
+<return> %TRUE if the exchange took place
</return>
</function>
<function name="g_atomic_pointer_get">
<description>
-Reads the value of the pointer pointed to by @atomic.
-Also acts as a memory barrier.
+Gets the current value of @atomic.
+
+This call acts as a full compiler and hardware
+memory barrier (before the get).
Since: 2.4
</description>
<parameters>
<parameter name="atomic">
-<parameter_description> a pointer to a #gpointer.
+<parameter_description> a pointer to a #gpointer-sized value
</parameter_description>
</parameter>
</parameters>
-<return> the value to add to * atomic
+<return> the value of the pointer
+
+</return>
+</function>
+
+<function name="g_atomic_pointer_or">
+<description>
+Performs an atomic bitwise 'or' of the value of @atomic and @val,
+storing the result back in @atomic.
+
+Think of this operation as an atomic version of
+<literal>{ tmp = *atomic; * atomic |= @val; return tmp; }</literal>
+
+This call acts as a full compiler and hardware memory barrier.
+
+Since: 2.30
+
+</description>
+<parameters>
+<parameter name="atomic">
+<parameter_description> a pointer to a #gpointer-sized value
+</parameter_description>
+</parameter>
+<parameter name="val">
+<parameter_description> the value to 'or'
+</parameter_description>
+</parameter>
+</parameters>
+<return> the value of @atomic before the operation, unsigned
</return>
</function>
<function name="g_atomic_pointer_set">
<description>
-Sets the value of the pointer pointed to by @atomic.
-Also acts as a memory barrier.
+Sets the value of @atomic to @newval.
-Since: 2.10
+This call acts as a full compiler and hardware
+memory barrier (after the set).
+
+Since: 2.4
</description>
<parameters>
<parameter name="atomic">
-<parameter_description> a pointer to a #gpointer
+<parameter_description> a pointer to a #gpointer-sized value
</parameter_description>
</parameter>
<parameter name="newval">
-<parameter_description> the new value
+<parameter_description> a new value to store
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
+<function name="g_atomic_pointer_xor">
+<description>
+Performs an atomic bitwise 'xor' of the value of @atomic and @val,
+storing the result back in @atomic.
+
+Think of this operation as an atomic version of
+<literal>{ tmp = *atomic; * atomic ^= @val; return tmp; }</literal>
+
+This call acts as a full compiler and hardware memory barrier.
+
+Since: 2.30
+
+</description>
+<parameters>
+<parameter name="atomic">
+<parameter_description> a pointer to a #gpointer-sized value
+</parameter_description>
+</parameter>
+<parameter name="val">
+<parameter_description> the value to 'xor'
+</parameter_description>
+</parameter>
+</parameters>
+<return> the value of @atomic before the operation, unsigned
+
+</return>
+</function>
+
<function name="g_base64_decode">
<description>
Decode a sequence of Base-64 encoded text into binary data
@@ -1685,7 +1953,8 @@ Since: 2.12
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated buffer containing the binary data
+<return>
+newly allocated buffer containing the binary data
that @text represents. The returned buffer must
be freed with g_free().
@@ -1702,7 +1971,8 @@ Since: 2.20
</description>
<parameters>
<parameter name="text">
-<parameter_description> zero-terminated string with base64 text to decode
+<parameter_description> zero-terminated
+string with base64 text to decode
</parameter_description>
</parameter>
<parameter name="out_len">
@@ -1775,8 +2045,8 @@ Since: 2.12
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated, zero-terminated Base-64 encoded
-string representing @data. The returned string must
+<return> a newly allocated, zero-terminated Base-64
+encoded string representing @data. The returned string must
be freed with g_free().
</return>
@@ -1890,6 +2160,98 @@ this function which returns a pointer into the argument.
</return>
</function>
+<function name="g_binding_get_flags">
+<description>
+Retrieves the flags passed when constructing the #GBinding
+
+Since: 2.26
+
+</description>
+<parameters>
+<parameter name="binding">
+<parameter_description> a #GBinding
+</parameter_description>
+</parameter>
+</parameters>
+<return> the #GBindingFlags used by the #GBinding
+
+</return>
+</function>
+
+<function name="g_binding_get_source">
+<description>
+Retrieves the #GObject instance used as the source of the binding
+
+Since: 2.26
+
+</description>
+<parameters>
+<parameter name="binding">
+<parameter_description> a #GBinding
+</parameter_description>
+</parameter>
+</parameters>
+<return> the source #GObject
+
+</return>
+</function>
+
+<function name="g_binding_get_source_property">
+<description>
+Retrieves the name of the property of #GBinding:source used as the source
+of the binding
+
+Since: 2.26
+
+</description>
+<parameters>
+<parameter name="binding">
+<parameter_description> a #GBinding
+</parameter_description>
+</parameter>
+</parameters>
+<return> the name of the source property
+
+</return>
+</function>
+
+<function name="g_binding_get_target">
+<description>
+Retrieves the #GObject instance used as the target of the binding
+
+Since: 2.26
+
+</description>
+<parameters>
+<parameter name="binding">
+<parameter_description> a #GBinding
+</parameter_description>
+</parameter>
+</parameters>
+<return> the target #GObject
+
+</return>
+</function>
+
+<function name="g_binding_get_target_property">
+<description>
+Retrieves the name of the property of #GBinding:target used as the target
+of the binding
+
+Since: 2.26
+
+</description>
+<parameters>
+<parameter name="binding">
+<parameter_description> a #GBinding
+</parameter_description>
+</parameter>
+</parameters>
+<return> the name of the target property
+
+</return>
+</function>
+
<function name="g_bit_lock">
<description>
Sets the indicated @lock_bit in @address. If the bit is already
@@ -1922,6 +2284,70 @@ Since: 2.24
<return></return>
</function>
+<function name="g_bit_nth_lsf">
+<description>
+Find the position of the first bit set in @mask, searching
+from (but not including) @nth_bit upwards. Bits are numbered
+from 0 (least significant) to sizeof(#gulong) * 8 - 1 (31 or 63,
+usually). To start searching from the 0th bit, set @nth_bit to -1.
+
+
+</description>
+<parameters>
+<parameter name="mask">
+<parameter_description> a #gulong containing flags
+</parameter_description>
+</parameter>
+<parameter name="nth_bit">
+<parameter_description> the index of the bit to start the search from
+</parameter_description>
+</parameter>
+</parameters>
+<return> the index of the first bit set which is higher than @nth_bit
+</return>
+</function>
+
+<function name="g_bit_nth_msf">
+<description>
+Find the position of the first bit set in @mask, searching
+from (but not including) @nth_bit downwards. Bits are numbered
+from 0 (least significant) to sizeof(#gulong) * 8 - 1 (31 or 63,
+usually). To start searching from the last bit, set @nth_bit to
+-1 or GLIB_SIZEOF_LONG * 8.
+
+
+</description>
+<parameters>
+<parameter name="mask">
+<parameter_description> a #gulong containing flags
+</parameter_description>
+</parameter>
+<parameter name="nth_bit">
+<parameter_description> the index of the bit to start the search from
+</parameter_description>
+</parameter>
+</parameters>
+<return> the index of the first bit set which is lower than @nth_bit
+</return>
+</function>
+
+<function name="g_bit_storage">
+<description>
+Gets the number of bits used to hold @number,
+e.g. if @number is 4, 3 bits are needed.
+
+
+</description>
+<parameters>
+<parameter name="number">
+<parameter_description> a #guint
+</parameter_description>
+</parameter>
+</parameters>
+<return> the number of bits used to hold @number
+</return>
+</function>
+
<function name="g_bit_trylock">
<description>
Sets the indicated @lock_bit in @address, returning %TRUE if
@@ -3227,6 +3653,70 @@ Since: 2.12
</return>
</function>
+<function name="g_boxed_copy">
+<description>
+Provide a copy of a boxed structure @src_boxed which is of type @boxed_type.
+
+
+</description>
+<parameters>
+<parameter name="boxed_type">
+<parameter_description> The type of @src_boxed.
+</parameter_description>
+</parameter>
+<parameter name="src_boxed">
+<parameter_description> The boxed structure to be copied.
+</parameter_description>
+</parameter>
+</parameters>
+<return> The newly created copy of the boxed structure.
+</return>
+</function>
+
+<function name="g_boxed_free">
+<description>
+Free the boxed structure @boxed which is of type @boxed_type.
+
+</description>
+<parameters>
+<parameter name="boxed_type">
+<parameter_description> The type of @boxed.
+</parameter_description>
+</parameter>
+<parameter name="boxed">
+<parameter_description> The boxed structure to be freed.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_boxed_type_register_static">
+<description>
+This function creates a new %G_TYPE_BOXED derived type id for a new
+boxed type with name @name. Boxed type handling functions have to be
+provided to copy and free opaque boxed structures of this type.
+
+
+</description>
+<parameters>
+<parameter name="name">
+<parameter_description> Name of the new boxed type.
+</parameter_description>
+</parameter>
+<parameter name="boxed_copy">
+<parameter_description> Boxed structure copy function.
+</parameter_description>
+</parameter>
+<parameter name="boxed_free">
+<parameter_description> Boxed structure free function.
+</parameter_description>
+</parameter>
+</parameters>
+<return> New %G_TYPE_BOXED derived type id for @name.
+</return>
+</function>
+
<function name="g_build_filename">
<description>
Creates a filename from a series of elements using the correct
@@ -3570,7 +4060,10 @@ arg is less than second arg, zero for equal, greater than zero if
first arg is greater than second arg).
If two array elements compare equal, their order in the sorted array
-is undefined.
+is undefined. If you want equal elements to keep their order &#8211; i.e.
+you want a stable sort &#8211; you can write a comparison function that,
+if two elements would otherwise compare equal, compares them by
+their addresses.
</description>
<parameters>
@@ -3793,3086 +4286,3160 @@ instead
<return></return>
</function>
-<function name="g_chdir">
+<function name="g_cclosure_marshal_BOOLEAN__FLAGS">
<description>
-A wrapper for the POSIX chdir() function. The function changes the
-current directory of the process to @path.
-
-See your C library manual for more details about chdir().
-
-Since: 2.8
+A marshaller for a #GCClosure with a callback of type
+<literal>gboolean (*callback) (gpointer instance, gint arg1, gpointer user_data)</literal> where the #gint parameter
+denotes a flags type.
</description>
<parameters>
-<parameter name="path">
-<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows)
+<parameter name="closure">
+<parameter_description> the #GClosure to which the marshaller belongs
+</parameter_description>
+</parameter>
+<parameter name="return_value">
+<parameter_description> a #GValue which can store the returned #gboolean
+</parameter_description>
+</parameter>
+<parameter name="n_param_values">
+<parameter_description> 2
+</parameter_description>
+</parameter>
+<parameter name="param_values">
+<parameter_description> a #GValue array holding instance and arg1
+</parameter_description>
+</parameter>
+<parameter name="invocation_hint">
+<parameter_description> the invocation hint given as the last argument
+to g_closure_invoke()
+</parameter_description>
+</parameter>
+<parameter name="marshal_data">
+<parameter_description> additional data specified when registering the marshaller
</parameter_description>
</parameter>
</parameters>
-<return> 0 on success, -1 if an error occurred.
-
-</return>
+<return></return>
</function>
-<function name="g_checksum_copy">
+<function name="g_cclosure_marshal_BOOLEAN__OBJECT_BOXED_BOXED">
<description>
-Copies a #GChecksum. If @checksum has been closed, by calling
-g_checksum_get_string() or g_checksum_get_digest(), the copied
-checksum will be closed as well.
+A marshaller for a #GCClosure with a callback of type
+<literal>gboolean (*callback) (gpointer instance, GBoxed *arg1, GBoxed *arg2, gpointer user_data)</literal>.
-Since: 2.16
+Since: 2.26
</description>
<parameters>
-<parameter name="checksum">
-<parameter_description> the #GChecksum to copy
+<parameter name="closure">
+<parameter_description> the #GClosure to which the marshaller belongs
+</parameter_description>
+</parameter>
+<parameter name="return_value">
+<parameter_description> a #GValue, which can store the returned string
+</parameter_description>
+</parameter>
+<parameter name="n_param_values">
+<parameter_description> 3
+</parameter_description>
+</parameter>
+<parameter name="param_values">
+<parameter_description> a #GValue array holding instance, arg1 and arg2
+</parameter_description>
+</parameter>
+<parameter name="invocation_hint">
+<parameter_description> the invocation hint given as the last argument
+to g_closure_invoke()
+</parameter_description>
+</parameter>
+<parameter name="marshal_data">
+<parameter_description> additional data specified when registering the marshaller
</parameter_description>
</parameter>
</parameters>
-<return> the copy of the passed #GChecksum. Use g_checksum_free()
-when finished using it.
-
-</return>
+<return></return>
</function>
-<function name="g_checksum_free">
+<function name="g_cclosure_marshal_BOOL__FLAGS">
<description>
-Frees the memory allocated for @checksum.
-
-Since: 2.16
+Another name for g_cclosure_marshal_BOOLEAN__FLAGS().
</description>
<parameters>
-<parameter name="checksum">
-<parameter_description> a #GChecksum
-</parameter_description>
-</parameter>
</parameters>
<return></return>
</function>
-<function name="g_checksum_get_digest">
+<function name="g_cclosure_marshal_STRING__OBJECT_POINTER">
<description>
-Gets the digest from @checksum as a raw binary vector and places it
-into @buffer. The size of the digest depends on the type of checksum.
-
-Once this function has been called, the #GChecksum is closed and can
-no longer be updated with g_checksum_update().
-
-Since: 2.16
+A marshaller for a #GCClosure with a callback of type
+<literal>gchar* (*callback) (gpointer instance, GObject *arg1, gpointer arg2, gpointer user_data)</literal>.
</description>
<parameters>
-<parameter name="checksum">
-<parameter_description> a #GChecksum
+<parameter name="closure">
+<parameter_description> the #GClosure to which the marshaller belongs
</parameter_description>
</parameter>
-<parameter name="buffer">
-<parameter_description> output buffer
+<parameter name="return_value">
+<parameter_description> a #GValue, which can store the returned string
</parameter_description>
</parameter>
-<parameter name="digest_len">
-<parameter_description> an inout parameter. The caller initializes it to the size of @buffer.
-After the call it contains the length of the digest.
+<parameter name="n_param_values">
+<parameter_description> 3
+</parameter_description>
+</parameter>
+<parameter name="param_values">
+<parameter_description> a #GValue array holding instance, arg1 and arg2
+</parameter_description>
+</parameter>
+<parameter name="invocation_hint">
+<parameter_description> the invocation hint given as the last argument
+to g_closure_invoke()
+</parameter_description>
+</parameter>
+<parameter name="marshal_data">
+<parameter_description> additional data specified when registering the marshaller
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_checksum_get_string">
+<function name="g_cclosure_marshal_VOID__BOOLEAN">
<description>
-Gets the digest as an hexadecimal string.
-
-Once this function has been called the #GChecksum can no longer be
-updated with g_checksum_update().
-
-The hexadecimal characters will be lower case.
-
-Since: 2.16
+A marshaller for a #GCClosure with a callback of type
+<literal>void (*callback) (gpointer instance, gboolean arg1, gpointer user_data)</literal>.
</description>
<parameters>
-<parameter name="checksum">
-<parameter_description> a #GChecksum
+<parameter name="closure">
+<parameter_description> the #GClosure to which the marshaller belongs
+</parameter_description>
+</parameter>
+<parameter name="return_value">
+<parameter_description> ignored
+</parameter_description>
+</parameter>
+<parameter name="n_param_values">
+<parameter_description> 2
+</parameter_description>
+</parameter>
+<parameter name="param_values">
+<parameter_description> a #GValue array holding the instance and the #gboolean parameter
+</parameter_description>
+</parameter>
+<parameter name="invocation_hint">
+<parameter_description> the invocation hint given as the last argument
+to g_closure_invoke()
+</parameter_description>
+</parameter>
+<parameter name="marshal_data">
+<parameter_description> additional data specified when registering the marshaller
</parameter_description>
</parameter>
</parameters>
-<return> the hexadecimal representation of the checksum. The
-returned string is owned by the checksum and should not be modified
-or freed.
-
-</return>
+<return></return>
</function>
-<function name="g_checksum_new">
+<function name="g_cclosure_marshal_VOID__BOXED">
<description>
-Creates a new #GChecksum, using the checksum algorithm @checksum_type.
-If the @checksum_type is not known, %NULL is returned.
-A #GChecksum can be used to compute the checksum, or digest, of an
-arbitrary binary blob, using different hashing algorithms.
-
-A #GChecksum works by feeding a binary blob through g_checksum_update()
-until there is data to be checked; the digest can then be extracted
-using g_checksum_get_string(), which will return the checksum as a
-hexadecimal string; or g_checksum_get_digest(), which will return a
-vector of raw bytes. Once either g_checksum_get_string() or
-g_checksum_get_digest() have been called on a #GChecksum, the checksum
-will be closed and it won't be possible to call g_checksum_update()
-on it anymore.
-
-Since: 2.16
+A marshaller for a #GCClosure with a callback of type
+<literal>void (*callback) (gpointer instance, GBoxed *arg1, gpointer user_data)</literal>.
</description>
<parameters>
-<parameter name="checksum_type">
-<parameter_description> the desired type of checksum
+<parameter name="closure">
+<parameter_description> the #GClosure to which the marshaller belongs
+</parameter_description>
+</parameter>
+<parameter name="return_value">
+<parameter_description> ignored
+</parameter_description>
+</parameter>
+<parameter name="n_param_values">
+<parameter_description> 2
+</parameter_description>
+</parameter>
+<parameter name="param_values">
+<parameter_description> a #GValue array holding the instance and the #GBoxed* parameter
+</parameter_description>
+</parameter>
+<parameter name="invocation_hint">
+<parameter_description> the invocation hint given as the last argument
+to g_closure_invoke()
+</parameter_description>
+</parameter>
+<parameter name="marshal_data">
+<parameter_description> additional data specified when registering the marshaller
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #GChecksum, or %NULL.
-Use g_checksum_free() to free the memory allocated by it.
-
-</return>
+<return></return>
</function>
-<function name="g_checksum_reset">
+<function name="g_cclosure_marshal_VOID__CHAR">
<description>
-Resets the state of the @checksum back to its initial state.
-
-Since: 2.18
+A marshaller for a #GCClosure with a callback of type
+<literal>void (*callback) (gpointer instance, gchar arg1, gpointer user_data)</literal>.
</description>
<parameters>
-<parameter name="checksum">
-<parameter_description> the #GChecksum to reset
+<parameter name="closure">
+<parameter_description> the #GClosure to which the marshaller belongs
+</parameter_description>
+</parameter>
+<parameter name="return_value">
+<parameter_description> ignored
+</parameter_description>
+</parameter>
+<parameter name="n_param_values">
+<parameter_description> 2
+</parameter_description>
+</parameter>
+<parameter name="param_values">
+<parameter_description> a #GValue array holding the instance and the #gchar parameter
+</parameter_description>
+</parameter>
+<parameter name="invocation_hint">
+<parameter_description> the invocation hint given as the last argument
+to g_closure_invoke()
+</parameter_description>
+</parameter>
+<parameter name="marshal_data">
+<parameter_description> additional data specified when registering the marshaller
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_checksum_type_get_length">
+<function name="g_cclosure_marshal_VOID__DOUBLE">
<description>
-Gets the length in bytes of digests of type @checksum_type
-
-Since: 2.16
+A marshaller for a #GCClosure with a callback of type
+<literal>void (*callback) (gpointer instance, gdouble arg1, gpointer user_data)</literal>.
</description>
<parameters>
-<parameter name="checksum_type">
-<parameter_description> a #GChecksumType
+<parameter name="closure">
+<parameter_description> the #GClosure to which the marshaller belongs
+</parameter_description>
+</parameter>
+<parameter name="return_value">
+<parameter_description> ignored
+</parameter_description>
+</parameter>
+<parameter name="n_param_values">
+<parameter_description> 2
+</parameter_description>
+</parameter>
+<parameter name="param_values">
+<parameter_description> a #GValue array holding the instance and the #gdouble parameter
+</parameter_description>
+</parameter>
+<parameter name="invocation_hint">
+<parameter_description> the invocation hint given as the last argument
+to g_closure_invoke()
+</parameter_description>
+</parameter>
+<parameter name="marshal_data">
+<parameter_description> additional data specified when registering the marshaller
</parameter_description>
</parameter>
</parameters>
-<return> the checksum length, or -1 if @checksum_type is
-not supported.
-
-</return>
+<return></return>
</function>
-<function name="g_checksum_update">
+<function name="g_cclosure_marshal_VOID__ENUM">
<description>
-Feeds @data into an existing #GChecksum. The checksum must still be
-open, that is g_checksum_get_string() or g_checksum_get_digest() must
-not have been called on @checksum.
-
-Since: 2.16
+A marshaller for a #GCClosure with a callback of type
+<literal>void (*callback) (gpointer instance, gint arg1, gpointer user_data)</literal> where the #gint parameter denotes an enumeration type..
</description>
<parameters>
-<parameter name="checksum">
-<parameter_description> a #GChecksum
+<parameter name="closure">
+<parameter_description> the #GClosure to which the marshaller belongs
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> buffer used to compute the checksum
+<parameter name="return_value">
+<parameter_description> ignored
</parameter_description>
</parameter>
-<parameter name="length">
-<parameter_description> size of the buffer, or -1 if it is a null-terminated string.
+<parameter name="n_param_values">
+<parameter_description> 2
+</parameter_description>
+</parameter>
+<parameter name="param_values">
+<parameter_description> a #GValue array holding the instance and the enumeration parameter
+</parameter_description>
+</parameter>
+<parameter name="invocation_hint">
+<parameter_description> the invocation hint given as the last argument
+to g_closure_invoke()
+</parameter_description>
+</parameter>
+<parameter name="marshal_data">
+<parameter_description> additional data specified when registering the marshaller
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_child_watch_add">
+<function name="g_cclosure_marshal_VOID__FLAGS">
<description>
-Sets a function to be called when the child indicated by @pid
-exits, at a default priority, #G_PRIORITY_DEFAULT.
-
-If you obtain @pid from g_spawn_async() or g_spawn_async_with_pipes()
-you will need to pass #G_SPAWN_DO_NOT_REAP_CHILD as flag to
-the spawn function for the child watching to work.
-
-Note that on platforms where #GPid must be explicitly closed
-(see g_spawn_close_pid()) @pid must not be closed while the
-source is still active. Typically, you will want to call
-g_spawn_close_pid() in the callback function for the source.
-
-GLib supports only a single callback per process id.
-
-This internally creates a main loop source using
-g_child_watch_source_new() and attaches it to the main loop context
-using g_source_attach(). You can do these steps manually if you
-need greater control.
-
-Since: 2.4
+A marshaller for a #GCClosure with a callback of type
+<literal>void (*callback) (gpointer instance, gint arg1, gpointer user_data)</literal> where the #gint parameter denotes a flags type.
</description>
<parameters>
-<parameter name="pid">
-<parameter_description> process id to watch. On POSIX the pid of a child process. On
-Windows a handle for a process (which doesn't have to be a child).
+<parameter name="closure">
+<parameter_description> the #GClosure to which the marshaller belongs
</parameter_description>
</parameter>
-<parameter name="function">
-<parameter_description> function to call
+<parameter name="return_value">
+<parameter_description> ignored
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> data to pass to @function
+<parameter name="n_param_values">
+<parameter_description> 2
+</parameter_description>
+</parameter>
+<parameter name="param_values">
+<parameter_description> a #GValue array holding the instance and the flags parameter
+</parameter_description>
+</parameter>
+<parameter name="invocation_hint">
+<parameter_description> the invocation hint given as the last argument
+to g_closure_invoke()
+</parameter_description>
+</parameter>
+<parameter name="marshal_data">
+<parameter_description> additional data specified when registering the marshaller
</parameter_description>
</parameter>
</parameters>
-<return> the ID (greater than 0) of the event source.
-
-</return>
+<return></return>
</function>
-<function name="g_child_watch_add_full">
+<function name="g_cclosure_marshal_VOID__FLOAT">
<description>
-Sets a function to be called when the child indicated by @pid
-exits, at the priority @priority.
-
-If you obtain @pid from g_spawn_async() or g_spawn_async_with_pipes()
-you will need to pass #G_SPAWN_DO_NOT_REAP_CHILD as flag to
-the spawn function for the child watching to work.
-
-Note that on platforms where #GPid must be explicitly closed
-(see g_spawn_close_pid()) @pid must not be closed while the
-source is still active. Typically, you will want to call
-g_spawn_close_pid() in the callback function for the source.
-
-GLib supports only a single callback per process id.
-
-This internally creates a main loop source using
-g_child_watch_source_new() and attaches it to the main loop context
-using g_source_attach(). You can do these steps manually if you
-need greater control.
-
-Since: 2.4
+A marshaller for a #GCClosure with a callback of type
+<literal>void (*callback) (gpointer instance, gfloat arg1, gpointer user_data)</literal>.
</description>
<parameters>
-<parameter name="priority">
-<parameter_description> the priority of the idle source. Typically this will be in the
-range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE.
+<parameter name="closure">
+<parameter_description> the #GClosure to which the marshaller belongs
</parameter_description>
</parameter>
-<parameter name="pid">
-<parameter_description> process to watch. On POSIX the pid of a child process. On
-Windows a handle for a process (which doesn't have to be a child).
+<parameter name="return_value">
+<parameter_description> ignored
</parameter_description>
</parameter>
-<parameter name="function">
-<parameter_description> function to call
+<parameter name="n_param_values">
+<parameter_description> 2
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> data to pass to @function
+<parameter name="param_values">
+<parameter_description> a #GValue array holding the instance and the #gfloat parameter
</parameter_description>
</parameter>
-<parameter name="notify">
-<parameter_description> function to call when the idle is removed, or %NULL
+<parameter name="invocation_hint">
+<parameter_description> the invocation hint given as the last argument
+to g_closure_invoke()
+</parameter_description>
+</parameter>
+<parameter name="marshal_data">
+<parameter_description> additional data specified when registering the marshaller
</parameter_description>
</parameter>
</parameters>
-<return> the ID (greater than 0) of the event source.
-
-</return>
+<return></return>
</function>
-<function name="g_child_watch_source_new">
+<function name="g_cclosure_marshal_VOID__INT">
<description>
-Creates a new child_watch source.
-
-The source will not initially be associated with any #GMainContext
-and must be added to one with g_source_attach() before it will be
-executed.
-
-Note that child watch sources can only be used in conjunction with
-<literal>g_spawn...</literal> when the %G_SPAWN_DO_NOT_REAP_CHILD
-flag is used.
-
-Note that on platforms where #GPid must be explicitly closed
-(see g_spawn_close_pid()) @pid must not be closed while the
-source is still active. Typically, you will want to call
-g_spawn_close_pid() in the callback function for the source.
-
-Note further that using g_child_watch_source_new() is not
-compatible with calling <literal>waitpid(-1)</literal> in
-the application. Calling waitpid() for individual pids will
-still work fine.
-
-Since: 2.4
+A marshaller for a #GCClosure with a callback of type
+<literal>void (*callback) (gpointer instance, gint arg1, gpointer user_data)</literal>.
</description>
<parameters>
-<parameter name="pid">
-<parameter_description> process to watch. On POSIX the pid of a child process. On
-Windows a handle for a process (which doesn't have to be a child).
+<parameter name="closure">
+<parameter_description> the #GClosure to which the marshaller belongs
+</parameter_description>
+</parameter>
+<parameter name="return_value">
+<parameter_description> ignored
+</parameter_description>
+</parameter>
+<parameter name="n_param_values">
+<parameter_description> 2
+</parameter_description>
+</parameter>
+<parameter name="param_values">
+<parameter_description> a #GValue array holding the instance and the #gint parameter
+</parameter_description>
+</parameter>
+<parameter name="invocation_hint">
+<parameter_description> the invocation hint given as the last argument
+to g_closure_invoke()
+</parameter_description>
+</parameter>
+<parameter name="marshal_data">
+<parameter_description> additional data specified when registering the marshaller
</parameter_description>
</parameter>
</parameters>
-<return> the newly-created child watch source
-
-</return>
+<return></return>
</function>
-<function name="g_chmod">
+<function name="g_cclosure_marshal_VOID__LONG">
<description>
-A wrapper for the POSIX chmod() function. The chmod() function is
-used to set the permissions of a file system object.
-
-On Windows the file protection mechanism is not at all POSIX-like,
-and the underlying chmod() function in the C library just sets or
-clears the FAT-style READONLY attribute. It does not touch any
-ACL. Software that needs to manage file permissions on Windows
-exactly should use the Win32 API.
-
-See your C library manual for more details about chmod().
-
-Since: 2.8
+A marshaller for a #GCClosure with a callback of type
+<literal>void (*callback) (gpointer instance, glong arg1, gpointer user_data)</literal>.
</description>
<parameters>
-<parameter name="filename">
-<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows)
+<parameter name="closure">
+<parameter_description> the #GClosure to which the marshaller belongs
</parameter_description>
</parameter>
-<parameter name="mode">
-<parameter_description> as in chmod()
+<parameter name="return_value">
+<parameter_description> ignored
+</parameter_description>
+</parameter>
+<parameter name="n_param_values">
+<parameter_description> 2
+</parameter_description>
+</parameter>
+<parameter name="param_values">
+<parameter_description> a #GValue array holding the instance and the #glong parameter
+</parameter_description>
+</parameter>
+<parameter name="invocation_hint">
+<parameter_description> the invocation hint given as the last argument
+to g_closure_invoke()
+</parameter_description>
+</parameter>
+<parameter name="marshal_data">
+<parameter_description> additional data specified when registering the marshaller
</parameter_description>
</parameter>
</parameters>
-<return> zero if the operation succeeded, -1 on error.
-
-</return>
+<return></return>
</function>
-<function name="g_chunk_free">
+<function name="g_cclosure_marshal_VOID__OBJECT">
<description>
-A convenience macro to free an atom of memory from a #GMemChunk. It
-simply switches the arguments and calls g_mem_chunk_free() It is
-included simply to complement the other convenience macros,
-g_chunk_new() and g_chunk_new0().
-
-Deprecated:2.10: Use g_slice_free() instead
+A marshaller for a #GCClosure with a callback of type
+<literal>void (*callback) (gpointer instance, GObject *arg1, gpointer user_data)</literal>.
</description>
<parameters>
-<parameter name="mem">
-<parameter_description> a pointer to the atom to be freed.
+<parameter name="closure">
+<parameter_description> the #GClosure to which the marshaller belongs
</parameter_description>
</parameter>
-<parameter name="mem_chunk">
-<parameter_description> a #GMemChunk.
+<parameter name="return_value">
+<parameter_description> ignored
+</parameter_description>
+</parameter>
+<parameter name="n_param_values">
+<parameter_description> 2
+</parameter_description>
+</parameter>
+<parameter name="param_values">
+<parameter_description> a #GValue array holding the instance and the #GObject* parameter
+</parameter_description>
+</parameter>
+<parameter name="invocation_hint">
+<parameter_description> the invocation hint given as the last argument
+to g_closure_invoke()
+</parameter_description>
+</parameter>
+<parameter name="marshal_data">
+<parameter_description> additional data specified when registering the marshaller
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_chunk_new">
+<function name="g_cclosure_marshal_VOID__PARAM">
<description>
-A convenience macro to allocate an atom of memory from a #GMemChunk.
-It calls g_mem_chunk_alloc() and casts the returned atom to a
-pointer to the given type, avoiding a type cast in the source code.
-
-Deprecated:2.10: Use g_slice_new() instead
+A marshaller for a #GCClosure with a callback of type
+<literal>void (*callback) (gpointer instance, GParamSpec *arg1, gpointer user_data)</literal>.
</description>
<parameters>
-<parameter name="type">
-<parameter_description> the type of the #GMemChunk atoms, typically a structure name.
+<parameter name="closure">
+<parameter_description> the #GClosure to which the marshaller belongs
</parameter_description>
</parameter>
-<parameter name="chunk">
-<parameter_description> a #GMemChunk.
+<parameter name="return_value">
+<parameter_description> ignored
+</parameter_description>
+</parameter>
+<parameter name="n_param_values">
+<parameter_description> 2
+</parameter_description>
+</parameter>
+<parameter name="param_values">
+<parameter_description> a #GValue array holding the instance and the #GParamSpec* parameter
+</parameter_description>
+</parameter>
+<parameter name="invocation_hint">
+<parameter_description> the invocation hint given as the last argument
+to g_closure_invoke()
+</parameter_description>
+</parameter>
+<parameter name="marshal_data">
+<parameter_description> additional data specified when registering the marshaller
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to the allocated atom, cast to a pointer to
- type
-</return>
+<return></return>
</function>
-<function name="g_chunk_new0">
+<function name="g_cclosure_marshal_VOID__POINTER">
<description>
-A convenience macro to allocate an atom of memory from a #GMemChunk.
-It calls g_mem_chunk_alloc0() and casts the returned atom to a
-pointer to the given type, avoiding a type cast in the source code.
-
-Deprecated:2.10: Use g_slice_new0() instead
+A marshaller for a #GCClosure with a callback of type
+<literal>void (*callback) (gpointer instance, gpointer arg1, gpointer user_data)</literal>.
</description>
<parameters>
-<parameter name="type">
-<parameter_description> the type of the #GMemChunk atoms, typically a structure name.
+<parameter name="closure">
+<parameter_description> the #GClosure to which the marshaller belongs
</parameter_description>
</parameter>
-<parameter name="chunk">
-<parameter_description> a #GMemChunk.
+<parameter name="return_value">
+<parameter_description> ignored
+</parameter_description>
+</parameter>
+<parameter name="n_param_values">
+<parameter_description> 2
+</parameter_description>
+</parameter>
+<parameter name="param_values">
+<parameter_description> a #GValue array holding the instance and the #gpointer parameter
+</parameter_description>
+</parameter>
+<parameter name="invocation_hint">
+<parameter_description> the invocation hint given as the last argument
+to g_closure_invoke()
+</parameter_description>
+</parameter>
+<parameter name="marshal_data">
+<parameter_description> additional data specified when registering the marshaller
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to the allocated atom, cast to a pointer to
- type
-</return>
+<return></return>
</function>
-<function name="g_clear_error">
+<function name="g_cclosure_marshal_VOID__STRING">
<description>
-If @err is %NULL, does nothing. If @err is non-%NULL,
-calls g_error_free() on * err and sets * err to %NULL.
+A marshaller for a #GCClosure with a callback of type
+<literal>void (*callback) (gpointer instance, const gchar *arg1, gpointer user_data)</literal>.
</description>
<parameters>
-<parameter name="err">
-<parameter_description> a #GError return location
+<parameter name="closure">
+<parameter_description> the #GClosure to which the marshaller belongs
+</parameter_description>
+</parameter>
+<parameter name="return_value">
+<parameter_description> ignored
+</parameter_description>
+</parameter>
+<parameter name="n_param_values">
+<parameter_description> 2
+</parameter_description>
+</parameter>
+<parameter name="param_values">
+<parameter_description> a #GValue array holding the instance and the #gchar* parameter
+</parameter_description>
+</parameter>
+<parameter name="invocation_hint">
+<parameter_description> the invocation hint given as the last argument
+to g_closure_invoke()
+</parameter_description>
+</parameter>
+<parameter name="marshal_data">
+<parameter_description> additional data specified when registering the marshaller
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_completion_add_items">
+<function name="g_cclosure_marshal_VOID__UCHAR">
<description>
-Adds items to the #GCompletion.
-
-Deprecated: 2.26: Rarely used API
+A marshaller for a #GCClosure with a callback of type
+<literal>void (*callback) (gpointer instance, guchar arg1, gpointer user_data)</literal>.
</description>
<parameters>
-<parameter name="cmp">
-<parameter_description> the #GCompletion.
+<parameter name="closure">
+<parameter_description> the #GClosure to which the marshaller belongs
</parameter_description>
</parameter>
-<parameter name="items">
-<parameter_description> the list of items to add.
+<parameter name="return_value">
+<parameter_description> ignored
+</parameter_description>
+</parameter>
+<parameter name="n_param_values">
+<parameter_description> 2
+</parameter_description>
+</parameter>
+<parameter name="param_values">
+<parameter_description> a #GValue array holding the instance and the #guchar parameter
+</parameter_description>
+</parameter>
+<parameter name="invocation_hint">
+<parameter_description> the invocation hint given as the last argument
+to g_closure_invoke()
+</parameter_description>
+</parameter>
+<parameter name="marshal_data">
+<parameter_description> additional data specified when registering the marshaller
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_completion_clear_items">
+<function name="g_cclosure_marshal_VOID__UINT">
<description>
-Removes all items from the #GCompletion.
-
-Deprecated: 2.26: Rarely used API
+A marshaller for a #GCClosure with a callback of type
+<literal>void (*callback) (gpointer instance, guint arg1, gpointer user_data)</literal>.
</description>
<parameters>
-<parameter name="cmp">
-<parameter_description> the #GCompletion.
+<parameter name="closure">
+<parameter_description> the #GClosure to which the marshaller belongs
+</parameter_description>
+</parameter>
+<parameter name="return_value">
+<parameter_description> ignored
+</parameter_description>
+</parameter>
+<parameter name="n_param_values">
+<parameter_description> 2
+</parameter_description>
+</parameter>
+<parameter name="param_values">
+<parameter_description> a #GValue array holding the instance and the #guint parameter
+</parameter_description>
+</parameter>
+<parameter name="invocation_hint">
+<parameter_description> the invocation hint given as the last argument
+to g_closure_invoke()
+</parameter_description>
+</parameter>
+<parameter name="marshal_data">
+<parameter_description> additional data specified when registering the marshaller
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_completion_complete">
+<function name="g_cclosure_marshal_VOID__UINT_POINTER">
<description>
-Attempts to complete the string @prefix using the #GCompletion
-target items.
-
-Deprecated: 2.26: Rarely used API
+A marshaller for a #GCClosure with a callback of type
+<literal>void (*callback) (gpointer instance, guint arg1, gpointer arg2, gpointer user_data)</literal>.
</description>
<parameters>
-<parameter name="cmp">
-<parameter_description> the #GCompletion.
+<parameter name="closure">
+<parameter_description> the #GClosure to which the marshaller belongs
</parameter_description>
</parameter>
-<parameter name="prefix">
-<parameter_description> the prefix string, typically typed by the user, which is
-compared with each of the items.
+<parameter name="return_value">
+<parameter_description> ignored
</parameter_description>
</parameter>
-<parameter name="new_prefix">
-<parameter_description> if non-%NULL, returns the longest prefix which is
-common to all items that matched @prefix, or %NULL if
-no items matched @prefix. This string should be freed
-when no longer needed.
+<parameter name="n_param_values">
+<parameter_description> 3
+</parameter_description>
+</parameter>
+<parameter name="param_values">
+<parameter_description> a #GValue array holding instance, arg1 and arg2
+</parameter_description>
+</parameter>
+<parameter name="invocation_hint">
+<parameter_description> the invocation hint given as the last argument
+to g_closure_invoke()
+</parameter_description>
+</parameter>
+<parameter name="marshal_data">
+<parameter_description> additional data specified when registering the marshaller
</parameter_description>
</parameter>
</parameters>
-<return> the list of items whose strings begin with @prefix. This
-should not be changed.
-</return>
+<return></return>
</function>
-<function name="g_completion_complete_utf8">
+<function name="g_cclosure_marshal_VOID__ULONG">
<description>
-Attempts to complete the string @prefix using the #GCompletion target items.
-In contrast to g_completion_complete(), this function returns the largest common
-prefix that is a valid UTF-8 string, omitting a possible common partial
-character.
-
-You should use this function instead of g_completion_complete() if your
-items are UTF-8 strings.
-
-Since: 2.4
-
-Deprecated: 2.26: Rarely used API
+A marshaller for a #GCClosure with a callback of type
+<literal>void (*callback) (gpointer instance, gulong arg1, gpointer user_data)</literal>.
</description>
<parameters>
-<parameter name="cmp">
-<parameter_description> the #GCompletion
+<parameter name="closure">
+<parameter_description> the #GClosure to which the marshaller belongs
</parameter_description>
</parameter>
-<parameter name="prefix">
-<parameter_description> the prefix string, typically used by the user, which is compared
-with each of the items
+<parameter name="return_value">
+<parameter_description> ignored
</parameter_description>
</parameter>
-<parameter name="new_prefix">
-<parameter_description> if non-%NULL, returns the longest prefix which is common to all
-items that matched @prefix, or %NULL if no items matched @prefix.
-This string should be freed when no longer needed.
+<parameter name="n_param_values">
+<parameter_description> 2
+</parameter_description>
+</parameter>
+<parameter name="param_values">
+<parameter_description> a #GValue array holding the instance and the #gulong parameter
+</parameter_description>
+</parameter>
+<parameter name="invocation_hint">
+<parameter_description> the invocation hint given as the last argument
+to g_closure_invoke()
+</parameter_description>
+</parameter>
+<parameter name="marshal_data">
+<parameter_description> additional data specified when registering the marshaller
</parameter_description>
</parameter>
</parameters>
-<return> the list of items whose strings begin with @prefix. This should
-not be changed.
-
-</return>
+<return></return>
</function>
-<function name="g_completion_free">
+<function name="g_cclosure_marshal_VOID__VARIANT">
<description>
-Frees all memory used by the #GCompletion.
+A marshaller for a #GCClosure with a callback of type
+<literal>void (*callback) (gpointer instance, GVariant *arg1, gpointer user_data)</literal>.
-Deprecated: 2.26: Rarely used API
+Since: 2.26
</description>
<parameters>
-<parameter name="cmp">
-<parameter_description> the #GCompletion.
+<parameter name="closure">
+<parameter_description> the #GClosure to which the marshaller belongs
+</parameter_description>
+</parameter>
+<parameter name="return_value">
+<parameter_description> ignored
+</parameter_description>
+</parameter>
+<parameter name="n_param_values">
+<parameter_description> 2
+</parameter_description>
+</parameter>
+<parameter name="param_values">
+<parameter_description> a #GValue array holding the instance and the #GVariant* parameter
+</parameter_description>
+</parameter>
+<parameter name="invocation_hint">
+<parameter_description> the invocation hint given as the last argument
+to g_closure_invoke()
+</parameter_description>
+</parameter>
+<parameter name="marshal_data">
+<parameter_description> additional data specified when registering the marshaller
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_completion_new">
+<function name="g_cclosure_marshal_VOID__VOID">
<description>
-Creates a new #GCompletion.
+A marshaller for a #GCClosure with a callback of type
+<literal>void (*callback) (gpointer instance, gpointer user_data)</literal>.
</description>
<parameters>
-<parameter name="func">
-<parameter_description> the function to be called to return the string representing
-an item in the #GCompletion, or %NULL if strings are going to
-be used as the #GCompletion items.
+<parameter name="closure">
+<parameter_description> the #GClosure to which the marshaller belongs
</parameter_description>
</parameter>
-</parameters>
-<return> the new #GCompletion.
-</return>
-</function>
-
-<function name="g_completion_remove_items">
-<description>
-Removes items from a #GCompletion.
-
-Deprecated: 2.26: Rarely used API
-
-</description>
-<parameters>
-<parameter name="cmp">
-<parameter_description> the #GCompletion.
+<parameter name="return_value">
+<parameter_description> ignored
</parameter_description>
</parameter>
-<parameter name="items">
-<parameter_description> the items to remove.
+<parameter name="n_param_values">
+<parameter_description> 1
+</parameter_description>
+</parameter>
+<parameter name="param_values">
+<parameter_description> a #GValue array holding only the instance
+</parameter_description>
+</parameter>
+<parameter name="invocation_hint">
+<parameter_description> the invocation hint given as the last argument
+to g_closure_invoke()
+</parameter_description>
+</parameter>
+<parameter name="marshal_data">
+<parameter_description> additional data specified when registering the marshaller
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_completion_set_compare">
+<function name="g_cclosure_marshal_generic">
<description>
-Sets the function to use for string comparisons. The default string
-comparison function is strncmp().
+A generic marshaller function implemented via <ulink
+url="http://sourceware.org/libffi/">libffi</ulink>.
-Deprecated: 2.26: Rarely used API
+Since: 2.30
</description>
<parameters>
-<parameter name="cmp">
-<parameter_description> a #GCompletion.
+<parameter name="closure">
+<parameter_description> A #GClosure.
</parameter_description>
</parameter>
-<parameter name="strncmp_func">
-<parameter_description> the string comparison function.
+<parameter name="return_gvalue">
+<parameter_description> A #GValue to store the return value. May be %NULL
+if the callback of closure doesn't return a value.
+</parameter_description>
+</parameter>
+<parameter name="n_param_values">
+<parameter_description> The length of the @param_values array.
+</parameter_description>
+</parameter>
+<parameter name="param_values">
+<parameter_description> An array of #GValue<!-- -->s holding the arguments
+on which to invoke the callback of closure.
+</parameter_description>
+</parameter>
+<parameter name="invocation_hint">
+<parameter_description> The invocation hint given as the last argument to
+g_closure_invoke().
+</parameter_description>
+</parameter>
+<parameter name="marshal_data">
+<parameter_description> Additional data specified when registering the
+marshaller, see g_closure_set_marshal() and
+g_closure_set_meta_marshal()
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_compute_checksum_for_data">
+<function name="g_cclosure_new">
<description>
-Computes the checksum for a binary @data of @length. This is a
-convenience wrapper for g_checksum_new(), g_checksum_get_string()
-and g_checksum_free().
+Creates a new closure which invokes @callback_func with @user_data as
+the last parameter.
-The hexadecimal string returned will be in lower case.
-
-Since: 2.16
</description>
<parameters>
-<parameter name="checksum_type">
-<parameter_description> a #GChecksumType
+<parameter name="callback_func">
+<parameter_description> the function to invoke
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> binary blob to compute the digest of
+<parameter name="user_data">
+<parameter_description> user data to pass to @callback_func
</parameter_description>
</parameter>
-<parameter name="length">
-<parameter_description> length of @data
+<parameter name="destroy_data">
+<parameter_description> destroy notify to be called when @user_data is no longer used
</parameter_description>
</parameter>
</parameters>
-<return> the digest of the binary data as a string in hexadecimal.
-The returned string should be freed with g_free() when done using it.
-
+<return> a new #GCClosure
</return>
</function>
-<function name="g_compute_checksum_for_string">
+<function name="g_cclosure_new_object">
<description>
-Computes the checksum of a string.
+A variant of g_cclosure_new() which uses @object as @user_data and
+calls g_object_watch_closure() on @object and the created
+closure. This function is useful when you have a callback closely
+associated with a #GObject, and want the callback to no longer run
+after the object is is freed.
-The hexadecimal string returned will be in lower case.
-
-Since: 2.16
</description>
<parameters>
-<parameter name="checksum_type">
-<parameter_description> a #GChecksumType
-</parameter_description>
-</parameter>
-<parameter name="str">
-<parameter_description> the string to compute the checksum of
+<parameter name="callback_func">
+<parameter_description> the function to invoke
</parameter_description>
</parameter>
-<parameter name="length">
-<parameter_description> the length of the string, or -1 if the string is null-terminated.
+<parameter name="object">
+<parameter_description> a #GObject pointer to pass to @callback_func
</parameter_description>
</parameter>
</parameters>
-<return> the checksum as a hexadecimal string. The returned string
-should be freed with g_free() when done using it.
-
+<return> a new #GCClosure
</return>
</function>
-<function name="g_cond_broadcast">
+<function name="g_cclosure_new_object_swap">
<description>
-If threads are waiting for @cond, all of them are woken up. It is
-good practice to lock the same mutex as the waiting threads, while
-calling this function, though not required.
+A variant of g_cclosure_new_swap() which uses @object as @user_data
+and calls g_object_watch_closure() on @object and the created
+closure. This function is useful when you have a callback closely
+associated with a #GObject, and want the callback to no longer run
+after the object is is freed.
-This function can be used even if g_thread_init() has not yet been
-called, and, in that case, will do nothing.
</description>
<parameters>
-<parameter name="cond">
-<parameter_description> a #GCond.
+<parameter name="callback_func">
+<parameter_description> the function to invoke
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="g_cond_free">
-<description>
-Destroys the #GCond.
-
-</description>
-<parameters>
-<parameter name="cond">
-<parameter_description> a #GCond.
+<parameter name="object">
+<parameter_description> a #GObject pointer to pass to @callback_func
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a new #GCClosure
+</return>
</function>
-<function name="g_cond_new">
+<function name="g_cclosure_new_swap">
<description>
-Creates a new #GCond. This function will abort, if g_thread_init()
-has not been called yet.
+Creates a new closure which invokes @callback_func with @user_data as
+the first parameter.
+
</description>
<parameters>
+<parameter name="callback_func">
+<parameter_description> the function to invoke
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> user data to pass to @callback_func
+</parameter_description>
+</parameter>
+<parameter name="destroy_data">
+<parameter_description> destroy notify to be called when @user_data is no longer used
+</parameter_description>
+</parameter>
</parameters>
-<return> a new #GCond.
+<return> a new #GCClosure
</return>
</function>
-<function name="g_cond_signal">
+<function name="g_chdir">
<description>
-If threads are waiting for @cond, exactly one of them is woken up.
-It is good practice to hold the same lock as the waiting thread
-while calling this function, though not required.
+A wrapper for the POSIX chdir() function. The function changes the
+current directory of the process to @path.
-This function can be used even if g_thread_init() has not yet been
-called, and, in that case, will do nothing.
+See your C library manual for more details about chdir().
+
+Since: 2.8
</description>
<parameters>
-<parameter name="cond">
-<parameter_description> a #GCond.
+<parameter name="path">
+<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows)
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> 0 on success, -1 if an error occurred.
+
+</return>
</function>
-<function name="g_cond_timed_wait">
+<function name="g_checksum_copy">
<description>
-Waits until this thread is woken up on @cond, but not longer than
-until the time specified by @abs_time. The @mutex is unlocked before
-falling asleep and locked again before resuming.
-
-If @abs_time is %NULL, g_cond_timed_wait() acts like g_cond_wait().
-
-This function can be used even if g_thread_init() has not yet been
-called, and, in that case, will immediately return %TRUE.
+Copies a #GChecksum. If @checksum has been closed, by calling
+g_checksum_get_string() or g_checksum_get_digest(), the copied
+checksum will be closed as well.
-To easily calculate @abs_time a combination of g_get_current_time()
-and g_time_val_add() can be used.
+Since: 2.16
</description>
<parameters>
-<parameter name="cond">
-<parameter_description> a #GCond.
-</parameter_description>
-</parameter>
-<parameter name="mutex">
-<parameter_description> a #GMutex that is currently locked.
-</parameter_description>
-</parameter>
-<parameter name="abs_time">
-<parameter_description> a #GTimeVal, determining the final time.
+<parameter name="checksum">
+<parameter_description> the #GChecksum to copy
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @cond was signalled, or %FALSE on timeout.
+<return> the copy of the passed #GChecksum. Use g_checksum_free()
+when finished using it.
+
</return>
</function>
-<function name="g_cond_wait">
+<function name="g_checksum_free">
<description>
-Waits until this thread is woken up on @cond. The @mutex is unlocked
-before falling asleep and locked again before resuming.
+Frees the memory allocated for @checksum.
-This function can be used even if g_thread_init() has not yet been
-called, and, in that case, will immediately return.
+Since: 2.16
</description>
<parameters>
-<parameter name="cond">
-<parameter_description> a #GCond.
-</parameter_description>
-</parameter>
-<parameter name="mutex">
-<parameter_description> a #GMutex, that is currently locked.
+<parameter name="checksum">
+<parameter_description> a #GChecksum
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_convert">
+<function name="g_checksum_get_digest">
<description>
-Converts a string from one character set to another.
+Gets the digest from @checksum as a raw binary vector and places it
+into @buffer. The size of the digest depends on the type of checksum.
-Note that you should use g_iconv() for streaming
-conversions<footnoteref linkend="streaming-state"/>.
+Once this function has been called, the #GChecksum is closed and can
+no longer be updated with g_checksum_update().
+Since: 2.16
</description>
<parameters>
-<parameter name="str">
-<parameter_description> the string to convert
-</parameter_description>
-</parameter>
-<parameter name="len">
-<parameter_description> the length of the string, or -1 if the string is
-nul-terminated<footnote id="nul-unsafe">
- <para>
- Note that some encodings may allow nul bytes to
- occur inside strings. In that case, using -1 for
- the @len parameter is unsafe.
- </para>
- </footnote>.
-</parameter_description>
-</parameter>
-<parameter name="to_codeset">
-<parameter_description> name of character set into which to convert @str
-</parameter_description>
-</parameter>
-<parameter name="from_codeset">
-<parameter_description> character set of @str.
-</parameter_description>
-</parameter>
-<parameter name="bytes_read">
-<parameter_description> location to store the number of bytes in the
-input string that were successfully converted, or %NULL.
-Even if the conversion was successful, this may be
-less than @len if there were partial characters
-at the end of the input. If the error
-#G_CONVERT_ERROR_ILLEGAL_SEQUENCE occurs, the value
-stored will the byte offset after the last valid
-input sequence.
+<parameter name="checksum">
+<parameter_description> a #GChecksum
</parameter_description>
</parameter>
-<parameter name="bytes_written">
-<parameter_description> the number of bytes stored in the output buffer (not
-including the terminating nul).
+<parameter name="buffer">
+<parameter_description> output buffer
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> location to store the error occuring, or %NULL to ignore
-errors. Any of the errors in #GConvertError may occur.
+<parameter name="digest_len">
+<parameter_description> an inout parameter. The caller initializes it to the size of @buffer.
+After the call it contains the length of the digest.
</parameter_description>
</parameter>
</parameters>
-<return> If the conversion was successful, a newly allocated
-nul-terminated string, which must be freed with
-g_free(). Otherwise %NULL and @error will be set.
-</return>
+<return></return>
</function>
-<function name="g_convert_with_fallback">
+<function name="g_checksum_get_string">
<description>
-Converts a string from one character set to another, possibly
-including fallback sequences for characters not representable
-in the output. Note that it is not guaranteed that the specification
-for the fallback sequences in @fallback will be honored. Some
-systems may do an approximate conversion from @from_codeset
-to @to_codeset in their iconv() functions,
-in which case GLib will simply return that approximate conversion.
+Gets the digest as an hexadecimal string.
-Note that you should use g_iconv() for streaming
-conversions<footnoteref linkend="streaming-state"/>.
+Once this function has been called the #GChecksum can no longer be
+updated with g_checksum_update().
+
+The hexadecimal characters will be lower case.
+Since: 2.16
</description>
<parameters>
-<parameter name="str">
-<parameter_description> the string to convert
-</parameter_description>
-</parameter>
-<parameter name="len">
-<parameter_description> the length of the string, or -1 if the string is
-nul-terminated<footnoteref linkend="nul-unsafe"/>.
-</parameter_description>
-</parameter>
-<parameter name="to_codeset">
-<parameter_description> name of character set into which to convert @str
-</parameter_description>
-</parameter>
-<parameter name="from_codeset">
-<parameter_description> character set of @str.
-</parameter_description>
-</parameter>
-<parameter name="fallback">
-<parameter_description> UTF-8 string to use in place of character not
-present in the target encoding. (The string must be
-representable in the target encoding).
- If %NULL, characters not in the target encoding will
- be represented as Unicode escapes \uxxxx or \Uxxxxyyyy.
-</parameter_description>
-</parameter>
-<parameter name="bytes_read">
-<parameter_description> location to store the number of bytes in the
-input string that were successfully converted, or %NULL.
-Even if the conversion was successful, this may be
-less than @len if there were partial characters
-at the end of the input.
-</parameter_description>
-</parameter>
-<parameter name="bytes_written">
-<parameter_description> the number of bytes stored in the output buffer (not
-including the terminating nul).
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> location to store the error occuring, or %NULL to ignore
-errors. Any of the errors in #GConvertError may occur.
+<parameter name="checksum">
+<parameter_description> a #GChecksum
</parameter_description>
</parameter>
</parameters>
-<return> If the conversion was successful, a newly allocated
-nul-terminated string, which must be freed with
-g_free(). Otherwise %NULL and @error will be set.
+<return> the hexadecimal representation of the checksum. The
+returned string is owned by the checksum and should not be modified
+or freed.
+
</return>
</function>
-<function name="g_convert_with_iconv">
+<function name="g_checksum_new">
<description>
-Converts a string from one character set to another.
+Creates a new #GChecksum, using the checksum algorithm @checksum_type.
+If the @checksum_type is not known, %NULL is returned.
+A #GChecksum can be used to compute the checksum, or digest, of an
+arbitrary binary blob, using different hashing algorithms.
-Note that you should use g_iconv() for streaming
-conversions<footnote id="streaming-state">
-<para>
-Despite the fact that @byes_read can return information about partial
-characters, the <literal>g_convert_...</literal> functions
-are not generally suitable for streaming. If the underlying converter
-being used maintains internal state, then this won't be preserved
-across successive calls to g_convert(), g_convert_with_iconv() or
-g_convert_with_fallback(). (An example of this is the GNU C converter
-for CP1255 which does not emit a base character until it knows that
-the next character is not a mark that could combine with the base
-character.)
-</para>
-</footnote>.
+A #GChecksum works by feeding a binary blob through g_checksum_update()
+until there is data to be checked; the digest can then be extracted
+using g_checksum_get_string(), which will return the checksum as a
+hexadecimal string; or g_checksum_get_digest(), which will return a
+vector of raw bytes. Once either g_checksum_get_string() or
+g_checksum_get_digest() have been called on a #GChecksum, the checksum
+will be closed and it won't be possible to call g_checksum_update()
+on it anymore.
+Since: 2.16
</description>
<parameters>
-<parameter name="str">
-<parameter_description> the string to convert
-</parameter_description>
-</parameter>
-<parameter name="len">
-<parameter_description> the length of the string, or -1 if the string is
-nul-terminated<footnoteref linkend="nul-unsafe"/>.
-</parameter_description>
-</parameter>
-<parameter name="converter">
-<parameter_description> conversion descriptor from g_iconv_open()
-</parameter_description>
-</parameter>
-<parameter name="bytes_read">
-<parameter_description> location to store the number of bytes in the
-input string that were successfully converted, or %NULL.
-Even if the conversion was successful, this may be
-less than @len if there were partial characters
-at the end of the input. If the error
-#G_CONVERT_ERROR_ILLEGAL_SEQUENCE occurs, the value
-stored will the byte offset after the last valid
-input sequence.
-</parameter_description>
-</parameter>
-<parameter name="bytes_written">
-<parameter_description> the number of bytes stored in the output buffer (not
-including the terminating nul).
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> location to store the error occuring, or %NULL to ignore
-errors. Any of the errors in #GConvertError may occur.
+<parameter name="checksum_type">
+<parameter_description> the desired type of checksum
</parameter_description>
</parameter>
</parameters>
-<return> If the conversion was successful, a newly allocated
-nul-terminated string, which must be freed with
-g_free(). Otherwise %NULL and @error will be set.
+<return> the newly created #GChecksum, or %NULL.
+Use g_checksum_free() to free the memory allocated by it.
+
</return>
</function>
-<function name="g_creat">
+<function name="g_checksum_reset">
<description>
-A wrapper for the POSIX creat() function. The creat() function is
-used to convert a pathname into a file descriptor, creating a file
-if necessary.
-
-On POSIX systems file descriptors are implemented by the operating
-system. On Windows, it's the C library that implements creat() and
-file descriptors. The actual Windows API for opening files is
-different, see MSDN documentation for CreateFile(). The Win32 API
-uses file handles, which are more randomish integers, not small
-integers like file descriptors.
-
-Because file descriptors are specific to the C library on Windows,
-the file descriptor returned by this function makes sense only to
-functions in the same C library. Thus if the GLib-using code uses a
-different C library than GLib does, the file descriptor returned by
-this function cannot be passed to C library functions like write()
-or read().
-
-See your C library manual for more details about creat().
+Resets the state of the @checksum back to its initial state.
-Since: 2.8
+Since: 2.18
</description>
<parameters>
-<parameter name="filename">
-<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows)
-</parameter_description>
-</parameter>
-<parameter name="mode">
-<parameter_description> as in creat()
+<parameter name="checksum">
+<parameter_description> the #GChecksum to reset
</parameter_description>
</parameter>
</parameters>
-<return> a new file descriptor, or -1 if an error occurred. The
-return value can be used exactly like the return value from creat().
-
-</return>
+<return></return>
</function>
-<function name="g_datalist_clear">
+<function name="g_checksum_type_get_length">
<description>
-Frees all the data elements of the datalist. The data elements'
-destroy functions are called if they have been set.
+Gets the length in bytes of digests of type @checksum_type
+
+Since: 2.16
</description>
<parameters>
-<parameter name="datalist">
-<parameter_description> a datalist.
+<parameter name="checksum_type">
+<parameter_description> a #GChecksumType
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the checksum length, or -1 if @checksum_type is
+not supported.
+
+</return>
</function>
-<function name="g_datalist_foreach">
+<function name="g_checksum_update">
<description>
-Calls the given function for each data element of the datalist. The
-function is called with each data element's #GQuark id and data,
-together with the given @user_data parameter. Note that this
-function is NOT thread-safe. So unless @datalist can be protected
-from any modifications during invocation of this function, it should
-not be called.
+Feeds @data into an existing #GChecksum. The checksum must still be
+open, that is g_checksum_get_string() or g_checksum_get_digest() must
+not have been called on @checksum.
+
+Since: 2.16
</description>
<parameters>
-<parameter name="datalist">
-<parameter_description> a datalist.
+<parameter name="checksum">
+<parameter_description> a #GChecksum
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> the function to call for each data element.
+<parameter name="data">
+<parameter_description> buffer used to compute the checksum
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> user data to pass to the function.
+<parameter name="length">
+<parameter_description> size of the buffer, or -1 if it is a null-terminated string.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_datalist_get_data">
+<function name="g_child_watch_add">
<description>
-Gets a data element, using its string identifer. This is slower than
-g_datalist_id_get_data() because the string is first converted to a
-#GQuark.
+Sets a function to be called when the child indicated by @pid
+exits, at a default priority, #G_PRIORITY_DEFAULT.
-</description>
-<parameters>
-<parameter name="dl">
-<parameter_description> a datalist.
-</parameter_description>
+If you obtain @pid from g_spawn_async() or g_spawn_async_with_pipes()
+you will need to pass #G_SPAWN_DO_NOT_REAP_CHILD as flag to
+the spawn function for the child watching to work.
+
+Note that on platforms where #GPid must be explicitly closed
+(see g_spawn_close_pid()) @pid must not be closed while the
+source is still active. Typically, you will want to call
+g_spawn_close_pid() in the callback function for the source.
+
+GLib supports only a single callback per process id.
+
+This internally creates a main loop source using
+g_child_watch_source_new() and attaches it to the main loop context
+using g_source_attach(). You can do these steps manually if you
+need greater control.
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="pid">
+<parameter_description> process id to watch. On POSIX the pid of a child process. On
+Windows a handle for a process (which doesn't have to be a child).
+</parameter_description>
</parameter>
-<parameter name="k">
-<parameter_description> the string identifying a data element.
+<parameter name="function">
+<parameter_description> function to call
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> data to pass to @function
</parameter_description>
</parameter>
</parameters>
-<return> the data element, or %NULL if it is not found.
+<return> the ID (greater than 0) of the event source.
+
</return>
</function>
-<function name="g_datalist_get_flags">
+<function name="g_child_watch_add_full">
<description>
-Gets flags values packed in together with the datalist.
-See g_datalist_set_flags().
+Sets a function to be called when the child indicated by @pid
+exits, at the priority @priority.
-Since: 2.8
+If you obtain @pid from g_spawn_async() or g_spawn_async_with_pipes()
+you will need to pass #G_SPAWN_DO_NOT_REAP_CHILD as flag to
+the spawn function for the child watching to work.
+
+Note that on platforms where #GPid must be explicitly closed
+(see g_spawn_close_pid()) @pid must not be closed while the
+source is still active. Typically, you will want to call
+g_spawn_close_pid() in the callback function for the source.
+
+GLib supports only a single callback per process id.
+
+This internally creates a main loop source using
+g_child_watch_source_new() and attaches it to the main loop context
+using g_source_attach(). You can do these steps manually if you
+need greater control.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="datalist">
-<parameter_description> pointer to the location that holds a list
+<parameter name="priority">
+<parameter_description> the priority of the idle source. Typically this will be in the
+range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE.
+</parameter_description>
+</parameter>
+<parameter name="pid">
+<parameter_description> process to watch. On POSIX the pid of a child process. On
+Windows a handle for a process (which doesn't have to be a child).
+</parameter_description>
+</parameter>
+<parameter name="function">
+<parameter_description> function to call
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> data to pass to @function
+</parameter_description>
+</parameter>
+<parameter name="notify">
+<parameter_description> function to call when the idle is removed, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the flags of the datalist
+<return> the ID (greater than 0) of the event source.
</return>
</function>
-<function name="g_datalist_id_get_data">
+<function name="g_child_watch_source_new">
<description>
-Retrieves the data element corresponding to @key_id.
+Creates a new child_watch source.
+
+The source will not initially be associated with any #GMainContext
+and must be added to one with g_source_attach() before it will be
+executed.
+
+Note that child watch sources can only be used in conjunction with
+<literal>g_spawn...</literal> when the %G_SPAWN_DO_NOT_REAP_CHILD
+flag is used.
+
+Note that on platforms where #GPid must be explicitly closed
+(see g_spawn_close_pid()) @pid must not be closed while the
+source is still active. Typically, you will want to call
+g_spawn_close_pid() in the callback function for the source.
+
+Note further that using g_child_watch_source_new() is not
+compatible with calling <literal>waitpid(-1)</literal> in
+the application. Calling waitpid() for individual pids will
+still work fine.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="datalist">
-<parameter_description> a datalist.
-</parameter_description>
-</parameter>
-<parameter name="key_id">
-<parameter_description> the #GQuark identifying a data element.
+<parameter name="pid">
+<parameter_description> process to watch. On POSIX the pid of a child process. On
+Windows a handle for a process (which doesn't have to be a child).
</parameter_description>
</parameter>
</parameters>
-<return> the data element, or %NULL if it is not found.
+<return> the newly-created child watch source
+
</return>
</function>
-<function name="g_datalist_id_remove_data">
+<function name="g_chmod">
<description>
-Removes an element, using its #GQuark identifier.
+A wrapper for the POSIX chmod() function. The chmod() function is
+used to set the permissions of a file system object.
+
+On Windows the file protection mechanism is not at all POSIX-like,
+and the underlying chmod() function in the C library just sets or
+clears the FAT-style READONLY attribute. It does not touch any
+ACL. Software that needs to manage file permissions on Windows
+exactly should use the Win32 API.
+
+See your C library manual for more details about chmod().
+
+Since: 2.8
</description>
<parameters>
-<parameter name="dl">
-<parameter_description> a datalist.
+<parameter name="filename">
+<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows)
</parameter_description>
</parameter>
-<parameter name="q">
-<parameter_description> the #GQuark identifying the data element.
+<parameter name="mode">
+<parameter_description> as in chmod()
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> zero if the operation succeeded, -1 on error.
+
+</return>
</function>
-<function name="g_datalist_id_remove_no_notify">
+<function name="g_chunk_free">
<description>
-Removes an element, without calling its destroy notification
-function.
+A convenience macro to free an atom of memory from a #GMemChunk. It
+simply switches the arguments and calls g_mem_chunk_free() It is
+included simply to complement the other convenience macros,
+g_chunk_new() and g_chunk_new0().
+
+Deprecated:2.10: Use g_slice_free() instead
</description>
<parameters>
-<parameter name="datalist">
-<parameter_description> a datalist.
+<parameter name="mem">
+<parameter_description> a pointer to the atom to be freed.
</parameter_description>
</parameter>
-<parameter name="key_id">
-<parameter_description> the #GQuark identifying a data element.
+<parameter name="mem_chunk">
+<parameter_description> a #GMemChunk.
</parameter_description>
</parameter>
</parameters>
-<return> the data previously stored at @key_id, or %NULL if none.
-</return>
+<return></return>
</function>
-<function name="g_datalist_id_set_data">
+<function name="g_chunk_new">
<description>
-Sets the data corresponding to the given #GQuark id. Any previous
-data with the same key is removed, and its destroy function is
-called.
+A convenience macro to allocate an atom of memory from a #GMemChunk.
+It calls g_mem_chunk_alloc() and casts the returned atom to a
+pointer to the given type, avoiding a type cast in the source code.
+
+Deprecated:2.10: Use g_slice_new() instead
</description>
<parameters>
-<parameter name="dl">
-<parameter_description> a datalist.
-</parameter_description>
-</parameter>
-<parameter name="q">
-<parameter_description> the #GQuark to identify the data element.
+<parameter name="type">
+<parameter_description> the type of the #GMemChunk atoms, typically a structure name.
</parameter_description>
</parameter>
-<parameter name="d">
-<parameter_description> the data element, or %NULL to remove any previous element
-corresponding to @q.
+<parameter name="chunk">
+<parameter_description> a #GMemChunk.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a pointer to the allocated atom, cast to a pointer to
+ type
+</return>
</function>
-<function name="g_datalist_id_set_data_full">
+<function name="g_chunk_new0">
<description>
-Sets the data corresponding to the given #GQuark id, and the
-function to be called when the element is removed from the datalist.
-Any previous data with the same key is removed, and its destroy
-function is called.
+A convenience macro to allocate an atom of memory from a #GMemChunk.
+It calls g_mem_chunk_alloc0() and casts the returned atom to a
+pointer to the given type, avoiding a type cast in the source code.
+
+Deprecated:2.10: Use g_slice_new0() instead
</description>
<parameters>
-<parameter name="datalist">
-<parameter_description> a datalist.
-</parameter_description>
-</parameter>
-<parameter name="key_id">
-<parameter_description> the #GQuark to identify the data element.
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> the data element or %NULL to remove any previous element
-corresponding to @key_id.
+<parameter name="type">
+<parameter_description> the type of the #GMemChunk atoms, typically a structure name.
</parameter_description>
</parameter>
-<parameter name="destroy_func">
-<parameter_description> the function to call when the data element is
-removed. This function will be called with the data
-element and can be used to free any memory allocated
-for it. If @data is %NULL, then @destroy_func must
-also be %NULL.
+<parameter name="chunk">
+<parameter_description> a #GMemChunk.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a pointer to the allocated atom, cast to a pointer to
+ type
+</return>
</function>
-<function name="g_datalist_init">
+<function name="g_clear_error">
<description>
-Resets the datalist to %NULL. It does not free any memory or call
-any destroy functions.
+If @err is %NULL, does nothing. If @err is non-%NULL,
+calls g_error_free() on * err and sets * err to %NULL.
</description>
<parameters>
-<parameter name="datalist">
-<parameter_description> a pointer to a pointer to a datalist.
+<parameter name="err">
+<parameter_description> a #GError return location
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_datalist_remove_data">
+<function name="g_clear_object">
<description>
-Removes an element using its string identifier. The data element's
-destroy function is called if it has been set.
+Clears a reference to a #GObject.
+
+ object_ptr must not be %NULL.
+
+If the reference is %NULL then this function does nothing.
+Otherwise, the reference count of the object is decreased and the
+pointer is set to %NULL.
+
+This function is threadsafe and modifies the pointer atomically,
+using memory barriers where needed.
+
+A macro is also included that allows this function to be used without
+pointer casts.
+
+Since: 2.28
</description>
<parameters>
-<parameter name="dl">
-<parameter_description> a datalist.
-</parameter_description>
-</parameter>
-<parameter name="k">
-<parameter_description> the string identifying the data element.
+<parameter name="object_ptr">
+<parameter_description> a pointer to a #GObject reference
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_datalist_remove_no_notify">
+<function name="g_closure_add_finalize_notifier">
<description>
-Removes an element, without calling its destroy notifier.
+Registers a finalization notifier which will be called when the
+reference count of @closure goes down to 0. Multiple finalization
+notifiers on a single closure are invoked in unspecified order. If
+a single call to g_closure_unref() results in the closure being
+both invalidated and finalized, then the invalidate notifiers will
+be run before the finalize notifiers.
</description>
<parameters>
-<parameter name="dl">
-<parameter_description> a datalist.
+<parameter name="closure">
+<parameter_description> a #GClosure
</parameter_description>
</parameter>
-<parameter name="k">
-<parameter_description> the string identifying the data element.
+<parameter name="notify_data">
+<parameter_description> data to pass to @notify_func
+</parameter_description>
+</parameter>
+<parameter name="notify_func">
+<parameter_description> the callback function to register
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_datalist_set_data">
+<function name="g_closure_add_invalidate_notifier">
<description>
-Sets the data element corresponding to the given string identifier.
+Registers an invalidation notifier which will be called when the
+ closure is invalidated with g_closure_invalidate(). Invalidation
+notifiers are invoked before finalization notifiers, in an
+unspecified order.
</description>
<parameters>
-<parameter name="dl">
-<parameter_description> a datalist.
+<parameter name="closure">
+<parameter_description> a #GClosure
</parameter_description>
</parameter>
-<parameter name="k">
-<parameter_description> the string to identify the data element.
+<parameter name="notify_data">
+<parameter_description> data to pass to @notify_func
</parameter_description>
</parameter>
-<parameter name="d">
-<parameter_description> the data element, or %NULL to remove any previous element
-corresponding to @k.
+<parameter name="notify_func">
+<parameter_description> the callback function to register
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_datalist_set_data_full">
+<function name="g_closure_add_marshal_guards">
<description>
-Sets the data element corresponding to the given string identifier,
-and the function to be called when the data element is removed.
+Adds a pair of notifiers which get invoked before and after the
+closure callback, respectively. This is typically used to protect
+the extra arguments for the duration of the callback. See
+g_object_watch_closure() for an example of marshal guards.
</description>
<parameters>
-<parameter name="dl">
-<parameter_description> a datalist.
+<parameter name="closure">
+<parameter_description> a #GClosure
</parameter_description>
</parameter>
-<parameter name="k">
-<parameter_description> the string to identify the data element.
+<parameter name="pre_marshal_data">
+<parameter_description> data to pass to @pre_marshal_notify
</parameter_description>
</parameter>
-<parameter name="d">
-<parameter_description> the data element, or %NULL to remove any previous element
-corresponding to @k.
+<parameter name="pre_marshal_notify">
+<parameter_description> a function to call before the closure callback
</parameter_description>
</parameter>
-<parameter name="f">
-<parameter_description> the function to call when the data element is removed. This
-function will be called with the data element and can be used to
-free any memory allocated for it. If @d is %NULL, then @f must
-also be %NULL.
+<parameter name="post_marshal_data">
+<parameter_description> data to pass to @post_marshal_notify
+</parameter_description>
+</parameter>
+<parameter name="post_marshal_notify">
+<parameter_description> a function to call after the closure callback
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_datalist_set_flags">
+<function name="g_closure_invalidate">
<description>
-Turns on flag values for a data list. This function is used
-to keep a small number of boolean flags in an object with
-a data list without using any additional space. It is
-not generally useful except in circumstances where space
-is very tight. (It is used in the base #GObject type, for
-example.)
+Sets a flag on the closure to indicate that its calling
+environment has become invalid, and thus causes any future
+invocations of g_closure_invoke() on this @closure to be
+ignored. Also, invalidation notifiers installed on the closure will
+be called at this point. Note that unless you are holding a
+reference to the closure yourself, the invalidation notifiers may
+unref the closure and cause it to be destroyed, so if you need to
+access the closure after calling g_closure_invalidate(), make sure
+that you've previously called g_closure_ref().
-Since: 2.8
+Note that g_closure_invalidate() will also be called when the
+reference count of a closure drops to zero (unless it has already
+been invalidated before).
</description>
<parameters>
-<parameter name="datalist">
-<parameter_description> pointer to the location that holds a list
-</parameter_description>
-</parameter>
-<parameter name="flags">
-<parameter_description> the flags to turn on. The values of the flags are
-restricted by %G_DATALIST_FLAGS_MASK (currently
-3; giving two possible boolean flags).
-A value for @flags that doesn't fit within the mask is
-an error.
+<parameter name="closure">
+<parameter_description> GClosure to invalidate
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_datalist_unset_flags">
+<function name="g_closure_invoke">
<description>
-Turns off flag values for a data list. See g_datalist_unset_flags()
-
-Since: 2.8
+Invokes the closure, i.e. executes the callback represented by the @closure.
</description>
<parameters>
-<parameter name="datalist">
-<parameter_description> pointer to the location that holds a list
+<parameter name="closure">
+<parameter_description> a #GClosure
</parameter_description>
</parameter>
-<parameter name="flags">
-<parameter_description> the flags to turn off. The values of the flags are
-restricted by %G_DATALIST_FLAGS_MASK (currently
-3: giving two possible boolean flags).
-A value for @flags that doesn't fit within the mask is
-an error.
+<parameter name="return_value">
+<parameter_description> a #GValue to store the return value. May be %NULL if the
+callback of @closure doesn't return a value.
+</parameter_description>
+</parameter>
+<parameter name="n_param_values">
+<parameter_description> the length of the @param_values array
+</parameter_description>
+</parameter>
+<parameter name="param_values">
+<parameter_description> an array of
+#GValue<!-- -->s holding the arguments on which to
+invoke the callback of @closure
+</parameter_description>
+</parameter>
+<parameter name="invocation_hint">
+<parameter_description> a context-dependent invocation hint
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_dataset_destroy">
+<function name="g_closure_new_object">
<description>
-Destroys the dataset, freeing all memory allocated, and calling any
-destroy functions set for data elements.
+A variant of g_closure_new_simple() which stores @object in the
+ data field of the closure and calls g_object_watch_closure() on
+ object and the created closure. This function is mainly useful
+when implementing new types of closures.
+
</description>
<parameters>
-<parameter name="dataset_location">
-<parameter_description> the location identifying the dataset.
+<parameter name="sizeof_closure">
+<parameter_description> the size of the structure to allocate, must be at least
+<literal>sizeof (GClosure)</literal>
+</parameter_description>
+</parameter>
+<parameter name="object">
+<parameter_description> a #GObject pointer to store in the @data field of the newly
+allocated #GClosure
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a newly allocated #GClosure
+</return>
</function>
-<function name="g_dataset_foreach">
+<function name="g_closure_new_simple">
<description>
-Calls the given function for each data element which is associated
-with the given location. Note that this function is NOT thread-safe.
-So unless @datalist can be protected from any modifications during
-invocation of this function, it should not be called.
+Allocates a struct of the given size and initializes the initial
+part as a #GClosure. This function is mainly useful when
+implementing new types of closures.
+
+|[
+typedef struct _MyClosure MyClosure;
+struct _MyClosure
+{
+GClosure closure;
+// extra data goes here
+};
+
+static void
+my_closure_finalize (gpointer notify_data,
+GClosure *closure)
+{
+MyClosure *my_closure = (MyClosure *)closure;
+
+// free extra data here
+}
+
+MyClosure *my_closure_new (gpointer data)
+{
+GClosure *closure;
+MyClosure *my_closure;
+
+closure = g_closure_new_simple (sizeof (MyClosure), data);
+my_closure = (MyClosure *) closure;
+
+// initialize extra data here
+
+g_closure_add_finalize_notifier (closure, notify_data,
+my_closure_finalize);
+return my_closure;
+}
+]|
+
</description>
<parameters>
-<parameter name="dataset_location">
-<parameter_description> the location identifying the dataset.
+<parameter name="sizeof_closure">
+<parameter_description> the size of the structure to allocate, must be at least
+<literal>sizeof (GClosure)</literal>
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> the function to call for each data element.
-</parameter_description>
-</parameter>
-<parameter name="user_data">
-<parameter_description> user data to pass to the function.
+<parameter name="data">
+<parameter_description> data to store in the @data field of the newly allocated #GClosure
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a newly allocated #GClosure
+</return>
</function>
-<function name="g_dataset_get_data">
+<function name="g_closure_ref">
<description>
-Gets the data element corresponding to a string.
+Increments the reference count on a closure to force it staying
+alive while the caller holds a pointer to it.
+
</description>
<parameters>
-<parameter name="l">
-<parameter_description> the location identifying the dataset.
-</parameter_description>
-</parameter>
-<parameter name="k">
-<parameter_description> the string identifying the data element.
+<parameter name="closure">
+<parameter_description> #GClosure to increment the reference count on
</parameter_description>
</parameter>
</parameters>
-<return> the data element corresponding to the string, or %NULL if
-it is not found.
+<return> The @closure passed in, for convenience
</return>
</function>
-<function name="g_dataset_id_get_data">
+<function name="g_closure_remove_finalize_notifier">
<description>
-Gets the data element corresponding to a #GQuark.
+Removes a finalization notifier.
+
+Notice that notifiers are automatically removed after they are run.
</description>
<parameters>
-<parameter name="dataset_location">
-<parameter_description> the location identifying the dataset.
+<parameter name="closure">
+<parameter_description> a #GClosure
</parameter_description>
</parameter>
-<parameter name="key_id">
-<parameter_description> the #GQuark id to identify the data element.
+<parameter name="notify_data">
+<parameter_description> data which was passed to g_closure_add_finalize_notifier()
+when registering @notify_func
+</parameter_description>
+</parameter>
+<parameter name="notify_func">
+<parameter_description> the callback function to remove
</parameter_description>
</parameter>
</parameters>
-<return> the data element corresponding to the #GQuark, or %NULL if
-it is not found.
-</return>
+<return></return>
</function>
-<function name="g_dataset_id_remove_data">
+<function name="g_closure_remove_invalidate_notifier">
<description>
-Removes a data element from a dataset. The data element's destroy
-function is called if it has been set.
+Removes an invalidation notifier.
+
+Notice that notifiers are automatically removed after they are run.
</description>
<parameters>
-<parameter name="l">
-<parameter_description> the location identifying the dataset.
+<parameter name="closure">
+<parameter_description> a #GClosure
</parameter_description>
</parameter>
-<parameter name="k">
-<parameter_description> the #GQuark id identifying the data element.
+<parameter name="notify_data">
+<parameter_description> data which was passed to g_closure_add_invalidate_notifier()
+when registering @notify_func
+</parameter_description>
+</parameter>
+<parameter name="notify_func">
+<parameter_description> the callback function to remove
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_dataset_id_remove_no_notify">
+<function name="g_closure_set_marshal">
<description>
-Removes an element, without calling its destroy notification
-function.
+Sets the marshaller of @closure. The <literal>marshal_data</literal>
+of @marshal provides a way for a meta marshaller to provide additional
+information to the marshaller. (See g_closure_set_meta_marshal().) For
+GObject's C predefined marshallers (the g_cclosure_marshal_*()
+functions), what it provides is a callback function to use instead of
+ closure->callback.
</description>
<parameters>
-<parameter name="dataset_location">
-<parameter_description> the location identifying the dataset.
+<parameter name="closure">
+<parameter_description> a #GClosure
</parameter_description>
</parameter>
-<parameter name="key_id">
-<parameter_description> the #GQuark ID identifying the data element.
+<parameter name="marshal">
+<parameter_description> a #GClosureMarshal function
</parameter_description>
</parameter>
</parameters>
-<return> the data previously stored at @key_id, or %NULL if none.
-</return>
+<return></return>
</function>
-<function name="g_dataset_id_set_data">
+<function name="g_closure_set_meta_marshal">
<description>
-Sets the data element associated with the given #GQuark id. Any
-previous data with the same key is removed, and its destroy function
-is called.
+Sets the meta marshaller of @closure. A meta marshaller wraps
+ closure->marshal and modifies the way it is called in some
+fashion. The most common use of this facility is for C callbacks.
+The same marshallers (generated by <link
+linkend="glib-genmarshal">glib-genmarshal</link>) are used
+everywhere, but the way that we get the callback function
+differs. In most cases we want to use @closure->callback, but in
+other cases we want to use some different technique to retrieve the
+callback function.
+
+For example, class closures for signals (see
+g_signal_type_cclosure_new()) retrieve the callback function from a
+fixed offset in the class structure. The meta marshaller retrieves
+the right callback and passes it to the marshaller as the
+ marshal_data argument.
</description>
<parameters>
-<parameter name="l">
-<parameter_description> the location identifying the dataset.
+<parameter name="closure">
+<parameter_description> a #GClosure
</parameter_description>
</parameter>
-<parameter name="k">
-<parameter_description> the #GQuark id to identify the data element.
+<parameter name="marshal_data">
+<parameter_description> context-dependent data to pass to @meta_marshal
</parameter_description>
</parameter>
-<parameter name="d">
-<parameter_description> the data element.
+<parameter name="meta_marshal">
+<parameter_description> a #GClosureMarshal function
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_dataset_id_set_data_full">
+<function name="g_closure_sink">
<description>
-Sets the data element associated with the given #GQuark id, and also
-the function to call when the data element is destroyed. Any
-previous data with the same key is removed, and its destroy function
-is called.
+Takes over the initial ownership of a closure. Each closure is
+initially created in a <firstterm>floating</firstterm> state, which
+means that the initial reference count is not owned by any caller.
+g_closure_sink() checks to see if the object is still floating, and
+if so, unsets the floating state and decreases the reference
+count. If the closure is not floating, g_closure_sink() does
+nothing. The reason for the existance of the floating state is to
+prevent cumbersome code sequences like:
+|[
+closure = g_cclosure_new (cb_func, cb_data);
+g_source_set_closure (source, closure);
+g_closure_unref (closure); // XXX GObject doesn't really need this
+]|
+Because g_source_set_closure() (and similar functions) take ownership of the
+initial reference count, if it is unowned, we instead can write:
+|[
+g_source_set_closure (source, g_cclosure_new (cb_func, cb_data));
+]|
+
+Generally, this function is used together with g_closure_ref(). Ane example
+of storing a closure for later notification looks like:
+|[
+static GClosure *notify_closure = NULL;
+void
+foo_notify_set_closure (GClosure *closure)
+{
+if (notify_closure)
+g_closure_unref (notify_closure);
+notify_closure = closure;
+if (notify_closure)
+{
+g_closure_ref (notify_closure);
+g_closure_sink (notify_closure);
+}
+}
+]|
+
+Because g_closure_sink() may decrement the reference count of a closure
+(if it hasn't been called on @closure yet) just like g_closure_unref(),
+g_closure_ref() should be called prior to this function.
</description>
<parameters>
-<parameter name="dataset_location">
-<parameter_description> the location identifying the dataset.
-</parameter_description>
-</parameter>
-<parameter name="key_id">
-<parameter_description> the #GQuark id to identify the data element.
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> the data element.
-</parameter_description>
-</parameter>
-<parameter name="destroy_func">
-<parameter_description> the function to call when the data element is
-removed. This function will be called with the data
-element and can be used to free any memory allocated
-for it.
+<parameter name="closure">
+<parameter_description> #GClosure to decrement the initial reference count on, if it's
+still being held
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_dataset_remove_data">
+<function name="g_closure_unref">
<description>
-Removes a data element corresponding to a string. Its destroy
-function is called if it has been set.
+Decrements the reference count of a closure after it was previously
+incremented by the same caller. If no other callers are using the
+closure, then the closure will be destroyed and freed.
</description>
<parameters>
-<parameter name="l">
-<parameter_description> the location identifying the dataset.
-</parameter_description>
-</parameter>
-<parameter name="k">
-<parameter_description> the string identifying the data element.
+<parameter name="closure">
+<parameter_description> #GClosure to decrement the reference count on
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_dataset_remove_no_notify">
+<function name="g_completion_add_items">
<description>
-Removes an element, without calling its destroy notifier.
+Adds items to the #GCompletion.
+
+Deprecated: 2.26: Rarely used API
</description>
<parameters>
-<parameter name="l">
-<parameter_description> the location identifying the dataset.
+<parameter name="cmp">
+<parameter_description> the #GCompletion.
</parameter_description>
</parameter>
-<parameter name="k">
-<parameter_description> the string identifying the data element.
+<parameter name="items">
+<parameter_description> the list of items to add.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_dataset_set_data">
+<function name="g_completion_clear_items">
<description>
-Sets the data corresponding to the given string identifier.
+Removes all items from the #GCompletion.
+
+Deprecated: 2.26: Rarely used API
</description>
<parameters>
-<parameter name="l">
-<parameter_description> the location identifying the dataset.
-</parameter_description>
-</parameter>
-<parameter name="k">
-<parameter_description> the string to identify the data element.
-</parameter_description>
-</parameter>
-<parameter name="d">
-<parameter_description> the data element.
+<parameter name="cmp">
+<parameter_description> the #GCompletion.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_dataset_set_data_full">
+<function name="g_completion_complete">
<description>
-Sets the data corresponding to the given string identifier, and the
-function to call when the data element is destroyed.
+Attempts to complete the string @prefix using the #GCompletion
+target items.
+
+Deprecated: 2.26: Rarely used API
</description>
<parameters>
-<parameter name="l">
-<parameter_description> the location identifying the dataset.
+<parameter name="cmp">
+<parameter_description> the #GCompletion.
</parameter_description>
</parameter>
-<parameter name="k">
-<parameter_description> the string to identify the data element.
-</parameter_description>
-</parameter>
-<parameter name="d">
-<parameter_description> the data element.
+<parameter name="prefix">
+<parameter_description> the prefix string, typically typed by the user, which is
+compared with each of the items.
</parameter_description>
</parameter>
-<parameter name="f">
-<parameter_description> the function to call when the data element is removed. This
-function will be called with the data element and can be used to
-free any memory allocated for it.
+<parameter name="new_prefix">
+<parameter_description> if non-%NULL, returns the longest prefix which is
+common to all items that matched @prefix, or %NULL if
+no items matched @prefix. This string should be freed
+when no longer needed.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the list of items whose strings begin with @prefix. This
+should not be changed.
+</return>
</function>
-<function name="g_date_get_iso8601_week_of_year">
+<function name="g_completion_complete_utf8">
<description>
-Returns the week of the year, where weeks are interpreted according
-to ISO 8601.
+Attempts to complete the string @prefix using the #GCompletion target items.
+In contrast to g_completion_complete(), this function returns the largest common
+prefix that is a valid UTF-8 string, omitting a possible common partial
+character.
-Since: 2.6
+You should use this function instead of g_completion_complete() if your
+items are UTF-8 strings.
+
+Since: 2.4
+
+Deprecated: 2.26: Rarely used API
</description>
<parameters>
-<parameter name="date">
-<parameter_description> a valid #GDate
+<parameter name="cmp">
+<parameter_description> the #GCompletion
+</parameter_description>
+</parameter>
+<parameter name="prefix">
+<parameter_description> the prefix string, typically used by the user, which is compared
+with each of the items
+</parameter_description>
+</parameter>
+<parameter name="new_prefix">
+<parameter_description> if non-%NULL, returns the longest prefix which is common to all
+items that matched @prefix, or %NULL if no items matched @prefix.
+This string should be freed when no longer needed.
</parameter_description>
</parameter>
</parameters>
-<return> ISO 8601 week number of the year.
+<return> the list of items whose strings begin with @prefix. This should
+not be changed.
</return>
</function>
-<function name="g_date_set_time">
+<function name="g_completion_free">
<description>
-Sets the value of a date from a #GTime value.
-The time to date conversion is done using the user's current timezone.
+Frees all memory used by the #GCompletion.
-Deprecated: 2.10: Use g_date_set_time_t() instead.
+Deprecated: 2.26: Rarely used API
</description>
<parameters>
-<parameter name="date">
-<parameter_description> a #GDate.
-</parameter_description>
-</parameter>
-<parameter name="time_">
-<parameter_description> #GTime value to set.
+<parameter name="cmp">
+<parameter_description> the #GCompletion.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_date_set_time_t">
+<function name="g_completion_new">
<description>
-Sets the value of a date to the date corresponding to a time
-specified as a time_t. The time to date conversion is done using
-the user's current timezone.
-
-To set the value of a date to the current day, you could write:
-|[
-g_date_set_time_t (date, time (NULL));
-]|
-
-Since: 2.10
+Creates a new #GCompletion.
</description>
<parameters>
-<parameter name="date">
-<parameter_description> a #GDate
-</parameter_description>
-</parameter>
-<parameter name="timet">
-<parameter_description> <type>time_t</type> value to set
+<parameter name="func">
+<parameter_description> the function to be called to return the string representing
+an item in the #GCompletion, or %NULL if strings are going to
+be used as the #GCompletion items.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the new #GCompletion.
+</return>
</function>
-<function name="g_date_set_time_val">
+<function name="g_completion_remove_items">
<description>
-Sets the value of a date from a #GTimeVal value. Note that the
- tv_usec member is ignored, because #GDate can't make use of the
-additional precision.
-
-The time to date conversion is done using the user's current timezone.
+Removes items from a #GCompletion.
-Since: 2.10
+Deprecated: 2.26: Rarely used API
</description>
<parameters>
-<parameter name="date">
-<parameter_description> a #GDate
+<parameter name="cmp">
+<parameter_description> the #GCompletion.
</parameter_description>
</parameter>
-<parameter name="timeval">
-<parameter_description> #GTimeVal value to set
+<parameter name="items">
+<parameter_description> the items to remove.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_date_time_add">
+<function name="g_completion_set_compare">
<description>
-Creates a copy of @datetime and adds the specified timespan to the copy.
+Sets the function to use for string comparisons. The default string
+comparison function is strncmp().
-Since: 2.26
+Deprecated: 2.26: Rarely used API
</description>
<parameters>
-<parameter name="datetime">
-<parameter_description> a #GDateTime
+<parameter name="cmp">
+<parameter_description> a #GCompletion.
</parameter_description>
</parameter>
-<parameter name="timespan">
-<parameter_description> a #GTimeSpan
+<parameter name="strncmp_func">
+<parameter_description> the string comparison function.
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #GDateTime which should be freed with
-g_date_time_unref().
-
-</return>
+<return></return>
</function>
-<function name="g_date_time_add_days">
+<function name="g_compute_checksum_for_data">
<description>
-Creates a copy of @datetime and adds the specified number of days to the
-copy.
+Computes the checksum for a binary @data of @length. This is a
+convenience wrapper for g_checksum_new(), g_checksum_get_string()
+and g_checksum_free().
-Since: 2.26
+The hexadecimal string returned will be in lower case.
+
+Since: 2.16
</description>
<parameters>
-<parameter name="datetime">
-<parameter_description> a #GDateTime
+<parameter name="checksum_type">
+<parameter_description> a #GChecksumType
</parameter_description>
</parameter>
-<parameter name="days">
-<parameter_description> the number of days
+<parameter name="data">
+<parameter_description> binary blob to compute the digest of
+</parameter_description>
+</parameter>
+<parameter name="length">
+<parameter_description> length of @data
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #GDateTime which should be freed with
-g_date_time_unref().
+<return> the digest of the binary data as a string in hexadecimal.
+The returned string should be freed with g_free() when done using it.
</return>
</function>
-<function name="g_date_time_add_full">
+<function name="g_compute_checksum_for_string">
<description>
-Creates a new #GDateTime adding the specified values to the current date and
-time in @datetime.
+Computes the checksum of a string.
-Since: 2.26
+The hexadecimal string returned will be in lower case.
+
+Since: 2.16
</description>
<parameters>
-<parameter name="datetime">
-<parameter_description> a #GDateTime
-</parameter_description>
-</parameter>
-<parameter name="years">
-<parameter_description> the number of years to add
-</parameter_description>
-</parameter>
-<parameter name="months">
-<parameter_description> the number of months to add
-</parameter_description>
-</parameter>
-<parameter name="days">
-<parameter_description> the number of days to add
-</parameter_description>
-</parameter>
-<parameter name="hours">
-<parameter_description> the number of hours to add
+<parameter name="checksum_type">
+<parameter_description> a #GChecksumType
</parameter_description>
</parameter>
-<parameter name="minutes">
-<parameter_description> the number of minutes to add
+<parameter name="str">
+<parameter_description> the string to compute the checksum of
</parameter_description>
</parameter>
-<parameter name="seconds">
-<parameter_description> the number of seconds to add
+<parameter name="length">
+<parameter_description> the length of the string, or -1 if the string is null-terminated.
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #GDateTime that should be freed with
-g_date_time_unref().
+<return> the checksum as a hexadecimal string. The returned string
+should be freed with g_free() when done using it.
</return>
</function>
-<function name="g_date_time_add_hours">
+<function name="g_cond_broadcast">
<description>
-Creates a copy of @datetime and adds the specified number of hours
+If threads are waiting for @cond, all of them are woken up. It is
+good practice to lock the same mutex as the waiting threads, while
+calling this function, though not required.
-Since: 2.26
+This function can be used even if g_thread_init() has not yet been
+called, and, in that case, will do nothing.
</description>
<parameters>
-<parameter name="datetime">
-<parameter_description> a #GDateTime
-</parameter_description>
-</parameter>
-<parameter name="hours">
-<parameter_description> the number of hours to add
+<parameter name="cond">
+<parameter_description> a #GCond.
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #GDateTime which should be freed with
-g_date_time_unref().
-
-</return>
+<return></return>
</function>
-<function name="g_date_time_add_minutes">
+<function name="g_cond_free">
<description>
-Creates a copy of @datetime adding the specified number of minutes.
-
-Since: 2.26
+Destroys the #GCond.
</description>
<parameters>
-<parameter name="datetime">
-<parameter_description> a #GDateTime
-</parameter_description>
-</parameter>
-<parameter name="minutes">
-<parameter_description> the number of minutes to add
+<parameter name="cond">
+<parameter_description> a #GCond.
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #GDateTime which should be freed with
-g_date_time_unref().
-
-</return>
+<return></return>
</function>
-<function name="g_date_time_add_months">
+<function name="g_cond_new">
<description>
-Creates a copy of @datetime and adds the specified number of months to the
-copy.
-
-Since: 2.26
+Creates a new #GCond. This function will abort, if g_thread_init()
+has not been called yet.
</description>
<parameters>
-<parameter name="datetime">
-<parameter_description> a #GDateTime
-</parameter_description>
-</parameter>
-<parameter name="months">
-<parameter_description> the number of months
-</parameter_description>
-</parameter>
</parameters>
-<return> the newly created #GDateTime which should be freed with
-g_date_time_unref().
-
+<return> a new #GCond.
</return>
</function>
-<function name="g_date_time_add_seconds">
+<function name="g_cond_signal">
<description>
-Creates a copy of @datetime and adds the specified number of seconds.
+If threads are waiting for @cond, exactly one of them is woken up.
+It is good practice to hold the same lock as the waiting thread
+while calling this function, though not required.
-Since: 2.26
+This function can be used even if g_thread_init() has not yet been
+called, and, in that case, will do nothing.
</description>
<parameters>
-<parameter name="datetime">
-<parameter_description> a #GDateTime
-</parameter_description>
-</parameter>
-<parameter name="seconds">
-<parameter_description> the number of seconds to add
+<parameter name="cond">
+<parameter_description> a #GCond.
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #GDateTime which should be freed with
-g_date_time_unref().
-
-</return>
+<return></return>
</function>
-<function name="g_date_time_add_weeks">
+<function name="g_cond_timed_wait">
<description>
-Creates a copy of @datetime and adds the specified number of weeks to the
-copy.
+Waits until this thread is woken up on @cond, but not longer than
+until the time specified by @abs_time. The @mutex is unlocked before
+falling asleep and locked again before resuming.
-Since: 2.26
+If @abs_time is %NULL, g_cond_timed_wait() acts like g_cond_wait().
+
+This function can be used even if g_thread_init() has not yet been
+called, and, in that case, will immediately return %TRUE.
+
+To easily calculate @abs_time a combination of g_get_current_time()
+and g_time_val_add() can be used.
</description>
<parameters>
-<parameter name="datetime">
-<parameter_description> a #GDateTime
+<parameter name="cond">
+<parameter_description> a #GCond.
</parameter_description>
</parameter>
-<parameter name="weeks">
-<parameter_description> the number of weeks
+<parameter name="mutex">
+<parameter_description> a #GMutex that is currently locked.
+</parameter_description>
+</parameter>
+<parameter name="abs_time">
+<parameter_description> a #GTimeVal, determining the final time.
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #GDateTime which should be freed with
-g_date_time_unref().
-
+<return> %TRUE if @cond was signalled, or %FALSE on timeout.
</return>
</function>
-<function name="g_date_time_add_years">
+<function name="g_cond_wait">
<description>
-Creates a copy of @datetime and adds the specified number of years to the
-copy.
+Waits until this thread is woken up on @cond. The @mutex is unlocked
+before falling asleep and locked again before resuming.
-Since: 2.26
+This function can be used even if g_thread_init() has not yet been
+called, and, in that case, will immediately return.
</description>
<parameters>
-<parameter name="datetime">
-<parameter_description> a #GDateTime
+<parameter name="cond">
+<parameter_description> a #GCond.
</parameter_description>
</parameter>
-<parameter name="years">
-<parameter_description> the number of years
+<parameter name="mutex">
+<parameter_description> a #GMutex, that is currently locked.
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #GDateTime which should be freed with
-g_date_time_unref().
-
-</return>
+<return></return>
</function>
-<function name="g_date_time_compare">
+<function name="g_convert">
<description>
-#GCompareFunc-compatible comparison for #GDateTime<!-- -->'s. Both
-#GDateTime<-- -->'s must be non-%NULL.
+Converts a string from one character set to another.
+
+Note that you should use g_iconv() for streaming
+conversions<footnoteref linkend="streaming-state"/>.
-Since: 2.26
</description>
<parameters>
-<parameter name="dt1">
-<parameter_description> first #GDateTime to compare
+<parameter name="str">
+<parameter_description> the string to convert
</parameter_description>
</parameter>
-<parameter name="dt2">
-<parameter_description> second #GDateTime to compare
+<parameter name="len">
+<parameter_description> the length of the string, or -1 if the string is
+nul-terminated<footnote id="nul-unsafe">
+ <para>
+ Note that some encodings may allow nul bytes to
+ occur inside strings. In that case, using -1 for
+ the @len parameter is unsafe.
+ </para>
+ </footnote>.
+</parameter_description>
+</parameter>
+<parameter name="to_codeset">
+<parameter_description> name of character set into which to convert @str
+</parameter_description>
+</parameter>
+<parameter name="from_codeset">
+<parameter_description> character set of @str.
+</parameter_description>
+</parameter>
+<parameter name="bytes_read">
+<parameter_description> location to store the number of bytes in the
+input string that were successfully converted, or %NULL.
+Even if the conversion was successful, this may be
+less than @len if there were partial characters
+at the end of the input. If the error
+#G_CONVERT_ERROR_ILLEGAL_SEQUENCE occurs, the value
+stored will the byte offset after the last valid
+input sequence.
+</parameter_description>
+</parameter>
+<parameter name="bytes_written">
+<parameter_description> the number of bytes stored in the output buffer (not
+including the terminating nul).
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> location to store the error occuring, or %NULL to ignore
+errors. Any of the errors in #GConvertError may occur.
</parameter_description>
</parameter>
</parameters>
-<return> -1, 0 or 1 if @dt1 is less than, equal to or greater
-than @dt2.
-
+<return> If the conversion was successful, a newly allocated
+nul-terminated string, which must be freed with
+g_free(). Otherwise %NULL and @error will be set.
</return>
</function>
-<function name="g_date_time_difference">
+<function name="g_convert_with_fallback">
<description>
-Calculates the difference in time between @end and @begin. The
-#GTimeSpan that is returned is effectively @end - @begin (ie:
-positive if the first simparameter is larger).
+Converts a string from one character set to another, possibly
+including fallback sequences for characters not representable
+in the output. Note that it is not guaranteed that the specification
+for the fallback sequences in @fallback will be honored. Some
+systems may do an approximate conversion from @from_codeset
+to @to_codeset in their iconv() functions,
+in which case GLib will simply return that approximate conversion.
+
+Note that you should use g_iconv() for streaming
+conversions<footnoteref linkend="streaming-state"/>.
-Since: 2.26
</description>
<parameters>
-<parameter name="end">
-<parameter_description> a #GDateTime
+<parameter name="str">
+<parameter_description> the string to convert
</parameter_description>
</parameter>
-<parameter name="begin">
-<parameter_description> a #GDateTime
+<parameter name="len">
+<parameter_description> the length of the string, or -1 if the string is
+nul-terminated<footnoteref linkend="nul-unsafe"/>.
+</parameter_description>
+</parameter>
+<parameter name="to_codeset">
+<parameter_description> name of character set into which to convert @str
+</parameter_description>
+</parameter>
+<parameter name="from_codeset">
+<parameter_description> character set of @str.
+</parameter_description>
+</parameter>
+<parameter name="fallback">
+<parameter_description> UTF-8 string to use in place of character not
+present in the target encoding. (The string must be
+representable in the target encoding).
+ If %NULL, characters not in the target encoding will
+ be represented as Unicode escapes \uxxxx or \Uxxxxyyyy.
+</parameter_description>
+</parameter>
+<parameter name="bytes_read">
+<parameter_description> location to store the number of bytes in the
+input string that were successfully converted, or %NULL.
+Even if the conversion was successful, this may be
+less than @len if there were partial characters
+at the end of the input.
+</parameter_description>
+</parameter>
+<parameter name="bytes_written">
+<parameter_description> the number of bytes stored in the output buffer (not
+including the terminating nul).
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> location to store the error occuring, or %NULL to ignore
+errors. Any of the errors in #GConvertError may occur.
</parameter_description>
</parameter>
</parameters>
-<return> the difference between the two #GDateTime, as a time
-span expressed in microseconds.
-
+<return> If the conversion was successful, a newly allocated
+nul-terminated string, which must be freed with
+g_free(). Otherwise %NULL and @error will be set.
</return>
</function>
-<function name="g_date_time_equal">
+<function name="g_convert_with_iconv">
<description>
-Checks to see if @dt1 and @dt2 are equal.
+Converts a string from one character set to another.
-Equal here means that they represent the same moment after converting
-them to the same time zone.
+Note that you should use g_iconv() for streaming
+conversions<footnote id="streaming-state">
+<para>
+Despite the fact that @byes_read can return information about partial
+characters, the <literal>g_convert_...</literal> functions
+are not generally suitable for streaming. If the underlying converter
+being used maintains internal state, then this won't be preserved
+across successive calls to g_convert(), g_convert_with_iconv() or
+g_convert_with_fallback(). (An example of this is the GNU C converter
+for CP1255 which does not emit a base character until it knows that
+the next character is not a mark that could combine with the base
+character.)
+</para>
+</footnote>.
-Since: 2.26
</description>
<parameters>
-<parameter name="dt1">
-<parameter_description> a #GDateTime
+<parameter name="str">
+<parameter_description> the string to convert
</parameter_description>
</parameter>
-<parameter name="dt2">
-<parameter_description> a #GDateTime
+<parameter name="len">
+<parameter_description> the length of the string, or -1 if the string is
+nul-terminated<footnoteref linkend="nul-unsafe"/>.
</parameter_description>
</parameter>
-</parameters>
-<return> %TRUE if @dt1 and @dt2 are equal
-
-</return>
-</function>
-
-<function name="g_date_time_format">
-<description>
-Creates a newly allocated string representing the requested @format.
-
-The following format specifiers are supported:
-
-<variablelist>
-<varlistentry><term>
-<literal>%%a</literal>:
-</term><listitem><simpara>
-the abbreviated weekday name according to the current locale
-</simpara></listitem></varlistentry>
-<varlistentry><term>
-<literal>%%A</literal>:
-</term><listitem><simpara>
-the full weekday name according to the current locale
-</simpara></listitem></varlistentry>
-<varlistentry><term>
-<literal>%%b</literal>:
-</term><listitem><simpara>
-the abbreviated month name according to the current locale
-</simpara></listitem></varlistentry>
-<varlistentry><term>
-<literal>%%B</literal>:
-</term><listitem><simpara>
-the full month name according to the current locale
-</simpara></listitem></varlistentry>
-<varlistentry><term>
-<literal>%%d</literal>:
-</term><listitem><simpara>
-the day of the month as a decimal number (range 01 to 31)
-</simpara></listitem></varlistentry>
-<varlistentry><term>
-<literal>%%e</literal>:
-</term><listitem><simpara>
-the day of the month as a decimal number (range 1 to 31)
-</simpara></listitem></varlistentry>
-<varlistentry><term>
-<literal>%%F</literal>:
-</term><listitem><simpara>
-equivalent to <literal>%%Y-%%m-%%d</literal> (the ISO 8601 date
-format)
-</simpara></listitem></varlistentry>
-<varlistentry><term>
-<literal>%%h</literal>:
-</term><listitem><simpara>
-equivalent to <literal>%%b</literal>
-</simpara></listitem></varlistentry>
-<varlistentry><term>
-<literal>%%H</literal>:
-</term><listitem><simpara>
-the hour as a decimal number using a 24-hour clock (range 00 to
-23)
-</simpara></listitem></varlistentry>
-<varlistentry><term>
-<literal>%%I</literal>:
-</term><listitem><simpara>
-the hour as a decimal number using a 12-hour clock (range 01 to
-12)
-</simpara></listitem></varlistentry>
-<varlistentry><term>
-<literal>%%j</literal>:
-</term><listitem><simpara>
-the day of the year as a decimal number (range 001 to 366)
-</simpara></listitem></varlistentry>
-<varlistentry><term>
-<literal>%%k</literal>:
-</term><listitem><simpara>
-the hour (24-hour clock) as a decimal number (range 0 to 23);
-single digits are preceded by a blank
-</simpara></listitem></varlistentry>
-<varlistentry><term>
-<literal>%%l</literal>:
-</term><listitem><simpara>
-the hour (12-hour clock) as a decimal number (range 1 to 12);
-single digits are preceded by a blank
-</simpara></listitem></varlistentry>
-<varlistentry><term>
-<literal>%%m</literal>:
-</term><listitem><simpara>
-the month as a decimal number (range 01 to 12)
-</simpara></listitem></varlistentry>
-<varlistentry><term>
-<literal>%%M</literal>:
-</term><listitem><simpara>
-the minute as a decimal number (range 00 to 59)
-</simpara></listitem></varlistentry>
-<varlistentry><term>
-<literal>%%N</literal>:
-</term><listitem><simpara>
-the micro-seconds as a decimal number
-</simpara></listitem></varlistentry>
-<varlistentry><term>
-<literal>%%p</literal>:
-</term><listitem><simpara>
-either "AM" or "PM" according to the given time value, or the
-corresponding strings for the current locale. Noon is treated as
-"PM" and midnight as "AM".
-</simpara></listitem></varlistentry>
-<varlistentry><term>
-<literal>%%P</literal>:
-</term><listitem><simpara>
-like %%p but lowercase: "am" or "pm" or a corresponding string for
-the current locale
-</simpara></listitem></varlistentry>
-<varlistentry><term>
-<literal>%%r</literal>:
-</term><listitem><simpara>
-the time in a.m. or p.m. notation
-</simpara></listitem></varlistentry>
-<varlistentry><term>
-<literal>%%R</literal>:
-</term><listitem><simpara>
-the time in 24-hour notation (<literal>%%H:%%M</literal>)
-</simpara></listitem></varlistentry>
-<varlistentry><term>
-<literal>%%s</literal>:
-</term><listitem><simpara>
-the number of seconds since the Epoch, that is, since 1970-01-01
-00:00:00 UTC
-</simpara></listitem></varlistentry>
-<varlistentry><term>
-<literal>%%S</literal>:
-</term><listitem><simpara>
-the second as a decimal number (range 00 to 60)
-</simpara></listitem></varlistentry>
-<varlistentry><term>
-<literal>%%t</literal>:
-</term><listitem><simpara>
-a tab character
-</simpara></listitem></varlistentry>
-<varlistentry><term>
-<literal>%%u</literal>:
-</term><listitem><simpara>
-the day of the week as a decimal, range 1 to 7, Monday being 1
-</simpara></listitem></varlistentry>
-<varlistentry><term>
-<literal>%%W</literal>:
-</term><listitem><simpara>
-the week number of the current year as a decimal number
-</simpara></listitem></varlistentry>
-<varlistentry><term>
-<literal>%%x</literal>:
-</term><listitem><simpara>
-the preferred date representation for the current locale without
-the time
-</simpara></listitem></varlistentry>
-<varlistentry><term>
-<literal>%%X</literal>:
-</term><listitem><simpara>
-the preferred time representation for the current locale without
-the date
-</simpara></listitem></varlistentry>
-<varlistentry><term>
-<literal>%%y</literal>:
-</term><listitem><simpara>
-the year as a decimal number without the century
-</simpara></listitem></varlistentry>
-<varlistentry><term>
-<literal>%%Y</literal>:
-</term><listitem><simpara>
-the year as a decimal number including the century
-</simpara></listitem></varlistentry>
-<varlistentry><term>
-<literal>%%z</literal>:
-</term><listitem><simpara>
-the time-zone as hour offset from UTC
-</simpara></listitem></varlistentry>
-<varlistentry><term>
-<literal>%%Z</literal>:
-</term><listitem><simpara>
-the time zone or name or abbreviation
-</simpara></listitem></varlistentry>
-<varlistentry><term>
-<literal>%%%</literal>:
-</term><listitem><simpara>
-a literal <literal>%%</literal> character
-</simpara></listitem></varlistentry>
-</variablelist>
-
-Since: 2.26
-
-</description>
-<parameters>
-<parameter name="datetime">
-<parameter_description> A #GDateTime
+<parameter name="converter">
+<parameter_description> conversion descriptor from g_iconv_open()
</parameter_description>
</parameter>
-<parameter name="format">
-<parameter_description> a valid UTF-8 string, containing the format for the
-#GDateTime
+<parameter name="bytes_read">
+<parameter_description> location to store the number of bytes in the
+input string that were successfully converted, or %NULL.
+Even if the conversion was successful, this may be
+less than @len if there were partial characters
+at the end of the input. If the error
+#G_CONVERT_ERROR_ILLEGAL_SEQUENCE occurs, the value
+stored will the byte offset after the last valid
+input sequence.
+</parameter_description>
+</parameter>
+<parameter name="bytes_written">
+<parameter_description> the number of bytes stored in the output buffer (not
+including the terminating nul).
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> location to store the error occuring, or %NULL to ignore
+errors. Any of the errors in #GConvertError may occur.
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated string formatted to the requested format
-or %NULL in the case that there was an error. The string
-should be freed with g_free().
-
+<return> If the conversion was successful, a newly allocated
+nul-terminated string, which must be freed with
+g_free(). Otherwise %NULL and @error will be set.
</return>
</function>
-<function name="g_date_time_get_day_of_month">
+<function name="g_creat">
<description>
-Retrieves the day of the month represented by @datetime in the gregorian
-calendar.
+A wrapper for the POSIX creat() function. The creat() function is
+used to convert a pathname into a file descriptor, creating a file
+if necessary.
-Since: 2.26
+On POSIX systems file descriptors are implemented by the operating
+system. On Windows, it's the C library that implements creat() and
+file descriptors. The actual Windows API for opening files is
+different, see MSDN documentation for CreateFile(). The Win32 API
+uses file handles, which are more randomish integers, not small
+integers like file descriptors.
+
+Because file descriptors are specific to the C library on Windows,
+the file descriptor returned by this function makes sense only to
+functions in the same C library. Thus if the GLib-using code uses a
+different C library than GLib does, the file descriptor returned by
+this function cannot be passed to C library functions like write()
+or read().
+
+See your C library manual for more details about creat().
+
+Since: 2.8
</description>
<parameters>
-<parameter name="datetime">
-<parameter_description> a #GDateTime
+<parameter name="filename">
+<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows)
+</parameter_description>
+</parameter>
+<parameter name="mode">
+<parameter_description> as in creat()
</parameter_description>
</parameter>
</parameters>
-<return> the day of the month
+<return> a new file descriptor, or -1 if an error occurred. The
+return value can be used exactly like the return value from creat().
</return>
</function>
-<function name="g_date_time_get_day_of_week">
+<function name="g_datalist_clear">
<description>
-Retrieves the ISO 8601 day of the week on which @datetime falls (1 is
-Monday, 2 is Tuesday... 7 is Sunday).
-
-Since: 2.26
+Frees all the data elements of the datalist.
+The data elements' destroy functions are called
+if they have been set.
</description>
<parameters>
-<parameter name="datetime">
-<parameter_description> a #GDateTime
+<parameter name="datalist">
+<parameter_description> a datalist.
</parameter_description>
</parameter>
</parameters>
-<return> the day of the week
-
-</return>
+<return></return>
</function>
-<function name="g_date_time_get_day_of_year">
+<function name="g_datalist_foreach">
<description>
-Retrieves the day of the year represented by @datetime in the Gregorian
-calendar.
-
-Since: 2.26
+Calls the given function for each data element of the datalist. The
+function is called with each data element's #GQuark id and data,
+together with the given @user_data parameter. Note that this
+function is NOT thread-safe. So unless @datalist can be protected
+from any modifications during invocation of this function, it should
+not be called.
</description>
<parameters>
-<parameter name="datetime">
-<parameter_description> a #GDateTime
+<parameter name="datalist">
+<parameter_description> a datalist.
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> the function to call for each data element.
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> user data to pass to the function.
</parameter_description>
</parameter>
</parameters>
-<return> the day of the year
-
-</return>
+<return></return>
</function>
-<function name="g_date_time_get_hour">
+<function name="g_datalist_get_data">
<description>
-Retrieves the hour of the day represented by @datetime
-
-Since: 2.26
+Gets a data element, using its string identifer. This is slower than
+g_datalist_id_get_data() because it compares strings.
</description>
<parameters>
-<parameter name="datetime">
-<parameter_description> a #GDateTime
+<parameter name="dl">
+<parameter_description> a datalist.
+</parameter_description>
+</parameter>
+<parameter name="k">
+<parameter_description> the string identifying a data element.
</parameter_description>
</parameter>
</parameters>
-<return> the hour of the day
-
+<return> the data element, or %NULL if it is not found.
</return>
</function>
-<function name="g_date_time_get_microsecond">
+<function name="g_datalist_get_flags">
<description>
-Retrieves the microsecond of the date represented by @datetime
+Gets flags values packed in together with the datalist.
+See g_datalist_set_flags().
-Since: 2.26
+Since: 2.8
</description>
<parameters>
-<parameter name="datetime">
-<parameter_description> a #GDateTime
+<parameter name="datalist">
+<parameter_description> pointer to the location that holds a list
</parameter_description>
</parameter>
</parameters>
-<return> the microsecond of the second
+<return> the flags of the datalist
</return>
</function>
-<function name="g_date_time_get_minute">
+<function name="g_datalist_id_get_data">
<description>
-Retrieves the minute of the hour represented by @datetime
-
-Since: 2.26
+Retrieves the data element corresponding to @key_id.
</description>
<parameters>
-<parameter name="datetime">
-<parameter_description> a #GDateTime
+<parameter name="datalist">
+<parameter_description> a datalist.
+</parameter_description>
+</parameter>
+<parameter name="key_id">
+<parameter_description> the #GQuark identifying a data element.
</parameter_description>
</parameter>
</parameters>
-<return> the minute of the hour
-
+<return> the data element, or %NULL if it is not found.
</return>
</function>
-<function name="g_date_time_get_month">
+<function name="g_datalist_id_remove_data">
<description>
-Retrieves the month of the year represented by @datetime in the Gregorian
-calendar.
-
-Since: 2.26
+Removes an element, using its #GQuark identifier.
</description>
<parameters>
-<parameter name="datetime">
-<parameter_description> a #GDateTime
+<parameter name="dl">
+<parameter_description> a datalist.
+</parameter_description>
+</parameter>
+<parameter name="q">
+<parameter_description> the #GQuark identifying the data element.
</parameter_description>
</parameter>
</parameters>
-<return> the month represented by @datetime
-
-</return>
+<return></return>
</function>
-<function name="g_date_time_get_second">
+<function name="g_datalist_id_remove_no_notify">
<description>
-Retrieves the second of the minute represented by @datetime
-
-Since: 2.26
+Removes an element, without calling its destroy notification
+function.
</description>
<parameters>
-<parameter name="datetime">
-<parameter_description> a #GDateTime
+<parameter name="datalist">
+<parameter_description> a datalist.
+</parameter_description>
+</parameter>
+<parameter name="key_id">
+<parameter_description> the #GQuark identifying a data element.
</parameter_description>
</parameter>
</parameters>
-<return> the second represented by @datetime
-
+<return> the data previously stored at @key_id, or %NULL if none.
</return>
</function>
-<function name="g_date_time_get_seconds">
+<function name="g_datalist_id_set_data">
<description>
-Retrieves the number of seconds since the start of the last minute,
-including the fractional part.
-
-Since: 2.26
+Sets the data corresponding to the given #GQuark id. Any previous
+data with the same key is removed, and its destroy function is
+called.
</description>
<parameters>
-<parameter name="datetime">
-<parameter_description> a #GDateTime
+<parameter name="dl">
+<parameter_description> a datalist.
+</parameter_description>
+</parameter>
+<parameter name="q">
+<parameter_description> the #GQuark to identify the data element.
+</parameter_description>
+</parameter>
+<parameter name="d">
+<parameter_description> the data element, or %NULL to remove any previous element
+corresponding to @q.
</parameter_description>
</parameter>
</parameters>
-<return> the number of seconds
-
-</return>
+<return></return>
</function>
-<function name="g_date_time_get_timezone_abbreviation">
+<function name="g_datalist_id_set_data_full">
<description>
-Determines the time zone abbreviation to be used at the time and in
-the time zone of @datetime.
-
-For example, in Toronto this is currently "EST" during the winter
-months and "EDT" during the summer months when daylight savings
-time is in effect.
-
-Since: 2.26
+Sets the data corresponding to the given #GQuark id, and the
+function to be called when the element is removed from the datalist.
+Any previous data with the same key is removed, and its destroy
+function is called.
</description>
<parameters>
-<parameter name="datetime">
-<parameter_description> a #GDateTime
+<parameter name="datalist">
+<parameter_description> a datalist.
+</parameter_description>
+</parameter>
+<parameter name="key_id">
+<parameter_description> the #GQuark to identify the data element.
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> the data element or %NULL to remove any previous element
+corresponding to @key_id.
+</parameter_description>
+</parameter>
+<parameter name="destroy_func">
+<parameter_description> the function to call when the data element is
+removed. This function will be called with the data
+element and can be used to free any memory allocated
+for it. If @data is %NULL, then @destroy_func must
+also be %NULL.
</parameter_description>
</parameter>
</parameters>
-<return> the time zone abbreviation. The returned
-string is owned by the #GDateTime and it should not be
-modified or freed
-
-</return>
+<return></return>
</function>
-<function name="g_date_time_get_utc_offset">
+<function name="g_datalist_init">
<description>
-Determines the offset to UTC in effect at the time and in the time
-zone of @datetime.
-
-The offset is the number of microseconds that you add to UTC time to
-arrive at local time for the time zone (ie: negative numbers for time
-zones west of GMT, positive numbers for east).
-
-If @datetime represents UTC time, then the offset is always zero.
-
-Since: 2.26
+Resets the datalist to %NULL. It does not free any memory or call
+any destroy functions.
</description>
<parameters>
-<parameter name="datetime">
-<parameter_description> a #GDateTime
+<parameter name="datalist">
+<parameter_description> a pointer to a pointer to a datalist.
</parameter_description>
</parameter>
</parameters>
-<return> the number of microseconds that should be added to UTC to
-get the local time
-
-</return>
+<return></return>
</function>
-<function name="g_date_time_get_week_numbering_year">
+<function name="g_datalist_remove_data">
<description>
-Returns the ISO 8601 week-numbering year in which the week containing
- datetime falls.
-
-This function, taken together with g_date_time_get_week_of_year() and
-g_date_time_get_day_of_week() can be used to determine the full ISO
-week date on which @datetime falls.
-
-This is usually equal to the normal Gregorian year (as returned by
-g_date_time_get_year()), except as detailed below:
-
-For Thursday, the week-numbering year is always equal to the usual
-calendar year. For other days, the number is such that every day
-within a complete week (Monday to Sunday) is contained within the
-same week-numbering year.
-
-For Monday, Tuesday and Wednesday occuring near the end of the year,
-this may mean that the week-numbering year is one greater than the
-calendar year (so that these days have the same week-numbering year
-as the Thursday occuring early in the next year).
-
-For Friday, Saturaday and Sunday occuring near the start of the year,
-this may mean that the week-numbering year is one less than the
-calendar year (so that these days have the same week-numbering year
-as the Thursday occuring late in the previous year).
-
-An equivalent description is that the week-numbering year is equal to
-the calendar year containing the majority of the days in the current
-week (Monday to Sunday).
-
-Note that January 1 0001 in the proleptic Gregorian calendar is a
-Monday, so this function never returns 0.
-
-Since: 2.26
+Removes an element using its string identifier. The data element's
+destroy function is called if it has been set.
</description>
<parameters>
-<parameter name="datetime">
-<parameter_description> a #GDateTime
+<parameter name="dl">
+<parameter_description> a datalist.
+</parameter_description>
+</parameter>
+<parameter name="k">
+<parameter_description> the string identifying the data element.
</parameter_description>
</parameter>
</parameters>
-<return> the ISO 8601 week-numbering year for @datetime
-
-</return>
+<return></return>
</function>
-<function name="g_date_time_get_week_of_year">
+<function name="g_datalist_remove_no_notify">
<description>
-Returns the ISO 8601 week number for the week containing @datetime.
-The ISO 8601 week number is the same for every day of the week (from
-Moday through Sunday). That can produce some unusual results
-(described below).
-
-The first week of the year is week 1. This is the week that contains
-the first Thursday of the year. Equivalently, this is the first week
-that has more than 4 of its days falling within the calendar year.
-
-The value 0 is never returned by this function. Days contained
-within a year but occuring before the first ISO 8601 week of that
-year are considered as being contained in the last week of the
-previous year. Similarly, the final days of a calendar year may be
-considered as being part of the first ISO 8601 week of the next year
-if 4 or more days of that week are contained within the new year.
-
-Since: 2.26
+Removes an element, without calling its destroy notifier.
</description>
<parameters>
-<parameter name="datetime">
-<parameter_description> a #GDateTime
+<parameter name="dl">
+<parameter_description> a datalist.
+</parameter_description>
+</parameter>
+<parameter name="k">
+<parameter_description> the string identifying the data element.
</parameter_description>
</parameter>
</parameters>
-<return> the ISO 8601 week number for @datetime.
-
-</return>
+<return></return>
</function>
-<function name="g_date_time_get_year">
+<function name="g_datalist_set_data">
<description>
-Retrieves the year represented by @datetime in the Gregorian calendar.
-
-Since: 2.26
+Sets the data element corresponding to the given string identifier.
</description>
<parameters>
-<parameter name="datetime">
-<parameter_description> A #GDateTime
+<parameter name="dl">
+<parameter_description> a datalist.
+</parameter_description>
+</parameter>
+<parameter name="k">
+<parameter_description> the string to identify the data element.
+</parameter_description>
+</parameter>
+<parameter name="d">
+<parameter_description> the data element, or %NULL to remove any previous element
+corresponding to @k.
</parameter_description>
</parameter>
</parameters>
-<return> the year represented by @datetime
-
-</return>
+<return></return>
</function>
-<function name="g_date_time_get_ymd">
+<function name="g_datalist_set_data_full">
<description>
-Retrieves the Gregorian day, month, and year of a given #GDateTime.
-
-Since: 2.26
+Sets the data element corresponding to the given string identifier,
+and the function to be called when the data element is removed.
</description>
<parameters>
-<parameter name="datetime">
-<parameter_description> a #GDateTime.
+<parameter name="dl">
+<parameter_description> a datalist.
</parameter_description>
</parameter>
-<parameter name="year">
-<parameter_description> the return location for the gregorian year, or %NULL.
+<parameter name="k">
+<parameter_description> the string to identify the data element.
</parameter_description>
</parameter>
-<parameter name="month">
-<parameter_description> the return location for the month of the year, or %NULL.
+<parameter name="d">
+<parameter_description> the data element, or %NULL to remove any previous element
+corresponding to @k.
</parameter_description>
</parameter>
-<parameter name="day">
-<parameter_description> the return location for the day of the month, or %NULL.
+<parameter name="f">
+<parameter_description> the function to call when the data element is removed. This
+function will be called with the data element and can be used to
+free any memory allocated for it. If @d is %NULL, then @f must
+also be %NULL.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_date_time_hash">
+<function name="g_datalist_set_flags">
<description>
-Hashes @datetime into a #guint, suitable for use within #GHashTable.
+Turns on flag values for a data list. This function is used
+to keep a small number of boolean flags in an object with
+a data list without using any additional space. It is
+not generally useful except in circumstances where space
+is very tight. (It is used in the base #GObject type, for
+example.)
-Since: 2.26
+Since: 2.8
</description>
<parameters>
-<parameter name="datetime">
-<parameter_description> a #GDateTime
+<parameter name="datalist">
+<parameter_description> pointer to the location that holds a list
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> the flags to turn on. The values of the flags are
+restricted by %G_DATALIST_FLAGS_MASK (currently
+3; giving two possible boolean flags).
+A value for @flags that doesn't fit within the mask is
+an error.
</parameter_description>
</parameter>
</parameters>
-<return> a #guint containing the hash
-
-</return>
+<return></return>
</function>
-<function name="g_date_time_is_daylight_savings">
+<function name="g_datalist_unset_flags">
<description>
-Determines if daylight savings time is in effect at the time and in
-the time zone of @datetime.
+Turns off flag values for a data list. See g_datalist_unset_flags()
-Since: 2.26
+Since: 2.8
</description>
<parameters>
-<parameter name="datetime">
-<parameter_description> a #GDateTime
+<parameter name="datalist">
+<parameter_description> pointer to the location that holds a list
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> the flags to turn off. The values of the flags are
+restricted by %G_DATALIST_FLAGS_MASK (currently
+3: giving two possible boolean flags).
+A value for @flags that doesn't fit within the mask is
+an error.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if daylight savings time is in effect
-
-</return>
+<return></return>
</function>
-<function name="g_date_time_new">
+<function name="g_dataset_destroy">
<description>
-Creates a new #GDateTime corresponding to the given date and time in
-the time zone @tz.
-
-The @year must be between 1 and 9999, @month between 1 and 12 and @day
-between 1 and 28, 29, 30 or 31 depending on the month and the year.
-
- hour must be between 0 and 23 and @minute must be between 0 and 59.
-
- seconds must be at least 0.0 and must be strictly less than 60.0.
-It will be rounded down to the nearest microsecond.
-
-If the given time is not representable in the given time zone (for
-example, 02:30 on March 14th 2010 in Toronto, due to daylight savings
-time) then the time will be rounded up to the nearest existing time
-(in this case, 03:00). If this matters to you then you should verify
-the return value for containing the same as the numbers you gave.
-
-In the case that the given time is ambiguous in the given time zone
-(for example, 01:30 on November 7th 2010 in Toronto, due to daylight
-savings time) then the time falling within standard (ie:
-non-daylight) time is taken.
-
-It not considered a programmer error for the values to this function
-to be out of range, but in the case that they are, the function will
-return %NULL.
-
-You should release the return value by calling g_date_time_unref()
-when you are done with it.
-
-Since: 2.26
+Destroys the dataset, freeing all memory allocated, and calling any
+destroy functions set for data elements.
</description>
<parameters>
-<parameter name="tz">
-<parameter_description> a #GTimeZone
-</parameter_description>
-</parameter>
-<parameter name="year">
-<parameter_description> the year component of the date
-</parameter_description>
-</parameter>
-<parameter name="month">
-<parameter_description> the month component of the date
-</parameter_description>
-</parameter>
-<parameter name="day">
-<parameter_description> the day component of the date
+<parameter name="dataset_location">
+<parameter_description> the location identifying the dataset.
</parameter_description>
</parameter>
-<parameter name="hour">
-<parameter_description> the hour component of the date
+</parameters>
+<return></return>
+</function>
+
+<function name="g_dataset_foreach">
+<description>
+Calls the given function for each data element which is associated
+with the given location. Note that this function is NOT thread-safe.
+So unless @datalist can be protected from any modifications during
+invocation of this function, it should not be called.
+
+</description>
+<parameters>
+<parameter name="dataset_location">
+<parameter_description> the location identifying the dataset.
</parameter_description>
</parameter>
-<parameter name="minute">
-<parameter_description> the minute component of the date
+<parameter name="func">
+<parameter_description> the function to call for each data element.
</parameter_description>
</parameter>
-<parameter name="seconds">
-<parameter_description> the number of seconds past the minute
+<parameter name="user_data">
+<parameter_description> user data to pass to the function.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GDateTime, or %NULL
-
-</return>
+<return></return>
</function>
-<function name="g_date_time_new_from_timeval_local">
+<function name="g_dataset_get_data">
<description>
-Creates a #GDateTime corresponding to the given #GTimeVal @tv in the
-local time zone.
-
-The time contained in a #GTimeVal is always stored in the form of
-seconds elapsed since 1970-01-01 00:00:00 UTC, regardless of the
-local time offset.
-
-This call can fail (returning %NULL) if @tv represents a time outside
-of the supported range of #GDateTime.
-
-You should release the return value by calling g_date_time_unref()
-when you are done with it.
-
-Since: 2.26
+Gets the data element corresponding to a string.
</description>
<parameters>
-<parameter name="tv">
-<parameter_description> a #GTimeVal
+<parameter name="l">
+<parameter_description> the location identifying the dataset.
+</parameter_description>
+</parameter>
+<parameter name="k">
+<parameter_description> the string identifying the data element.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GDateTime, or %NULL
-
+<return> the data element corresponding to the string, or %NULL if
+it is not found.
</return>
</function>
-<function name="g_date_time_new_from_timeval_utc">
+<function name="g_dataset_id_get_data">
<description>
-Creates a #GDateTime corresponding to the given #GTimeVal @tv in UTC.
-
-The time contained in a #GTimeVal is always stored in the form of
-seconds elapsed since 1970-01-01 00:00:00 UTC.
-
-This call can fail (returning %NULL) if @tv represents a time outside
-of the supported range of #GDateTime.
-
-You should release the return value by calling g_date_time_unref()
-when you are done with it.
-
-Since: 2.26
+Gets the data element corresponding to a #GQuark.
</description>
<parameters>
-<parameter name="tv">
-<parameter_description> a #GTimeVal
+<parameter name="dataset_location">
+<parameter_description> the location identifying the dataset.
+</parameter_description>
+</parameter>
+<parameter name="key_id">
+<parameter_description> the #GQuark id to identify the data element.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GDateTime, or %NULL
-
+<return> the data element corresponding to the #GQuark, or %NULL if
+it is not found.
</return>
</function>
-<function name="g_date_time_new_from_unix_local">
+<function name="g_dataset_id_remove_data">
<description>
-Creates a #GDateTime corresponding to the given Unix time @t in the
-local time zone.
-
-Unix time is the number of seconds that have elapsed since 1970-01-01
-00:00:00 UTC, regardless of the local time offset.
-
-This call can fail (returning %NULL) if @t represents a time outside
-of the supported range of #GDateTime.
-
-You should release the return value by calling g_date_time_unref()
-when you are done with it.
-
-Since: 2.26
+Removes a data element from a dataset. The data element's destroy
+function is called if it has been set.
</description>
<parameters>
-<parameter name="t">
-<parameter_description> the Unix time
+<parameter name="l">
+<parameter_description> the location identifying the dataset.
+</parameter_description>
+</parameter>
+<parameter name="k">
+<parameter_description> the #GQuark id identifying the data element.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GDateTime, or %NULL
-
-</return>
+<return></return>
</function>
-<function name="g_date_time_new_from_unix_utc">
+<function name="g_dataset_id_remove_no_notify">
<description>
-Creates a #GDateTime corresponding to the given Unix time @t in UTC.
-
-Unix time is the number of seconds that have elapsed since 1970-01-01
-00:00:00 UTC.
-
-This call can fail (returning %NULL) if @t represents a time outside
-of the supported range of #GDateTime.
-
-You should release the return value by calling g_date_time_unref()
-when you are done with it.
-
-Since: 2.26
+Removes an element, without calling its destroy notification
+function.
</description>
<parameters>
-<parameter name="t">
-<parameter_description> the Unix time
+<parameter name="dataset_location">
+<parameter_description> the location identifying the dataset.
+</parameter_description>
+</parameter>
+<parameter name="key_id">
+<parameter_description> the #GQuark ID identifying the data element.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GDateTime, or %NULL
-
+<return> the data previously stored at @key_id, or %NULL if none.
</return>
</function>
-<function name="g_date_time_new_local">
+<function name="g_dataset_id_set_data">
<description>
-Creates a new #GDateTime corresponding to the given date and time in
-the local time zone.
-
-This call is equivalent to calling g_date_time_new() with the time
-zone returned by g_time_zone_new_local().
-
-Since: 2.26.
+Sets the data element associated with the given #GQuark id. Any
+previous data with the same key is removed, and its destroy function
+is called.
</description>
<parameters>
-<parameter name="year">
-<parameter_description> the year component of the date
+<parameter name="l">
+<parameter_description> the location identifying the dataset.
</parameter_description>
</parameter>
-<parameter name="month">
-<parameter_description> the month component of the date
+<parameter name="k">
+<parameter_description> the #GQuark id to identify the data element.
</parameter_description>
</parameter>
-<parameter name="day">
-<parameter_description> the day component of the date
+<parameter name="d">
+<parameter_description> the data element.
</parameter_description>
</parameter>
-<parameter name="hour">
-<parameter_description> the hour component of the date
+</parameters>
+<return></return>
+</function>
+
+<function name="g_dataset_id_set_data_full">
+<description>
+Sets the data element associated with the given #GQuark id, and also
+the function to call when the data element is destroyed. Any
+previous data with the same key is removed, and its destroy function
+is called.
+
+</description>
+<parameters>
+<parameter name="dataset_location">
+<parameter_description> the location identifying the dataset.
</parameter_description>
</parameter>
-<parameter name="minute">
-<parameter_description> the minute component of the date
+<parameter name="key_id">
+<parameter_description> the #GQuark id to identify the data element.
</parameter_description>
</parameter>
-<parameter name="seconds">
-<parameter_description> the number of seconds past the minute
+<parameter name="data">
+<parameter_description> the data element.
+</parameter_description>
+</parameter>
+<parameter name="destroy_func">
+<parameter_description> the function to call when the data element is
+removed. This function will be called with the data
+element and can be used to free any memory allocated
+for it.
</parameter_description>
</parameter>
</parameters>
-<return> a #GDateTime, or %NULL
-
-</return>
+<return></return>
</function>
-<function name="g_date_time_new_now">
+<function name="g_dataset_remove_data">
<description>
-Creates a #GDateTime corresponding to this exact instant in the given
-time zone @tz. The time is as accurate as the system allows, to a
-maximum accuracy of 1 microsecond.
-
-This function will always succeed unless the system clock is set to
-truly insane values (or unless GLib is still being used after the
-year 9999).
-
-You should release the return value by calling g_date_time_unref()
-when you are done with it.
-
-Since: 2.26
+Removes a data element corresponding to a string. Its destroy
+function is called if it has been set.
</description>
<parameters>
-<parameter name="tz">
-<parameter_description> a #GTimeZone
+<parameter name="l">
+<parameter_description> the location identifying the dataset.
+</parameter_description>
+</parameter>
+<parameter name="k">
+<parameter_description> the string identifying the data element.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GDateTime, or %NULL
-
-</return>
+<return></return>
</function>
-<function name="g_date_time_new_now_local">
+<function name="g_dataset_remove_no_notify">
<description>
-Creates a #GDateTime corresponding to this exact instant in the local
-time zone.
-
-This is equivalent to calling g_date_time_new_now() with the time
-zone returned by g_time_zone_new_local().
-
-Since: 2.26
+Removes an element, without calling its destroy notifier.
</description>
<parameters>
+<parameter name="l">
+<parameter_description> the location identifying the dataset.
+</parameter_description>
+</parameter>
+<parameter name="k">
+<parameter_description> the string identifying the data element.
+</parameter_description>
+</parameter>
</parameters>
-<return> a new #GDateTime, or %NULL
-
-</return>
+<return></return>
</function>
-<function name="g_date_time_new_now_utc">
+<function name="g_dataset_set_data">
<description>
-Creates a #GDateTime corresponding to this exact instant in UTC.
-
-This is equivalent to calling g_date_time_new_now() with the time
-zone returned by g_time_zone_new_utc().
-
-Since: 2.26
+Sets the data corresponding to the given string identifier.
</description>
<parameters>
+<parameter name="l">
+<parameter_description> the location identifying the dataset.
+</parameter_description>
+</parameter>
+<parameter name="k">
+<parameter_description> the string to identify the data element.
+</parameter_description>
+</parameter>
+<parameter name="d">
+<parameter_description> the data element.
+</parameter_description>
+</parameter>
</parameters>
-<return> a new #GDateTime, or %NULL
-
-</return>
+<return></return>
</function>
-<function name="g_date_time_new_utc">
+<function name="g_dataset_set_data_full">
<description>
-Creates a new #GDateTime corresponding to the given date and time in
-UTC.
-
-This call is equivalent to calling g_date_time_new() with the time
-zone returned by g_time_zone_new_utc().
-
-Since: 2.26.
+Sets the data corresponding to the given string identifier, and the
+function to call when the data element is destroyed.
</description>
<parameters>
-<parameter name="year">
-<parameter_description> the year component of the date
-</parameter_description>
-</parameter>
-<parameter name="month">
-<parameter_description> the month component of the date
-</parameter_description>
-</parameter>
-<parameter name="day">
-<parameter_description> the day component of the date
+<parameter name="l">
+<parameter_description> the location identifying the dataset.
</parameter_description>
</parameter>
-<parameter name="hour">
-<parameter_description> the hour component of the date
+<parameter name="k">
+<parameter_description> the string to identify the data element.
</parameter_description>
</parameter>
-<parameter name="minute">
-<parameter_description> the minute component of the date
+<parameter name="d">
+<parameter_description> the data element.
</parameter_description>
</parameter>
-<parameter name="seconds">
-<parameter_description> the number of seconds past the minute
+<parameter name="f">
+<parameter_description> the function to call when the data element is removed. This
+function will be called with the data element and can be used to
+free any memory allocated for it.
</parameter_description>
</parameter>
</parameters>
-<return> a #GDateTime, or %NULL
-
-</return>
+<return></return>
</function>
-<function name="g_date_time_ref">
+<function name="g_date_get_iso8601_week_of_year">
<description>
-Atomically increments the reference count of @datetime by one.
+Returns the week of the year, where weeks are interpreted according
+to ISO 8601.
-Since: 2.26
+Since: 2.6
</description>
<parameters>
-<parameter name="datetime">
-<parameter_description> a #GDateTime
+<parameter name="date">
+<parameter_description> a valid #GDate
</parameter_description>
</parameter>
</parameters>
-<return> the #GDateTime with the reference count increased
+<return> ISO 8601 week number of the year.
</return>
</function>
-<function name="g_date_time_to_local">
+<function name="g_date_set_time">
<description>
-Creates a new #GDateTime corresponding to the same instant in time as
- datetime, but in the local time zone.
+Sets the value of a date from a #GTime value.
+The time to date conversion is done using the user's current timezone.
-This call is equivalent to calling g_date_time_to_timezone() with the
-time zone returned by g_time_zone_new_local().
-
-Since: 2.26
+Deprecated: 2.10: Use g_date_set_time_t() instead.
</description>
<parameters>
-<parameter name="datetime">
-<parameter_description> a #GDateTime
+<parameter name="date">
+<parameter_description> a #GDate.
+</parameter_description>
+</parameter>
+<parameter name="time_">
+<parameter_description> #GTime value to set.
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #GDateTime
-
-</return>
+<return></return>
</function>
-<function name="g_date_time_to_timeval">
+<function name="g_date_set_time_t">
<description>
-Stores the instant in time that @datetime represents into @tv.
-
-The time contained in a #GTimeVal is always stored in the form of
-seconds elapsed since 1970-01-01 00:00:00 UTC, regardless of the time
-zone associated with @datetime.
-
-On systems where 'long' is 32bit (ie: all 32bit systems and all
-Windows systems), a #GTimeVal is incapable of storing the entire
-range of values that #GDateTime is capable of expressing. On those
-systems, this function returns %FALSE to indicate that the time is
-out of range.
+Sets the value of a date to the date corresponding to a time
+specified as a time_t. The time to date conversion is done using
+the user's current timezone.
-On systems where 'long' is 64bit, this function never fails.
+To set the value of a date to the current day, you could write:
+|[
+g_date_set_time_t (date, time (NULL));
+]|
-Since: 2.26
+Since: 2.10
</description>
<parameters>
-<parameter name="datetime">
-<parameter_description> a #GDateTime
+<parameter name="date">
+<parameter_description> a #GDate
</parameter_description>
</parameter>
-<parameter name="tv">
-<parameter_description> a #GTimeVal to modify
+<parameter name="timet">
+<parameter_description> <type>time_t</type> value to set
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if successful, else %FALSE
-
-</return>
+<return></return>
</function>
-<function name="g_date_time_to_timezone">
+<function name="g_date_set_time_val">
<description>
-Create a new #GDateTime corresponding to the same instant in time as
- datetime, but in the time zone @tz.
-
-This call can fail in the case that the time goes out of bounds. For
-example, converting 0001-01-01 00:00:00 UTC to a time zone west of
-Greenwich will fail (due to the year 0 being out of range).
+Sets the value of a date from a #GTimeVal value. Note that the
+ tv_usec member is ignored, because #GDate can't make use of the
+additional precision.
-You should release the return value by calling g_date_time_unref()
-when you are done with it.
+The time to date conversion is done using the user's current timezone.
-Since: 2.26
+Since: 2.10
</description>
<parameters>
-<parameter name="datetime">
-<parameter_description> a #GDateTime
+<parameter name="date">
+<parameter_description> a #GDate
</parameter_description>
</parameter>
-<parameter name="tz">
-<parameter_description> the new #GTimeZone
+<parameter name="timeval">
+<parameter_description> #GTimeVal value to set
</parameter_description>
</parameter>
</parameters>
-<return> a new #GDateTime, or %NULL
-
-</return>
+<return></return>
</function>
-<function name="g_date_time_to_unix">
+<function name="g_date_time_add">
<description>
-Gives the Unix time corresponding to @datetime, rounding down to the
-nearest second.
-
-Unix time is the number of seconds that have elapsed since 1970-01-01
-00:00:00 UTC, regardless of the time zone associated with @datetime.
+Creates a copy of @datetime and adds the specified timespan to the copy.
Since: 2.26
@@ -6882,19 +7449,21 @@ Since: 2.26
<parameter_description> a #GDateTime
</parameter_description>
</parameter>
+<parameter name="timespan">
+<parameter_description> a #GTimeSpan
+</parameter_description>
+</parameter>
</parameters>
-<return> the Unix time corresponding to @datetime
+<return> the newly created #GDateTime which should be freed with
+g_date_time_unref().
</return>
</function>
-<function name="g_date_time_to_utc">
+<function name="g_date_time_add_days">
<description>
-Creates a new #GDateTime corresponding to the same instant in time as
- datetime, but in UTC.
-
-This call is equivalent to calling g_date_time_to_timezone() with the
-time zone returned by g_time_zone_new_utc().
+Creates a copy of @datetime and adds the specified number of days to the
+copy.
Since: 2.26
@@ -6904,18 +7473,21 @@ Since: 2.26
<parameter_description> a #GDateTime
</parameter_description>
</parameter>
+<parameter name="days">
+<parameter_description> the number of days
+</parameter_description>
+</parameter>
</parameters>
-<return> the newly created #GDateTime
+<return> the newly created #GDateTime which should be freed with
+g_date_time_unref().
</return>
</function>
-<function name="g_date_time_unref">
+<function name="g_date_time_add_full">
<description>
-Atomically decrements the reference count of @datetime by one.
-
-When the reference count reaches zero, the resources allocated by
- datetime are freed
+Creates a new #GDateTime adding the specified values to the current date and
+time in @datetime.
Since: 2.26
@@ -6925,23640 +7497,32855 @@ Since: 2.26
<parameter_description> a #GDateTime
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="g_dcgettext">
-<description>
-This is a variant of g_dgettext() that allows specifying a locale
-category instead of always using %LC_MESSAGES. See g_dgettext() for
-more information about how this functions differs from calling
-dcgettext() directly.
-
-Since: 2.26
-
-</description>
-<parameters>
-<parameter name="domain">
-<parameter_description> the translation domain to use, or %NULL to use
-the domain set with textdomain()
+<parameter name="years">
+<parameter_description> the number of years to add
</parameter_description>
</parameter>
-<parameter name="msgid">
-<parameter_description> message to translate
+<parameter name="months">
+<parameter_description> the number of months to add
</parameter_description>
</parameter>
-<parameter name="category">
-<parameter_description> a locale category
+<parameter name="days">
+<parameter_description> the number of days to add
</parameter_description>
</parameter>
-</parameters>
-<return> the translated string for the given locale category
-
-</return>
-</function>
-
-<function name="g_dgettext">
-<description>
-This function is a wrapper of dgettext() which does not translate
-the message if the default domain as set with textdomain() has no
-translations for the current locale.
-
-The advantage of using this function over dgettext() proper is that
-libraries using this function (like GTK+) will not use translations
-if the application using the library does not have translations for
-the current locale. This results in a consistent English-only
-interface instead of one having partial translations. For this
-feature to work, the call to textdomain() and setlocale() should
-precede any g_dgettext() invocations. For GTK+, it means calling
-textdomain() before gtk_init or its variants.
-
-This function disables translations if and only if upon its first
-call all the following conditions hold:
-<itemizedlist>
-<listitem>@domain is not %NULL</listitem>
-<listitem>textdomain() has been called to set a default text domain</listitem>
-<listitem>there is no translations available for the default text domain
-and the current locale</listitem>
-<listitem>current locale is not "C" or any English locales (those
-starting with "en_")</listitem>
-</itemizedlist>
-
-Note that this behavior may not be desired for example if an application
-has its untranslated messages in a language other than English. In those
-cases the application should call textdomain() after initializing GTK+.
-
-Applications should normally not use this function directly,
-but use the _() macro for translations.
-
-Since: 2.18
-
-</description>
-<parameters>
-<parameter name="domain">
-<parameter_description> the translation domain to use, or %NULL to use
-the domain set with textdomain()
+<parameter name="hours">
+<parameter_description> the number of hours to add
</parameter_description>
</parameter>
-<parameter name="msgid">
-<parameter_description> message to translate
+<parameter name="minutes">
+<parameter_description> the number of minutes to add
</parameter_description>
</parameter>
-</parameters>
-<return> The translated string
-
-</return>
-</function>
-
-<function name="g_dir_close">
-<description>
-Closes the directory and deallocates all related resources.
-
-</description>
-<parameters>
-<parameter name="dir">
-<parameter_description> a #GDir* created by g_dir_open()
+<parameter name="seconds">
+<parameter_description> the number of seconds to add
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the newly created #GDateTime that should be freed with
+g_date_time_unref().
+
+</return>
</function>
-<function name="g_dir_open">
+<function name="g_date_time_add_hours">
<description>
-Opens a directory for reading. The names of the files in the
-directory can then be retrieved using g_dir_read_name(). Note
-that the ordering is not defined.
+Creates a copy of @datetime and adds the specified number of hours
+Since: 2.26
</description>
<parameters>
-<parameter name="path">
-<parameter_description> the path to the directory you are interested in. On Unix
-in the on-disk encoding. On Windows in UTF-8
-</parameter_description>
-</parameter>
-<parameter name="flags">
-<parameter_description> Currently must be set to 0. Reserved for future use.
+<parameter name="datetime">
+<parameter_description> a #GDateTime
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError, or %NULL.
-If non-%NULL, an error will be set if and only if
-g_dir_open() fails.
+<parameter name="hours">
+<parameter_description> the number of hours to add
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated #GDir on success, %NULL on failure.
-If non-%NULL, you must free the result with g_dir_close()
-when you are finished with it.
+<return> the newly created #GDateTime which should be freed with
+g_date_time_unref().
+
</return>
</function>
-<function name="g_dir_read_name">
+<function name="g_date_time_add_minutes">
<description>
-Retrieves the name of another entry in the directory, or %NULL.
-The order of entries returned from this function is not defined,
-and may vary by file system or other operating-system dependent
-factors.
-
-On Unix, the '.' and '..' entries are omitted, and the returned
-name is in the on-disk encoding.
-
-On Windows, as is true of all GLib functions which operate on
-filenames, the returned name is in UTF-8.
+Creates a copy of @datetime adding the specified number of minutes.
+Since: 2.26
</description>
<parameters>
-<parameter name="dir">
-<parameter_description> a #GDir* created by g_dir_open()
+<parameter name="datetime">
+<parameter_description> a #GDateTime
</parameter_description>
</parameter>
-</parameters>
-<return> The entry's name or %NULL if there are no
-more entries. The return value is owned by GLib and
-must not be modified or freed.
-</return>
-</function>
-
-<function name="g_dir_rewind">
-<description>
-Resets the given directory. The next call to g_dir_read_name()
-will return the first entry again.
-
-</description>
-<parameters>
-<parameter name="dir">
-<parameter_description> a #GDir* created by g_dir_open()
+<parameter name="minutes">
+<parameter_description> the number of minutes to add
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the newly created #GDateTime which should be freed with
+g_date_time_unref().
+
+</return>
</function>
-<function name="g_direct_equal">
+<function name="g_date_time_add_months">
<description>
-Compares two #gpointer arguments and returns %TRUE if they are equal.
-It can be passed to g_hash_table_new() as the @key_equal_func
-parameter, when using pointers as keys in a #GHashTable.
+Creates a copy of @datetime and adds the specified number of months to the
+copy.
+Since: 2.26
</description>
<parameters>
-<parameter name="v1">
-<parameter_description> a key.
+<parameter name="datetime">
+<parameter_description> a #GDateTime
</parameter_description>
</parameter>
-<parameter name="v2">
-<parameter_description> a key to compare with @v1.
+<parameter name="months">
+<parameter_description> the number of months
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the two keys match.
-</return>
-</function>
-
-<function name="g_direct_hash">
-<description>
-Converts a gpointer to a hash value.
-It can be passed to g_hash_table_new() as the @hash_func parameter,
-when using pointers as keys in a #GHashTable.
-
+<return> the newly created #GDateTime which should be freed with
+g_date_time_unref().
-</description>
-<parameters>
-<parameter name="v">
-<parameter_description> a #gpointer key
-</parameter_description>
-</parameter>
-</parameters>
-<return> a hash value corresponding to the key.
</return>
</function>
-<function name="g_dngettext">
+<function name="g_date_time_add_seconds">
<description>
-This function is a wrapper of dngettext() which does not translate
-the message if the default domain as set with textdomain() has no
-translations for the current locale.
-
-See g_dgettext() for details of how this differs from dngettext()
-proper.
+Creates a copy of @datetime and adds the specified number of seconds.
-Since: 2.18
+Since: 2.26
</description>
<parameters>
-<parameter name="domain">
-<parameter_description> the translation domain to use, or %NULL to use
-the domain set with textdomain()
-</parameter_description>
-</parameter>
-<parameter name="msgid">
-<parameter_description> message to translate
-</parameter_description>
-</parameter>
-<parameter name="msgid_plural">
-<parameter_description> plural form of the message
+<parameter name="datetime">
+<parameter_description> a #GDateTime
</parameter_description>
</parameter>
-<parameter name="n">
-<parameter_description> the quantity for which translation is needed
+<parameter name="seconds">
+<parameter_description> the number of seconds to add
</parameter_description>
</parameter>
</parameters>
-<return> The translated string
+<return> the newly created #GDateTime which should be freed with
+g_date_time_unref().
</return>
</function>
-<function name="g_double_equal">
+<function name="g_date_time_add_weeks">
<description>
-Compares the two #gdouble values being pointed to and returns
-%TRUE if they are equal.
-It can be passed to g_hash_table_new() as the @key_equal_func
-parameter, when using pointers to doubles as keys in a #GHashTable.
+Creates a copy of @datetime and adds the specified number of weeks to the
+copy.
-Since: 2.22
+Since: 2.26
</description>
<parameters>
-<parameter name="v1">
-<parameter_description> a pointer to a #gdouble key.
+<parameter name="datetime">
+<parameter_description> a #GDateTime
</parameter_description>
</parameter>
-<parameter name="v2">
-<parameter_description> a pointer to a #gdouble key to compare with @v1.
+<parameter name="weeks">
+<parameter_description> the number of weeks
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the two keys match.
+<return> the newly created #GDateTime which should be freed with
+g_date_time_unref().
</return>
</function>
-<function name="g_double_hash">
+<function name="g_date_time_add_years">
<description>
-Converts a pointer to a #gdouble to a hash value.
-It can be passed to g_hash_table_new() as the @hash_func parameter,
-when using pointers to doubles as keys in a #GHashTable.
+Creates a copy of @datetime and adds the specified number of years to the
+copy.
-Since: 2.22
+Since: 2.26
</description>
<parameters>
-<parameter name="v">
-<parameter_description> a pointer to a #gdouble key
+<parameter name="datetime">
+<parameter_description> a #GDateTime
+</parameter_description>
+</parameter>
+<parameter name="years">
+<parameter_description> the number of years
</parameter_description>
</parameter>
</parameters>
-<return> a hash value corresponding to the key.
+<return> the newly created #GDateTime which should be freed with
+g_date_time_unref().
</return>
</function>
-<function name="g_dpgettext">
+<function name="g_date_time_compare">
<description>
-This function is a variant of g_dgettext() which supports
-a disambiguating message context. GNU gettext uses the
-'\004' character to separate the message context and
-message id in @msgctxtid.
-If 0 is passed as @msgidoffset, this function will fall back to
-trying to use the deprecated convention of using "|" as a separation
-character.
-
-This uses g_dgettext() internally. See that functions for differences
-with dgettext() proper.
-
-Applications should normally not use this function directly,
-but use the C_() macro for translations with context.
+A comparison function for #GDateTimes that is suitable
+as a #GCompareFunc. Both #GDateTimes must be non-%NULL.
-Since: 2.16
+Since: 2.26
</description>
<parameters>
-<parameter name="domain">
-<parameter_description> the translation domain to use, or %NULL to use
-the domain set with textdomain()
-</parameter_description>
-</parameter>
-<parameter name="msgctxtid">
-<parameter_description> a combined message context and message id, separated
-by a \004 character
+<parameter name="dt1">
+<parameter_description> first #GDateTime to compare
</parameter_description>
</parameter>
-<parameter name="msgidoffset">
-<parameter_description> the offset of the message id in @msgctxid
+<parameter name="dt2">
+<parameter_description> second #GDateTime to compare
</parameter_description>
</parameter>
</parameters>
-<return> The translated string
+<return> -1, 0 or 1 if @dt1 is less than, equal to or greater
+than @dt2.
</return>
</function>
-<function name="g_dpgettext2">
+<function name="g_date_time_difference">
<description>
-This function is a variant of g_dgettext() which supports
-a disambiguating message context. GNU gettext uses the
-'\004' character to separate the message context and
-message id in @msgctxtid.
-
-This uses g_dgettext() internally. See that functions for differences
-with dgettext() proper.
-
-This function differs from C_() in that it is not a macro and
-thus you may use non-string-literals as context and msgid arguments.
+Calculates the difference in time between @end and @begin. The
+#GTimeSpan that is returned is effectively @end - @begin (ie:
+positive if the first simparameter is larger).
-Since: 2.18
+Since: 2.26
</description>
<parameters>
-<parameter name="domain">
-<parameter_description> the translation domain to use, or %NULL to use
-the domain set with textdomain()
-</parameter_description>
-</parameter>
-<parameter name="context">
-<parameter_description> the message context
+<parameter name="end">
+<parameter_description> a #GDateTime
</parameter_description>
</parameter>
-<parameter name="msgid">
-<parameter_description> the message
+<parameter name="begin">
+<parameter_description> a #GDateTime
</parameter_description>
</parameter>
</parameters>
-<return> The translated string
+<return> the difference between the two #GDateTime, as a time
+span expressed in microseconds.
</return>
</function>
-<function name="g_error_copy">
+<function name="g_date_time_equal">
<description>
-Makes a copy of @error.
+Checks to see if @dt1 and @dt2 are equal.
+Equal here means that they represent the same moment after converting
+them to the same time zone.
+
+Since: 2.26
</description>
<parameters>
-<parameter name="error">
-<parameter_description> a #GError
+<parameter name="dt1">
+<parameter_description> a #GDateTime
</parameter_description>
</parameter>
-</parameters>
-<return> a new #GError
-</return>
-</function>
-
-<function name="g_error_free">
-<description>
-Frees a #GError and associated resources.
-
-</description>
-<parameters>
-<parameter name="error">
-<parameter_description> a #GError
+<parameter name="dt2">
+<parameter_description> a #GDateTime
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @dt1 and @dt2 are equal
+
+</return>
</function>
-<function name="g_error_matches">
+<function name="g_date_time_format">
<description>
-Returns %TRUE if @error matches @domain and @code, %FALSE
-otherwise. In particular, when @error is %NULL, %FALSE will
-be returned.
+Creates a newly allocated string representing the requested @format.
+The format strings understood by this function are a subset of the
+strftime() format language. In contrast to strftime(), this function
+always produces a UTF-8 string, regardless of the current locale.
+Note that the rendering of many formats is locale-dependent and may
+not match the strftime() output exactly.
-</description>
-<parameters>
-<parameter name="error">
-<parameter_description> a #GError or %NULL
-</parameter_description>
-</parameter>
-<parameter name="domain">
-<parameter_description> an error domain
-</parameter_description>
-</parameter>
-<parameter name="code">
-<parameter_description> an error code
-</parameter_description>
-</parameter>
-</parameters>
-<return> whether @error has @domain and @code
-</return>
-</function>
+The following format specifiers are supported:
-<function name="g_error_new">
-<description>
-Creates a new #GError with the given @domain and @code,
-and a message formatted with @format.
+<variablelist>
+<varlistentry><term>
+<literal>%%a</literal>:
+</term><listitem><simpara>
+the abbreviated weekday name according to the current locale
+</simpara></listitem></varlistentry>
+<varlistentry><term>
+<literal>%%A</literal>:
+</term><listitem><simpara>
+the full weekday name according to the current locale
+</simpara></listitem></varlistentry>
+<varlistentry><term>
+<literal>%%b</literal>:
+</term><listitem><simpara>
+the abbreviated month name according to the current locale
+</simpara></listitem></varlistentry>
+<varlistentry><term>
+<literal>%%B</literal>:
+</term><listitem><simpara>
+the full month name according to the current locale
+</simpara></listitem></varlistentry>
+<varlistentry><term>
+<literal>%%d</literal>:
+</term><listitem><simpara>
+the day of the month as a decimal number (range 01 to 31)
+</simpara></listitem></varlistentry>
+<varlistentry><term>
+<literal>%%e</literal>:
+</term><listitem><simpara>
+the day of the month as a decimal number (range 1 to 31)
+</simpara></listitem></varlistentry>
+<varlistentry><term>
+<literal>%%F</literal>:
+</term><listitem><simpara>
+equivalent to <literal>%%Y-%%m-%%d</literal> (the ISO 8601 date
+format)
+</simpara></listitem></varlistentry>
+<varlistentry><term>
+<literal>%%h</literal>:
+</term><listitem><simpara>
+equivalent to <literal>%%b</literal>
+</simpara></listitem></varlistentry>
+<varlistentry><term>
+<literal>%%H</literal>:
+</term><listitem><simpara>
+the hour as a decimal number using a 24-hour clock (range 00 to
+23)
+</simpara></listitem></varlistentry>
+<varlistentry><term>
+<literal>%%I</literal>:
+</term><listitem><simpara>
+the hour as a decimal number using a 12-hour clock (range 01 to
+12)
+</simpara></listitem></varlistentry>
+<varlistentry><term>
+<literal>%%j</literal>:
+</term><listitem><simpara>
+the day of the year as a decimal number (range 001 to 366)
+</simpara></listitem></varlistentry>
+<varlistentry><term>
+<literal>%%k</literal>:
+</term><listitem><simpara>
+the hour (24-hour clock) as a decimal number (range 0 to 23);
+single digits are preceded by a blank
+</simpara></listitem></varlistentry>
+<varlistentry><term>
+<literal>%%l</literal>:
+</term><listitem><simpara>
+the hour (12-hour clock) as a decimal number (range 1 to 12);
+single digits are preceded by a blank
+</simpara></listitem></varlistentry>
+<varlistentry><term>
+<literal>%%m</literal>:
+</term><listitem><simpara>
+the month as a decimal number (range 01 to 12)
+</simpara></listitem></varlistentry>
+<varlistentry><term>
+<literal>%%M</literal>:
+</term><listitem><simpara>
+the minute as a decimal number (range 00 to 59)
+</simpara></listitem></varlistentry>
+<varlistentry><term>
+<literal>%%N</literal>:
+</term><listitem><simpara>
+the micro-seconds as a decimal number
+</simpara></listitem></varlistentry>
+<varlistentry><term>
+<literal>%%p</literal>:
+</term><listitem><simpara>
+either "AM" or "PM" according to the given time value, or the
+corresponding strings for the current locale. Noon is treated as
+"PM" and midnight as "AM".
+</simpara></listitem></varlistentry>
+<varlistentry><term>
+<literal>%%P</literal>:
+</term><listitem><simpara>
+like %%p but lowercase: "am" or "pm" or a corresponding string for
+the current locale
+</simpara></listitem></varlistentry>
+<varlistentry><term>
+<literal>%%r</literal>:
+</term><listitem><simpara>
+the time in a.m. or p.m. notation
+</simpara></listitem></varlistentry>
+<varlistentry><term>
+<literal>%%R</literal>:
+</term><listitem><simpara>
+the time in 24-hour notation (<literal>%%H:%%M</literal>)
+</simpara></listitem></varlistentry>
+<varlistentry><term>
+<literal>%%s</literal>:
+</term><listitem><simpara>
+the number of seconds since the Epoch, that is, since 1970-01-01
+00:00:00 UTC
+</simpara></listitem></varlistentry>
+<varlistentry><term>
+<literal>%%S</literal>:
+</term><listitem><simpara>
+the second as a decimal number (range 00 to 60)
+</simpara></listitem></varlistentry>
+<varlistentry><term>
+<literal>%%t</literal>:
+</term><listitem><simpara>
+a tab character
+</simpara></listitem></varlistentry>
+<varlistentry><term>
+<literal>%%u</literal>:
+</term><listitem><simpara>
+the day of the week as a decimal, range 1 to 7, Monday being 1
+</simpara></listitem></varlistentry>
+<varlistentry><term>
+<literal>%%W</literal>:
+</term><listitem><simpara>
+the week number of the current year as a decimal number
+</simpara></listitem></varlistentry>
+<varlistentry><term>
+<literal>%%x</literal>:
+</term><listitem><simpara>
+the preferred date representation for the current locale without
+the time
+</simpara></listitem></varlistentry>
+<varlistentry><term>
+<literal>%%X</literal>:
+</term><listitem><simpara>
+the preferred time representation for the current locale without
+the date
+</simpara></listitem></varlistentry>
+<varlistentry><term>
+<literal>%%y</literal>:
+</term><listitem><simpara>
+the year as a decimal number without the century
+</simpara></listitem></varlistentry>
+<varlistentry><term>
+<literal>%%Y</literal>:
+</term><listitem><simpara>
+the year as a decimal number including the century
+</simpara></listitem></varlistentry>
+<varlistentry><term>
+<literal>%%z</literal>:
+</term><listitem><simpara>
+the time-zone as hour offset from UTC
+</simpara></listitem></varlistentry>
+<varlistentry><term>
+<literal>%%Z</literal>:
+</term><listitem><simpara>
+the time zone or name or abbreviation
+</simpara></listitem></varlistentry>
+<varlistentry><term>
+<literal>%%%</literal>:
+</term><listitem><simpara>
+a literal <literal>%%</literal> character
+</simpara></listitem></varlistentry>
+</variablelist>
+
+Some conversion specifications can be modified by preceding the
+conversion specifier by one or more modifier characters. The
+following modifiers are supported for many of the numeric
+conversions:
+<variablelist>
+<varlistentry>
+<term>O</term>
+<listitem>
+Use alternative numeric symbols, if the current locale
+supports those.
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>_</term>
+<listitem>
+Pad a numeric result with spaces.
+This overrides the default padding for the specifier.
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>-</term>
+<listitem>
+Do not pad a numeric result.
+This overrides the default padding for the specifier.
+</listitem>
+</varlistentry>
+<varlistentry>
+<term>0</term>
+<listitem>
+Pad a numeric result with zeros.
+This overrides the default padding for the specifier.
+</listitem>
+</varlistentry>
+</variablelist>
+Since: 2.26
</description>
<parameters>
-<parameter name="domain">
-<parameter_description> error domain
-</parameter_description>
-</parameter>
-<parameter name="code">
-<parameter_description> error code
+<parameter name="datetime">
+<parameter_description> A #GDateTime
</parameter_description>
</parameter>
<parameter name="format">
-<parameter_description> printf()-style format for error message
-</parameter_description>
-</parameter>
-<parameter name="Varargs">
-<parameter_description> parameters for message format
+<parameter_description> a valid UTF-8 string, containing the format for the
+#GDateTime
</parameter_description>
</parameter>
</parameters>
-<return> a new #GError
+<return> a newly allocated string formatted to the requested format
+or %NULL in the case that there was an error. The string
+should be freed with g_free().
+
</return>
</function>
-<function name="g_error_new_literal">
+<function name="g_date_time_get_day_of_month">
<description>
-Creates a new #GError; unlike g_error_new(), @message is
-not a printf()-style format string. Use this function if
- message contains text you don't have control over,
-that could include printf() escape sequences.
+Retrieves the day of the month represented by @datetime in the gregorian
+calendar.
+Since: 2.26
</description>
<parameters>
-<parameter name="domain">
-<parameter_description> error domain
-</parameter_description>
-</parameter>
-<parameter name="code">
-<parameter_description> error code
-</parameter_description>
-</parameter>
-<parameter name="message">
-<parameter_description> error message
+<parameter name="datetime">
+<parameter_description> a #GDateTime
</parameter_description>
</parameter>
</parameters>
-<return> a new #GError
+<return> the day of the month
+
</return>
</function>
-<function name="g_error_new_valist">
+<function name="g_date_time_get_day_of_week">
<description>
-Creates a new #GError with the given @domain and @code,
-and a message formatted with @format.
+Retrieves the ISO 8601 day of the week on which @datetime falls (1 is
+Monday, 2 is Tuesday... 7 is Sunday).
-Since: 2.22
+Since: 2.26
</description>
<parameters>
-<parameter name="domain">
-<parameter_description> error domain
-</parameter_description>
-</parameter>
-<parameter name="code">
-<parameter_description> error code
-</parameter_description>
-</parameter>
-<parameter name="format">
-<parameter_description> printf()-style format for error message
-</parameter_description>
-</parameter>
-<parameter name="args">
-<parameter_description> #va_list of parameters for the message format
+<parameter name="datetime">
+<parameter_description> a #GDateTime
</parameter_description>
</parameter>
</parameters>
-<return> a new #GError
+<return> the day of the week
</return>
</function>
-<function name="g_file_error_from_errno">
+<function name="g_date_time_get_day_of_year">
<description>
-Gets a #GFileError constant based on the passed-in @errno.
-For example, if you pass in %EEXIST this function returns
-#G_FILE_ERROR_EXIST. Unlike @errno values, you can portably
-assume that all #GFileError values will exist.
-
-Normally a #GFileError value goes into a #GError returned
-from a function that manipulates files. So you would use
-g_file_error_from_errno() when constructing a #GError.
+Retrieves the day of the year represented by @datetime in the Gregorian
+calendar.
+Since: 2.26
</description>
<parameters>
-<parameter name="err_no">
-<parameter_description> an "errno" value
+<parameter name="datetime">
+<parameter_description> a #GDateTime
</parameter_description>
</parameter>
</parameters>
-<return> #GFileError corresponding to the given @errno
+<return> the day of the year
+
</return>
</function>
-<function name="g_file_get_contents">
+<function name="g_date_time_get_hour">
<description>
-Reads an entire file into allocated memory, with good error
-checking.
-
-If the call was successful, it returns %TRUE and sets @contents to the file
-contents and @length to the length of the file contents in bytes. The string
-stored in @contents will be nul-terminated, so for text files you can pass
-%NULL for the @length argument. If the call was not successful, it returns
-%FALSE and sets @error. The error domain is #G_FILE_ERROR. Possible error
-codes are those in the #GFileError enumeration. In the error case,
- contents is set to %NULL and @length is set to zero.
+Retrieves the hour of the day represented by @datetime
+Since: 2.26
</description>
<parameters>
-<parameter name="filename">
-<parameter_description> name of a file to read contents from, in the GLib file name encoding
-</parameter_description>
-</parameter>
-<parameter name="contents">
-<parameter_description> location to store an allocated string, use g_free() to free
-the returned string
-</parameter_description>
-</parameter>
-<parameter name="length">
-<parameter_description> location to store length in bytes of the contents, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError, or %NULL
+<parameter name="datetime">
+<parameter_description> a #GDateTime
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE on success, %FALSE if an error occurred
+<return> the hour of the day
+
</return>
</function>
-<function name="g_file_open_tmp">
+<function name="g_date_time_get_microsecond">
<description>
-Opens a file for writing in the preferred directory for temporary
-files (as returned by g_get_tmp_dir()).
-
- tmpl should be a string in the GLib file name encoding containing
-a sequence of six 'X' characters, as the parameter to g_mkstemp().
-However, unlike these functions, the template should only be a
-basename, no directory components are allowed. If template is
-%NULL, a default template is used.
-
-Note that in contrast to g_mkstemp() (and mkstemp())
- tmpl is not modified, and might thus be a read-only literal string.
-
-The actual name used is returned in @name_used if non-%NULL. This
-string should be freed with g_free() when not needed any longer.
-The returned name is in the GLib file name encoding.
+Retrieves the microsecond of the date represented by @datetime
+Since: 2.26
</description>
<parameters>
-<parameter name="tmpl">
-<parameter_description> Template for file name, as in g_mkstemp(), basename only,
-or %NULL, to a default template
-</parameter_description>
-</parameter>
-<parameter name="name_used">
-<parameter_description> location to store actual name used, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError
+<parameter name="datetime">
+<parameter_description> a #GDateTime
</parameter_description>
</parameter>
</parameters>
-<return> A file handle (as from open()) to
-the file opened for reading and writing. The file is opened in binary
-mode on platforms where there is a difference. The file handle should be
-closed with close(). In case of errors, -1 is returned
-and @error will be set.
+<return> the microsecond of the second
+
</return>
</function>
-<function name="g_file_read_link">
+<function name="g_date_time_get_minute">
<description>
-Reads the contents of the symbolic link @filename like the POSIX
-readlink() function. The returned string is in the encoding used
-for filenames. Use g_filename_to_utf8() to convert it to UTF-8.
+Retrieves the minute of the hour represented by @datetime
-Since: 2.4
+Since: 2.26
</description>
<parameters>
-<parameter name="filename">
-<parameter_description> the symbolic link
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError
+<parameter name="datetime">
+<parameter_description> a #GDateTime
</parameter_description>
</parameter>
</parameters>
-<return> A newly-allocated string with the contents of the symbolic link,
-or %NULL if an error occurred.
+<return> the minute of the hour
</return>
</function>
-<function name="g_file_set_contents">
+<function name="g_date_time_get_month">
<description>
-Writes all of @contents to a file named @filename, with good error checking.
-If a file called @filename already exists it will be overwritten.
-
-This write is atomic in the sense that it is first written to a temporary
-file which is then renamed to the final name. Notes:
-<itemizedlist>
-<listitem>
-On Unix, if @filename already exists hard links to @filename will break.
-Also since the file is recreated, existing permissions, access control
-lists, metadata etc. may be lost. If @filename is a symbolic link,
-the link itself will be replaced, not the linked file.
-</listitem>
-<listitem>
-On Windows renaming a file will not remove an existing file with the
-new name, so on Windows there is a race condition between the existing
-file being removed and the temporary file being renamed.
-</listitem>
-<listitem>
-On Windows there is no way to remove a file that is open to some
-process, or mapped into memory. Thus, this function will fail if
- filename already exists and is open.
-</listitem>
-</itemizedlist>
-
-If the call was sucessful, it returns %TRUE. If the call was not successful,
-it returns %FALSE and sets @error. The error domain is #G_FILE_ERROR.
-Possible error codes are those in the #GFileError enumeration.
-
-Note that the name for the temporary file is constructed by appending up
-to 7 characters to @filename.
+Retrieves the month of the year represented by @datetime in the Gregorian
+calendar.
-Since: 2.8
+Since: 2.26
</description>
<parameters>
-<parameter name="filename">
-<parameter_description> name of a file to write @contents to, in the GLib file name
-encoding
-</parameter_description>
-</parameter>
-<parameter name="contents">
-<parameter_description> string to write to the file
-</parameter_description>
-</parameter>
-<parameter name="length">
-<parameter_description> length of @contents, or -1 if @contents is a nul-terminated string
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError, or %NULL
+<parameter name="datetime">
+<parameter_description> a #GDateTime
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE on success, %FALSE if an error occurred
+<return> the month represented by @datetime
</return>
</function>
-<function name="g_file_test">
+<function name="g_date_time_get_second">
<description>
-Returns %TRUE if any of the tests in the bitfield @test are
-%TRUE. For example, <literal>(G_FILE_TEST_EXISTS |
-G_FILE_TEST_IS_DIR)</literal> will return %TRUE if the file exists;
-the check whether it's a directory doesn't matter since the existence
-test is %TRUE. With the current set of available tests, there's no point
-passing in more than one test at a time.
-
-Apart from %G_FILE_TEST_IS_SYMLINK all tests follow symbolic links,
-so for a symbolic link to a regular file g_file_test() will return
-%TRUE for both %G_FILE_TEST_IS_SYMLINK and %G_FILE_TEST_IS_REGULAR.
+Retrieves the second of the minute represented by @datetime
-Note, that for a dangling symbolic link g_file_test() will return
-%TRUE for %G_FILE_TEST_IS_SYMLINK and %FALSE for all other flags.
+Since: 2.26
-You should never use g_file_test() to test whether it is safe
-to perform an operation, because there is always the possibility
-of the condition changing before you actually perform the operation.
-For example, you might think you could use %G_FILE_TEST_IS_SYMLINK
-to know whether it is safe to write to a file without being
-tricked into writing into a different location. It doesn't work!
-|[
-/ * DON'T DO THIS * /
-if (!g_file_test (filename, G_FILE_TEST_IS_SYMLINK))
-{
-fd = g_open (filename, O_WRONLY);
-/ * write to fd * /
-}
-]|
+</description>
+<parameters>
+<parameter name="datetime">
+<parameter_description> a #GDateTime
+</parameter_description>
+</parameter>
+</parameters>
+<return> the second represented by @datetime
-Another thing to note is that %G_FILE_TEST_EXISTS and
-%G_FILE_TEST_IS_EXECUTABLE are implemented using the access()
-system call. This usually doesn't matter, but if your program
-is setuid or setgid it means that these tests will give you
-the answer for the real user ID and group ID, rather than the
-effective user ID and group ID.
+</return>
+</function>
-On Windows, there are no symlinks, so testing for
-%G_FILE_TEST_IS_SYMLINK will always return %FALSE. Testing for
-%G_FILE_TEST_IS_EXECUTABLE will just check that the file exists and
-its name indicates that it is executable, checking for well-known
-extensions and those listed in the %PATHEXT environment variable.
+<function name="g_date_time_get_seconds">
+<description>
+Retrieves the number of seconds since the start of the last minute,
+including the fractional part.
+Since: 2.26
</description>
<parameters>
-<parameter name="filename">
-<parameter_description> a filename to test in the GLib file name encoding
-</parameter_description>
-</parameter>
-<parameter name="test">
-<parameter_description> bitfield of #GFileTest flags
+<parameter name="datetime">
+<parameter_description> a #GDateTime
</parameter_description>
</parameter>
</parameters>
-<return> whether a test was %TRUE
+<return> the number of seconds
+
</return>
</function>
-<function name="g_filename_display_basename">
+<function name="g_date_time_get_timezone_abbreviation">
<description>
-Returns the display basename for the particular filename, guaranteed
-to be valid UTF-8. The display name might not be identical to the filename,
-for instance there might be problems converting it to UTF-8, and some files
-can be translated in the display.
-
-If GLib cannot make sense of the encoding of @filename, as a last resort it
-replaces unknown characters with U+FFFD, the Unicode replacement character.
-You can search the result for the UTF-8 encoding of this character (which is
-"\357\277\275" in octal notation) to find out if @filename was in an invalid
-encoding.
-
-You must pass the whole absolute pathname to this functions so that
-translation of well known locations can be done.
+Determines the time zone abbreviation to be used at the time and in
+the time zone of @datetime.
-This function is preferred over g_filename_display_name() if you know the
-whole path, as it allows translation.
+For example, in Toronto this is currently "EST" during the winter
+months and "EDT" during the summer months when daylight savings
+time is in effect.
-Since: 2.6
+Since: 2.26
</description>
<parameters>
-<parameter name="filename">
-<parameter_description> an absolute pathname in the GLib file name encoding
+<parameter name="datetime">
+<parameter_description> a #GDateTime
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated string containing
-a rendition of the basename of the filename in valid UTF-8
+<return> the time zone abbreviation. The returned
+string is owned by the #GDateTime and it should not be
+modified or freed
</return>
</function>
-<function name="g_filename_display_name">
+<function name="g_date_time_get_utc_offset">
<description>
-Converts a filename into a valid UTF-8 string. The conversion is
-not necessarily reversible, so you should keep the original around
-and use the return value of this function only for display purposes.
-Unlike g_filename_to_utf8(), the result is guaranteed to be non-%NULL
-even if the filename actually isn't in the GLib file name encoding.
+Determines the offset to UTC in effect at the time and in the time
+zone of @datetime.
-If GLib cannot make sense of the encoding of @filename, as a last resort it
-replaces unknown characters with U+FFFD, the Unicode replacement character.
-You can search the result for the UTF-8 encoding of this character (which is
-"\357\277\275" in octal notation) to find out if @filename was in an invalid
-encoding.
+The offset is the number of microseconds that you add to UTC time to
+arrive at local time for the time zone (ie: negative numbers for time
+zones west of GMT, positive numbers for east).
-If you know the whole pathname of the file you should use
-g_filename_display_basename(), since that allows location-based
-translation of filenames.
+If @datetime represents UTC time, then the offset is always zero.
-Since: 2.6
+Since: 2.26
</description>
<parameters>
-<parameter name="filename">
-<parameter_description> a pathname hopefully in the GLib file name encoding
+<parameter name="datetime">
+<parameter_description> a #GDateTime
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated string containing
-a rendition of the filename in valid UTF-8
+<return> the number of microseconds that should be added to UTC to
+get the local time
</return>
</function>
-<function name="g_filename_from_uri">
+<function name="g_date_time_get_week_numbering_year">
<description>
-Converts an escaped ASCII-encoded URI to a local filename in the
-encoding used for filenames.
+Returns the ISO 8601 week-numbering year in which the week containing
+ datetime falls.
+
+This function, taken together with g_date_time_get_week_of_year() and
+g_date_time_get_day_of_week() can be used to determine the full ISO
+week date on which @datetime falls.
+
+This is usually equal to the normal Gregorian year (as returned by
+g_date_time_get_year()), except as detailed below:
+
+For Thursday, the week-numbering year is always equal to the usual
+calendar year. For other days, the number is such that every day
+within a complete week (Monday to Sunday) is contained within the
+same week-numbering year.
+
+For Monday, Tuesday and Wednesday occuring near the end of the year,
+this may mean that the week-numbering year is one greater than the
+calendar year (so that these days have the same week-numbering year
+as the Thursday occuring early in the next year).
+For Friday, Saturaday and Sunday occuring near the start of the year,
+this may mean that the week-numbering year is one less than the
+calendar year (so that these days have the same week-numbering year
+as the Thursday occuring late in the previous year).
+
+An equivalent description is that the week-numbering year is equal to
+the calendar year containing the majority of the days in the current
+week (Monday to Sunday).
+
+Note that January 1 0001 in the proleptic Gregorian calendar is a
+Monday, so this function never returns 0.
+
+Since: 2.26
</description>
<parameters>
-<parameter name="uri">
-<parameter_description> a uri describing a filename (escaped, encoded in ASCII).
-</parameter_description>
-</parameter>
-<parameter name="hostname">
-<parameter_description> Location to store hostname for the URI, or %NULL.
-If there is no hostname in the URI, %NULL will be
-stored in this location.
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> location to store the error occuring, or %NULL to ignore
-errors. Any of the errors in #GConvertError may occur.
+<parameter name="datetime">
+<parameter_description> a #GDateTime
</parameter_description>
</parameter>
</parameters>
-<return> a newly-allocated string holding the resulting
-filename, or %NULL on an error.
+<return> the ISO 8601 week-numbering year for @datetime
+
</return>
</function>
-<function name="g_filename_from_utf8">
+<function name="g_date_time_get_week_of_year">
<description>
-Converts a string from UTF-8 to the encoding GLib uses for
-filenames. Note that on Windows GLib uses UTF-8 for filenames;
-on other platforms, this function indirectly depends on the
-<link linkend="setlocale">current locale</link>.
+Returns the ISO 8601 week number for the week containing @datetime.
+The ISO 8601 week number is the same for every day of the week (from
+Moday through Sunday). That can produce some unusual results
+(described below).
+
+The first week of the year is week 1. This is the week that contains
+the first Thursday of the year. Equivalently, this is the first week
+that has more than 4 of its days falling within the calendar year.
+
+The value 0 is never returned by this function. Days contained
+within a year but occuring before the first ISO 8601 week of that
+year are considered as being contained in the last week of the
+previous year. Similarly, the final days of a calendar year may be
+considered as being part of the first ISO 8601 week of the next year
+if 4 or more days of that week are contained within the new year.
+Since: 2.26
</description>
<parameters>
-<parameter name="utf8string">
-<parameter_description> a UTF-8 encoded string.
-</parameter_description>
-</parameter>
-<parameter name="len">
-<parameter_description> the length of the string, or -1 if the string is
-nul-terminated.
-</parameter_description>
-</parameter>
-<parameter name="bytes_read">
-<parameter_description> location to store the number of bytes in the
-input string that were successfully converted, or %NULL.
-Even if the conversion was successful, this may be
-less than @len if there were partial characters
-at the end of the input. If the error
-#G_CONVERT_ERROR_ILLEGAL_SEQUENCE occurs, the value
-stored will the byte offset after the last valid
-input sequence.
-</parameter_description>
-</parameter>
-<parameter name="bytes_written">
-<parameter_description> the number of bytes stored in the output buffer (not
-including the terminating nul).
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> location to store the error occuring, or %NULL to ignore
-errors. Any of the errors in #GConvertError may occur.
+<parameter name="datetime">
+<parameter_description> a #GDateTime
</parameter_description>
</parameter>
</parameters>
-<return> The converted string, or %NULL on an error.
+<return> the ISO 8601 week number for @datetime.
+
</return>
</function>
-<function name="g_filename_to_uri">
+<function name="g_date_time_get_year">
<description>
-Converts an absolute filename to an escaped ASCII-encoded URI, with the path
-component following Section 3.3. of RFC 2396.
+Retrieves the year represented by @datetime in the Gregorian calendar.
+Since: 2.26
</description>
<parameters>
-<parameter name="filename">
-<parameter_description> an absolute filename specified in the GLib file name encoding,
-which is the on-disk file name bytes on Unix, and UTF-8 on
-Windows
-</parameter_description>
-</parameter>
-<parameter name="hostname">
-<parameter_description> A UTF-8 encoded hostname, or %NULL for none.
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> location to store the error occuring, or %NULL to ignore
-errors. Any of the errors in #GConvertError may occur.
+<parameter name="datetime">
+<parameter_description> A #GDateTime
</parameter_description>
</parameter>
</parameters>
-<return> a newly-allocated string holding the resulting
-URI, or %NULL on an error.
+<return> the year represented by @datetime
+
</return>
</function>
-<function name="g_filename_to_utf8">
+<function name="g_date_time_get_ymd">
<description>
-Converts a string which is in the encoding used by GLib for
-filenames into a UTF-8 string. Note that on Windows GLib uses UTF-8
-for filenames; on other platforms, this function indirectly depends on
-the <link linkend="setlocale">current locale</link>.
+Retrieves the Gregorian day, month, and year of a given #GDateTime.
+Since: 2.26
</description>
<parameters>
-<parameter name="opsysstring">
-<parameter_description> a string in the encoding for filenames
-</parameter_description>
-</parameter>
-<parameter name="len">
-<parameter_description> the length of the string, or -1 if the string is
-nul-terminated<footnoteref linkend="nul-unsafe"/>.
+<parameter name="datetime">
+<parameter_description> a #GDateTime.
</parameter_description>
</parameter>
-<parameter name="bytes_read">
-<parameter_description> location to store the number of bytes in the
-input string that were successfully converted, or %NULL.
-Even if the conversion was successful, this may be
-less than @len if there were partial characters
-at the end of the input. If the error
-#G_CONVERT_ERROR_ILLEGAL_SEQUENCE occurs, the value
-stored will the byte offset after the last valid
-input sequence.
+<parameter name="year">
+<parameter_description> the return location for the gregorian year, or %NULL.
</parameter_description>
</parameter>
-<parameter name="bytes_written">
-<parameter_description> the number of bytes stored in the output buffer (not
-including the terminating nul).
+<parameter name="month">
+<parameter_description> the return location for the month of the year, or %NULL.
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> location to store the error occuring, or %NULL to ignore
-errors. Any of the errors in #GConvertError may occur.
+<parameter name="day">
+<parameter_description> the return location for the day of the month, or %NULL.
</parameter_description>
</parameter>
</parameters>
-<return> The converted string, or %NULL on an error.
-</return>
+<return></return>
</function>
-<function name="g_find_program_in_path">
+<function name="g_date_time_hash">
<description>
-Locates the first executable named @program in the user's path, in the
-same way that execvp() would locate it. Returns an allocated string
-with the absolute path name, or %NULL if the program is not found in
-the path. If @program is already an absolute path, returns a copy of
- program if @program exists and is executable, and %NULL otherwise.
-
-On Windows, if @program does not have a file type suffix, tries
-with the suffixes .exe, .cmd, .bat and .com, and the suffixes in
-the <envar>PATHEXT</envar> environment variable.
-
-On Windows, it looks for the file in the same way as CreateProcess()
-would. This means first in the directory where the executing
-program was loaded from, then in the current directory, then in the
-Windows 32-bit system directory, then in the Windows directory, and
-finally in the directories in the <envar>PATH</envar> environment
-variable. If the program is found, the return value contains the
-full name including the type suffix.
+Hashes @datetime into a #guint, suitable for use within #GHashTable.
+Since: 2.26
</description>
<parameters>
-<parameter name="program">
-<parameter_description> a program name in the GLib file name encoding
+<parameter name="datetime">
+<parameter_description> a #GDateTime
</parameter_description>
</parameter>
</parameters>
-<return> absolute path, or %NULL
+<return> a #guint containing the hash
+
</return>
</function>
-<function name="g_fopen">
+<function name="g_date_time_is_daylight_savings">
<description>
-A wrapper for the stdio fopen() function. The fopen() function
-opens a file and associates a new stream with it.
-
-Because file descriptors are specific to the C library on Windows,
-and a file descriptor is partof the <type>FILE</type> struct, the
-<type>FILE</type> pointer returned by this function makes sense
-only to functions in the same C library. Thus if the GLib-using
-code uses a different C library than GLib does, the
-<type>FILE</type> pointer returned by this function cannot be
-passed to C library functions like fprintf() or fread().
-
-See your C library manual for more details about fopen().
+Determines if daylight savings time is in effect at the time and in
+the time zone of @datetime.
-Since: 2.6
+Since: 2.26
</description>
<parameters>
-<parameter name="filename">
-<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows)
-</parameter_description>
-</parameter>
-<parameter name="mode">
-<parameter_description> a string describing the mode in which the file should be
-opened
+<parameter name="datetime">
+<parameter_description> a #GDateTime
</parameter_description>
</parameter>
</parameters>
-<return> A <type>FILE</type> pointer if the file was successfully
-opened, or %NULL if an error occurred
+<return> %TRUE if daylight savings time is in effect
</return>
</function>
-<function name="g_format_size_for_display">
+<function name="g_date_time_new">
<description>
-Formats a size (for example the size of a file) into a human readable string.
-Sizes are rounded to the nearest size prefix (KB, MB, GB) and are displayed
-rounded to the nearest tenth. E.g. the file size 3292528 bytes will be
-converted into the string "3.1 MB".
+Creates a new #GDateTime corresponding to the given date and time in
+the time zone @tz.
-The prefix units base is 1024 (i.e. 1 KB is 1024 bytes).
+The @year must be between 1 and 9999, @month between 1 and 12 and @day
+between 1 and 28, 29, 30 or 31 depending on the month and the year.
-This string should be freed with g_free() when not needed any longer.
+ hour must be between 0 and 23 and @minute must be between 0 and 59.
-Since: 2.16
+ seconds must be at least 0.0 and must be strictly less than 60.0.
+It will be rounded down to the nearest microsecond.
-</description>
-<parameters>
-<parameter name="size">
-<parameter_description> a size in bytes.
-</parameter_description>
-</parameter>
-</parameters>
-<return> a newly-allocated formatted string containing a human readable
-file size.
+If the given time is not representable in the given time zone (for
+example, 02:30 on March 14th 2010 in Toronto, due to daylight savings
+time) then the time will be rounded up to the nearest existing time
+(in this case, 03:00). If this matters to you then you should verify
+the return value for containing the same as the numbers you gave.
-</return>
-</function>
+In the case that the given time is ambiguous in the given time zone
+(for example, 01:30 on November 7th 2010 in Toronto, due to daylight
+savings time) then the time falling within standard (ie:
+non-daylight) time is taken.
-<function name="g_fprintf">
-<description>
-An implementation of the standard fprintf() function which supports
-positional parameters, as specified in the Single Unix Specification.
+It not considered a programmer error for the values to this function
+to be out of range, but in the case that they are, the function will
+return %NULL.
-Since: 2.2
+You should release the return value by calling g_date_time_unref()
+when you are done with it.
+
+Since: 2.26
</description>
<parameters>
-<parameter name="file">
-<parameter_description> the stream to write to.
+<parameter name="tz">
+<parameter_description> a #GTimeZone
</parameter_description>
</parameter>
-<parameter name="format">
-<parameter_description> a standard printf() format string, but notice
-<link linkend="string-precision">string precision pitfalls</link>.
+<parameter name="year">
+<parameter_description> the year component of the date
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> the arguments to insert in the output.
+<parameter name="month">
+<parameter_description> the month component of the date
+</parameter_description>
+</parameter>
+<parameter name="day">
+<parameter_description> the day component of the date
+</parameter_description>
+</parameter>
+<parameter name="hour">
+<parameter_description> the hour component of the date
+</parameter_description>
+</parameter>
+<parameter name="minute">
+<parameter_description> the minute component of the date
+</parameter_description>
+</parameter>
+<parameter name="seconds">
+<parameter_description> the number of seconds past the minute
</parameter_description>
</parameter>
</parameters>
-<return> the number of bytes printed.
+<return> a new #GDateTime, or %NULL
</return>
</function>
-<function name="g_free">
+<function name="g_date_time_new_from_timeval_local">
<description>
-Frees the memory pointed to by @mem.
-If @mem is %NULL it simply returns.
+Creates a #GDateTime corresponding to the given #GTimeVal @tv in the
+local time zone.
-</description>
-<parameters>
-<parameter name="mem">
-<parameter_description> the memory to free
-</parameter_description>
-</parameter>
-</parameters>
-<return></return>
-</function>
+The time contained in a #GTimeVal is always stored in the form of
+seconds elapsed since 1970-01-01 00:00:00 UTC, regardless of the
+local time offset.
-<function name="g_freopen">
-<description>
-A wrapper for the POSIX freopen() function. The freopen() function
-opens a file and associates it with an existing stream.
+This call can fail (returning %NULL) if @tv represents a time outside
+of the supported range of #GDateTime.
-See your C library manual for more details about freopen().
+You should release the return value by calling g_date_time_unref()
+when you are done with it.
-Since: 2.6
+Since: 2.26
</description>
<parameters>
-<parameter name="filename">
-<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows)
-</parameter_description>
-</parameter>
-<parameter name="mode">
-<parameter_description> a string describing the mode in which the file should be
-opened
-</parameter_description>
-</parameter>
-<parameter name="stream">
-<parameter_description> an existing stream which will be reused, or %NULL
+<parameter name="tv">
+<parameter_description> a #GTimeVal
</parameter_description>
</parameter>
</parameters>
-<return> A <type>FILE</type> pointer if the file was successfully
-opened, or %NULL if an error occurred.
+<return> a new #GDateTime, or %NULL
</return>
</function>
-<function name="g_get_application_name">
+<function name="g_date_time_new_from_timeval_utc">
<description>
-Gets a human-readable name for the application, as set by
-g_set_application_name(). This name should be localized if
-possible, and is intended for display to the user. Contrast with
-g_get_prgname(), which gets a non-localized name. If
-g_set_application_name() has not been called, returns the result of
-g_get_prgname() (which may be %NULL if g_set_prgname() has also not
-been called).
+Creates a #GDateTime corresponding to the given #GTimeVal @tv in UTC.
-Since: 2.2
+The time contained in a #GTimeVal is always stored in the form of
+seconds elapsed since 1970-01-01 00:00:00 UTC.
+
+This call can fail (returning %NULL) if @tv represents a time outside
+of the supported range of #GDateTime.
+
+You should release the return value by calling g_date_time_unref()
+when you are done with it.
+
+Since: 2.26
</description>
<parameters>
+<parameter name="tv">
+<parameter_description> a #GTimeVal
+</parameter_description>
+</parameter>
</parameters>
-<return> human-readable application name. may return %NULL
+<return> a new #GDateTime, or %NULL
</return>
</function>
-<function name="g_get_charset">
+<function name="g_date_time_new_from_unix_local">
<description>
-Obtains the character set for the <link linkend="setlocale">current
-locale</link>; you might use this character set as an argument to
-g_convert(), to convert from the current locale's encoding to some
-other encoding. (Frequently g_locale_to_utf8() and g_locale_from_utf8()
-are nice shortcuts, though.)
+Creates a #GDateTime corresponding to the given Unix time @t in the
+local time zone.
-On Windows the character set returned by this function is the
-so-called system default ANSI code-page. That is the character set
-used by the "narrow" versions of C library and Win32 functions that
-handle file names. It might be different from the character set
-used by the C library's current locale.
+Unix time is the number of seconds that have elapsed since 1970-01-01
+00:00:00 UTC, regardless of the local time offset.
-The return value is %TRUE if the locale's encoding is UTF-8, in that
-case you can perhaps avoid calling g_convert().
+This call can fail (returning %NULL) if @t represents a time outside
+of the supported range of #GDateTime.
-The string returned in @charset is not allocated, and should not be
-freed.
+You should release the return value by calling g_date_time_unref()
+when you are done with it.
+Since: 2.26
</description>
<parameters>
-<parameter name="charset">
-<parameter_description> return location for character set name
+<parameter name="t">
+<parameter_description> the Unix time
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the returned charset is UTF-8
+<return> a new #GDateTime, or %NULL
+
</return>
</function>
-<function name="g_get_codeset">
+<function name="g_date_time_new_from_unix_utc">
<description>
-Get the codeset for the current locale.
+Creates a #GDateTime corresponding to the given Unix time @t in UTC.
+Unix time is the number of seconds that have elapsed since 1970-01-01
+00:00:00 UTC.
-</description>
-<parameters>
-</parameters>
-<return> a newly allocated string containing the name
-of the codeset. This string must be freed with g_free().
-</return>
-</function>
+This call can fail (returning %NULL) if @t represents a time outside
+of the supported range of #GDateTime.
-<function name="g_get_current_dir">
-<description>
-Gets the current directory.
-The returned string should be freed when no longer needed. The encoding
-of the returned string is system defined. On Windows, it is always UTF-8.
+You should release the return value by calling g_date_time_unref()
+when you are done with it.
+Since: 2.26
</description>
<parameters>
+<parameter name="t">
+<parameter_description> the Unix time
+</parameter_description>
+</parameter>
</parameters>
-<return> the current directory.
+<return> a new #GDateTime, or %NULL
+
</return>
</function>
-<function name="g_get_current_time">
+<function name="g_date_time_new_local">
<description>
-Equivalent to the UNIX gettimeofday() function, but portable.
+Creates a new #GDateTime corresponding to the given date and time in
+the local time zone.
-You may find g_get_real_time() to be more convenient.
+This call is equivalent to calling g_date_time_new() with the time
+zone returned by g_time_zone_new_local().
+
+Since: 2.26.
</description>
<parameters>
-<parameter name="result">
-<parameter_description> #GTimeVal structure in which to store current time.
+<parameter name="year">
+<parameter_description> the year component of the date
+</parameter_description>
+</parameter>
+<parameter name="month">
+<parameter_description> the month component of the date
+</parameter_description>
+</parameter>
+<parameter name="day">
+<parameter_description> the day component of the date
+</parameter_description>
+</parameter>
+<parameter name="hour">
+<parameter_description> the hour component of the date
+</parameter_description>
+</parameter>
+<parameter name="minute">
+<parameter_description> the minute component of the date
+</parameter_description>
+</parameter>
+<parameter name="seconds">
+<parameter_description> the number of seconds past the minute
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a #GDateTime, or %NULL
+
+</return>
</function>
-<function name="g_get_environ">
+<function name="g_date_time_new_now">
<description>
-Gets the list of environment variables for the current process. The
-list is %NULL terminated and each item in the list is of the form
-'NAME=VALUE'.
+Creates a #GDateTime corresponding to this exact instant in the given
+time zone @tz. The time is as accurate as the system allows, to a
+maximum accuracy of 1 microsecond.
-This is equivalent to direct access to the 'environ' global variable,
-except portable.
+This function will always succeed unless the system clock is set to
+truly insane values (or unless GLib is still being used after the
+year 9999).
-The return value is freshly allocated and it should be freed with
-g_strfreev() when it is no longer needed.
+You should release the return value by calling g_date_time_unref()
+when you are done with it.
-Since: 2.28
+Since: 2.26
</description>
<parameters>
+<parameter name="tz">
+<parameter_description> a #GTimeZone
+</parameter_description>
+</parameter>
</parameters>
-<return> the list of environment variables
+<return> a new #GDateTime, or %NULL
</return>
</function>
-<function name="g_get_filename_charsets">
+<function name="g_date_time_new_now_local">
<description>
-Determines the preferred character sets used for filenames.
-The first character set from the @charsets is the filename encoding, the
-subsequent character sets are used when trying to generate a displayable
-representation of a filename, see g_filename_display_name().
-
-On Unix, the character sets are determined by consulting the
-environment variables <envar>G_FILENAME_ENCODING</envar> and
-<envar>G_BROKEN_FILENAMES</envar>. On Windows, the character set
-used in the GLib API is always UTF-8 and said environment variables
-have no effect.
-
-<envar>G_FILENAME_ENCODING</envar> may be set to a comma-separated list
-of character set names. The special token "@locale" is taken to
-mean the character set for the <link linkend="setlocale">current
-locale</link>. If <envar>G_FILENAME_ENCODING</envar> is not set, but
-<envar>G_BROKEN_FILENAMES</envar> is, the character set of the current
-locale is taken as the filename encoding. If neither environment variable
-is set, UTF-8 is taken as the filename encoding, but the character
-set of the current locale is also put in the list of encodings.
-
-The returned @charsets belong to GLib and must not be freed.
+Creates a #GDateTime corresponding to this exact instant in the local
+time zone.
-Note that on Unix, regardless of the locale character set or
-<envar>G_FILENAME_ENCODING</envar> value, the actual file names present
-on a system might be in any random encoding or just gibberish.
+This is equivalent to calling g_date_time_new_now() with the time
+zone returned by g_time_zone_new_local().
-Since: 2.6
+Since: 2.26
</description>
<parameters>
-<parameter name="charsets">
-<parameter_description> return location for the %NULL-terminated list of encoding names
-</parameter_description>
-</parameter>
</parameters>
-<return> %TRUE if the filename encoding is UTF-8.
+<return> a new #GDateTime, or %NULL
</return>
</function>
-<function name="g_get_home_dir">
+<function name="g_date_time_new_now_utc">
<description>
-Gets the current user's home directory as defined in the
-password database.
-
-Note that in contrast to traditional UNIX tools, this function
-prefers <filename>passwd</filename> entries over the <envar>HOME</envar>
-environment variable.
+Creates a #GDateTime corresponding to this exact instant in UTC.
-One of the reasons for this decision is that applications in many
-cases need special handling to deal with the case where
-<envar>HOME</envar> is
-<simplelist>
-<member>Not owned by the user</member>
-<member>Not writeable</member>
-<member>Not even readable</member>
-</simplelist>
-Since applications are in general <emphasis>not</emphasis> written
-to deal with these situations it was considered better to make
-g_get_home_dir() not pay attention to <envar>HOME</envar> and to
-return the real home directory for the user. If applications
-want to pay attention to <envar>HOME</envar>, they can do:
-|[
-const char *homedir = g_getenv ("HOME");
-if (!homedir)
-homedir = g_get_home_dir (<!-- -->);
-]|
+This is equivalent to calling g_date_time_new_now() with the time
+zone returned by g_time_zone_new_utc().
+Since: 2.26
</description>
<parameters>
</parameters>
-<return> the current user's home directory
+<return> a new #GDateTime, or %NULL
+
</return>
</function>
-<function name="g_get_host_name">
+<function name="g_date_time_new_utc">
<description>
-Return a name for the machine.
+Creates a new #GDateTime corresponding to the given date and time in
+UTC.
-The returned name is not necessarily a fully-qualified domain name,
-or even present in DNS or some other name service at all. It need
-not even be unique on your local network or site, but usually it
-is. Callers should not rely on the return value having any specific
-properties like uniqueness for security purposes. Even if the name
-of the machine is changed while an application is running, the
-return value from this function does not change. The returned
-string is owned by GLib and should not be modified or freed. If no
-name can be determined, a default fixed string "localhost" is
-returned.
+This call is equivalent to calling g_date_time_new() with the time
+zone returned by g_time_zone_new_utc().
-Since: 2.8
+Since: 2.26.
</description>
<parameters>
+<parameter name="year">
+<parameter_description> the year component of the date
+</parameter_description>
+</parameter>
+<parameter name="month">
+<parameter_description> the month component of the date
+</parameter_description>
+</parameter>
+<parameter name="day">
+<parameter_description> the day component of the date
+</parameter_description>
+</parameter>
+<parameter name="hour">
+<parameter_description> the hour component of the date
+</parameter_description>
+</parameter>
+<parameter name="minute">
+<parameter_description> the minute component of the date
+</parameter_description>
+</parameter>
+<parameter name="seconds">
+<parameter_description> the number of seconds past the minute
+</parameter_description>
+</parameter>
</parameters>
-<return> the host name of the machine.
+<return> a #GDateTime, or %NULL
</return>
</function>
-<function name="g_get_language_names">
+<function name="g_date_time_ref">
<description>
-Computes a list of applicable locale names, which can be used to
-e.g. construct locale-dependent filenames or search paths. The returned
-list is sorted from most desirable to least desirable and always contains
-the default locale "C".
-
-For example, if LANGUAGE=de:en_US, then the returned list is
-"de", "en_US", "en", "C".
-
-This function consults the environment variables <envar>LANGUAGE</envar>,
-<envar>LC_ALL</envar>, <envar>LC_MESSAGES</envar> and <envar>LANG</envar>
-to find the list of locales specified by the user.
+Atomically increments the reference count of @datetime by one.
-Since: 2.6
+Since: 2.26
</description>
<parameters>
+<parameter name="datetime">
+<parameter_description> a #GDateTime
+</parameter_description>
+</parameter>
</parameters>
-<return> a %NULL-terminated array of strings owned by GLib
-that must not be modified or freed.
+<return> the #GDateTime with the reference count increased
</return>
</function>
-<function name="g_get_locale_variants">
+<function name="g_date_time_to_local">
<description>
-Returns a list of derived variants of @locale, which can be used to
-e.g. construct locale-dependent filenames or search paths. The returned
-list is sorted from most desirable to least desirable.
-This function handles territory, charset and extra locale modifiers.
-
-For example, if @locale is "fr_BE", then the returned list
-is "fr_BE", "fr".
+Creates a new #GDateTime corresponding to the same instant in time as
+ datetime, but in the local time zone.
-If you need the list of variants for the <emphasis>current locale</emphasis>,
-use g_get_language_names().
+This call is equivalent to calling g_date_time_to_timezone() with the
+time zone returned by g_time_zone_new_local().
-Since: 2.28
+Since: 2.26
</description>
<parameters>
-<parameter name="locale">
-<parameter_description> a locale identifier
+<parameter name="datetime">
+<parameter_description> a #GDateTime
</parameter_description>
</parameter>
</parameters>
-<return> a newly
-allocated array of newly allocated strings with the locale variants. Free with
-g_strfreev().
+<return> the newly created #GDateTime
</return>
</function>
-<function name="g_get_monotonic_time">
+<function name="g_date_time_to_timeval">
<description>
-Queries the system monotonic time, if available.
+Stores the instant in time that @datetime represents into @tv.
-On POSIX systems with clock_gettime() and %CLOCK_MONOTONIC this call
-is a very shallow wrapper for that. Otherwise, we make a best effort
-that probably involves returning the wall clock time (with at least
-microsecond accuracy, subject to the limitations of the OS kernel).
+The time contained in a #GTimeVal is always stored in the form of
+seconds elapsed since 1970-01-01 00:00:00 UTC, regardless of the time
+zone associated with @datetime.
-Note that, on Windows, "limitations of the OS kernel" is a rather
-substantial statement. Depending on the configuration of the system,
-the wall clock time is updated as infrequently as 64 times a second
-(which is approximately every 16ms).
+On systems where 'long' is 32bit (ie: all 32bit systems and all
+Windows systems), a #GTimeVal is incapable of storing the entire
+range of values that #GDateTime is capable of expressing. On those
+systems, this function returns %FALSE to indicate that the time is
+out of range.
-Since: 2.28
+On systems where 'long' is 64bit, this function never fails.
+
+Since: 2.26
</description>
<parameters>
+<parameter name="datetime">
+<parameter_description> a #GDateTime
+</parameter_description>
+</parameter>
+<parameter name="tv">
+<parameter_description> a #GTimeVal to modify
+</parameter_description>
+</parameter>
</parameters>
-<return> the monotonic time, in microseconds
+<return> %TRUE if successful, else %FALSE
</return>
</function>
-<function name="g_get_prgname">
+<function name="g_date_time_to_timezone">
<description>
-Gets the name of the program. This name should <emphasis>not</emphasis>
-be localized, contrast with g_get_application_name().
-(If you are using GDK or GTK+ the program name is set in gdk_init(),
-which is called by gtk_init(). The program name is found by taking
-the last component of <literal>argv[0]</literal>.)
-
+Create a new #GDateTime corresponding to the same instant in time as
+ datetime, but in the time zone @tz.
-</description>
-<parameters>
-</parameters>
-<return> the name of the program. The returned string belongs
-to GLib and must not be modified or freed.
-</return>
-</function>
+This call can fail in the case that the time goes out of bounds. For
+example, converting 0001-01-01 00:00:00 UTC to a time zone west of
+Greenwich will fail (due to the year 0 being out of range).
-<function name="g_get_real_name">
-<description>
-Gets the real name of the user. This usually comes from the user's entry
-in the <filename>passwd</filename> file. The encoding of the returned
-string is system-defined. (On Windows, it is, however, always UTF-8.)
-If the real user name cannot be determined, the string "Unknown" is
-returned.
+You should release the return value by calling g_date_time_unref()
+when you are done with it.
+Since: 2.26
</description>
<parameters>
+<parameter name="datetime">
+<parameter_description> a #GDateTime
+</parameter_description>
+</parameter>
+<parameter name="tz">
+<parameter_description> the new #GTimeZone
+</parameter_description>
+</parameter>
</parameters>
-<return> the user's real name.
+<return> a new #GDateTime, or %NULL
+
</return>
</function>
-<function name="g_get_real_time">
+<function name="g_date_time_to_unix">
<description>
-Queries the system wall-clock time.
-
-This call is functionally equivalent to g_get_current_time() except
-that the return value is often more convenient than dealing with a
-#GTimeVal.
+Gives the Unix time corresponding to @datetime, rounding down to the
+nearest second.
-You should only use this call if you are actually interested in the real
-wall-clock time. g_get_monotonic_time() is probably more useful for
-measuring intervals.
+Unix time is the number of seconds that have elapsed since 1970-01-01
+00:00:00 UTC, regardless of the time zone associated with @datetime.
-Since: 2.28
+Since: 2.26
</description>
<parameters>
+<parameter name="datetime">
+<parameter_description> a #GDateTime
+</parameter_description>
+</parameter>
</parameters>
-<return> the number of microseconds since January 1, 1970 UTC.
+<return> the Unix time corresponding to @datetime
</return>
</function>
-<function name="g_get_system_config_dirs">
+<function name="g_date_time_to_utc">
<description>
-Returns an ordered list of base directories in which to access
-system-wide configuration information.
-
-On UNIX platforms this is determined using the mechanisms described in
-the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
-XDG Base Directory Specification</ulink>.
-In this case the list of directories retrieved will be XDG_CONFIG_DIRS.
+Creates a new #GDateTime corresponding to the same instant in time as
+ datetime, but in UTC.
-On Windows is the directory that contains application data for all users.
-A typical path is C:\Documents and Settings\All Users\Application Data.
-This folder is used for application data that is not user specific.
-For example, an application can store a spell-check dictionary, a database
-of clip art, or a log file in the CSIDL_COMMON_APPDATA folder.
-This information will not roam and is available to anyone using the computer.
+This call is equivalent to calling g_date_time_to_timezone() with the
+time zone returned by g_time_zone_new_utc().
-Since: 2.6
+Since: 2.26
</description>
<parameters>
+<parameter name="datetime">
+<parameter_description> a #GDateTime
+</parameter_description>
+</parameter>
</parameters>
-<return> a %NULL-terminated array of strings owned by GLib that must
-not be modified or freed.
+<return> the newly created #GDateTime
+
</return>
</function>
-<function name="g_get_system_data_dirs">
+<function name="g_date_time_unref">
<description>
-Returns an ordered list of base directories in which to access
-system-wide application data.
-
-On UNIX platforms this is determined using the mechanisms described in
-the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
-XDG Base Directory Specification</ulink>
-In this case the list of directories retrieved will be XDG_DATA_DIRS.
-
-On Windows the first elements in the list are the Application Data
-and Documents folders for All Users. (These can be determined only
-on Windows 2000 or later and are not present in the list on other
-Windows versions.) See documentation for CSIDL_COMMON_APPDATA and
-CSIDL_COMMON_DOCUMENTS.
-
-Then follows the "share" subfolder in the installation folder for
-the package containing the DLL that calls this function, if it can
-be determined.
-
-Finally the list contains the "share" subfolder in the installation
-folder for GLib, and in the installation folder for the package the
-application's .exe file belongs to.
-
-The installation folders above are determined by looking up the
-folder where the module (DLL or EXE) in question is located. If the
-folder's name is "bin", its parent is used, otherwise the folder
-itself.
+Atomically decrements the reference count of @datetime by one.
-Note that on Windows the returned list can vary depending on where
-this function is called.
+When the reference count reaches zero, the resources allocated by
+ datetime are freed
-Since: 2.6
+Since: 2.26
</description>
<parameters>
+<parameter name="datetime">
+<parameter_description> a #GDateTime
+</parameter_description>
+</parameter>
</parameters>
-<return> a %NULL-terminated array of strings owned by GLib that must
-not be modified or freed.
-</return>
+<return></return>
</function>
-<function name="g_get_tmp_dir">
+<function name="g_dcgettext">
<description>
-Gets the directory to use for temporary files. This is found from
-inspecting the environment variables <envar>TMPDIR</envar>,
-<envar>TMP</envar>, and <envar>TEMP</envar> in that order. If none
-of those are defined "/tmp" is returned on UNIX and "C:\" on Windows.
-The encoding of the returned string is system-defined. On Windows,
-it is always UTF-8. The return value is never %NULL or the empty string.
+This is a variant of g_dgettext() that allows specifying a locale
+category instead of always using %LC_MESSAGES. See g_dgettext() for
+more information about how this functions differs from calling
+dcgettext() directly.
+Since: 2.26
</description>
<parameters>
+<parameter name="domain">
+<parameter_description> the translation domain to use, or %NULL to use
+the domain set with textdomain()
+</parameter_description>
+</parameter>
+<parameter name="msgid">
+<parameter_description> message to translate
+</parameter_description>
+</parameter>
+<parameter name="category">
+<parameter_description> a locale category
+</parameter_description>
+</parameter>
</parameters>
-<return> the directory to use for temporary files.
+<return> the translated string for the given locale category
+
</return>
</function>
-<function name="g_get_user_cache_dir">
+<function name="g_dgettext">
<description>
-Returns a base directory in which to store non-essential, cached
-data specific to particular user.
+This function is a wrapper of dgettext() which does not translate
+the message if the default domain as set with textdomain() has no
+translations for the current locale.
-On UNIX platforms this is determined using the mechanisms described in
-the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
-XDG Base Directory Specification</ulink>.
-In this case the directory retrieved will be XDG_CACHE_HOME.
+The advantage of using this function over dgettext() proper is that
+libraries using this function (like GTK+) will not use translations
+if the application using the library does not have translations for
+the current locale. This results in a consistent English-only
+interface instead of one having partial translations. For this
+feature to work, the call to textdomain() and setlocale() should
+precede any g_dgettext() invocations. For GTK+, it means calling
+textdomain() before gtk_init or its variants.
-On Windows is the directory that serves as a common repository for
-temporary Internet files. A typical path is
-C:\Documents and Settings\username\Local Settings\Temporary Internet Files.
-See documentation for CSIDL_INTERNET_CACHE.
+This function disables translations if and only if upon its first
+call all the following conditions hold:
+<itemizedlist>
+<listitem>@domain is not %NULL</listitem>
+<listitem>textdomain() has been called to set a default text domain</listitem>
+<listitem>there is no translations available for the default text domain
+and the current locale</listitem>
+<listitem>current locale is not "C" or any English locales (those
+starting with "en_")</listitem>
+</itemizedlist>
-Since: 2.6
+Note that this behavior may not be desired for example if an application
+has its untranslated messages in a language other than English. In those
+cases the application should call textdomain() after initializing GTK+.
+
+Applications should normally not use this function directly,
+but use the _() macro for translations.
+
+Since: 2.18
</description>
<parameters>
+<parameter name="domain">
+<parameter_description> the translation domain to use, or %NULL to use
+the domain set with textdomain()
+</parameter_description>
+</parameter>
+<parameter name="msgid">
+<parameter_description> message to translate
+</parameter_description>
+</parameter>
</parameters>
-<return> a string owned by GLib that must not be modified
-or freed.
+<return> The translated string
+
</return>
</function>
-<function name="g_get_user_config_dir">
+<function name="g_dir_close">
<description>
-Returns a base directory in which to store user-specific application
-configuration information such as user preferences and settings.
-
-On UNIX platforms this is determined using the mechanisms described in
-the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
-XDG Base Directory Specification</ulink>.
-In this case the directory retrieved will be XDG_CONFIG_HOME.
-
-On Windows this is the folder to use for local (as opposed to
-roaming) application data. See documentation for
-CSIDL_LOCAL_APPDATA. Note that on Windows it thus is the same as
-what g_get_user_data_dir() returns.
-
-Since: 2.6
+Closes the directory and deallocates all related resources.
</description>
<parameters>
+<parameter name="dir">
+<parameter_description> a #GDir* created by g_dir_open()
+</parameter_description>
+</parameter>
</parameters>
-<return> a string owned by GLib that must not be modified
-or freed.
-</return>
+<return></return>
</function>
-<function name="g_get_user_data_dir">
+<function name="g_dir_open">
<description>
-Returns a base directory in which to access application data such
-as icons that is customized for a particular user.
+Opens a directory for reading. The names of the files in the
+directory can then be retrieved using g_dir_read_name(). Note
+that the ordering is not defined.
-On UNIX platforms this is determined using the mechanisms described in
-the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
-XDG Base Directory Specification</ulink>.
-In this case the directory retrieved will be XDG_DATA_HOME.
-
-On Windows this is the folder to use for local (as opposed to
-roaming) application data. See documentation for
-CSIDL_LOCAL_APPDATA. Note that on Windows it thus is the same as
-what g_get_user_config_dir() returns.
-
-Since: 2.6
</description>
<parameters>
+<parameter name="path">
+<parameter_description> the path to the directory you are interested in. On Unix
+in the on-disk encoding. On Windows in UTF-8
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> Currently must be set to 0. Reserved for future use.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError, or %NULL.
+If non-%NULL, an error will be set if and only if
+g_dir_open() fails.
+</parameter_description>
+</parameter>
</parameters>
-<return> a string owned by GLib that must not be modified
-or freed.
+<return> a newly allocated #GDir on success, %NULL on failure.
+If non-%NULL, you must free the result with g_dir_close()
+when you are finished with it.
</return>
</function>
-<function name="g_get_user_name">
+<function name="g_dir_read_name">
<description>
-Gets the user name of the current user. The encoding of the returned
-string is system-defined. On UNIX, it might be the preferred file name
-encoding, or something else, and there is no guarantee that it is even
-consistent on a machine. On Windows, it is always UTF-8.
+Retrieves the name of another entry in the directory, or %NULL.
+The order of entries returned from this function is not defined,
+and may vary by file system or other operating-system dependent
+factors.
+
+On Unix, the '.' and '..' entries are omitted, and the returned
+name is in the on-disk encoding.
+
+On Windows, as is true of all GLib functions which operate on
+filenames, the returned name is in UTF-8.
</description>
<parameters>
+<parameter name="dir">
+<parameter_description> a #GDir* created by g_dir_open()
+</parameter_description>
+</parameter>
</parameters>
-<return> the user name of the current user.
+<return> The entry's name or %NULL if there are no
+more entries. The return value is owned by GLib and
+must not be modified or freed.
</return>
</function>
-<function name="g_get_user_runtime_dir">
+<function name="g_dir_rewind">
<description>
-Returns a directory that is unique to the current user on the local
-system.
-
-On UNIX platforms this is determined using the mechanisms described in
-the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
-XDG Base Directory Specification</ulink>. This is the directory
-specified in the <envar>XDG_RUNTIME_DIR</envar> environment variable.
-In the case that this variable is not set, GLib will issue a warning
-message to stderr and return the value of g_get_user_cache_dir().
-
-On Windows this is the folder to use for local (as opposed to
-roaming) application data. See documentation for
-CSIDL_LOCAL_APPDATA. Note that on Windows it thus is the same as
-what g_get_user_config_dir() returns.
-
-Since: 2.28
+Resets the given directory. The next call to g_dir_read_name()
+will return the first entry again.
</description>
<parameters>
+<parameter name="dir">
+<parameter_description> a #GDir* created by g_dir_open()
+</parameter_description>
+</parameter>
</parameters>
-<return> a string owned by GLib that must not be modified or freed.
-
-</return>
+<return></return>
</function>
-<function name="g_get_user_special_dir">
+<function name="g_direct_equal">
<description>
-Returns the full path of a special directory using its logical id.
-
-On Unix this is done using the XDG special user directories.
-For compatibility with existing practise, %G_USER_DIRECTORY_DESKTOP
-falls back to <filename>$HOME/Desktop</filename> when XDG special
-user directories have not been set up.
-
-Depending on the platform, the user might be able to change the path
-of the special directory without requiring the session to restart; GLib
-will not reflect any change once the special directories are loaded.
+Compares two #gpointer arguments and returns %TRUE if they are equal.
+It can be passed to g_hash_table_new() as the @key_equal_func
+parameter, when using pointers as keys in a #GHashTable.
-Since: 2.14
</description>
<parameters>
-<parameter name="directory">
-<parameter_description> the logical id of special directory
+<parameter name="v1">
+<parameter_description> a key.
+</parameter_description>
+</parameter>
+<parameter name="v2">
+<parameter_description> a key to compare with @v1.
</parameter_description>
</parameter>
</parameters>
-<return> the path to the specified special directory, or %NULL
-if the logical id was not found. The returned string is owned by
-GLib and should not be modified or freed.
-
+<return> %TRUE if the two keys match.
</return>
</function>
-<function name="g_getenv">
+<function name="g_direct_hash">
<description>
-Returns the value of an environment variable. The name and value
-are in the GLib file name encoding. On UNIX, this means the actual
-bytes which might or might not be in some consistent character set
-and encoding. On Windows, it is in UTF-8. On Windows, in case the
-environment variable's value contains references to other
-environment variables, they are expanded.
+Converts a gpointer to a hash value.
+It can be passed to g_hash_table_new() as the @hash_func parameter,
+when using pointers as keys in a #GHashTable.
</description>
<parameters>
-<parameter name="variable">
-<parameter_description> the environment variable to get, in the GLib file name encoding.
+<parameter name="v">
+<parameter_description> a #gpointer key
</parameter_description>
</parameter>
</parameters>
-<return> the value of the environment variable, or %NULL if
-the environment variable is not found. The returned string may be
-overwritten by the next call to g_getenv(), g_setenv() or
-g_unsetenv().
+<return> a hash value corresponding to the key.
</return>
</function>
-<function name="g_hash_table_destroy">
+<function name="g_dirname">
<description>
-Destroys all keys and values in the #GHashTable and decrements its
-reference count by 1. If keys and/or values are dynamically allocated,
-you should either free them first or create the #GHashTable with destroy
-notifiers using g_hash_table_new_full(). In the latter case the destroy
-functions you supplied will be called on all keys and values during the
-destruction phase.
+Gets the directory components of a file name.
+If the file name has no directory components "." is returned.
+The returned string should be freed when no longer needed.
+
+Deprecated: use g_path_get_dirname() instead
</description>
<parameters>
-<parameter name="hash_table">
-<parameter_description> a #GHashTable.
+<parameter name="file_name">
+<parameter_description> the name of the file
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the directory components of the file
+
+</return>
</function>
-<function name="g_hash_table_find">
+<function name="g_dngettext">
<description>
-Calls the given function for key/value pairs in the #GHashTable until
- predicate returns %TRUE. The function is passed the key and value of
-each pair, and the given @user_data parameter. The hash table may not
-be modified while iterating over it (you can't add/remove items).
+This function is a wrapper of dngettext() which does not translate
+the message if the default domain as set with textdomain() has no
+translations for the current locale.
-Note, that hash tables are really only optimized for forward lookups,
-i.e. g_hash_table_lookup().
-So code that frequently issues g_hash_table_find() or
-g_hash_table_foreach() (e.g. in the order of once per every entry in a
-hash table) should probably be reworked to use additional or different
-data structures for reverse lookups (keep in mind that an O(n) find/foreach
-operation issued for all n values in a hash table ends up needing O(n*n)
-operations).
+See g_dgettext() for details of how this differs from dngettext()
+proper.
-Since: 2.4
+Since: 2.18
</description>
<parameters>
-<parameter name="hash_table">
-<parameter_description> a #GHashTable.
+<parameter name="domain">
+<parameter_description> the translation domain to use, or %NULL to use
+the domain set with textdomain()
</parameter_description>
</parameter>
-<parameter name="predicate">
-<parameter_description> function to test the key/value pairs for a certain property.
+<parameter name="msgid">
+<parameter_description> message to translate
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> user data to pass to the function.
+<parameter name="msgid_plural">
+<parameter_description> plural form of the message
+</parameter_description>
+</parameter>
+<parameter name="n">
+<parameter_description> the quantity for which translation is needed
</parameter_description>
</parameter>
</parameters>
-<return> The value of the first key/value pair is returned, for which
-func evaluates to %TRUE. If no pair with the requested property is found,
-%NULL is returned.
+<return> The translated string
</return>
</function>
-<function name="g_hash_table_foreach">
+<function name="g_double_equal">
<description>
-Calls the given function for each of the key/value pairs in the
-#GHashTable. The function is passed the key and value of each
-pair, and the given @user_data parameter. The hash table may not
-be modified while iterating over it (you can't add/remove
-items). To remove all items matching a predicate, use
-g_hash_table_foreach_remove().
+Compares the two #gdouble values being pointed to and returns
+%TRUE if they are equal.
+It can be passed to g_hash_table_new() as the @key_equal_func
+parameter, when using pointers to doubles as keys in a #GHashTable.
-See g_hash_table_find() for performance caveats for linear
-order searches in contrast to g_hash_table_lookup().
+Since: 2.22
</description>
<parameters>
-<parameter name="hash_table">
-<parameter_description> a #GHashTable.
-</parameter_description>
-</parameter>
-<parameter name="func">
-<parameter_description> the function to call for each key/value pair.
+<parameter name="v1">
+<parameter_description> a pointer to a #gdouble key.
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> user data to pass to the function.
+<parameter name="v2">
+<parameter_description> a pointer to a #gdouble key to compare with @v1.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the two keys match.
+
+</return>
</function>
-<function name="g_hash_table_foreach_remove">
+<function name="g_double_hash">
<description>
-Calls the given function for each key/value pair in the #GHashTable.
-If the function returns %TRUE, then the key/value pair is removed from the
-#GHashTable. If you supplied key or value destroy functions when creating
-the #GHashTable, they are used to free the memory allocated for the removed
-keys and values.
-
-See #GHashTableIter for an alternative way to loop over the
-key/value pairs in the hash table.
+Converts a pointer to a #gdouble to a hash value.
+It can be passed to g_hash_table_new() as the @hash_func parameter,
+when using pointers to doubles as keys in a #GHashTable.
+Since: 2.22
</description>
<parameters>
-<parameter name="hash_table">
-<parameter_description> a #GHashTable.
-</parameter_description>
-</parameter>
-<parameter name="func">
-<parameter_description> the function to call for each key/value pair.
-</parameter_description>
-</parameter>
-<parameter name="user_data">
-<parameter_description> user data to pass to the function.
+<parameter name="v">
+<parameter_description> a pointer to a #gdouble key
</parameter_description>
</parameter>
</parameters>
-<return> the number of key/value pairs removed.
+<return> a hash value corresponding to the key.
+
</return>
</function>
-<function name="g_hash_table_foreach_steal">
+<function name="g_dpgettext">
<description>
-Calls the given function for each key/value pair in the #GHashTable.
-If the function returns %TRUE, then the key/value pair is removed from the
-#GHashTable, but no key or value destroy functions are called.
+This function is a variant of g_dgettext() which supports
+a disambiguating message context. GNU gettext uses the
+'\004' character to separate the message context and
+message id in @msgctxtid.
+If 0 is passed as @msgidoffset, this function will fall back to
+trying to use the deprecated convention of using "|" as a separation
+character.
-See #GHashTableIter for an alternative way to loop over the
-key/value pairs in the hash table.
+This uses g_dgettext() internally. See that functions for differences
+with dgettext() proper.
+
+Applications should normally not use this function directly,
+but use the C_() macro for translations with context.
+Since: 2.16
</description>
<parameters>
-<parameter name="hash_table">
-<parameter_description> a #GHashTable.
+<parameter name="domain">
+<parameter_description> the translation domain to use, or %NULL to use
+the domain set with textdomain()
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> the function to call for each key/value pair.
+<parameter name="msgctxtid">
+<parameter_description> a combined message context and message id, separated
+by a \004 character
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> user data to pass to the function.
+<parameter name="msgidoffset">
+<parameter_description> the offset of the message id in @msgctxid
</parameter_description>
</parameter>
</parameters>
-<return> the number of key/value pairs removed.
+<return> The translated string
+
</return>
</function>
-<function name="g_hash_table_get_keys">
+<function name="g_dpgettext2">
<description>
-Retrieves every key inside @hash_table. The returned data is valid
-until @hash_table is modified.
+This function is a variant of g_dgettext() which supports
+a disambiguating message context. GNU gettext uses the
+'\004' character to separate the message context and
+message id in @msgctxtid.
-Since: 2.14
+This uses g_dgettext() internally. See that functions for differences
+with dgettext() proper.
+
+This function differs from C_() in that it is not a macro and
+thus you may use non-string-literals as context and msgid arguments.
+
+Since: 2.18
</description>
<parameters>
-<parameter name="hash_table">
-<parameter_description> a #GHashTable
+<parameter name="domain">
+<parameter_description> the translation domain to use, or %NULL to use
+the domain set with textdomain()
+</parameter_description>
+</parameter>
+<parameter name="context">
+<parameter_description> the message context
+</parameter_description>
+</parameter>
+<parameter name="msgid">
+<parameter_description> the message
</parameter_description>
</parameter>
</parameters>
-<return> a #GList containing all the keys inside the hash
-table. The content of the list is owned by the hash table and
-should not be modified or freed. Use g_list_free() when done
-using the list.
+<return> The translated string
</return>
</function>
-<function name="g_hash_table_get_values">
+<function name="g_enum_complete_type_info">
<description>
-Retrieves every value inside @hash_table. The returned data is
-valid until @hash_table is modified.
+This function is meant to be called from the complete_type_info()
+function of a #GTypePlugin implementation, as in the following
+example:
-Since: 2.14
+|[
+static void
+my_enum_complete_type_info (GTypePlugin *plugin,
+GType g_type,
+GTypeInfo *info,
+GTypeValueTable *value_table)
+{
+static const GEnumValue values[] = {
+{ MY_ENUM_FOO, "MY_ENUM_FOO", "foo" },
+{ MY_ENUM_BAR, "MY_ENUM_BAR", "bar" },
+{ 0, NULL, NULL }
+};
+
+g_enum_complete_type_info (type, info, values);
+}
+]|
</description>
<parameters>
-<parameter name="hash_table">
-<parameter_description> a #GHashTable
+<parameter name="g_enum_type">
+<parameter_description> the type identifier of the type being completed
+</parameter_description>
+</parameter>
+<parameter name="info">
+<parameter_description> the #GTypeInfo struct to be filled in
+</parameter_description>
+</parameter>
+<parameter name="const_values">
+<parameter_description> An array of #GEnumValue structs for the possible
+enumeration values. The array is terminated by a struct with all
+members being 0.
</parameter_description>
</parameter>
</parameters>
-<return> a #GList containing all the values inside the hash
-table. The content of the list is owned by the hash table and
-should not be modified or freed. Use g_list_free() when done
-using the list.
-
-</return>
+<return></return>
</function>
-<function name="g_hash_table_insert">
+<function name="g_enum_get_value">
<description>
-Inserts a new key and value into a #GHashTable.
+Returns the #GEnumValue for a value.
-If the key already exists in the #GHashTable its current value is replaced
-with the new value. If you supplied a @value_destroy_func when creating the
-#GHashTable, the old value is freed using that function. If you supplied
-a @key_destroy_func when creating the #GHashTable, the passed key is freed
-using that function.
</description>
<parameters>
-<parameter name="hash_table">
-<parameter_description> a #GHashTable.
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a key to insert.
+<parameter name="enum_class">
+<parameter_description> a #GEnumClass
</parameter_description>
</parameter>
<parameter name="value">
-<parameter_description> the value to associate with the key.
+<parameter_description> the value to look up
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the #GEnumValue for @value, or %NULL if @value is not a
+member of the enumeration
+</return>
</function>
-<function name="g_hash_table_iter_get_hash_table">
+<function name="g_enum_get_value_by_name">
<description>
-Returns the #GHashTable associated with @iter.
+Looks up a #GEnumValue by name.
-Since: 2.16
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> an initialized #GHashTableIter.
+<parameter name="enum_class">
+<parameter_description> a #GEnumClass
+</parameter_description>
+</parameter>
+<parameter name="name">
+<parameter_description> the name to look up
</parameter_description>
</parameter>
</parameters>
-<return> the #GHashTable associated with @iter.
-
+<return> the #GEnumValue with name @name, or %NULL if the
+enumeration doesn't have a member with that name
</return>
</function>
-<function name="g_hash_table_iter_init">
+<function name="g_enum_get_value_by_nick">
<description>
-Initializes a key/value pair iterator and associates it with
- hash_table Modifying the hash table after calling this function
-invalidates the returned iterator.
-|[
-GHashTableIter iter;
-gpointer key, value;
-
-g_hash_table_iter_init (&iter, hash_table);
-while (g_hash_table_iter_next (&iter, &key, &value))
-{
-/ * do something with key and value * /
-}
-]|
+Looks up a #GEnumValue by nickname.
-Since: 2.16
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> an uninitialized #GHashTableIter.
+<parameter name="enum_class">
+<parameter_description> a #GEnumClass
</parameter_description>
</parameter>
-<parameter name="hash_table">
-<parameter_description> a #GHashTable.
+<parameter name="nick">
+<parameter_description> the nickname to look up
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the #GEnumValue with nickname @nick, or %NULL if the
+enumeration doesn't have a member with that nickname
+</return>
</function>
-<function name="g_hash_table_iter_next">
+<function name="g_enum_register_static">
<description>
-Advances @iter and retrieves the key and/or value that are now
-pointed to as a result of this advancement. If %FALSE is returned,
- key and @value are not set, and the iterator becomes invalid.
+Registers a new static enumeration type with the name @name.
+
+It is normally more convenient to let <link
+linkend="glib-mkenums">glib-mkenums</link> generate a
+my_enum_get_type() function from a usual C enumeration definition
+than to write one yourself using g_enum_register_static().
-Since: 2.16
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> an initialized #GHashTableIter.
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a location to store the key, or %NULL.
+<parameter name="name">
+<parameter_description> A nul-terminated string used as the name of the new type.
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> a location to store the value, or %NULL.
+<parameter name="const_static_values">
+<parameter_description> An array of #GEnumValue structs for the possible
+enumeration values. The array is terminated by a struct with all
+members being 0. GObject keeps a reference to the data, so it cannot
+be stack-allocated.
</parameter_description>
</parameter>
</parameters>
-<return> %FALSE if the end of the #GHashTable has been reached.
-
+<return> The new type identifier.
</return>
</function>
-<function name="g_hash_table_iter_remove">
+<function name="g_error_copy">
<description>
-Removes the key/value pair currently pointed to by the iterator
-from its associated #GHashTable. Can only be called after
-g_hash_table_iter_next() returned %TRUE, and cannot be called more
-than once for the same key/value pair.
-
-If the #GHashTable was created using g_hash_table_new_full(), the
-key and value are freed using the supplied destroy functions, otherwise
-you have to make sure that any dynamically allocated values are freed
-yourself.
+Makes a copy of @error.
-Since: 2.16
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> an initialized #GHashTableIter.
+<parameter name="error">
+<parameter_description> a #GError
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a new #GError
+</return>
</function>
-<function name="g_hash_table_iter_steal">
+<function name="g_error_free">
<description>
-Removes the key/value pair currently pointed to by the iterator
-from its associated #GHashTable, without calling the key and value
-destroy functions. Can only be called after
-g_hash_table_iter_next() returned %TRUE, and cannot be called more
-than once for the same key/value pair.
-
-Since: 2.16
+Frees a #GError and associated resources.
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> an initialized #GHashTableIter.
+<parameter name="error">
+<parameter_description> a #GError
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_hash_table_lookup">
+<function name="g_error_matches">
<description>
-Looks up a key in a #GHashTable. Note that this function cannot
-distinguish between a key that is not present and one which is present
-and has the value %NULL. If you need this distinction, use
-g_hash_table_lookup_extended().
+Returns %TRUE if @error matches @domain and @code, %FALSE
+otherwise. In particular, when @error is %NULL, %FALSE will
+be returned.
</description>
<parameters>
-<parameter name="hash_table">
-<parameter_description> a #GHashTable.
+<parameter name="error">
+<parameter_description> a #GError or %NULL
</parameter_description>
</parameter>
-<parameter name="key">
-<parameter_description> the key to look up.
+<parameter name="domain">
+<parameter_description> an error domain
+</parameter_description>
+</parameter>
+<parameter name="code">
+<parameter_description> an error code
</parameter_description>
</parameter>
</parameters>
-<return> the associated value, or %NULL if the key is not found.
+<return> whether @error has @domain and @code
</return>
</function>
-<function name="g_hash_table_lookup_extended">
+<function name="g_error_new">
<description>
-Looks up a key in the #GHashTable, returning the original key and the
-associated value and a #gboolean which is %TRUE if the key was found. This
-is useful if you need to free the memory allocated for the original key,
-for example before calling g_hash_table_remove().
-
-You can actually pass %NULL for @lookup_key to test
-whether the %NULL key exists, provided the hash and equal functions
-of @hash_table are %NULL-safe.
+Creates a new #GError with the given @domain and @code,
+and a message formatted with @format.
</description>
<parameters>
-<parameter name="hash_table">
-<parameter_description> a #GHashTable
+<parameter name="domain">
+<parameter_description> error domain
</parameter_description>
</parameter>
-<parameter name="lookup_key">
-<parameter_description> the key to look up
+<parameter name="code">
+<parameter_description> error code
</parameter_description>
</parameter>
-<parameter name="orig_key">
-<parameter_description> return location for the original key, or %NULL
+<parameter name="format">
+<parameter_description> printf()-style format for error message
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> return location for the value associated with the key, or %NULL
+<parameter name="Varargs">
+<parameter_description> parameters for message format
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the key was found in the #GHashTable.
+<return> a new #GError
</return>
</function>
-<function name="g_hash_table_new">
+<function name="g_error_new_literal">
<description>
-Creates a new #GHashTable with a reference count of 1.
+Creates a new #GError; unlike g_error_new(), @message is
+not a printf()-style format string. Use this function if
+ message contains text you don't have control over,
+that could include printf() escape sequences.
</description>
<parameters>
-<parameter name="hash_func">
-<parameter_description> a function to create a hash value from a key.
-Hash values are used to determine where keys are stored within the
-#GHashTable data structure. The g_direct_hash(), g_int_hash(),
-g_int64_hash(), g_double_hash() and g_str_hash() functions are provided
-for some common types of keys.
-If hash_func is %NULL, g_direct_hash() is used.
+<parameter name="domain">
+<parameter_description> error domain
</parameter_description>
</parameter>
-<parameter name="key_equal_func">
-<parameter_description> a function to check two keys for equality. This is
-used when looking up keys in the #GHashTable. The g_direct_equal(),
-g_int_equal(), g_int64_equal(), g_double_equal() and g_str_equal()
-functions are provided for the most common types of keys.
-If @key_equal_func is %NULL, keys are compared directly in a similar
-fashion to g_direct_equal(), but without the overhead of a function call.
+<parameter name="code">
+<parameter_description> error code
</parameter_description>
</parameter>
-</parameters>
-<return> a new #GHashTable.
+<parameter name="message">
+<parameter_description> error message
+</parameter_description>
+</parameter>
+</parameters>
+<return> a new #GError
</return>
</function>
-<function name="g_hash_table_new_full">
+<function name="g_error_new_valist">
<description>
-Creates a new #GHashTable like g_hash_table_new() with a reference count
-of 1 and allows to specify functions to free the memory allocated for the
-key and value that get called when removing the entry from the #GHashTable.
+Creates a new #GError with the given @domain and @code,
+and a message formatted with @format.
+Since: 2.22
</description>
<parameters>
-<parameter name="hash_func">
-<parameter_description> a function to create a hash value from a key.
+<parameter name="domain">
+<parameter_description> error domain
</parameter_description>
</parameter>
-<parameter name="key_equal_func">
-<parameter_description> a function to check two keys for equality.
+<parameter name="code">
+<parameter_description> error code
</parameter_description>
</parameter>
-<parameter name="key_destroy_func">
-<parameter_description> a function to free the memory allocated for the key
-used when removing the entry from the #GHashTable or %NULL if you
-don't want to supply such a function.
+<parameter name="format">
+<parameter_description> printf()-style format for error message
</parameter_description>
</parameter>
-<parameter name="value_destroy_func">
-<parameter_description> a function to free the memory allocated for the
-value used when removing the entry from the #GHashTable or %NULL if
-you don't want to supply such a function.
+<parameter name="args">
+<parameter_description> #va_list of parameters for the message format
</parameter_description>
</parameter>
</parameters>
-<return> a new #GHashTable.
+<return> a new #GError
+
</return>
</function>
-<function name="g_hash_table_ref">
+<function name="g_file_error_from_errno">
<description>
-Atomically increments the reference count of @hash_table by one.
-This function is MT-safe and may be called from any thread.
+Gets a #GFileError constant based on the passed-in @errno.
+For example, if you pass in %EEXIST this function returns
+#G_FILE_ERROR_EXIST. Unlike @errno values, you can portably
+assume that all #GFileError values will exist.
+
+Normally a #GFileError value goes into a #GError returned
+from a function that manipulates files. So you would use
+g_file_error_from_errno() when constructing a #GError.
-Since: 2.10
</description>
<parameters>
-<parameter name="hash_table">
-<parameter_description> a valid #GHashTable.
+<parameter name="err_no">
+<parameter_description> an "errno" value
</parameter_description>
</parameter>
</parameters>
-<return> the passed in #GHashTable.
-
+<return> #GFileError corresponding to the given @errno
</return>
</function>
-<function name="g_hash_table_remove">
+<function name="g_file_get_contents">
<description>
-Removes a key and its associated value from a #GHashTable.
+Reads an entire file into allocated memory, with good error
+checking.
-If the #GHashTable was created using g_hash_table_new_full(), the
-key and value are freed using the supplied destroy functions, otherwise
-you have to make sure that any dynamically allocated values are freed
-yourself.
+If the call was successful, it returns %TRUE and sets @contents to the file
+contents and @length to the length of the file contents in bytes. The string
+stored in @contents will be nul-terminated, so for text files you can pass
+%NULL for the @length argument. If the call was not successful, it returns
+%FALSE and sets @error. The error domain is #G_FILE_ERROR. Possible error
+codes are those in the #GFileError enumeration. In the error case,
+ contents is set to %NULL and @length is set to zero.
</description>
<parameters>
-<parameter name="hash_table">
-<parameter_description> a #GHashTable.
+<parameter name="filename">
+<parameter_description> name of a file to read contents from, in the GLib file name encoding
</parameter_description>
</parameter>
-<parameter name="key">
-<parameter_description> the key to remove.
+<parameter name="contents">
+<parameter_description> location to store an allocated string, use g_free() to free
+the returned string
+</parameter_description>
+</parameter>
+<parameter name="length">
+<parameter_description> location to store length in bytes of the contents, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the key was found and removed from the #GHashTable.
+<return> %TRUE on success, %FALSE if an error occurred
</return>
</function>
-<function name="g_hash_table_remove_all">
+<function name="g_file_open_tmp">
<description>
-Removes all keys and their associated values from a #GHashTable.
+Opens a file for writing in the preferred directory for temporary
+files (as returned by g_get_tmp_dir()).
-If the #GHashTable was created using g_hash_table_new_full(), the keys
-and values are freed using the supplied destroy functions, otherwise you
-have to make sure that any dynamically allocated values are freed
-yourself.
+ tmpl should be a string in the GLib file name encoding containing
+a sequence of six 'X' characters, as the parameter to g_mkstemp().
+However, unlike these functions, the template should only be a
+basename, no directory components are allowed. If template is
+%NULL, a default template is used.
-Since: 2.12
+Note that in contrast to g_mkstemp() (and mkstemp())
+ tmpl is not modified, and might thus be a read-only literal string.
-</description>
-<parameters>
-<parameter name="hash_table">
-<parameter_description> a #GHashTable
-</parameter_description>
-</parameter>
-</parameters>
-<return></return>
-</function>
+The actual name used is returned in @name_used if non-%NULL. This
+string should be freed with g_free() when not needed any longer.
+The returned name is in the GLib file name encoding.
-<function name="g_hash_table_replace">
-<description>
-Inserts a new key and value into a #GHashTable similar to
-g_hash_table_insert(). The difference is that if the key already exists
-in the #GHashTable, it gets replaced by the new key. If you supplied a
- value_destroy_func when creating the #GHashTable, the old value is freed
-using that function. If you supplied a @key_destroy_func when creating the
-#GHashTable, the old key is freed using that function.
</description>
<parameters>
-<parameter name="hash_table">
-<parameter_description> a #GHashTable.
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a key to insert.
+<parameter name="tmpl">
+<parameter_description> Template for file name, as in g_mkstemp(), basename only,
+or %NULL, to a default template
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> the value to associate with the key.
+<parameter name="name_used">
+<parameter_description> location to store actual name used, or %NULL
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="g_hash_table_size">
-<description>
-Returns the number of elements contained in the #GHashTable.
-
-
-</description>
-<parameters>
-<parameter name="hash_table">
-<parameter_description> a #GHashTable.
+<parameter name="error">
+<parameter_description> return location for a #GError
</parameter_description>
</parameter>
</parameters>
-<return> the number of key/value pairs in the #GHashTable.
+<return> A file handle (as from open()) to
+the file opened for reading and writing. The file is opened in binary
+mode on platforms where there is a difference. The file handle should be
+closed with close(). In case of errors, -1 is returned
+and @error will be set.
</return>
</function>
-<function name="g_hash_table_steal">
+<function name="g_file_read_link">
<description>
-Removes a key and its associated value from a #GHashTable without
-calling the key and value destroy functions.
+Reads the contents of the symbolic link @filename like the POSIX
+readlink() function. The returned string is in the encoding used
+for filenames. Use g_filename_to_utf8() to convert it to UTF-8.
+Since: 2.4
</description>
<parameters>
-<parameter name="hash_table">
-<parameter_description> a #GHashTable.
+<parameter name="filename">
+<parameter_description> the symbolic link
</parameter_description>
</parameter>
-<parameter name="key">
-<parameter_description> the key to remove.
+<parameter name="error">
+<parameter_description> return location for a #GError
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the key was found and removed from the #GHashTable.
+<return> A newly-allocated string with the contents of the symbolic link,
+or %NULL if an error occurred.
+
</return>
</function>
-<function name="g_hash_table_steal_all">
+<function name="g_file_set_contents">
<description>
-Removes all keys and their associated values from a #GHashTable
-without calling the key and value destroy functions.
+Writes all of @contents to a file named @filename, with good error checking.
+If a file called @filename already exists it will be overwritten.
-Since: 2.12
+This write is atomic in the sense that it is first written to a temporary
+file which is then renamed to the final name. Notes:
+<itemizedlist>
+<listitem>
+On Unix, if @filename already exists hard links to @filename will break.
+Also since the file is recreated, existing permissions, access control
+lists, metadata etc. may be lost. If @filename is a symbolic link,
+the link itself will be replaced, not the linked file.
+</listitem>
+<listitem>
+On Windows renaming a file will not remove an existing file with the
+new name, so on Windows there is a race condition between the existing
+file being removed and the temporary file being renamed.
+</listitem>
+<listitem>
+On Windows there is no way to remove a file that is open to some
+process, or mapped into memory. Thus, this function will fail if
+ filename already exists and is open.
+</listitem>
+</itemizedlist>
-</description>
-<parameters>
-<parameter name="hash_table">
-<parameter_description> a #GHashTable.
-</parameter_description>
-</parameter>
-</parameters>
-<return></return>
-</function>
+If the call was sucessful, it returns %TRUE. If the call was not successful,
+it returns %FALSE and sets @error. The error domain is #G_FILE_ERROR.
+Possible error codes are those in the #GFileError enumeration.
-<function name="g_hash_table_unref">
-<description>
-Atomically decrements the reference count of @hash_table by one.
-If the reference count drops to 0, all keys and values will be
-destroyed, and all memory allocated by the hash table is released.
-This function is MT-safe and may be called from any thread.
+Note that the name for the temporary file is constructed by appending up
+to 7 characters to @filename.
-Since: 2.10
+Since: 2.8
</description>
<parameters>
-<parameter name="hash_table">
-<parameter_description> a valid #GHashTable.
+<parameter name="filename">
+<parameter_description> name of a file to write @contents to, in the GLib file name
+encoding
+</parameter_description>
+</parameter>
+<parameter name="contents">
+<parameter_description> string to write to the file
+</parameter_description>
+</parameter>
+<parameter name="length">
+<parameter_description> length of @contents, or -1 if @contents is a nul-terminated string
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE on success, %FALSE if an error occurred
+
+</return>
</function>
-<function name="g_hostname_is_ascii_encoded">
+<function name="g_file_test">
<description>
-Tests if @hostname contains segments with an ASCII-compatible
-encoding of an Internationalized Domain Name. If this returns
-%TRUE, you should decode the hostname with g_hostname_to_unicode()
-before displaying it to the user.
+Returns %TRUE if any of the tests in the bitfield @test are
+%TRUE. For example, <literal>(G_FILE_TEST_EXISTS |
+G_FILE_TEST_IS_DIR)</literal> will return %TRUE if the file exists;
+the check whether it's a directory doesn't matter since the existence
+test is %TRUE. With the current set of available tests, there's no point
+passing in more than one test at a time.
-Note that a hostname might contain a mix of encoded and unencoded
-segments, and so it is possible for g_hostname_is_non_ascii() and
-g_hostname_is_ascii_encoded() to both return %TRUE for a name.
+Apart from %G_FILE_TEST_IS_SYMLINK all tests follow symbolic links,
+so for a symbolic link to a regular file g_file_test() will return
+%TRUE for both %G_FILE_TEST_IS_SYMLINK and %G_FILE_TEST_IS_REGULAR.
-Since: 2.22
+Note, that for a dangling symbolic link g_file_test() will return
+%TRUE for %G_FILE_TEST_IS_SYMLINK and %FALSE for all other flags.
-</description>
-<parameters>
-<parameter name="hostname">
-<parameter_description> a hostname
-</parameter_description>
-</parameter>
-</parameters>
-<return> %TRUE if @hostname contains any ASCII-encoded
-segments.
+You should never use g_file_test() to test whether it is safe
+to perform an operation, because there is always the possibility
+of the condition changing before you actually perform the operation.
+For example, you might think you could use %G_FILE_TEST_IS_SYMLINK
+to know whether it is safe to write to a file without being
+tricked into writing into a different location. It doesn't work!
+|[
+/ * DON'T DO THIS * /
+if (!g_file_test (filename, G_FILE_TEST_IS_SYMLINK))
+{
+fd = g_open (filename, O_WRONLY);
+/ * write to fd * /
+}
+]|
-</return>
-</function>
+Another thing to note is that %G_FILE_TEST_EXISTS and
+%G_FILE_TEST_IS_EXECUTABLE are implemented using the access()
+system call. This usually doesn't matter, but if your program
+is setuid or setgid it means that these tests will give you
+the answer for the real user ID and group ID, rather than the
+effective user ID and group ID.
-<function name="g_hostname_is_ip_address">
-<description>
-Tests if @hostname is the string form of an IPv4 or IPv6 address.
-(Eg, "192.168.0.1".)
+On Windows, there are no symlinks, so testing for
+%G_FILE_TEST_IS_SYMLINK will always return %FALSE. Testing for
+%G_FILE_TEST_IS_EXECUTABLE will just check that the file exists and
+its name indicates that it is executable, checking for well-known
+extensions and those listed in the %PATHEXT environment variable.
-Since: 2.22
</description>
<parameters>
-<parameter name="hostname">
-<parameter_description> a hostname (or IP address in string form)
+<parameter name="filename">
+<parameter_description> a filename to test in the GLib file name encoding
+</parameter_description>
+</parameter>
+<parameter name="test">
+<parameter_description> bitfield of #GFileTest flags
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @hostname is an IP address
-
+<return> whether a test was %TRUE
</return>
</function>
-<function name="g_hostname_is_non_ascii">
+<function name="g_filename_display_basename">
<description>
-Tests if @hostname contains Unicode characters. If this returns
-%TRUE, you need to encode the hostname with g_hostname_to_ascii()
-before using it in non-IDN-aware contexts.
+Returns the display basename for the particular filename, guaranteed
+to be valid UTF-8. The display name might not be identical to the filename,
+for instance there might be problems converting it to UTF-8, and some files
+can be translated in the display.
-Note that a hostname might contain a mix of encoded and unencoded
-segments, and so it is possible for g_hostname_is_non_ascii() and
-g_hostname_is_ascii_encoded() to both return %TRUE for a name.
+If GLib cannot make sense of the encoding of @filename, as a last resort it
+replaces unknown characters with U+FFFD, the Unicode replacement character.
+You can search the result for the UTF-8 encoding of this character (which is
+"\357\277\275" in octal notation) to find out if @filename was in an invalid
+encoding.
-Since: 2.22
+You must pass the whole absolute pathname to this functions so that
+translation of well known locations can be done.
+
+This function is preferred over g_filename_display_name() if you know the
+whole path, as it allows translation.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="hostname">
-<parameter_description> a hostname
+<parameter name="filename">
+<parameter_description> an absolute pathname in the GLib file name encoding
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @hostname contains any non-ASCII characters
+<return> a newly allocated string containing
+a rendition of the basename of the filename in valid UTF-8
</return>
</function>
-<function name="g_hostname_to_ascii">
+<function name="g_filename_display_name">
<description>
-Converts @hostname to its canonical ASCII form; an ASCII-only
-string containing no uppercase letters and not ending with a
-trailing dot.
+Converts a filename into a valid UTF-8 string. The conversion is
+not necessarily reversible, so you should keep the original around
+and use the return value of this function only for display purposes.
+Unlike g_filename_to_utf8(), the result is guaranteed to be non-%NULL
+even if the filename actually isn't in the GLib file name encoding.
-Since: 2.22
+If GLib cannot make sense of the encoding of @filename, as a last resort it
+replaces unknown characters with U+FFFD, the Unicode replacement character.
+You can search the result for the UTF-8 encoding of this character (which is
+"\357\277\275" in octal notation) to find out if @filename was in an invalid
+encoding.
+
+If you know the whole pathname of the file you should use
+g_filename_display_basename(), since that allows location-based
+translation of filenames.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="hostname">
-<parameter_description> a valid UTF-8 or ASCII hostname
+<parameter name="filename">
+<parameter_description> a pathname hopefully in the GLib file name encoding
</parameter_description>
</parameter>
</parameters>
-<return> an ASCII hostname, which must be freed, or %NULL if
- hostname is in some way invalid.
+<return> a newly allocated string containing
+a rendition of the filename in valid UTF-8
</return>
</function>
-<function name="g_hostname_to_unicode">
+<function name="g_filename_from_uri">
<description>
-Converts @hostname to its canonical presentation form; a UTF-8
-string in Unicode normalization form C, containing no uppercase
-letters, no forbidden characters, and no ASCII-encoded segments,
-and not ending with a trailing dot.
-
-Of course if @hostname is not an internationalized hostname, then
-the canonical presentation form will be entirely ASCII.
+Converts an escaped ASCII-encoded URI to a local filename in the
+encoding used for filenames.
-Since: 2.22
</description>
<parameters>
+<parameter name="uri">
+<parameter_description> a uri describing a filename (escaped, encoded in ASCII).
+</parameter_description>
+</parameter>
<parameter name="hostname">
-<parameter_description> a valid UTF-8 or ASCII hostname
+<parameter_description> Location to store hostname for the URI, or %NULL.
+If there is no hostname in the URI, %NULL will be
+stored in this location.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> location to store the error occuring, or %NULL to ignore
+errors. Any of the errors in #GConvertError may occur.
</parameter_description>
</parameter>
</parameters>
-<return> a UTF-8 hostname, which must be freed, or %NULL if
- hostname is in some way invalid.
-
+<return> a newly-allocated string holding the resulting
+filename, or %NULL on an error.
</return>
</function>
-<function name="g_iconv">
+<function name="g_filename_from_utf8">
<description>
-Same as the standard UNIX routine iconv(), but
-may be implemented via libiconv on UNIX flavors that lack
-a native implementation.
-
-GLib provides g_convert() and g_locale_to_utf8() which are likely
-more convenient than the raw iconv wrappers.
+Converts a string from UTF-8 to the encoding GLib uses for
+filenames. Note that on Windows GLib uses UTF-8 for filenames;
+on other platforms, this function indirectly depends on the
+<link linkend="setlocale">current locale</link>.
</description>
<parameters>
-<parameter name="converter">
-<parameter_description> conversion descriptor from g_iconv_open()
+<parameter name="utf8string">
+<parameter_description> a UTF-8 encoded string.
</parameter_description>
</parameter>
-<parameter name="inbuf">
-<parameter_description> bytes to convert
+<parameter name="len">
+<parameter_description> the length of the string, or -1 if the string is
+nul-terminated.
</parameter_description>
</parameter>
-<parameter name="inbytes_left">
-<parameter_description> inout parameter, bytes remaining to convert in @inbuf
+<parameter name="bytes_read">
+<parameter_description> location to store the number of bytes in the
+input string that were successfully converted, or %NULL.
+Even if the conversion was successful, this may be
+less than @len if there were partial characters
+at the end of the input. If the error
+#G_CONVERT_ERROR_ILLEGAL_SEQUENCE occurs, the value
+stored will the byte offset after the last valid
+input sequence.
</parameter_description>
</parameter>
-<parameter name="outbuf">
-<parameter_description> converted output bytes
+<parameter name="bytes_written">
+<parameter_description> the number of bytes stored in the output buffer (not
+including the terminating nul).
</parameter_description>
</parameter>
-<parameter name="outbytes_left">
-<parameter_description> inout parameter, bytes available to fill in @outbuf
+<parameter name="error">
+<parameter_description> location to store the error occuring, or %NULL to ignore
+errors. Any of the errors in #GConvertError may occur.
</parameter_description>
</parameter>
</parameters>
-<return> count of non-reversible conversions, or -1 on error
+<return> The converted string, or %NULL on an error.
</return>
</function>
-<function name="g_iconv_close">
+<function name="g_filename_to_uri">
<description>
-Same as the standard UNIX routine iconv_close(), but
-may be implemented via libiconv on UNIX flavors that lack
-a native implementation. Should be called to clean up
-the conversion descriptor from g_iconv_open() when
-you are done converting things.
-
-GLib provides g_convert() and g_locale_to_utf8() which are likely
-more convenient than the raw iconv wrappers.
+Converts an absolute filename to an escaped ASCII-encoded URI, with the path
+component following Section 3.3. of RFC 2396.
</description>
<parameters>
-<parameter name="converter">
-<parameter_description> a conversion descriptor from g_iconv_open()
+<parameter name="filename">
+<parameter_description> an absolute filename specified in the GLib file name encoding,
+which is the on-disk file name bytes on Unix, and UTF-8 on
+Windows
+</parameter_description>
+</parameter>
+<parameter name="hostname">
+<parameter_description> A UTF-8 encoded hostname, or %NULL for none.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> location to store the error occuring, or %NULL to ignore
+errors. Any of the errors in #GConvertError may occur.
</parameter_description>
</parameter>
</parameters>
-<return> -1 on error, 0 on success
+<return> a newly-allocated string holding the resulting
+URI, or %NULL on an error.
</return>
</function>
-<function name="g_iconv_open">
+<function name="g_filename_to_utf8">
<description>
-Same as the standard UNIX routine iconv_open(), but
-may be implemented via libiconv on UNIX flavors that lack
-a native implementation.
-
-GLib provides g_convert() and g_locale_to_utf8() which are likely
-more convenient than the raw iconv wrappers.
+Converts a string which is in the encoding used by GLib for
+filenames into a UTF-8 string. Note that on Windows GLib uses UTF-8
+for filenames; on other platforms, this function indirectly depends on
+the <link linkend="setlocale">current locale</link>.
</description>
<parameters>
-<parameter name="to_codeset">
-<parameter_description> destination codeset
-</parameter_description>
-</parameter>
-<parameter name="from_codeset">
-<parameter_description> source codeset
+<parameter name="opsysstring">
+<parameter_description> a string in the encoding for filenames
+</parameter_description>
+</parameter>
+<parameter name="len">
+<parameter_description> the length of the string, or -1 if the string is
+nul-terminated<footnoteref linkend="nul-unsafe"/>.
+</parameter_description>
+</parameter>
+<parameter name="bytes_read">
+<parameter_description> location to store the number of bytes in the
+input string that were successfully converted, or %NULL.
+Even if the conversion was successful, this may be
+less than @len if there were partial characters
+at the end of the input. If the error
+#G_CONVERT_ERROR_ILLEGAL_SEQUENCE occurs, the value
+stored will the byte offset after the last valid
+input sequence.
+</parameter_description>
+</parameter>
+<parameter name="bytes_written">
+<parameter_description> the number of bytes stored in the output buffer (not
+including the terminating nul).
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> location to store the error occuring, or %NULL to ignore
+errors. Any of the errors in #GConvertError may occur.
</parameter_description>
</parameter>
</parameters>
-<return> a "conversion descriptor", or (GIConv)-1 if
-opening the converter failed.
+<return> The converted string, or %NULL on an error.
</return>
</function>
-<function name="g_idle_add">
+<function name="g_find_program_in_path">
<description>
-Adds a function to be called whenever there are no higher priority
-events pending to the default main loop. The function is given the
-default idle priority, #G_PRIORITY_DEFAULT_IDLE. If the function
-returns %FALSE it is automatically removed from the list of event
-sources and will not be called again.
+Locates the first executable named @program in the user's path, in the
+same way that execvp() would locate it. Returns an allocated string
+with the absolute path name, or %NULL if the program is not found in
+the path. If @program is already an absolute path, returns a copy of
+ program if @program exists and is executable, and %NULL otherwise.
-This internally creates a main loop source using g_idle_source_new()
-and attaches it to the main loop context using g_source_attach().
-You can do these steps manually if you need greater control.
+On Windows, if @program does not have a file type suffix, tries
+with the suffixes .exe, .cmd, .bat and .com, and the suffixes in
+the <envar>PATHEXT</envar> environment variable.
+
+On Windows, it looks for the file in the same way as CreateProcess()
+would. This means first in the directory where the executing
+program was loaded from, then in the current directory, then in the
+Windows 32-bit system directory, then in the Windows directory, and
+finally in the directories in the <envar>PATH</envar> environment
+variable. If the program is found, the return value contains the
+full name including the type suffix.
</description>
<parameters>
-<parameter name="function">
-<parameter_description> function to call
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> data to pass to @function.
+<parameter name="program">
+<parameter_description> a program name in the GLib file name encoding
</parameter_description>
</parameter>
</parameters>
-<return> the ID (greater than 0) of the event source.
+<return> absolute path, or %NULL
</return>
</function>
-<function name="g_idle_add_full">
+<function name="g_flags_complete_type_info">
<description>
-Adds a function to be called whenever there are no higher priority
-events pending. If the function returns %FALSE it is automatically
-removed from the list of event sources and will not be called again.
-
-This internally creates a main loop source using g_idle_source_new()
-and attaches it to the main loop context using g_source_attach().
-You can do these steps manually if you need greater control.
-
+This function is meant to be called from the complete_type_info()
+function of a #GTypePlugin implementation, see the example for
+g_enum_complete_type_info() above.
</description>
<parameters>
-<parameter name="priority">
-<parameter_description> the priority of the idle source. Typically this will be in the
-range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE.
-</parameter_description>
-</parameter>
-<parameter name="function">
-<parameter_description> function to call
+<parameter name="g_flags_type">
+<parameter_description> the type identifier of the type being completed
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> data to pass to @function
+<parameter name="info">
+<parameter_description> the #GTypeInfo struct to be filled in
</parameter_description>
</parameter>
-<parameter name="notify">
-<parameter_description> function to call when the idle is removed, or %NULL
+<parameter name="const_values">
+<parameter_description> An array of #GFlagsValue structs for the possible
+enumeration values. The array is terminated by a struct with all
+members being 0.
</parameter_description>
</parameter>
</parameters>
-<return> the ID (greater than 0) of the event source.
-</return>
+<return></return>
</function>
-<function name="g_idle_remove_by_data">
+<function name="g_flags_get_first_value">
<description>
-Removes the idle function with the given data.
+Returns the first #GFlagsValue which is set in @value.
</description>
<parameters>
-<parameter name="data">
-<parameter_description> the data for the idle source's callback.
+<parameter name="flags_class">
+<parameter_description> a #GFlagsClass
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> the value
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if an idle source was found and removed.
-</return>
-</function>
-
-<function name="g_idle_source_new">
-<description>
-Creates a new idle source.
-
-The source will not initially be associated with any #GMainContext
-and must be added to one with g_source_attach() before it will be
-executed. Note that the default priority for idle sources is
-%G_PRIORITY_DEFAULT_IDLE, as compared to other sources which
-have a default priority of %G_PRIORITY_DEFAULT.
-
-
-</description>
-<parameters>
-</parameters>
-<return> the newly-created idle source
+<return> the first #GFlagsValue which is set in @value, or %NULL if
+none is set
</return>
</function>
-<function name="g_int64_equal">
+<function name="g_flags_get_value_by_name">
<description>
-Compares the two #gint64 values being pointed to and returns
-%TRUE if they are equal.
-It can be passed to g_hash_table_new() as the @key_equal_func
-parameter, when using pointers to 64-bit integers as keys in a #GHashTable.
+Looks up a #GFlagsValue by name.
-Since: 2.22
</description>
<parameters>
-<parameter name="v1">
-<parameter_description> a pointer to a #gint64 key.
+<parameter name="flags_class">
+<parameter_description> a #GFlagsClass
</parameter_description>
</parameter>
-<parameter name="v2">
-<parameter_description> a pointer to a #gint64 key to compare with @v1.
+<parameter name="name">
+<parameter_description> the name to look up
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the two keys match.
-
+<return> the #GFlagsValue with name @name, or %NULL if there is no
+flag with that name
</return>
</function>
-<function name="g_int64_hash">
+<function name="g_flags_get_value_by_nick">
<description>
-Converts a pointer to a #gint64 to a hash value.
-It can be passed to g_hash_table_new() as the @hash_func parameter,
-when using pointers to 64-bit integers values as keys in a #GHashTable.
+Looks up a #GFlagsValue by nickname.
-Since: 2.22
</description>
<parameters>
-<parameter name="v">
-<parameter_description> a pointer to a #gint64 key
+<parameter name="flags_class">
+<parameter_description> a #GFlagsClass
+</parameter_description>
+</parameter>
+<parameter name="nick">
+<parameter_description> the nickname to look up
</parameter_description>
</parameter>
</parameters>
-<return> a hash value corresponding to the key.
-
+<return> the #GFlagsValue with nickname @nick, or %NULL if there is
+no flag with that nickname
</return>
</function>
-<function name="g_int_equal">
+<function name="g_flags_register_static">
<description>
-Compares the two #gint values being pointed to and returns
-%TRUE if they are equal.
-It can be passed to g_hash_table_new() as the @key_equal_func
-parameter, when using pointers to integers as keys in a #GHashTable.
+Registers a new static flags type with the name @name.
+
+It is normally more convenient to let <link
+linkend="glib-mkenums">glib-mkenums</link> generate a
+my_flags_get_type() function from a usual C enumeration definition
+than to write one yourself using g_flags_register_static().
</description>
<parameters>
-<parameter name="v1">
-<parameter_description> a pointer to a #gint key.
+<parameter name="name">
+<parameter_description> A nul-terminated string used as the name of the new type.
</parameter_description>
</parameter>
-<parameter name="v2">
-<parameter_description> a pointer to a #gint key to compare with @v1.
+<parameter name="const_static_values">
+<parameter_description> An array of #GFlagsValue structs for the possible
+flags values. The array is terminated by a struct with all members being 0.
+GObject keeps a reference to the data, so it cannot be stack-allocated.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the two keys match.
+<return> The new type identifier.
</return>
</function>
-<function name="g_int_hash">
+<function name="g_fopen">
<description>
-Converts a pointer to a #gint to a hash value.
-It can be passed to g_hash_table_new() as the @hash_func parameter,
-when using pointers to integers values as keys in a #GHashTable.
+A wrapper for the stdio fopen() function. The fopen() function
+opens a file and associates a new stream with it.
+
+Because file descriptors are specific to the C library on Windows,
+and a file descriptor is partof the <type>FILE</type> struct, the
+<type>FILE</type> pointer returned by this function makes sense
+only to functions in the same C library. Thus if the GLib-using
+code uses a different C library than GLib does, the
+<type>FILE</type> pointer returned by this function cannot be
+passed to C library functions like fprintf() or fread().
+
+See your C library manual for more details about fopen().
+Since: 2.6
</description>
<parameters>
-<parameter name="v">
-<parameter_description> a pointer to a #gint key
+<parameter name="filename">
+<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows)
+</parameter_description>
+</parameter>
+<parameter name="mode">
+<parameter_description> a string describing the mode in which the file should be
+opened
</parameter_description>
</parameter>
</parameters>
-<return> a hash value corresponding to the key.
+<return> A <type>FILE</type> pointer if the file was successfully
+opened, or %NULL if an error occurred
+
</return>
</function>
-<function name="g_intern_static_string">
+<function name="g_format_size_for_display">
<description>
-Returns a canonical representation for @string. Interned strings can
-be compared for equality by comparing the pointers, instead of using strcmp().
-g_intern_static_string() does not copy the string, therefore @string must
-not be freed or modified.
+Formats a size (for example the size of a file) into a human readable string.
+Sizes are rounded to the nearest size prefix (KB, MB, GB) and are displayed
+rounded to the nearest tenth. E.g. the file size 3292528 bytes will be
+converted into the string "3.1 MB".
-Since: 2.10
+The prefix units base is 1024 (i.e. 1 KB is 1024 bytes).
+
+This string should be freed with g_free() when not needed any longer.
+
+Since: 2.16
</description>
<parameters>
-<parameter name="string">
-<parameter_description> a static string
+<parameter name="size">
+<parameter_description> a size in bytes.
</parameter_description>
</parameter>
</parameters>
-<return> a canonical representation for the string
+<return> a newly-allocated formatted string containing a human readable
+file size.
</return>
</function>
-<function name="g_intern_string">
+<function name="g_fprintf">
<description>
-Returns a canonical representation for @string. Interned strings can
-be compared for equality by comparing the pointers, instead of using strcmp().
+An implementation of the standard fprintf() function which supports
+positional parameters, as specified in the Single Unix Specification.
-Since: 2.10
+Since: 2.2
</description>
<parameters>
-<parameter name="string">
-<parameter_description> a string
+<parameter name="file">
+<parameter_description> the stream to write to.
+</parameter_description>
+</parameter>
+<parameter name="format">
+<parameter_description> a standard printf() format string, but notice
+<link linkend="string-precision">string precision pitfalls</link>.
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> the arguments to insert in the output.
</parameter_description>
</parameter>
</parameters>
-<return> a canonical representation for the string
+<return> the number of bytes printed.
</return>
</function>
-<function name="g_io_add_watch">
+<function name="g_free">
<description>
-Adds the #GIOChannel into the default main loop context
-with the default priority.
-
+Frees the memory pointed to by @mem.
+If @mem is %NULL it simply returns.
</description>
<parameters>
-<parameter name="channel">
-<parameter_description> a #GIOChannel
-</parameter_description>
-</parameter>
-<parameter name="condition">
-<parameter_description> the condition to watch for
-</parameter_description>
-</parameter>
-<parameter name="func">
-<parameter_description> the function to call when the condition is satisfied
-</parameter_description>
-</parameter>
-<parameter name="user_data">
-<parameter_description> user data to pass to @func
+<parameter name="mem">
+<parameter_description> the memory to free
</parameter_description>
</parameter>
</parameters>
-<return> the event source id
-</return>
+<return></return>
</function>
-<function name="g_io_add_watch_full">
+<function name="g_freopen">
<description>
-Adds the #GIOChannel into the default main loop context
-with the given priority.
+A wrapper for the POSIX freopen() function. The freopen() function
+opens a file and associates it with an existing stream.
-This internally creates a main loop source using g_io_create_watch()
-and attaches it to the main loop context with g_source_attach().
-You can do these steps manually if you need greater control.
+See your C library manual for more details about freopen().
+Since: 2.6
</description>
<parameters>
-<parameter name="channel">
-<parameter_description> a #GIOChannel
-</parameter_description>
-</parameter>
-<parameter name="priority">
-<parameter_description> the priority of the #GIOChannel source
-</parameter_description>
-</parameter>
-<parameter name="condition">
-<parameter_description> the condition to watch for
-</parameter_description>
-</parameter>
-<parameter name="func">
-<parameter_description> the function to call when the condition is satisfied
+<parameter name="filename">
+<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows)
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> user data to pass to @func
+<parameter name="mode">
+<parameter_description> a string describing the mode in which the file should be
+opened
</parameter_description>
</parameter>
-<parameter name="notify">
-<parameter_description> the function to call when the source is removed
+<parameter name="stream">
+<parameter_description> an existing stream which will be reused, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the event source id
+<return> A <type>FILE</type> pointer if the file was successfully
+opened, or %NULL if an error occurred.
+
</return>
</function>
-<function name="g_io_channel_close">
+<function name="g_get_application_name">
<description>
-Close an IO channel. Any pending data to be written will be
-flushed, ignoring errors. The channel will not be freed until the
-last reference is dropped using g_io_channel_unref().
+Gets a human-readable name for the application, as set by
+g_set_application_name(). This name should be localized if
+possible, and is intended for display to the user. Contrast with
+g_get_prgname(), which gets a non-localized name. If
+g_set_application_name() has not been called, returns the result of
+g_get_prgname() (which may be %NULL if g_set_prgname() has also not
+been called).
-Deprecated:2.2: Use g_io_channel_shutdown() instead.
+Since: 2.2
</description>
<parameters>
-<parameter name="channel">
-<parameter_description> A #GIOChannel
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> human-readable application name. may return %NULL
+
+</return>
</function>
-<function name="g_io_channel_error_from_errno">
+<function name="g_get_charset">
<description>
-Converts an <literal>errno</literal> error number to a #GIOChannelError.
+Obtains the character set for the <link linkend="setlocale">current
+locale</link>; you might use this character set as an argument to
+g_convert(), to convert from the current locale's encoding to some
+other encoding. (Frequently g_locale_to_utf8() and g_locale_from_utf8()
+are nice shortcuts, though.)
+
+On Windows the character set returned by this function is the
+so-called system default ANSI code-page. That is the character set
+used by the "narrow" versions of C library and Win32 functions that
+handle file names. It might be different from the character set
+used by the C library's current locale.
+
+The return value is %TRUE if the locale's encoding is UTF-8, in that
+case you can perhaps avoid calling g_convert().
+
+The string returned in @charset is not allocated, and should not be
+freed.
</description>
<parameters>
-<parameter name="en">
-<parameter_description> an <literal>errno</literal> error number, e.g. %EINVAL
+<parameter name="charset">
+<parameter_description> return location for character set name
</parameter_description>
</parameter>
</parameters>
-<return> a #GIOChannelError error number, e.g.
-%G_IO_CHANNEL_ERROR_INVAL.
+<return> %TRUE if the returned charset is UTF-8
</return>
</function>
-<function name="g_io_channel_error_quark">
+<function name="g_get_codeset">
<description>
+Get the codeset for the current locale.
+
</description>
<parameters>
</parameters>
-<return> the quark used as %G_IO_CHANNEL_ERROR
+<return> a newly allocated string containing the name
+of the codeset. This string must be freed with g_free().
</return>
</function>
-<function name="g_io_channel_flush">
+<function name="g_get_current_dir">
<description>
-Flushes the write buffer for the GIOChannel.
+Gets the current directory.
+The returned string should be freed when no longer needed. The encoding
+of the returned string is system defined. On Windows, it is always UTF-8.
</description>
<parameters>
-<parameter name="channel">
-<parameter_description> a #GIOChannel
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> location to store an error of type #GIOChannelError
-</parameter_description>
-</parameter>
</parameters>
-<return> the status of the operation: One of
-#G_IO_STATUS_NORMAL, #G_IO_STATUS_AGAIN, or
-#G_IO_STATUS_ERROR.
+<return> the current directory.
</return>
</function>
-<function name="g_io_channel_get_buffer_condition">
+<function name="g_get_current_time">
<description>
-This function returns a #GIOCondition depending on whether there
-is data to be read/space to write data in the internal buffers in
-the #GIOChannel. Only the flags %G_IO_IN and %G_IO_OUT may be set.
+Equivalent to the UNIX gettimeofday() function, but portable.
+You may find g_get_real_time() to be more convenient.
</description>
<parameters>
-<parameter name="channel">
-<parameter_description> A #GIOChannel
+<parameter name="result">
+<parameter_description> #GTimeVal structure in which to store current time.
</parameter_description>
</parameter>
</parameters>
-<return> A #GIOCondition
-</return>
+<return></return>
</function>
-<function name="g_io_channel_get_buffer_size">
+<function name="g_get_environ">
<description>
-Gets the buffer size.
+Gets the list of environment variables for the current process. The
+list is %NULL terminated and each item in the list is of the form
+'NAME=VALUE'.
+
+This is equivalent to direct access to the 'environ' global variable,
+except portable.
+
+The return value is freshly allocated and it should be freed with
+g_strfreev() when it is no longer needed.
+Since: 2.28
</description>
<parameters>
-<parameter name="channel">
-<parameter_description> a #GIOChannel
-</parameter_description>
-</parameter>
</parameters>
-<return> the size of the buffer.
+<return> the list of environment variables
+
</return>
</function>
-<function name="g_io_channel_get_buffered">
+<function name="g_get_filename_charsets">
<description>
-Returns whether @channel is buffered.
+Determines the preferred character sets used for filenames.
+The first character set from the @charsets is the filename encoding, the
+subsequent character sets are used when trying to generate a displayable
+representation of a filename, see g_filename_display_name().
+
+On Unix, the character sets are determined by consulting the
+environment variables <envar>G_FILENAME_ENCODING</envar> and
+<envar>G_BROKEN_FILENAMES</envar>. On Windows, the character set
+used in the GLib API is always UTF-8 and said environment variables
+have no effect.
+
+<envar>G_FILENAME_ENCODING</envar> may be set to a comma-separated list
+of character set names. The special token "@locale" is taken to
+mean the character set for the <link linkend="setlocale">current
+locale</link>. If <envar>G_FILENAME_ENCODING</envar> is not set, but
+<envar>G_BROKEN_FILENAMES</envar> is, the character set of the current
+locale is taken as the filename encoding. If neither environment variable
+is set, UTF-8 is taken as the filename encoding, but the character
+set of the current locale is also put in the list of encodings.
+
+The returned @charsets belong to GLib and must not be freed.
+
+Note that on Unix, regardless of the locale character set or
+<envar>G_FILENAME_ENCODING</envar> value, the actual file names present
+on a system might be in any random encoding or just gibberish.
+Since: 2.6
</description>
<parameters>
-<parameter name="channel">
-<parameter_description> a #GIOChannel
+<parameter name="charsets">
+<parameter_description> return location for the %NULL-terminated list of encoding names
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the @channel is buffered.
+<return> %TRUE if the filename encoding is UTF-8.
+
</return>
</function>
-<function name="g_io_channel_get_close_on_unref">
+<function name="g_get_home_dir">
<description>
-Returns whether the file/socket/whatever associated with @channel
-will be closed when @channel receives its final unref and is
-destroyed. The default value of this is %TRUE for channels created
-by g_io_channel_new_file (), and %FALSE for all other channels.
+Gets the current user's home directory as defined in the
+password database.
+
+Note that in contrast to traditional UNIX tools, this function
+prefers <filename>passwd</filename> entries over the <envar>HOME</envar>
+environment variable.
+
+One of the reasons for this decision is that applications in many
+cases need special handling to deal with the case where
+<envar>HOME</envar> is
+<simplelist>
+<member>Not owned by the user</member>
+<member>Not writeable</member>
+<member>Not even readable</member>
+</simplelist>
+Since applications are in general <emphasis>not</emphasis> written
+to deal with these situations it was considered better to make
+g_get_home_dir() not pay attention to <envar>HOME</envar> and to
+return the real home directory for the user. If applications
+want to pay attention to <envar>HOME</envar>, they can do:
+|[
+const char *homedir = g_getenv ("HOME");
+if (!homedir)
+homedir = g_get_home_dir (<!-- -->);
+]|
</description>
<parameters>
-<parameter name="channel">
-<parameter_description> a #GIOChannel.
-</parameter_description>
-</parameter>
</parameters>
-<return> Whether the channel will be closed on the final unref of
-the GIOChannel data structure.
+<return> the current user's home directory
</return>
</function>
-<function name="g_io_channel_get_encoding">
+<function name="g_get_host_name">
<description>
-Gets the encoding for the input/output of the channel.
-The internal encoding is always UTF-8. The encoding %NULL
-makes the channel safe for binary data.
+Return a name for the machine.
+
+The returned name is not necessarily a fully-qualified domain name,
+or even present in DNS or some other name service at all. It need
+not even be unique on your local network or site, but usually it
+is. Callers should not rely on the return value having any specific
+properties like uniqueness for security purposes. Even if the name
+of the machine is changed while an application is running, the
+return value from this function does not change. The returned
+string is owned by GLib and should not be modified or freed. If no
+name can be determined, a default fixed string "localhost" is
+returned.
+Since: 2.8
</description>
<parameters>
-<parameter name="channel">
-<parameter_description> a #GIOChannel
-</parameter_description>
-</parameter>
</parameters>
-<return> A string containing the encoding, this string is
-owned by GLib and must not be freed.
+<return> the host name of the machine.
+
</return>
</function>
-<function name="g_io_channel_get_flags">
+<function name="g_get_language_names">
<description>
-Gets the current flags for a #GIOChannel, including read-only
-flags such as %G_IO_FLAG_IS_READABLE.
+Computes a list of applicable locale names, which can be used to
+e.g. construct locale-dependent filenames or search paths. The returned
+list is sorted from most desirable to least desirable and always contains
+the default locale "C".
-The values of the flags %G_IO_FLAG_IS_READABLE and %G_IO_FLAG_IS_WRITEABLE
-are cached for internal use by the channel when it is created.
-If they should change at some later point (e.g. partial shutdown
-of a socket with the UNIX shutdown() function), the user
-should immediately call g_io_channel_get_flags() to update
-the internal values of these flags.
+For example, if LANGUAGE=de:en_US, then the returned list is
+"de", "en_US", "en", "C".
+
+This function consults the environment variables <envar>LANGUAGE</envar>,
+<envar>LC_ALL</envar>, <envar>LC_MESSAGES</envar> and <envar>LANG</envar>
+to find the list of locales specified by the user.
+Since: 2.6
</description>
<parameters>
-<parameter name="channel">
-<parameter_description> a #GIOChannel
-</parameter_description>
-</parameter>
</parameters>
-<return> the flags which are set on the channel
+<return> a %NULL-terminated array of strings owned by GLib
+that must not be modified or freed.
+
</return>
</function>
-<function name="g_io_channel_get_line_term">
+<function name="g_get_locale_variants">
<description>
-This returns the string that #GIOChannel uses to determine
-where in the file a line break occurs. A value of %NULL
-indicates autodetection.
+Returns a list of derived variants of @locale, which can be used to
+e.g. construct locale-dependent filenames or search paths. The returned
+list is sorted from most desirable to least desirable.
+This function handles territory, charset and extra locale modifiers.
+
+For example, if @locale is "fr_BE", then the returned list
+is "fr_BE", "fr".
+
+If you need the list of variants for the <emphasis>current locale</emphasis>,
+use g_get_language_names().
+Since: 2.28
</description>
<parameters>
-<parameter name="channel">
-<parameter_description> a #GIOChannel
-</parameter_description>
-</parameter>
-<parameter name="length">
-<parameter_description> a location to return the length of the line terminator
+<parameter name="locale">
+<parameter_description> a locale identifier
</parameter_description>
</parameter>
</parameters>
-<return> The line termination string. This value
-is owned by GLib and must not be freed.
+<return> a newly
+allocated array of newly allocated strings with the locale variants. Free with
+g_strfreev().
+
</return>
</function>
-<function name="g_io_channel_init">
+<function name="g_get_monotonic_time">
<description>
-Initializes a #GIOChannel struct.
+Queries the system monotonic time, if available.
-This is called by each of the above functions when creating a
-#GIOChannel, and so is not often needed by the application
-programmer (unless you are creating a new type of #GIOChannel).
+On POSIX systems with clock_gettime() and %CLOCK_MONOTONIC this call
+is a very shallow wrapper for that. Otherwise, we make a best effort
+that probably involves returning the wall clock time (with at least
+microsecond accuracy, subject to the limitations of the OS kernel).
+
+Note that, on Windows, "limitations of the OS kernel" is a rather
+substantial statement. Depending on the configuration of the system,
+the wall clock time is updated as infrequently as 64 times a second
+(which is approximately every 16ms).
+
+Since: 2.28
</description>
<parameters>
-<parameter name="channel">
-<parameter_description> a #GIOChannel
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> the monotonic time, in microseconds
+
+</return>
</function>
-<function name="g_io_channel_new_file">
+<function name="g_get_prgname">
<description>
-Open a file @filename as a #GIOChannel using mode @mode. This
-channel will be closed when the last reference to it is dropped,
-so there is no need to call g_io_channel_close() (though doing
-so will not cause problems, as long as no attempt is made to
-access the channel after it is closed).
+Gets the name of the program. This name should <emphasis>not</emphasis>
+be localized, contrast with g_get_application_name().
+(If you are using GDK or GTK+ the program name is set in gdk_init(),
+which is called by gtk_init(). The program name is found by taking
+the last component of <literal>argv[0]</literal>.)
</description>
<parameters>
-<parameter name="filename">
-<parameter_description> A string containing the name of a file
-</parameter_description>
-</parameter>
-<parameter name="mode">
-<parameter_description> One of "r", "w", "a", "r+", "w+", "a+". These have
-the same meaning as in fopen()
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> A location to return an error of type %G_FILE_ERROR
-</parameter_description>
-</parameter>
</parameters>
-<return> A #GIOChannel on success, %NULL on failure.
+<return> the name of the program. The returned string belongs
+to GLib and must not be modified or freed.
</return>
</function>
-<function name="g_io_channel_read">
+<function name="g_get_real_name">
<description>
-Reads data from a #GIOChannel.
+Gets the real name of the user. This usually comes from the user's entry
+in the <filename>passwd</filename> file. The encoding of the returned
+string is system-defined. (On Windows, it is, however, always UTF-8.)
+If the real user name cannot be determined, the string "Unknown" is
+returned.
-Deprecated:2.2: Use g_io_channel_read_chars() instead.
</description>
<parameters>
-<parameter name="channel">
-<parameter_description> a #GIOChannel
-</parameter_description>
-</parameter>
-<parameter name="buf">
-<parameter_description> a buffer to read the data into (which should be at least
-count bytes long)
-</parameter_description>
-</parameter>
-<parameter name="count">
-<parameter_description> the number of bytes to read from the #GIOChannel
-</parameter_description>
-</parameter>
-<parameter name="bytes_read">
-<parameter_description> returns the number of bytes actually read
-</parameter_description>
-</parameter>
</parameters>
-<return> %G_IO_ERROR_NONE if the operation was successful.
-
+<return> the user's real name.
</return>
</function>
-<function name="g_io_channel_read_chars">
+<function name="g_get_real_time">
<description>
-Replacement for g_io_channel_read() with the new API.
+Queries the system wall-clock time.
+
+This call is functionally equivalent to g_get_current_time() except
+that the return value is often more convenient than dealing with a
+#GTimeVal.
+
+You should only use this call if you are actually interested in the real
+wall-clock time. g_get_monotonic_time() is probably more useful for
+measuring intervals.
+Since: 2.28
</description>
<parameters>
-<parameter name="channel">
-<parameter_description> a #GIOChannel
-</parameter_description>
-</parameter>
-<parameter name="buf">
-<parameter_description> a buffer to read data into
-</parameter_description>
-</parameter>
-<parameter name="count">
-<parameter_description> the size of the buffer. Note that the buffer may not be
-complelely filled even if there is data in the buffer if the
-remaining data is not a complete character.
-</parameter_description>
-</parameter>
-<parameter name="bytes_read">
-<parameter_description> The number of bytes read. This may be
-zero even on success if count < 6 and the channel's encoding
-is non-%NULL. This indicates that the next UTF-8 character is
-too wide for the buffer.
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> a location to return an error of type #GConvertError
-or #GIOChannelError.
-</parameter_description>
-</parameter>
</parameters>
-<return> the status of the operation.
+<return> the number of microseconds since January 1, 1970 UTC.
+
</return>
</function>
-<function name="g_io_channel_read_line">
+<function name="g_get_system_config_dirs">
<description>
-Reads a line, including the terminating character(s),
-from a #GIOChannel into a newly-allocated string.
- str_return will contain allocated memory if the return
-is %G_IO_STATUS_NORMAL.
+Returns an ordered list of base directories in which to access
+system-wide configuration information.
+
+On UNIX platforms this is determined using the mechanisms described in
+the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
+XDG Base Directory Specification</ulink>.
+In this case the list of directories retrieved will be XDG_CONFIG_DIRS.
+
+On Windows is the directory that contains application data for all users.
+A typical path is C:\Documents and Settings\All Users\Application Data.
+This folder is used for application data that is not user specific.
+For example, an application can store a spell-check dictionary, a database
+of clip art, or a log file in the CSIDL_COMMON_APPDATA folder.
+This information will not roam and is available to anyone using the computer.
+Since: 2.6
</description>
<parameters>
-<parameter name="channel">
-<parameter_description> a #GIOChannel
-</parameter_description>
-</parameter>
-<parameter name="str_return">
-<parameter_description> The line read from the #GIOChannel, including the
-line terminator. This data should be freed with g_free()
-when no longer needed. This is a nul-terminated string.
-If a @length of zero is returned, this will be %NULL instead.
-</parameter_description>
-</parameter>
-<parameter name="length">
-<parameter_description> location to store length of the read data, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="terminator_pos">
-<parameter_description> location to store position of line terminator, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> A location to return an error of type #GConvertError
-or #GIOChannelError
-</parameter_description>
-</parameter>
</parameters>
-<return> the status of the operation.
+<return> a %NULL-terminated array of strings owned by GLib that must
+not be modified or freed.
</return>
</function>
-<function name="g_io_channel_read_line_string">
+<function name="g_get_system_data_dirs">
<description>
-Reads a line from a #GIOChannel, using a #GString as a buffer.
+Returns an ordered list of base directories in which to access
+system-wide application data.
+
+On UNIX platforms this is determined using the mechanisms described in
+the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
+XDG Base Directory Specification</ulink>
+In this case the list of directories retrieved will be XDG_DATA_DIRS.
+
+On Windows the first elements in the list are the Application Data
+and Documents folders for All Users. (These can be determined only
+on Windows 2000 or later and are not present in the list on other
+Windows versions.) See documentation for CSIDL_COMMON_APPDATA and
+CSIDL_COMMON_DOCUMENTS.
+
+Then follows the "share" subfolder in the installation folder for
+the package containing the DLL that calls this function, if it can
+be determined.
+
+Finally the list contains the "share" subfolder in the installation
+folder for GLib, and in the installation folder for the package the
+application's .exe file belongs to.
+
+The installation folders above are determined by looking up the
+folder where the module (DLL or EXE) in question is located. If the
+folder's name is "bin", its parent is used, otherwise the folder
+itself.
+
+Note that on Windows the returned list can vary depending on where
+this function is called.
+Since: 2.6
</description>
<parameters>
-<parameter name="channel">
-<parameter_description> a #GIOChannel
-</parameter_description>
-</parameter>
-<parameter name="buffer">
-<parameter_description> a #GString into which the line will be written.
-If @buffer already contains data, the old data will
-be overwritten.
-</parameter_description>
-</parameter>
-<parameter name="terminator_pos">
-<parameter_description> location to store position of line terminator, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> a location to store an error of type #GConvertError
-or #GIOChannelError
-</parameter_description>
-</parameter>
</parameters>
-<return> the status of the operation.
+<return> a %NULL-terminated array of strings owned by GLib that must
+not be modified or freed.
</return>
</function>
-<function name="g_io_channel_read_to_end">
+<function name="g_get_tmp_dir">
<description>
-Reads all the remaining data from the file.
+Gets the directory to use for temporary files. This is found from
+inspecting the environment variables <envar>TMPDIR</envar>,
+<envar>TMP</envar>, and <envar>TEMP</envar> in that order. If none
+of those are defined "/tmp" is returned on UNIX and "C:\" on Windows.
+The encoding of the returned string is system-defined. On Windows,
+it is always UTF-8. The return value is never %NULL or the empty string.
</description>
<parameters>
-<parameter name="channel">
-<parameter_description> a #GIOChannel
-</parameter_description>
-</parameter>
-<parameter name="str_return">
-<parameter_description> Location to store a pointer to a string holding
-the remaining data in the #GIOChannel. This data should
-be freed with g_free() when no longer needed. This
-data is terminated by an extra nul character, but there
-may be other nuls in the intervening data.
-</parameter_description>
-</parameter>
-<parameter name="length">
-<parameter_description> location to store length of the data
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> location to return an error of type #GConvertError
-or #GIOChannelError
-</parameter_description>
-</parameter>
</parameters>
-<return> %G_IO_STATUS_NORMAL on success.
-This function never returns %G_IO_STATUS_EOF.
+<return> the directory to use for temporary files.
</return>
</function>
-<function name="g_io_channel_read_unichar">
+<function name="g_get_user_cache_dir">
<description>
-Reads a Unicode character from @channel.
-This function cannot be called on a channel with %NULL encoding.
+Returns a base directory in which to store non-essential, cached
+data specific to particular user.
+
+On UNIX platforms this is determined using the mechanisms described in
+the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
+XDG Base Directory Specification</ulink>.
+In this case the directory retrieved will be XDG_CACHE_HOME.
+On Windows is the directory that serves as a common repository for
+temporary Internet files. A typical path is
+C:\Documents and Settings\username\Local Settings\Temporary Internet Files.
+See documentation for CSIDL_INTERNET_CACHE.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="channel">
-<parameter_description> a #GIOChannel
-</parameter_description>
-</parameter>
-<parameter name="thechar">
-<parameter_description> a location to return a character
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> a location to return an error of type #GConvertError
-or #GIOChannelError
-</parameter_description>
-</parameter>
</parameters>
-<return> a #GIOStatus
+<return> a string owned by GLib that must not be modified
+or freed.
</return>
</function>
-<function name="g_io_channel_ref">
+<function name="g_get_user_config_dir">
<description>
-Increments the reference count of a #GIOChannel.
+Returns a base directory in which to store user-specific application
+configuration information such as user preferences and settings.
+
+On UNIX platforms this is determined using the mechanisms described in
+the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
+XDG Base Directory Specification</ulink>.
+In this case the directory retrieved will be XDG_CONFIG_HOME.
+On Windows this is the folder to use for local (as opposed to
+roaming) application data. See documentation for
+CSIDL_LOCAL_APPDATA. Note that on Windows it thus is the same as
+what g_get_user_data_dir() returns.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="channel">
-<parameter_description> a #GIOChannel
-</parameter_description>
-</parameter>
</parameters>
-<return> the @channel that was passed in (since 2.6)
+<return> a string owned by GLib that must not be modified
+or freed.
</return>
</function>
-<function name="g_io_channel_seek">
+<function name="g_get_user_data_dir">
<description>
-Sets the current position in the #GIOChannel, similar to the standard
-library function fseek().
+Returns a base directory in which to access application data such
+as icons that is customized for a particular user.
-Deprecated:2.2: Use g_io_channel_seek_position() instead.
+On UNIX platforms this is determined using the mechanisms described in
+the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
+XDG Base Directory Specification</ulink>.
+In this case the directory retrieved will be XDG_DATA_HOME.
+
+On Windows this is the folder to use for local (as opposed to
+roaming) application data. See documentation for
+CSIDL_LOCAL_APPDATA. Note that on Windows it thus is the same as
+what g_get_user_config_dir() returns.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="channel">
-<parameter_description> a #GIOChannel
-</parameter_description>
-</parameter>
-<parameter name="offset">
-<parameter_description> an offset, in bytes, which is added to the position specified
-by @type
-</parameter_description>
-</parameter>
-<parameter name="type">
-<parameter_description> the position in the file, which can be %G_SEEK_CUR (the current
-position), %G_SEEK_SET (the start of the file), or %G_SEEK_END
-(the end of the file)
-</parameter_description>
-</parameter>
</parameters>
-<return> %G_IO_ERROR_NONE if the operation was successful.
-
+<return> a string owned by GLib that must not be modified
+or freed.
</return>
</function>
-<function name="g_io_channel_seek_position">
+<function name="g_get_user_name">
<description>
-Replacement for g_io_channel_seek() with the new API.
+Gets the user name of the current user. The encoding of the returned
+string is system-defined. On UNIX, it might be the preferred file name
+encoding, or something else, and there is no guarantee that it is even
+consistent on a machine. On Windows, it is always UTF-8.
</description>
<parameters>
-<parameter name="channel">
-<parameter_description> a #GIOChannel
-</parameter_description>
-</parameter>
-<parameter name="offset">
-<parameter_description> The offset in bytes from the position specified by @type
-</parameter_description>
-</parameter>
-<parameter name="type">
-<parameter_description> a #GSeekType. The type %G_SEEK_CUR is only allowed in those
-cases where a call to g_io_channel_set_encoding ()
-is allowed. See the documentation for
-g_io_channel_set_encoding () for details.
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> A location to return an error of type #GIOChannelError
-</parameter_description>
-</parameter>
</parameters>
-<return> the status of the operation.
+<return> the user name of the current user.
</return>
</function>
-<function name="g_io_channel_set_buffer_size">
+<function name="g_get_user_runtime_dir">
<description>
-Sets the buffer size.
+Returns a directory that is unique to the current user on the local
+system.
+
+On UNIX platforms this is determined using the mechanisms described in
+the <ulink url="http://www.freedesktop.org/Standards/basedir-spec">
+XDG Base Directory Specification</ulink>. This is the directory
+specified in the <envar>XDG_RUNTIME_DIR</envar> environment variable.
+In the case that this variable is not set, GLib will issue a warning
+message to stderr and return the value of g_get_user_cache_dir().
+
+On Windows this is the folder to use for local (as opposed to
+roaming) application data. See documentation for
+CSIDL_LOCAL_APPDATA. Note that on Windows it thus is the same as
+what g_get_user_config_dir() returns.
+
+Since: 2.28
</description>
<parameters>
-<parameter name="channel">
-<parameter_description> a #GIOChannel
-</parameter_description>
-</parameter>
-<parameter name="size">
-<parameter_description> the size of the buffer, or 0 to let GLib pick a good size
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> a string owned by GLib that must not be modified or freed.
+
+</return>
</function>
-<function name="g_io_channel_set_buffered">
+<function name="g_get_user_special_dir">
<description>
-The buffering state can only be set if the channel's encoding
-is %NULL. For any other encoding, the channel must be buffered.
+Returns the full path of a special directory using its logical id.
-A buffered channel can only be set unbuffered if the channel's
-internal buffers have been flushed. Newly created channels or
-channels which have returned %G_IO_STATUS_EOF
-not require such a flush. For write-only channels, a call to
-g_io_channel_flush () is sufficient. For all other channels,
-the buffers may be flushed by a call to g_io_channel_seek_position ().
-This includes the possibility of seeking with seek type %G_SEEK_CUR
-and an offset of zero. Note that this means that socket-based
-channels cannot be set unbuffered once they have had data
-read from them.
+On Unix this is done using the XDG special user directories.
+For compatibility with existing practise, %G_USER_DIRECTORY_DESKTOP
+falls back to <filename>$HOME/Desktop</filename> when XDG special
+user directories have not been set up.
-On unbuffered channels, it is safe to mix read and write
-calls from the new and old APIs, if this is necessary for
-maintaining old code.
+Depending on the platform, the user might be able to change the path
+of the special directory without requiring the session to restart; GLib
+will not reflect any change once the special directories are loaded.
-The default state of the channel is buffered.
+Since: 2.14
</description>
<parameters>
-<parameter name="channel">
-<parameter_description> a #GIOChannel
-</parameter_description>
-</parameter>
-<parameter name="buffered">
-<parameter_description> whether to set the channel buffered or unbuffered
+<parameter name="directory">
+<parameter_description> the logical id of special directory
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the path to the specified special directory, or %NULL
+if the logical id was not found. The returned string is owned by
+GLib and should not be modified or freed.
+
+</return>
</function>
-<function name="g_io_channel_set_close_on_unref">
+<function name="g_getenv">
<description>
-Setting this flag to %TRUE for a channel you have already closed
-can cause problems.
+Returns the value of an environment variable. The name and value
+are in the GLib file name encoding. On UNIX, this means the actual
+bytes which might or might not be in some consistent character set
+and encoding. On Windows, it is in UTF-8. On Windows, in case the
+environment variable's value contains references to other
+environment variables, they are expanded.
+
</description>
<parameters>
-<parameter name="channel">
-<parameter_description> a #GIOChannel
-</parameter_description>
-</parameter>
-<parameter name="do_close">
-<parameter_description> Whether to close the channel on the final unref of
-the GIOChannel data structure. The default value of
-this is %TRUE for channels created by g_io_channel_new_file (),
-and %FALSE for all other channels.
+<parameter name="variable">
+<parameter_description> the environment variable to get, in the GLib file name encoding.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the value of the environment variable, or %NULL if
+the environment variable is not found. The returned string may be
+overwritten by the next call to g_getenv(), g_setenv() or
+g_unsetenv().
+</return>
</function>
-<function name="g_io_channel_set_encoding">
+<function name="g_hash_table_destroy">
<description>
-Sets the encoding for the input/output of the channel.
-The internal encoding is always UTF-8. The default encoding
-for the external file is UTF-8.
-
-The encoding %NULL is safe to use with binary data.
-
-The encoding can only be set if one of the following conditions
-is true:
-<itemizedlist>
-<listitem><para>
-The channel was just created, and has not been written to or read
-from yet.
-</para></listitem>
-<listitem><para>
-The channel is write-only.
-</para></listitem>
-<listitem><para>
-The channel is a file, and the file pointer was just
-repositioned by a call to g_io_channel_seek_position().
-(This flushes all the internal buffers.)
-</para></listitem>
-<listitem><para>
-The current encoding is %NULL or UTF-8.
-</para></listitem>
-<listitem><para>
-One of the (new API) read functions has just returned %G_IO_STATUS_EOF
-(or, in the case of g_io_channel_read_to_end(), %G_IO_STATUS_NORMAL).
-</para></listitem>
-<listitem><para>
-One of the functions g_io_channel_read_chars() or
-g_io_channel_read_unichar() has returned %G_IO_STATUS_AGAIN or
-%G_IO_STATUS_ERROR. This may be useful in the case of
-%G_CONVERT_ERROR_ILLEGAL_SEQUENCE.
-Returning one of these statuses from g_io_channel_read_line(),
-g_io_channel_read_line_string(), or g_io_channel_read_to_end()
-does <emphasis>not</emphasis> guarantee that the encoding can
-be changed.
-</para></listitem>
-</itemizedlist>
-Channels which do not meet one of the above conditions cannot call
-g_io_channel_seek_position() with an offset of %G_SEEK_CUR, and, if
-they are "seekable", cannot call g_io_channel_write_chars() after
-calling one of the API "read" functions.
-
+Destroys all keys and values in the #GHashTable and decrements its
+reference count by 1. If keys and/or values are dynamically allocated,
+you should either free them first or create the #GHashTable with destroy
+notifiers using g_hash_table_new_full(). In the latter case the destroy
+functions you supplied will be called on all keys and values during the
+destruction phase.
</description>
<parameters>
-<parameter name="channel">
-<parameter_description> a #GIOChannel
-</parameter_description>
-</parameter>
-<parameter name="encoding">
-<parameter_description> the encoding type
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> location to store an error of type #GConvertError
+<parameter name="hash_table">
+<parameter_description> a #GHashTable.
</parameter_description>
</parameter>
</parameters>
-<return> %G_IO_STATUS_NORMAL if the encoding was successfully set.
-</return>
+<return></return>
</function>
-<function name="g_io_channel_set_flags">
+<function name="g_hash_table_find">
<description>
-Sets the (writeable) flags in @channel to (@flags & %G_IO_CHANNEL_SET_MASK).
+Calls the given function for key/value pairs in the #GHashTable until
+ predicate returns %TRUE. The function is passed the key and value of
+each pair, and the given @user_data parameter. The hash table may not
+be modified while iterating over it (you can't add/remove items).
+
+Note, that hash tables are really only optimized for forward lookups,
+i.e. g_hash_table_lookup().
+So code that frequently issues g_hash_table_find() or
+g_hash_table_foreach() (e.g. in the order of once per every entry in a
+hash table) should probably be reworked to use additional or different
+data structures for reverse lookups (keep in mind that an O(n) find/foreach
+operation issued for all n values in a hash table ends up needing O(n*n)
+operations).
+Since: 2.4
</description>
<parameters>
-<parameter name="channel">
-<parameter_description> a #GIOChannel
+<parameter name="hash_table">
+<parameter_description> a #GHashTable.
</parameter_description>
</parameter>
-<parameter name="flags">
-<parameter_description> the flags to set on the IO channel
+<parameter name="predicate">
+<parameter_description> function to test the key/value pairs for a certain property.
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> A location to return an error of type #GIOChannelError
+<parameter name="user_data">
+<parameter_description> user data to pass to the function.
</parameter_description>
</parameter>
</parameters>
-<return> the status of the operation.
+<return> The value of the first key/value pair is returned,
+for which @predicate evaluates to %TRUE. If no pair with the
+requested property is found, %NULL is returned.
+
</return>
</function>
-<function name="g_io_channel_set_line_term">
+<function name="g_hash_table_foreach">
<description>
-This sets the string that #GIOChannel uses to determine
-where in the file a line break occurs.
+Calls the given function for each of the key/value pairs in the
+#GHashTable. The function is passed the key and value of each
+pair, and the given @user_data parameter. The hash table may not
+be modified while iterating over it (you can't add/remove
+items). To remove all items matching a predicate, use
+g_hash_table_foreach_remove().
+
+See g_hash_table_find() for performance caveats for linear
+order searches in contrast to g_hash_table_lookup().
</description>
<parameters>
-<parameter name="channel">
-<parameter_description> a #GIOChannel
+<parameter name="hash_table">
+<parameter_description> a #GHashTable.
</parameter_description>
</parameter>
-<parameter name="line_term">
-<parameter_description> The line termination string. Use %NULL for autodetect.
-Autodetection breaks on "\n", "\r\n", "\r", "\0", and
-the Unicode paragraph separator. Autodetection should
-not be used for anything other than file-based channels.
+<parameter name="func">
+<parameter_description> the function to call for each key/value pair.
</parameter_description>
</parameter>
-<parameter name="length">
-<parameter_description> The length of the termination string. If -1 is passed, the
-string is assumed to be nul-terminated. This option allows
-termination strings with embedded nuls.
+<parameter name="user_data">
+<parameter_description> user data to pass to the function.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_io_channel_shutdown">
+<function name="g_hash_table_foreach_remove">
<description>
-Close an IO channel. Any pending data to be written will be
-flushed if @flush is %TRUE. The channel will not be freed until the
-last reference is dropped using g_io_channel_unref().
+Calls the given function for each key/value pair in the #GHashTable.
+If the function returns %TRUE, then the key/value pair is removed from the
+#GHashTable. If you supplied key or value destroy functions when creating
+the #GHashTable, they are used to free the memory allocated for the removed
+keys and values.
+
+See #GHashTableIter for an alternative way to loop over the
+key/value pairs in the hash table.
</description>
<parameters>
-<parameter name="channel">
-<parameter_description> a #GIOChannel
+<parameter name="hash_table">
+<parameter_description> a #GHashTable.
</parameter_description>
</parameter>
-<parameter name="flush">
-<parameter_description> if %TRUE, flush pending
+<parameter name="func">
+<parameter_description> the function to call for each key/value pair.
</parameter_description>
</parameter>
-<parameter name="err">
-<parameter_description> location to store a #GIOChannelError
+<parameter name="user_data">
+<parameter_description> user data to pass to the function.
</parameter_description>
</parameter>
</parameters>
-<return> the status of the operation.
+<return> the number of key/value pairs removed.
</return>
</function>
-<function name="g_io_channel_unix_get_fd">
+<function name="g_hash_table_foreach_steal">
<description>
-Returns the file descriptor of the #GIOChannel.
+Calls the given function for each key/value pair in the #GHashTable.
+If the function returns %TRUE, then the key/value pair is removed from the
+#GHashTable, but no key or value destroy functions are called.
+
+See #GHashTableIter for an alternative way to loop over the
+key/value pairs in the hash table.
-On Windows this function returns the file descriptor or socket of
-the #GIOChannel.
</description>
<parameters>
-<parameter name="channel">
-<parameter_description> a #GIOChannel, created with g_io_channel_unix_new().
+<parameter name="hash_table">
+<parameter_description> a #GHashTable.
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> the function to call for each key/value pair.
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> user data to pass to the function.
</parameter_description>
</parameter>
</parameters>
-<return> the file descriptor of the #GIOChannel.
+<return> the number of key/value pairs removed.
</return>
</function>
-<function name="g_io_channel_unix_new">
+<function name="g_hash_table_get_keys">
<description>
-Creates a new #GIOChannel given a file descriptor. On UNIX systems
-this works for plain files, pipes, and sockets.
-
-The returned #GIOChannel has a reference count of 1.
-
-The default encoding for #GIOChannel is UTF-8. If your application
-is reading output from a command using via pipe, you may need to set
-the encoding to the encoding of the current locale (see
-g_get_charset()) with the g_io_channel_set_encoding() function.
-
-If you want to read raw binary data without interpretation, then
-call the g_io_channel_set_encoding() function with %NULL for the
-encoding argument.
+Retrieves every key inside @hash_table. The returned data is valid
+until @hash_table is modified.
-This function is available in GLib on Windows, too, but you should
-avoid using it on Windows. The domain of file descriptors and
-sockets overlap. There is no way for GLib to know which one you mean
-in case the argument you pass to this function happens to be both a
-valid file descriptor and socket. If that happens a warning is
-issued, and GLib assumes that it is the file descriptor you mean.
+Since: 2.14
</description>
<parameters>
-<parameter name="fd">
-<parameter_description> a file descriptor.
+<parameter name="hash_table">
+<parameter_description> a #GHashTable
</parameter_description>
</parameter>
</parameters>
-<return> a new #GIOChannel.
+<return> a #GList containing all the keys inside the hash
+table. The content of the list is owned by the hash table and
+should not be modified or freed. Use g_list_free() when done
+using the list.
+
</return>
</function>
-<function name="g_io_channel_unref">
+<function name="g_hash_table_get_values">
<description>
-Decrements the reference count of a #GIOChannel.
+Retrieves every value inside @hash_table. The returned data is
+valid until @hash_table is modified.
+
+Since: 2.14
</description>
<parameters>
-<parameter name="channel">
-<parameter_description> a #GIOChannel
+<parameter name="hash_table">
+<parameter_description> a #GHashTable
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a #GList containing all the values inside the hash
+table. The content of the list is owned by the hash table and
+should not be modified or freed. Use g_list_free() when done
+using the list.
+
+</return>
</function>
-<function name="g_io_channel_win32_new_fd">
+<function name="g_hash_table_insert">
<description>
-Creates a new #GIOChannel given a file descriptor on Windows. This
-works for file descriptors from the C runtime.
-
-This function works for file descriptors as returned by the open(),
-creat(), pipe() and fileno() calls in the Microsoft C runtime. In
-order to meaningfully use this function your code should use the
-same C runtime as GLib uses, which is msvcrt.dll. Note that in
-current Microsoft compilers it is near impossible to convince it to
-build code that would use msvcrt.dll. The last Microsoft compiler
-version that supported using msvcrt.dll as the C runtime was version
-6. The GNU compiler and toolchain for Windows, also known as Mingw,
-fully supports msvcrt.dll.
-
-If you have created a #GIOChannel for a file descriptor and started
-watching (polling) it, you shouldn't call read() on the file
-descriptor. This is because adding polling for a file descriptor is
-implemented in GLib on Windows by starting a thread that sits
-blocked in a read() from the file descriptor most of the time. All
-reads from the file descriptor should be done by this internal GLib
-thread. Your code should call only g_io_channel_read().
+Inserts a new key and value into a #GHashTable.
-This function is available only in GLib on Windows.
+If the key already exists in the #GHashTable its current value is replaced
+with the new value. If you supplied a @value_destroy_func when creating the
+#GHashTable, the old value is freed using that function. If you supplied
+a @key_destroy_func when creating the #GHashTable, the passed key is freed
+using that function.
</description>
<parameters>
-<parameter name="fd">
-<parameter_description> a C library file descriptor.
+<parameter name="hash_table">
+<parameter_description> a #GHashTable.
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a key to insert.
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> the value to associate with the key.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GIOChannel.
-</return>
+<return></return>
</function>
-<function name="g_io_channel_win32_new_messages">
+<function name="g_hash_table_iter_get_hash_table">
<description>
-Creates a new #GIOChannel given a window handle on Windows.
+Returns the #GHashTable associated with @iter.
-This function creates a #GIOChannel that can be used to poll for
-Windows messages for the window in question.
+Since: 2.16
</description>
<parameters>
-<parameter name="hwnd">
-<parameter_description> a window handle.
+<parameter name="iter">
+<parameter_description> an initialized #GHashTableIter.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GIOChannel.
+<return> the #GHashTable associated with @iter.
+
</return>
</function>
-<function name="g_io_channel_win32_new_socket">
+<function name="g_hash_table_iter_init">
<description>
-Creates a new #GIOChannel given a socket on Windows.
+Initializes a key/value pair iterator and associates it with
+ hash_table Modifying the hash table after calling this function
+invalidates the returned iterator.
+|[
+GHashTableIter iter;
+gpointer key, value;
-This function works for sockets created by Winsock. It's available
-only in GLib on Windows.
+g_hash_table_iter_init (&iter, hash_table);
+while (g_hash_table_iter_next (&iter, &key, &value))
+{
+/ * do something with key and value * /
+}
+]|
-Polling a #GSource created to watch a channel for a socket puts the
-socket in non-blocking mode. This is a side-effect of the
-implementation and unavoidable.
+Since: 2.16
</description>
<parameters>
-<parameter name="socket">
-<parameter_description> a Winsock socket
+<parameter name="iter">
+<parameter_description> an uninitialized #GHashTableIter.
+</parameter_description>
+</parameter>
+<parameter name="hash_table">
+<parameter_description> a #GHashTable.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GIOChannel
-</return>
+<return></return>
</function>
-<function name="g_io_channel_write">
+<function name="g_hash_table_iter_next">
<description>
-Writes data to a #GIOChannel.
+Advances @iter and retrieves the key and/or value that are now
+pointed to as a result of this advancement. If %FALSE is returned,
+ key and @value are not set, and the iterator becomes invalid.
-Deprecated:2.2: Use g_io_channel_write_chars() instead.
+Since: 2.16
</description>
<parameters>
-<parameter name="channel">
-<parameter_description> a #GIOChannel
-</parameter_description>
-</parameter>
-<parameter name="buf">
-<parameter_description> the buffer containing the data to write
+<parameter name="iter">
+<parameter_description> an initialized #GHashTableIter.
</parameter_description>
</parameter>
-<parameter name="count">
-<parameter_description> the number of bytes to write
+<parameter name="key">
+<parameter_description> a location to store the key, or %NULL.
</parameter_description>
</parameter>
-<parameter name="bytes_written">
-<parameter_description> the number of bytes actually written
+<parameter name="value">
+<parameter_description> a location to store the value, or %NULL.
</parameter_description>
</parameter>
</parameters>
-<return> %G_IO_ERROR_NONE if the operation was successful.
+<return> %FALSE if the end of the #GHashTable has been reached.
</return>
</function>
-<function name="g_io_channel_write_chars">
+<function name="g_hash_table_iter_remove">
<description>
-Replacement for g_io_channel_write() with the new API.
+Removes the key/value pair currently pointed to by the iterator
+from its associated #GHashTable. Can only be called after
+g_hash_table_iter_next() returned %TRUE, and cannot be called more
+than once for the same key/value pair.
-On seekable channels with encodings other than %NULL or UTF-8, generic
-mixing of reading and writing is not allowed. A call to g_io_channel_write_chars ()
-may only be made on a channel from which data has been read in the
-cases described in the documentation for g_io_channel_set_encoding ().
+If the #GHashTable was created using g_hash_table_new_full(), the
+key and value are freed using the supplied destroy functions, otherwise
+you have to make sure that any dynamically allocated values are freed
+yourself.
+Since: 2.16
</description>
<parameters>
-<parameter name="channel">
-<parameter_description> a #GIOChannel
-</parameter_description>
-</parameter>
-<parameter name="buf">
-<parameter_description> a buffer to write data from
+<parameter name="iter">
+<parameter_description> an initialized #GHashTableIter.
</parameter_description>
</parameter>
-<parameter name="count">
-<parameter_description> the size of the buffer. If -1, the buffer
-is taken to be a nul-terminated string.
+</parameters>
+<return></return>
+</function>
+
+<function name="g_hash_table_iter_steal">
+<description>
+Removes the key/value pair currently pointed to by the iterator
+from its associated #GHashTable, without calling the key and value
+destroy functions. Can only be called after
+g_hash_table_iter_next() returned %TRUE, and cannot be called more
+than once for the same key/value pair.
+
+Since: 2.16
+
+</description>
+<parameters>
+<parameter name="iter">
+<parameter_description> an initialized #GHashTableIter.
</parameter_description>
</parameter>
-<parameter name="bytes_written">
-<parameter_description> The number of bytes written. This can be nonzero
-even if the return value is not %G_IO_STATUS_NORMAL.
-If the return value is %G_IO_STATUS_NORMAL and the
-channel is blocking, this will always be equal
-to @count if @count >= 0.
+</parameters>
+<return></return>
+</function>
+
+<function name="g_hash_table_lookup">
+<description>
+Looks up a key in a #GHashTable. Note that this function cannot
+distinguish between a key that is not present and one which is present
+and has the value %NULL. If you need this distinction, use
+g_hash_table_lookup_extended().
+
+
+</description>
+<parameters>
+<parameter name="hash_table">
+<parameter_description> a #GHashTable.
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> a location to return an error of type #GConvertError
-or #GIOChannelError
+<parameter name="key">
+<parameter_description> the key to look up.
</parameter_description>
</parameter>
</parameters>
-<return> the status of the operation.
+<return> the associated value, or %NULL if the key is not found.
</return>
</function>
-<function name="g_io_channel_write_unichar">
+<function name="g_hash_table_lookup_extended">
<description>
-Writes a Unicode character to @channel.
-This function cannot be called on a channel with %NULL encoding.
+Looks up a key in the #GHashTable, returning the original key and the
+associated value and a #gboolean which is %TRUE if the key was found. This
+is useful if you need to free the memory allocated for the original key,
+for example before calling g_hash_table_remove().
+
+You can actually pass %NULL for @lookup_key to test
+whether the %NULL key exists, provided the hash and equal functions
+of @hash_table are %NULL-safe.
</description>
<parameters>
-<parameter name="channel">
-<parameter_description> a #GIOChannel
+<parameter name="hash_table">
+<parameter_description> a #GHashTable
</parameter_description>
</parameter>
-<parameter name="thechar">
-<parameter_description> a character
+<parameter name="lookup_key">
+<parameter_description> the key to look up
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> location to return an error of type #GConvertError
-or #GIOChannelError
+<parameter name="orig_key">
+<parameter_description> return location for the original key, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> return location for the value associated with the key, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a #GIOStatus
+<return> %TRUE if the key was found in the #GHashTable.
</return>
</function>
-<function name="g_io_create_watch">
+<function name="g_hash_table_new">
<description>
-Creates a #GSource that's dispatched when @condition is met for the
-given @channel. For example, if condition is #G_IO_IN, the source will
-be dispatched when there's data available for reading.
-
-g_io_add_watch() is a simpler interface to this same functionality, for
-the case where you want to add the source to the default main loop context
-at the default priority.
-
-On Windows, polling a #GSource created to watch a channel for a socket
-puts the socket in non-blocking mode. This is a side-effect of the
-implementation and unavoidable.
+Creates a new #GHashTable with a reference count of 1.
</description>
<parameters>
-<parameter name="channel">
-<parameter_description> a #GIOChannel to watch
+<parameter name="hash_func">
+<parameter_description> a function to create a hash value from a key.
+Hash values are used to determine where keys are stored within the
+#GHashTable data structure. The g_direct_hash(), g_int_hash(),
+g_int64_hash(), g_double_hash() and g_str_hash() functions are provided
+for some common types of keys.
+If hash_func is %NULL, g_direct_hash() is used.
</parameter_description>
</parameter>
-<parameter name="condition">
-<parameter_description> conditions to watch for
+<parameter name="key_equal_func">
+<parameter_description> a function to check two keys for equality. This is
+used when looking up keys in the #GHashTable. The g_direct_equal(),
+g_int_equal(), g_int64_equal(), g_double_equal() and g_str_equal()
+functions are provided for the most common types of keys.
+If @key_equal_func is %NULL, keys are compared directly in a similar
+fashion to g_direct_equal(), but without the overhead of a function call.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GSource
+<return> a new #GHashTable.
</return>
</function>
-<function name="g_key_file_free">
+<function name="g_hash_table_new_full">
<description>
-Frees a #GKeyFile.
+Creates a new #GHashTable like g_hash_table_new() with a reference count
+of 1 and allows to specify functions to free the memory allocated for the
+key and value that get called when removing the entry from the #GHashTable.
-Since: 2.6
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
-</parameter_description>
-</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="g_key_file_get_boolean">
-<description>
-Returns the value associated with @key under @group_name as a
-boolean.
-
-If @key cannot be found then %FALSE is returned and @error is set
-to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the value
-associated with @key cannot be interpreted as a boolean then %FALSE
-is returned and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE.
-
-Since: 2.6
-
-</description>
-<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
+<parameter name="hash_func">
+<parameter_description> a function to create a hash value from a key.
</parameter_description>
</parameter>
-<parameter name="group_name">
-<parameter_description> a group name
+<parameter name="key_equal_func">
+<parameter_description> a function to check two keys for equality.
</parameter_description>
</parameter>
-<parameter name="key">
-<parameter_description> a key
+<parameter name="key_destroy_func">
+<parameter_description> a function to free the memory allocated for the key
+used when removing the entry from the #GHashTable or %NULL if you
+don't want to supply such a function.
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError
+<parameter name="value_destroy_func">
+<parameter_description> a function to free the memory allocated for the
+value used when removing the entry from the #GHashTable or %NULL if
+you don't want to supply such a function.
</parameter_description>
</parameter>
</parameters>
-<return> the value associated with the key as a boolean,
-or %FALSE if the key was not found or could not be parsed.
-
+<return> a new #GHashTable.
</return>
</function>
-<function name="g_key_file_get_boolean_list">
+<function name="g_hash_table_ref">
<description>
-Returns the values associated with @key under @group_name as
-booleans.
-
-If @key cannot be found then %NULL is returned and @error is set to
-#G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the values associated
-with @key cannot be interpreted as booleans then %NULL is returned
-and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE.
+Atomically increments the reference count of @hash_table by one.
+This function is MT-safe and may be called from any thread.
-Since: 2.6
+Since: 2.10
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
-</parameter_description>
-</parameter>
-<parameter name="group_name">
-<parameter_description> a group name
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a key
-</parameter_description>
-</parameter>
-<parameter name="length">
-<parameter_description> the number of booleans returned
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError
+<parameter name="hash_table">
+<parameter_description> a valid #GHashTable.
</parameter_description>
</parameter>
</parameters>
-<return> the values associated with the key as a list of
-booleans, or %NULL if the key was not found or could not be parsed.
+<return> the passed in #GHashTable.
</return>
</function>
-<function name="g_key_file_get_comment">
+<function name="g_hash_table_remove">
<description>
-Retrieves a comment above @key from @group_name.
-If @key is %NULL then @comment will be read from above
- group_name If both @key and @group_name are %NULL, then
- comment will be read from above the first group in the file.
+Removes a key and its associated value from a #GHashTable.
+
+If the #GHashTable was created using g_hash_table_new_full(), the
+key and value are freed using the supplied destroy functions, otherwise
+you have to make sure that any dynamically allocated values are freed
+yourself.
-Since: 2.6
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
-</parameter_description>
-</parameter>
-<parameter name="group_name">
-<parameter_description> a group name, or %NULL
+<parameter name="hash_table">
+<parameter_description> a #GHashTable.
</parameter_description>
</parameter>
<parameter name="key">
-<parameter_description> a key
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError
+<parameter_description> the key to remove.
</parameter_description>
</parameter>
</parameters>
-<return> a comment that should be freed with g_free()
-
+<return> %TRUE if the key was found and removed from the #GHashTable.
</return>
</function>
-<function name="g_key_file_get_double">
+<function name="g_hash_table_remove_all">
<description>
-Returns the value associated with @key under @group_name as a
-double. If @group_name is %NULL, the start_group is used.
+Removes all keys and their associated values from a #GHashTable.
-If @key cannot be found then 0.0 is returned and @error is set to
-#G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the value associated
-with @key cannot be interpreted as a double then 0.0 is returned
-and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE.
+If the #GHashTable was created using g_hash_table_new_full(), the keys
+and values are freed using the supplied destroy functions, otherwise you
+have to make sure that any dynamically allocated values are freed
+yourself.
Since: 2.12
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
-</parameter_description>
-</parameter>
-<parameter name="group_name">
-<parameter_description> a group name
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a key
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError
+<parameter name="hash_table">
+<parameter_description> a #GHashTable
</parameter_description>
</parameter>
</parameters>
-<return> the value associated with the key as a double, or
-0.0 if the key was not found or could not be parsed.
-
-</return>
+<return></return>
</function>
-<function name="g_key_file_get_double_list">
+<function name="g_hash_table_replace">
<description>
-Returns the values associated with @key under @group_name as
-doubles.
-
-If @key cannot be found then %NULL is returned and @error is set to
-#G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the values associated
-with @key cannot be interpreted as doubles then %NULL is returned
-and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE.
-
-Since: 2.12
+Inserts a new key and value into a #GHashTable similar to
+g_hash_table_insert(). The difference is that if the key already exists
+in the #GHashTable, it gets replaced by the new key. If you supplied a
+ value_destroy_func when creating the #GHashTable, the old value is freed
+using that function. If you supplied a @key_destroy_func when creating the
+#GHashTable, the old key is freed using that function.
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
-</parameter_description>
-</parameter>
-<parameter name="group_name">
-<parameter_description> a group name
+<parameter name="hash_table">
+<parameter_description> a #GHashTable.
</parameter_description>
</parameter>
<parameter name="key">
-<parameter_description> a key
-</parameter_description>
-</parameter>
-<parameter name="length">
-<parameter_description> the number of doubles returned
+<parameter_description> a key to insert.
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError
+<parameter name="value">
+<parameter_description> the value to associate with the key.
</parameter_description>
</parameter>
</parameters>
-<return> the values associated with the key as a list of
-doubles, or %NULL if the key was not found or could not be parsed.
-
-</return>
+<return></return>
</function>
-<function name="g_key_file_get_groups">
+<function name="g_hash_table_size">
<description>
-Returns all groups in the key file loaded with @key_file.
-The array of returned groups will be %NULL-terminated, so
- length may optionally be %NULL.
+Returns the number of elements contained in the #GHashTable.
-Since: 2.6
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
-</parameter_description>
-</parameter>
-<parameter name="length">
-<parameter_description> return location for the number of returned groups, or %NULL
+<parameter name="hash_table">
+<parameter_description> a #GHashTable.
</parameter_description>
</parameter>
</parameters>
-<return> a newly-allocated %NULL-terminated array of strings.
-Use g_strfreev() to free it.
+<return> the number of key/value pairs in the #GHashTable.
</return>
</function>
-<function name="g_key_file_get_int64">
+<function name="g_hash_table_steal">
<description>
-Returns the value associated with @key under @group_name as a signed
-64-bit integer. This is similar to g_key_file_get_integer() but can return
-64-bit results without truncation.
+Removes a key and its associated value from a #GHashTable without
+calling the key and value destroy functions.
-Since: 2.26
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> a non-%NULL #GKeyFile
-</parameter_description>
-</parameter>
-<parameter name="group_name">
-<parameter_description> a non-%NULL group name
+<parameter name="hash_table">
+<parameter_description> a #GHashTable.
</parameter_description>
</parameter>
<parameter name="key">
-<parameter_description> a non-%NULL key
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError
+<parameter_description> the key to remove.
</parameter_description>
</parameter>
</parameters>
-<return> the value associated with the key as a signed 64-bit integer, or
-0 if the key was not found or could not be parsed.
-
+<return> %TRUE if the key was found and removed from the #GHashTable.
</return>
</function>
-<function name="g_key_file_get_integer">
+<function name="g_hash_table_steal_all">
<description>
-Returns the value associated with @key under @group_name as an
-integer.
-
-If @key cannot be found then 0 is returned and @error is set to
-#G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the value associated
-with @key cannot be interpreted as an integer then 0 is returned
-and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE.
+Removes all keys and their associated values from a #GHashTable
+without calling the key and value destroy functions.
-Since: 2.6
+Since: 2.12
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
-</parameter_description>
-</parameter>
-<parameter name="group_name">
-<parameter_description> a group name
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a key
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError
+<parameter name="hash_table">
+<parameter_description> a #GHashTable.
</parameter_description>
</parameter>
</parameters>
-<return> the value associated with the key as an integer, or
-0 if the key was not found or could not be parsed.
-
-</return>
+<return></return>
</function>
-<function name="g_key_file_get_integer_list">
+<function name="g_hash_table_unref">
<description>
-Returns the values associated with @key under @group_name as
-integers.
-
-If @key cannot be found then %NULL is returned and @error is set to
-#G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the values associated
-with @key cannot be interpreted as integers then %NULL is returned
-and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE.
+Atomically decrements the reference count of @hash_table by one.
+If the reference count drops to 0, all keys and values will be
+destroyed, and all memory allocated by the hash table is released.
+This function is MT-safe and may be called from any thread.
-Since: 2.6
+Since: 2.10
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
-</parameter_description>
-</parameter>
-<parameter name="group_name">
-<parameter_description> a group name
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a key
-</parameter_description>
-</parameter>
-<parameter name="length">
-<parameter_description> the number of integers returned
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError
+<parameter name="hash_table">
+<parameter_description> a valid #GHashTable.
</parameter_description>
</parameter>
</parameters>
-<return> the values associated with the key as a list of
-integers, or %NULL if the key was not found or could not be parsed.
-
-</return>
+<return></return>
</function>
-<function name="g_key_file_get_keys">
+<function name="g_hostname_is_ascii_encoded">
<description>
-Returns all keys for the group name @group_name. The array of
-returned keys will be %NULL-terminated, so @length may
-optionally be %NULL. In the event that the @group_name cannot
-be found, %NULL is returned and @error is set to
-#G_KEY_FILE_ERROR_GROUP_NOT_FOUND.
+Tests if @hostname contains segments with an ASCII-compatible
+encoding of an Internationalized Domain Name. If this returns
+%TRUE, you should decode the hostname with g_hostname_to_unicode()
+before displaying it to the user.
-Since: 2.6
+Note that a hostname might contain a mix of encoded and unencoded
+segments, and so it is possible for g_hostname_is_non_ascii() and
+g_hostname_is_ascii_encoded() to both return %TRUE for a name.
+
+Since: 2.22
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
-</parameter_description>
-</parameter>
-<parameter name="group_name">
-<parameter_description> a group name
-</parameter_description>
-</parameter>
-<parameter name="length">
-<parameter_description> return location for the number of keys returned, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError, or %NULL
+<parameter name="hostname">
+<parameter_description> a hostname
</parameter_description>
</parameter>
</parameters>
-<return> a newly-allocated %NULL-terminated array of strings.
-Use g_strfreev() to free it.
+<return> %TRUE if @hostname contains any ASCII-encoded
+segments.
</return>
</function>
-<function name="g_key_file_get_locale_string">
+<function name="g_hostname_is_ip_address">
<description>
-Returns the value associated with @key under @group_name
-translated in the given @locale if available. If @locale is
-%NULL then the current locale is assumed.
-
-If @key cannot be found then %NULL is returned and @error is set
-to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. If the value associated
-with @key cannot be interpreted or no suitable translation can
-be found then the untranslated value is returned.
+Tests if @hostname is the string form of an IPv4 or IPv6 address.
+(Eg, "192.168.0.1".)
-Since: 2.6
+Since: 2.22
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
-</parameter_description>
-</parameter>
-<parameter name="group_name">
-<parameter_description> a group name
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a key
-</parameter_description>
-</parameter>
-<parameter name="locale">
-<parameter_description> a locale identifier or %NULL
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError, or %NULL
+<parameter name="hostname">
+<parameter_description> a hostname (or IP address in string form)
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated string or %NULL if the specified
-key cannot be found.
+<return> %TRUE if @hostname is an IP address
</return>
</function>
-<function name="g_key_file_get_locale_string_list">
+<function name="g_hostname_is_non_ascii">
<description>
-Returns the values associated with @key under @group_name
-translated in the given @locale if available. If @locale is
-%NULL then the current locale is assumed.
+Tests if @hostname contains Unicode characters. If this returns
+%TRUE, you need to encode the hostname with g_hostname_to_ascii()
+before using it in non-IDN-aware contexts.
-If @key cannot be found then %NULL is returned and @error is set
-to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. If the values associated
-with @key cannot be interpreted or no suitable translations
-can be found then the untranslated values are returned. The
-returned array is %NULL-terminated, so @length may optionally
-be %NULL.
+Note that a hostname might contain a mix of encoded and unencoded
+segments, and so it is possible for g_hostname_is_non_ascii() and
+g_hostname_is_ascii_encoded() to both return %TRUE for a name.
-Since: 2.6
+Since: 2.22
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
-</parameter_description>
-</parameter>
-<parameter name="group_name">
-<parameter_description> a group name
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a key
-</parameter_description>
-</parameter>
-<parameter name="locale">
-<parameter_description> a locale identifier or %NULL
-</parameter_description>
-</parameter>
-<parameter name="length">
-<parameter_description> return location for the number of returned strings or %NULL
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError or %NULL
+<parameter name="hostname">
+<parameter_description> a hostname
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated %NULL-terminated string array
-or %NULL if the key isn't found. The string array should be freed
-with g_strfreev().
+<return> %TRUE if @hostname contains any non-ASCII characters
</return>
</function>
-<function name="g_key_file_get_start_group">
+<function name="g_hostname_to_ascii">
<description>
-Returns the name of the start group of the file.
+Converts @hostname to its canonical ASCII form; an ASCII-only
+string containing no uppercase letters and not ending with a
+trailing dot.
-Since: 2.6
+Since: 2.22
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
+<parameter name="hostname">
+<parameter_description> a valid UTF-8 or ASCII hostname
</parameter_description>
</parameter>
</parameters>
-<return> The start group of the key file.
+<return> an ASCII hostname, which must be freed, or %NULL if
+ hostname is in some way invalid.
</return>
</function>
-<function name="g_key_file_get_string">
+<function name="g_hostname_to_unicode">
<description>
-Returns the string value associated with @key under @group_name.
-Unlike g_key_file_get_value(), this function handles escape sequences
-like \s.
+Converts @hostname to its canonical presentation form; a UTF-8
+string in Unicode normalization form C, containing no uppercase
+letters, no forbidden characters, and no ASCII-encoded segments,
+and not ending with a trailing dot.
-In the event the key cannot be found, %NULL is returned and
- error is set to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. In the
-event that the @group_name cannot be found, %NULL is returned
-and @error is set to #G_KEY_FILE_ERROR_GROUP_NOT_FOUND.
+Of course if @hostname is not an internationalized hostname, then
+the canonical presentation form will be entirely ASCII.
-Since: 2.6
+Since: 2.22
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
-</parameter_description>
-</parameter>
-<parameter name="group_name">
-<parameter_description> a group name
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a key
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError, or %NULL
+<parameter name="hostname">
+<parameter_description> a valid UTF-8 or ASCII hostname
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated string or %NULL if the specified
-key cannot be found.
+<return> a UTF-8 hostname, which must be freed, or %NULL if
+ hostname is in some way invalid.
</return>
</function>
-<function name="g_key_file_get_string_list">
+<function name="g_iconv">
<description>
-Returns the values associated with @key under @group_name.
+Same as the standard UNIX routine iconv(), but
+may be implemented via libiconv on UNIX flavors that lack
+a native implementation.
-In the event the key cannot be found, %NULL is returned and
- error is set to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. In the
-event that the @group_name cannot be found, %NULL is returned
-and @error is set to #G_KEY_FILE_ERROR_GROUP_NOT_FOUND.
+GLib provides g_convert() and g_locale_to_utf8() which are likely
+more convenient than the raw iconv wrappers.
-Since: 2.6
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
+<parameter name="converter">
+<parameter_description> conversion descriptor from g_iconv_open()
</parameter_description>
</parameter>
-<parameter name="group_name">
-<parameter_description> a group name
+<parameter name="inbuf">
+<parameter_description> bytes to convert
</parameter_description>
</parameter>
-<parameter name="key">
-<parameter_description> a key
+<parameter name="inbytes_left">
+<parameter_description> inout parameter, bytes remaining to convert in @inbuf
</parameter_description>
</parameter>
-<parameter name="length">
-<parameter_description> return location for the number of returned strings, or %NULL
+<parameter name="outbuf">
+<parameter_description> converted output bytes
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError, or %NULL
+<parameter name="outbytes_left">
+<parameter_description> inout parameter, bytes available to fill in @outbuf
</parameter_description>
</parameter>
</parameters>
-<return> a %NULL-terminated string array or %NULL if the specified
-key cannot be found. The array should be freed with g_strfreev().
-
+<return> count of non-reversible conversions, or -1 on error
</return>
</function>
-<function name="g_key_file_get_uint64">
+<function name="g_iconv_close">
<description>
-Returns the value associated with @key under @group_name as an unsigned
-64-bit integer. This is similar to g_key_file_get_integer() but can return
-large positive results without truncation.
+Same as the standard UNIX routine iconv_close(), but
+may be implemented via libiconv on UNIX flavors that lack
+a native implementation. Should be called to clean up
+the conversion descriptor from g_iconv_open() when
+you are done converting things.
+
+GLib provides g_convert() and g_locale_to_utf8() which are likely
+more convenient than the raw iconv wrappers.
-Since: 2.26
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> a non-%NULL #GKeyFile
-</parameter_description>
-</parameter>
-<parameter name="group_name">
-<parameter_description> a non-%NULL group name
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a non-%NULL key
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError
+<parameter name="converter">
+<parameter_description> a conversion descriptor from g_iconv_open()
</parameter_description>
</parameter>
</parameters>
-<return> the value associated with the key as an unsigned 64-bit integer,
-or 0 if the key was not found or could not be parsed.
-
+<return> -1 on error, 0 on success
</return>
</function>
-<function name="g_key_file_get_value">
+<function name="g_iconv_open">
<description>
-Returns the raw value associated with @key under @group_name.
-Use g_key_file_get_string() to retrieve an unescaped UTF-8 string.
-
-In the event the key cannot be found, %NULL is returned and
- error is set to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. In the
-event that the @group_name cannot be found, %NULL is returned
-and @error is set to #G_KEY_FILE_ERROR_GROUP_NOT_FOUND.
+Same as the standard UNIX routine iconv_open(), but
+may be implemented via libiconv on UNIX flavors that lack
+a native implementation.
+GLib provides g_convert() and g_locale_to_utf8() which are likely
+more convenient than the raw iconv wrappers.
-Since: 2.6
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
-</parameter_description>
-</parameter>
-<parameter name="group_name">
-<parameter_description> a group name
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a key
+<parameter name="to_codeset">
+<parameter_description> destination codeset
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError, or %NULL
+<parameter name="from_codeset">
+<parameter_description> source codeset
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated string or %NULL if the specified
-key cannot be found.
-
+<return> a "conversion descriptor", or (GIConv)-1 if
+opening the converter failed.
</return>
</function>
-<function name="g_key_file_has_group">
+<function name="g_idle_add">
<description>
-Looks whether the key file has the group @group_name.
+Adds a function to be called whenever there are no higher priority
+events pending to the default main loop. The function is given the
+default idle priority, #G_PRIORITY_DEFAULT_IDLE. If the function
+returns %FALSE it is automatically removed from the list of event
+sources and will not be called again.
+
+This internally creates a main loop source using g_idle_source_new()
+and attaches it to the main loop context using g_source_attach().
+You can do these steps manually if you need greater control.
-Since: 2.6
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
+<parameter name="function">
+<parameter_description> function to call
</parameter_description>
</parameter>
-<parameter name="group_name">
-<parameter_description> a group name
+<parameter name="data">
+<parameter_description> data to pass to @function.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @group_name is a part of @key_file, %FALSE
-otherwise.
+<return> the ID (greater than 0) of the event source.
</return>
</function>
-<function name="g_key_file_has_key">
+<function name="g_idle_add_full">
<description>
-Looks whether the key file has the key @key in the group
- group_name
+Adds a function to be called whenever there are no higher priority
+events pending. If the function returns %FALSE it is automatically
+removed from the list of event sources and will not be called again.
+
+This internally creates a main loop source using g_idle_source_new()
+and attaches it to the main loop context using g_source_attach().
+You can do these steps manually if you need greater control.
-Since: 2.6
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
+<parameter name="priority">
+<parameter_description> the priority of the idle source. Typically this will be in the
+range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE.
</parameter_description>
</parameter>
-<parameter name="group_name">
-<parameter_description> a group name
+<parameter name="function">
+<parameter_description> function to call
</parameter_description>
</parameter>
-<parameter name="key">
-<parameter_description> a key name
+<parameter name="data">
+<parameter_description> data to pass to @function
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError
+<parameter name="notify">
+<parameter_description> function to call when the idle is removed, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @key is a part of @group_name, %FALSE
-otherwise.
-
+<return> the ID (greater than 0) of the event source.
</return>
</function>
-<function name="g_key_file_load_from_data">
+<function name="g_idle_remove_by_data">
<description>
-Loads a key file from memory into an empty #GKeyFile structure.
-If the object cannot be created then %error is set to a #GKeyFileError.
+Removes the idle function with the given data.
-Since: 2.6
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> an empty #GKeyFile struct
-</parameter_description>
-</parameter>
<parameter name="data">
-<parameter_description> key file loaded in memory
-</parameter_description>
-</parameter>
-<parameter name="length">
-<parameter_description> the length of @data in bytes
-</parameter_description>
-</parameter>
-<parameter name="flags">
-<parameter_description> flags from #GKeyFileFlags
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError, or %NULL
+<parameter_description> the data for the idle source's callback.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if a key file could be loaded, %FALSE otherwise
+<return> %TRUE if an idle source was found and removed.
+</return>
+</function>
+
+<function name="g_idle_source_new">
+<description>
+Creates a new idle source.
+
+The source will not initially be associated with any #GMainContext
+and must be added to one with g_source_attach() before it will be
+executed. Note that the default priority for idle sources is
+%G_PRIORITY_DEFAULT_IDLE, as compared to other sources which
+have a default priority of %G_PRIORITY_DEFAULT.
+
+</description>
+<parameters>
+</parameters>
+<return> the newly-created idle source
</return>
</function>
-<function name="g_key_file_load_from_data_dirs">
+<function name="g_int64_equal">
<description>
-This function looks for a key file named @file in the paths
-returned from g_get_user_data_dir() and g_get_system_data_dirs(),
-loads the file into @key_file and returns the file's full path in
- full_path If the file could not be loaded then an %error is
-set to either a #GFileError or #GKeyFileError.
+Compares the two #gint64 values being pointed to and returns
+%TRUE if they are equal.
+It can be passed to g_hash_table_new() as the @key_equal_func
+parameter, when using pointers to 64-bit integers as keys in a #GHashTable.
-Since: 2.6
+Since: 2.22
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> an empty #GKeyFile struct
-</parameter_description>
-</parameter>
-<parameter name="file">
-<parameter_description> a relative path to a filename to open and parse
-</parameter_description>
-</parameter>
-<parameter name="full_path">
-<parameter_description> return location for a string containing the full path
-of the file, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="flags">
-<parameter_description> flags from #GKeyFileFlags
+<parameter name="v1">
+<parameter_description> a pointer to a #gint64 key.
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError, or %NULL
+<parameter name="v2">
+<parameter_description> a pointer to a #gint64 key to compare with @v1.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if a key file could be loaded, %FALSE othewise
+<return> %TRUE if the two keys match.
+
</return>
</function>
-<function name="g_key_file_load_from_dirs">
+<function name="g_int64_hash">
<description>
-This function looks for a key file named @file in the paths
-specified in @search_dirs, loads the file into @key_file and
-returns the file's full path in @full_path. If the file could not
-be loaded then an %error is set to either a #GFileError or
-#GKeyFileError.
+Converts a pointer to a #gint64 to a hash value.
+It can be passed to g_hash_table_new() as the @hash_func parameter,
+when using pointers to 64-bit integers values as keys in a #GHashTable.
-Since: 2.14
+Since: 2.22
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> an empty #GKeyFile struct
-</parameter_description>
-</parameter>
-<parameter name="file">
-<parameter_description> a relative path to a filename to open and parse
-</parameter_description>
-</parameter>
-<parameter name="search_dirs">
-<parameter_description> %NULL-terminated array of directories to search
-</parameter_description>
-</parameter>
-<parameter name="full_path">
-<parameter_description> return location for a string containing the full path
-of the file, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="flags">
-<parameter_description> flags from #GKeyFileFlags
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError, or %NULL
+<parameter name="v">
+<parameter_description> a pointer to a #gint64 key
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if a key file could be loaded, %FALSE otherwise
+<return> a hash value corresponding to the key.
</return>
</function>
-<function name="g_key_file_load_from_file">
+<function name="g_int_equal">
<description>
-Loads a key file into an empty #GKeyFile structure.
-If the file could not be loaded then %error is set to
-either a #GFileError or #GKeyFileError.
+Compares the two #gint values being pointed to and returns
+%TRUE if they are equal.
+It can be passed to g_hash_table_new() as the @key_equal_func
+parameter, when using pointers to integers as keys in a #GHashTable.
-Since: 2.6
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> an empty #GKeyFile struct
-</parameter_description>
-</parameter>
-<parameter name="file">
-<parameter_description> the path of a filename to load, in the GLib filename encoding
-</parameter_description>
-</parameter>
-<parameter name="flags">
-<parameter_description> flags from #GKeyFileFlags
+<parameter name="v1">
+<parameter_description> a pointer to a #gint key.
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError, or %NULL
+<parameter name="v2">
+<parameter_description> a pointer to a #gint key to compare with @v1.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if a key file could be loaded, %FALSE otherwise
-
+<return> %TRUE if the two keys match.
</return>
</function>
-<function name="g_key_file_new">
+<function name="g_int_hash">
<description>
-Creates a new empty #GKeyFile object. Use
-g_key_file_load_from_file(), g_key_file_load_from_data(),
-g_key_file_load_from_dirs() or g_key_file_load_from_data_dirs() to
-read an existing key file.
+Converts a pointer to a #gint to a hash value.
+It can be passed to g_hash_table_new() as the @hash_func parameter,
+when using pointers to integers values as keys in a #GHashTable.
-Since: 2.6
</description>
<parameters>
+<parameter name="v">
+<parameter_description> a pointer to a #gint key
+</parameter_description>
+</parameter>
</parameters>
-<return> an empty #GKeyFile.
-
+<return> a hash value corresponding to the key.
</return>
</function>
-<function name="g_key_file_remove_comment">
+<function name="g_intern_static_string">
<description>
-Removes a comment above @key from @group_name.
-If @key is %NULL then @comment will be removed above @group_name.
-If both @key and @group_name are %NULL, then @comment will
-be removed above the first group in the file.
+Returns a canonical representation for @string. Interned strings can
+be compared for equality by comparing the pointers, instead of using strcmp().
+g_intern_static_string() does not copy the string, therefore @string must
+not be freed or modified.
-Since: 2.6
+Since: 2.10
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
-</parameter_description>
-</parameter>
-<parameter name="group_name">
-<parameter_description> a group name, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a key
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError
+<parameter name="string">
+<parameter_description> a static string
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the comment was removed, %FALSE otherwise
+<return> a canonical representation for the string
</return>
</function>
-<function name="g_key_file_remove_group">
+<function name="g_intern_string">
<description>
-Removes the specified group, @group_name,
-from the key file.
+Returns a canonical representation for @string. Interned strings can
+be compared for equality by comparing the pointers, instead of using strcmp().
-Since: 2.6
+Since: 2.10
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
-</parameter_description>
-</parameter>
-<parameter name="group_name">
-<parameter_description> a group name
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError or %NULL
+<parameter name="string">
+<parameter_description> a string
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the group was removed, %FALSE otherwise
+<return> a canonical representation for the string
</return>
</function>
-<function name="g_key_file_remove_key">
+<function name="g_io_add_watch">
<description>
-Removes @key in @group_name from the key file.
+Adds the #GIOChannel into the default main loop context
+with the default priority.
-Since: 2.6
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
+<parameter name="channel">
+<parameter_description> a #GIOChannel
</parameter_description>
</parameter>
-<parameter name="group_name">
-<parameter_description> a group name
+<parameter name="condition">
+<parameter_description> the condition to watch for
</parameter_description>
</parameter>
-<parameter name="key">
-<parameter_description> a key name to remove
+<parameter name="func">
+<parameter_description> the function to call when the condition is satisfied
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError or %NULL
+<parameter name="user_data">
+<parameter_description> user data to pass to @func
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the key was removed, %FALSE otherwise
-
+<return> the event source id
</return>
</function>
-<function name="g_key_file_set_boolean">
+<function name="g_io_add_watch_full">
<description>
-Associates a new boolean value with @key under @group_name.
-If @key cannot be found then it is created.
+Adds the #GIOChannel into the default main loop context
+with the given priority.
+
+This internally creates a main loop source using g_io_create_watch()
+and attaches it to the main loop context with g_source_attach().
+You can do these steps manually if you need greater control.
-Since: 2.6
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
+<parameter name="channel">
+<parameter_description> a #GIOChannel
</parameter_description>
</parameter>
-<parameter name="group_name">
-<parameter_description> a group name
+<parameter name="priority">
+<parameter_description> the priority of the #GIOChannel source
</parameter_description>
</parameter>
-<parameter name="key">
-<parameter_description> a key
+<parameter name="condition">
+<parameter_description> the condition to watch for
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> %TRUE or %FALSE
+<parameter name="func">
+<parameter_description> the function to call when the condition is satisfied
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> user data to pass to @func
+</parameter_description>
+</parameter>
+<parameter name="notify">
+<parameter_description> the function to call when the source is removed
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the event source id
+</return>
</function>
-<function name="g_key_file_set_boolean_list">
+<function name="g_io_channel_close">
<description>
-Associates a list of boolean values with @key under @group_name.
-If @key cannot be found then it is created.
-If @group_name is %NULL, the start_group is used.
+Close an IO channel. Any pending data to be written will be
+flushed, ignoring errors. The channel will not be freed until the
+last reference is dropped using g_io_channel_unref().
-Since: 2.6
+Deprecated:2.2: Use g_io_channel_shutdown() instead.
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
-</parameter_description>
-</parameter>
-<parameter name="group_name">
-<parameter_description> a group name
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a key
-</parameter_description>
-</parameter>
-<parameter name="list">
-<parameter_description> an array of boolean values
-</parameter_description>
-</parameter>
-<parameter name="length">
-<parameter_description> length of @list
+<parameter name="channel">
+<parameter_description> A #GIOChannel
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_key_file_set_comment">
+<function name="g_io_channel_error_from_errno">
<description>
-Places a comment above @key from @group_name.
-If @key is %NULL then @comment will be written above @group_name.
-If both @key and @group_name are %NULL, then @comment will be
-written above the first group in the file.
+Converts an <literal>errno</literal> error number to a #GIOChannelError.
-Since: 2.6
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
-</parameter_description>
-</parameter>
-<parameter name="group_name">
-<parameter_description> a group name, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a key
-</parameter_description>
-</parameter>
-<parameter name="comment">
-<parameter_description> a comment
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError
+<parameter name="en">
+<parameter_description> an <literal>errno</literal> error number, e.g. %EINVAL
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the comment was written, %FALSE otherwise
+<return> a #GIOChannelError error number, e.g.
+%G_IO_CHANNEL_ERROR_INVAL.
+</return>
+</function>
+
+<function name="g_io_channel_error_quark">
+<description>
+</description>
+<parameters>
+</parameters>
+<return> the quark used as %G_IO_CHANNEL_ERROR
</return>
</function>
-<function name="g_key_file_set_double">
+<function name="g_io_channel_flush">
<description>
-Associates a new double value with @key under @group_name.
-If @key cannot be found then it is created.
+Flushes the write buffer for the GIOChannel.
-Since: 2.12
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
-</parameter_description>
-</parameter>
-<parameter name="group_name">
-<parameter_description> a group name
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a key
+<parameter name="channel">
+<parameter_description> a #GIOChannel
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> an double value
+<parameter name="error">
+<parameter_description> location to store an error of type #GIOChannelError
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the status of the operation: One of
+#G_IO_STATUS_NORMAL, #G_IO_STATUS_AGAIN, or
+#G_IO_STATUS_ERROR.
+</return>
</function>
-<function name="g_key_file_set_double_list">
+<function name="g_io_channel_get_buffer_condition">
<description>
-Associates a list of double values with @key under
- group_name If @key cannot be found then it is created.
+This function returns a #GIOCondition depending on whether there
+is data to be read/space to write data in the internal buffers in
+the #GIOChannel. Only the flags %G_IO_IN and %G_IO_OUT may be set.
-Since: 2.12
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
-</parameter_description>
-</parameter>
-<parameter name="group_name">
-<parameter_description> a group name
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a key
-</parameter_description>
-</parameter>
-<parameter name="list">
-<parameter_description> an array of double values
-</parameter_description>
-</parameter>
-<parameter name="length">
-<parameter_description> number of double values in @list
+<parameter name="channel">
+<parameter_description> A #GIOChannel
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> A #GIOCondition
+</return>
</function>
-<function name="g_key_file_set_int64">
+<function name="g_io_channel_get_buffer_size">
<description>
-Associates a new integer value with @key under @group_name.
-If @key cannot be found then it is created.
+Gets the buffer size.
-Since: 2.26
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
-</parameter_description>
-</parameter>
-<parameter name="group_name">
-<parameter_description> a group name
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a key
-</parameter_description>
-</parameter>
-<parameter name="value">
-<parameter_description> an integer value
+<parameter name="channel">
+<parameter_description> a #GIOChannel
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the size of the buffer.
+</return>
</function>
-<function name="g_key_file_set_integer">
+<function name="g_io_channel_get_buffered">
<description>
-Associates a new integer value with @key under @group_name.
-If @key cannot be found then it is created.
+Returns whether @channel is buffered.
-Since: 2.6
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
-</parameter_description>
-</parameter>
-<parameter name="group_name">
-<parameter_description> a group name
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a key
-</parameter_description>
-</parameter>
-<parameter name="value">
-<parameter_description> an integer value
+<parameter name="channel">
+<parameter_description> a #GIOChannel
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the @channel is buffered.
+</return>
</function>
-<function name="g_key_file_set_integer_list">
+<function name="g_io_channel_get_close_on_unref">
<description>
-Associates a list of integer values with @key under @group_name.
-If @key cannot be found then it is created.
+Returns whether the file/socket/whatever associated with @channel
+will be closed when @channel receives its final unref and is
+destroyed. The default value of this is %TRUE for channels created
+by g_io_channel_new_file (), and %FALSE for all other channels.
-Since: 2.6
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
+<parameter name="channel">
+<parameter_description> a #GIOChannel.
</parameter_description>
</parameter>
-<parameter name="group_name">
-<parameter_description> a group name
+</parameters>
+<return> Whether the channel will be closed on the final unref of
+the GIOChannel data structure.
+</return>
+</function>
+
+<function name="g_io_channel_get_encoding">
+<description>
+Gets the encoding for the input/output of the channel.
+The internal encoding is always UTF-8. The encoding %NULL
+makes the channel safe for binary data.
+
+
+</description>
+<parameters>
+<parameter name="channel">
+<parameter_description> a #GIOChannel
</parameter_description>
</parameter>
-<parameter name="key">
-<parameter_description> a key
+</parameters>
+<return> A string containing the encoding, this string is
+owned by GLib and must not be freed.
+</return>
+</function>
+
+<function name="g_io_channel_get_flags">
+<description>
+Gets the current flags for a #GIOChannel, including read-only
+flags such as %G_IO_FLAG_IS_READABLE.
+
+The values of the flags %G_IO_FLAG_IS_READABLE and %G_IO_FLAG_IS_WRITEABLE
+are cached for internal use by the channel when it is created.
+If they should change at some later point (e.g. partial shutdown
+of a socket with the UNIX shutdown() function), the user
+should immediately call g_io_channel_get_flags() to update
+the internal values of these flags.
+
+
+</description>
+<parameters>
+<parameter name="channel">
+<parameter_description> a #GIOChannel
</parameter_description>
</parameter>
-<parameter name="list">
-<parameter_description> an array of integer values
+</parameters>
+<return> the flags which are set on the channel
+</return>
+</function>
+
+<function name="g_io_channel_get_line_term">
+<description>
+This returns the string that #GIOChannel uses to determine
+where in the file a line break occurs. A value of %NULL
+indicates autodetection.
+
+
+</description>
+<parameters>
+<parameter name="channel">
+<parameter_description> a #GIOChannel
</parameter_description>
</parameter>
<parameter name="length">
-<parameter_description> number of integer values in @list
+<parameter_description> a location to return the length of the line terminator
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The line termination string. This value
+is owned by GLib and must not be freed.
+</return>
</function>
-<function name="g_key_file_set_list_separator">
+<function name="g_io_channel_init">
<description>
-Sets the character which is used to separate
-values in lists. Typically ';' or ',' are used
-as separators. The default list separator is ';'.
+Initializes a #GIOChannel struct.
-Since: 2.6
+This is called by each of the above functions when creating a
+#GIOChannel, and so is not often needed by the application
+programmer (unless you are creating a new type of #GIOChannel).
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
-</parameter_description>
-</parameter>
-<parameter name="separator">
-<parameter_description> the separator
+<parameter name="channel">
+<parameter_description> a #GIOChannel
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_key_file_set_locale_string">
+<function name="g_io_channel_new_file">
<description>
-Associates a string value for @key and @locale under @group_name.
-If the translation for @key cannot be found then it is created.
+Open a file @filename as a #GIOChannel using mode @mode. This
+channel will be closed when the last reference to it is dropped,
+so there is no need to call g_io_channel_close() (though doing
+so will not cause problems, as long as no attempt is made to
+access the channel after it is closed).
-Since: 2.6
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
-</parameter_description>
-</parameter>
-<parameter name="group_name">
-<parameter_description> a group name
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a key
+<parameter name="filename">
+<parameter_description> A string containing the name of a file
</parameter_description>
</parameter>
-<parameter name="locale">
-<parameter_description> a locale identifier
+<parameter name="mode">
+<parameter_description> One of "r", "w", "a", "r+", "w+", "a+". These have
+the same meaning as in fopen()
</parameter_description>
</parameter>
-<parameter name="string">
-<parameter_description> a string
+<parameter name="error">
+<parameter_description> A location to return an error of type %G_FILE_ERROR
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> A #GIOChannel on success, %NULL on failure.
+</return>
</function>
-<function name="g_key_file_set_locale_string_list">
+<function name="g_io_channel_read">
<description>
-Associates a list of string values for @key and @locale under
- group_name If the translation for @key cannot be found then
-it is created.
+Reads data from a #GIOChannel.
-Since: 2.6
+Deprecated:2.2: Use g_io_channel_read_chars() instead.
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
-</parameter_description>
-</parameter>
-<parameter name="group_name">
-<parameter_description> a group name
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a key
+<parameter name="channel">
+<parameter_description> a #GIOChannel
</parameter_description>
</parameter>
-<parameter name="locale">
-<parameter_description> a locale identifier
+<parameter name="buf">
+<parameter_description> a buffer to read the data into (which should be at least
+count bytes long)
</parameter_description>
</parameter>
-<parameter name="list">
-<parameter_description> a %NULL-terminated array of locale string values
+<parameter name="count">
+<parameter_description> the number of bytes to read from the #GIOChannel
</parameter_description>
</parameter>
-<parameter name="length">
-<parameter_description> the length of @list
+<parameter name="bytes_read">
+<parameter_description> returns the number of bytes actually read
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %G_IO_ERROR_NONE if the operation was successful.
+
+</return>
</function>
-<function name="g_key_file_set_string">
+<function name="g_io_channel_read_chars">
<description>
-Associates a new string value with @key under @group_name.
-If @key cannot be found then it is created.
-If @group_name cannot be found then it is created.
-Unlike g_key_file_set_value(), this function handles characters
-that need escaping, such as newlines.
+Replacement for g_io_channel_read() with the new API.
-Since: 2.6
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
+<parameter name="channel">
+<parameter_description> a #GIOChannel
</parameter_description>
</parameter>
-<parameter name="group_name">
-<parameter_description> a group name
+<parameter name="buf">
+<parameter_description> a buffer to read data into
</parameter_description>
</parameter>
-<parameter name="key">
-<parameter_description> a key
+<parameter name="count">
+<parameter_description> the size of the buffer. Note that the buffer may not be
+complelely filled even if there is data in the buffer if the
+remaining data is not a complete character.
</parameter_description>
</parameter>
-<parameter name="string">
-<parameter_description> a string
+<parameter name="bytes_read">
+<parameter_description> The number of bytes read. This may be
+zero even on success if count < 6 and the channel's encoding
+is non-%NULL. This indicates that the next UTF-8 character is
+too wide for the buffer.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a location to return an error of type #GConvertError
+or #GIOChannelError.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the status of the operation.
+</return>
</function>
-<function name="g_key_file_set_string_list">
+<function name="g_io_channel_read_line">
<description>
-Associates a list of string values for @key under @group_name.
-If @key cannot be found then it is created.
-If @group_name cannot be found then it is created.
+Reads a line, including the terminating character(s),
+from a #GIOChannel into a newly-allocated string.
+ str_return will contain allocated memory if the return
+is %G_IO_STATUS_NORMAL.
-Since: 2.6
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
+<parameter name="channel">
+<parameter_description> a #GIOChannel
</parameter_description>
</parameter>
-<parameter name="group_name">
-<parameter_description> a group name
+<parameter name="str_return">
+<parameter_description> The line read from the #GIOChannel, including the
+line terminator. This data should be freed with g_free()
+when no longer needed. This is a nul-terminated string.
+If a @length of zero is returned, this will be %NULL instead.
</parameter_description>
</parameter>
-<parameter name="key">
-<parameter_description> a key
+<parameter name="length">
+<parameter_description> location to store length of the read data, or %NULL
</parameter_description>
</parameter>
-<parameter name="list">
-<parameter_description> an array of string values
+<parameter name="terminator_pos">
+<parameter_description> location to store position of line terminator, or %NULL
</parameter_description>
</parameter>
-<parameter name="length">
-<parameter_description> number of string values in @list
+<parameter name="error">
+<parameter_description> A location to return an error of type #GConvertError
+or #GIOChannelError
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the status of the operation.
+</return>
</function>
-<function name="g_key_file_set_uint64">
+<function name="g_io_channel_read_line_string">
<description>
-Associates a new integer value with @key under @group_name.
-If @key cannot be found then it is created.
+Reads a line from a #GIOChannel, using a #GString as a buffer.
-Since: 2.26
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
+<parameter name="channel">
+<parameter_description> a #GIOChannel
</parameter_description>
</parameter>
-<parameter name="group_name">
-<parameter_description> a group name
+<parameter name="buffer">
+<parameter_description> a #GString into which the line will be written.
+If @buffer already contains data, the old data will
+be overwritten.
</parameter_description>
</parameter>
-<parameter name="key">
-<parameter_description> a key
+<parameter name="terminator_pos">
+<parameter_description> location to store position of line terminator, or %NULL
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> an integer value
+<parameter name="error">
+<parameter_description> a location to store an error of type #GConvertError
+or #GIOChannelError
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the status of the operation.
+</return>
</function>
-<function name="g_key_file_set_value">
+<function name="g_io_channel_read_to_end">
<description>
-Associates a new value with @key under @group_name.
-
-If @key cannot be found then it is created. If @group_name cannot
-be found then it is created. To set an UTF-8 string which may contain
-characters that need escaping (such as newlines or spaces), use
-g_key_file_set_string().
+Reads all the remaining data from the file.
-Since: 2.6
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
+<parameter name="channel">
+<parameter_description> a #GIOChannel
</parameter_description>
</parameter>
-<parameter name="group_name">
-<parameter_description> a group name
+<parameter name="str_return">
+<parameter_description> Location to store a pointer to a string holding
+the remaining data in the #GIOChannel. This data should
+be freed with g_free() when no longer needed. This
+data is terminated by an extra nul character, but there
+may be other nuls in the intervening data.
</parameter_description>
</parameter>
-<parameter name="key">
-<parameter_description> a key
+<parameter name="length">
+<parameter_description> location to store length of the data
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> a string
+<parameter name="error">
+<parameter_description> location to return an error of type #GConvertError
+or #GIOChannelError
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %G_IO_STATUS_NORMAL on success.
+This function never returns %G_IO_STATUS_EOF.
+</return>
</function>
-<function name="g_key_file_to_data">
+<function name="g_io_channel_read_unichar">
<description>
-This function outputs @key_file as a string.
-
-Note that this function never reports an error,
-so it is safe to pass %NULL as @error.
+Reads a Unicode character from @channel.
+This function cannot be called on a channel with %NULL encoding.
-Since: 2.6
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
+<parameter name="channel">
+<parameter_description> a #GIOChannel
</parameter_description>
</parameter>
-<parameter name="length">
-<parameter_description> return location for the length of the
-returned string, or %NULL
+<parameter name="thechar">
+<parameter_description> a location to return a character
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> return location for a #GError, or %NULL
+<parameter_description> a location to return an error of type #GConvertError
+or #GIOChannelError
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated string holding
-the contents of the #GKeyFile
-
+<return> a #GIOStatus
</return>
</function>
-<function name="g_list_alloc">
+<function name="g_io_channel_ref">
<description>
-Allocates space for one #GList element. It is called by
-g_list_append(), g_list_prepend(), g_list_insert() and
-g_list_insert_sorted() and so is rarely used on its own.
+Increments the reference count of a #GIOChannel.
+
</description>
<parameters>
+<parameter name="channel">
+<parameter_description> a #GIOChannel
+</parameter_description>
+</parameter>
</parameters>
-<return> a pointer to the newly-allocated #GList element.
+<return> the @channel that was passed in (since 2.6)
</return>
</function>
-<function name="g_list_append">
+<function name="g_io_channel_seek">
<description>
-Adds a new element on to the end of the list.
-
-<note><para>
-The return value is the new start of the list, which
-may have changed, so make sure you store the new value.
-</para></note>
-
-<note><para>
-Note that g_list_append() has to traverse the entire list
-to find the end, which is inefficient when adding multiple
-elements. A common idiom to avoid the inefficiency is to prepend
-the elements and reverse the list when all elements have been added.
-</para></note>
-
-|[
-/ * Notice that these are initialized to the empty list. * /
-GList *list = NULL, *number_list = NULL;
-
-/ * This is a list of strings. * /
-list = g_list_append (list, "first");
-list = g_list_append (list, "second");
-
-/ * This is a list of integers. * /
-number_list = g_list_append (number_list, GINT_TO_POINTER (27));
-number_list = g_list_append (number_list, GINT_TO_POINTER (14));
-]|
+Sets the current position in the #GIOChannel, similar to the standard
+library function fseek().
+Deprecated:2.2: Use g_io_channel_seek_position() instead.
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a pointer to a #GList
+<parameter name="channel">
+<parameter_description> a #GIOChannel
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> the data for the new element
+<parameter name="offset">
+<parameter_description> an offset, in bytes, which is added to the position specified
+by @type
+</parameter_description>
+</parameter>
+<parameter name="type">
+<parameter_description> the position in the file, which can be %G_SEEK_CUR (the current
+position), %G_SEEK_SET (the start of the file), or %G_SEEK_END
+(the end of the file)
</parameter_description>
</parameter>
</parameters>
-<return> the new start of the #GList
+<return> %G_IO_ERROR_NONE if the operation was successful.
+
</return>
</function>
-<function name="g_list_concat">
+<function name="g_io_channel_seek_position">
<description>
-Adds the second #GList onto the end of the first #GList.
-Note that the elements of the second #GList are not copied.
-They are used directly.
+Replacement for g_io_channel_seek() with the new API.
</description>
<parameters>
-<parameter name="list1">
-<parameter_description> a #GList
+<parameter name="channel">
+<parameter_description> a #GIOChannel
</parameter_description>
</parameter>
-<parameter name="list2">
-<parameter_description> the #GList to add to the end of the first #GList
+<parameter name="offset">
+<parameter_description> The offset in bytes from the position specified by @type
+</parameter_description>
+</parameter>
+<parameter name="type">
+<parameter_description> a #GSeekType. The type %G_SEEK_CUR is only allowed in those
+cases where a call to g_io_channel_set_encoding ()
+is allowed. See the documentation for
+g_io_channel_set_encoding () for details.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> A location to return an error of type #GIOChannelError
</parameter_description>
</parameter>
</parameters>
-<return> the start of the new #GList
+<return> the status of the operation.
</return>
</function>
-<function name="g_list_copy">
+<function name="g_io_channel_set_buffer_size">
<description>
-Copies a #GList.
-
-<note><para>
-Note that this is a "shallow" copy. If the list elements
-consist of pointers to data, the pointers are copied but
-the actual data is not.
-</para></note>
-
+Sets the buffer size.
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GList
+<parameter name="channel">
+<parameter_description> a #GIOChannel
</parameter_description>
</parameter>
-</parameters>
-<return> a copy of @list
-</return>
+<parameter name="size">
+<parameter_description> the size of the buffer, or 0 to let GLib pick a good size
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="g_list_delete_link">
+<function name="g_io_channel_set_buffered">
<description>
-Removes the node link_ from the list and frees it.
-Compare this to g_list_remove_link() which removes the node
-without freeing it.
+The buffering state can only be set if the channel's encoding
+is %NULL. For any other encoding, the channel must be buffered.
+
+A buffered channel can only be set unbuffered if the channel's
+internal buffers have been flushed. Newly created channels or
+channels which have returned %G_IO_STATUS_EOF
+not require such a flush. For write-only channels, a call to
+g_io_channel_flush () is sufficient. For all other channels,
+the buffers may be flushed by a call to g_io_channel_seek_position ().
+This includes the possibility of seeking with seek type %G_SEEK_CUR
+and an offset of zero. Note that this means that socket-based
+channels cannot be set unbuffered once they have had data
+read from them.
+On unbuffered channels, it is safe to mix read and write
+calls from the new and old APIs, if this is necessary for
+maintaining old code.
+
+The default state of the channel is buffered.
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GList
+<parameter name="channel">
+<parameter_description> a #GIOChannel
</parameter_description>
</parameter>
-<parameter name="link_">
-<parameter_description> node to delete from @list
+<parameter name="buffered">
+<parameter_description> whether to set the channel buffered or unbuffered
</parameter_description>
</parameter>
</parameters>
-<return> the new head of @list
-</return>
+<return></return>
</function>
-<function name="g_list_find">
+<function name="g_io_channel_set_close_on_unref">
<description>
-Finds the element in a #GList which
-contains the given data.
-
+Setting this flag to %TRUE for a channel you have already closed
+can cause problems.
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GList
+<parameter name="channel">
+<parameter_description> a #GIOChannel
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> the element data to find
+<parameter name="do_close">
+<parameter_description> Whether to close the channel on the final unref of
+the GIOChannel data structure. The default value of
+this is %TRUE for channels created by g_io_channel_new_file (),
+and %FALSE for all other channels.
</parameter_description>
</parameter>
</parameters>
-<return> the found #GList element,
-or %NULL if it is not found
-</return>
+<return></return>
</function>
-<function name="g_list_find_custom">
+<function name="g_io_channel_set_encoding">
<description>
-Finds an element in a #GList, using a supplied function to
-find the desired element. It iterates over the list, calling
-the given function which should return 0 when the desired
-element is found. The function takes two #gconstpointer arguments,
-the #GList element's data as the first argument and the
-given user data.
+Sets the encoding for the input/output of the channel.
+The internal encoding is always UTF-8. The default encoding
+for the external file is UTF-8.
+
+The encoding %NULL is safe to use with binary data.
+
+The encoding can only be set if one of the following conditions
+is true:
+<itemizedlist>
+<listitem><para>
+The channel was just created, and has not been written to or read
+from yet.
+</para></listitem>
+<listitem><para>
+The channel is write-only.
+</para></listitem>
+<listitem><para>
+The channel is a file, and the file pointer was just
+repositioned by a call to g_io_channel_seek_position().
+(This flushes all the internal buffers.)
+</para></listitem>
+<listitem><para>
+The current encoding is %NULL or UTF-8.
+</para></listitem>
+<listitem><para>
+One of the (new API) read functions has just returned %G_IO_STATUS_EOF
+(or, in the case of g_io_channel_read_to_end(), %G_IO_STATUS_NORMAL).
+</para></listitem>
+<listitem><para>
+One of the functions g_io_channel_read_chars() or
+g_io_channel_read_unichar() has returned %G_IO_STATUS_AGAIN or
+%G_IO_STATUS_ERROR. This may be useful in the case of
+%G_CONVERT_ERROR_ILLEGAL_SEQUENCE.
+Returning one of these statuses from g_io_channel_read_line(),
+g_io_channel_read_line_string(), or g_io_channel_read_to_end()
+does <emphasis>not</emphasis> guarantee that the encoding can
+be changed.
+</para></listitem>
+</itemizedlist>
+Channels which do not meet one of the above conditions cannot call
+g_io_channel_seek_position() with an offset of %G_SEEK_CUR, and, if
+they are "seekable", cannot call g_io_channel_write_chars() after
+calling one of the API "read" functions.
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GList
+<parameter name="channel">
+<parameter_description> a #GIOChannel
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> user data passed to the function
+<parameter name="encoding">
+<parameter_description> the encoding type
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> the function to call for each element.
-It should return 0 when the desired element is found
+<parameter name="error">
+<parameter_description> location to store an error of type #GConvertError
</parameter_description>
</parameter>
</parameters>
-<return> the found #GList element, or %NULL if it is not found
+<return> %G_IO_STATUS_NORMAL if the encoding was successfully set.
</return>
</function>
-<function name="g_list_first">
+<function name="g_io_channel_set_flags">
<description>
-Gets the first element in a #GList.
+Sets the (writeable) flags in @channel to (@flags & %G_IO_CHANNEL_SET_MASK).
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GList
+<parameter name="channel">
+<parameter_description> a #GIOChannel
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> the flags to set on the IO channel
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> A location to return an error of type #GIOChannelError
</parameter_description>
</parameter>
</parameters>
-<return> the first element in the #GList,
-or %NULL if the #GList has no elements
+<return> the status of the operation.
</return>
</function>
-<function name="g_list_foreach">
+<function name="g_io_channel_set_line_term">
<description>
-Calls a function for each element of a #GList.
+This sets the string that #GIOChannel uses to determine
+where in the file a line break occurs.
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GList
+<parameter name="channel">
+<parameter_description> a #GIOChannel
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> the function to call with each element's data
+<parameter name="line_term">
+<parameter_description> The line termination string. Use %NULL for autodetect.
+Autodetection breaks on "\n", "\r\n", "\r", "\0", and
+the Unicode paragraph separator. Autodetection should
+not be used for anything other than file-based channels.
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> user data to pass to the function
+<parameter name="length">
+<parameter_description> The length of the termination string. If -1 is passed, the
+string is assumed to be nul-terminated. This option allows
+termination strings with embedded nuls.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_list_free">
+<function name="g_io_channel_shutdown">
<description>
-Frees all of the memory used by a #GList.
-The freed elements are returned to the slice allocator.
+Close an IO channel. Any pending data to be written will be
+flushed if @flush is %TRUE. The channel will not be freed until the
+last reference is dropped using g_io_channel_unref().
-<note><para>
-If list elements contain dynamically-allocated memory,
-you should either use g_list_free_full() or free them manually
-first.
-</para></note>
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GList
+<parameter name="channel">
+<parameter_description> a #GIOChannel
+</parameter_description>
+</parameter>
+<parameter name="flush">
+<parameter_description> if %TRUE, flush pending
+</parameter_description>
+</parameter>
+<parameter name="err">
+<parameter_description> location to store a #GIOChannelError
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the status of the operation.
+</return>
</function>
-<function name="g_list_free1">
+<function name="g_io_channel_unix_get_fd">
<description>
-Another name for g_list_free_1().
+Returns the file descriptor of the #GIOChannel.
+
+On Windows this function returns the file descriptor or socket of
+the #GIOChannel.
</description>
<parameters>
+<parameter name="channel">
+<parameter_description> a #GIOChannel, created with g_io_channel_unix_new().
+</parameter_description>
+</parameter>
</parameters>
-<return></return>
+<return> the file descriptor of the #GIOChannel.
+</return>
</function>
-<function name="g_list_free_1">
+<function name="g_io_channel_unix_new">
<description>
-Frees one #GList element.
-It is usually used after g_list_remove_link().
+Creates a new #GIOChannel given a file descriptor. On UNIX systems
+this works for plain files, pipes, and sockets.
+
+The returned #GIOChannel has a reference count of 1.
+
+The default encoding for #GIOChannel is UTF-8. If your application
+is reading output from a command using via pipe, you may need to set
+the encoding to the encoding of the current locale (see
+g_get_charset()) with the g_io_channel_set_encoding() function.
+
+If you want to read raw binary data without interpretation, then
+call the g_io_channel_set_encoding() function with %NULL for the
+encoding argument.
+
+This function is available in GLib on Windows, too, but you should
+avoid using it on Windows. The domain of file descriptors and
+sockets overlap. There is no way for GLib to know which one you mean
+in case the argument you pass to this function happens to be both a
+valid file descriptor and socket. If that happens a warning is
+issued, and GLib assumes that it is the file descriptor you mean.
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GList element
+<parameter name="fd">
+<parameter_description> a file descriptor.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a new #GIOChannel.
+</return>
</function>
-<function name="g_list_free_full">
+<function name="g_io_channel_unref">
<description>
-Convenience method, which frees all the memory used by a #GList, and
-calls the specified destroy function on every element's data.
-
-Since: 2.28
+Decrements the reference count of a #GIOChannel.
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a pointer to a #GList
-</parameter_description>
-</parameter>
-<parameter name="free_func">
-<parameter_description> the function to be called to free each element's data
+<parameter name="channel">
+<parameter_description> a #GIOChannel
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_list_index">
+<function name="g_io_channel_win32_new_fd">
<description>
-Gets the position of the element containing
-the given data (starting from 0).
+Creates a new #GIOChannel given a file descriptor on Windows. This
+works for file descriptors from the C runtime.
+
+This function works for file descriptors as returned by the open(),
+creat(), pipe() and fileno() calls in the Microsoft C runtime. In
+order to meaningfully use this function your code should use the
+same C runtime as GLib uses, which is msvcrt.dll. Note that in
+current Microsoft compilers it is near impossible to convince it to
+build code that would use msvcrt.dll. The last Microsoft compiler
+version that supported using msvcrt.dll as the C runtime was version
+6. The GNU compiler and toolchain for Windows, also known as Mingw,
+fully supports msvcrt.dll.
+If you have created a #GIOChannel for a file descriptor and started
+watching (polling) it, you shouldn't call read() on the file
+descriptor. This is because adding polling for a file descriptor is
+implemented in GLib on Windows by starting a thread that sits
+blocked in a read() from the file descriptor most of the time. All
+reads from the file descriptor should be done by this internal GLib
+thread. Your code should call only g_io_channel_read().
+
+This function is available only in GLib on Windows.
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GList
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> the data to find
+<parameter name="fd">
+<parameter_description> a C library file descriptor.
</parameter_description>
</parameter>
</parameters>
-<return> the index of the element containing the data,
-or -1 if the data is not found
+<return> a new #GIOChannel.
</return>
</function>
-<function name="g_list_insert">
+<function name="g_io_channel_win32_new_messages">
<description>
-Inserts a new element into the list at the given position.
+Creates a new #GIOChannel given a window handle on Windows.
+This function creates a #GIOChannel that can be used to poll for
+Windows messages for the window in question.
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a pointer to a #GList
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> the data for the new element
-</parameter_description>
-</parameter>
-<parameter name="position">
-<parameter_description> the position to insert the element. If this is
-negative, or is larger than the number of elements in the
-list, the new element is added on to the end of the list.
+<parameter name="hwnd">
+<parameter_description> a window handle.
</parameter_description>
</parameter>
</parameters>
-<return> the new start of the #GList
+<return> a new #GIOChannel.
</return>
</function>
-<function name="g_list_insert_before">
+<function name="g_io_channel_win32_new_socket">
<description>
-Inserts a new element into the list before the given position.
+Creates a new #GIOChannel given a socket on Windows.
+
+This function works for sockets created by Winsock. It's available
+only in GLib on Windows.
+Polling a #GSource created to watch a channel for a socket puts the
+socket in non-blocking mode. This is a side-effect of the
+implementation and unavoidable.
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a pointer to a #GList
-</parameter_description>
-</parameter>
-<parameter name="sibling">
-<parameter_description> the list element before which the new element
-is inserted or %NULL to insert at the end of the list
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> the data for the new element
+<parameter name="socket">
+<parameter_description> a Winsock socket
</parameter_description>
</parameter>
</parameters>
-<return> the new start of the #GList
+<return> a new #GIOChannel
</return>
</function>
-<function name="g_list_insert_sorted">
+<function name="g_io_channel_write">
<description>
-Inserts a new element into the list, using the given comparison
-function to determine its position.
+Writes data to a #GIOChannel.
+Deprecated:2.2: Use g_io_channel_write_chars() instead.
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a pointer to a #GList
+<parameter name="channel">
+<parameter_description> a #GIOChannel
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> the data for the new element
+<parameter name="buf">
+<parameter_description> the buffer containing the data to write
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> the function to compare elements in the list. It should
-return a number > 0 if the first parameter comes after the
-second parameter in the sort order.
+<parameter name="count">
+<parameter_description> the number of bytes to write
+</parameter_description>
+</parameter>
+<parameter name="bytes_written">
+<parameter_description> the number of bytes actually written
</parameter_description>
</parameter>
</parameters>
-<return> the new start of the #GList
+<return> %G_IO_ERROR_NONE if the operation was successful.
+
</return>
</function>
-<function name="g_list_insert_sorted_with_data">
+<function name="g_io_channel_write_chars">
<description>
-Inserts a new element into the list, using the given comparison
-function to determine its position.
+Replacement for g_io_channel_write() with the new API.
+
+On seekable channels with encodings other than %NULL or UTF-8, generic
+mixing of reading and writing is not allowed. A call to g_io_channel_write_chars ()
+may only be made on a channel from which data has been read in the
+cases described in the documentation for g_io_channel_set_encoding ().
-Since: 2.10
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a pointer to a #GList
+<parameter name="channel">
+<parameter_description> a #GIOChannel
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> the data for the new element
+<parameter name="buf">
+<parameter_description> a buffer to write data from
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> the function to compare elements in the list.
-It should return a number > 0 if the first parameter
-comes after the second parameter in the sort order.
+<parameter name="count">
+<parameter_description> the size of the buffer. If -1, the buffer
+is taken to be a nul-terminated string.
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> user data to pass to comparison function.
+<parameter name="bytes_written">
+<parameter_description> The number of bytes written. This can be nonzero
+even if the return value is not %G_IO_STATUS_NORMAL.
+If the return value is %G_IO_STATUS_NORMAL and the
+channel is blocking, this will always be equal
+to @count if @count >= 0.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a location to return an error of type #GConvertError
+or #GIOChannelError
</parameter_description>
</parameter>
</parameters>
-<return> the new start of the #GList
-
+<return> the status of the operation.
</return>
</function>
-<function name="g_list_last">
+<function name="g_io_channel_write_unichar">
<description>
-Gets the last element in a #GList.
+Writes a Unicode character to @channel.
+This function cannot be called on a channel with %NULL encoding.
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GList
+<parameter name="channel">
+<parameter_description> a #GIOChannel
+</parameter_description>
+</parameter>
+<parameter name="thechar">
+<parameter_description> a character
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> location to return an error of type #GConvertError
+or #GIOChannelError
</parameter_description>
</parameter>
</parameters>
-<return> the last element in the #GList,
-or %NULL if the #GList has no elements
+<return> a #GIOStatus
</return>
</function>
-<function name="g_list_length">
+<function name="g_io_create_watch">
<description>
-Gets the number of elements in a #GList.
+Creates a #GSource that's dispatched when @condition is met for the
+given @channel. For example, if condition is #G_IO_IN, the source will
+be dispatched when there's data available for reading.
-<note><para>
-This function iterates over the whole list to
-count its elements.
-</para></note>
+g_io_add_watch() is a simpler interface to this same functionality, for
+the case where you want to add the source to the default main loop context
+at the default priority.
+
+On Windows, polling a #GSource created to watch a channel for a socket
+puts the socket in non-blocking mode. This is a side-effect of the
+implementation and unavoidable.
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GList
+<parameter name="channel">
+<parameter_description> a #GIOChannel to watch
+</parameter_description>
+</parameter>
+<parameter name="condition">
+<parameter_description> conditions to watch for
</parameter_description>
</parameter>
</parameters>
-<return> the number of elements in the #GList
+<return> a new #GSource
</return>
</function>
-<function name="g_list_next">
+<function name="g_key_file_free">
<description>
-A convenience macro to get the next element in a #GList.
+Frees a #GKeyFile.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="list">
-<parameter_description> an element in a #GList.
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
</parameter_description>
</parameter>
</parameters>
-<return> the next element, or %NULL if there are no more elements.
-</return>
+<return></return>
</function>
-<function name="g_list_nth">
+<function name="g_key_file_get_boolean">
<description>
-Gets the element at the given position in a #GList.
+Returns the value associated with @key under @group_name as a
+boolean.
+
+If @key cannot be found then %FALSE is returned and @error is set
+to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the value
+associated with @key cannot be interpreted as a boolean then %FALSE
+is returned and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE.
+Since: 2.6
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GList
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
</parameter_description>
</parameter>
-<parameter name="n">
-<parameter_description> the position of the element, counting from 0
+<parameter name="group_name">
+<parameter_description> a group name
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a key
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError
</parameter_description>
</parameter>
</parameters>
-<return> the element, or %NULL if the position is off
-the end of the #GList
+<return> the value associated with the key as a boolean,
+or %FALSE if the key was not found or could not be parsed.
+
</return>
</function>
-<function name="g_list_nth_data">
+<function name="g_key_file_get_boolean_list">
<description>
-Gets the data of the element at the given position.
+Returns the values associated with @key under @group_name as
+booleans.
+
+If @key cannot be found then %NULL is returned and @error is set to
+#G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the values associated
+with @key cannot be interpreted as booleans then %NULL is returned
+and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE.
+Since: 2.6
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GList
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
</parameter_description>
</parameter>
-<parameter name="n">
-<parameter_description> the position of the element
+<parameter name="group_name">
+<parameter_description> a group name
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a key
+</parameter_description>
+</parameter>
+<parameter name="length">
+<parameter_description> the number of booleans returned
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError
</parameter_description>
</parameter>
</parameters>
-<return> the element's data, or %NULL if the position
-is off the end of the #GList
+<return> the values associated with the key as a list of
+booleans, or %NULL if the key was not found or could not be parsed.
+
</return>
</function>
-<function name="g_list_nth_prev">
+<function name="g_key_file_get_comment">
<description>
-Gets the element @n places before @list.
+Retrieves a comment above @key from @group_name.
+If @key is %NULL then @comment will be read from above
+ group_name If both @key and @group_name are %NULL, then
+ comment will be read from above the first group in the file.
+Since: 2.6
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GList
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
</parameter_description>
</parameter>
-<parameter name="n">
-<parameter_description> the position of the element, counting from 0
+<parameter name="group_name">
+<parameter_description> a group name, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a key
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError
</parameter_description>
</parameter>
</parameters>
-<return> the element, or %NULL if the position is
-off the end of the #GList
+<return> a comment that should be freed with g_free()
+
</return>
</function>
-<function name="g_list_pop_allocator">
+<function name="g_key_file_get_double">
<description>
-Restores the previous #GAllocator, used when allocating #GList
-elements.
-
-Note that this function is not available if GLib has been compiled
-with <option>--disable-mem-pools</option>
-
-Deprecated:2.10: It does nothing, since #GList has been converted
-to the <link linkend="glib-Memory-Slices">slice
-allocator</link>
-
-</description>
-<parameters>
-</parameters>
-<return></return>
-</function>
+Returns the value associated with @key under @group_name as a
+double. If @group_name is %NULL, the start_group is used.
-<function name="g_list_position">
-<description>
-Gets the position of the given element
-in the #GList (starting from 0).
+If @key cannot be found then 0.0 is returned and @error is set to
+#G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the value associated
+with @key cannot be interpreted as a double then 0.0 is returned
+and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE.
+Since: 2.12
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GList
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
</parameter_description>
</parameter>
-<parameter name="llink">
-<parameter_description> an element in the #GList
+<parameter name="group_name">
+<parameter_description> a group name
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a key
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError
</parameter_description>
</parameter>
</parameters>
-<return> the position of the element in the #GList,
-or -1 if the element is not found
+<return> the value associated with the key as a double, or
+0.0 if the key was not found or could not be parsed.
+
</return>
</function>
-<function name="g_list_prepend">
+<function name="g_key_file_get_double_list">
<description>
-Adds a new element on to the start of the list.
-
-<note><para>
-The return value is the new start of the list, which
-may have changed, so make sure you store the new value.
-</para></note>
+Returns the values associated with @key under @group_name as
+doubles.
-|[
-/ * Notice that it is initialized to the empty list. * /
-GList *list = NULL;
-list = g_list_prepend (list, "last");
-list = g_list_prepend (list, "first");
-]|
+If @key cannot be found then %NULL is returned and @error is set to
+#G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the values associated
+with @key cannot be interpreted as doubles then %NULL is returned
+and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE.
+Since: 2.12
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a pointer to a #GList
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> the data for the new element
+<parameter name="group_name">
+<parameter_description> a group name
</parameter_description>
</parameter>
-</parameters>
-<return> the new start of the #GList
-</return>
-</function>
-
-<function name="g_list_previous">
-<description>
-A convenience macro to get the previous element in a #GList.
-
-</description>
-<parameters>
-<parameter name="list">
-<parameter_description> an element in a #GList.
+<parameter name="key">
+<parameter_description> a key
+</parameter_description>
+</parameter>
+<parameter name="length">
+<parameter_description> the number of doubles returned
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError
</parameter_description>
</parameter>
</parameters>
-<return> the previous element, or %NULL if there are no previous
-elements.
+<return> the values associated with the key as a list of
+doubles, or %NULL if the key was not found or could not be parsed.
+
</return>
</function>
-<function name="g_list_push_allocator">
+<function name="g_key_file_get_groups">
<description>
-Sets the allocator to use to allocate #GList elements. Use
-g_list_pop_allocator() to restore the previous allocator.
-
-Note that this function is not available if GLib has been compiled
-with <option>--disable-mem-pools</option>
+Returns all groups in the key file loaded with @key_file.
+The array of returned groups will be %NULL-terminated, so
+ length may optionally be %NULL.
-Deprecated:2.10: It does nothing, since #GList has been converted
-to the <link linkend="glib-Memory-Slices">slice
-allocator</link>
+Since: 2.6
</description>
<parameters>
-<parameter name="allocator">
-<parameter_description> the #GAllocator to use when allocating #GList elements.
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
+</parameter_description>
+</parameter>
+<parameter name="length">
+<parameter_description> return location for the number of returned groups, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a newly-allocated %NULL-terminated array of strings.
+Use g_strfreev() to free it.
+</return>
</function>
-<function name="g_list_remove">
+<function name="g_key_file_get_int64">
<description>
-Removes an element from a #GList.
-If two elements contain the same data, only the first is removed.
-If none of the elements contain the data, the #GList is unchanged.
+Returns the value associated with @key under @group_name as a signed
+64-bit integer. This is similar to g_key_file_get_integer() but can return
+64-bit results without truncation.
+Since: 2.26
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GList
+<parameter name="key_file">
+<parameter_description> a non-%NULL #GKeyFile
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> the data of the element to remove
+<parameter name="group_name">
+<parameter_description> a non-%NULL group name
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a non-%NULL key
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError
</parameter_description>
</parameter>
</parameters>
-<return> the new start of the #GList
+<return> the value associated with the key as a signed 64-bit integer, or
+0 if the key was not found or could not be parsed.
+
</return>
</function>
-<function name="g_list_remove_all">
+<function name="g_key_file_get_integer">
<description>
-Removes all list nodes with data equal to @data.
-Returns the new head of the list. Contrast with
-g_list_remove() which removes only the first node
-matching the given data.
+Returns the value associated with @key under @group_name as an
+integer.
+
+If @key cannot be found then 0 is returned and @error is set to
+#G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the value associated
+with @key cannot be interpreted as an integer then 0 is returned
+and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE.
+Since: 2.6
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GList
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> data to remove
+<parameter name="group_name">
+<parameter_description> a group name
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a key
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError
</parameter_description>
</parameter>
</parameters>
-<return> new head of @list
+<return> the value associated with the key as an integer, or
+0 if the key was not found or could not be parsed.
+
</return>
</function>
-<function name="g_list_remove_link">
+<function name="g_key_file_get_integer_list">
<description>
-Removes an element from a #GList, without freeing the element.
-The removed element's prev and next links are set to %NULL, so
-that it becomes a self-contained list with one element.
+Returns the values associated with @key under @group_name as
+integers.
+
+If @key cannot be found then %NULL is returned and @error is set to
+#G_KEY_FILE_ERROR_KEY_NOT_FOUND. Likewise, if the values associated
+with @key cannot be interpreted as integers then %NULL is returned
+and @error is set to #G_KEY_FILE_ERROR_INVALID_VALUE.
+Since: 2.6
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GList
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
</parameter_description>
</parameter>
-<parameter name="llink">
-<parameter_description> an element in the #GList
+<parameter name="group_name">
+<parameter_description> a group name
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a key
+</parameter_description>
+</parameter>
+<parameter name="length">
+<parameter_description> the number of integers returned
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError
</parameter_description>
</parameter>
</parameters>
-<return> the new start of the #GList, without the element
+<return> the values associated with the key as a list of
+integers, or %NULL if the key was not found or could not be parsed.
+
</return>
</function>
-<function name="g_list_reverse">
+<function name="g_key_file_get_keys">
<description>
-Reverses a #GList.
-It simply switches the next and prev pointers of each element.
+Returns all keys for the group name @group_name. The array of
+returned keys will be %NULL-terminated, so @length may
+optionally be %NULL. In the event that the @group_name cannot
+be found, %NULL is returned and @error is set to
+#G_KEY_FILE_ERROR_GROUP_NOT_FOUND.
+Since: 2.6
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GList
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
+</parameter_description>
+</parameter>
+<parameter name="group_name">
+<parameter_description> a group name
+</parameter_description>
+</parameter>
+<parameter name="length">
+<parameter_description> return location for the number of keys returned, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the start of the reversed #GList
+<return> a newly-allocated %NULL-terminated array of strings.
+Use g_strfreev() to free it.
+
</return>
</function>
-<function name="g_list_sort">
+<function name="g_key_file_get_locale_string">
<description>
-Sorts a #GList using the given comparison function.
+Returns the value associated with @key under @group_name
+translated in the given @locale if available. If @locale is
+%NULL then the current locale is assumed.
+
+If @key cannot be found then %NULL is returned and @error is set
+to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. If the value associated
+with @key cannot be interpreted or no suitable translation can
+be found then the untranslated value is returned.
+Since: 2.6
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GList
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
</parameter_description>
</parameter>
-<parameter name="compare_func">
-<parameter_description> the comparison function used to sort the #GList.
-This function is passed the data from 2 elements of the #GList
-and should return 0 if they are equal, a negative value if the
-first element comes before the second, or a positive value if
-the first element comes after the second.
+<parameter name="group_name">
+<parameter_description> a group name
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a key
+</parameter_description>
+</parameter>
+<parameter name="locale">
+<parameter_description> a locale identifier or %NULL
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the start of the sorted #GList
+<return> a newly allocated string or %NULL if the specified
+key cannot be found.
+
</return>
</function>
-<function name="g_list_sort_with_data">
+<function name="g_key_file_get_locale_string_list">
<description>
-Like g_list_sort(), but the comparison function accepts
-a user data argument.
+Returns the values associated with @key under @group_name
+translated in the given @locale if available. If @locale is
+%NULL then the current locale is assumed.
+
+If @key cannot be found then %NULL is returned and @error is set
+to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. If the values associated
+with @key cannot be interpreted or no suitable translations
+can be found then the untranslated values are returned. The
+returned array is %NULL-terminated, so @length may optionally
+be %NULL.
+Since: 2.6
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GList
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
</parameter_description>
</parameter>
-<parameter name="compare_func">
-<parameter_description> comparison function
+<parameter name="group_name">
+<parameter_description> a group name
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> user data to pass to comparison function
+<parameter name="key">
+<parameter_description> a key
+</parameter_description>
+</parameter>
+<parameter name="locale">
+<parameter_description> a locale identifier or %NULL
+</parameter_description>
+</parameter>
+<parameter name="length">
+<parameter_description> return location for the number of returned strings or %NULL
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the new head of @list
+<return> a newly allocated %NULL-terminated string array
+or %NULL if the key isn't found. The string array should be freed
+with g_strfreev().
+
</return>
</function>
-<function name="g_listenv">
+<function name="g_key_file_get_start_group">
<description>
-Gets the names of all variables set in the environment.
+Returns the name of the start group of the file.
-Since: 2.8
+Since: 2.6
</description>
<parameters>
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
+</parameter_description>
+</parameter>
</parameters>
-<return> a %NULL-terminated list of strings which must be freed
-with g_strfreev().
-
-Programs that want to be portable to Windows should typically use
-this function and g_getenv() instead of using the environ array
-from the C library directly. On Windows, the strings in the environ
-array are in system codepage encoding, while in most of the typical
-use cases for environment variables in GLib-using programs you want
-the UTF-8 encoding that this function and g_getenv() provide.
+<return> The start group of the key file.
</return>
</function>
-<function name="g_locale_from_utf8">
+<function name="g_key_file_get_string">
<description>
-Converts a string from UTF-8 to the encoding used for strings by
-the C runtime (usually the same as that used by the operating
-system) in the <link linkend="setlocale">current locale</link>. On
-Windows this means the system codepage.
+Returns the string value associated with @key under @group_name.
+Unlike g_key_file_get_value(), this function handles escape sequences
+like \s.
+
+In the event the key cannot be found, %NULL is returned and
+ error is set to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. In the
+event that the @group_name cannot be found, %NULL is returned
+and @error is set to #G_KEY_FILE_ERROR_GROUP_NOT_FOUND.
+Since: 2.6
</description>
<parameters>
-<parameter name="utf8string">
-<parameter_description> a UTF-8 encoded string
-</parameter_description>
-</parameter>
-<parameter name="len">
-<parameter_description> the length of the string, or -1 if the string is
-nul-terminated<footnoteref linkend="nul-unsafe"/>.
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
</parameter_description>
</parameter>
-<parameter name="bytes_read">
-<parameter_description> location to store the number of bytes in the
-input string that were successfully converted, or %NULL.
-Even if the conversion was successful, this may be
-less than @len if there were partial characters
-at the end of the input. If the error
-#G_CONVERT_ERROR_ILLEGAL_SEQUENCE occurs, the value
-stored will the byte offset after the last valid
-input sequence.
+<parameter name="group_name">
+<parameter_description> a group name
</parameter_description>
</parameter>
-<parameter name="bytes_written">
-<parameter_description> the number of bytes stored in the output buffer (not
-including the terminating nul).
+<parameter name="key">
+<parameter_description> a key
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> location to store the error occuring, or %NULL to ignore
-errors. Any of the errors in #GConvertError may occur.
+<parameter_description> return location for a #GError, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> The converted string, or %NULL on an error.
+<return> a newly allocated string or %NULL if the specified
+key cannot be found.
+
</return>
</function>
-<function name="g_locale_to_utf8">
+<function name="g_key_file_get_string_list">
<description>
-Converts a string which is in the encoding used for strings by
-the C runtime (usually the same as that used by the operating
-system) in the <link linkend="setlocale">current locale</link> into a
-UTF-8 string.
+Returns the values associated with @key under @group_name.
+
+In the event the key cannot be found, %NULL is returned and
+ error is set to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. In the
+event that the @group_name cannot be found, %NULL is returned
+and @error is set to #G_KEY_FILE_ERROR_GROUP_NOT_FOUND.
+Since: 2.6
</description>
<parameters>
-<parameter name="opsysstring">
-<parameter_description> a string in the encoding of the current locale. On Windows
-this means the system codepage.
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
</parameter_description>
</parameter>
-<parameter name="len">
-<parameter_description> the length of the string, or -1 if the string is
-nul-terminated<footnoteref linkend="nul-unsafe"/>.
+<parameter name="group_name">
+<parameter_description> a group name
</parameter_description>
</parameter>
-<parameter name="bytes_read">
-<parameter_description> location to store the number of bytes in the
-input string that were successfully converted, or %NULL.
-Even if the conversion was successful, this may be
-less than @len if there were partial characters
-at the end of the input. If the error
-#G_CONVERT_ERROR_ILLEGAL_SEQUENCE occurs, the value
-stored will the byte offset after the last valid
-input sequence.
+<parameter name="key">
+<parameter_description> a key
</parameter_description>
</parameter>
-<parameter name="bytes_written">
-<parameter_description> the number of bytes stored in the output buffer (not
-including the terminating nul).
+<parameter name="length">
+<parameter_description> return location for the number of returned strings, or %NULL
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> location to store the error occuring, or %NULL to ignore
-errors. Any of the errors in #GConvertError may occur.
+<parameter_description> return location for a #GError, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> The converted string, or %NULL on an error.
+<return>
+a %NULL-terminated string array or %NULL if the specified
+key cannot be found. The array should be freed with g_strfreev().
+
</return>
</function>
-<function name="g_lstat">
+<function name="g_key_file_get_uint64">
<description>
-A wrapper for the POSIX lstat() function. The lstat() function is
-like stat() except that in the case of symbolic links, it returns
-information about the symbolic link itself and not the file that it
-refers to. If the system does not support symbolic links g_lstat()
-is identical to g_stat().
-
-See your C library manual for more details about lstat().
+Returns the value associated with @key under @group_name as an unsigned
+64-bit integer. This is similar to g_key_file_get_integer() but can return
+large positive results without truncation.
-Since: 2.6
+Since: 2.26
</description>
<parameters>
-<parameter name="filename">
-<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows)
+<parameter name="key_file">
+<parameter_description> a non-%NULL #GKeyFile
</parameter_description>
</parameter>
-<parameter name="buf">
-<parameter_description> a pointer to a <structname>stat</structname> struct, which
-will be filled with the file information
+<parameter name="group_name">
+<parameter_description> a non-%NULL group name
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a non-%NULL key
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError
</parameter_description>
</parameter>
</parameters>
-<return> 0 if the information was successfully retrieved, -1 if an error
-occurred
+<return> the value associated with the key as an unsigned 64-bit integer,
+or 0 if the key was not found or could not be parsed.
</return>
</function>
-<function name="g_main_context_acquire">
+<function name="g_key_file_get_value">
<description>
-Tries to become the owner of the specified context.
-If some other thread is the owner of the context,
-returns %FALSE immediately. Ownership is properly
-recursive: the owner can require ownership again
-and will release ownership when g_main_context_release()
-is called as many times as g_main_context_acquire().
+Returns the raw value associated with @key under @group_name.
+Use g_key_file_get_string() to retrieve an unescaped UTF-8 string.
+
+In the event the key cannot be found, %NULL is returned and
+ error is set to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. In the
+event that the @group_name cannot be found, %NULL is returned
+and @error is set to #G_KEY_FILE_ERROR_GROUP_NOT_FOUND.
-You must be the owner of a context before you
-can call g_main_context_prepare(), g_main_context_query(),
-g_main_context_check(), g_main_context_dispatch().
+Since: 2.6
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GMainContext
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
+</parameter_description>
+</parameter>
+<parameter name="group_name">
+<parameter_description> a group name
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a key
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the operation succeeded, and
-this thread is now the owner of @context.
+<return> a newly allocated string or %NULL if the specified
+key cannot be found.
+
</return>
</function>
-<function name="g_main_context_add_poll">
+<function name="g_key_file_has_group">
<description>
-Adds a file descriptor to the set of file descriptors polled for
-this context. This will very seldomly be used directly. Instead
-a typical event source will use g_source_add_poll() instead.
+Looks whether the key file has the group @group_name.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GMainContext (or %NULL for the default context)
-</parameter_description>
-</parameter>
-<parameter name="fd">
-<parameter_description> a #GPollFD structure holding information about a file
-descriptor to watch.
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
</parameter_description>
</parameter>
-<parameter name="priority">
-<parameter_description> the priority for this file descriptor which should be
-the same as the priority used for g_source_attach() to ensure that the
-file descriptor is polled whenever the results may be needed.
+<parameter name="group_name">
+<parameter_description> a group name
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @group_name is a part of @key_file, %FALSE
+otherwise.
+</return>
</function>
-<function name="g_main_context_check">
+<function name="g_key_file_has_key">
<description>
-Passes the results of polling back to the main loop.
+Looks whether the key file has the key @key in the group
+ group_name
+
+<note>This function does not follow the rules for #GError strictly;
+the return value both carries meaning and signals an error. To use
+this function, you must pass a #GError pointer in @error, and check
+whether it is not %NULL to see if an error occurred.</note>
+See g_key_file_has_key_full() for a replacement function which does
+follow the #GError rules.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GMainContext
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
</parameter_description>
</parameter>
-<parameter name="max_priority">
-<parameter_description> the maximum numerical priority of sources to check
+<parameter name="group_name">
+<parameter_description> a group name
</parameter_description>
</parameter>
-<parameter name="fds">
-<parameter_description> array of #GPollFD's that was passed to the last call to
-g_main_context_query()
+<parameter name="key">
+<parameter_description> a key name
</parameter_description>
</parameter>
-<parameter name="n_fds">
-<parameter_description> return value of g_main_context_query()
+<parameter name="error">
+<parameter_description> return location for a #GError
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if some sources are ready to be dispatched.
+<return> %TRUE if @key is a part of @group_name, %FALSE
+otherwise.
+
</return>
</function>
-<function name="g_main_context_default">
+<function name="g_key_file_has_key_full">
<description>
-Returns the global default main context. This is the main context
-used for main loop functions when a main loop is not explicitly
-specified, and corresponds to the "main" main loop. See also
-g_main_context_get_thread_default().
-
+Looks whether the key file has the key @key in the group
+ group_name
-</description>
-<parameters>
-</parameters>
-<return> the global default main context.
-</return>
-</function>
+Since: 2.30
-<function name="g_main_context_dispatch">
-<description>
-Dispatches all pending sources.
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GMainContext
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
+</parameter_description>
+</parameter>
+<parameter name="group_name">
+<parameter_description> a group name
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a key name
+</parameter_description>
+</parameter>
+<parameter name="has_key">
+<parameter_description> Return location for whether or not key exists
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if a group with the name @group_name
+exists. Otherwise, @error is set and %FALSE is returned.
+
+</return>
</function>
-<function name="g_main_context_find_source_by_funcs_user_data">
+<function name="g_key_file_load_from_data">
<description>
-Finds a source with the given source functions and user data. If
-multiple sources exist with the same source function and user data,
-the first one found will be returned.
+Loads a key file from memory into an empty #GKeyFile structure.
+If the object cannot be created then %error is set to a #GKeyFileError.
+Since: 2.6
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GMainContext (if %NULL, the default context will be used).
+<parameter name="key_file">
+<parameter_description> an empty #GKeyFile struct
</parameter_description>
</parameter>
-<parameter name="funcs">
-<parameter_description> the @source_funcs passed to g_source_new().
+<parameter name="data">
+<parameter_description> key file loaded in memory
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> the user data from the callback.
+<parameter name="length">
+<parameter_description> the length of @data in bytes
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> flags from #GKeyFileFlags
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the source, if one was found, otherwise %NULL
+<return> %TRUE if a key file could be loaded, %FALSE otherwise
+
</return>
</function>
-<function name="g_main_context_find_source_by_id">
+<function name="g_key_file_load_from_data_dirs">
<description>
-Finds a #GSource given a pair of context and ID.
+This function looks for a key file named @file in the paths
+returned from g_get_user_data_dir() and g_get_system_data_dirs(),
+loads the file into @key_file and returns the file's full path in
+ full_path If the file could not be loaded then an %error is
+set to either a #GFileError or #GKeyFileError.
+Since: 2.6
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GMainContext (if %NULL, the default context will be used)
+<parameter name="key_file">
+<parameter_description> an empty #GKeyFile struct
</parameter_description>
</parameter>
-<parameter name="source_id">
-<parameter_description> the source ID, as returned by g_source_get_id().
+<parameter name="file">
+<parameter_description> a relative path to a filename to open and parse
+</parameter_description>
+</parameter>
+<parameter name="full_path">
+<parameter_description> return location for a string containing the full path
+of the file, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> flags from #GKeyFileFlags
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the #GSource if found, otherwise, %NULL
+<return> %TRUE if a key file could be loaded, %FALSE othewise
</return>
</function>
-<function name="g_main_context_find_source_by_user_data">
+<function name="g_key_file_load_from_dirs">
<description>
-Finds a source with the given user data for the callback. If
-multiple sources exist with the same user data, the first
-one found will be returned.
+This function looks for a key file named @file in the paths
+specified in @search_dirs, loads the file into @key_file and
+returns the file's full path in @full_path. If the file could not
+be loaded then an %error is set to either a #GFileError or
+#GKeyFileError.
+Since: 2.14
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GMainContext
+<parameter name="key_file">
+<parameter_description> an empty #GKeyFile struct
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> the user_data for the callback.
+<parameter name="file">
+<parameter_description> a relative path to a filename to open and parse
+</parameter_description>
+</parameter>
+<parameter name="search_dirs">
+<parameter_description> %NULL-terminated array of directories to search
+</parameter_description>
+</parameter>
+<parameter name="full_path">
+<parameter_description> return location for a string containing the full path
+of the file, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> flags from #GKeyFileFlags
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the source, if one was found, otherwise %NULL
+<return> %TRUE if a key file could be loaded, %FALSE otherwise
+
</return>
</function>
-<function name="g_main_context_get_poll_func">
+<function name="g_key_file_load_from_file">
<description>
-Gets the poll function set by g_main_context_set_poll_func().
+Loads a key file into an empty #GKeyFile structure.
+If the file could not be loaded then %error is set to
+either a #GFileError or #GKeyFileError.
+Since: 2.6
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GMainContext
+<parameter name="key_file">
+<parameter_description> an empty #GKeyFile struct
+</parameter_description>
+</parameter>
+<parameter name="file">
+<parameter_description> the path of a filename to load, in the GLib filename encoding
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> flags from #GKeyFileFlags
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the poll function
+<return> %TRUE if a key file could be loaded, %FALSE otherwise
+
</return>
</function>
-<function name="g_main_context_get_thread_default">
+<function name="g_key_file_new">
<description>
-Gets the thread-default #GMainContext for this thread. Asynchronous
-operations that want to be able to be run in contexts other than
-the default one should call this method to get a #GMainContext to
-add their #GSource<!-- -->s to. (Note that even in single-threaded
-programs applications may sometimes want to temporarily push a
-non-default context, so it is not safe to assume that this will
-always return %NULL if threads are not initialized.)
+Creates a new empty #GKeyFile object. Use
+g_key_file_load_from_file(), g_key_file_load_from_data(),
+g_key_file_load_from_dirs() or g_key_file_load_from_data_dirs() to
+read an existing key file.
-Since: 2.22
+Since: 2.6
</description>
<parameters>
</parameters>
-<return> the thread-default #GMainContext, or %NULL if the
-thread-default context is the global default context.
+<return> an empty #GKeyFile.
</return>
</function>
-<function name="g_main_context_invoke">
+<function name="g_key_file_remove_comment">
<description>
-Invokes a function in such a way that @context is owned during the
-invocation of @function.
-
-If @context is %NULL then the global default main context â as
-returned by g_main_context_default() â is used.
-
-If @context is owned by the current thread, @function is called
-directly. Otherwise, if @context is the thread-default main context
-of the current thread and g_main_context_acquire() succeeds, then
- function is called and g_main_context_release() is called
-afterwards.
-
-In any other case, an idle source is created to call @function and
-that source is attached to @context (presumably to be run in another
-thread). The idle source is attached with #G_PRIORITY_DEFAULT
-priority. If you want a different priority, use
-g_main_context_invoke_full().
-
-Note that, as with normal idle functions, @function should probably
-return %FALSE. If it returns %TRUE, it will be continuously run in a
-loop (and may prevent this call from returning).
+Removes a comment above @key from @group_name.
+If @key is %NULL then @comment will be removed above @group_name.
+If both @key and @group_name are %NULL, then @comment will
+be removed above the first group in the file.
-Since: 2.28
+Since: 2.6
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GMainContext, or %NULL
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
</parameter_description>
</parameter>
-<parameter name="function">
-<parameter_description> function to call
+<parameter name="group_name">
+<parameter_description> a group name, or %NULL
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> data to pass to @function
+<parameter name="key">
+<parameter_description> a key
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the comment was removed, %FALSE otherwise
+
+</return>
</function>
-<function name="g_main_context_invoke_full">
+<function name="g_key_file_remove_group">
<description>
-Invokes a function in such a way that @context is owned during the
-invocation of @function.
-
-This function is the same as g_main_context_invoke() except that it
-lets you specify the priority incase @function ends up being
-scheduled as an idle and also lets you give a #GDestroyNotify for @data.
-
- notify should not assume that it is called from any particular
-thread or with any particular context acquired.
+Removes the specified group, @group_name,
+from the key file.
-Since: 2.28
+Since: 2.6
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GMainContext, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="priority">
-<parameter_description> the priority at which to run @function
-</parameter_description>
-</parameter>
-<parameter name="function">
-<parameter_description> function to call
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> data to pass to @function
+<parameter name="group_name">
+<parameter_description> a group name
</parameter_description>
</parameter>
-<parameter name="notify">
-<parameter_description> a function to call when @data is no longer in use, or %NULL.
+<parameter name="error">
+<parameter_description> return location for a #GError or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the group was removed, %FALSE otherwise
+
+</return>
</function>
-<function name="g_main_context_is_owner">
+<function name="g_key_file_remove_key">
<description>
-Determines whether this thread holds the (recursive)
-ownership of this #GMaincontext. This is useful to
-know before waiting on another thread that may be
-blocking to get ownership of @context.
+Removes @key in @group_name from the key file.
-Since: 2.10
+Since: 2.6
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GMainContext
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
+</parameter_description>
+</parameter>
+<parameter name="group_name">
+<parameter_description> a group name
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a key name to remove
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if current thread is owner of @context.
+<return> %TRUE if the key was removed, %FALSE otherwise
</return>
</function>
-<function name="g_main_context_iteration">
+<function name="g_key_file_set_boolean">
<description>
-Runs a single iteration for the given main loop. This involves
-checking to see if any event sources are ready to be processed,
-then if no events sources are ready and @may_block is %TRUE, waiting
-for a source to become ready, then dispatching the highest priority
-events sources that are ready. Otherwise, if @may_block is %FALSE
-sources are not waited to become ready, only those highest priority
-events sources will be dispatched (if any), that are ready at this
-given moment without further waiting.
-
-Note that even when @may_block is %TRUE, it is still possible for
-g_main_context_iteration() to return %FALSE, since the the wait may
-be interrupted for other reasons than an event source becoming ready.
+Associates a new boolean value with @key under @group_name.
+If @key cannot be found then it is created.
+Since: 2.6
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GMainContext (if %NULL, the default context will be used)
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
</parameter_description>
</parameter>
-<parameter name="may_block">
-<parameter_description> whether the call may block.
+<parameter name="group_name">
+<parameter_description> a group name
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a key
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> %TRUE or %FALSE
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if events were dispatched.
-</return>
+<return></return>
</function>
-<function name="g_main_context_new">
+<function name="g_key_file_set_boolean_list">
<description>
-Creates a new #GMainContext structure.
+Associates a list of boolean values with @key under @group_name.
+If @key cannot be found then it is created.
+If @group_name is %NULL, the start_group is used.
+Since: 2.6
</description>
<parameters>
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
+</parameter_description>
+</parameter>
+<parameter name="group_name">
+<parameter_description> a group name
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a key
+</parameter_description>
+</parameter>
+<parameter name="list">
+<parameter_description> an array of boolean values
+</parameter_description>
+</parameter>
+<parameter name="length">
+<parameter_description> length of @list
+</parameter_description>
+</parameter>
</parameters>
-<return> the new #GMainContext
-</return>
+<return></return>
</function>
-<function name="g_main_context_pending">
+<function name="g_key_file_set_comment">
<description>
-Checks if any sources have pending events for the given context.
+Places a comment above @key from @group_name.
+If @key is %NULL then @comment will be written above @group_name.
+If both @key and @group_name are %NULL, then @comment will be
+written above the first group in the file.
+Since: 2.6
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GMainContext (if %NULL, the default context will be used)
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
</parameter_description>
</parameter>
-</parameters>
-<return> %TRUE if events are pending.
-</return>
-</function>
-
-<function name="g_main_context_pop_thread_default">
-<description>
-Pops @context off the thread-default context stack (verifying that
-it was on the top of the stack).
+<parameter name="group_name">
+<parameter_description> a group name, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a key
+</parameter_description>
+</parameter>
+<parameter name="comment">
+<parameter_description> a comment
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the comment was written, %FALSE otherwise
-Since: 2.22
+</return>
+</function>
+
+<function name="g_key_file_set_double">
+<description>
+Associates a new double value with @key under @group_name.
+If @key cannot be found then it is created.
+
+Since: 2.12
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GMainContext object, or %NULL
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
+</parameter_description>
+</parameter>
+<parameter name="group_name">
+<parameter_description> a group name
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a key
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> an double value
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_main_context_prepare">
+<function name="g_key_file_set_double_list">
<description>
-Prepares to poll sources within a main loop. The resulting information
-for polling is determined by calling g_main_context_query ().
+Associates a list of double values with @key under
+ group_name If @key cannot be found then it is created.
+Since: 2.12
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GMainContext
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
</parameter_description>
</parameter>
-<parameter name="priority">
-<parameter_description> location to store priority of highest priority
-source already ready.
+<parameter name="group_name">
+<parameter_description> a group name
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a key
+</parameter_description>
+</parameter>
+<parameter name="list">
+<parameter_description> an array of double values
+</parameter_description>
+</parameter>
+<parameter name="length">
+<parameter_description> number of double values in @list
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if some source is ready to be dispatched
-prior to polling.
-</return>
+<return></return>
</function>
-<function name="g_main_context_push_thread_default">
+<function name="g_key_file_set_int64">
<description>
-Acquires @context and sets it as the thread-default context for the
-current thread. This will cause certain asynchronous operations
-(such as most <link linkend="gio">gio</link>-based I/O) which are
-started in this thread to run under @context and deliver their
-results to its main loop, rather than running under the global
-default context in the main thread. Note that calling this function
-changes the context returned by
-g_main_context_get_thread_default(), <emphasis>not</emphasis> the
-one returned by g_main_context_default(), so it does not affect the
-context used by functions like g_idle_add().
+Associates a new integer value with @key under @group_name.
+If @key cannot be found then it is created.
-Normally you would call this function shortly after creating a new
-thread, passing it a #GMainContext which will be run by a
-#GMainLoop in that thread, to set a new default context for all
-async operations in that thread. (In this case, you don't need to
-ever call g_main_context_pop_thread_default().) In some cases
-however, you may want to schedule a single operation in a
-non-default context, or temporarily use a non-default context in
-the main thread. In that case, you can wrap the call to the
-asynchronous operation inside a
-g_main_context_push_thread_default() /
-g_main_context_pop_thread_default() pair, but it is up to you to
-ensure that no other asynchronous operations accidentally get
-started while the non-default context is active.
+Since: 2.26
-Beware that libraries that predate this function may not correctly
-handle being used from a thread with a thread-default context. Eg,
-see g_file_supports_thread_contexts().
+</description>
+<parameters>
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
+</parameter_description>
+</parameter>
+<parameter name="group_name">
+<parameter_description> a group name
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a key
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> an integer value
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
-Since: 2.22
+<function name="g_key_file_set_integer">
+<description>
+Associates a new integer value with @key under @group_name.
+If @key cannot be found then it is created.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GMainContext, or %NULL for the global default context
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
+</parameter_description>
+</parameter>
+<parameter name="group_name">
+<parameter_description> a group name
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a key
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> an integer value
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_main_context_query">
+<function name="g_key_file_set_integer_list">
<description>
-Determines information necessary to poll this main loop.
+Associates a list of integer values with @key under @group_name.
+If @key cannot be found then it is created.
+Since: 2.6
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GMainContext
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
</parameter_description>
</parameter>
-<parameter name="max_priority">
-<parameter_description> maximum priority source to check
+<parameter name="group_name">
+<parameter_description> a group name
</parameter_description>
</parameter>
-<parameter name="timeout_">
-<parameter_description> location to store timeout to be used in polling
+<parameter name="key">
+<parameter_description> a key
</parameter_description>
</parameter>
-<parameter name="fds">
-<parameter_description> location to store #GPollFD records that need to be polled.
+<parameter name="list">
+<parameter_description> an array of integer values
</parameter_description>
</parameter>
-<parameter name="n_fds">
-<parameter_description> length of @fds.
+<parameter name="length">
+<parameter_description> number of integer values in @list
</parameter_description>
</parameter>
</parameters>
-<return> the number of records actually stored in @fds,
-or, if more than @n_fds records need to be stored, the number
-of records that need to be stored.
-</return>
+<return></return>
</function>
-<function name="g_main_context_ref">
+<function name="g_key_file_set_list_separator">
<description>
-Increases the reference count on a #GMainContext object by one.
+Sets the character which is used to separate
+values in lists. Typically ';' or ',' are used
+as separators. The default list separator is ';'.
+Since: 2.6
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GMainContext
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
+</parameter_description>
+</parameter>
+<parameter name="separator">
+<parameter_description> the separator
</parameter_description>
</parameter>
</parameters>
-<return> the @context that was passed in (since 2.6)
-</return>
+<return></return>
</function>
-<function name="g_main_context_release">
+<function name="g_key_file_set_locale_string">
<description>
-Releases ownership of a context previously acquired by this thread
-with g_main_context_acquire(). If the context was acquired multiple
-times, the ownership will be released only when g_main_context_release()
-is called as many times as it was acquired.
+Associates a string value for @key and @locale under @group_name.
+If the translation for @key cannot be found then it is created.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GMainContext
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
+</parameter_description>
+</parameter>
+<parameter name="group_name">
+<parameter_description> a group name
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a key
+</parameter_description>
+</parameter>
+<parameter name="locale">
+<parameter_description> a locale identifier
+</parameter_description>
+</parameter>
+<parameter name="string">
+<parameter_description> a string
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_main_context_remove_poll">
+<function name="g_key_file_set_locale_string_list">
<description>
-Removes file descriptor from the set of file descriptors to be
-polled for a particular context.
+Associates a list of string values for @key and @locale under
+ group_name If the translation for @key cannot be found then
+it is created.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="context">
-<parameter_description>a #GMainContext
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
</parameter_description>
</parameter>
-<parameter name="fd">
-<parameter_description> a #GPollFD descriptor previously added with g_main_context_add_poll()
+<parameter name="group_name">
+<parameter_description> a group name
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a key
+</parameter_description>
+</parameter>
+<parameter name="locale">
+<parameter_description> a locale identifier
+</parameter_description>
+</parameter>
+<parameter name="list">
+<parameter_description> a %NULL-terminated array of locale string values
+</parameter_description>
+</parameter>
+<parameter name="length">
+<parameter_description> the length of @list
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_main_context_set_poll_func">
+<function name="g_key_file_set_string">
<description>
-Sets the function to use to handle polling of file descriptors. It
-will be used instead of the poll() system call
-(or GLib's replacement function, which is used where
-poll() isn't available).
+Associates a new string value with @key under @group_name.
+If @key cannot be found then it is created.
+If @group_name cannot be found then it is created.
+Unlike g_key_file_set_value(), this function handles characters
+that need escaping, such as newlines.
-This function could possibly be used to integrate the GLib event
-loop with an external event loop.
+Since: 2.6
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GMainContext
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> the function to call to poll all file descriptors
+<parameter name="group_name">
+<parameter_description> a group name
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a key
+</parameter_description>
+</parameter>
+<parameter name="string">
+<parameter_description> a string
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_main_context_unref">
+<function name="g_key_file_set_string_list">
<description>
-Decreases the reference count on a #GMainContext object by one. If
-the result is zero, free the context and free all associated memory.
+Associates a list of string values for @key under @group_name.
+If @key cannot be found then it is created.
+If @group_name cannot be found then it is created.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GMainContext
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
+</parameter_description>
+</parameter>
+<parameter name="group_name">
+<parameter_description> a group name
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a key
+</parameter_description>
+</parameter>
+<parameter name="list">
+<parameter_description> an array of string values
+</parameter_description>
+</parameter>
+<parameter name="length">
+<parameter_description> number of string values in @list
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_main_context_wait">
+<function name="g_key_file_set_uint64">
<description>
-Tries to become the owner of the specified context,
-as with g_main_context_acquire(). But if another thread
-is the owner, atomically drop @mutex and wait on @cond until
-that owner releases ownership or until @cond is signaled, then
-try again (once) to become the owner.
+Associates a new integer value with @key under @group_name.
+If @key cannot be found then it is created.
+Since: 2.26
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GMainContext
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
</parameter_description>
</parameter>
-<parameter name="cond">
-<parameter_description> a condition variable
+<parameter name="group_name">
+<parameter_description> a group name
</parameter_description>
</parameter>
-<parameter name="mutex">
-<parameter_description> a mutex, currently held
+<parameter name="key">
+<parameter_description> a key
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> an integer value
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the operation succeeded, and
-this thread is now the owner of @context.
-</return>
+<return></return>
</function>
-<function name="g_main_context_wakeup">
+<function name="g_key_file_set_value">
<description>
-If @context is currently waiting in a poll(), interrupt
-the poll(), and continue the iteration process.
+Associates a new value with @key under @group_name.
+
+If @key cannot be found then it is created. If @group_name cannot
+be found then it is created. To set an UTF-8 string which may contain
+characters that need escaping (such as newlines or spaces), use
+g_key_file_set_string().
+
+Since: 2.6
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GMainContext
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
+</parameter_description>
+</parameter>
+<parameter name="group_name">
+<parameter_description> a group name
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a key
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> a string
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_main_current_source">
+<function name="g_key_file_to_data">
<description>
-Returns the currently firing source for this thread.
+This function outputs @key_file as a string.
-Since: 2.12
+Note that this function never reports an error,
+so it is safe to pass %NULL as @error.
+
+Since: 2.6
</description>
<parameters>
+<parameter name="key_file">
+<parameter_description> a #GKeyFile
+</parameter_description>
+</parameter>
+<parameter name="length">
+<parameter_description> return location for the length of the
+returned string, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError, or %NULL
+</parameter_description>
+</parameter>
</parameters>
-<return> The currently firing source or %NULL.
+<return> a newly allocated string holding
+the contents of the #GKeyFile
</return>
</function>
-<function name="g_main_depth">
+<function name="g_list_alloc">
<description>
-Returns the depth of the stack of calls to
-g_main_context_dispatch() on any #GMainContext in the current thread.
-That is, when called from the toplevel, it gives 0. When
-called from within a callback from g_main_context_iteration()
-(or g_main_loop_run(), etc.) it returns 1. When called from within
-a callback to a recursive call to g_main_context_iterate(),
-it returns 2. And so forth.
+Allocates space for one #GList element. It is called by
+g_list_append(), g_list_prepend(), g_list_insert() and
+g_list_insert_sorted() and so is rarely used on its own.
-This function is useful in a situation like the following:
-Imagine an extremely simple "garbage collected" system.
+</description>
+<parameters>
+</parameters>
+<return> a pointer to the newly-allocated #GList element.
+</return>
+</function>
-|[
-static GList *free_list;
+<function name="g_list_append">
+<description>
+Adds a new element on to the end of the list.
-gpointer
-allocate_memory (gsize size)
-{
-gpointer result = g_malloc (size);
-free_list = g_list_prepend (free_list, result);
-return result;
-}
+<note><para>
+The return value is the new start of the list, which
+may have changed, so make sure you store the new value.
+</para></note>
-void
-free_allocated_memory (void)
-{
-GList *l;
-for (l = free_list; l; l = l->next);
-g_free (l->data);
-g_list_free (free_list);
-free_list = NULL;
-}
+<note><para>
+Note that g_list_append() has to traverse the entire list
+to find the end, which is inefficient when adding multiple
+elements. A common idiom to avoid the inefficiency is to prepend
+the elements and reverse the list when all elements have been added.
+</para></note>
-[...]
+|[
+/ * Notice that these are initialized to the empty list. * /
+GList *list = NULL, *number_list = NULL;
-while (TRUE);
-{
-g_main_context_iteration (NULL, TRUE);
-free_allocated_memory();
-}
+/ * This is a list of strings. * /
+list = g_list_append (list, "first");
+list = g_list_append (list, "second");
+
+/ * This is a list of integers. * /
+number_list = g_list_append (number_list, GINT_TO_POINTER (27));
+number_list = g_list_append (number_list, GINT_TO_POINTER (14));
]|
-This works from an application, however, if you want to do the same
-thing from a library, it gets more difficult, since you no longer
-control the main loop. You might think you can simply use an idle
-function to make the call to free_allocated_memory(), but that
-doesn't work, since the idle function could be called from a
-recursive callback. This can be fixed by using g_main_depth()
-|[
-gpointer
-allocate_memory (gsize size)
-{
-FreeListBlock *block = g_new (FreeListBlock, 1);
-block->mem = g_malloc (size);
-block->depth = g_main_depth ();
-free_list = g_list_prepend (free_list, block);
-return block->mem;
-}
+</description>
+<parameters>
+<parameter name="list">
+<parameter_description> a pointer to a #GList
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> the data for the new element
+</parameter_description>
+</parameter>
+</parameters>
+<return> the new start of the #GList
+</return>
+</function>
-void
-free_allocated_memory (void)
-{
-GList *l;
-
-int depth = g_main_depth ();
-for (l = free_list; l; );
-{
-GList *next = l->next;
-FreeListBlock *block = l->data;
-if (block->depth > depth)
-{
-g_free (block->mem);
-g_free (block);
-free_list = g_list_delete_link (free_list, l);
-}
-
-l = next;
-}
-}
-]|
-
-There is a temptation to use g_main_depth() to solve
-problems with reentrancy. For instance, while waiting for data
-to be received from the network in response to a menu item,
-the menu item might be selected again. It might seem that
-one could make the menu item's callback return immediately
-and do nothing if g_main_depth() returns a value greater than 1.
-However, this should be avoided since the user then sees selecting
-the menu item do nothing. Furthermore, you'll find yourself adding
-these checks all over your code, since there are doubtless many,
-many things that the user could do. Instead, you can use the
-following techniques:
-
-<orderedlist>
-<listitem>
-<para>
-Use gtk_widget_set_sensitive() or modal dialogs to prevent
-the user from interacting with elements while the main
-loop is recursing.
-</para>
-</listitem>
-<listitem>
-<para>
-Avoid main loop recursion in situations where you can't handle
-arbitrary callbacks. Instead, structure your code so that you
-simply return to the main loop and then get called again when
-there is more work to do.
-</para>
-</listitem>
-</orderedlist>
+<function name="g_list_concat">
+<description>
+Adds the second #GList onto the end of the first #GList.
+Note that the elements of the second #GList are not copied.
+They are used directly.
</description>
<parameters>
+<parameter name="list1">
+<parameter_description> a #GList
+</parameter_description>
+</parameter>
+<parameter name="list2">
+<parameter_description> the #GList to add to the end of the first #GList
+</parameter_description>
+</parameter>
</parameters>
-<return> The main loop recursion level in the current thread
+<return> the start of the new #GList
</return>
</function>
-<function name="g_main_loop_get_context">
+<function name="g_list_copy">
<description>
-Returns the #GMainContext of @loop.
+Copies a #GList.
+
+<note><para>
+Note that this is a "shallow" copy. If the list elements
+consist of pointers to data, the pointers are copied but
+the actual data is not.
+</para></note>
</description>
<parameters>
-<parameter name="loop">
-<parameter_description> a #GMainLoop.
+<parameter name="list">
+<parameter_description> a #GList
</parameter_description>
</parameter>
</parameters>
-<return> the #GMainContext of @loop
+<return> a copy of @list
</return>
</function>
-<function name="g_main_loop_is_running">
+<function name="g_list_delete_link">
<description>
-Checks to see if the main loop is currently being run via g_main_loop_run().
+Removes the node link_ from the list and frees it.
+Compare this to g_list_remove_link() which removes the node
+without freeing it.
</description>
<parameters>
-<parameter name="loop">
-<parameter_description> a #GMainLoop.
+<parameter name="list">
+<parameter_description> a #GList
+</parameter_description>
+</parameter>
+<parameter name="link_">
+<parameter_description> node to delete from @list
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the mainloop is currently being run.
+<return> the new head of @list
</return>
</function>
-<function name="g_main_loop_new">
+<function name="g_list_find">
<description>
-Creates a new #GMainLoop structure.
+Finds the element in a #GList which
+contains the given data.
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GMainContext (if %NULL, the default context will be used).
+<parameter name="list">
+<parameter_description> a #GList
</parameter_description>
</parameter>
-<parameter name="is_running">
-<parameter_description> set to %TRUE to indicate that the loop is running. This
-is not very important since calling g_main_loop_run() will set this to
-%TRUE anyway.
+<parameter name="data">
+<parameter_description> the element data to find
</parameter_description>
</parameter>
</parameters>
-<return> a new #GMainLoop.
+<return> the found #GList element,
+or %NULL if it is not found
</return>
</function>
-<function name="g_main_loop_quit">
+<function name="g_list_find_custom">
<description>
-Stops a #GMainLoop from running. Any calls to g_main_loop_run()
-for the loop will return.
+Finds an element in a #GList, using a supplied function to
+find the desired element. It iterates over the list, calling
+the given function which should return 0 when the desired
+element is found. The function takes two #gconstpointer arguments,
+the #GList element's data as the first argument and the
+given user data.
-Note that sources that have already been dispatched when
-g_main_loop_quit() is called will still be executed.
</description>
<parameters>
-<parameter name="loop">
-<parameter_description> a #GMainLoop
+<parameter name="list">
+<parameter_description> a #GList
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> user data passed to the function
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> the function to call for each element.
+It should return 0 when the desired element is found
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the found #GList element, or %NULL if it is not found
+</return>
</function>
-<function name="g_main_loop_ref">
+<function name="g_list_first">
<description>
-Increases the reference count on a #GMainLoop object by one.
+Gets the first element in a #GList.
</description>
<parameters>
-<parameter name="loop">
-<parameter_description> a #GMainLoop
+<parameter name="list">
+<parameter_description> a #GList
</parameter_description>
</parameter>
</parameters>
-<return> @loop
+<return> the first element in the #GList,
+or %NULL if the #GList has no elements
</return>
</function>
-<function name="g_main_loop_run">
+<function name="g_list_foreach">
<description>
-Runs a main loop until g_main_loop_quit() is called on the loop.
-If this is called for the thread of the loop's #GMainContext,
-it will process events from the loop, otherwise it will
-simply wait.
+Calls a function for each element of a #GList.
</description>
<parameters>
-<parameter name="loop">
-<parameter_description> a #GMainLoop
+<parameter name="list">
+<parameter_description> a #GList
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> the function to call with each element's data
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> user data to pass to the function
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_main_loop_unref">
+<function name="g_list_free">
<description>
-Decreases the reference count on a #GMainLoop object by one. If
-the result is zero, free the loop and free all associated memory.
+Frees all of the memory used by a #GList.
+The freed elements are returned to the slice allocator.
+
+<note><para>
+If list elements contain dynamically-allocated memory,
+you should either use g_list_free_full() or free them manually
+first.
+</para></note>
</description>
<parameters>
-<parameter name="loop">
-<parameter_description> a #GMainLoop
+<parameter name="list">
+<parameter_description> a #GList
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_malloc">
+<function name="g_list_free1">
<description>
-Allocates @n_bytes bytes of memory.
-If @n_bytes is 0 it returns %NULL.
-
+Another name for g_list_free_1().
</description>
<parameters>
-<parameter name="n_bytes">
-<parameter_description> the number of bytes to allocate
-</parameter_description>
-</parameter>
</parameters>
-<return> a pointer to the allocated memory
-</return>
+<return></return>
</function>
-<function name="g_malloc0">
+<function name="g_list_free_1">
<description>
-Allocates @n_bytes bytes of memory, initialized to 0's.
-If @n_bytes is 0 it returns %NULL.
-
+Frees one #GList element.
+It is usually used after g_list_remove_link().
</description>
<parameters>
-<parameter name="n_bytes">
-<parameter_description> the number of bytes to allocate
+<parameter name="list">
+<parameter_description> a #GList element
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to the allocated memory
-</return>
+<return></return>
</function>
-<function name="g_malloc0_n">
+<function name="g_list_free_full">
<description>
-This function is similar to g_malloc0(), allocating (@n_blocks * @n_block_bytes) bytes,
-but care is taken to detect possible overflow during multiplication.
+Convenience method, which frees all the memory used by a #GList, and
+calls the specified destroy function on every element's data.
-Since: 2.24
+Since: 2.28
</description>
<parameters>
-<parameter name="n_blocks">
-<parameter_description> the number of blocks to allocate
+<parameter name="list">
+<parameter_description> a pointer to a #GList
</parameter_description>
</parameter>
-<parameter name="n_block_bytes">
-<parameter_description> the size of each block in bytes
+<parameter name="free_func">
+<parameter_description> the function to be called to free each element's data
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to the allocated memory
-</return>
+<return></return>
</function>
-<function name="g_malloc_n">
+<function name="g_list_index">
<description>
-This function is similar to g_malloc(), allocating (@n_blocks * @n_block_bytes) bytes,
-but care is taken to detect possible overflow during multiplication.
+Gets the position of the element containing
+the given data (starting from 0).
-Since: 2.24
</description>
<parameters>
-<parameter name="n_blocks">
-<parameter_description> the number of blocks to allocate
+<parameter name="list">
+<parameter_description> a #GList
</parameter_description>
</parameter>
-<parameter name="n_block_bytes">
-<parameter_description> the size of each block in bytes
+<parameter name="data">
+<parameter_description> the data to find
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to the allocated memory
+<return> the index of the element containing the data,
+or -1 if the data is not found
</return>
</function>
-<function name="g_mapped_file_free">
+<function name="g_list_insert">
<description>
-This call existed before #GMappedFile had refcounting and is currently
-exactly the same as g_mapped_file_unref().
+Inserts a new element into the list at the given position.
-Since: 2.8
-Deprecated:2.22: Use g_mapped_file_unref() instead.
</description>
<parameters>
-<parameter name="file">
-<parameter_description> a #GMappedFile
+<parameter name="list">
+<parameter_description> a pointer to a #GList
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> the data for the new element
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> the position to insert the element. If this is
+negative, or is larger than the number of elements in the
+list, the new element is added on to the end of the list.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the new start of the #GList
+</return>
</function>
-<function name="g_mapped_file_get_contents">
+<function name="g_list_insert_before">
<description>
-Returns the contents of a #GMappedFile.
-
-Note that the contents may not be zero-terminated,
-even if the #GMappedFile is backed by a text file.
-
-If the file is empty then %NULL is returned.
+Inserts a new element into the list before the given position.
-Since: 2.8
</description>
<parameters>
-<parameter name="file">
-<parameter_description> a #GMappedFile
+<parameter name="list">
+<parameter_description> a pointer to a #GList
+</parameter_description>
+</parameter>
+<parameter name="sibling">
+<parameter_description> the list element before which the new element
+is inserted or %NULL to insert at the end of the list
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> the data for the new element
</parameter_description>
</parameter>
</parameters>
-<return> the contents of @file, or %NULL.
-
+<return> the new start of the #GList
</return>
</function>
-<function name="g_mapped_file_get_length">
+<function name="g_list_insert_sorted">
<description>
-Returns the length of the contents of a #GMappedFile.
+Inserts a new element into the list, using the given comparison
+function to determine its position.
-Since: 2.8
</description>
<parameters>
-<parameter name="file">
-<parameter_description> a #GMappedFile
+<parameter name="list">
+<parameter_description> a pointer to a #GList
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> the data for the new element
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> the function to compare elements in the list. It should
+return a number > 0 if the first parameter comes after the
+second parameter in the sort order.
</parameter_description>
</parameter>
</parameters>
-<return> the length of the contents of @file.
-
+<return> the new start of the #GList
</return>
</function>
-<function name="g_mapped_file_new">
+<function name="g_list_insert_sorted_with_data">
<description>
-Maps a file into memory. On UNIX, this is using the mmap() function.
-
-If @writable is %TRUE, the mapped buffer may be modified, otherwise
-it is an error to modify the mapped buffer. Modifications to the buffer
-are not visible to other processes mapping the same file, and are not
-written back to the file.
-
-Note that modifications of the underlying file might affect the contents
-of the #GMappedFile. Therefore, mapping should only be used if the file
-will not be modified, or if all modifications of the file are done
-atomically (e.g. using g_file_set_contents()).
+Inserts a new element into the list, using the given comparison
+function to determine its position.
-Since: 2.8
+Since: 2.10
</description>
<parameters>
-<parameter name="filename">
-<parameter_description> The path of the file to load, in the GLib filename encoding
+<parameter name="list">
+<parameter_description> a pointer to a #GList
</parameter_description>
</parameter>
-<parameter name="writable">
-<parameter_description> whether the mapping should be writable
+<parameter name="data">
+<parameter_description> the data for the new element
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError, or %NULL
+<parameter name="func">
+<parameter_description> the function to compare elements in the list.
+It should return a number > 0 if the first parameter
+comes after the second parameter in the sort order.
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> user data to pass to comparison function.
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated #GMappedFile which must be unref'd
-with g_mapped_file_unref(), or %NULL if the mapping failed.
+<return> the new start of the #GList
</return>
</function>
-<function name="g_mapped_file_ref">
+<function name="g_list_last">
<description>
-Increments the reference count of @file by one. It is safe to call
-this function from any thread.
+Gets the last element in a #GList.
-Since: 2.22
</description>
<parameters>
-<parameter name="file">
-<parameter_description> a #GMappedFile
+<parameter name="list">
+<parameter_description> a #GList
</parameter_description>
</parameter>
</parameters>
-<return> the passed in #GMappedFile.
-
+<return> the last element in the #GList,
+or %NULL if the #GList has no elements
</return>
</function>
-<function name="g_mapped_file_unref">
+<function name="g_list_length">
<description>
-Decrements the reference count of @file by one. If the reference count
-drops to 0, unmaps the buffer of @file and frees it.
+Gets the number of elements in a #GList.
-It is safe to call this function from any thread.
+<note><para>
+This function iterates over the whole list to
+count its elements.
+</para></note>
-Since 2.22
</description>
<parameters>
-<parameter name="file">
-<parameter_description> a #GMappedFile
+<parameter name="list">
+<parameter_description> a #GList
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the number of elements in the #GList
+</return>
</function>
-<function name="g_markup_collect_attributes">
+<function name="g_list_next">
<description>
-Collects the attributes of the element from the data passed to the
-#GMarkupParser start_element function, dealing with common error
-conditions and supporting boolean values.
-
-This utility function is not required to write a parser but can save
-a lot of typing.
-
-The @element_name, @attribute_names, @attribute_values and @error
-parameters passed to the start_element callback should be passed
-unmodified to this function.
-
-Following these arguments is a list of "supported" attributes to collect.
-It is an error to specify multiple attributes with the same name. If any
-attribute not in the list appears in the @attribute_names array then an
-unknown attribute error will result.
-
-The #GMarkupCollectType field allows specifying the type of collection
-to perform and if a given attribute must appear or is optional.
-
-The attribute name is simply the name of the attribute to collect.
-
-The pointer should be of the appropriate type (see the descriptions
-under #GMarkupCollectType) and may be %NULL in case a particular
-attribute is to be allowed but ignored.
-
-This function deals with issuing errors for missing attributes
-(of type %G_MARKUP_ERROR_MISSING_ATTRIBUTE), unknown attributes
-(of type %G_MARKUP_ERROR_UNKNOWN_ATTRIBUTE) and duplicate
-attributes (of type %G_MARKUP_ERROR_INVALID_CONTENT) as well
-as parse errors for boolean-valued attributes (again of type
-%G_MARKUP_ERROR_INVALID_CONTENT). In all of these cases %FALSE
-will be returned and @error will be set as appropriate.
-
-Since: 2.16
+A convenience macro to get the next element in a #GList.
</description>
<parameters>
-<parameter name="element_name">
-<parameter_description> the current tag name
-</parameter_description>
-</parameter>
-<parameter name="attribute_names">
-<parameter_description> the attribute names
-</parameter_description>
-</parameter>
-<parameter name="attribute_values">
-<parameter_description> the attribute values
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> a pointer to a #GError or %NULL
-</parameter_description>
-</parameter>
-<parameter name="first_type">
-<parameter_description> the #GMarkupCollectType of the first attribute
-</parameter_description>
-</parameter>
-<parameter name="first_attr">
-<parameter_description> the name of the first attribute
-</parameter_description>
-</parameter>
-<parameter name="Varargs">
-<parameter_description> a pointer to the storage location of the first attribute
-(or %NULL), followed by more types names and pointers, ending
-with %G_MARKUP_COLLECT_INVALID
+<parameter name="list">
+<parameter_description> an element in a #GList.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if successful
-
+<return> the next element, or %NULL if there are no more elements.
</return>
</function>
-<function name="g_markup_escape_text">
+<function name="g_list_nth">
<description>
-Escapes text so that the markup parser will parse it verbatim.
-Less than, greater than, ampersand, etc. are replaced with the
-corresponding entities. This function would typically be used
-when writing out a file to be parsed with the markup parser.
-
-Note that this function doesn't protect whitespace and line endings
-from being processed according to the XML rules for normalization
-of line endings and attribute values.
-
-Note also that this function will produce character references in
-the range of &#x1; ... &#x1f; for all control sequences
-except for tabstop, newline and carriage return. The character
-references in this range are not valid XML 1.0, but they are
-valid XML 1.1 and will be accepted by the GMarkup parser.
+Gets the element at the given position in a #GList.
</description>
<parameters>
-<parameter name="text">
-<parameter_description> some valid UTF-8 text
+<parameter name="list">
+<parameter_description> a #GList
</parameter_description>
</parameter>
-<parameter name="length">
-<parameter_description> length of @text in bytes, or -1 if the text is nul-terminated
+<parameter name="n">
+<parameter_description> the position of the element, counting from 0
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated string with the escaped text
+<return> the element, or %NULL if the position is off
+the end of the #GList
</return>
</function>
-<function name="g_markup_parse_context_end_parse">
+<function name="g_list_nth_data">
<description>
-Signals to the #GMarkupParseContext that all data has been
-fed into the parse context with g_markup_parse_context_parse().
-
-This function reports an error if the document isn't complete,
-for example if elements are still open.
+Gets the data of the element at the given position.
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GMarkupParseContext
+<parameter name="list">
+<parameter_description> a #GList
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError
+<parameter name="n">
+<parameter_description> the position of the element
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE on success, %FALSE if an error was set
+<return> the element's data, or %NULL if the position
+is off the end of the #GList
</return>
</function>
-<function name="g_markup_parse_context_free">
+<function name="g_list_nth_prev">
<description>
-Frees a #GMarkupParseContext.
+Gets the element @n places before @list.
-This function can't be called from inside one of the
-#GMarkupParser functions or while a subparser is pushed.
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GMarkupParseContext
+<parameter name="list">
+<parameter_description> a #GList
+</parameter_description>
+</parameter>
+<parameter name="n">
+<parameter_description> the position of the element, counting from 0
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the element, or %NULL if the position is
+off the end of the #GList
+</return>
</function>
-<function name="g_markup_parse_context_get_element">
+<function name="g_list_pop_allocator">
<description>
-Retrieves the name of the currently open element.
+Restores the previous #GAllocator, used when allocating #GList
+elements.
-If called from the start_element or end_element handlers this will
-give the element_name as passed to those functions. For the parent
-elements, see g_markup_parse_context_get_element_stack().
+Note that this function is not available if GLib has been compiled
+with <option>--disable-mem-pools</option>
-Since: 2.2
+Deprecated:2.10: It does nothing, since #GList has been converted
+to the <link linkend="glib-Memory-Slices">slice
+allocator</link>
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GMarkupParseContext
-</parameter_description>
-</parameter>
</parameters>
-<return> the name of the currently open element, or %NULL
-
-</return>
+<return></return>
</function>
-<function name="g_markup_parse_context_get_element_stack">
+<function name="g_list_position">
<description>
-Retrieves the element stack from the internal state of the parser.
-
-The returned #GSList is a list of strings where the first item is
-the currently open tag (as would be returned by
-g_markup_parse_context_get_element()) and the next item is its
-immediate parent.
-
-This function is intended to be used in the start_element and
-end_element handlers where g_markup_parse_context_get_element()
-would merely return the name of the element that is being
-processed.
+Gets the position of the given element
+in the #GList (starting from 0).
-Since: 2.16
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GMarkupParseContext
+<parameter name="list">
+<parameter_description> a #GList
+</parameter_description>
+</parameter>
+<parameter name="llink">
+<parameter_description> an element in the #GList
</parameter_description>
</parameter>
</parameters>
-<return> the element stack, which must not be modified
-
+<return> the position of the element in the #GList,
+or -1 if the element is not found
</return>
</function>
-<function name="g_markup_parse_context_get_position">
+<function name="g_list_prepend">
<description>
-Retrieves the current line number and the number of the character on
-that line. Intended for use in error messages; there are no strict
-semantics for what constitutes the "current" line number other than
-"the best number we could come up with for error messages."
+Adds a new element on to the start of the list.
+
+<note><para>
+The return value is the new start of the list, which
+may have changed, so make sure you store the new value.
+</para></note>
+
+|[
+/ * Notice that it is initialized to the empty list. * /
+GList *list = NULL;
+list = g_list_prepend (list, "last");
+list = g_list_prepend (list, "first");
+]|
+
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GMarkupParseContext
-</parameter_description>
-</parameter>
-<parameter name="line_number">
-<parameter_description> return location for a line number, or %NULL
+<parameter name="list">
+<parameter_description> a pointer to a #GList
</parameter_description>
</parameter>
-<parameter name="char_number">
-<parameter_description> return location for a char-on-line number, or %NULL
+<parameter name="data">
+<parameter_description> the data for the new element
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the new start of the #GList
+</return>
</function>
-<function name="g_markup_parse_context_get_user_data">
+<function name="g_list_previous">
<description>
-Returns the user_data associated with @context.
-
-This will either be the user_data that was provided to
-g_markup_parse_context_new() or to the most recent call
-of g_markup_parse_context_push().
-
-Since: 2.18
+A convenience macro to get the previous element in a #GList.
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GMarkupParseContext
+<parameter name="list">
+<parameter_description> an element in a #GList.
</parameter_description>
</parameter>
</parameters>
-<return> the provided user_data. The returned data belongs to
-the markup context and will be freed when g_markup_context_free()
-is called.
-
+<return> the previous element, or %NULL if there are no previous
+elements.
</return>
</function>
-<function name="g_markup_parse_context_new">
+<function name="g_list_push_allocator">
<description>
-Creates a new parse context. A parse context is used to parse
-marked-up documents. You can feed any number of documents into
-a context, as long as no errors occur; once an error occurs,
-the parse context can't continue to parse text (you have to
-free it and create a new parse context).
+Sets the allocator to use to allocate #GList elements. Use
+g_list_pop_allocator() to restore the previous allocator.
+Note that this function is not available if GLib has been compiled
+with <option>--disable-mem-pools</option>
+
+Deprecated:2.10: It does nothing, since #GList has been converted
+to the <link linkend="glib-Memory-Slices">slice
+allocator</link>
</description>
<parameters>
-<parameter name="parser">
-<parameter_description> a #GMarkupParser
-</parameter_description>
-</parameter>
-<parameter name="flags">
-<parameter_description> one or more #GMarkupParseFlags
-</parameter_description>
-</parameter>
-<parameter name="user_data">
-<parameter_description> user data to pass to #GMarkupParser functions
-</parameter_description>
-</parameter>
-<parameter name="user_data_dnotify">
-<parameter_description> user data destroy notifier called when
-the parse context is freed
+<parameter name="allocator">
+<parameter_description> the #GAllocator to use when allocating #GList elements.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GMarkupParseContext
-</return>
+<return></return>
</function>
-<function name="g_markup_parse_context_parse">
+<function name="g_list_remove">
<description>
-Feed some data to the #GMarkupParseContext.
-
-The data need not be valid UTF-8; an error will be signaled if
-it's invalid. The data need not be an entire document; you can
-feed a document into the parser incrementally, via multiple calls
-to this function. Typically, as you receive data from a network
-connection or file, you feed each received chunk of data into this
-function, aborting the process if an error occurs. Once an error
-is reported, no further data may be fed to the #GMarkupParseContext;
-all errors are fatal.
+Removes an element from a #GList.
+If two elements contain the same data, only the first is removed.
+If none of the elements contain the data, the #GList is unchanged.
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GMarkupParseContext
-</parameter_description>
-</parameter>
-<parameter name="text">
-<parameter_description> chunk of text to parse
-</parameter_description>
-</parameter>
-<parameter name="text_len">
-<parameter_description> length of @text in bytes
+<parameter name="list">
+<parameter_description> a #GList
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError
+<parameter name="data">
+<parameter_description> the data of the element to remove
</parameter_description>
</parameter>
</parameters>
-<return> %FALSE if an error occurred, %TRUE on success
+<return> the new start of the #GList
</return>
</function>
-<function name="g_markup_parse_context_pop">
+<function name="g_list_remove_all">
<description>
-Completes the process of a temporary sub-parser redirection.
-
-This function exists to collect the user_data allocated by a
-matching call to g_markup_parse_context_push(). It must be called
-in the end_element handler corresponding to the start_element
-handler during which g_markup_parse_context_push() was called.
-You must not call this function from the error callback -- the
- user_data is provided directly to the callback in that case.
-
-This function is not intended to be directly called by users
-interested in invoking subparsers. Instead, it is intended to
-be used by the subparsers themselves to implement a higher-level
-interface.
+Removes all list nodes with data equal to @data.
+Returns the new head of the list. Contrast with
+g_list_remove() which removes only the first node
+matching the given data.
-Since: 2.18
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GMarkupParseContext
+<parameter name="list">
+<parameter_description> a #GList
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> data to remove
</parameter_description>
</parameter>
</parameters>
-<return> the user data passed to g_markup_parse_context_push()
-
+<return> new head of @list
</return>
</function>
-<function name="g_markup_parse_context_push">
+<function name="g_list_remove_link">
<description>
-Temporarily redirects markup data to a sub-parser.
-
-This function may only be called from the start_element handler of
-a #GMarkupParser. It must be matched with a corresponding call to
-g_markup_parse_context_pop() in the matching end_element handler
-(except in the case that the parser aborts due to an error).
-
-All tags, text and other data between the matching tags is
-redirected to the subparser given by @parser. @user_data is used
-as the user_data for that parser. @user_data is also passed to the
-error callback in the event that an error occurs. This includes
-errors that occur in subparsers of the subparser.
-
-The end tag matching the start tag for which this call was made is
-handled by the previous parser (which is given its own user_data)
-which is why g_markup_parse_context_pop() is provided to allow "one
-last access" to the @user_data provided to this function. In the
-case of error, the @user_data provided here is passed directly to
-the error callback of the subparser and g_markup_parse_context()
-should not be called. In either case, if @user_data was allocated
-then it ought to be freed from both of these locations.
-
-This function is not intended to be directly called by users
-interested in invoking subparsers. Instead, it is intended to be
-used by the subparsers themselves to implement a higher-level
-interface.
-
-As an example, see the following implementation of a simple
-parser that counts the number of tags encountered.
-
-|[
-typedef struct
-{
-gint tag_count;
-} CounterData;
-
-static void
-counter_start_element (GMarkupParseContext *context,
-const gchar *element_name,
-const gchar **attribute_names,
-const gchar **attribute_values,
-gpointer user_data,
-GError **error)
-{
-CounterData *data = user_data;
-
-data->tag_count++;
-}
-
-static void
-counter_error (GMarkupParseContext *context,
-GError *error,
-gpointer user_data)
-{
-CounterData *data = user_data;
-
-g_slice_free (CounterData, data);
-}
-
-static GMarkupParser counter_subparser =
-{
-counter_start_element,
-NULL,
-NULL,
-NULL,
-counter_error
-};
-]|
-
-In order to allow this parser to be easily used as a subparser, the
-following interface is provided:
-
-|[
-void
-start_counting (GMarkupParseContext *context)
-{
-CounterData *data = g_slice_new (CounterData);
-
-data->tag_count = 0;
-g_markup_parse_context_push (context, &counter_subparser, data);
-}
-
-gint
-end_counting (GMarkupParseContext *context)
-{
-CounterData *data = g_markup_parse_context_pop (context);
-int result;
-
-result = data->tag_count;
-g_slice_free (CounterData, data);
-
-return result;
-}
-]|
-
-The subparser would then be used as follows:
-
-|[
-static void start_element (context, element_name, ...)
-{
-if (strcmp (element_name, "count-these") == 0)
-start_counting (context);
-
-/ * else, handle other tags... * /
-}
-
-static void end_element (context, element_name, ...)
-{
-if (strcmp (element_name, "count-these") == 0)
-g_print ("Counted %d tags\n", end_counting (context));
-
-/ * else, handle other tags... * /
-}
-]|
+Removes an element from a #GList, without freeing the element.
+The removed element's prev and next links are set to %NULL, so
+that it becomes a self-contained list with one element.
-Since: 2.18
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GMarkupParseContext
-</parameter_description>
-</parameter>
-<parameter name="parser">
-<parameter_description> a #GMarkupParser
+<parameter name="list">
+<parameter_description> a #GList
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> user data to pass to #GMarkupParser functions
+<parameter name="llink">
+<parameter_description> an element in the #GList
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the new start of the #GList, without the element
+</return>
</function>
-<function name="g_markup_printf_escaped">
+<function name="g_list_reverse">
<description>
-Formats arguments according to @format, escaping
-all string and character arguments in the fashion
-of g_markup_escape_text(). This is useful when you
-want to insert literal strings into XML-style markup
-output, without having to worry that the strings
-might themselves contain markup.
-
-|[
-const char *store = "Fortnum & Mason";
-const char *item = "Tea";
-char *output;
- 
-output = g_markup_printf_escaped ("<purchase>"
-"<store>%s</store>"
-"<item>%s</item>"
-"</purchase>",
-store, item);
-]|
+Reverses a #GList.
+It simply switches the next and prev pointers of each element.
-Since: 2.4
</description>
<parameters>
-<parameter name="format">
-<parameter_description> printf() style format string
-</parameter_description>
-</parameter>
-<parameter name="Varargs">
-<parameter_description> the arguments to insert in the format string
+<parameter name="list">
+<parameter_description> a #GList
</parameter_description>
</parameter>
</parameters>
-<return> newly allocated result from formatting
-operation. Free with g_free().
-
+<return> the start of the reversed #GList
</return>
</function>
-<function name="g_markup_vprintf_escaped">
+<function name="g_list_sort">
<description>
-Formats the data in @args according to @format, escaping
-all string and character arguments in the fashion
-of g_markup_escape_text(). See g_markup_printf_escaped().
+Sorts a #GList using the given comparison function.
-Since: 2.4
</description>
<parameters>
-<parameter name="format">
-<parameter_description> printf() style format string
+<parameter name="list">
+<parameter_description> a #GList
</parameter_description>
</parameter>
-<parameter name="args">
-<parameter_description> variable argument list, similar to vprintf()
+<parameter name="compare_func">
+<parameter_description> the comparison function used to sort the #GList.
+This function is passed the data from 2 elements of the #GList
+and should return 0 if they are equal, a negative value if the
+first element comes before the second, or a positive value if
+the first element comes after the second.
</parameter_description>
</parameter>
</parameters>
-<return> newly allocated result from formatting
-operation. Free with g_free().
-
+<return> the start of the sorted #GList
</return>
</function>
-<function name="g_match_info_expand_references">
+<function name="g_list_sort_with_data">
<description>
-Returns a new string containing the text in @string_to_expand with
-references and escape sequences expanded. References refer to the last
-match done with @string against @regex and have the same syntax used by
-g_regex_replace().
-
-The @string_to_expand must be UTF-8 encoded even if #G_REGEX_RAW was
-passed to g_regex_new().
-
-The backreferences are extracted from the string passed to the match
-function, so you cannot call this function after freeing the string.
-
- match_info may be %NULL in which case @string_to_expand must not
-contain references. For instance "foo\n" does not refer to an actual
-pattern and '\n' merely will be replaced with \n character,
-while to expand "\0" (whole match) one needs the result of a match.
-Use g_regex_check_replacement() to find out whether @string_to_expand
-contains references.
+Like g_list_sort(), but the comparison function accepts
+a user data argument.
-Since: 2.14
</description>
<parameters>
-<parameter name="match_info">
-<parameter_description> a #GMatchInfo or %NULL
+<parameter name="list">
+<parameter_description> a #GList
</parameter_description>
</parameter>
-<parameter name="string_to_expand">
-<parameter_description> the string to expand
+<parameter name="compare_func">
+<parameter_description> comparison function
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> location to store the error occuring, or %NULL to ignore errors
+<parameter name="user_data">
+<parameter_description> user data to pass to comparison function
</parameter_description>
</parameter>
</parameters>
-<return> the expanded string, or %NULL if an error occurred
-
+<return> the new head of @list
</return>
</function>
-<function name="g_match_info_fetch">
+<function name="g_listenv">
<description>
-Retrieves the text matching the @match_num<!-- -->'th capturing
-parentheses. 0 is the full text of the match, 1 is the first paren
-set, 2 the second, and so on.
-
-If @match_num is a valid sub pattern but it didn't match anything
-(e.g. sub pattern 1, matching "b" against "(a)?b") then an empty
-string is returned.
-
-If the match was obtained using the DFA algorithm, that is using
-g_regex_match_all() or g_regex_match_all_full(), the retrieved
-string is not that of a set of parentheses but that of a matched
-substring. Substrings are matched in reverse order of length, so
-0 is the longest match.
-
-The string is fetched from the string passed to the match function,
-so you cannot call this function after freeing the string.
+Gets the names of all variables set in the environment.
-Since: 2.14
+Since: 2.8
</description>
<parameters>
-<parameter name="match_info">
-<parameter_description> #GMatchInfo structure
-</parameter_description>
-</parameter>
-<parameter name="match_num">
-<parameter_description> number of the sub expression
-</parameter_description>
-</parameter>
</parameters>
-<return> The matched substring, or %NULL if an error
-occurred. You have to free the string yourself
+<return> a %NULL-terminated list of strings which must be freed
+with g_strfreev().
+
+Programs that want to be portable to Windows should typically use
+this function and g_getenv() instead of using the environ array
+from the C library directly. On Windows, the strings in the environ
+array are in system codepage encoding, while in most of the typical
+use cases for environment variables in GLib-using programs you want
+the UTF-8 encoding that this function and g_getenv() provide.
</return>
</function>
-<function name="g_match_info_fetch_all">
+<function name="g_locale_from_utf8">
<description>
-Bundles up pointers to each of the matching substrings from a match
-and stores them in an array of gchar pointers. The first element in
-the returned array is the match number 0, i.e. the entire matched
-text.
-
-If a sub pattern didn't match anything (e.g. sub pattern 1, matching
-"b" against "(a)?b") then an empty string is inserted.
-
-If the last match was obtained using the DFA algorithm, that is using
-g_regex_match_all() or g_regex_match_all_full(), the retrieved
-strings are not that matched by sets of parentheses but that of the
-matched substring. Substrings are matched in reverse order of length,
-so the first one is the longest match.
-
-The strings are fetched from the string passed to the match function,
-so you cannot call this function after freeing the string.
+Converts a string from UTF-8 to the encoding used for strings by
+the C runtime (usually the same as that used by the operating
+system) in the <link linkend="setlocale">current locale</link>. On
+Windows this means the system codepage.
-Since: 2.14
</description>
<parameters>
-<parameter name="match_info">
-<parameter_description> a #GMatchInfo structure
+<parameter name="utf8string">
+<parameter_description> a UTF-8 encoded string
</parameter_description>
</parameter>
-</parameters>
-<return> a %NULL-terminated array of gchar * pointers.
-It must be freed using g_strfreev(). If the previous match failed
-%NULL is returned
-
+<parameter name="len">
+<parameter_description> the length of the string, or -1 if the string is
+nul-terminated<footnoteref linkend="nul-unsafe"/>.
+</parameter_description>
+</parameter>
+<parameter name="bytes_read">
+<parameter_description> location to store the number of bytes in the
+input string that were successfully converted, or %NULL.
+Even if the conversion was successful, this may be
+less than @len if there were partial characters
+at the end of the input. If the error
+#G_CONVERT_ERROR_ILLEGAL_SEQUENCE occurs, the value
+stored will the byte offset after the last valid
+input sequence.
+</parameter_description>
+</parameter>
+<parameter name="bytes_written">
+<parameter_description> the number of bytes stored in the output buffer (not
+including the terminating nul).
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> location to store the error occuring, or %NULL to ignore
+errors. Any of the errors in #GConvertError may occur.
+</parameter_description>
+</parameter>
+</parameters>
+<return> The converted string, or %NULL on an error.
</return>
</function>
-<function name="g_match_info_fetch_named">
+<function name="g_locale_to_utf8">
<description>
-Retrieves the text matching the capturing parentheses named @name.
-
-If @name is a valid sub pattern name but it didn't match anything
-(e.g. sub pattern "X", matching "b" against "(?P<X>a)?b")
-then an empty string is returned.
-
-The string is fetched from the string passed to the match function,
-so you cannot call this function after freeing the string.
+Converts a string which is in the encoding used for strings by
+the C runtime (usually the same as that used by the operating
+system) in the <link linkend="setlocale">current locale</link> into a
+UTF-8 string.
-Since: 2.14
</description>
<parameters>
-<parameter name="match_info">
-<parameter_description> #GMatchInfo structure
+<parameter name="opsysstring">
+<parameter_description> a string in the encoding of the current locale. On Windows
+this means the system codepage.
</parameter_description>
</parameter>
-<parameter name="name">
-<parameter_description> name of the subexpression
+<parameter name="len">
+<parameter_description> the length of the string, or -1 if the string is
+nul-terminated<footnoteref linkend="nul-unsafe"/>.
+</parameter_description>
+</parameter>
+<parameter name="bytes_read">
+<parameter_description> location to store the number of bytes in the
+input string that were successfully converted, or %NULL.
+Even if the conversion was successful, this may be
+less than @len if there were partial characters
+at the end of the input. If the error
+#G_CONVERT_ERROR_ILLEGAL_SEQUENCE occurs, the value
+stored will the byte offset after the last valid
+input sequence.
+</parameter_description>
+</parameter>
+<parameter name="bytes_written">
+<parameter_description> the number of bytes stored in the output buffer (not
+including the terminating nul).
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> location to store the error occuring, or %NULL to ignore
+errors. Any of the errors in #GConvertError may occur.
</parameter_description>
</parameter>
</parameters>
-<return> The matched substring, or %NULL if an error
-occurred. You have to free the string yourself
-
+<return> The converted string, or %NULL on an error.
</return>
</function>
-<function name="g_match_info_fetch_named_pos">
+<function name="g_lstat">
<description>
-Retrieves the position in bytes of the capturing parentheses named @name.
+A wrapper for the POSIX lstat() function. The lstat() function is
+like stat() except that in the case of symbolic links, it returns
+information about the symbolic link itself and not the file that it
+refers to. If the system does not support symbolic links g_lstat()
+is identical to g_stat().
-If @name is a valid sub pattern name but it didn't match anything
-(e.g. sub pattern "X", matching "b" against "(?P<X>a)?b")
-then @start_pos and @end_pos are set to -1 and %TRUE is returned.
+See your C library manual for more details about lstat().
-Since: 2.14
+Since: 2.6
</description>
<parameters>
-<parameter name="match_info">
-<parameter_description> #GMatchInfo structure
-</parameter_description>
-</parameter>
-<parameter name="name">
-<parameter_description> name of the subexpression
-</parameter_description>
-</parameter>
-<parameter name="start_pos">
-<parameter_description> pointer to location where to store
-the start position, or %NULL
+<parameter name="filename">
+<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows)
</parameter_description>
</parameter>
-<parameter name="end_pos">
-<parameter_description> pointer to location where to store
-the end position, or %NULL
+<parameter name="buf">
+<parameter_description> a pointer to a <structname>stat</structname> struct, which
+will be filled with the file information
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the position was fetched, %FALSE otherwise.
-If the position cannot be fetched, @start_pos and @end_pos
-are left unchanged.
+<return> 0 if the information was successfully retrieved, -1 if an error
+occurred
</return>
</function>
-<function name="g_match_info_fetch_pos">
+<function name="g_main_context_acquire">
<description>
-Retrieves the position in bytes of the @match_num<!-- -->'th capturing
-parentheses. 0 is the full text of the match, 1 is the first
-paren set, 2 the second, and so on.
-
-If @match_num is a valid sub pattern but it didn't match anything
-(e.g. sub pattern 1, matching "b" against "(a)?b") then @start_pos
-and @end_pos are set to -1 and %TRUE is returned.
+Tries to become the owner of the specified context.
+If some other thread is the owner of the context,
+returns %FALSE immediately. Ownership is properly
+recursive: the owner can require ownership again
+and will release ownership when g_main_context_release()
+is called as many times as g_main_context_acquire().
-If the match was obtained using the DFA algorithm, that is using
-g_regex_match_all() or g_regex_match_all_full(), the retrieved
-position is not that of a set of parentheses but that of a matched
-substring. Substrings are matched in reverse order of length, so
-0 is the longest match.
+You must be the owner of a context before you
+can call g_main_context_prepare(), g_main_context_query(),
+g_main_context_check(), g_main_context_dispatch().
-Since: 2.14
</description>
<parameters>
-<parameter name="match_info">
-<parameter_description> #GMatchInfo structure
-</parameter_description>
-</parameter>
-<parameter name="match_num">
-<parameter_description> number of the sub expression
-</parameter_description>
-</parameter>
-<parameter name="start_pos">
-<parameter_description> pointer to location where to store
-the start position, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="end_pos">
-<parameter_description> pointer to location where to store
-the end position, or %NULL
+<parameter name="context">
+<parameter_description> a #GMainContext
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the position was fetched, %FALSE otherwise. If
-the position cannot be fetched, @start_pos and @end_pos are left
-unchanged
-
+<return> %TRUE if the operation succeeded, and
+this thread is now the owner of @context.
</return>
</function>
-<function name="g_match_info_free">
+<function name="g_main_context_add_poll">
<description>
-Frees all the memory associated with the #GMatchInfo structure.
-
-Since: 2.14
+Adds a file descriptor to the set of file descriptors polled for
+this context. This will very seldomly be used directly. Instead
+a typical event source will use g_source_add_poll() instead.
</description>
<parameters>
-<parameter name="match_info">
-<parameter_description> a #GMatchInfo
+<parameter name="context">
+<parameter_description> a #GMainContext (or %NULL for the default context)
+</parameter_description>
+</parameter>
+<parameter name="fd">
+<parameter_description> a #GPollFD structure holding information about a file
+descriptor to watch.
+</parameter_description>
+</parameter>
+<parameter name="priority">
+<parameter_description> the priority for this file descriptor which should be
+the same as the priority used for g_source_attach() to ensure that the
+file descriptor is polled whenever the results may be needed.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_match_info_get_match_count">
+<function name="g_main_context_check">
<description>
-Retrieves the number of matched substrings (including substring 0,
-that is the whole matched text), so 1 is returned if the pattern
-has no substrings in it and 0 is returned if the match failed.
-
-If the last match was obtained using the DFA algorithm, that is
-using g_regex_match_all() or g_regex_match_all_full(), the retrieved
-count is not that of the number of capturing parentheses but that of
-the number of matched substrings.
+Passes the results of polling back to the main loop.
-Since: 2.14
</description>
<parameters>
-<parameter name="match_info">
-<parameter_description> a #GMatchInfo structure
+<parameter name="context">
+<parameter_description> a #GMainContext
+</parameter_description>
+</parameter>
+<parameter name="max_priority">
+<parameter_description> the maximum numerical priority of sources to check
+</parameter_description>
+</parameter>
+<parameter name="fds">
+<parameter_description> array of #GPollFD's that was passed to the last call to
+g_main_context_query()
+</parameter_description>
+</parameter>
+<parameter name="n_fds">
+<parameter_description> return value of g_main_context_query()
</parameter_description>
</parameter>
</parameters>
-<return> Number of matched substrings, or -1 if an error occurred
-
+<return> %TRUE if some sources are ready to be dispatched.
</return>
</function>
-<function name="g_match_info_get_regex">
+<function name="g_main_context_default">
<description>
-Returns #GRegex object used in @match_info. It belongs to Glib
-and must not be freed. Use g_regex_ref() if you need to keep it
-after you free @match_info object.
+Returns the global default main context. This is the main context
+used for main loop functions when a main loop is not explicitly
+specified, and corresponds to the "main" main loop. See also
+g_main_context_get_thread_default().
-Since: 2.14
</description>
<parameters>
-<parameter name="match_info">
-<parameter_description> a #GMatchInfo
-</parameter_description>
-</parameter>
</parameters>
-<return> #GRegex object used in @match_info
-
+<return> the global default main context.
</return>
</function>
-<function name="g_match_info_get_string">
+<function name="g_main_context_dispatch">
<description>
-Returns the string searched with @match_info. This is the
-string passed to g_regex_match() or g_regex_replace() so
-you may not free it before calling this function.
-
-Since: 2.14
+Dispatches all pending sources.
</description>
<parameters>
-<parameter name="match_info">
-<parameter_description> a #GMatchInfo
+<parameter name="context">
+<parameter_description> a #GMainContext
</parameter_description>
</parameter>
</parameters>
-<return> the string searched with @match_info
-
-</return>
+<return></return>
</function>
-<function name="g_match_info_is_partial_match">
+<function name="g_main_context_find_source_by_funcs_user_data">
<description>
-Usually if the string passed to g_regex_match*() matches as far as
-it goes, but is too short to match the entire pattern, %FALSE is
-returned. There are circumstances where it might be helpful to
-distinguish this case from other cases in which there is no match.
-
-Consider, for example, an application where a human is required to
-type in data for a field with specific formatting requirements. An
-example might be a date in the form ddmmmyy, defined by the pattern
-"^\d?\d(jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec)\d\d$".
-If the application sees the userâs keystrokes one by one, and can
-check that what has been typed so far is potentially valid, it is
-able to raise an error as soon as a mistake is made.
-
-GRegex supports the concept of partial matching by means of the
-#G_REGEX_MATCH_PARTIAL flag. When this is set the return code for
-g_regex_match() or g_regex_match_full() is, as usual, %TRUE
-for a complete match, %FALSE otherwise. But, when these functions
-return %FALSE, you can check if the match was partial calling
-g_match_info_is_partial_match().
-
-When using partial matching you cannot use g_match_info_fetch*().
-
-Because of the way certain internal optimizations are implemented
-the partial matching algorithm cannot be used with all patterns.
-So repeated single characters such as "a{2,4}" and repeated single
-meta-sequences such as "\d+" are not permitted if the maximum number
-of occurrences is greater than one. Optional items such as "\d?"
-(where the maximum is one) are permitted. Quantifiers with any values
-are permitted after parentheses, so the invalid examples above can be
-coded thus "(a){2,4}" and "(\d)+". If #G_REGEX_MATCH_PARTIAL is set
-for a pattern that does not conform to the restrictions, matching
-functions return an error.
+Finds a source with the given source functions and user data. If
+multiple sources exist with the same source function and user data,
+the first one found will be returned.
-Since: 2.14
</description>
<parameters>
-<parameter name="match_info">
-<parameter_description> a #GMatchInfo structure
+<parameter name="context">
+<parameter_description> a #GMainContext (if %NULL, the default context will be used).
+</parameter_description>
+</parameter>
+<parameter name="funcs">
+<parameter_description> the @source_funcs passed to g_source_new().
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> the user data from the callback.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the match was partial, %FALSE otherwise
-
+<return> the source, if one was found, otherwise %NULL
</return>
</function>
-<function name="g_match_info_matches">
+<function name="g_main_context_find_source_by_id">
<description>
-Returns whether the previous match operation succeeded.
+Finds a #GSource given a pair of context and ID.
-Since: 2.14
</description>
<parameters>
-<parameter name="match_info">
-<parameter_description> a #GMatchInfo structure
+<parameter name="context">
+<parameter_description> a #GMainContext (if %NULL, the default context will be used)
+</parameter_description>
+</parameter>
+<parameter name="source_id">
+<parameter_description> the source ID, as returned by g_source_get_id().
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the previous match operation succeeded,
-%FALSE otherwise
-
+<return> the #GSource if found, otherwise, %NULL
</return>
</function>
-<function name="g_match_info_next">
+<function name="g_main_context_find_source_by_user_data">
<description>
-Scans for the next match using the same parameters of the previous
-call to g_regex_match_full() or g_regex_match() that returned
- match_info
-
-The match is done on the string passed to the match function, so you
-cannot free it before calling this function.
+Finds a source with the given user data for the callback. If
+multiple sources exist with the same user data, the first
+one found will be returned.
-Since: 2.14
</description>
<parameters>
-<parameter name="match_info">
-<parameter_description> a #GMatchInfo structure
+<parameter name="context">
+<parameter_description> a #GMainContext
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> location to store the error occuring, or %NULL to ignore errors
+<parameter name="user_data">
+<parameter_description> the user_data for the callback.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE is the string matched, %FALSE otherwise
-
+<return> the source, if one was found, otherwise %NULL
</return>
</function>
-<function name="g_mem_chunk_alloc">
+<function name="g_main_context_get_poll_func">
<description>
-Allocates an atom of memory from a #GMemChunk.
+Gets the poll function set by g_main_context_set_poll_func().
-Deprecated:2.10: Use g_slice_alloc() instead
</description>
<parameters>
-<parameter name="mem_chunk">
-<parameter_description> a #GMemChunk.
+<parameter name="context">
+<parameter_description> a #GMainContext
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to the allocated atom.
+<return> the poll function
</return>
</function>
-<function name="g_mem_chunk_alloc0">
+<function name="g_main_context_get_thread_default">
<description>
-Allocates an atom of memory from a #GMemChunk, setting the memory to
-0.
+Gets the thread-default #GMainContext for this thread. Asynchronous
+operations that want to be able to be run in contexts other than
+the default one should call this method to get a #GMainContext to
+add their #GSource<!-- -->s to. (Note that even in single-threaded
+programs applications may sometimes want to temporarily push a
+non-default context, so it is not safe to assume that this will
+always return %NULL if threads are not initialized.)
-Deprecated:2.10: Use g_slice_alloc0() instead
+Since: 2.22
</description>
<parameters>
-<parameter name="mem_chunk">
-<parameter_description> a #GMemChunk.
-</parameter_description>
-</parameter>
</parameters>
-<return> a pointer to the allocated atom.
+<return> the thread-default #GMainContext, or %NULL if the
+thread-default context is the global default context.
+
</return>
</function>
-<function name="g_mem_chunk_clean">
+<function name="g_main_context_invoke">
<description>
-Frees any blocks in a #GMemChunk which are no longer being used.
+Invokes a function in such a way that @context is owned during the
+invocation of @function.
-Deprecated:2.10: Use the <link linkend="glib-Memory-Slices">slice
-allocator</link> instead
+If @context is %NULL then the global default main context â as
+returned by g_main_context_default() â is used.
+
+If @context is owned by the current thread, @function is called
+directly. Otherwise, if @context is the thread-default main context
+of the current thread and g_main_context_acquire() succeeds, then
+ function is called and g_main_context_release() is called
+afterwards.
+
+In any other case, an idle source is created to call @function and
+that source is attached to @context (presumably to be run in another
+thread). The idle source is attached with #G_PRIORITY_DEFAULT
+priority. If you want a different priority, use
+g_main_context_invoke_full().
+
+Note that, as with normal idle functions, @function should probably
+return %FALSE. If it returns %TRUE, it will be continuously run in a
+loop (and may prevent this call from returning).
+
+Since: 2.28
</description>
<parameters>
-<parameter name="mem_chunk">
-<parameter_description> a #GMemChunk.
+<parameter name="context">
+<parameter_description> a #GMainContext, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="function">
+<parameter_description> function to call
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> data to pass to @function
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_mem_chunk_create">
+<function name="g_main_context_invoke_full">
<description>
-A convenience macro for creating a new #GMemChunk. It calls
-g_mem_chunk_new(), using the given type to create the #GMemChunk
-name. The atom size is determined using
-<function>sizeof()</function>, and the area size is calculated by
-multiplying the @pre_alloc parameter with the atom size.
+Invokes a function in such a way that @context is owned during the
+invocation of @function.
-Deprecated:2.10: Use the <link linkend="glib-Memory-Slices">slice
-allocator</link> instead
+This function is the same as g_main_context_invoke() except that it
+lets you specify the priority incase @function ends up being
+scheduled as an idle and also lets you give a #GDestroyNotify for @data.
+
+ notify should not assume that it is called from any particular
+thread or with any particular context acquired.
+
+Since: 2.28
</description>
<parameters>
-<parameter name="type">
-<parameter_description> the type of the atoms, typically a structure name.
+<parameter name="context">
+<parameter_description> a #GMainContext, or %NULL
</parameter_description>
</parameter>
-<parameter name="pre_alloc">
-<parameter_description> the number of atoms to store in each block of memory.
+<parameter name="priority">
+<parameter_description> the priority at which to run @function
</parameter_description>
</parameter>
-<parameter name="alloc_type">
-<parameter_description> the type of the #GMemChunk. #G_ALLOC_AND_FREE is used
-if the atoms will be freed individually. #G_ALLOC_ONLY
-should be used if atoms will never be freed
-individually. #G_ALLOC_ONLY is quicker, since it does
-not need to track free atoms, but it obviously wastes
-memory if you no longer need many of the atoms.
+<parameter name="function">
+<parameter_description> function to call
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> data to pass to @function
+</parameter_description>
+</parameter>
+<parameter name="notify">
+<parameter_description> a function to call when @data is no longer in use, or %NULL.
</parameter_description>
</parameter>
</parameters>
-<return> the new #GMemChunk.
-</return>
+<return></return>
</function>
-<function name="g_mem_chunk_destroy">
+<function name="g_main_context_is_owner">
<description>
-Frees all of the memory allocated for a #GMemChunk.
+Determines whether this thread holds the (recursive)
+ownership of this #GMaincontext. This is useful to
+know before waiting on another thread that may be
+blocking to get ownership of @context.
-Deprecated:2.10: Use the <link linkend="glib-Memory-Slices">slice
-allocator</link> instead
+Since: 2.10
</description>
<parameters>
-<parameter name="mem_chunk">
-<parameter_description> a #GMemChunk.
+<parameter name="context">
+<parameter_description> a #GMainContext
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if current thread is owner of @context.
+
+</return>
</function>
-<function name="g_mem_chunk_free">
+<function name="g_main_context_iteration">
<description>
-Frees an atom in a #GMemChunk. This should only be called if the
-#GMemChunk was created with #G_ALLOC_AND_FREE. Otherwise it will
-simply return.
+Runs a single iteration for the given main loop. This involves
+checking to see if any event sources are ready to be processed,
+then if no events sources are ready and @may_block is %TRUE, waiting
+for a source to become ready, then dispatching the highest priority
+events sources that are ready. Otherwise, if @may_block is %FALSE
+sources are not waited to become ready, only those highest priority
+events sources will be dispatched (if any), that are ready at this
+given moment without further waiting.
+
+Note that even when @may_block is %TRUE, it is still possible for
+g_main_context_iteration() to return %FALSE, since the the wait may
+be interrupted for other reasons than an event source becoming ready.
-Deprecated:2.10: Use g_slice_free1() instead
</description>
<parameters>
-<parameter name="mem_chunk">
-<parameter_description> a #GMemChunk.
+<parameter name="context">
+<parameter_description> a #GMainContext (if %NULL, the default context will be used)
</parameter_description>
</parameter>
-<parameter name="mem">
-<parameter_description> a pointer to the atom to free.
+<parameter name="may_block">
+<parameter_description> whether the call may block.
</parameter_description>
</parameter>
</parameters>
-<return></return>
-</function>
+<return> %TRUE if events were dispatched.
+</return>
+</function>
-<function name="g_mem_chunk_info">
+<function name="g_main_context_new">
<description>
-Outputs debugging information for all #GMemChunk objects currently
-in use. It outputs the number of #GMemChunk objects currently
-allocated, and calls g_mem_chunk_print() to output information on
-each one.
+Creates a new #GMainContext structure.
-Deprecated:2.10: Use the <link linkend="glib-Memory-Slices">slice
-allocator</link> instead
</description>
<parameters>
</parameters>
-<return></return>
+<return> the new #GMainContext
+</return>
</function>
-<function name="g_mem_chunk_new">
+<function name="g_main_context_pending">
<description>
-Creates a new #GMemChunk.
+Checks if any sources have pending events for the given context.
-Deprecated:2.10: Use the <link linkend="glib-Memory-Slices">slice
-allocator</link> instead
</description>
<parameters>
-<parameter name="name">
-<parameter_description> a string to identify the #GMemChunk. It is not copied so it
-should be valid for the lifetime of the #GMemChunk. It is
-only used in g_mem_chunk_print(), which is used for debugging.
-</parameter_description>
-</parameter>
-<parameter name="atom_size">
-<parameter_description> the size, in bytes, of each element in the #GMemChunk.
-</parameter_description>
-</parameter>
-<parameter name="area_size">
-<parameter_description> the size, in bytes, of each block of memory allocated to
-contain the atoms.
-</parameter_description>
-</parameter>
-<parameter name="type">
-<parameter_description> the type of the #GMemChunk. #G_ALLOC_AND_FREE is used if the
-atoms will be freed individually. #G_ALLOC_ONLY should be
-used if atoms will never be freed individually.
-#G_ALLOC_ONLY is quicker, since it does not need to track
-free atoms, but it obviously wastes memory if you no longer
-need many of the atoms.
+<parameter name="context">
+<parameter_description> a #GMainContext (if %NULL, the default context will be used)
</parameter_description>
</parameter>
</parameters>
-<return> the new #GMemChunk.
+<return> %TRUE if events are pending.
</return>
</function>
-<function name="g_mem_chunk_print">
+<function name="g_main_context_pop_thread_default">
<description>
-Outputs debugging information for a #GMemChunk. It outputs the name
-of the #GMemChunk (set with g_mem_chunk_new()), the number of bytes
-used, and the number of blocks of memory allocated.
+Pops @context off the thread-default context stack (verifying that
+it was on the top of the stack).
-Deprecated:2.10: Use the <link linkend="glib-Memory-Slices">slice
-allocator</link> instead
+Since: 2.22
</description>
<parameters>
-<parameter name="mem_chunk">
-<parameter_description> a #GMemChunk.
+<parameter name="context">
+<parameter_description> a #GMainContext object, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_mem_chunk_reset">
+<function name="g_main_context_prepare">
<description>
-Resets a GMemChunk to its initial state. It frees all of the
-currently allocated blocks of memory.
+Prepares to poll sources within a main loop. The resulting information
+for polling is determined by calling g_main_context_query ().
-Deprecated:2.10: Use the <link linkend="glib-Memory-Slices">slice
-allocator</link> instead
</description>
<parameters>
-<parameter name="mem_chunk">
-<parameter_description> a #GMemChunk.
+<parameter name="context">
+<parameter_description> a #GMainContext
+</parameter_description>
+</parameter>
+<parameter name="priority">
+<parameter_description> location to store priority of highest priority
+source already ready.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if some source is ready to be dispatched
+prior to polling.
+</return>
</function>
-<function name="g_mem_gc_friendly">
+<function name="g_main_context_push_thread_default">
<description>
-This variable is %TRUE if the <envar>G_DEBUG</envar> environment variable
-includes the key <link linkend="G_DEBUG">gc-friendly</link>.
+Acquires @context and sets it as the thread-default context for the
+current thread. This will cause certain asynchronous operations
+(such as most <link linkend="gio">gio</link>-based I/O) which are
+started in this thread to run under @context and deliver their
+results to its main loop, rather than running under the global
+default context in the main thread. Note that calling this function
+changes the context returned by
+g_main_context_get_thread_default(), <emphasis>not</emphasis> the
+one returned by g_main_context_default(), so it does not affect the
+context used by functions like g_idle_add().
+
+Normally you would call this function shortly after creating a new
+thread, passing it a #GMainContext which will be run by a
+#GMainLoop in that thread, to set a new default context for all
+async operations in that thread. (In this case, you don't need to
+ever call g_main_context_pop_thread_default().) In some cases
+however, you may want to schedule a single operation in a
+non-default context, or temporarily use a non-default context in
+the main thread. In that case, you can wrap the call to the
+asynchronous operation inside a
+g_main_context_push_thread_default() /
+g_main_context_pop_thread_default() pair, but it is up to you to
+ensure that no other asynchronous operations accidentally get
+started while the non-default context is active.
+
+Beware that libraries that predate this function may not correctly
+handle being used from a thread with a thread-default context. Eg,
+see g_file_supports_thread_contexts().
+
+Since: 2.22
</description>
<parameters>
+<parameter name="context">
+<parameter_description> a #GMainContext, or %NULL for the global default context
+</parameter_description>
+</parameter>
</parameters>
<return></return>
</function>
-<function name="g_mem_is_system_malloc">
+<function name="g_main_context_query">
<description>
-Checks whether the allocator used by g_malloc() is the system's
-malloc implementation. If it returns %TRUE memory allocated with
-malloc() can be used interchangeable with memory allocated using g_malloc().
-This function is useful for avoiding an extra copy of allocated memory returned
-by a non-GLib-based API.
-
-A different allocator can be set using g_mem_set_vtable().
+Determines information necessary to poll this main loop.
</description>
<parameters>
+<parameter name="context">
+<parameter_description> a #GMainContext
+</parameter_description>
+</parameter>
+<parameter name="max_priority">
+<parameter_description> maximum priority source to check
+</parameter_description>
+</parameter>
+<parameter name="timeout_">
+<parameter_description> location to store timeout to be used in polling
+</parameter_description>
+</parameter>
+<parameter name="fds">
+<parameter_description> location to store #GPollFD records that need to be polled.
+</parameter_description>
+</parameter>
+<parameter name="n_fds">
+<parameter_description> length of @fds.
+</parameter_description>
+</parameter>
</parameters>
-<return> if %TRUE, malloc() and g_malloc() can be mixed.
+<return> the number of records actually stored in @fds,
+or, if more than @n_fds records need to be stored, the number
+of records that need to be stored.
</return>
</function>
-<function name="g_mem_profile">
+<function name="g_main_context_ref">
<description>
-Outputs a summary of memory usage.
-
-It outputs the frequency of allocations of different sizes,
-the total number of bytes which have been allocated,
-the total number of bytes which have been freed,
-and the difference between the previous two values, i.e. the number of bytes
-still in use.
+Increases the reference count on a #GMainContext object by one.
-Note that this function will not output anything unless you have
-previously installed the #glib_mem_profiler_table with g_mem_set_vtable().
</description>
<parameters>
-<parameter name="void">
-<parameter_description>
+<parameter name="context">
+<parameter_description> a #GMainContext
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the @context that was passed in (since 2.6)
+</return>
</function>
-<function name="g_mem_set_vtable">
+<function name="g_main_context_release">
<description>
-Sets the #GMemVTable to use for memory allocation. You can use this to provide
-custom memory allocation routines. <emphasis>This function must be called
-before using any other GLib functions.</emphasis> The @vtable only needs to
-provide malloc(), realloc(), and free() functions; GLib can provide default
-implementations of the others. The malloc() and realloc() implementations
-should return %NULL on failure, GLib will handle error-checking for you.
- vtable is copied, so need not persist after this function has been called.
+Releases ownership of a context previously acquired by this thread
+with g_main_context_acquire(). If the context was acquired multiple
+times, the ownership will be released only when g_main_context_release()
+is called as many times as it was acquired.
</description>
<parameters>
-<parameter name="vtable">
-<parameter_description> table of memory allocation routines.
+<parameter name="context">
+<parameter_description> a #GMainContext
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_memdup">
+<function name="g_main_context_remove_poll">
<description>
-Allocates @byte_size bytes of memory, and copies @byte_size bytes into it
-from @mem. If @mem is %NULL it returns %NULL.
-
+Removes file descriptor from the set of file descriptors to be
+polled for a particular context.
</description>
<parameters>
-<parameter name="mem">
-<parameter_description> the memory to copy.
+<parameter name="context">
+<parameter_description>a #GMainContext
</parameter_description>
</parameter>
-<parameter name="byte_size">
-<parameter_description> the number of bytes to copy.
+<parameter name="fd">
+<parameter_description> a #GPollFD descriptor previously added with g_main_context_add_poll()
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to the newly-allocated copy of the memory, or %NULL if @mem
-is %NULL.
-</return>
+<return></return>
</function>
-<function name="g_memmove">
+<function name="g_main_context_set_poll_func">
<description>
-Copies a block of memory @len bytes long, from @src to @dest.
-The source and destination areas may overlap.
+Sets the function to use to handle polling of file descriptors. It
+will be used instead of the poll() system call
+(or GLib's replacement function, which is used where
+poll() isn't available).
-In order to use this function, you must include
-<filename>string.h</filename> yourself, because this macro will
-typically simply resolve to memmove() and GLib does not include
-<filename>string.h</filename> for you.
+This function could possibly be used to integrate the GLib event
+loop with an external event loop.
</description>
<parameters>
-<parameter name="dest">
-<parameter_description> the destination address to copy the bytes to.
-</parameter_description>
-</parameter>
-<parameter name="src">
-<parameter_description> the source address to copy the bytes from.
+<parameter name="context">
+<parameter_description> a #GMainContext
</parameter_description>
</parameter>
-<parameter name="len">
-<parameter_description> the number of bytes to copy.
+<parameter name="func">
+<parameter_description> the function to call to poll all file descriptors
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_mkdir">
+<function name="g_main_context_unref">
<description>
-A wrapper for the POSIX mkdir() function. The mkdir() function
-attempts to create a directory with the given name and permissions.
-The mode argument is ignored on Windows.
-
-See your C library manual for more details about mkdir().
-
-Since: 2.6
+Decreases the reference count on a #GMainContext object by one. If
+the result is zero, free the context and free all associated memory.
</description>
<parameters>
-<parameter name="filename">
-<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows)
-</parameter_description>
-</parameter>
-<parameter name="mode">
-<parameter_description> permissions to use for the newly created directory
+<parameter name="context">
+<parameter_description> a #GMainContext
</parameter_description>
</parameter>
</parameters>
-<return> 0 if the directory was successfully created, -1 if an error
-occurred
-
-</return>
+<return></return>
</function>
-<function name="g_mkdir_with_parents">
+<function name="g_main_context_wait">
<description>
-Create a directory if it doesn't already exist. Create intermediate
-parent directories as needed, too.
+Tries to become the owner of the specified context,
+as with g_main_context_acquire(). But if another thread
+is the owner, atomically drop @mutex and wait on @cond until
+that owner releases ownership or until @cond is signaled, then
+try again (once) to become the owner.
-Since: 2.8
</description>
<parameters>
-<parameter name="pathname">
-<parameter_description> a pathname in the GLib file name encoding
+<parameter name="context">
+<parameter_description> a #GMainContext
</parameter_description>
</parameter>
-<parameter name="mode">
-<parameter_description> permissions to use for newly created directories
+<parameter name="cond">
+<parameter_description> a condition variable
+</parameter_description>
+</parameter>
+<parameter name="mutex">
+<parameter_description> a mutex, currently held
</parameter_description>
</parameter>
</parameters>
-<return> 0 if the directory already exists, or was successfully
-created. Returns -1 if an error occurred, with errno set.
-
+<return> %TRUE if the operation succeeded, and
+this thread is now the owner of @context.
</return>
</function>
-<function name="g_mkstemp">
+<function name="g_main_context_wakeup">
<description>
-Opens a temporary file. See the mkstemp() documentation
-on most UNIX-like systems.
-
-The parameter is a string that should follow the rules for
-mkstemp() templates, i.e. contain the string "XXXXXX".
-g_mkstemp() is slightly more flexible than mkstemp()
-in that the sequence does not have to occur at the very end of the
-template. The X string will
-be modified to form the name of a file that didn't exist.
-The string should be in the GLib file name encoding. Most importantly,
-on Windows it should be in UTF-8.
-
+If @context is currently waiting in a poll(), interrupt
+the poll(), and continue the iteration process.
</description>
<parameters>
-<parameter name="tmpl">
-<parameter_description> template filename
+<parameter name="context">
+<parameter_description> a #GMainContext
</parameter_description>
</parameter>
</parameters>
-<return> A file handle (as from open()) to the file
-opened for reading and writing. The file is opened in binary mode
-on platforms where there is a difference. The file handle should be
-closed with close(). In case of errors, -1 is returned.
-</return>
+<return></return>
</function>
-<function name="g_mkstemp_full">
+<function name="g_main_current_source">
<description>
-Opens a temporary file. See the mkstemp() documentation
-on most UNIX-like systems.
-
-The parameter is a string that should follow the rules for
-mkstemp() templates, i.e. contain the string "XXXXXX".
-g_mkstemp_full() is slightly more flexible than mkstemp()
-in that the sequence does not have to occur at the very end of the
-template and you can pass a @mode and additional @flags. The X
-string will be modified to form the name of a file that didn't exist.
-The string should be in the GLib file name encoding. Most importantly,
-on Windows it should be in UTF-8.
+Returns the currently firing source for this thread.
-Since: 2.22
+Since: 2.12
</description>
<parameters>
-<parameter name="tmpl">
-<parameter_description> template filename
-</parameter_description>
-</parameter>
-<parameter name="flags">
-<parameter_description> flags to pass to an open() call in addition to O_EXCL and
-O_CREAT, which are passed automatically
-</parameter_description>
-</parameter>
-<parameter name="mode">
-<parameter_description> permissios to create the temporary file with
-</parameter_description>
-</parameter>
</parameters>
-<return> A file handle (as from open()) to the file
-opened for reading and writing. The file handle should be
-closed with close(). In case of errors, -1 is returned.
+<return> The currently firing source or %NULL.
</return>
</function>
-<function name="g_mutex_free">
+<function name="g_main_depth">
<description>
-Destroys @mutex.
+Returns the depth of the stack of calls to
+g_main_context_dispatch() on any #GMainContext in the current thread.
+That is, when called from the toplevel, it gives 0. When
+called from within a callback from g_main_context_iteration()
+(or g_main_loop_run(), etc.) it returns 1. When called from within
+a callback to a recursive call to g_main_context_iteration(),
+it returns 2. And so forth.
+
+This function is useful in a situation like the following:
+Imagine an extremely simple "garbage collected" system.
+
+|[
+static GList *free_list;
+
+gpointer
+allocate_memory (gsize size)
+{
+gpointer result = g_malloc (size);
+free_list = g_list_prepend (free_list, result);
+return result;
+}
+
+void
+free_allocated_memory (void)
+{
+GList *l;
+for (l = free_list; l; l = l->next);
+g_free (l->data);
+g_list_free (free_list);
+free_list = NULL;
+}
+
+[...]
+
+while (TRUE);
+{
+g_main_context_iteration (NULL, TRUE);
+free_allocated_memory();
+}
+]|
+
+This works from an application, however, if you want to do the same
+thing from a library, it gets more difficult, since you no longer
+control the main loop. You might think you can simply use an idle
+function to make the call to free_allocated_memory(), but that
+doesn't work, since the idle function could be called from a
+recursive callback. This can be fixed by using g_main_depth()
+
+|[
+gpointer
+allocate_memory (gsize size)
+{
+FreeListBlock *block = g_new (FreeListBlock, 1);
+block->mem = g_malloc (size);
+block->depth = g_main_depth ();
+free_list = g_list_prepend (free_list, block);
+return block->mem;
+}
+
+void
+free_allocated_memory (void)
+{
+GList *l;
+
+int depth = g_main_depth ();
+for (l = free_list; l; );
+{
+GList *next = l->next;
+FreeListBlock *block = l->data;
+if (block->depth > depth)
+{
+g_free (block->mem);
+g_free (block);
+free_list = g_list_delete_link (free_list, l);
+}
+
+l = next;
+}
+}
+]|
+
+There is a temptation to use g_main_depth() to solve
+problems with reentrancy. For instance, while waiting for data
+to be received from the network in response to a menu item,
+the menu item might be selected again. It might seem that
+one could make the menu item's callback return immediately
+and do nothing if g_main_depth() returns a value greater than 1.
+However, this should be avoided since the user then sees selecting
+the menu item do nothing. Furthermore, you'll find yourself adding
+these checks all over your code, since there are doubtless many,
+many things that the user could do. Instead, you can use the
+following techniques:
+
+<orderedlist>
+<listitem>
+<para>
+Use gtk_widget_set_sensitive() or modal dialogs to prevent
+the user from interacting with elements while the main
+loop is recursing.
+</para>
+</listitem>
+<listitem>
+<para>
+Avoid main loop recursion in situations where you can't handle
+arbitrary callbacks. Instead, structure your code so that you
+simply return to the main loop and then get called again when
+there is more work to do.
+</para>
+</listitem>
+</orderedlist>
-<note><para>Calling g_mutex_free() on a locked mutex may result in
-undefined behaviour.</para></note>
</description>
<parameters>
-<parameter name="mutex">
-<parameter_description> a #GMutex.
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> The main loop recursion level in the current thread
+</return>
</function>
-<function name="g_mutex_lock">
+<function name="g_main_loop_get_context">
<description>
-Locks @mutex. If @mutex is already locked by another thread, the
-current thread will block until @mutex is unlocked by the other
-thread.
-
-This function can be used even if g_thread_init() has not yet been
-called, and, in that case, will do nothing.
+Returns the #GMainContext of @loop.
-<note><para>#GMutex is neither guaranteed to be recursive nor to be
-non-recursive, i.e. a thread could deadlock while calling
-g_mutex_lock(), if it already has locked @mutex. Use
-#GStaticRecMutex, if you need recursive mutexes.</para></note>
</description>
<parameters>
-<parameter name="mutex">
-<parameter_description> a #GMutex.
+<parameter name="loop">
+<parameter_description> a #GMainLoop.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the #GMainContext of @loop
+</return>
</function>
-<function name="g_mutex_new">
+<function name="g_main_loop_is_running">
<description>
-Creates a new #GMutex.
+Checks to see if the main loop is currently being run via g_main_loop_run().
-<note><para>This function will abort if g_thread_init() has not been
-called yet.</para></note>
</description>
<parameters>
+<parameter name="loop">
+<parameter_description> a #GMainLoop.
+</parameter_description>
+</parameter>
</parameters>
-<return> a new #GMutex.
+<return> %TRUE if the mainloop is currently being run.
</return>
</function>
-<function name="g_mutex_trylock">
+<function name="g_main_loop_new">
<description>
-Tries to lock @mutex. If @mutex is already locked by another thread,
-it immediately returns %FALSE. Otherwise it locks @mutex and returns
-%TRUE.
-
-This function can be used even if g_thread_init() has not yet been
-called, and, in that case, will immediately return %TRUE.
+Creates a new #GMainLoop structure.
-<note><para>#GMutex is neither guaranteed to be recursive nor to be
-non-recursive, i.e. the return value of g_mutex_trylock() could be
-both %FALSE or %TRUE, if the current thread already has locked
- mutex Use #GStaticRecMutex, if you need recursive
-mutexes.</para></note>
</description>
<parameters>
-<parameter name="mutex">
-<parameter_description> a #GMutex.
+<parameter name="context">
+<parameter_description> a #GMainContext (if %NULL, the default context will be used).
+</parameter_description>
+</parameter>
+<parameter name="is_running">
+<parameter_description> set to %TRUE to indicate that the loop is running. This
+is not very important since calling g_main_loop_run() will set this to
+%TRUE anyway.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE, if @mutex could be locked.
+<return> a new #GMainLoop.
</return>
</function>
-<function name="g_mutex_unlock">
+<function name="g_main_loop_quit">
<description>
-Unlocks @mutex. If another thread is blocked in a g_mutex_lock()
-call for @mutex, it will be woken and can lock @mutex itself.
+Stops a #GMainLoop from running. Any calls to g_main_loop_run()
+for the loop will return.
-This function can be used even if g_thread_init() has not yet been
-called, and, in that case, will do nothing.
+Note that sources that have already been dispatched when
+g_main_loop_quit() is called will still be executed.
</description>
<parameters>
-<parameter name="mutex">
-<parameter_description> a #GMutex.
+<parameter name="loop">
+<parameter_description> a #GMainLoop
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_node_child_index">
+<function name="g_main_loop_ref">
<description>
-Gets the position of the first child of a #GNode
-which contains the given data.
+Increases the reference count on a #GMainLoop object by one.
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #GNode
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> the data to find
+<parameter name="loop">
+<parameter_description> a #GMainLoop
</parameter_description>
</parameter>
</parameters>
-<return> the index of the child of @node which contains
- data, or -1 if the data is not found
+<return> @loop
</return>
</function>
-<function name="g_node_child_position">
+<function name="g_main_loop_run">
<description>
-Gets the position of a #GNode with respect to its siblings.
- child must be a child of @node. The first child is numbered 0,
-the second 1, and so on.
-
+Runs a main loop until g_main_loop_quit() is called on the loop.
+If this is called for the thread of the loop's #GMainContext,
+it will process events from the loop, otherwise it will
+simply wait.
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #GNode
-</parameter_description>
-</parameter>
-<parameter name="child">
-<parameter_description> a child of @node
+<parameter name="loop">
+<parameter_description> a #GMainLoop
</parameter_description>
</parameter>
</parameters>
-<return> the position of @child with respect to its siblings
-</return>
+<return></return>
</function>
-<function name="g_node_children_foreach">
+<function name="g_main_loop_unref">
<description>
-Calls a function for each of the children of a #GNode.
-Note that it doesn't descend beneath the child nodes.
+Decreases the reference count on a #GMainLoop object by one. If
+the result is zero, free the loop and free all associated memory.
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #GNode
-</parameter_description>
-</parameter>
-<parameter name="flags">
-<parameter_description> which types of children are to be visited, one of
-%G_TRAVERSE_ALL, %G_TRAVERSE_LEAVES and %G_TRAVERSE_NON_LEAVES
-</parameter_description>
-</parameter>
-<parameter name="func">
-<parameter_description> the function to call for each visited node
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> user data to pass to the function
+<parameter name="loop">
+<parameter_description> a #GMainLoop
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_node_copy">
+<function name="g_malloc">
<description>
-Recursively copies a #GNode (but does not deep-copy the data inside the
-nodes, see g_node_copy_deep() if you need that).
+Allocates @n_bytes bytes of memory.
+If @n_bytes is 0 it returns %NULL.
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #GNode
+<parameter name="n_bytes">
+<parameter_description> the number of bytes to allocate
</parameter_description>
</parameter>
</parameters>
-<return> a new #GNode containing the same data pointers
+<return> a pointer to the allocated memory
</return>
</function>
-<function name="g_node_copy_deep">
+<function name="g_malloc0">
<description>
-Recursively copies a #GNode and its data.
+Allocates @n_bytes bytes of memory, initialized to 0's.
+If @n_bytes is 0 it returns %NULL.
-Since: 2.4
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #GNode
+<parameter name="n_bytes">
+<parameter_description> the number of bytes to allocate
</parameter_description>
</parameter>
-<parameter name="copy_func">
-<parameter_description> the function which is called to copy the data inside each node,
-or %NULL to use the original data.
+</parameters>
+<return> a pointer to the allocated memory
+</return>
+</function>
+
+<function name="g_malloc0_n">
+<description>
+This function is similar to g_malloc0(), allocating (@n_blocks * @n_block_bytes) bytes,
+but care is taken to detect possible overflow during multiplication.
+
+Since: 2.24
+
+</description>
+<parameters>
+<parameter name="n_blocks">
+<parameter_description> the number of blocks to allocate
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> data to pass to @copy_func
+<parameter name="n_block_bytes">
+<parameter_description> the size of each block in bytes
</parameter_description>
</parameter>
</parameters>
-<return> a new #GNode containing copies of the data in @node.
-
+<return> a pointer to the allocated memory
</return>
</function>
-<function name="g_node_depth">
+<function name="g_malloc_n">
<description>
-Gets the depth of a #GNode.
-
-If @node is %NULL the depth is 0. The root node has a depth of 1.
-For the children of the root node the depth is 2. And so on.
+This function is similar to g_malloc(), allocating (@n_blocks * @n_block_bytes) bytes,
+but care is taken to detect possible overflow during multiplication.
+Since: 2.24
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #GNode
+<parameter name="n_blocks">
+<parameter_description> the number of blocks to allocate
+</parameter_description>
+</parameter>
+<parameter name="n_block_bytes">
+<parameter_description> the size of each block in bytes
</parameter_description>
</parameter>
</parameters>
-<return> the depth of the #GNode
+<return> a pointer to the allocated memory
</return>
</function>
-<function name="g_node_destroy">
+<function name="g_mapped_file_free">
<description>
-Removes @root and its children from the tree, freeing any memory
-allocated.
+This call existed before #GMappedFile had refcounting and is currently
+exactly the same as g_mapped_file_unref().
+
+Since: 2.8
+Deprecated:2.22: Use g_mapped_file_unref() instead.
</description>
<parameters>
-<parameter name="root">
-<parameter_description> the root of the tree/subtree to destroy
+<parameter name="file">
+<parameter_description> a #GMappedFile
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_node_find">
+<function name="g_mapped_file_get_contents">
<description>
-Finds a #GNode in a tree.
+Returns the contents of a #GMappedFile.
+
+Note that the contents may not be zero-terminated,
+even if the #GMappedFile is backed by a text file.
+
+If the file is empty then %NULL is returned.
+Since: 2.8
</description>
<parameters>
-<parameter name="root">
-<parameter_description> the root #GNode of the tree to search
-</parameter_description>
-</parameter>
-<parameter name="order">
-<parameter_description> the order in which nodes are visited - %G_IN_ORDER,
-%G_PRE_ORDER, %G_POST_ORDER, or %G_LEVEL_ORDER
-</parameter_description>
-</parameter>
-<parameter name="flags">
-<parameter_description> which types of children are to be searched, one of
-%G_TRAVERSE_ALL, %G_TRAVERSE_LEAVES and %G_TRAVERSE_NON_LEAVES
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> the data to find
+<parameter name="file">
+<parameter_description> a #GMappedFile
</parameter_description>
</parameter>
</parameters>
-<return> the found #GNode, or %NULL if the data is not found
+<return> the contents of @file, or %NULL.
+
</return>
</function>
-<function name="g_node_find_child">
+<function name="g_mapped_file_get_length">
<description>
-Finds the first child of a #GNode with the given data.
+Returns the length of the contents of a #GMappedFile.
+Since: 2.8
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #GNode
-</parameter_description>
-</parameter>
-<parameter name="flags">
-<parameter_description> which types of children are to be searched, one of
-%G_TRAVERSE_ALL, %G_TRAVERSE_LEAVES and %G_TRAVERSE_NON_LEAVES
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> the data to find
+<parameter name="file">
+<parameter_description> a #GMappedFile
</parameter_description>
</parameter>
</parameters>
-<return> the found child #GNode, or %NULL if the data is not found
+<return> the length of the contents of @file.
+
</return>
</function>
-<function name="g_node_first_sibling">
+<function name="g_mapped_file_new">
<description>
-Gets the first sibling of a #GNode.
-This could possibly be the node itself.
+Maps a file into memory. On UNIX, this is using the mmap() function.
+
+If @writable is %TRUE, the mapped buffer may be modified, otherwise
+it is an error to modify the mapped buffer. Modifications to the buffer
+are not visible to other processes mapping the same file, and are not
+written back to the file.
+
+Note that modifications of the underlying file might affect the contents
+of the #GMappedFile. Therefore, mapping should only be used if the file
+will not be modified, or if all modifications of the file are done
+atomically (e.g. using g_file_set_contents()).
+Since: 2.8
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #GNode
+<parameter name="filename">
+<parameter_description> The path of the file to load, in the GLib filename encoding
+</parameter_description>
+</parameter>
+<parameter name="writable">
+<parameter_description> whether the mapping should be writable
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the first sibling of @node
+<return> a newly allocated #GMappedFile which must be unref'd
+with g_mapped_file_unref(), or %NULL if the mapping failed.
+
</return>
</function>
-<function name="g_node_get_root">
+<function name="g_mapped_file_ref">
<description>
-Gets the root of a tree.
+Increments the reference count of @file by one. It is safe to call
+this function from any thread.
+Since: 2.22
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #GNode
+<parameter name="file">
+<parameter_description> a #GMappedFile
</parameter_description>
</parameter>
</parameters>
-<return> the root of the tree
+<return> the passed in #GMappedFile.
+
</return>
</function>
-<function name="g_node_insert">
+<function name="g_mapped_file_unref">
<description>
-Inserts a #GNode beneath the parent at the given position.
+Decrements the reference count of @file by one. If the reference count
+drops to 0, unmaps the buffer of @file and frees it.
+It is safe to call this function from any thread.
+
+Since 2.22
</description>
<parameters>
-<parameter name="parent">
-<parameter_description> the #GNode to place @node under
-</parameter_description>
-</parameter>
-<parameter name="position">
-<parameter_description> the position to place @node at, with respect to its siblings
-If position is -1, @node is inserted as the last child of @parent
-</parameter_description>
-</parameter>
-<parameter name="node">
-<parameter_description> the #GNode to insert
+<parameter name="file">
+<parameter_description> a #GMappedFile
</parameter_description>
</parameter>
</parameters>
-<return> the inserted #GNode
-</return>
+<return></return>
</function>
-<function name="g_node_insert_after">
+<function name="g_markup_collect_attributes">
<description>
-Inserts a #GNode beneath the parent after the given sibling.
+Collects the attributes of the element from the data passed to the
+#GMarkupParser start_element function, dealing with common error
+conditions and supporting boolean values.
+
+This utility function is not required to write a parser but can save
+a lot of typing.
+
+The @element_name, @attribute_names, @attribute_values and @error
+parameters passed to the start_element callback should be passed
+unmodified to this function.
+
+Following these arguments is a list of "supported" attributes to collect.
+It is an error to specify multiple attributes with the same name. If any
+attribute not in the list appears in the @attribute_names array then an
+unknown attribute error will result.
+
+The #GMarkupCollectType field allows specifying the type of collection
+to perform and if a given attribute must appear or is optional.
+
+The attribute name is simply the name of the attribute to collect.
+
+The pointer should be of the appropriate type (see the descriptions
+under #GMarkupCollectType) and may be %NULL in case a particular
+attribute is to be allowed but ignored.
+
+This function deals with issuing errors for missing attributes
+(of type %G_MARKUP_ERROR_MISSING_ATTRIBUTE), unknown attributes
+(of type %G_MARKUP_ERROR_UNKNOWN_ATTRIBUTE) and duplicate
+attributes (of type %G_MARKUP_ERROR_INVALID_CONTENT) as well
+as parse errors for boolean-valued attributes (again of type
+%G_MARKUP_ERROR_INVALID_CONTENT). In all of these cases %FALSE
+will be returned and @error will be set as appropriate.
+Since: 2.16
</description>
<parameters>
-<parameter name="parent">
-<parameter_description> the #GNode to place @node under
+<parameter name="element_name">
+<parameter_description> the current tag name
</parameter_description>
</parameter>
-<parameter name="sibling">
-<parameter_description> the sibling #GNode to place @node after.
-If sibling is %NULL, the node is inserted as the first child of @parent.
+<parameter name="attribute_names">
+<parameter_description> the attribute names
</parameter_description>
</parameter>
-<parameter name="node">
-<parameter_description> the #GNode to insert
+<parameter name="attribute_values">
+<parameter_description> the attribute values
</parameter_description>
</parameter>
-</parameters>
-<return> the inserted #GNode
-</return>
-</function>
-
-<function name="g_node_insert_before">
-<description>
-Inserts a #GNode beneath the parent before the given sibling.
-
-
-</description>
-<parameters>
-<parameter name="parent">
-<parameter_description> the #GNode to place @node under
+<parameter name="error">
+<parameter_description> a pointer to a #GError or %NULL
</parameter_description>
</parameter>
-<parameter name="sibling">
-<parameter_description> the sibling #GNode to place @node before.
-If sibling is %NULL, the node is inserted as the last child of @parent.
+<parameter name="first_type">
+<parameter_description> the #GMarkupCollectType of the first attribute
</parameter_description>
</parameter>
-<parameter name="node">
-<parameter_description> the #GNode to insert
+<parameter name="first_attr">
+<parameter_description> the name of the first attribute
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> a pointer to the storage location of the first attribute
+(or %NULL), followed by more types names and pointers, ending
+with %G_MARKUP_COLLECT_INVALID
</parameter_description>
</parameter>
</parameters>
-<return> the inserted #GNode
+<return> %TRUE if successful
+
</return>
</function>
-<function name="g_node_is_ancestor">
+<function name="g_markup_escape_text">
<description>
-Returns %TRUE if @node is an ancestor of @descendant.
-This is true if node is the parent of @descendant,
-or if node is the grandparent of @descendant etc.
+Escapes text so that the markup parser will parse it verbatim.
+Less than, greater than, ampersand, etc. are replaced with the
+corresponding entities. This function would typically be used
+when writing out a file to be parsed with the markup parser.
+
+Note that this function doesn't protect whitespace and line endings
+from being processed according to the XML rules for normalization
+of line endings and attribute values.
+
+Note also that this function will produce character references in
+the range of &#x1; ... &#x1f; for all control sequences
+except for tabstop, newline and carriage return. The character
+references in this range are not valid XML 1.0, but they are
+valid XML 1.1 and will be accepted by the GMarkup parser.
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #GNode
+<parameter name="text">
+<parameter_description> some valid UTF-8 text
</parameter_description>
</parameter>
-<parameter name="descendant">
-<parameter_description> a #GNode
+<parameter name="length">
+<parameter_description> length of @text in bytes, or -1 if the text is nul-terminated
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @node is an ancestor of @descendant
+<return> a newly allocated string with the escaped text
</return>
</function>
-<function name="g_node_last_child">
+<function name="g_markup_parse_context_end_parse">
<description>
-Gets the last child of a #GNode.
+Signals to the #GMarkupParseContext that all data has been
+fed into the parse context with g_markup_parse_context_parse().
+
+This function reports an error if the document isn't complete,
+for example if elements are still open.
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #GNode (must not be %NULL)
+<parameter name="context">
+<parameter_description> a #GMarkupParseContext
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError
</parameter_description>
</parameter>
</parameters>
-<return> the last child of @node, or %NULL if @node has no children
+<return> %TRUE on success, %FALSE if an error was set
</return>
</function>
-<function name="g_node_last_sibling">
+<function name="g_markup_parse_context_free">
<description>
-Gets the last sibling of a #GNode.
-This could possibly be the node itself.
+Frees a #GMarkupParseContext.
+This function can't be called from inside one of the
+#GMarkupParser functions or while a subparser is pushed.
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #GNode
+<parameter name="context">
+<parameter_description> a #GMarkupParseContext
</parameter_description>
</parameter>
</parameters>
-<return> the last sibling of @node
-</return>
+<return></return>
</function>
-<function name="g_node_max_height">
+<function name="g_markup_parse_context_get_element">
<description>
-Gets the maximum height of all branches beneath a #GNode.
-This is the maximum distance from the #GNode to all leaf nodes.
+Retrieves the name of the currently open element.
-If @root is %NULL, 0 is returned. If @root has no children,
-1 is returned. If @root has children, 2 is returned. And so on.
+If called from the start_element or end_element handlers this will
+give the element_name as passed to those functions. For the parent
+elements, see g_markup_parse_context_get_element_stack().
+Since: 2.2
</description>
<parameters>
-<parameter name="root">
-<parameter_description> a #GNode
+<parameter name="context">
+<parameter_description> a #GMarkupParseContext
</parameter_description>
</parameter>
</parameters>
-<return> the maximum height of the tree beneath @root
+<return> the name of the currently open element, or %NULL
+
</return>
</function>
-<function name="g_node_n_children">
+<function name="g_markup_parse_context_get_element_stack">
<description>
-Gets the number of children of a #GNode.
+Retrieves the element stack from the internal state of the parser.
+
+The returned #GSList is a list of strings where the first item is
+the currently open tag (as would be returned by
+g_markup_parse_context_get_element()) and the next item is its
+immediate parent.
+
+This function is intended to be used in the start_element and
+end_element handlers where g_markup_parse_context_get_element()
+would merely return the name of the element that is being
+processed.
+Since: 2.16
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #GNode
+<parameter name="context">
+<parameter_description> a #GMarkupParseContext
</parameter_description>
</parameter>
</parameters>
-<return> the number of children of @node
+<return> the element stack, which must not be modified
+
</return>
</function>
-<function name="g_node_n_nodes">
+<function name="g_markup_parse_context_get_position">
<description>
-Gets the number of nodes in a tree.
-
+Retrieves the current line number and the number of the character on
+that line. Intended for use in error messages; there are no strict
+semantics for what constitutes the "current" line number other than
+"the best number we could come up with for error messages."
</description>
<parameters>
-<parameter name="root">
-<parameter_description> a #GNode
+<parameter name="context">
+<parameter_description> a #GMarkupParseContext
</parameter_description>
</parameter>
-<parameter name="flags">
-<parameter_description> which types of children are to be counted, one of
-%G_TRAVERSE_ALL, %G_TRAVERSE_LEAVES and %G_TRAVERSE_NON_LEAVES
+<parameter name="line_number">
+<parameter_description> return location for a line number, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="char_number">
+<parameter_description> return location for a char-on-line number, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the number of nodes in the tree
-</return>
+<return></return>
</function>
-<function name="g_node_new">
+<function name="g_markup_parse_context_get_user_data">
<description>
-Creates a new #GNode containing the given data.
-Used to create the first node in a tree.
+Returns the user_data associated with @context.
+
+This will either be the user_data that was provided to
+g_markup_parse_context_new() or to the most recent call
+of g_markup_parse_context_push().
+Since: 2.18
</description>
<parameters>
-<parameter name="data">
-<parameter_description> the data of the new node
+<parameter name="context">
+<parameter_description> a #GMarkupParseContext
</parameter_description>
</parameter>
</parameters>
-<return> a new #GNode
+<return> the provided user_data. The returned data belongs to
+the markup context and will be freed when
+g_markup_parse_context_free() is called.
+
</return>
</function>
-<function name="g_node_nth_child">
+<function name="g_markup_parse_context_new">
<description>
-Gets a child of a #GNode, using the given index.
-The first child is at index 0. If the index is
-too big, %NULL is returned.
+Creates a new parse context. A parse context is used to parse
+marked-up documents. You can feed any number of documents into
+a context, as long as no errors occur; once an error occurs,
+the parse context can't continue to parse text (you have to
+free it and create a new parse context).
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #GNode
+<parameter name="parser">
+<parameter_description> a #GMarkupParser
</parameter_description>
</parameter>
-<parameter name="n">
-<parameter_description> the index of the desired child
+<parameter name="flags">
+<parameter_description> one or more #GMarkupParseFlags
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> user data to pass to #GMarkupParser functions
+</parameter_description>
+</parameter>
+<parameter name="user_data_dnotify">
+<parameter_description> user data destroy notifier called when
+the parse context is freed
</parameter_description>
</parameter>
</parameters>
-<return> the child of @node at index @n
+<return> a new #GMarkupParseContext
</return>
</function>
-<function name="g_node_pop_allocator">
+<function name="g_markup_parse_context_parse">
<description>
-Restores the previous #GAllocator, used when allocating #GNode
-elements.
-
-Note that this function is not available if GLib has been compiled
-with <option>--disable-mem-pools</option>
-
-Deprecated:2.10: It does nothing, since #GNode has been converted to
-the <link linkend="glib-Memory-Slices">slice
-allocator</link>
-
-</description>
-<parameters>
-</parameters>
-<return></return>
-</function>
+Feed some data to the #GMarkupParseContext.
-<function name="g_node_prepend">
-<description>
-Inserts a #GNode as the first child of the given parent.
+The data need not be valid UTF-8; an error will be signaled if
+it's invalid. The data need not be an entire document; you can
+feed a document into the parser incrementally, via multiple calls
+to this function. Typically, as you receive data from a network
+connection or file, you feed each received chunk of data into this
+function, aborting the process if an error occurs. Once an error
+is reported, no further data may be fed to the #GMarkupParseContext;
+all errors are fatal.
</description>
<parameters>
-<parameter name="parent">
-<parameter_description> the #GNode to place the new #GNode under
+<parameter name="context">
+<parameter_description> a #GMarkupParseContext
</parameter_description>
</parameter>
-<parameter name="node">
-<parameter_description> the #GNode to insert
+<parameter name="text">
+<parameter_description> chunk of text to parse
+</parameter_description>
+</parameter>
+<parameter name="text_len">
+<parameter_description> length of @text in bytes
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError
</parameter_description>
</parameter>
</parameters>
-<return> the inserted #GNode
+<return> %FALSE if an error occurred, %TRUE on success
</return>
</function>
-<function name="g_node_push_allocator">
+<function name="g_markup_parse_context_pop">
<description>
-Sets the allocator to use to allocate #GNode elements. Use
-g_node_pop_allocator() to restore the previous allocator.
+Completes the process of a temporary sub-parser redirection.
-Note that this function is not available if GLib has been compiled
-with <option>--disable-mem-pools</option>
+This function exists to collect the user_data allocated by a
+matching call to g_markup_parse_context_push(). It must be called
+in the end_element handler corresponding to the start_element
+handler during which g_markup_parse_context_push() was called.
+You must not call this function from the error callback -- the
+ user_data is provided directly to the callback in that case.
-Deprecated:2.10: It does nothing, since #GNode has been converted to
-the <link linkend="glib-Memory-Slices">slice
-allocator</link>
+This function is not intended to be directly called by users
+interested in invoking subparsers. Instead, it is intended to
+be used by the subparsers themselves to implement a higher-level
+interface.
+
+Since: 2.18
</description>
<parameters>
-<parameter name="dummy">
-<parameter_description> the #GAllocator to use when allocating #GNode elements.
+<parameter name="context">
+<parameter_description> a #GMarkupParseContext
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the user data passed to g_markup_parse_context_push()
+
+</return>
</function>
-<function name="g_node_reverse_children">
+<function name="g_markup_parse_context_push">
<description>
-Reverses the order of the children of a #GNode.
-(It doesn't change the order of the grandchildren.)
+Temporarily redirects markup data to a sub-parser.
-</description>
-<parameters>
-<parameter name="node">
-<parameter_description> a #GNode.
-</parameter_description>
-</parameter>
-</parameters>
-<return></return>
-</function>
+This function may only be called from the start_element handler of
+a #GMarkupParser. It must be matched with a corresponding call to
+g_markup_parse_context_pop() in the matching end_element handler
+(except in the case that the parser aborts due to an error).
-<function name="g_node_traverse">
-<description>
-Traverses a tree starting at the given root #GNode.
-It calls the given function for each node visited.
-The traversal can be halted at any point by returning %TRUE from @func.
+All tags, text and other data between the matching tags is
+redirected to the subparser given by @parser. @user_data is used
+as the user_data for that parser. @user_data is also passed to the
+error callback in the event that an error occurs. This includes
+errors that occur in subparsers of the subparser.
+
+The end tag matching the start tag for which this call was made is
+handled by the previous parser (which is given its own user_data)
+which is why g_markup_parse_context_pop() is provided to allow "one
+last access" to the @user_data provided to this function. In the
+case of error, the @user_data provided here is passed directly to
+the error callback of the subparser and g_markup_parse_context_pop()
+should not be called. In either case, if @user_data was allocated
+then it ought to be freed from both of these locations.
+
+This function is not intended to be directly called by users
+interested in invoking subparsers. Instead, it is intended to be
+used by the subparsers themselves to implement a higher-level
+interface.
+
+As an example, see the following implementation of a simple
+parser that counts the number of tags encountered.
+
+|[
+typedef struct
+{
+gint tag_count;
+} CounterData;
+
+static void
+counter_start_element (GMarkupParseContext *context,
+const gchar *element_name,
+const gchar **attribute_names,
+const gchar **attribute_values,
+gpointer user_data,
+GError **error)
+{
+CounterData *data = user_data;
+
+data->tag_count++;
+}
+
+static void
+counter_error (GMarkupParseContext *context,
+GError *error,
+gpointer user_data)
+{
+CounterData *data = user_data;
+
+g_slice_free (CounterData, data);
+}
+
+static GMarkupParser counter_subparser =
+{
+counter_start_element,
+NULL,
+NULL,
+NULL,
+counter_error
+};
+]|
+
+In order to allow this parser to be easily used as a subparser, the
+following interface is provided:
+
+|[
+void
+start_counting (GMarkupParseContext *context)
+{
+CounterData *data = g_slice_new (CounterData);
+
+data->tag_count = 0;
+g_markup_parse_context_push (context, &counter_subparser, data);
+}
+
+gint
+end_counting (GMarkupParseContext *context)
+{
+CounterData *data = g_markup_parse_context_pop (context);
+int result;
+
+result = data->tag_count;
+g_slice_free (CounterData, data);
+
+return result;
+}
+]|
+
+The subparser would then be used as follows:
+
+|[
+static void start_element (context, element_name, ...)
+{
+if (strcmp (element_name, "count-these") == 0)
+start_counting (context);
+
+/ * else, handle other tags... * /
+}
+
+static void end_element (context, element_name, ...)
+{
+if (strcmp (element_name, "count-these") == 0)
+g_print ("Counted %d tags\n", end_counting (context));
+
+/ * else, handle other tags... * /
+}
+]|
+
+Since: 2.18
</description>
<parameters>
-<parameter name="root">
-<parameter_description> the root #GNode of the tree to traverse
-</parameter_description>
-</parameter>
-<parameter name="order">
-<parameter_description> the order in which nodes are visited - %G_IN_ORDER,
-%G_PRE_ORDER, %G_POST_ORDER, or %G_LEVEL_ORDER.
-</parameter_description>
-</parameter>
-<parameter name="flags">
-<parameter_description> which types of children are to be visited, one of
-%G_TRAVERSE_ALL, %G_TRAVERSE_LEAVES and %G_TRAVERSE_NON_LEAVES
-</parameter_description>
-</parameter>
-<parameter name="max_depth">
-<parameter_description> the maximum depth of the traversal. Nodes below this
-depth will not be visited. If max_depth is -1 all nodes in
-the tree are visited. If depth is 1, only the root is visited.
-If depth is 2, the root and its children are visited. And so on.
+<parameter name="context">
+<parameter_description> a #GMarkupParseContext
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> the function to call for each visited #GNode
+<parameter name="parser">
+<parameter_description> a #GMarkupParser
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> user data to pass to the function
+<parameter name="user_data">
+<parameter_description> user data to pass to #GMarkupParser functions
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_node_unlink">
+<function name="g_markup_printf_escaped">
<description>
-Unlinks a #GNode from a tree, resulting in two separate trees.
+Formats arguments according to @format, escaping
+all string and character arguments in the fashion
+of g_markup_escape_text(). This is useful when you
+want to insert literal strings into XML-style markup
+output, without having to worry that the strings
+might themselves contain markup.
+
+|[
+const char *store = "Fortnum & Mason";
+const char *item = "Tea";
+char *output;
+ 
+output = g_markup_printf_escaped ("<purchase>"
+"<store>%s</store>"
+"<item>%s</item>"
+"</purchase>",
+store, item);
+]|
+
+Since: 2.4
</description>
<parameters>
-<parameter name="node">
-<parameter_description> the #GNode to unlink, which becomes the root of a new tree
+<parameter name="format">
+<parameter_description> printf() style format string
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> the arguments to insert in the format string
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> newly allocated result from formatting
+operation. Free with g_free().
+
+</return>
</function>
-<function name="g_nullify_pointer">
+<function name="g_markup_vprintf_escaped">
<description>
-Set the pointer at the specified location to %NULL.
+Formats the data in @args according to @format, escaping
+all string and character arguments in the fashion
+of g_markup_escape_text(). See g_markup_printf_escaped().
+
+Since: 2.4
</description>
<parameters>
-<parameter name="nullify_location">
-<parameter_description> the memory address of the pointer.
+<parameter name="format">
+<parameter_description> printf() style format string
+</parameter_description>
+</parameter>
+<parameter name="args">
+<parameter_description> variable argument list, similar to vprintf()
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> newly allocated result from formatting
+operation. Free with g_free().
+
+</return>
</function>
-<function name="g_once">
+<function name="g_match_info_expand_references">
<description>
-The first call to this routine by a process with a given #GOnce
-struct calls @func with the given argument. Thereafter, subsequent
-calls to g_once() with the same #GOnce struct do not call @func
-again, but return the stored result of the first call. On return
-from g_once(), the status of @once will be %G_ONCE_STATUS_READY.
-
-For example, a mutex or a thread-specific data key must be created
-exactly once. In a threaded environment, calling g_once() ensures
-that the initialization is serialized across multiple threads.
-
-<note><para>Calling g_once() recursively on the same #GOnce struct in
- func will lead to a deadlock.</para></note>
+Returns a new string containing the text in @string_to_expand with
+references and escape sequences expanded. References refer to the last
+match done with @string against @regex and have the same syntax used by
+g_regex_replace().
-<informalexample>
-<programlisting>
-gpointer
-get_debug_flags (void)
-{
-static GOnce my_once = G_ONCE_INIT;
+The @string_to_expand must be UTF-8 encoded even if #G_REGEX_RAW was
+passed to g_regex_new().
-g_once (&my_once, parse_debug_flags, NULL);
+The backreferences are extracted from the string passed to the match
+function, so you cannot call this function after freeing the string.
-return my_once.retval;
-}
-</programlisting>
-</informalexample>
+ match_info may be %NULL in which case @string_to_expand must not
+contain references. For instance "foo\n" does not refer to an actual
+pattern and '\n' merely will be replaced with \n character,
+while to expand "\0" (whole match) one needs the result of a match.
+Use g_regex_check_replacement() to find out whether @string_to_expand
+contains references.
-Since: 2.4
+Since: 2.14
</description>
<parameters>
-<parameter name="once">
-<parameter_description> a #GOnce structure
+<parameter name="match_info">
+<parameter_description> a #GMatchInfo or %NULL
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> the #GThreadFunc function associated to @once. This function
-is called only once, regardless of the number of times it and
-its associated #GOnce struct are passed to g_once().
+<parameter name="string_to_expand">
+<parameter_description> the string to expand
</parameter_description>
</parameter>
-<parameter name="arg">
-<parameter_description> data to be passed to @func
+<parameter name="error">
+<parameter_description> location to store the error occuring, or %NULL to ignore errors
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the expanded string, or %NULL if an error occurred
+
+</return>
</function>
-<function name="g_once_init_enter">
+<function name="g_match_info_fetch">
<description>
-Function to be called when starting a critical initialization
-section. The argument @value_location must point to a static
-0-initialized variable that will be set to a value other than 0 at
-the end of the initialization section. In combination with
-g_once_init_leave() and the unique address @value_location, it can
-be ensured that an initialization section will be executed only once
-during a program's life time, and that concurrent threads are
-blocked until initialization completed. To be used in constructs
-like this:
-
-<informalexample>
-<programlisting>
-static gsize initialization_value = 0;
+Retrieves the text matching the @match_num<!-- -->'th capturing
+parentheses. 0 is the full text of the match, 1 is the first paren
+set, 2 the second, and so on.
-if (g_once_init_enter (&initialization_value))
-{
-gsize setup_value = 42; /<!-- -->* initialization code here *<!-- -->/
+If @match_num is a valid sub pattern but it didn't match anything
+(e.g. sub pattern 1, matching "b" against "(a)?b") then an empty
+string is returned.
-g_once_init_leave (&initialization_value, setup_value);
-}
+If the match was obtained using the DFA algorithm, that is using
+g_regex_match_all() or g_regex_match_all_full(), the retrieved
+string is not that of a set of parentheses but that of a matched
+substring. Substrings are matched in reverse order of length, so
+0 is the longest match.
-/<!-- -->* use initialization_value here *<!-- -->/
-</programlisting>
-</informalexample>
+The string is fetched from the string passed to the match function,
+so you cannot call this function after freeing the string.
Since: 2.14
</description>
<parameters>
-<parameter name="value_location">
-<parameter_description> location of a static initializable variable
-containing 0.
+<parameter name="match_info">
+<parameter_description> #GMatchInfo structure
+</parameter_description>
+</parameter>
+<parameter name="match_num">
+<parameter_description> number of the sub expression
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the initialization section should be entered,
-%FALSE and blocks otherwise
+<return> The matched substring, or %NULL if an error
+occurred. You have to free the string yourself
+
</return>
</function>
-<function name="g_once_init_leave">
+<function name="g_match_info_fetch_all">
<description>
-Counterpart to g_once_init_enter(). Expects a location of a static
-0-initialized initialization variable, and an initialization value
-other than 0. Sets the variable to the initialization value, and
-releases concurrent threads blocking in g_once_init_enter() on this
-initialization variable.
+Bundles up pointers to each of the matching substrings from a match
+and stores them in an array of gchar pointers. The first element in
+the returned array is the match number 0, i.e. the entire matched
+text.
+
+If a sub pattern didn't match anything (e.g. sub pattern 1, matching
+"b" against "(a)?b") then an empty string is inserted.
+
+If the last match was obtained using the DFA algorithm, that is using
+g_regex_match_all() or g_regex_match_all_full(), the retrieved
+strings are not that matched by sets of parentheses but that of the
+matched substring. Substrings are matched in reverse order of length,
+so the first one is the longest match.
+
+The strings are fetched from the string passed to the match function,
+so you cannot call this function after freeing the string.
Since: 2.14
</description>
<parameters>
-<parameter name="value_location">
-<parameter_description> location of a static initializable variable
-containing 0.
-</parameter_description>
-</parameter>
-<parameter name="initialization_value">
-<parameter_description> new non-0 value for * value_location
+<parameter name="match_info">
+<parameter_description> a #GMatchInfo structure
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a %NULL-terminated array of gchar * pointers.
+It must be freed using g_strfreev(). If the previous match failed
+%NULL is returned
+
+</return>
</function>
-<function name="g_open">
+<function name="g_match_info_fetch_named">
<description>
-A wrapper for the POSIX open() function. The open() function is
-used to convert a pathname into a file descriptor.
-
-On POSIX systems file descriptors are implemented by the operating
-system. On Windows, it's the C library that implements open() and
-file descriptors. The actual Win32 API for opening files is quite
-different, see MSDN documentation for CreateFile(). The Win32 API
-uses file handles, which are more randomish integers, not small
-integers like file descriptors.
+Retrieves the text matching the capturing parentheses named @name.
-Because file descriptors are specific to the C library on Windows,
-the file descriptor returned by this function makes sense only to
-functions in the same C library. Thus if the GLib-using code uses a
-different C library than GLib does, the file descriptor returned by
-this function cannot be passed to C library functions like write()
-or read().
+If @name is a valid sub pattern name but it didn't match anything
+(e.g. sub pattern "X", matching "b" against "(?P<X>a)?b")
+then an empty string is returned.
-See your C library manual for more details about open().
+The string is fetched from the string passed to the match function,
+so you cannot call this function after freeing the string.
-Since: 2.6
+Since: 2.14
</description>
<parameters>
-<parameter name="filename">
-<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows)
-</parameter_description>
-</parameter>
-<parameter name="flags">
-<parameter_description> as in open()
+<parameter name="match_info">
+<parameter_description> #GMatchInfo structure
</parameter_description>
</parameter>
-<parameter name="mode">
-<parameter_description> as in open()
+<parameter name="name">
+<parameter_description> name of the subexpression
</parameter_description>
</parameter>
</parameters>
-<return> a new file descriptor, or -1 if an error occurred. The
-return value can be used exactly like the return value from open().
+<return> The matched substring, or %NULL if an error
+occurred. You have to free the string yourself
</return>
</function>
-<function name="g_option_context_add_group">
+<function name="g_match_info_fetch_named_pos">
<description>
-Adds a #GOptionGroup to the @context, so that parsing with @context
-will recognize the options in the group. Note that the group will
-be freed together with the context when g_option_context_free() is
-called, so you must not free the group yourself after adding it
-to a context.
+Retrieves the position in bytes of the capturing parentheses named @name.
-Since: 2.6
+If @name is a valid sub pattern name but it didn't match anything
+(e.g. sub pattern "X", matching "b" against "(?P<X>a)?b")
+then @start_pos and @end_pos are set to -1 and %TRUE is returned.
+
+Since: 2.14
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GOptionContext
+<parameter name="match_info">
+<parameter_description> #GMatchInfo structure
</parameter_description>
</parameter>
-<parameter name="group">
-<parameter_description> the group to add
+<parameter name="name">
+<parameter_description> name of the subexpression
+</parameter_description>
+</parameter>
+<parameter name="start_pos">
+<parameter_description> pointer to location where to store
+the start position, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="end_pos">
+<parameter_description> pointer to location where to store
+the end position, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the position was fetched, %FALSE otherwise.
+If the position cannot be fetched, @start_pos and @end_pos
+are left unchanged.
+
+</return>
</function>
-<function name="g_option_context_add_main_entries">
+<function name="g_match_info_fetch_pos">
<description>
-A convenience function which creates a main group if it doesn't
-exist, adds the @entries to it and sets the translation domain.
+Retrieves the position in bytes of the @match_num<!-- -->'th capturing
+parentheses. 0 is the full text of the match, 1 is the first
+paren set, 2 the second, and so on.
-Since: 2.6
+If @match_num is a valid sub pattern but it didn't match anything
+(e.g. sub pattern 1, matching "b" against "(a)?b") then @start_pos
+and @end_pos are set to -1 and %TRUE is returned.
+
+If the match was obtained using the DFA algorithm, that is using
+g_regex_match_all() or g_regex_match_all_full(), the retrieved
+position is not that of a set of parentheses but that of a matched
+substring. Substrings are matched in reverse order of length, so
+0 is the longest match.
+
+Since: 2.14
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GOptionContext
+<parameter name="match_info">
+<parameter_description> #GMatchInfo structure
</parameter_description>
</parameter>
-<parameter name="entries">
-<parameter_description> a %NULL-terminated array of #GOptionEntry<!-- -->s
+<parameter name="match_num">
+<parameter_description> number of the sub expression
</parameter_description>
</parameter>
-<parameter name="translation_domain">
-<parameter_description> a translation domain to use for translating
-the <option>--help</option> output for the options in @entries
-with gettext(), or %NULL
+<parameter name="start_pos">
+<parameter_description> pointer to location where to store
+the start position, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="end_pos">
+<parameter_description> pointer to location where to store
+the end position, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the position was fetched, %FALSE otherwise. If
+the position cannot be fetched, @start_pos and @end_pos are left
+unchanged
+
+</return>
</function>
-<function name="g_option_context_free">
+<function name="g_match_info_free">
<description>
-Frees context and all the groups which have been
-added to it.
-
-Please note that parsed arguments need to be freed separately (see
-#GOptionEntry).
+Frees all the memory associated with the #GMatchInfo structure.
-Since: 2.6
+Since: 2.14
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GOptionContext
+<parameter name="match_info">
+<parameter_description> a #GMatchInfo
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_option_context_get_description">
+<function name="g_match_info_get_match_count">
<description>
-Returns the description. See g_option_context_set_description().
+Retrieves the number of matched substrings (including substring 0,
+that is the whole matched text), so 1 is returned if the pattern
+has no substrings in it and 0 is returned if the match failed.
-Since: 2.12
+If the last match was obtained using the DFA algorithm, that is
+using g_regex_match_all() or g_regex_match_all_full(), the retrieved
+count is not that of the number of capturing parentheses but that of
+the number of matched substrings.
+
+Since: 2.14
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GOptionContext
+<parameter name="match_info">
+<parameter_description> a #GMatchInfo structure
</parameter_description>
</parameter>
</parameters>
-<return> the description
+<return> Number of matched substrings, or -1 if an error occurred
</return>
</function>
-<function name="g_option_context_get_help">
+<function name="g_match_info_get_regex">
<description>
-Returns a formatted, translated help text for the given context.
-To obtain the text produced by <option>--help</option>, call
-<literal>g_option_context_get_help (context, TRUE, NULL)</literal>.
-To obtain the text produced by <option>--help-all</option>, call
-<literal>g_option_context_get_help (context, FALSE, NULL)</literal>.
-To obtain the help text for an option group, call
-<literal>g_option_context_get_help (context, FALSE, group)</literal>.
+Returns #GRegex object used in @match_info. It belongs to Glib
+and must not be freed. Use g_regex_ref() if you need to keep it
+after you free @match_info object.
Since: 2.14
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GOptionContext
-</parameter_description>
-</parameter>
-<parameter name="main_help">
-<parameter_description> if %TRUE, only include the main group
-</parameter_description>
-</parameter>
-<parameter name="group">
-<parameter_description> the #GOptionGroup to create help for, or %NULL
+<parameter name="match_info">
+<parameter_description> a #GMatchInfo
</parameter_description>
</parameter>
</parameters>
-<return> A newly allocated string containing the help text
+<return> #GRegex object used in @match_info
</return>
</function>
-<function name="g_option_context_get_help_enabled">
+<function name="g_match_info_get_string">
<description>
-Returns whether automatic <option>--help</option> generation
-is turned on for @context. See g_option_context_set_help_enabled().
+Returns the string searched with @match_info. This is the
+string passed to g_regex_match() or g_regex_replace() so
+you may not free it before calling this function.
-Since: 2.6
+Since: 2.14
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GOptionContext
+<parameter name="match_info">
+<parameter_description> a #GMatchInfo
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if automatic help generation is turned on.
+<return> the string searched with @match_info
</return>
</function>
-<function name="g_option_context_get_ignore_unknown_options">
+<function name="g_match_info_is_partial_match">
<description>
-Returns whether unknown options are ignored or not. See
-g_option_context_set_ignore_unknown_options().
+Usually if the string passed to g_regex_match*() matches as far as
+it goes, but is too short to match the entire pattern, %FALSE is
+returned. There are circumstances where it might be helpful to
+distinguish this case from other cases in which there is no match.
-Since: 2.6
+Consider, for example, an application where a human is required to
+type in data for a field with specific formatting requirements. An
+example might be a date in the form ddmmmyy, defined by the pattern
+"^\d?\d(jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec)\d\d$".
+If the application sees the userâs keystrokes one by one, and can
+check that what has been typed so far is potentially valid, it is
+able to raise an error as soon as a mistake is made.
+
+GRegex supports the concept of partial matching by means of the
+#G_REGEX_MATCH_PARTIAL flag. When this is set the return code for
+g_regex_match() or g_regex_match_full() is, as usual, %TRUE
+for a complete match, %FALSE otherwise. But, when these functions
+return %FALSE, you can check if the match was partial calling
+g_match_info_is_partial_match().
+
+When using partial matching you cannot use g_match_info_fetch*().
+
+Because of the way certain internal optimizations are implemented
+the partial matching algorithm cannot be used with all patterns.
+So repeated single characters such as "a{2,4}" and repeated single
+meta-sequences such as "\d+" are not permitted if the maximum number
+of occurrences is greater than one. Optional items such as "\d?"
+(where the maximum is one) are permitted. Quantifiers with any values
+are permitted after parentheses, so the invalid examples above can be
+coded thus "(a){2,4}" and "(\d)+". If #G_REGEX_MATCH_PARTIAL is set
+for a pattern that does not conform to the restrictions, matching
+functions return an error.
+
+Since: 2.14
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GOptionContext
+<parameter name="match_info">
+<parameter_description> a #GMatchInfo structure
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if unknown options are ignored.
+<return> %TRUE if the match was partial, %FALSE otherwise
</return>
</function>
-<function name="g_option_context_get_main_group">
+<function name="g_match_info_matches">
<description>
-Returns a pointer to the main group of @context.
+Returns whether the previous match operation succeeded.
-Since: 2.6
+Since: 2.14
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GOptionContext
+<parameter name="match_info">
+<parameter_description> a #GMatchInfo structure
</parameter_description>
</parameter>
</parameters>
-<return> the main group of @context, or %NULL if @context doesn't
-have a main group. Note that group belongs to @context and should
-not be modified or freed.
+<return> %TRUE if the previous match operation succeeded,
+%FALSE otherwise
</return>
</function>
-<function name="g_option_context_get_summary">
+<function name="g_match_info_next">
<description>
-Returns the summary. See g_option_context_set_summary().
+Scans for the next match using the same parameters of the previous
+call to g_regex_match_full() or g_regex_match() that returned
+ match_info
-Since: 2.12
+The match is done on the string passed to the match function, so you
+cannot free it before calling this function.
+
+Since: 2.14
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GOptionContext
+<parameter name="match_info">
+<parameter_description> a #GMatchInfo structure
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> location to store the error occuring, or %NULL to ignore errors
</parameter_description>
</parameter>
</parameters>
-<return> the summary
+<return> %TRUE is the string matched, %FALSE otherwise
</return>
</function>
-<function name="g_option_context_new">
+<function name="g_mem_chunk_alloc">
<description>
-Creates a new option context.
-
-The @parameter_string can serve multiple purposes. It can be used
-to add descriptions for "rest" arguments, which are not parsed by
-the #GOptionContext, typically something like "FILES" or
-"FILE1 FILE2...". If you are using #G_OPTION_REMAINING for
-collecting "rest" arguments, GLib handles this automatically by
-using the @arg_description of the corresponding #GOptionEntry in
-the usage summary.
-
-Another usage is to give a short summary of the program
-functionality, like " - frob the strings", which will be displayed
-in the same line as the usage. For a longer description of the
-program functionality that should be displayed as a paragraph
-below the usage line, use g_option_context_set_summary().
-
-Note that the @parameter_string is translated using the
-function set with g_option_context_set_translate_func(), so
-it should normally be passed untranslated.
+Allocates an atom of memory from a #GMemChunk.
-Since: 2.6
+Deprecated:2.10: Use g_slice_alloc() instead
</description>
<parameters>
-<parameter name="parameter_string">
-<parameter_description> a string which is displayed in
-the first line of <option>--help</option> output, after the
-usage summary
-<literal><replaceable>programname</replaceable> [OPTION...]</literal>
+<parameter name="mem_chunk">
+<parameter_description> a #GMemChunk.
</parameter_description>
</parameter>
</parameters>
-<return> a newly created #GOptionContext, which must be
-freed with g_option_context_free() after use.
-
+<return> a pointer to the allocated atom.
</return>
</function>
-<function name="g_option_context_parse">
+<function name="g_mem_chunk_alloc0">
<description>
-Parses the command line arguments, recognizing options
-which have been added to @context. A side-effect of
-calling this function is that g_set_prgname() will be
-called.
-
-If the parsing is successful, any parsed arguments are
-removed from the array and @argc and @argv are updated
-accordingly. A '--' option is stripped from @argv
-unless there are unparsed options before and after it,
-or some of the options after it start with '-'. In case
-of an error, @argc and @argv are left unmodified.
-
-If automatic <option>--help</option> support is enabled
-(see g_option_context_set_help_enabled()), and the
- argv array contains one of the recognized help options,
-this function will produce help output to stdout and
-call <literal>exit (0)</literal>.
-
-Note that function depends on the
-<link linkend="setlocale">current locale</link> for
-automatic character set conversion of string and filename
-arguments.
+Allocates an atom of memory from a #GMemChunk, setting the memory to
+0.
-Since: 2.6
+Deprecated:2.10: Use g_slice_alloc0() instead
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GOptionContext
-</parameter_description>
-</parameter>
-<parameter name="argc">
-<parameter_description> a pointer to the number of command line arguments
-</parameter_description>
-</parameter>
-<parameter name="argv">
-<parameter_description> a pointer to the array of command line arguments
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> a return location for errors
+<parameter name="mem_chunk">
+<parameter_description> a #GMemChunk.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the parsing was successful,
-%FALSE if an error occurred
-
+<return> a pointer to the allocated atom.
</return>
</function>
-<function name="g_option_context_set_description">
+<function name="g_mem_chunk_clean">
<description>
-Adds a string to be displayed in <option>--help</option> output
-after the list of options. This text often includes a bug reporting
-address.
-
-Note that the summary is translated (see
-g_option_context_set_translate_func()).
+Frees any blocks in a #GMemChunk which are no longer being used.
-Since: 2.12
+Deprecated:2.10: Use the <link linkend="glib-Memory-Slices">slice
+allocator</link> instead
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GOptionContext
-</parameter_description>
-</parameter>
-<parameter name="description">
-<parameter_description> a string to be shown in <option>--help</option> output
-after the list of options, or %NULL
+<parameter name="mem_chunk">
+<parameter_description> a #GMemChunk.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_option_context_set_help_enabled">
+<function name="g_mem_chunk_create">
<description>
-Enables or disables automatic generation of <option>--help</option>
-output. By default, g_option_context_parse() recognizes
-<option>--help</option>, <option>-h</option>,
-<option>-?</option>, <option>--help-all</option>
-and <option>--help-</option><replaceable>groupname</replaceable> and creates
-suitable output to stdout.
+A convenience macro for creating a new #GMemChunk. It calls
+g_mem_chunk_new(), using the given type to create the #GMemChunk
+name. The atom size is determined using
+<function>sizeof()</function>, and the area size is calculated by
+multiplying the @pre_alloc parameter with the atom size.
-Since: 2.6
+Deprecated:2.10: Use the <link linkend="glib-Memory-Slices">slice
+allocator</link> instead
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GOptionContext
+<parameter name="type">
+<parameter_description> the type of the atoms, typically a structure name.
</parameter_description>
</parameter>
-<parameter name="help_enabled">
-<parameter_description> %TRUE to enable <option>--help</option>, %FALSE to disable it
+<parameter name="pre_alloc">
+<parameter_description> the number of atoms to store in each block of memory.
+</parameter_description>
+</parameter>
+<parameter name="alloc_type">
+<parameter_description> the type of the #GMemChunk. #G_ALLOC_AND_FREE is used
+if the atoms will be freed individually. #G_ALLOC_ONLY
+should be used if atoms will never be freed
+individually. #G_ALLOC_ONLY is quicker, since it does
+not need to track free atoms, but it obviously wastes
+memory if you no longer need many of the atoms.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the new #GMemChunk.
+</return>
</function>
-<function name="g_option_context_set_ignore_unknown_options">
+<function name="g_mem_chunk_destroy">
<description>
-Sets whether to ignore unknown options or not. If an argument is
-ignored, it is left in the @argv array after parsing. By default,
-g_option_context_parse() treats unknown options as error.
-
-This setting does not affect non-option arguments (i.e. arguments
-which don't start with a dash). But note that GOption cannot reliably
-determine whether a non-option belongs to a preceding unknown option.
+Frees all of the memory allocated for a #GMemChunk.
-Since: 2.6
+Deprecated:2.10: Use the <link linkend="glib-Memory-Slices">slice
+allocator</link> instead
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GOptionContext
-</parameter_description>
-</parameter>
-<parameter name="ignore_unknown">
-<parameter_description> %TRUE to ignore unknown options, %FALSE to produce
-an error when unknown options are met
+<parameter name="mem_chunk">
+<parameter_description> a #GMemChunk.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_option_context_set_main_group">
+<function name="g_mem_chunk_free">
<description>
-Sets a #GOptionGroup as main group of the @context.
-This has the same effect as calling g_option_context_add_group(),
-the only difference is that the options in the main group are
-treated differently when generating <option>--help</option> output.
+Frees an atom in a #GMemChunk. This should only be called if the
+#GMemChunk was created with #G_ALLOC_AND_FREE. Otherwise it will
+simply return.
-Since: 2.6
+Deprecated:2.10: Use g_slice_free1() instead
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GOptionContext
+<parameter name="mem_chunk">
+<parameter_description> a #GMemChunk.
</parameter_description>
</parameter>
-<parameter name="group">
-<parameter_description> the group to set as main group
+<parameter name="mem">
+<parameter_description> a pointer to the atom to free.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_option_context_set_summary">
+<function name="g_mem_chunk_info">
<description>
-Adds a string to be displayed in <option>--help</option> output
-before the list of options. This is typically a summary of the
-program functionality.
-
-Note that the summary is translated (see
-g_option_context_set_translate_func() and
-g_option_context_set_translation_domain()).
+Outputs debugging information for all #GMemChunk objects currently
+in use. It outputs the number of #GMemChunk objects currently
+allocated, and calls g_mem_chunk_print() to output information on
+each one.
-Since: 2.12
+Deprecated:2.10: Use the <link linkend="glib-Memory-Slices">slice
+allocator</link> instead
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GOptionContext
-</parameter_description>
-</parameter>
-<parameter name="summary">
-<parameter_description> a string to be shown in <option>--help</option> output
-before the list of options, or %NULL
-</parameter_description>
-</parameter>
</parameters>
<return></return>
</function>
-<function name="g_option_context_set_translate_func">
+<function name="g_mem_chunk_new">
<description>
-Sets the function which is used to translate the contexts
-user-visible strings, for <option>--help</option> output.
-If @func is %NULL, strings are not translated.
-
-Note that option groups have their own translation functions,
-this function only affects the @parameter_string (see g_option_context_new()),
-the summary (see g_option_context_set_summary()) and the description
-(see g_option_context_set_description()).
-
-If you are using gettext(), you only need to set the translation
-domain, see g_option_context_set_translation_domain().
+Creates a new #GMemChunk.
-Since: 2.12
+Deprecated:2.10: Use the <link linkend="glib-Memory-Slices">slice
+allocator</link> instead
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GOptionContext
+<parameter name="name">
+<parameter_description> a string to identify the #GMemChunk. It is not copied so it
+should be valid for the lifetime of the #GMemChunk. It is
+only used in g_mem_chunk_print(), which is used for debugging.
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> the #GTranslateFunc, or %NULL
+<parameter name="atom_size">
+<parameter_description> the size, in bytes, of each element in the #GMemChunk.
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> user data to pass to @func, or %NULL
+<parameter name="area_size">
+<parameter_description> the size, in bytes, of each block of memory allocated to
+contain the atoms.
</parameter_description>
</parameter>
-<parameter name="destroy_notify">
-<parameter_description> a function which gets called to free @data, or %NULL
+<parameter name="type">
+<parameter_description> the type of the #GMemChunk. #G_ALLOC_AND_FREE is used if the
+atoms will be freed individually. #G_ALLOC_ONLY should be
+used if atoms will never be freed individually.
+#G_ALLOC_ONLY is quicker, since it does not need to track
+free atoms, but it obviously wastes memory if you no longer
+need many of the atoms.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the new #GMemChunk.
+</return>
</function>
-<function name="g_option_context_set_translation_domain">
+<function name="g_mem_chunk_print">
<description>
-A convenience function to use gettext() for translating
-user-visible strings.
+Outputs debugging information for a #GMemChunk. It outputs the name
+of the #GMemChunk (set with g_mem_chunk_new()), the number of bytes
+used, and the number of blocks of memory allocated.
-Since: 2.12
+Deprecated:2.10: Use the <link linkend="glib-Memory-Slices">slice
+allocator</link> instead
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GOptionContext
-</parameter_description>
-</parameter>
-<parameter name="domain">
-<parameter_description> the domain to use
+<parameter name="mem_chunk">
+<parameter_description> a #GMemChunk.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_option_group_add_entries">
+<function name="g_mem_chunk_reset">
<description>
-Adds the options specified in @entries to @group.
-
-Since: 2.6
+Resets a GMemChunk to its initial state. It frees all of the
+currently allocated blocks of memory.
+
+Deprecated:2.10: Use the <link linkend="glib-Memory-Slices">slice
+allocator</link> instead
</description>
<parameters>
-<parameter name="group">
-<parameter_description> a #GOptionGroup
-</parameter_description>
-</parameter>
-<parameter name="entries">
-<parameter_description> a %NULL-terminated array of #GOptionEntry<!-- -->s
+<parameter name="mem_chunk">
+<parameter_description> a #GMemChunk.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_option_group_free">
+<function name="g_mem_gc_friendly">
<description>
-Frees a #GOptionGroup. Note that you must <emphasis>not</emphasis>
-free groups which have been added to a #GOptionContext.
-
-Since: 2.6
+This variable is %TRUE if the <envar>G_DEBUG</envar> environment variable
+includes the key <link linkend="G_DEBUG">gc-friendly</link>.
</description>
<parameters>
-<parameter name="group">
-<parameter_description> a #GOptionGroup
-</parameter_description>
-</parameter>
</parameters>
<return></return>
</function>
-<function name="g_option_group_new">
+<function name="g_mem_is_system_malloc">
<description>
-Creates a new #GOptionGroup.
+Checks whether the allocator used by g_malloc() is the system's
+malloc implementation. If it returns %TRUE memory allocated with
+malloc() can be used interchangeable with memory allocated using g_malloc().
+This function is useful for avoiding an extra copy of allocated memory returned
+by a non-GLib-based API.
+
+A different allocator can be set using g_mem_set_vtable().
-Since: 2.6
</description>
<parameters>
-<parameter name="name">
-<parameter_description> the name for the option group, this is used to provide
-help for the options in this group with <option>--help-</option>@name
-</parameter_description>
-</parameter>
-<parameter name="description">
-<parameter_description> a description for this group to be shown in
-<option>--help</option>. This string is translated using the translation
-domain or translation function of the group
-</parameter_description>
-</parameter>
-<parameter name="help_description">
-<parameter_description> a description for the <option>--help-</option>@name option.
-This string is translated using the translation domain or translation function
-of the group
-</parameter_description>
-</parameter>
-<parameter name="user_data">
-<parameter_description> user data that will be passed to the pre- and post-parse hooks,
-the error hook and to callbacks of %G_OPTION_ARG_CALLBACK options, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="destroy">
-<parameter_description> a function that will be called to free @user_data, or %NULL
-</parameter_description>
-</parameter>
</parameters>
-<return> a newly created option group. It should be added
-to a #GOptionContext or freed with g_option_group_free().
-
+<return> if %TRUE, malloc() and g_malloc() can be mixed.
</return>
</function>
-<function name="g_option_group_set_error_hook">
+<function name="g_mem_profile">
<description>
-Associates a function with @group which will be called
-from g_option_context_parse() when an error occurs.
+Outputs a summary of memory usage.
-Note that the user data to be passed to @error_func can be
-specified when constructing the group with g_option_group_new().
+It outputs the frequency of allocations of different sizes,
+the total number of bytes which have been allocated,
+the total number of bytes which have been freed,
+and the difference between the previous two values, i.e. the number of bytes
+still in use.
-Since: 2.6
+Note that this function will not output anything unless you have
+previously installed the #glib_mem_profiler_table with g_mem_set_vtable().
</description>
<parameters>
-<parameter name="group">
-<parameter_description> a #GOptionGroup
+<parameter name="void">
+<parameter_description>
</parameter_description>
</parameter>
-<parameter name="error_func">
-<parameter_description> a function to call when an error occurs
+</parameters>
+<return></return>
+</function>
+
+<function name="g_mem_set_vtable">
+<description>
+Sets the #GMemVTable to use for memory allocation. You can use this to provide
+custom memory allocation routines. <emphasis>This function must be called
+before using any other GLib functions.</emphasis> The @vtable only needs to
+provide malloc(), realloc(), and free() functions; GLib can provide default
+implementations of the others. The malloc() and realloc() implementations
+should return %NULL on failure, GLib will handle error-checking for you.
+ vtable is copied, so need not persist after this function has been called.
+
+</description>
+<parameters>
+<parameter name="vtable">
+<parameter_description> table of memory allocation routines.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_option_group_set_parse_hooks">
+<function name="g_memdup">
<description>
-Associates two functions with @group which will be called
-from g_option_context_parse() before the first option is parsed
-and after the last option has been parsed, respectively.
-
-Note that the user data to be passed to @pre_parse_func and
- post_parse_func can be specified when constructing the group
-with g_option_group_new().
+Allocates @byte_size bytes of memory, and copies @byte_size bytes into it
+from @mem. If @mem is %NULL it returns %NULL.
-Since: 2.6
</description>
<parameters>
-<parameter name="group">
-<parameter_description> a #GOptionGroup
-</parameter_description>
-</parameter>
-<parameter name="pre_parse_func">
-<parameter_description> a function to call before parsing, or %NULL
+<parameter name="mem">
+<parameter_description> the memory to copy.
</parameter_description>
</parameter>
-<parameter name="post_parse_func">
-<parameter_description> a function to call after parsing, or %NULL
+<parameter name="byte_size">
+<parameter_description> the number of bytes to copy.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a pointer to the newly-allocated copy of the memory, or %NULL if @mem
+is %NULL.
+</return>
</function>
-<function name="g_option_group_set_translate_func">
+<function name="g_memmove">
<description>
-Sets the function which is used to translate user-visible
-strings, for <option>--help</option> output. Different
-groups can use different #GTranslateFunc<!-- -->s. If @func
-is %NULL, strings are not translated.
-
-If you are using gettext(), you only need to set the translation
-domain, see g_option_group_set_translation_domain().
+Copies a block of memory @len bytes long, from @src to @dest.
+The source and destination areas may overlap.
-Since: 2.6
+In order to use this function, you must include
+<filename>string.h</filename> yourself, because this macro will
+typically simply resolve to memmove() and GLib does not include
+<filename>string.h</filename> for you.
</description>
<parameters>
-<parameter name="group">
-<parameter_description> a #GOptionGroup
-</parameter_description>
-</parameter>
-<parameter name="func">
-<parameter_description> the #GTranslateFunc, or %NULL
+<parameter name="dest">
+<parameter_description> the destination address to copy the bytes to.
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> user data to pass to @func, or %NULL
+<parameter name="src">
+<parameter_description> the source address to copy the bytes from.
</parameter_description>
</parameter>
-<parameter name="destroy_notify">
-<parameter_description> a function which gets called to free @data, or %NULL
+<parameter name="len">
+<parameter_description> the number of bytes to copy.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_option_group_set_translation_domain">
+<function name="g_mkdir">
<description>
-A convenience function to use gettext() for translating
-user-visible strings.
+A wrapper for the POSIX mkdir() function. The mkdir() function
+attempts to create a directory with the given name and permissions.
+The mode argument is ignored on Windows.
+
+See your C library manual for more details about mkdir().
Since: 2.6
</description>
<parameters>
-<parameter name="group">
-<parameter_description> a #GOptionGroup
+<parameter name="filename">
+<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows)
</parameter_description>
</parameter>
-<parameter name="domain">
-<parameter_description> the domain to use
+<parameter name="mode">
+<parameter_description> permissions to use for the newly created directory
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> 0 if the directory was successfully created, -1 if an error
+occurred
+
+</return>
</function>
-<function name="g_parse_debug_string">
+<function name="g_mkdir_with_parents">
<description>
-Parses a string containing debugging options
-into a %guint containing bit flags. This is used
-within GDK and GTK+ to parse the debug options passed on the
-command line or through environment variables.
-
-If @string is equal to "all", all flags are set. If @string
-is equal to "help", all the available keys in @keys are printed
-out to standard error.
+Create a directory if it doesn't already exist. Create intermediate
+parent directories as needed, too.
+Since: 2.8
</description>
<parameters>
-<parameter name="string">
-<parameter_description> a list of debug options separated by colons, spaces, or
-commas, or %NULL.
-</parameter_description>
-</parameter>
-<parameter name="keys">
-<parameter_description> pointer to an array of #GDebugKey which associate
-strings with bit flags.
+<parameter name="pathname">
+<parameter_description> a pathname in the GLib file name encoding
</parameter_description>
</parameter>
-<parameter name="nkeys">
-<parameter_description> the number of #GDebugKey<!-- -->s in the array.
+<parameter name="mode">
+<parameter_description> permissions to use for newly created directories
</parameter_description>
</parameter>
</parameters>
-<return> the combined set of bit flags.
+<return> 0 if the directory already exists, or was successfully
+created. Returns -1 if an error occurred, with errno set.
+
</return>
</function>
-<function name="g_path_get_basename">
+<function name="g_mkstemp">
<description>
-Gets the last component of the filename. If @file_name ends with a
-directory separator it gets the component before the last slash. If
- file_name consists only of directory separators (and on Windows,
-possibly a drive letter), a single separator is returned. If
- file_name is empty, it gets ".".
+Opens a temporary file. See the mkstemp() documentation
+on most UNIX-like systems.
+
+The parameter is a string that should follow the rules for
+mkstemp() templates, i.e. contain the string "XXXXXX".
+g_mkstemp() is slightly more flexible than mkstemp()
+in that the sequence does not have to occur at the very end of the
+template. The X string will
+be modified to form the name of a file that didn't exist.
+The string should be in the GLib file name encoding. Most importantly,
+on Windows it should be in UTF-8.
</description>
<parameters>
-<parameter name="file_name">
-<parameter_description> the name of the file.
+<parameter name="tmpl">
+<parameter_description> template filename
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated string containing the last component of
-the filename.
+<return> A file handle (as from open()) to the file
+opened for reading and writing. The file is opened in binary mode
+on platforms where there is a difference. The file handle should be
+closed with close(). In case of errors, -1 is returned.
</return>
</function>
-<function name="g_path_get_dirname">
+<function name="g_mkstemp_full">
<description>
-Gets the directory components of a file name. If the file name has no
-directory components "." is returned. The returned string should be
-freed when no longer needed.
+Opens a temporary file. See the mkstemp() documentation
+on most UNIX-like systems.
+
+The parameter is a string that should follow the rules for
+mkstemp() templates, i.e. contain the string "XXXXXX".
+g_mkstemp_full() is slightly more flexible than mkstemp()
+in that the sequence does not have to occur at the very end of the
+template and you can pass a @mode and additional @flags. The X
+string will be modified to form the name of a file that didn't exist.
+The string should be in the GLib file name encoding. Most importantly,
+on Windows it should be in UTF-8.
+Since: 2.22
</description>
<parameters>
-<parameter name="file_name">
-<parameter_description> the name of the file.
+<parameter name="tmpl">
+<parameter_description> template filename
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> flags to pass to an open() call in addition to O_EXCL and
+O_CREAT, which are passed automatically
+</parameter_description>
+</parameter>
+<parameter name="mode">
+<parameter_description> permissios to create the temporary file with
</parameter_description>
</parameter>
</parameters>
-<return> the directory components of the file.
+<return> A file handle (as from open()) to the file
+opened for reading and writing. The file handle should be
+closed with close(). In case of errors, -1 is returned.
+
</return>
</function>
-<function name="g_path_is_absolute">
+<function name="g_mutex_free">
<description>
-Returns %TRUE if the given @file_name is an absolute file name.
-Note that this is a somewhat vague concept on Windows.
+Destroys @mutex.
-On POSIX systems, an absolute file name is well-defined. It always
-starts from the single root directory. For example "/usr/local".
+<note><para>Calling g_mutex_free() on a locked mutex may result in
+undefined behaviour.</para></note>
-On Windows, the concepts of current drive and drive-specific
-current directory introduce vagueness. This function interprets as
-an absolute file name one that either begins with a directory
-separator such as "\Users\tml" or begins with the root on a drive,
-for example "C:\Windows". The first case also includes UNC paths
-such as "\\myserver\docs\foo". In all cases, either slashes or
-backslashes are accepted.
+</description>
+<parameters>
+<parameter name="mutex">
+<parameter_description> a #GMutex.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
-Note that a file name relative to the current drive root does not
-truly specify a file uniquely over time and across processes, as
-the current drive is a per-process value and can be changed.
+<function name="g_mutex_lock">
+<description>
+Locks @mutex. If @mutex is already locked by another thread, the
+current thread will block until @mutex is unlocked by the other
+thread.
-File names relative the current directory on some specific drive,
-such as "D:foo/bar", are not interpreted as absolute by this
-function, but they obviously are not relative to the normal current
-directory as returned by getcwd() or g_get_current_dir()
-either. Such paths should be avoided, or need to be handled using
-Windows-specific code.
+This function can be used even if g_thread_init() has not yet been
+called, and, in that case, will do nothing.
+<note><para>#GMutex is neither guaranteed to be recursive nor to be
+non-recursive, i.e. a thread could deadlock while calling
+g_mutex_lock(), if it already has locked @mutex. Use
+#GStaticRecMutex, if you need recursive mutexes.</para></note>
</description>
<parameters>
-<parameter name="file_name">
-<parameter_description> a file name.
+<parameter name="mutex">
+<parameter_description> a #GMutex.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @file_name is absolute.
-</return>
+<return></return>
</function>
-<function name="g_path_skip_root">
+<function name="g_mutex_new">
<description>
-Returns a pointer into @file_name after the root component, i.e. after
-the "/" in UNIX or "C:\" under Windows. If @file_name is not an absolute
-path it returns %NULL.
+Creates a new #GMutex.
+<note><para>This function will abort if g_thread_init() has not been
+called yet.</para></note>
</description>
<parameters>
-<parameter name="file_name">
-<parameter_description> a file name.
-</parameter_description>
-</parameter>
</parameters>
-<return> a pointer into @file_name after the root component.
+<return> a new #GMutex.
</return>
</function>
-<function name="g_pattern_match">
+<function name="g_mutex_trylock">
<description>
-Matches a string against a compiled pattern. Passing the correct
-length of the string given is mandatory. The reversed string can be
-omitted by passing %NULL, this is more efficient if the reversed
-version of the string to be matched is not at hand, as
-g_pattern_match() will only construct it if the compiled pattern
-requires reverse matches.
+Tries to lock @mutex. If @mutex is already locked by another thread,
+it immediately returns %FALSE. Otherwise it locks @mutex and returns
+%TRUE.
-Note that, if the user code will (possibly) match a string against a
-multitude of patterns containing wildcards, chances are high that
-some patterns will require a reversed string. In this case, it's
-more efficient to provide the reversed string to avoid multiple
-constructions thereof in the various calls to g_pattern_match().
+This function can be used even if g_thread_init() has not yet been
+called, and, in that case, will immediately return %TRUE.
-Note also that the reverse of a UTF-8 encoded string can in general
-<emphasis>not</emphasis> be obtained by g_strreverse(). This works
-only if the string doesn't contain any multibyte characters. GLib
-offers the g_utf8_strreverse() function to reverse UTF-8 encoded
-strings.
+<note><para>#GMutex is neither guaranteed to be recursive nor to be
+non-recursive, i.e. the return value of g_mutex_trylock() could be
+both %FALSE or %TRUE, if the current thread already has locked
+ mutex Use #GStaticRecMutex, if you need recursive
+mutexes.</para></note>
</description>
<parameters>
-<parameter name="pspec">
-<parameter_description> a #GPatternSpec
-</parameter_description>
-</parameter>
-<parameter name="string_length">
-<parameter_description> the length of @string (in bytes, i.e. strlen(),
-<emphasis>not</emphasis> g_utf8_strlen())
-</parameter_description>
-</parameter>
-<parameter name="string">
-<parameter_description> the UTF-8 encoded string to match
-</parameter_description>
-</parameter>
-<parameter name="string_reversed">
-<parameter_description> the reverse of @string or %NULL
+<parameter name="mutex">
+<parameter_description> a #GMutex.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @string matches @pspec
+<return> %TRUE, if @mutex could be locked.
</return>
</function>
-<function name="g_pattern_match_simple">
+<function name="g_mutex_unlock">
<description>
-Matches a string against a pattern given as a string. If this
-function is to be called in a loop, it's more efficient to compile
-the pattern once with g_pattern_spec_new() and call
-g_pattern_match_string() repeatedly.
+Unlocks @mutex. If another thread is blocked in a g_mutex_lock()
+call for @mutex, it will be woken and can lock @mutex itself.
+
+This function can be used even if g_thread_init() has not yet been
+called, and, in that case, will do nothing.
</description>
<parameters>
-<parameter name="pattern">
-<parameter_description> the UTF-8 encoded pattern
-</parameter_description>
-</parameter>
-<parameter name="string">
-<parameter_description> the UTF-8 encoded string to match
+<parameter name="mutex">
+<parameter_description> a #GMutex.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @string matches @pspec
-</return>
+<return></return>
</function>
-<function name="g_pattern_match_string">
+<function name="g_node_child_index">
<description>
-Matches a string against a compiled pattern. If the string is to be
-matched against more than one pattern, consider using
-g_pattern_match() instead while supplying the reversed string.
+Gets the position of the first child of a #GNode
+which contains the given data.
+
</description>
<parameters>
-<parameter name="pspec">
-<parameter_description> a #GPatternSpec
+<parameter name="node">
+<parameter_description> a #GNode
</parameter_description>
</parameter>
-<parameter name="string">
-<parameter_description> the UTF-8 encoded string to match
+<parameter name="data">
+<parameter_description> the data to find
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @string matches @pspec
+<return> the index of the child of @node which contains
+ data, or -1 if the data is not found
</return>
</function>
-<function name="g_pattern_spec_equal">
+<function name="g_node_child_position">
<description>
-Compares two compiled pattern specs and returns whether they will
-match the same set of strings.
+Gets the position of a #GNode with respect to its siblings.
+ child must be a child of @node. The first child is numbered 0,
+the second 1, and so on.
+
</description>
<parameters>
-<parameter name="pspec1">
-<parameter_description> a #GPatternSpec
+<parameter name="node">
+<parameter_description> a #GNode
</parameter_description>
</parameter>
-<parameter name="pspec2">
-<parameter_description> another #GPatternSpec
+<parameter name="child">
+<parameter_description> a child of @node
</parameter_description>
</parameter>
</parameters>
-<return> Whether the compiled patterns are equal
+<return> the position of @child with respect to its siblings
</return>
</function>
-<function name="g_pattern_spec_free">
+<function name="g_node_children_foreach">
<description>
-Frees the memory allocated for the #GPatternSpec.
+Calls a function for each of the children of a #GNode.
+Note that it doesn't descend beneath the child nodes.
</description>
<parameters>
-<parameter name="pspec">
-<parameter_description> a #GPatternSpec
+<parameter name="node">
+<parameter_description> a #GNode
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> which types of children are to be visited, one of
+%G_TRAVERSE_ALL, %G_TRAVERSE_LEAVES and %G_TRAVERSE_NON_LEAVES
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> the function to call for each visited node
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> user data to pass to the function
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_pattern_spec_new">
+<function name="g_node_copy">
<description>
-Compiles a pattern to a #GPatternSpec.
+Recursively copies a #GNode (but does not deep-copy the data inside the
+nodes, see g_node_copy_deep() if you need that).
+
</description>
<parameters>
-<parameter name="pattern">
-<parameter_description> a zero-terminated UTF-8 encoded string
+<parameter name="node">
+<parameter_description> a #GNode
</parameter_description>
</parameter>
</parameters>
-<return> a newly-allocated #GPatternSpec
+<return> a new #GNode containing the same data pointers
</return>
</function>
-<function name="g_poll">
+<function name="g_node_copy_deep">
<description>
-Polls @fds, as with the poll() system call, but portably. (On
-systems that don't have poll(), it is emulated using select().)
-This is used internally by #GMainContext, but it can be called
-directly if you need to block until a file descriptor is ready, but
-don't want to run the full main loop.
-
-Each element of @fds is a #GPollFD describing a single file
-descriptor to poll. The %fd field indicates the file descriptor,
-and the %events field indicates the events to poll for. On return,
-the %revents fields will be filled with the events that actually
-occurred.
-
-On POSIX systems, the file descriptors in @fds can be any sort of
-file descriptor, but the situation is much more complicated on
-Windows. If you need to use g_poll() in code that has to run on
-Windows, the easiest solution is to construct all of your
-#GPollFD<!-- -->s with g_io_channel_win32_make_pollfd().
+Recursively copies a #GNode and its data.
-Since: 2.20
+Since: 2.4
</description>
<parameters>
-<parameter name="fds">
-<parameter_description> file descriptors to poll
+<parameter name="node">
+<parameter_description> a #GNode
</parameter_description>
</parameter>
-<parameter name="nfds">
-<parameter_description> the number of file descriptors in @fds
+<parameter name="copy_func">
+<parameter_description> the function which is called to copy the data inside each node,
+or %NULL to use the original data.
</parameter_description>
</parameter>
-<parameter name="timeout">
-<parameter_description> amount of time to wait, in milliseconds, or -1 to wait forever
+<parameter name="data">
+<parameter_description> data to pass to @copy_func
</parameter_description>
</parameter>
</parameters>
-<return> the number of entries in @fds whose %revents fields
-were filled in, or 0 if the operation timed out, or -1 on error or
-if the call was interrupted.
+<return> a new #GNode containing copies of the data in @node.
</return>
</function>
-<function name="g_prefix_error">
+<function name="g_node_depth">
<description>
-Formats a string according to @format and
-prefix it to an existing error message. If
- err is %NULL (ie: no error variable) then do
-nothing.
+Gets the depth of a #GNode.
-If * err is %NULL (ie: an error variable is
-present but there is no error condition) then
-also do nothing. Whether or not it makes
-sense to take advantage of this feature is up
-to you.
+If @node is %NULL the depth is 0. The root node has a depth of 1.
+For the children of the root node the depth is 2. And so on.
-Since: 2.16
</description>
<parameters>
-<parameter name="err">
-<parameter_description> a return location for a #GError, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="format">
-<parameter_description> printf()-style format string
-</parameter_description>
-</parameter>
-<parameter name="Varargs">
-<parameter_description> arguments to @format
+<parameter name="node">
+<parameter_description> a #GNode
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the depth of the #GNode
+</return>
</function>
-<function name="g_printf">
+<function name="g_node_destroy">
<description>
-An implementation of the standard printf() function which supports
-positional parameters, as specified in the Single Unix Specification.
-
-Since: 2.2
+Removes @root and its children from the tree, freeing any memory
+allocated.
</description>
<parameters>
-<parameter name="format">
-<parameter_description> a standard printf() format string, but notice
-<link linkend="string-precision">string precision pitfalls</link>.
-</parameter_description>
-</parameter>
-<parameter name="Varargs">
-<parameter_description> the arguments to insert in the output.
+<parameter name="root">
+<parameter_description> the root of the tree/subtree to destroy
</parameter_description>
</parameter>
</parameters>
-<return> the number of bytes printed.
-
-</return>
+<return></return>
</function>
-<function name="g_private_get">
+<function name="g_node_find">
<description>
-Returns the pointer keyed to @private_key for the current thread. If
-g_private_set() hasn't been called for the current @private_key and
-thread yet, this pointer will be %NULL.
+Finds a #GNode in a tree.
-This function can be used even if g_thread_init() has not yet been
-called, and, in that case, will return the value of @private_key
-casted to #gpointer. Note however, that private data set
-<emphasis>before</emphasis> g_thread_init() will
-<emphasis>not</emphasis> be retained <emphasis>after</emphasis> the
-call. Instead, %NULL will be returned in all threads directly after
-g_thread_init(), regardless of any g_private_set() calls issued
-before threading system intialization.
</description>
<parameters>
-<parameter name="private_key">
-<parameter_description> a #GPrivate.
+<parameter name="root">
+<parameter_description> the root #GNode of the tree to search
+</parameter_description>
+</parameter>
+<parameter name="order">
+<parameter_description> the order in which nodes are visited - %G_IN_ORDER,
+%G_PRE_ORDER, %G_POST_ORDER, or %G_LEVEL_ORDER
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> which types of children are to be searched, one of
+%G_TRAVERSE_ALL, %G_TRAVERSE_LEAVES and %G_TRAVERSE_NON_LEAVES
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> the data to find
</parameter_description>
</parameter>
</parameters>
-<return> the corresponding pointer.
+<return> the found #GNode, or %NULL if the data is not found
</return>
</function>
-<function name="g_private_new">
+<function name="g_node_find_child">
<description>
-Creates a new #GPrivate. If @destructor is non-%NULL, it is a
-pointer to a destructor function. Whenever a thread ends and the
-corresponding pointer keyed to this instance of #GPrivate is
-non-%NULL, the destructor is called with this pointer as the
-argument.
-
-<note><para>@destructor is used quite differently from @notify in
-g_static_private_set().</para></note>
-
-<note><para>A #GPrivate cannot be freed. Reuse it instead, if you
-can, to avoid shortage, or use #GStaticPrivate.</para></note>
+Finds the first child of a #GNode with the given data.
-<note><para>This function will abort if g_thread_init() has not been
-called yet.</para></note>
</description>
<parameters>
-<parameter name="destructor">
-<parameter_description> a function to destroy the data keyed to #GPrivate when
-a thread ends.
+<parameter name="node">
+<parameter_description> a #GNode
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> which types of children are to be searched, one of
+%G_TRAVERSE_ALL, %G_TRAVERSE_LEAVES and %G_TRAVERSE_NON_LEAVES
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> the data to find
</parameter_description>
</parameter>
</parameters>
-<return> a new #GPrivate.
+<return> the found child #GNode, or %NULL if the data is not found
</return>
</function>
-<function name="g_private_set">
+<function name="g_node_first_sibling">
<description>
-Sets the pointer keyed to @private_key for the current thread.
+Gets the first sibling of a #GNode.
+This could possibly be the node itself.
-This function can be used even if g_thread_init() has not yet been
-called, and, in that case, will set @private_key to @data casted to
-#GPrivate*. See g_private_get() for resulting caveats.
</description>
<parameters>
-<parameter name="private_key">
-<parameter_description> a #GPrivate.
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> the new pointer.
+<parameter name="node">
+<parameter_description> a #GNode
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the first sibling of @node
+</return>
</function>
-<function name="g_propagate_error">
+<function name="g_node_get_root">
<description>
-If @dest is %NULL, free @src; otherwise, moves @src into * dest
-The error variable @dest points to must be %NULL.
+Gets the root of a tree.
+
</description>
<parameters>
-<parameter name="dest">
-<parameter_description> error return location
-</parameter_description>
-</parameter>
-<parameter name="src">
-<parameter_description> error to move into the return location
+<parameter name="node">
+<parameter_description> a #GNode
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the root of the tree
+</return>
</function>
-<function name="g_propagate_prefixed_error">
+<function name="g_node_insert">
<description>
-If @dest is %NULL, free @src; otherwise,
-moves @src into * dest * dest must be %NULL.
-After the move, add a prefix as with
-g_prefix_error().
+Inserts a #GNode beneath the parent at the given position.
-Since: 2.16
</description>
<parameters>
-<parameter name="dest">
-<parameter_description> error return location
-</parameter_description>
-</parameter>
-<parameter name="src">
-<parameter_description> error to move into the return location
+<parameter name="parent">
+<parameter_description> the #GNode to place @node under
</parameter_description>
</parameter>
-<parameter name="format">
-<parameter_description> printf()-style format string
+<parameter name="position">
+<parameter_description> the position to place @node at, with respect to its siblings
+If position is -1, @node is inserted as the last child of @parent
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> arguments to @format
+<parameter name="node">
+<parameter_description> the #GNode to insert
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the inserted #GNode
+</return>
</function>
-<function name="g_ptr_array_add">
+<function name="g_node_insert_after">
<description>
-Adds a pointer to the end of the pointer array. The array will grow
-in size automatically if necessary.
+Inserts a #GNode beneath the parent after the given sibling.
+
</description>
<parameters>
-<parameter name="array">
-<parameter_description> a #GPtrArray.
+<parameter name="parent">
+<parameter_description> the #GNode to place @node under
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> the pointer to add.
+<parameter name="sibling">
+<parameter_description> the sibling #GNode to place @node after.
+If sibling is %NULL, the node is inserted as the first child of @parent.
+</parameter_description>
+</parameter>
+<parameter name="node">
+<parameter_description> the #GNode to insert
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the inserted #GNode
+</return>
</function>
-<function name="g_ptr_array_foreach">
+<function name="g_node_insert_before">
<description>
-Calls a function for each element of a #GPtrArray.
+Inserts a #GNode beneath the parent before the given sibling.
-Since: 2.4
</description>
<parameters>
-<parameter name="array">
-<parameter_description> a #GPtrArray
+<parameter name="parent">
+<parameter_description> the #GNode to place @node under
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> the function to call for each array element
+<parameter name="sibling">
+<parameter_description> the sibling #GNode to place @node before.
+If sibling is %NULL, the node is inserted as the last child of @parent.
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> user data to pass to the function
+<parameter name="node">
+<parameter_description> the #GNode to insert
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the inserted #GNode
+</return>
</function>
-<function name="g_ptr_array_free">
+<function name="g_node_is_ancestor">
<description>
-Frees the memory allocated for the #GPtrArray. If @free_seg is %TRUE
-it frees the memory block holding the elements as well. Pass %FALSE
-if you want to free the #GPtrArray wrapper but preserve the
-underlying array for use elsewhere. If the reference count of @array
-is greater than one, the #GPtrArray wrapper is preserved but the
-size of @array will be set to zero.
+Returns %TRUE if @node is an ancestor of @descendant.
+This is true if node is the parent of @descendant,
+or if node is the grandparent of @descendant etc.
-<note><para>If array contents point to dynamically-allocated
-memory, they should be freed separately if @free_seg is %TRUE and no
-#GDestroyNotify function has been set for @array.</para></note>
</description>
<parameters>
-<parameter name="array">
-<parameter_description> a #GPtrArray.
+<parameter name="node">
+<parameter_description> a #GNode
</parameter_description>
</parameter>
-<parameter name="free_seg">
-<parameter_description> if %TRUE the actual pointer array is freed as well.
+<parameter name="descendant">
+<parameter_description> a #GNode
</parameter_description>
</parameter>
</parameters>
-<return> the pointer array if @free_seg is %FALSE, otherwise %NULL.
-The pointer array should be freed using g_free().
+<return> %TRUE if @node is an ancestor of @descendant
</return>
</function>
-<function name="g_ptr_array_index">
+<function name="g_node_last_child">
<description>
-Returns the pointer at the given index of the pointer array.
+Gets the last child of a #GNode.
+
</description>
<parameters>
-<parameter name="array">
-<parameter_description> a #GPtrArray.
-</parameter_description>
-</parameter>
-<parameter name="index_">
-<parameter_description> the index of the pointer to return.
+<parameter name="node">
+<parameter_description> a #GNode (must not be %NULL)
</parameter_description>
</parameter>
</parameters>
-<return> the pointer at the given index.
+<return> the last child of @node, or %NULL if @node has no children
</return>
</function>
-<function name="g_ptr_array_new">
+<function name="g_node_last_sibling">
<description>
-Creates a new #GPtrArray with a reference count of 1.
+Gets the last sibling of a #GNode.
+This could possibly be the node itself.
+
</description>
<parameters>
+<parameter name="node">
+<parameter_description> a #GNode
+</parameter_description>
+</parameter>
</parameters>
-<return> the new #GPtrArray.
+<return> the last sibling of @node
</return>
</function>
-<function name="g_ptr_array_new_with_free_func">
+<function name="g_node_max_height">
<description>
-Creates a new #GPtrArray with a reference count of 1 and use @element_free_func
-for freeing each element when the array is destroyed either via
-g_ptr_array_unref(), when g_ptr_array_free() is called with @free_segment
-set to %TRUE or when removing elements.
+Gets the maximum height of all branches beneath a #GNode.
+This is the maximum distance from the #GNode to all leaf nodes.
+
+If @root is %NULL, 0 is returned. If @root has no children,
+1 is returned. If @root has children, 2 is returned. And so on.
-Since: 2.22
</description>
<parameters>
-<parameter name="element_free_func">
-<parameter_description> A function to free elements with destroy @array or %NULL.
+<parameter name="root">
+<parameter_description> a #GNode
</parameter_description>
</parameter>
</parameters>
-<return> A new #GPtrArray.
-
+<return> the maximum height of the tree beneath @root
</return>
</function>
-<function name="g_ptr_array_ref">
+<function name="g_node_n_children">
<description>
-Atomically increments the reference count of @array by one. This
-function is MT-safe and may be called from any thread.
+Gets the number of children of a #GNode.
-Since: 2.22
</description>
<parameters>
-<parameter name="array">
-<parameter_description> A #GArray.
+<parameter name="node">
+<parameter_description> a #GNode
</parameter_description>
</parameter>
</parameters>
-<return> The passed in #GPtrArray.
-
+<return> the number of children of @node
</return>
</function>
-<function name="g_ptr_array_remove">
+<function name="g_node_n_nodes">
<description>
-Removes the first occurrence of the given pointer from the pointer
-array. The following elements are moved down one place. If @array
-has a non-%NULL #GDestroyNotify function it is called for the
-removed element.
+Gets the number of nodes in a tree.
-It returns %TRUE if the pointer was removed, or %FALSE if the
-pointer was not found.
</description>
<parameters>
-<parameter name="array">
-<parameter_description> a #GPtrArray.
+<parameter name="root">
+<parameter_description> a #GNode
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> the pointer to remove.
+<parameter name="flags">
+<parameter_description> which types of children are to be counted, one of
+%G_TRAVERSE_ALL, %G_TRAVERSE_LEAVES and %G_TRAVERSE_NON_LEAVES
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the pointer is removed. %FALSE if the pointer is
-not found in the array.
+<return> the number of nodes in the tree
</return>
</function>
-<function name="g_ptr_array_remove_fast">
+<function name="g_node_new">
<description>
-Removes the first occurrence of the given pointer from the pointer
-array. The last element in the array is used to fill in the space,
-so this function does not preserve the order of the array. But it is
-faster than g_ptr_array_remove(). If @array has a non-%NULL
-#GDestroyNotify function it is called for the removed element.
+Creates a new #GNode containing the given data.
+Used to create the first node in a tree.
-It returns %TRUE if the pointer was removed, or %FALSE if the
-pointer was not found.
</description>
<parameters>
-<parameter name="array">
-<parameter_description> a #GPtrArray.
-</parameter_description>
-</parameter>
<parameter name="data">
-<parameter_description> the pointer to remove.
+<parameter_description> the data of the new node
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the pointer was found in the array.
+<return> a new #GNode
</return>
</function>
-<function name="g_ptr_array_remove_index">
+<function name="g_node_nth_child">
<description>
-Removes the pointer at the given index from the pointer array. The
-following elements are moved down one place. If @array has a
-non-%NULL #GDestroyNotify function it is called for the removed
-element.
+Gets a child of a #GNode, using the given index.
+The first child is at index 0. If the index is
+too big, %NULL is returned.
+
</description>
<parameters>
-<parameter name="array">
-<parameter_description> a #GPtrArray.
+<parameter name="node">
+<parameter_description> a #GNode
</parameter_description>
</parameter>
-<parameter name="index_">
-<parameter_description> the index of the pointer to remove.
+<parameter name="n">
+<parameter_description> the index of the desired child
</parameter_description>
</parameter>
</parameters>
-<return> the pointer which was removed.
+<return> the child of @node at index @n
</return>
</function>
-<function name="g_ptr_array_remove_index_fast">
+<function name="g_node_pop_allocator">
<description>
-Removes the pointer at the given index from the pointer array. The
-last element in the array is used to fill in the space, so this
-function does not preserve the order of the array. But it is faster
-than g_ptr_array_remove_index(). If @array has a non-%NULL
-#GDestroyNotify function it is called for the removed element.
+Restores the previous #GAllocator, used when allocating #GNode
+elements.
+
+Note that this function is not available if GLib has been compiled
+with <option>--disable-mem-pools</option>
+
+Deprecated:2.10: It does nothing, since #GNode has been converted to
+the <link linkend="glib-Memory-Slices">slice
+allocator</link>
</description>
<parameters>
-<parameter name="array">
-<parameter_description> a #GPtrArray.
+</parameters>
+<return></return>
+</function>
+
+<function name="g_node_prepend">
+<description>
+Inserts a #GNode as the first child of the given parent.
+
+
+</description>
+<parameters>
+<parameter name="parent">
+<parameter_description> the #GNode to place the new #GNode under
</parameter_description>
</parameter>
-<parameter name="index_">
-<parameter_description> the index of the pointer to remove.
+<parameter name="node">
+<parameter_description> the #GNode to insert
</parameter_description>
</parameter>
</parameters>
-<return> the pointer which was removed.
+<return> the inserted #GNode
</return>
</function>
-<function name="g_ptr_array_remove_range">
+<function name="g_node_push_allocator">
<description>
-Removes the given number of pointers starting at the given index
-from a #GPtrArray. The following elements are moved to close the
-gap. If @array has a non-%NULL #GDestroyNotify function it is called
-for the removed elements.
+Sets the allocator to use to allocate #GNode elements. Use
+g_node_pop_allocator() to restore the previous allocator.
-Since: 2.4
+Note that this function is not available if GLib has been compiled
+with <option>--disable-mem-pools</option>
+
+Deprecated:2.10: It does nothing, since #GNode has been converted to
+the <link linkend="glib-Memory-Slices">slice
+allocator</link>
</description>
<parameters>
-<parameter name="array">
-<parameter_description> a @GPtrArray.
-</parameter_description>
-</parameter>
-<parameter name="index_">
-<parameter_description> the index of the first pointer to remove.
-</parameter_description>
-</parameter>
-<parameter name="length">
-<parameter_description> the number of pointers to remove.
+<parameter name="dummy">
+<parameter_description> the #GAllocator to use when allocating #GNode elements.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_ptr_array_set_free_func">
+<function name="g_node_reverse_children">
<description>
-Sets a function for freeing each element when @array is destroyed
-either via g_ptr_array_unref(), when g_ptr_array_free() is called
-with @free_segment set to %TRUE or when removing elements.
-
-Since: 2.22
+Reverses the order of the children of a #GNode.
+(It doesn't change the order of the grandchildren.)
</description>
<parameters>
-<parameter name="array">
-<parameter_description> A #GPtrArray.
-</parameter_description>
-</parameter>
-<parameter name="element_free_func">
-<parameter_description> A function to free elements with destroy @array or %NULL.
+<parameter name="node">
+<parameter_description> a #GNode.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_ptr_array_set_size">
+<function name="g_node_traverse">
<description>
-Sets the size of the array. When making the array larger,
-newly-added elements will be set to %NULL. When making it smaller,
-if @array has a non-%NULL #GDestroyNotify function then it will be
-called for the removed elements.
+Traverses a tree starting at the given root #GNode.
+It calls the given function for each node visited.
+The traversal can be halted at any point by returning %TRUE from @func.
</description>
<parameters>
-<parameter name="array">
-<parameter_description> a #GPtrArray.
+<parameter name="root">
+<parameter_description> the root #GNode of the tree to traverse
</parameter_description>
</parameter>
-<parameter name="length">
-<parameter_description> the new length of the pointer array.
+<parameter name="order">
+<parameter_description> the order in which nodes are visited - %G_IN_ORDER,
+%G_PRE_ORDER, %G_POST_ORDER, or %G_LEVEL_ORDER.
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> which types of children are to be visited, one of
+%G_TRAVERSE_ALL, %G_TRAVERSE_LEAVES and %G_TRAVERSE_NON_LEAVES
+</parameter_description>
+</parameter>
+<parameter name="max_depth">
+<parameter_description> the maximum depth of the traversal. Nodes below this
+depth will not be visited. If max_depth is -1 all nodes in
+the tree are visited. If depth is 1, only the root is visited.
+If depth is 2, the root and its children are visited. And so on.
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> the function to call for each visited #GNode
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> user data to pass to the function
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_ptr_array_sized_new">
+<function name="g_node_unlink">
<description>
-Creates a new #GPtrArray with @reserved_size pointers preallocated
-and a reference count of 1. This avoids frequent reallocation, if
-you are going to add many pointers to the array. Note however that
-the size of the array is still 0.
+Unlinks a #GNode from a tree, resulting in two separate trees.
</description>
<parameters>
-<parameter name="reserved_size">
-<parameter_description> number of pointers preallocated.
+<parameter name="node">
+<parameter_description> the #GNode to unlink, which becomes the root of a new tree
</parameter_description>
</parameter>
</parameters>
-<return> the new #GPtrArray.
-</return>
+<return></return>
</function>
-<function name="g_ptr_array_sort">
+<function name="g_nullify_pointer">
<description>
-Sorts the array, using @compare_func which should be a qsort()-style
-comparison function (returns less than zero for first arg is less
-than second arg, zero for equal, greater than zero if irst arg is
-greater than second arg).
-
-If two array elements compare equal, their order in the sorted array
-is undefined.
-
-<note><para>The comparison function for g_ptr_array_sort() doesn't
-take the pointers from the array as arguments, it takes pointers to
-the pointers in the array.</para></note>
+Set the pointer at the specified location to %NULL.
</description>
<parameters>
-<parameter name="array">
-<parameter_description> a #GPtrArray.
-</parameter_description>
-</parameter>
-<parameter name="compare_func">
-<parameter_description> comparison function.
+<parameter name="nullify_location">
+<parameter_description> the memory address of the pointer.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_ptr_array_sort_with_data">
+<function name="g_object_add_toggle_ref">
<description>
-Like g_ptr_array_sort(), but the comparison function has an extra
-user data argument.
+Increases the reference count of the object by one and sets a
+callback to be called when all other references to the object are
+dropped, or when this is already the last reference to the object
+and another reference is established.
-<note><para>The comparison function for g_ptr_array_sort_with_data()
-doesn't take the pointers from the array as arguments, it takes
-pointers to the pointers in the array.</para></note>
+This functionality is intended for binding @object to a proxy
+object managed by another memory manager. This is done with two
+paired references: the strong reference added by
+g_object_add_toggle_ref() and a reverse reference to the proxy
+object which is either a strong reference or weak reference.
+
+The setup is that when there are no other references to @object,
+only a weak reference is held in the reverse direction from @object
+to the proxy object, but when there are other references held to
+ object, a strong reference is held. The @notify callback is called
+when the reference from @object to the proxy object should be
+<firstterm>toggled</firstterm> from strong to weak (@is_last_ref
+true) or weak to strong (@is_last_ref false).
+
+Since a (normal) reference must be held to the object before
+calling g_object_toggle_ref(), the initial state of the reverse
+link is always strong.
+
+Multiple toggle references may be added to the same gobject,
+however if there are multiple toggle references to an object, none
+of them will ever be notified until all but one are removed. For
+this reason, you should only ever use a toggle reference if there
+is important state in the proxy object.
+
+Since: 2.8
</description>
<parameters>
-<parameter name="array">
-<parameter_description> a #GPtrArray.
+<parameter name="object">
+<parameter_description> a #GObject
</parameter_description>
</parameter>
-<parameter name="compare_func">
-<parameter_description> comparison function.
+<parameter name="notify">
+<parameter_description> a function to call when this reference is the
+last reference to the object, or is no longer
+the last reference.
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> data to pass to @compare_func.
+<parameter name="data">
+<parameter_description> data to pass to @notify
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_ptr_array_unref">
+<function name="g_object_add_weak_pointer">
<description>
-Atomically decrements the reference count of @array by one. If the
-reference count drops to 0, the effect is the same as calling
-g_ptr_array_free() with @free_segment set to %TRUE. This function
-is MT-safe and may be called from any thread.
-
-Since: 2.22
+Adds a weak reference from weak_pointer to @object to indicate that
+the pointer located at @weak_pointer_location is only valid during
+the lifetime of @object. When the @object is finalized,
+ weak_pointer will be set to %NULL.
</description>
<parameters>
-<parameter name="array">
-<parameter_description> A #GPtrArray.
+<parameter name="object">
+<parameter_description> The object that should be weak referenced.
+</parameter_description>
+</parameter>
+<parameter name="weak_pointer_location">
+<parameter_description> The memory address of a pointer.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_qsort_with_data">
+<function name="g_object_bind_property">
<description>
-This is just like the standard C qsort() function, but
-the comparison routine accepts a user data argument.
+Creates a binding between @source_property on @source and @target_property
+on @target. Whenever the @source_property is changed the @target_property is
+updated using the same value. For instance:
+
+|[
+g_object_bind_property (action, "active", widget, "sensitive", 0);
+]|
+
+Will result in the "sensitive" property of the widget #GObject instance to be
+updated with the same value of the "active" property of the action #GObject
+instance.
+
+If @flags contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual:
+if @target_property on @target changes then the @source_property on @source
+will be updated as well.
+
+The binding will automatically be removed when either the @source or the
+ target instances are finalized. To remove the binding without affecting the
+ source and the @target you can just call g_object_unref() on the returned
+#GBinding instance.
+
+A #GObject can have multiple bindings.
+
+Since: 2.26
</description>
<parameters>
-<parameter name="pbase">
-<parameter_description> start of array to sort
+<parameter name="source">
+<parameter_description> the source #GObject
</parameter_description>
</parameter>
-<parameter name="total_elems">
-<parameter_description> elements in the array
+<parameter name="source_property">
+<parameter_description> the property on @source to bind
</parameter_description>
</parameter>
-<parameter name="size">
-<parameter_description> size of each element
+<parameter name="target">
+<parameter_description> the target #GObject
</parameter_description>
</parameter>
-<parameter name="compare_func">
-<parameter_description> function to compare elements
+<parameter name="target_property">
+<parameter_description> the property on @target to bind
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> data to pass to @compare_func
+<parameter name="flags">
+<parameter_description> flags to pass to #GBinding
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the #GBinding instance representing the
+binding between the two #GObject instances. The binding is released
+whenever the #GBinding reference count reaches zero.
+
+</return>
</function>
-<function name="g_quark_from_static_string">
+<function name="g_object_bind_property_full">
<description>
-Gets the #GQuark identifying the given (static) string. If the
-string does not currently have an associated #GQuark, a new #GQuark
-is created, linked to the given string.
+Complete version of g_object_bind_property().
-Note that this function is identical to g_quark_from_string() except
-that if a new #GQuark is created the string itself is used rather
-than a copy. This saves memory, but can only be used if the string
-will <emphasis>always</emphasis> exist. It can be used with
-statically allocated strings in the main program, but not with
-statically allocated memory in dynamically loaded modules, if you
-expect to ever unload the module again (e.g. do not use this
-function in GTK+ theme engines).
+Creates a binding between @source_property on @source and @target_property
+on @target, allowing you to set the transformation functions to be used by
+the binding.
-</description>
-<parameters>
-<parameter name="string">
-<parameter_description> a string.
-</parameter_description>
-</parameter>
-</parameters>
-<return> the #GQuark identifying the string, or 0 if @string is
-%NULL.
-</return>
-</function>
+If @flags contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual:
+if @target_property on @target changes then the @source_property on @source
+will be updated as well. The @transform_from function is only used in case
+of bidirectional bindings, otherwise it will be ignored
-<function name="g_quark_from_string">
-<description>
-Gets the #GQuark identifying the given string. If the string does
-not currently have an associated #GQuark, a new #GQuark is created,
-using a copy of the string.
+The binding will automatically be removed when either the @source or the
+ target instances are finalized. To remove the binding without affecting the
+ source and the @target you can just call g_object_unref() on the returned
+#GBinding instance.
+
+A #GObject can have multiple bindings.
+
+<note>The same @user_data parameter will be used for both @transform_to
+and @transform_from transformation functions; the @notify function will
+be called once, when the binding is removed. If you need different data
+for each transformation function, please use
+g_object_bind_property_with_closures() instead.</note>
+
+Since: 2.26
</description>
<parameters>
-<parameter name="string">
-<parameter_description> a string.
+<parameter name="source">
+<parameter_description> the source #GObject
+</parameter_description>
+</parameter>
+<parameter name="source_property">
+<parameter_description> the property on @source to bind
+</parameter_description>
+</parameter>
+<parameter name="target">
+<parameter_description> the target #GObject
+</parameter_description>
+</parameter>
+<parameter name="target_property">
+<parameter_description> the property on @target to bind
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> flags to pass to #GBinding
+</parameter_description>
+</parameter>
+<parameter name="transform_to">
+<parameter_description> the transformation function
+from the @source to the @target, or %NULL to use the default
+</parameter_description>
+</parameter>
+<parameter name="transform_from">
+<parameter_description> the transformation function
+from the @target to the @source, or %NULL to use the default
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> custom data to be passed to the transformation functions,
+or %NULL
+</parameter_description>
+</parameter>
+<parameter name="notify">
+<parameter_description> function to be called when disposing the binding, to free the
+resources used by the transformation functions
</parameter_description>
</parameter>
</parameters>
-<return> the #GQuark identifying the string, or 0 if @string is
-%NULL.
+<return> the #GBinding instance representing the
+binding between the two #GObject instances. The binding is released
+whenever the #GBinding reference count reaches zero.
+
</return>
</function>
-<function name="g_quark_to_string">
+<function name="g_object_bind_property_with_closures">
<description>
-Gets the string associated with the given #GQuark.
+Creates a binding between @source_property on @source and @target_property
+on @target, allowing you to set the transformation functions to be used by
+the binding.
+
+This function is the language bindings friendly version of
+g_object_bind_property_full(), using #GClosure<!-- -->s instead of
+function pointers.
+
+Since: 2.26
</description>
<parameters>
-<parameter name="quark">
-<parameter_description> a #GQuark.
+<parameter name="source">
+<parameter_description> the source #GObject
+</parameter_description>
+</parameter>
+<parameter name="source_property">
+<parameter_description> the property on @source to bind
+</parameter_description>
+</parameter>
+<parameter name="target">
+<parameter_description> the target #GObject
+</parameter_description>
+</parameter>
+<parameter name="target_property">
+<parameter_description> the property on @target to bind
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> flags to pass to #GBinding
+</parameter_description>
+</parameter>
+<parameter name="transform_to">
+<parameter_description> a #GClosure wrapping the transformation function
+from the @source to the @target, or %NULL to use the default
+</parameter_description>
+</parameter>
+<parameter name="transform_from">
+<parameter_description> a #GClosure wrapping the transformation function
+from the @target to the @source, or %NULL to use the default
</parameter_description>
</parameter>
</parameters>
-<return> the string associated with the #GQuark.
+<return> the #GBinding instance representing the
+binding between the two #GObject instances. The binding is released
+whenever the #GBinding reference count reaches zero.
+
</return>
</function>
-<function name="g_quark_try_string">
+<function name="g_object_class_find_property">
<description>
-Gets the #GQuark associated with the given string, or 0 if string is
-%NULL or it has no associated #GQuark.
+Looks up the #GParamSpec for a property of a class.
-If you want the GQuark to be created if it doesn't already exist,
-use g_quark_from_string() or g_quark_from_static_string().
</description>
<parameters>
-<parameter name="string">
-<parameter_description> a string.
+<parameter name="oclass">
+<parameter_description> a #GObjectClass
+</parameter_description>
+</parameter>
+<parameter name="property_name">
+<parameter_description> the name of the property to look up
</parameter_description>
</parameter>
</parameters>
-<return> the #GQuark associated with the string, or 0 if @string is
-%NULL or there is no #GQuark associated with it.
+<return> the #GParamSpec for the property, or
+%NULL if the class doesn't have a property of that name
</return>
</function>
-<function name="g_queue_clear">
+<function name="g_object_class_install_properties">
<description>
-Removes all the elements in @queue. If queue elements contain
-dynamically-allocated memory, they should be freed first.
+Installs new properties from an array of #GParamSpec<!-- -->s. This is
+usually done in the class initializer.
-Since: 2.14
+The property id of each property is the index of each #GParamSpec in
+the @pspecs array.
+
+The property id of 0 is treated specially by #GObject and it should not
+be used to store a #GParamSpec.
+
+This function should be used if you plan to use a static array of
+#GParamSpec<!-- -->s and g_object_notify_by_pspec(). For instance, this
+class initialization:
+
+|[
+enum {
+PROP_0, PROP_FOO, PROP_BAR, N_PROPERTIES
+};
+
+static GParamSpec *obj_properties[N_PROPERTIES] = { NULL, };
+
+static void
+my_object_class_init (MyObjectClass *klass)
+{
+GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
+
+obj_properties[PROP_FOO] =
+g_param_spec_int ("foo", "Foo", "Foo",
+-1, G_MAXINT,
+0,
+G_PARAM_READWRITE);
+
+obj_properties[PROP_BAR] =
+g_param_spec_string ("bar", "Bar", "Bar",
+NULL,
+G_PARAM_READWRITE);
+
+gobject_class->set_property = my_object_set_property;
+gobject_class->get_property = my_object_get_property;
+g_object_class_install_properties (gobject_class,
+N_PROPERTIES,
+obj_properties);
+}
+]|
+
+allows calling g_object_notify_by_pspec() to notify of property changes:
+
+|[
+void
+my_object_set_foo (MyObject *self, gint foo)
+{
+if (self->foo != foo)
+{
+self->foo = foo;
+g_object_notify_by_pspec (G_OBJECT (self), obj_properties[PROP_FOO]);
+}
+}
+]|
+
+Since: 2.26
</description>
<parameters>
-<parameter name="queue">
-<parameter_description> a #GQueue
+<parameter name="oclass">
+<parameter_description> a #GObjectClass
+</parameter_description>
+</parameter>
+<parameter name="n_pspecs">
+<parameter_description> the length of the #GParamSpec<!-- -->s array
+</parameter_description>
+</parameter>
+<parameter name="pspecs">
+<parameter_description> the #GParamSpec<!-- -->s array
+defining the new properties
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_queue_copy">
+<function name="g_object_class_install_property">
<description>
-Copies a @queue. Note that is a shallow copy. If the elements in the
-queue consist of pointers to data, the pointers are copied, but the
-actual data is not.
+Installs a new property. This is usually done in the class initializer.
-Since: 2.4
+Note that it is possible to redefine a property in a derived class,
+by installing a property with the same name. This can be useful at times,
+e.g. to change the range of allowed values or the default value.
</description>
<parameters>
-<parameter name="queue">
-<parameter_description> a #GQueue
+<parameter name="oclass">
+<parameter_description> a #GObjectClass
+</parameter_description>
+</parameter>
+<parameter name="property_id">
+<parameter_description> the id for the new property
+</parameter_description>
+</parameter>
+<parameter name="pspec">
+<parameter_description> the #GParamSpec for the new property
</parameter_description>
</parameter>
</parameters>
-<return> A copy of @queue
-
-</return>
+<return></return>
</function>
-<function name="g_queue_delete_link">
+<function name="g_object_class_list_properties">
<description>
-Removes @link_ from @queue and frees it.
-
- link_ must be part of @queue.
+Get an array of #GParamSpec* for all properties of a class.
-Since: 2.4
</description>
<parameters>
-<parameter name="queue">
-<parameter_description> a #GQueue
+<parameter name="oclass">
+<parameter_description> a #GObjectClass
</parameter_description>
</parameter>
-<parameter name="link_">
-<parameter_description> a #GList link that <emphasis>must</emphasis> be part of @queue
+<parameter name="n_properties">
+<parameter_description> return location for the length of the returned array
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> an array of
+#GParamSpec* which should be freed after use
+</return>
</function>
-<function name="g_queue_find">
+<function name="g_object_class_override_property">
<description>
-Finds the first link in @queue which contains @data.
+Registers @property_id as referring to a property with the
+name @name in a parent class or in an interface implemented
+by @oclass. This allows this class to <firstterm>override</firstterm>
+a property implementation in a parent class or to provide
+the implementation of a property from an interface.
+
+<note>
+Internally, overriding is implemented by creating a property of type
+#GParamSpecOverride; generally operations that query the properties of
+the object class, such as g_object_class_find_property() or
+g_object_class_list_properties() will return the overridden
+property. However, in one case, the @construct_properties argument of
+the @constructor virtual function, the #GParamSpecOverride is passed
+instead, so that the @param_id field of the #GParamSpec will be
+correct. For virtually all uses, this makes no difference. If you
+need to get the overridden property, you can call
+g_param_spec_get_redirect_target().
+</note>
Since: 2.4
</description>
<parameters>
-<parameter name="queue">
-<parameter_description> a #GQueue
+<parameter name="oclass">
+<parameter_description> a #GObjectClass
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> data to find
+<parameter name="property_id">
+<parameter_description> the new property ID
+</parameter_description>
+</parameter>
+<parameter name="name">
+<parameter_description> the name of a property registered in a parent class or
+in an interface of this class.
</parameter_description>
</parameter>
</parameters>
-<return> The first link in @queue which contains @data.
-
-</return>
+<return></return>
</function>
-<function name="g_queue_find_custom">
+<function name="g_object_connect">
<description>
-Finds an element in a #GQueue, using a supplied function to find the
-desired element. It iterates over the queue, calling the given function
-which should return 0 when the desired element is found. The function
-takes two gconstpointer arguments, the #GQueue element's data as the
-first argument and the given user data as the second argument.
+A convenience function to connect multiple signals at once.
+
+The signal specs expected by this function have the form
+"modifier::signal_name", where modifier can be one of the following:
+<variablelist>
+<varlistentry>
+<term>signal</term>
+<listitem><para>
+equivalent to <literal>g_signal_connect_data (..., NULL, 0)</literal>
+</para></listitem>
+</varlistentry>
+<varlistentry>
+<term>object_signal</term>
+<term>object-signal</term>
+<listitem><para>
+equivalent to <literal>g_signal_connect_object (..., 0)</literal>
+</para></listitem>
+</varlistentry>
+<varlistentry>
+<term>swapped_signal</term>
+<term>swapped-signal</term>
+<listitem><para>
+equivalent to <literal>g_signal_connect_data (..., NULL, G_CONNECT_SWAPPED)</literal>
+</para></listitem>
+</varlistentry>
+<varlistentry>
+<term>swapped_object_signal</term>
+<term>swapped-object-signal</term>
+<listitem><para>
+equivalent to <literal>g_signal_connect_object (..., G_CONNECT_SWAPPED)</literal>
+</para></listitem>
+</varlistentry>
+<varlistentry>
+<term>signal_after</term>
+<term>signal-after</term>
+<listitem><para>
+equivalent to <literal>g_signal_connect_data (..., NULL, G_CONNECT_AFTER)</literal>
+</para></listitem>
+</varlistentry>
+<varlistentry>
+<term>object_signal_after</term>
+<term>object-signal-after</term>
+<listitem><para>
+equivalent to <literal>g_signal_connect_object (..., G_CONNECT_AFTER)</literal>
+</para></listitem>
+</varlistentry>
+<varlistentry>
+<term>swapped_signal_after</term>
+<term>swapped-signal-after</term>
+<listitem><para>
+equivalent to <literal>g_signal_connect_data (..., NULL, G_CONNECT_SWAPPED | G_CONNECT_AFTER)</literal>
+</para></listitem>
+</varlistentry>
+<varlistentry>
+<term>swapped_object_signal_after</term>
+<term>swapped-object-signal-after</term>
+<listitem><para>
+equivalent to <literal>g_signal_connect_object (..., G_CONNECT_SWAPPED | G_CONNECT_AFTER)</literal>
+</para></listitem>
+</varlistentry>
+</variablelist>
+
+|[
+menu->toplevel = g_object_connect (g_object_new (GTK_TYPE_WINDOW,
+"type", GTK_WINDOW_POPUP,
+"child", menu,
+NULL),
+"signal::event", gtk_menu_window_event, menu,
+"signal::size_request", gtk_menu_window_size_request, menu,
+"signal::destroy", gtk_widget_destroyed, &menu->toplevel,
+NULL);
+]|
-Since: 2.4
</description>
<parameters>
-<parameter name="queue">
-<parameter_description> a #GQueue
+<parameter name="object">
+<parameter_description> a #GObject
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> user data passed to @func
+<parameter name="signal_spec">
+<parameter_description> the spec for the first signal
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> a #GCompareFunc to call for each element. It should return 0
-when the desired element is found
+<parameter name="Varargs">
+<parameter_description> #GCallback for the first signal, followed by data for the
+first signal, followed optionally by more signal
+spec/callback/data triples, followed by %NULL
</parameter_description>
</parameter>
</parameters>
-<return> The found link, or %NULL if it wasn't found
-
+<return> @object
</return>
</function>
-<function name="g_queue_foreach">
+<function name="g_object_disconnect">
<description>
-Calls @func for each element in the queue passing @user_data to the
-function.
+A convenience function to disconnect multiple signals at once.
-Since: 2.4
+The signal specs expected by this function have the form
+"any_signal", which means to disconnect any signal with matching
+callback and data, or "any_signal::signal_name", which only
+disconnects the signal named "signal_name".
</description>
<parameters>
-<parameter name="queue">
-<parameter_description> a #GQueue
+<parameter name="object">
+<parameter_description> a #GObject
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> the function to call for each element's data
+<parameter name="signal_spec">
+<parameter_description> the spec for the first signal
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> user data to pass to @func
+<parameter name="Varargs">
+<parameter_description> #GCallback for the first signal, followed by data for the first signal,
+followed optionally by more signal spec/callback/data triples,
+followed by %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_queue_free">
+<function name="g_object_force_floating">
<description>
-Frees the memory allocated for the #GQueue. Only call this function if
- queue was created with g_queue_new(). If queue elements contain
-dynamically-allocated memory, they should be freed first.
+This function is intended for #GObject implementations to re-enforce a
+<link linkend="floating-ref">floating</link> object reference.
+Doing this is seldomly required: all
+#GInitiallyUnowned<!-- -->s are created with a floating reference which
+usually just needs to be sunken by calling g_object_ref_sink().
+
+Since: 2.10
</description>
<parameters>
-<parameter name="queue">
-<parameter_description> a #GQueue.
+<parameter name="object">
+<parameter_description> a #GObject
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_queue_get_length">
+<function name="g_object_freeze_notify">
<description>
-Returns the number of items in @queue.
+Increases the freeze count on @object. If the freeze count is
+non-zero, the emission of "notify" signals on @object is
+stopped. The signals are queued until the freeze count is decreased
+to zero.
-Since: 2.4
+This is necessary for accessors that modify multiple properties to prevent
+premature notification while the object is still being modified.
</description>
<parameters>
-<parameter name="queue">
-<parameter_description> a #GQueue
+<parameter name="object">
+<parameter_description> a #GObject
</parameter_description>
</parameter>
</parameters>
-<return> The number of items in @queue.
-
-</return>
+<return></return>
</function>
-<function name="g_queue_index">
+<function name="g_object_get">
<description>
-Returns the position of the first element in @queue which contains @data.
+Gets properties of an object.
-Since: 2.4
+In general, a copy is made of the property contents and the caller
+is responsible for freeing the memory in the appropriate manner for
+the type, for instance by calling g_free() or g_object_unref().
+
+<example>
+<title>Using g_object_get(<!-- -->)</title>
+An example of using g_object_get() to get the contents
+of three properties - one of type #G_TYPE_INT,
+one of type #G_TYPE_STRING, and one of type #G_TYPE_OBJECT:
+<programlisting>
+gint intval;
+gchar *strval;
+GObject *objval;
+
+g_object_get (my_object,
+"int-property", &intval,
+"str-property", &strval,
+"obj-property", &objval,
+NULL);
+
+// Do something with intval, strval, objval
+
+g_free (strval);
+g_object_unref (objval);
+</programlisting>
+</example>
</description>
<parameters>
-<parameter name="queue">
-<parameter_description> a #GQueue
+<parameter name="object">
+<parameter_description> a #GObject
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> the data to find.
+<parameter name="first_property_name">
+<parameter_description> name of the first property to get
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> return location for the first property, followed optionally by more
+name/return location pairs, followed by %NULL
</parameter_description>
</parameter>
</parameters>
-<return> The position of the first element in @queue which contains @data, or -1 if no element in @queue contains @data.
-
-</return>
+<return></return>
</function>
-<function name="g_queue_init">
+<function name="g_object_get_data">
<description>
-A statically-allocated #GQueue must be initialized with this function
-before it can be used. Alternatively you can initialize it with
-#G_QUEUE_INIT. It is not necessary to initialize queues created with
-g_queue_new().
+Gets a named field from the objects table of associations (see g_object_set_data()).
-Since: 2.14
</description>
<parameters>
-<parameter name="queue">
-<parameter_description> an uninitialized #GQueue
+<parameter name="object">
+<parameter_description> #GObject containing the associations
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> name of the key for that association
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the data if found, or %NULL if no such data exists.
+</return>
</function>
-<function name="g_queue_insert_after">
+<function name="g_object_get_property">
<description>
-Inserts @data into @queue after @sibling
+Gets a property of an object. @value must have been initialized to the
+expected type of the property (or a type to which the expected type can be
+transformed) using g_value_init().
- sibling must be part of @queue
+In general, a copy is made of the property contents and the caller is
+responsible for freeing the memory by calling g_value_unset().
-Since: 2.4
+Note that g_object_get_property() is really intended for language
+bindings, g_object_get() is much more convenient for C programming.
</description>
<parameters>
-<parameter name="queue">
-<parameter_description> a #GQueue
+<parameter name="object">
+<parameter_description> a #GObject
</parameter_description>
</parameter>
-<parameter name="sibling">
-<parameter_description> a #GList link that <emphasis>must</emphasis> be part of @queue
+<parameter name="property_name">
+<parameter_description> the name of the property to get
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> the data to insert
+<parameter name="value">
+<parameter_description> return location for the property value
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_queue_insert_before">
+<function name="g_object_get_qdata">
<description>
-Inserts @data into @queue before @sibling.
-
- sibling must be part of @queue.
+This function gets back user data pointers stored via
+g_object_set_qdata().
-Since: 2.4
</description>
<parameters>
-<parameter name="queue">
-<parameter_description> a #GQueue
+<parameter name="object">
+<parameter_description> The GObject to get a stored user data pointer from
</parameter_description>
</parameter>
-<parameter name="sibling">
-<parameter_description> a #GList link that <emphasis>must</emphasis> be part of @queue
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> the data to insert
+<parameter name="quark">
+<parameter_description> A #GQuark, naming the user data pointer
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The user data pointer set, or %NULL
+</return>
</function>
-<function name="g_queue_insert_sorted">
+<function name="g_object_get_valist">
<description>
-Inserts @data into @queue using @func to determine the new position.
+Gets properties of an object.
-Since: 2.4
+In general, a copy is made of the property contents and the caller
+is responsible for freeing the memory in the appropriate manner for
+the type, for instance by calling g_free() or g_object_unref().
+
+See g_object_get().
</description>
<parameters>
-<parameter name="queue">
-<parameter_description> a #GQueue
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> the data to insert
+<parameter name="object">
+<parameter_description> a #GObject
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> the #GCompareDataFunc used to compare elements in the queue. It is
-called with two elements of the @queue and @user_data. It should
-return 0 if the elements are equal, a negative value if the first
-element comes before the second, and a positive value if the second
-element comes before the first.
+<parameter name="first_property_name">
+<parameter_description> name of the first property to get
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> user data passed to @func.
+<parameter name="var_args">
+<parameter_description> return location for the first property, followed optionally by more
+name/return location pairs, followed by %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_queue_is_empty">
+<function name="g_object_interface_find_property">
<description>
-Returns %TRUE if the queue is empty.
+Find the #GParamSpec with the given name for an
+interface. Generally, the interface vtable passed in as @g_iface
+will be the default vtable from g_type_default_interface_ref(), or,
+if you know the interface has already been loaded,
+g_type_default_interface_peek().
+
+Since: 2.4
</description>
<parameters>
-<parameter name="queue">
-<parameter_description> a #GQueue.
+<parameter name="g_iface">
+<parameter_description> any interface vtable for the interface, or the default
+vtable for the interface
+</parameter_description>
+</parameter>
+<parameter name="property_name">
+<parameter_description> name of a property to lookup.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the queue is empty.
+<return> the #GParamSpec for the property of the
+interface with the name @property_name, or %NULL if no
+such property exists.
</return>
</function>
-<function name="g_queue_link_index">
+<function name="g_object_interface_install_property">
<description>
-Returns the position of @link_ in @queue.
+Add a property to an interface; this is only useful for interfaces
+that are added to GObject-derived types. Adding a property to an
+interface forces all objects classes with that interface to have a
+compatible property. The compatible property could be a newly
+created #GParamSpec, but normally
+g_object_class_override_property() will be used so that the object
+class only needs to provide an implementation and inherits the
+property description, default value, bounds, and so forth from the
+interface property.
+
+This function is meant to be called from the interface's default
+vtable initialization function (the @class_init member of
+#GTypeInfo.) It must not be called after after @class_init has
+been called for any object types implementing this interface.
Since: 2.4
</description>
<parameters>
-<parameter name="queue">
-<parameter_description> a #Gqueue
+<parameter name="g_iface">
+<parameter_description> any interface vtable for the interface, or the default
+vtable for the interface.
</parameter_description>
</parameter>
-<parameter name="link_">
-<parameter_description> A #GList link
+<parameter name="pspec">
+<parameter_description> the #GParamSpec for the new property
</parameter_description>
</parameter>
</parameters>
-<return> The position of @link_, or -1 if the link is
-not part of @queue
-
-</return>
+<return></return>
</function>
-<function name="g_queue_new">
+<function name="g_object_interface_list_properties">
<description>
-Creates a new #GQueue.
-
-
-</description>
-<parameters>
-</parameters>
-<return> a new #GQueue.
-</return>
-</function>
+Lists the properties of an interface.Generally, the interface
+vtable passed in as @g_iface will be the default vtable from
+g_type_default_interface_ref(), or, if you know the interface has
+already been loaded, g_type_default_interface_peek().
-<function name="g_queue_peek_head">
-<description>
-Returns the first element of the queue.
+Since: 2.4
</description>
<parameters>
-<parameter name="queue">
-<parameter_description> a #GQueue.
+<parameter name="g_iface">
+<parameter_description> any interface vtable for the interface, or the default
+vtable for the interface
+</parameter_description>
+</parameter>
+<parameter name="n_properties_p">
+<parameter_description> location to store number of properties returned.
</parameter_description>
</parameter>
</parameters>
-<return> the data of the first element in the queue, or %NULL if the queue
-is empty.
+<return> a
+pointer to an array of pointers to #GParamSpec
+structures. The paramspecs are owned by GLib, but the
+array should be freed with g_free() when you are done with
+it.
</return>
</function>
-<function name="g_queue_peek_head_link">
+<function name="g_object_is_floating">
<description>
-Returns the first link in @queue
+Checks whether @object has a <link linkend="floating-ref">floating</link>
+reference.
+
+Since: 2.10
-Since: 2.4
</description>
<parameters>
-<parameter name="queue">
-<parameter_description> a #GQueue
+<parameter name="object">
+<parameter_description> a #GObject
</parameter_description>
</parameter>
</parameters>
-<return> the first link in @queue, or %NULL if @queue is empty
-
+<return> %TRUE if @object has a floating reference
</return>
</function>
-<function name="g_queue_peek_nth">
+<function name="g_object_new">
<description>
-Returns the @n'th element of @queue.
+Creates a new instance of a #GObject subtype and sets its properties.
+
+Construction parameters (see #G_PARAM_CONSTRUCT, #G_PARAM_CONSTRUCT_ONLY)
+which are not explicitly specified are set to their default values.
-Since: 2.4
</description>
<parameters>
-<parameter name="queue">
-<parameter_description> a #GQueue
+<parameter name="object_type">
+<parameter_description> the type id of the #GObject subtype to instantiate
</parameter_description>
</parameter>
-<parameter name="n">
-<parameter_description> the position of the element.
+<parameter name="first_property_name">
+<parameter_description> the name of the first property
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> the value of the first property, followed optionally by more
+name/value pairs, followed by %NULL
</parameter_description>
</parameter>
</parameters>
-<return> The data for the @n'th element of @queue, or %NULL if @n is
-off the end of @queue.
-
+<return> a new instance of @object_type
</return>
</function>
-<function name="g_queue_peek_nth_link">
+<function name="g_object_new_valist">
<description>
-Returns the link at the given position
+Creates a new instance of a #GObject subtype and sets its properties.
+
+Construction parameters (see #G_PARAM_CONSTRUCT, #G_PARAM_CONSTRUCT_ONLY)
+which are not explicitly specified are set to their default values.
-Since: 2.4
</description>
<parameters>
-<parameter name="queue">
-<parameter_description> a #GQueue
+<parameter name="object_type">
+<parameter_description> the type id of the #GObject subtype to instantiate
</parameter_description>
</parameter>
-<parameter name="n">
-<parameter_description> the position of the link
+<parameter name="first_property_name">
+<parameter_description> the name of the first property
+</parameter_description>
+</parameter>
+<parameter name="var_args">
+<parameter_description> the value of the first property, followed optionally by more
+name/value pairs, followed by %NULL
</parameter_description>
</parameter>
</parameters>
-<return> The link at the @n'th position, or %NULL if @n is off the
-end of the list
-
+<return> a new instance of @object_type
</return>
</function>
-<function name="g_queue_peek_tail">
+<function name="g_object_newv">
<description>
-Returns the last element of the queue.
+Creates a new instance of a #GObject subtype and sets its properties.
+
+Construction parameters (see #G_PARAM_CONSTRUCT, #G_PARAM_CONSTRUCT_ONLY)
+which are not explicitly specified are set to their default values.
</description>
<parameters>
-<parameter name="queue">
-<parameter_description> a #GQueue.
+<parameter name="object_type">
+<parameter_description> the type id of the #GObject subtype to instantiate
+</parameter_description>
+</parameter>
+<parameter name="n_parameters">
+<parameter_description> the length of the @parameters array
+</parameter_description>
+</parameter>
+<parameter name="parameters">
+<parameter_description> an array of #GParameter
</parameter_description>
</parameter>
</parameters>
-<return> the data of the last element in the queue, or %NULL if the queue
-is empty.
+<return> a new instance of
+ object_type
</return>
</function>
-<function name="g_queue_peek_tail_link">
+<function name="g_object_notify">
<description>
-Returns the last link @queue.
+Emits a "notify" signal for the property @property_name on @object.
-Since: 2.4
+When possible, eg. when signaling a property change from within the class
+that registered the property, you should use g_object_notify_by_pspec()
+instead.
</description>
<parameters>
-<parameter name="queue">
-<parameter_description> a #GQueue
+<parameter name="object">
+<parameter_description> a #GObject
+</parameter_description>
+</parameter>
+<parameter name="property_name">
+<parameter_description> the name of a property installed on the class of @object.
</parameter_description>
</parameter>
</parameters>
-<return> the last link in @queue, or %NULL if @queue is empty
-
-</return>
+<return></return>
</function>
-<function name="g_queue_pop_head">
+<function name="g_object_notify_by_pspec">
<description>
-Removes the first element of the queue.
+Emits a "notify" signal for the property specified by @pspec on @object.
+This function omits the property name lookup, hence it is faster than
+g_object_notify().
-</description>
-<parameters>
-<parameter name="queue">
-<parameter_description> a #GQueue.
-</parameter_description>
-</parameter>
-</parameters>
-<return> the data of the first element in the queue, or %NULL if the queue
-is empty.
-</return>
-</function>
+One way to avoid using g_object_notify() from within the
+class that registered the properties, and using g_object_notify_by_pspec()
+instead, is to store the GParamSpec used with
+g_object_class_install_property() inside a static array, e.g.:
-<function name="g_queue_pop_head_link">
-<description>
-Removes the first element of the queue.
+|[
+enum
+{
+PROP_0,
+PROP_FOO,
+PROP_LAST
+};
+static GParamSpec *properties[PROP_LAST];
-</description>
-<parameters>
-<parameter name="queue">
-<parameter_description> a #GQueue.
-</parameter_description>
-</parameter>
-</parameters>
-<return> the #GList element at the head of the queue, or %NULL if the queue
-is empty.
-</return>
-</function>
+static void
+my_object_class_init (MyObjectClass *klass)
+{
+properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
+0, 100,
+50,
+G_PARAM_READWRITE);
+g_object_class_install_property (gobject_class,
+PROP_FOO,
+properties[PROP_FOO]);
+}
+]|
-<function name="g_queue_pop_nth">
-<description>
-Removes the @n'th element of @queue.
+and then notify a change on the "foo" property with:
-Since: 2.4
+|[
+g_object_notify_by_pspec (self, properties[PROP_FOO]);
+]|
+
+Since: 2.26
</description>
<parameters>
-<parameter name="queue">
-<parameter_description> a #GQueue
+<parameter name="object">
+<parameter_description> a #GObject
</parameter_description>
</parameter>
-<parameter name="n">
-<parameter_description> the position of the element.
+<parameter name="pspec">
+<parameter_description> the #GParamSpec of a property installed on the class of @object.
</parameter_description>
</parameter>
</parameters>
-<return> the element's data, or %NULL if @n is off the end of @queue.
-
-</return>
+<return></return>
</function>
-<function name="g_queue_pop_nth_link">
+<function name="g_object_ref">
<description>
-Removes and returns the link at the given position.
+Increases the reference count of @object.
-Since: 2.4
</description>
<parameters>
-<parameter name="queue">
-<parameter_description> a #GQueue
-</parameter_description>
-</parameter>
-<parameter name="n">
-<parameter_description> the link's position
+<parameter name="object">
+<parameter_description> a #GObject
</parameter_description>
</parameter>
</parameters>
-<return> The @n'th link, or %NULL if @n is off the end of @queue.
-
+<return> the same @object
</return>
</function>
-<function name="g_queue_pop_tail">
+<function name="g_object_ref_sink">
<description>
-Removes the last element of the queue.
+Increase the reference count of @object, and possibly remove the
+<link linkend="floating-ref">floating</link> reference, if @object
+has a floating reference.
+
+In other words, if the object is floating, then this call "assumes
+ownership" of the floating reference, converting it to a normal
+reference by clearing the floating flag while leaving the reference
+count unchanged. If the object is not floating, then this call
+adds a new normal reference increasing the reference count by one.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="queue">
-<parameter_description> a #GQueue.
+<parameter name="object">
+<parameter_description> a #GObject
</parameter_description>
</parameter>
</parameters>
-<return> the data of the last element in the queue, or %NULL if the queue
-is empty.
+<return> @object
</return>
</function>
-<function name="g_queue_pop_tail_link">
+<function name="g_object_remove_toggle_ref">
<description>
-Removes the last element of the queue.
+Removes a reference added with g_object_add_toggle_ref(). The
+reference count of the object is decreased by one.
+Since: 2.8
</description>
<parameters>
-<parameter name="queue">
-<parameter_description> a #GQueue.
+<parameter name="object">
+<parameter_description> a #GObject
+</parameter_description>
+</parameter>
+<parameter name="notify">
+<parameter_description> a function to call when this reference is the
+last reference to the object, or is no longer
+the last reference.
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> data to pass to @notify
</parameter_description>
</parameter>
</parameters>
-<return> the #GList element at the tail of the queue, or %NULL if the queue
-is empty.
-</return>
+<return></return>
</function>
-<function name="g_queue_push_head">
+<function name="g_object_remove_weak_pointer">
<description>
-Adds a new element at the head of the queue.
+Removes a weak reference from @object that was previously added
+using g_object_add_weak_pointer(). The @weak_pointer_location has
+to match the one used with g_object_add_weak_pointer().
</description>
<parameters>
-<parameter name="queue">
-<parameter_description> a #GQueue.
+<parameter name="object">
+<parameter_description> The object that is weak referenced.
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> the data for the new element.
+<parameter name="weak_pointer_location">
+<parameter_description> The memory address of a pointer.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_queue_push_head_link">
+<function name="g_object_run_dispose">
<description>
-Adds a new element at the head of the queue.
+Releases all references to other objects. This can be used to break
+reference cycles.
+
+This functions should only be called from object system implementations.
</description>
<parameters>
-<parameter name="queue">
-<parameter_description> a #GQueue.
-</parameter_description>
-</parameter>
-<parameter name="link_">
-<parameter_description> a single #GList element, <emphasis>not</emphasis> a list with
-more than one element.
+<parameter name="object">
+<parameter_description> a #GObject
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_queue_push_nth">
+<function name="g_object_set">
<description>
-Inserts a new element into @queue at the given position
-
-Since: 2.4
+Sets properties on an object.
</description>
<parameters>
-<parameter name="queue">
-<parameter_description> a #GQueue
+<parameter name="object">
+<parameter_description> a #GObject
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> the data for the new element
+<parameter name="first_property_name">
+<parameter_description> name of the first property to set
</parameter_description>
</parameter>
-<parameter name="n">
-<parameter_description> the position to insert the new element. If @n is negative or
-larger than the number of elements in the @queue, the element is
-added to the end of the queue.
+<parameter name="Varargs">
+<parameter_description> value for the first property, followed optionally by more
+name/value pairs, followed by %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_queue_push_nth_link">
+<function name="g_object_set_data">
<description>
-Inserts @link into @queue at the given position.
+Each object carries around a table of associations from
+strings to pointers. This function lets you set an association.
-Since: 2.4
+If the object already had an association with that name,
+the old association will be destroyed.
</description>
<parameters>
-<parameter name="queue">
-<parameter_description> a #GQueue
+<parameter name="object">
+<parameter_description> #GObject containing the associations.
</parameter_description>
</parameter>
-<parameter name="n">
-<parameter_description> the position to insert the link. If this is negative or larger than
-the number of elements in @queue, the link is added to the end of
- queue
+<parameter name="key">
+<parameter_description> name of the key
</parameter_description>
</parameter>
-<parameter name="link_">
-<parameter_description> the link to add to @queue
+<parameter name="data">
+<parameter_description> data to associate with that key
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_queue_push_tail">
+<function name="g_object_set_data_full">
<description>
-Adds a new element at the tail of the queue.
+Like g_object_set_data() except it adds notification
+for when the association is destroyed, either by setting it
+to a different value or when the object is destroyed.
+
+Note that the @destroy callback is not called if @data is %NULL.
</description>
<parameters>
-<parameter name="queue">
-<parameter_description> a #GQueue.
+<parameter name="object">
+<parameter_description> #GObject containing the associations
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> name of the key
</parameter_description>
</parameter>
<parameter name="data">
-<parameter_description> the data for the new element.
+<parameter_description> data to associate with that key
+</parameter_description>
+</parameter>
+<parameter name="destroy">
+<parameter_description> function to call when the association is destroyed
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_queue_push_tail_link">
+<function name="g_object_set_property">
<description>
-Adds a new element at the tail of the queue.
+Sets a property on an object.
</description>
<parameters>
-<parameter name="queue">
-<parameter_description> a #GQueue.
+<parameter name="object">
+<parameter_description> a #GObject
</parameter_description>
</parameter>
-<parameter name="link_">
-<parameter_description> a single #GList element, <emphasis>not</emphasis> a list with
-more than one element.
+<parameter name="property_name">
+<parameter_description> the name of the property to set
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> the value
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_queue_remove">
+<function name="g_object_set_qdata">
<description>
-Removes the first element in @queue that contains @data.
-
-Since: 2.4
+This sets an opaque, named pointer on an object.
+The name is specified through a #GQuark (retrived e.g. via
+g_quark_from_static_string()), and the pointer
+can be gotten back from the @object with g_object_get_qdata()
+until the @object is finalized.
+Setting a previously set user data pointer, overrides (frees)
+the old pointer set, using #NULL as pointer essentially
+removes the data stored.
</description>
<parameters>
-<parameter name="queue">
-<parameter_description> a #GQueue
+<parameter name="object">
+<parameter_description> The GObject to set store a user data pointer
+</parameter_description>
+</parameter>
+<parameter name="quark">
+<parameter_description> A #GQuark, naming the user data pointer
</parameter_description>
</parameter>
<parameter name="data">
-<parameter_description> data to remove.
+<parameter_description> An opaque user data pointer
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_queue_remove_all">
+<function name="g_object_set_qdata_full">
<description>
-Remove all elements whose data equals @data from @queue.
-
-Since: 2.4
+This function works like g_object_set_qdata(), but in addition,
+a void (*destroy) (gpointer) function may be specified which is
+called with @data as argument when the @object is finalized, or
+the data is being overwritten by a call to g_object_set_qdata()
+with the same @quark.
</description>
<parameters>
-<parameter name="queue">
-<parameter_description> a #GQueue
+<parameter name="object">
+<parameter_description> The GObject to set store a user data pointer
+</parameter_description>
+</parameter>
+<parameter name="quark">
+<parameter_description> A #GQuark, naming the user data pointer
</parameter_description>
</parameter>
<parameter name="data">
-<parameter_description> data to remove
+<parameter_description> An opaque user data pointer
+</parameter_description>
+</parameter>
+<parameter name="destroy">
+<parameter_description> Function to invoke with @data as argument, when @data
+needs to be freed
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_queue_reverse">
+<function name="g_object_set_valist">
<description>
-Reverses the order of the items in @queue.
-
-Since: 2.4
+Sets properties on an object.
</description>
<parameters>
-<parameter name="queue">
-<parameter_description> a #GQueue
+<parameter name="object">
+<parameter_description> a #GObject
+</parameter_description>
+</parameter>
+<parameter name="first_property_name">
+<parameter_description> name of the first property to set
+</parameter_description>
+</parameter>
+<parameter name="var_args">
+<parameter_description> value for the first property, followed optionally by more
+name/value pairs, followed by %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_queue_sort">
+<function name="g_object_steal_data">
<description>
-Sorts @queue using @compare_func.
+Remove a specified datum from the object's data associations,
+without invoking the association's destroy handler.
-Since: 2.4
</description>
<parameters>
-<parameter name="queue">
-<parameter_description> a #GQueue
-</parameter_description>
-</parameter>
-<parameter name="compare_func">
-<parameter_description> the #GCompareDataFunc used to sort @queue. This function
-is passed two elements of the queue and should return 0 if they are
-equal, a negative value if the first comes before the second, and
-a positive value if the second comes before the first.
+<parameter name="object">
+<parameter_description> #GObject containing the associations
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> user data passed to @compare_func
+<parameter name="key">
+<parameter_description> name of the key
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the data if found, or %NULL if no such data exists.
+</return>
</function>
-<function name="g_queue_unlink">
+<function name="g_object_steal_qdata">
<description>
-Unlinks @link_ so that it will no longer be part of @queue. The link is
-not freed.
+This function gets back user data pointers stored via
+g_object_set_qdata() and removes the @data from object
+without invoking its destroy() function (if any was
+set).
+Usually, calling this function is only required to update
+user data pointers with a destroy notifier, for example:
+|[
+void
+object_add_to_user_list (GObject *object,
+const gchar *new_string)
+{
+// the quark, naming the object data
+GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
+// retrive the old string list
+GList *list = g_object_steal_qdata (object, quark_string_list);
+
+// prepend new string
+list = g_list_prepend (list, g_strdup (new_string));
+// this changed 'list', so we need to set it again
+g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
+}
+static void
+free_string_list (gpointer data)
+{
+GList *node, *list = data;
- link_ must be part of @queue,
+for (node = list; node; node = node->next)
+g_free (node->data);
+g_list_free (list);
+}
+]|
+Using g_object_get_qdata() in the above example, instead of
+g_object_steal_qdata() would have left the destroy function set,
+and thus the partial string list would have been freed upon
+g_object_set_qdata_full().
-Since: 2.4
</description>
<parameters>
-<parameter name="queue">
-<parameter_description> a #GQueue
+<parameter name="object">
+<parameter_description> The GObject to get a stored user data pointer from
</parameter_description>
</parameter>
-<parameter name="link_">
-<parameter_description> a #GList link that <emphasis>must</emphasis> be part of @queue
+<parameter name="quark">
+<parameter_description> A #GQuark, naming the user data pointer
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The user data pointer set, or %NULL
+</return>
</function>
-<function name="g_rand_boolean">
+<function name="g_object_thaw_notify">
<description>
-Returns a random #gboolean from @rand_. This corresponds to a
-unbiased coin toss.
+Reverts the effect of a previous call to
+g_object_freeze_notify(). The freeze count is decreased on @object
+and when it reaches zero, all queued "notify" signals are emitted.
+
+It is an error to call this function when the freeze count is zero.
</description>
<parameters>
-<parameter name="rand_">
-<parameter_description> a #GRand.
+<parameter name="object">
+<parameter_description> a #GObject
</parameter_description>
</parameter>
</parameters>
-<return> a random #gboolean.
-</return>
+<return></return>
</function>
-<function name="g_rand_copy">
+<function name="g_object_unref">
<description>
-Copies a #GRand into a new one with the same exact state as before.
-This way you can take a snapshot of the random number generator for
-replaying later.
-
-Since: 2.4
+Decreases the reference count of @object. When its reference count
+drops to 0, the object is finalized (i.e. its memory is freed).
</description>
<parameters>
-<parameter name="rand_">
-<parameter_description> a #GRand.
+<parameter name="object">
+<parameter_description> a #GObject
</parameter_description>
</parameter>
</parameters>
-<return> the new #GRand.
-
-</return>
+<return></return>
</function>
-<function name="g_rand_double">
+<function name="g_object_watch_closure">
<description>
-Returns the next random #gdouble from @rand_ equally distributed over
-the range [0..1).
-
+This function essentially limits the life time of the @closure to
+the life time of the object. That is, when the object is finalized,
+the @closure is invalidated by calling g_closure_invalidate() on
+it, in order to prevent invocations of the closure with a finalized
+(nonexisting) object. Also, g_object_ref() and g_object_unref() are
+added as marshal guards to the @closure, to ensure that an extra
+reference count is held on @object during invocation of the
+ closure Usually, this function will be called on closures that
+use this @object as closure data.
</description>
<parameters>
-<parameter name="rand_">
-<parameter_description> a #GRand.
+<parameter name="object">
+<parameter_description> GObject restricting lifetime of @closure
+</parameter_description>
+</parameter>
+<parameter name="closure">
+<parameter_description> GClosure to watch
</parameter_description>
</parameter>
</parameters>
-<return> A random number.
-</return>
+<return></return>
</function>
-<function name="g_rand_double_range">
+<function name="g_object_weak_ref">
<description>
-Returns the next random #gdouble from @rand_ equally distributed over
-the range [ begin @end).
-
+Adds a weak reference callback to an object. Weak references are
+used for notification when an object is finalized. They are called
+"weak references" because they allow you to safely hold a pointer
+to an object without calling g_object_ref() (g_object_ref() adds a
+strong reference, that is, forces the object to stay alive).
</description>
<parameters>
-<parameter name="rand_">
-<parameter_description> a #GRand.
+<parameter name="object">
+<parameter_description> #GObject to reference weakly
</parameter_description>
</parameter>
-<parameter name="begin">
-<parameter_description> lower closed bound of the interval.
+<parameter name="notify">
+<parameter_description> callback to invoke before the object is freed
</parameter_description>
</parameter>
-<parameter name="end">
-<parameter_description> upper open bound of the interval.
+<parameter name="data">
+<parameter_description> extra data to pass to notify
</parameter_description>
</parameter>
</parameters>
-<return> A random number.
-</return>
+<return></return>
</function>
-<function name="g_rand_free">
+<function name="g_object_weak_unref">
<description>
-Frees the memory allocated for the #GRand.
+Removes a weak reference callback to an object.
</description>
<parameters>
-<parameter name="rand_">
-<parameter_description> a #GRand.
+<parameter name="object">
+<parameter_description> #GObject to remove a weak reference from
+</parameter_description>
+</parameter>
+<parameter name="notify">
+<parameter_description> callback to search for
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> data to search for
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_rand_int">
+<function name="g_once">
<description>
-Returns the next random #guint32 from @rand_ equally distributed over
-the range [0..2^32-1].
+The first call to this routine by a process with a given #GOnce
+struct calls @func with the given argument. Thereafter, subsequent
+calls to g_once() with the same #GOnce struct do not call @func
+again, but return the stored result of the first call. On return
+from g_once(), the status of @once will be %G_ONCE_STATUS_READY.
+
+For example, a mutex or a thread-specific data key must be created
+exactly once. In a threaded environment, calling g_once() ensures
+that the initialization is serialized across multiple threads.
+<note><para>Calling g_once() recursively on the same #GOnce struct in
+ func will lead to a deadlock.</para></note>
-</description>
-<parameters>
-<parameter name="rand_">
-<parameter_description> a #GRand.
-</parameter_description>
-</parameter>
-</parameters>
-<return> A random number.
-</return>
-</function>
+<informalexample>
+<programlisting>
+gpointer
+get_debug_flags (void)
+{
+static GOnce my_once = G_ONCE_INIT;
-<function name="g_rand_int_range">
-<description>
-Returns the next random #gint32 from @rand_ equally distributed over
-the range [ begin @end-1].
+g_once (&my_once, parse_debug_flags, NULL);
+
+return my_once.retval;
+}
+</programlisting>
+</informalexample>
+Since: 2.4
</description>
<parameters>
-<parameter name="rand_">
-<parameter_description> a #GRand.
+<parameter name="once">
+<parameter_description> a #GOnce structure
</parameter_description>
</parameter>
-<parameter name="begin">
-<parameter_description> lower closed bound of the interval.
+<parameter name="func">
+<parameter_description> the #GThreadFunc function associated to @once. This function
+is called only once, regardless of the number of times it and
+its associated #GOnce struct are passed to g_once().
</parameter_description>
</parameter>
-<parameter name="end">
-<parameter_description> upper open bound of the interval.
+<parameter name="arg">
+<parameter_description> data to be passed to @func
</parameter_description>
</parameter>
</parameters>
-<return> A random number.
-</return>
+<return></return>
</function>
-<function name="g_rand_new">
+<function name="g_once_init_enter">
<description>
-Creates a new random number generator initialized with a seed taken
-either from <filename>/dev/urandom</filename> (if existing) or from
-the current time (as a fallback).
+Function to be called when starting a critical initialization
+section. The argument @value_location must point to a static
+0-initialized variable that will be set to a value other than 0 at
+the end of the initialization section. In combination with
+g_once_init_leave() and the unique address @value_location, it can
+be ensured that an initialization section will be executed only once
+during a program's life time, and that concurrent threads are
+blocked until initialization completed. To be used in constructs
+like this:
+
+<informalexample>
+<programlisting>
+static gsize initialization_value = 0;
+
+if (g_once_init_enter (&initialization_value))
+{
+gsize setup_value = 42; /<!-- -->* initialization code here *<!-- -->/
+
+g_once_init_leave (&initialization_value, setup_value);
+}
+
+/<!-- -->* use initialization_value here *<!-- -->/
+</programlisting>
+</informalexample>
+Since: 2.14
</description>
<parameters>
+<parameter name="value_location">
+<parameter_description> location of a static initializable variable
+containing 0.
+</parameter_description>
+</parameter>
</parameters>
-<return> the new #GRand.
+<return> %TRUE if the initialization section should be entered,
+%FALSE and blocks otherwise
</return>
</function>
-<function name="g_rand_new_with_seed">
+<function name="g_once_init_leave">
<description>
-Creates a new random number generator initialized with @seed.
+Counterpart to g_once_init_enter(). Expects a location of a static
+0-initialized initialization variable, and an initialization value
+other than 0. Sets the variable to the initialization value, and
+releases concurrent threads blocking in g_once_init_enter() on this
+initialization variable.
+Since: 2.14
</description>
<parameters>
-<parameter name="seed">
-<parameter_description> a value to initialize the random number generator.
+<parameter name="value_location">
+<parameter_description> location of a static initializable variable
+containing 0.
+</parameter_description>
+</parameter>
+<parameter name="initialization_value">
+<parameter_description> new non-0 value for * value_location
</parameter_description>
</parameter>
</parameters>
-<return> the new #GRand.
-</return>
+<return></return>
</function>
-<function name="g_rand_new_with_seed_array">
+<function name="g_open">
<description>
-Creates a new random number generator initialized with @seed.
+A wrapper for the POSIX open() function. The open() function is
+used to convert a pathname into a file descriptor.
-Since: 2.4
+On POSIX systems file descriptors are implemented by the operating
+system. On Windows, it's the C library that implements open() and
+file descriptors. The actual Win32 API for opening files is quite
+different, see MSDN documentation for CreateFile(). The Win32 API
+uses file handles, which are more randomish integers, not small
+integers like file descriptors.
+
+Because file descriptors are specific to the C library on Windows,
+the file descriptor returned by this function makes sense only to
+functions in the same C library. Thus if the GLib-using code uses a
+different C library than GLib does, the file descriptor returned by
+this function cannot be passed to C library functions like write()
+or read().
+
+See your C library manual for more details about open().
+
+Since: 2.6
</description>
<parameters>
-<parameter name="seed">
-<parameter_description> an array of seeds to initialize the random number generator.
+<parameter name="filename">
+<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows)
</parameter_description>
</parameter>
-<parameter name="seed_length">
-<parameter_description> an array of seeds to initialize the random number generator.
+<parameter name="flags">
+<parameter_description> as in open()
+</parameter_description>
+</parameter>
+<parameter name="mode">
+<parameter_description> as in open()
</parameter_description>
</parameter>
</parameters>
-<return> the new #GRand.
+<return> a new file descriptor, or -1 if an error occurred. The
+return value can be used exactly like the return value from open().
</return>
</function>
-<function name="g_rand_set_seed">
+<function name="g_option_context_add_group">
<description>
-Sets the seed for the random number generator #GRand to @seed.
+Adds a #GOptionGroup to the @context, so that parsing with @context
+will recognize the options in the group. Note that the group will
+be freed together with the context when g_option_context_free() is
+called, so you must not free the group yourself after adding it
+to a context.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="rand_">
-<parameter_description> a #GRand.
+<parameter name="context">
+<parameter_description> a #GOptionContext
</parameter_description>
</parameter>
-<parameter name="seed">
-<parameter_description> a value to reinitialize the random number generator.
+<parameter name="group">
+<parameter_description> the group to add
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_rand_set_seed_array">
+<function name="g_option_context_add_main_entries">
<description>
-Initializes the random number generator by an array of
-longs. Array can be of arbitrary size, though only the
-first 624 values are taken. This function is useful
-if you have many low entropy seeds, or if you require more then
-32bits of actual entropy for your application.
+A convenience function which creates a main group if it doesn't
+exist, adds the @entries to it and sets the translation domain.
-Since: 2.4
+Since: 2.6
</description>
<parameters>
-<parameter name="rand_">
-<parameter_description> a #GRand.
+<parameter name="context">
+<parameter_description> a #GOptionContext
</parameter_description>
</parameter>
-<parameter name="seed">
-<parameter_description> array to initialize with
+<parameter name="entries">
+<parameter_description> a %NULL-terminated array of #GOptionEntry<!-- -->s
</parameter_description>
</parameter>
-<parameter name="seed_length">
-<parameter_description> length of array
+<parameter name="translation_domain">
+<parameter_description> a translation domain to use for translating
+the <option>--help</option> output for the options in @entries
+with gettext(), or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_random_boolean">
+<function name="g_option_context_free">
<description>
-Returns a random #gboolean. This corresponds to a unbiased coin toss.
+Frees context and all the groups which have been
+added to it.
+
+Please note that parsed arguments need to be freed separately (see
+#GOptionEntry).
+
+Since: 2.6
</description>
<parameters>
+<parameter name="context">
+<parameter_description> a #GOptionContext
+</parameter_description>
+</parameter>
</parameters>
-<return> a random #gboolean.
-</return>
+<return></return>
</function>
-<function name="g_random_double">
+<function name="g_option_context_get_description">
<description>
-Returns a random #gdouble equally distributed over the range [0..1).
+Returns the description. See g_option_context_set_description().
+Since: 2.12
</description>
<parameters>
+<parameter name="context">
+<parameter_description> a #GOptionContext
+</parameter_description>
+</parameter>
</parameters>
-<return> A random number.
+<return> the description
+
</return>
</function>
-<function name="g_random_double_range">
+<function name="g_option_context_get_help">
<description>
-Returns a random #gdouble equally distributed over the range [ begin @end).
-
-
-</description>
-<parameters>
-<parameter name="begin">
-<parameter_description> lower closed bound of the interval.
+Returns a formatted, translated help text for the given context.
+To obtain the text produced by <option>--help</option>, call
+<literal>g_option_context_get_help (context, TRUE, NULL)</literal>.
+To obtain the text produced by <option>--help-all</option>, call
+<literal>g_option_context_get_help (context, FALSE, NULL)</literal>.
+To obtain the help text for an option group, call
+<literal>g_option_context_get_help (context, FALSE, group)</literal>.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="context">
+<parameter_description> a #GOptionContext
</parameter_description>
</parameter>
-<parameter name="end">
-<parameter_description> upper open bound of the interval.
+<parameter name="main_help">
+<parameter_description> if %TRUE, only include the main group
+</parameter_description>
+</parameter>
+<parameter name="group">
+<parameter_description> the #GOptionGroup to create help for, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> A random number.
+<return> A newly allocated string containing the help text
+
</return>
</function>
-<function name="g_random_int">
+<function name="g_option_context_get_help_enabled">
<description>
-Return a random #guint32 equally distributed over the range
-[0..2^32-1].
+Returns whether automatic <option>--help</option> generation
+is turned on for @context. See g_option_context_set_help_enabled().
+Since: 2.6
</description>
<parameters>
+<parameter name="context">
+<parameter_description> a #GOptionContext
+</parameter_description>
+</parameter>
</parameters>
-<return> A random number.
+<return> %TRUE if automatic help generation is turned on.
+
</return>
</function>
-<function name="g_random_int_range">
+<function name="g_option_context_get_ignore_unknown_options">
<description>
-Returns a random #gint32 equally distributed over the range
-[ begin @end-1].
+Returns whether unknown options are ignored or not. See
+g_option_context_set_ignore_unknown_options().
+Since: 2.6
</description>
<parameters>
-<parameter name="begin">
-<parameter_description> lower closed bound of the interval.
-</parameter_description>
-</parameter>
-<parameter name="end">
-<parameter_description> upper open bound of the interval.
+<parameter name="context">
+<parameter_description> a #GOptionContext
</parameter_description>
</parameter>
</parameters>
-<return> A random number.
+<return> %TRUE if unknown options are ignored.
+
</return>
</function>
-<function name="g_random_set_seed">
+<function name="g_option_context_get_main_group">
<description>
-Sets the seed for the global random number generator, which is used
-by the <function>g_random_*</function> functions, to @seed.
+Returns a pointer to the main group of @context.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="seed">
-<parameter_description> a value to reinitialize the global random number generator.
+<parameter name="context">
+<parameter_description> a #GOptionContext
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the main group of @context, or %NULL if @context doesn't
+have a main group. Note that group belongs to @context and should
+not be modified or freed.
+
+</return>
</function>
-<function name="g_realloc">
+<function name="g_option_context_get_summary">
<description>
-Reallocates the memory pointed to by @mem, so that it now has space for
- n_bytes bytes of memory. It returns the new address of the memory, which may
-have been moved. @mem may be %NULL, in which case it's considered to
-have zero-length. @n_bytes may be 0, in which case %NULL will be returned
-and @mem will be freed unless it is %NULL.
+Returns the summary. See g_option_context_set_summary().
+Since: 2.12
</description>
<parameters>
-<parameter name="mem">
-<parameter_description> the memory to reallocate
-</parameter_description>
-</parameter>
-<parameter name="n_bytes">
-<parameter_description> new size of the memory in bytes
+<parameter name="context">
+<parameter_description> a #GOptionContext
</parameter_description>
</parameter>
</parameters>
-<return> the new address of the allocated memory
+<return> the summary
+
</return>
</function>
-<function name="g_realloc_n">
+<function name="g_option_context_new">
<description>
-This function is similar to g_realloc(), allocating (@n_blocks * @n_block_bytes) bytes,
-but care is taken to detect possible overflow during multiplication.
+Creates a new option context.
-Since: 2.24
+The @parameter_string can serve multiple purposes. It can be used
+to add descriptions for "rest" arguments, which are not parsed by
+the #GOptionContext, typically something like "FILES" or
+"FILE1 FILE2...". If you are using #G_OPTION_REMAINING for
+collecting "rest" arguments, GLib handles this automatically by
+using the @arg_description of the corresponding #GOptionEntry in
+the usage summary.
+
+Another usage is to give a short summary of the program
+functionality, like " - frob the strings", which will be displayed
+in the same line as the usage. For a longer description of the
+program functionality that should be displayed as a paragraph
+below the usage line, use g_option_context_set_summary().
+
+Note that the @parameter_string is translated using the
+function set with g_option_context_set_translate_func(), so
+it should normally be passed untranslated.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="mem">
-<parameter_description> the memory to reallocate
-</parameter_description>
-</parameter>
-<parameter name="n_blocks">
-<parameter_description> the number of blocks to allocate
-</parameter_description>
-</parameter>
-<parameter name="n_block_bytes">
-<parameter_description> the size of each block in bytes
+<parameter name="parameter_string">
+<parameter_description> a string which is displayed in
+the first line of <option>--help</option> output, after the
+usage summary
+<literal><replaceable>programname</replaceable> [OPTION...]</literal>
</parameter_description>
</parameter>
</parameters>
-<return> the new address of the allocated memory
+<return> a newly created #GOptionContext, which must be
+freed with g_option_context_free() after use.
+
</return>
</function>
-<function name="g_regex_check_replacement">
+<function name="g_option_context_parse">
<description>
-Checks whether @replacement is a valid replacement string
-(see g_regex_replace()), i.e. that all escape sequences in
-it are valid.
+Parses the command line arguments, recognizing options
+which have been added to @context. A side-effect of
+calling this function is that g_set_prgname() will be
+called.
-If @has_references is not %NULL then @replacement is checked
-for pattern references. For instance, replacement text 'foo\n'
-does not contain references and may be evaluated without information
-about actual match, but '\0\1' (whole match followed by first
-subpattern) requires valid #GMatchInfo object.
+If the parsing is successful, any parsed arguments are
+removed from the array and @argc and @argv are updated
+accordingly. A '--' option is stripped from @argv
+unless there are unparsed options before and after it,
+or some of the options after it start with '-'. In case
+of an error, @argc and @argv are left unmodified.
-Since: 2.14
+If automatic <option>--help</option> support is enabled
+(see g_option_context_set_help_enabled()), and the
+ argv array contains one of the recognized help options,
+this function will produce help output to stdout and
+call <literal>exit (0)</literal>.
+
+Note that function depends on the
+<link linkend="setlocale">current locale</link> for
+automatic character set conversion of string and filename
+arguments.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="replacement">
-<parameter_description> the replacement string
+<parameter name="context">
+<parameter_description> a #GOptionContext
</parameter_description>
</parameter>
-<parameter name="has_references">
-<parameter_description> location to store information about
-references in @replacement or %NULL
+<parameter name="argc">
+<parameter_description> a pointer to the number of command line arguments
+</parameter_description>
+</parameter>
+<parameter name="argv">
+<parameter_description> a pointer to the array of command line arguments
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> location to store error
+<parameter_description> a return location for errors
</parameter_description>
</parameter>
</parameters>
-<return> whether @replacement is a valid replacement string
+<return> %TRUE if the parsing was successful,
+%FALSE if an error occurred
</return>
</function>
-<function name="g_regex_escape_string">
+<function name="g_option_context_set_description">
<description>
-Escapes the special characters used for regular expressions
-in @string, for instance "a.b*c" becomes "a\.b\*c". This
-function is useful to dynamically generate regular expressions.
+Adds a string to be displayed in <option>--help</option> output
+after the list of options. This text often includes a bug reporting
+address.
- string can contain nul characters that are replaced with "\0",
-in this case remember to specify the correct length of @string
-in @length.
+Note that the summary is translated (see
+g_option_context_set_translate_func()).
-Since: 2.14
+Since: 2.12
</description>
<parameters>
-<parameter name="string">
-<parameter_description> the string to escape
+<parameter name="context">
+<parameter_description> a #GOptionContext
</parameter_description>
</parameter>
-<parameter name="length">
-<parameter_description> the length of @string, or -1 if @string is nul-terminated
+<parameter name="description">
+<parameter_description> a string to be shown in <option>--help</option> output
+after the list of options, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a newly-allocated escaped string
-
-</return>
+<return></return>
</function>
-<function name="g_regex_get_capture_count">
+<function name="g_option_context_set_help_enabled">
<description>
-Returns the number of capturing subpatterns in the pattern.
+Enables or disables automatic generation of <option>--help</option>
+output. By default, g_option_context_parse() recognizes
+<option>--help</option>, <option>-h</option>,
+<option>-?</option>, <option>--help-all</option>
+and <option>--help-</option><replaceable>groupname</replaceable> and creates
+suitable output to stdout.
-Since: 2.14
+Since: 2.6
</description>
<parameters>
-<parameter name="regex">
-<parameter_description> a #GRegex
+<parameter name="context">
+<parameter_description> a #GOptionContext
+</parameter_description>
+</parameter>
+<parameter name="help_enabled">
+<parameter_description> %TRUE to enable <option>--help</option>, %FALSE to disable it
</parameter_description>
</parameter>
</parameters>
-<return> the number of capturing subpatterns
-
-</return>
+<return></return>
</function>
-<function name="g_regex_get_compile_flags">
+<function name="g_option_context_set_ignore_unknown_options">
<description>
-Returns the compile options that @regex was created with.
+Sets whether to ignore unknown options or not. If an argument is
+ignored, it is left in the @argv array after parsing. By default,
+g_option_context_parse() treats unknown options as error.
-Since: 2.26
+This setting does not affect non-option arguments (i.e. arguments
+which don't start with a dash). But note that GOption cannot reliably
+determine whether a non-option belongs to a preceding unknown option.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="regex">
-<parameter_description> a #GRegex
+<parameter name="context">
+<parameter_description> a #GOptionContext
+</parameter_description>
+</parameter>
+<parameter name="ignore_unknown">
+<parameter_description> %TRUE to ignore unknown options, %FALSE to produce
+an error when unknown options are met
</parameter_description>
</parameter>
</parameters>
-<return> flags from #GRegexCompileFlags
-
-</return>
+<return></return>
</function>
-<function name="g_regex_get_match_flags">
+<function name="g_option_context_set_main_group">
<description>
-Returns the match options that @regex was created with.
+Sets a #GOptionGroup as main group of the @context.
+This has the same effect as calling g_option_context_add_group(),
+the only difference is that the options in the main group are
+treated differently when generating <option>--help</option> output.
-Since: 2.26
+Since: 2.6
</description>
<parameters>
-<parameter name="regex">
-<parameter_description> a #GRegex
+<parameter name="context">
+<parameter_description> a #GOptionContext
+</parameter_description>
+</parameter>
+<parameter name="group">
+<parameter_description> the group to set as main group
</parameter_description>
</parameter>
</parameters>
-<return> flags from #GRegexMatchFlags
-
-</return>
+<return></return>
</function>
-<function name="g_regex_get_max_backref">
+<function name="g_option_context_set_summary">
<description>
-Returns the number of the highest back reference
-in the pattern, or 0 if the pattern does not contain
-back references.
+Adds a string to be displayed in <option>--help</option> output
+before the list of options. This is typically a summary of the
+program functionality.
-Since: 2.14
+Note that the summary is translated (see
+g_option_context_set_translate_func() and
+g_option_context_set_translation_domain()).
+
+Since: 2.12
</description>
<parameters>
-<parameter name="regex">
-<parameter_description> a #GRegex
+<parameter name="context">
+<parameter_description> a #GOptionContext
+</parameter_description>
+</parameter>
+<parameter name="summary">
+<parameter_description> a string to be shown in <option>--help</option> output
+before the list of options, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the number of the highest back reference
-
-</return>
+<return></return>
</function>
-<function name="g_regex_get_pattern">
+<function name="g_option_context_set_translate_func">
<description>
-Gets the pattern string associated with @regex, i.e. a copy of
-the string passed to g_regex_new().
+Sets the function which is used to translate the contexts
+user-visible strings, for <option>--help</option> output.
+If @func is %NULL, strings are not translated.
-Since: 2.14
+Note that option groups have their own translation functions,
+this function only affects the @parameter_string (see g_option_context_new()),
+the summary (see g_option_context_set_summary()) and the description
+(see g_option_context_set_description()).
+
+If you are using gettext(), you only need to set the translation
+domain, see g_option_context_set_translation_domain().
+
+Since: 2.12
</description>
<parameters>
-<parameter name="regex">
-<parameter_description> a #GRegex structure
+<parameter name="context">
+<parameter_description> a #GOptionContext
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> the #GTranslateFunc, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> user data to pass to @func, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="destroy_notify">
+<parameter_description> a function which gets called to free @data, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the pattern of @regex
-
-</return>
+<return></return>
</function>
-<function name="g_regex_get_string_number">
+<function name="g_option_context_set_translation_domain">
<description>
-Retrieves the number of the subexpression named @name.
+A convenience function to use gettext() for translating
+user-visible strings.
-Since: 2.14
+Since: 2.12
</description>
<parameters>
-<parameter name="regex">
-<parameter_description> #GRegex structure
+<parameter name="context">
+<parameter_description> a #GOptionContext
</parameter_description>
</parameter>
-<parameter name="name">
-<parameter_description> name of the subexpression
+<parameter name="domain">
+<parameter_description> the domain to use
</parameter_description>
</parameter>
</parameters>
-<return> The number of the subexpression or -1 if @name
-does not exists
-
-</return>
+<return></return>
</function>
-<function name="g_regex_match">
+<function name="g_option_group_add_entries">
<description>
-Scans for a match in string for the pattern in @regex.
-The @match_options are combined with the match options specified
-when the @regex structure was created, letting you have more
-flexibility in reusing #GRegex structures.
-
-A #GMatchInfo structure, used to get information on the match,
-is stored in @match_info if not %NULL. Note that if @match_info
-is not %NULL then it is created even if the function returns %FALSE,
-i.e. you must free it regardless if regular expression actually matched.
-
-To retrieve all the non-overlapping matches of the pattern in
-string you can use g_match_info_next().
-
-|[
-static void
-print_uppercase_words (const gchar *string)
-{
-/ * Print all uppercase-only words. * /
-GRegex *regex;
-GMatchInfo *match_info;
- 
-regex = g_regex_new ("[A-Z]+", 0, 0, NULL);
-g_regex_match (regex, string, 0, &match_info);
-while (g_match_info_matches (match_info))
-{
-gchar *word = g_match_info_fetch (match_info, 0);
-g_print ("Found: %s\n", word);
-g_free (word);
-g_match_info_next (match_info, NULL);
-}
-g_match_info_free (match_info);
-g_regex_unref (regex);
-}
-]|
-
- string is not copied and is used in #GMatchInfo internally. If
-you use any #GMatchInfo method (except g_match_info_free()) after
-freeing or modifying @string then the behaviour is undefined.
+Adds the options specified in @entries to @group.
-Since: 2.14
+Since: 2.6
</description>
<parameters>
-<parameter name="regex">
-<parameter_description> a #GRegex structure from g_regex_new()
-</parameter_description>
-</parameter>
-<parameter name="string">
-<parameter_description> the string to scan for matches
-</parameter_description>
-</parameter>
-<parameter name="match_options">
-<parameter_description> match options
+<parameter name="group">
+<parameter_description> a #GOptionGroup
</parameter_description>
</parameter>
-<parameter name="match_info">
-<parameter_description> pointer to location where to store
-the #GMatchInfo, or %NULL if you do not need it
+<parameter name="entries">
+<parameter_description> a %NULL-terminated array of #GOptionEntry<!-- -->s
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE is the string matched, %FALSE otherwise
-
-</return>
+<return></return>
</function>
-<function name="g_regex_match_all">
+<function name="g_option_group_free">
<description>
-Using the standard algorithm for regular expression matching only
-the longest match in the string is retrieved. This function uses
-a different algorithm so it can retrieve all the possible matches.
-For more documentation see g_regex_match_all_full().
+Frees a #GOptionGroup. Note that you must <emphasis>not</emphasis>
+free groups which have been added to a #GOptionContext.
-A #GMatchInfo structure, used to get information on the match, is
-stored in @match_info if not %NULL. Note that if @match_info is
-not %NULL then it is created even if the function returns %FALSE,
-i.e. you must free it regardless if regular expression actually
-matched.
+Since: 2.6
- string is not copied and is used in #GMatchInfo internally. If
-you use any #GMatchInfo method (except g_match_info_free()) after
-freeing or modifying @string then the behaviour is undefined.
+</description>
+<parameters>
+<parameter name="group">
+<parameter_description> a #GOptionGroup
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
-Since: 2.14
+<function name="g_option_group_new">
+<description>
+Creates a new #GOptionGroup.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="regex">
-<parameter_description> a #GRegex structure from g_regex_new()
+<parameter name="name">
+<parameter_description> the name for the option group, this is used to provide
+help for the options in this group with <option>--help-</option>@name
</parameter_description>
</parameter>
-<parameter name="string">
-<parameter_description> the string to scan for matches
+<parameter name="description">
+<parameter_description> a description for this group to be shown in
+<option>--help</option>. This string is translated using the translation
+domain or translation function of the group
</parameter_description>
</parameter>
-<parameter name="match_options">
-<parameter_description> match options
+<parameter name="help_description">
+<parameter_description> a description for the <option>--help-</option>@name option.
+This string is translated using the translation domain or translation function
+of the group
</parameter_description>
</parameter>
-<parameter name="match_info">
-<parameter_description> pointer to location where to store
-the #GMatchInfo, or %NULL if you do not need it
+<parameter name="user_data">
+<parameter_description> user data that will be passed to the pre- and post-parse hooks,
+the error hook and to callbacks of %G_OPTION_ARG_CALLBACK options, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="destroy">
+<parameter_description> a function that will be called to free @user_data, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE is the string matched, %FALSE otherwise
+<return> a newly created option group. It should be added
+to a #GOptionContext or freed with g_option_group_free().
</return>
</function>
-<function name="g_regex_match_all_full">
+<function name="g_option_group_set_error_hook">
<description>
-Using the standard algorithm for regular expression matching only
-the longest match in the string is retrieved, it is not possibile
-to obtain all the available matches. For instance matching
-"<a> <b> <c>" against the pattern "<.*>"
-you get "<a> <b> <c>".
+Associates a function with @group which will be called
+from g_option_context_parse() when an error occurs.
-This function uses a different algorithm (called DFA, i.e. deterministic
-finite automaton), so it can retrieve all the possible matches, all
-starting at the same point in the string. For instance matching
-"<a> <b> <c>" against the pattern "<.*>"
-you would obtain three matches: "<a> <b> <c>",
-"<a> <b>" and "<a>".
-
-The number of matched strings is retrieved using
-g_match_info_get_match_count(). To obtain the matched strings and
-their position you can use, respectively, g_match_info_fetch() and
-g_match_info_fetch_pos(). Note that the strings are returned in
-reverse order of length; that is, the longest matching string is
-given first.
+Note that the user data to be passed to @error_func can be
+specified when constructing the group with g_option_group_new().
-Note that the DFA algorithm is slower than the standard one and it
-is not able to capture substrings, so backreferences do not work.
+Since: 2.6
-Setting @start_position differs from just passing over a shortened
-string and setting #G_REGEX_MATCH_NOTBOL in the case of a pattern
-that begins with any kind of lookbehind assertion, such as "\b".
+</description>
+<parameters>
+<parameter name="group">
+<parameter_description> a #GOptionGroup
+</parameter_description>
+</parameter>
+<parameter name="error_func">
+<parameter_description> a function to call when an error occurs
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
-A #GMatchInfo structure, used to get information on the match, is
-stored in @match_info if not %NULL. Note that if @match_info is
-not %NULL then it is created even if the function returns %FALSE,
-i.e. you must free it regardless if regular expression actually
-matched.
+<function name="g_option_group_set_parse_hooks">
+<description>
+Associates two functions with @group which will be called
+from g_option_context_parse() before the first option is parsed
+and after the last option has been parsed, respectively.
- string is not copied and is used in #GMatchInfo internally. If
-you use any #GMatchInfo method (except g_match_info_free()) after
-freeing or modifying @string then the behaviour is undefined.
+Note that the user data to be passed to @pre_parse_func and
+ post_parse_func can be specified when constructing the group
+with g_option_group_new().
-Since: 2.14
+Since: 2.6
</description>
<parameters>
-<parameter name="regex">
-<parameter_description> a #GRegex structure from g_regex_new()
+<parameter name="group">
+<parameter_description> a #GOptionGroup
</parameter_description>
</parameter>
-<parameter name="string">
-<parameter_description> the string to scan for matches
+<parameter name="pre_parse_func">
+<parameter_description> a function to call before parsing, or %NULL
</parameter_description>
</parameter>
-<parameter name="string_len">
-<parameter_description> the length of @string, or -1 if @string is nul-terminated
+<parameter name="post_parse_func">
+<parameter_description> a function to call after parsing, or %NULL
</parameter_description>
</parameter>
-<parameter name="start_position">
-<parameter_description> starting index of the string to match
+</parameters>
+<return></return>
+</function>
+
+<function name="g_option_group_set_translate_func">
+<description>
+Sets the function which is used to translate user-visible
+strings, for <option>--help</option> output. Different
+groups can use different #GTranslateFunc<!-- -->s. If @func
+is %NULL, strings are not translated.
+
+If you are using gettext(), you only need to set the translation
+domain, see g_option_group_set_translation_domain().
+
+Since: 2.6
+
+</description>
+<parameters>
+<parameter name="group">
+<parameter_description> a #GOptionGroup
</parameter_description>
</parameter>
-<parameter name="match_options">
-<parameter_description> match options
+<parameter name="func">
+<parameter_description> the #GTranslateFunc, or %NULL
</parameter_description>
</parameter>
-<parameter name="match_info">
-<parameter_description> pointer to location where to store
-the #GMatchInfo, or %NULL if you do not need it
+<parameter name="data">
+<parameter_description> user data to pass to @func, or %NULL
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> location to store the error occuring, or %NULL to ignore errors
+<parameter name="destroy_notify">
+<parameter_description> a function which gets called to free @data, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE is the string matched, %FALSE otherwise
+<return></return>
+</function>
-</return>
+<function name="g_option_group_set_translation_domain">
+<description>
+A convenience function to use gettext() for translating
+user-visible strings.
+
+Since: 2.6
+
+</description>
+<parameters>
+<parameter name="group">
+<parameter_description> a #GOptionGroup
+</parameter_description>
+</parameter>
+<parameter name="domain">
+<parameter_description> the domain to use
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="g_regex_match_full">
+<function name="g_param_spec_boolean">
<description>
-Scans for a match in string for the pattern in @regex.
-The @match_options are combined with the match options specified
-when the @regex structure was created, letting you have more
-flexibility in reusing #GRegex structures.
+Creates a new #GParamSpecBoolean instance specifying a %G_TYPE_BOOLEAN
+property.
-Setting @start_position differs from just passing over a shortened
-string and setting #G_REGEX_MATCH_NOTBOL in the case of a pattern
-that begins with any kind of lookbehind assertion, such as "\b".
+See g_param_spec_internal() for details on property names.
-A #GMatchInfo structure, used to get information on the match, is
-stored in @match_info if not %NULL. Note that if @match_info is
-not %NULL then it is created even if the function returns %FALSE,
-i.e. you must free it regardless if regular expression actually
-matched.
- string is not copied and is used in #GMatchInfo internally. If
-you use any #GMatchInfo method (except g_match_info_free()) after
-freeing or modifying @string then the behaviour is undefined.
+</description>
+<parameters>
+<parameter name="name">
+<parameter_description> canonical name of the property specified
+</parameter_description>
+</parameter>
+<parameter name="nick">
+<parameter_description> nick name for the property specified
+</parameter_description>
+</parameter>
+<parameter name="blurb">
+<parameter_description> description of the property specified
+</parameter_description>
+</parameter>
+<parameter name="default_value">
+<parameter_description> default value for the property specified
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> flags for the property specified
+</parameter_description>
+</parameter>
+</parameters>
+<return> a newly created parameter specification
+</return>
+</function>
-To retrieve all the non-overlapping matches of the pattern in
-string you can use g_match_info_next().
+<function name="g_param_spec_boxed">
+<description>
+Creates a new #GParamSpecBoxed instance specifying a %G_TYPE_BOXED
+derived property.
-|[
-static void
-print_uppercase_words (const gchar *string)
-{
-/ * Print all uppercase-only words. * /
-GRegex *regex;
-GMatchInfo *match_info;
-GError *error = NULL;
- 
-regex = g_regex_new ("[A-Z]+", 0, 0, NULL);
-g_regex_match_full (regex, string, -1, 0, 0, &match_info, &error);
-while (g_match_info_matches (match_info))
-{
-gchar *word = g_match_info_fetch (match_info, 0);
-g_print ("Found: %s\n", word);
-g_free (word);
-g_match_info_next (match_info, &error);
-}
-g_match_info_free (match_info);
-g_regex_unref (regex);
-if (error != NULL)
-{
-g_printerr ("Error while matching: %s\n", error->message);
-g_error_free (error);
-}
-}
-]|
+See g_param_spec_internal() for details on property names.
-Since: 2.14
</description>
<parameters>
-<parameter name="regex">
-<parameter_description> a #GRegex structure from g_regex_new()
+<parameter name="name">
+<parameter_description> canonical name of the property specified
</parameter_description>
</parameter>
-<parameter name="string">
-<parameter_description> the string to scan for matches
+<parameter name="nick">
+<parameter_description> nick name for the property specified
</parameter_description>
</parameter>
-<parameter name="string_len">
-<parameter_description> the length of @string, or -1 if @string is nul-terminated
+<parameter name="blurb">
+<parameter_description> description of the property specified
</parameter_description>
</parameter>
-<parameter name="start_position">
-<parameter_description> starting index of the string to match
+<parameter name="boxed_type">
+<parameter_description> %G_TYPE_BOXED derived type of this property
</parameter_description>
</parameter>
-<parameter name="match_options">
-<parameter_description> match options
+<parameter name="flags">
+<parameter_description> flags for the property specified
</parameter_description>
</parameter>
-<parameter name="match_info">
-<parameter_description> pointer to location where to store
-the #GMatchInfo, or %NULL if you do not need it
+</parameters>
+<return> a newly created parameter specification
+</return>
+</function>
+
+<function name="g_param_spec_char">
+<description>
+Creates a new #GParamSpecChar instance specifying a %G_TYPE_CHAR property.
+
+
+</description>
+<parameters>
+<parameter name="name">
+<parameter_description> canonical name of the property specified
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> location to store the error occuring, or %NULL to ignore errors
+<parameter name="nick">
+<parameter_description> nick name for the property specified
+</parameter_description>
+</parameter>
+<parameter name="blurb">
+<parameter_description> description of the property specified
+</parameter_description>
+</parameter>
+<parameter name="minimum">
+<parameter_description> minimum value for the property specified
+</parameter_description>
+</parameter>
+<parameter name="maximum">
+<parameter_description> maximum value for the property specified
+</parameter_description>
+</parameter>
+<parameter name="default_value">
+<parameter_description> default value for the property specified
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> flags for the property specified
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE is the string matched, %FALSE otherwise
-
+<return> a newly created parameter specification
</return>
</function>
-<function name="g_regex_match_simple">
+<function name="g_param_spec_double">
<description>
-Scans for a match in @string for @pattern.
+Creates a new #GParamSpecDouble instance specifying a %G_TYPE_DOUBLE
+property.
-This function is equivalent to g_regex_match() but it does not
-require to compile the pattern with g_regex_new(), avoiding some
-lines of code when you need just to do a match without extracting
-substrings, capture counts, and so on.
+See g_param_spec_internal() for details on property names.
-If this function is to be called on the same @pattern more than
-once, it's more efficient to compile the pattern once with
-g_regex_new() and then use g_regex_match().
-Since: 2.14
+</description>
+<parameters>
+<parameter name="name">
+<parameter_description> canonical name of the property specified
+</parameter_description>
+</parameter>
+<parameter name="nick">
+<parameter_description> nick name for the property specified
+</parameter_description>
+</parameter>
+<parameter name="blurb">
+<parameter_description> description of the property specified
+</parameter_description>
+</parameter>
+<parameter name="minimum">
+<parameter_description> minimum value for the property specified
+</parameter_description>
+</parameter>
+<parameter name="maximum">
+<parameter_description> maximum value for the property specified
+</parameter_description>
+</parameter>
+<parameter name="default_value">
+<parameter_description> default value for the property specified
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> flags for the property specified
+</parameter_description>
+</parameter>
+</parameters>
+<return> a newly created parameter specification
+</return>
+</function>
+
+<function name="g_param_spec_enum">
+<description>
+Creates a new #GParamSpecEnum instance specifying a %G_TYPE_ENUM
+property.
+
+See g_param_spec_internal() for details on property names.
+
</description>
<parameters>
-<parameter name="pattern">
-<parameter_description> the regular expression
+<parameter name="name">
+<parameter_description> canonical name of the property specified
</parameter_description>
</parameter>
-<parameter name="string">
-<parameter_description> the string to scan for matches
+<parameter name="nick">
+<parameter_description> nick name for the property specified
</parameter_description>
</parameter>
-<parameter name="compile_options">
-<parameter_description> compile options for the regular expression, or 0
+<parameter name="blurb">
+<parameter_description> description of the property specified
</parameter_description>
</parameter>
-<parameter name="match_options">
-<parameter_description> match options, or 0
+<parameter name="enum_type">
+<parameter_description> a #GType derived from %G_TYPE_ENUM
+</parameter_description>
+</parameter>
+<parameter name="default_value">
+<parameter_description> default value for the property specified
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> flags for the property specified
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the string matched, %FALSE otherwise
+<return> a newly created parameter specification
+</return>
+</function>
+
+<function name="g_param_spec_flags">
+<description>
+Creates a new #GParamSpecFlags instance specifying a %G_TYPE_FLAGS
+property.
+
+See g_param_spec_internal() for details on property names.
+
+</description>
+<parameters>
+<parameter name="name">
+<parameter_description> canonical name of the property specified
+</parameter_description>
+</parameter>
+<parameter name="nick">
+<parameter_description> nick name for the property specified
+</parameter_description>
+</parameter>
+<parameter name="blurb">
+<parameter_description> description of the property specified
+</parameter_description>
+</parameter>
+<parameter name="flags_type">
+<parameter_description> a #GType derived from %G_TYPE_FLAGS
+</parameter_description>
+</parameter>
+<parameter name="default_value">
+<parameter_description> default value for the property specified
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> flags for the property specified
+</parameter_description>
+</parameter>
+</parameters>
+<return> a newly created parameter specification
</return>
</function>
-<function name="g_regex_new">
+<function name="g_param_spec_float">
<description>
-Compiles the regular expression to an internal form, and does
-the initial setup of the #GRegex structure.
+Creates a new #GParamSpecFloat instance specifying a %G_TYPE_FLOAT property.
+
+See g_param_spec_internal() for details on property names.
-Since: 2.14
</description>
<parameters>
-<parameter name="pattern">
-<parameter_description> the regular expression
+<parameter name="name">
+<parameter_description> canonical name of the property specified
</parameter_description>
</parameter>
-<parameter name="compile_options">
-<parameter_description> compile options for the regular expression, or 0
+<parameter name="nick">
+<parameter_description> nick name for the property specified
</parameter_description>
</parameter>
-<parameter name="match_options">
-<parameter_description> match options for the regular expression, or 0
+<parameter name="blurb">
+<parameter_description> description of the property specified
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError
+<parameter name="minimum">
+<parameter_description> minimum value for the property specified
+</parameter_description>
+</parameter>
+<parameter name="maximum">
+<parameter_description> maximum value for the property specified
+</parameter_description>
+</parameter>
+<parameter name="default_value">
+<parameter_description> default value for the property specified
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> flags for the property specified
</parameter_description>
</parameter>
</parameters>
-<return> a #GRegex structure. Call g_regex_unref() when you
-are done with it
+<return> a newly created parameter specification
+</return>
+</function>
+
+<function name="g_param_spec_get_blurb">
+<description>
+Get the short description of a #GParamSpec.
+
+</description>
+<parameters>
+<parameter name="pspec">
+<parameter_description> a valid #GParamSpec
+</parameter_description>
+</parameter>
+</parameters>
+<return> the short description of @pspec.
</return>
</function>
-<function name="g_regex_ref">
+<function name="g_param_spec_get_name">
<description>
-Increases reference count of @regex by 1.
+Get the name of a #GParamSpec.
-Since: 2.14
</description>
<parameters>
-<parameter name="regex">
-<parameter_description> a #GRegex
+<parameter name="pspec">
+<parameter_description> a valid #GParamSpec
</parameter_description>
</parameter>
</parameters>
-<return> @regex
+<return> the name of @pspec.
+</return>
+</function>
+
+<function name="g_param_spec_get_nick">
+<description>
+Get the nickname of a #GParamSpec.
+
+</description>
+<parameters>
+<parameter name="pspec">
+<parameter_description> a valid #GParamSpec
+</parameter_description>
+</parameter>
+</parameters>
+<return> the nickname of @pspec.
</return>
</function>
-<function name="g_regex_replace">
+<function name="g_param_spec_get_qdata">
<description>
-Replaces all occurrences of the pattern in @regex with the
-replacement text. Backreferences of the form '\number' or
-'\g<number>' in the replacement text are interpolated by the
-number-th captured subexpression of the match, '\g<name>' refers
-to the captured subexpression with the given name. '\0' refers to the
-complete match, but '\0' followed by a number is the octal representation
-of a character. To include a literal '\' in the replacement, write '\\'.
-There are also escapes that changes the case of the following text:
+Gets back user data pointers stored via g_param_spec_set_qdata().
-<variablelist>
-<varlistentry><term>\l</term>
-<listitem>
-<para>Convert to lower case the next character</para>
-</listitem>
-</varlistentry>
-<varlistentry><term>\u</term>
-<listitem>
-<para>Convert to upper case the next character</para>
-</listitem>
-</varlistentry>
-<varlistentry><term>\L</term>
-<listitem>
-<para>Convert to lower case till \E</para>
-</listitem>
-</varlistentry>
-<varlistentry><term>\U</term>
-<listitem>
-<para>Convert to upper case till \E</para>
-</listitem>
-</varlistentry>
-<varlistentry><term>\E</term>
-<listitem>
-<para>End case modification</para>
-</listitem>
-</varlistentry>
-</variablelist>
-If you do not need to use backreferences use g_regex_replace_literal().
+</description>
+<parameters>
+<parameter name="pspec">
+<parameter_description> a valid #GParamSpec
+</parameter_description>
+</parameter>
+<parameter name="quark">
+<parameter_description> a #GQuark, naming the user data pointer
+</parameter_description>
+</parameter>
+</parameters>
+<return> the user data pointer set, or %NULL
+</return>
+</function>
-The @replacement string must be UTF-8 encoded even if #G_REGEX_RAW was
-passed to g_regex_new(). If you want to use not UTF-8 encoded stings
-you can use g_regex_replace_literal().
+<function name="g_param_spec_get_redirect_target">
+<description>
+If the paramspec redirects operations to another paramspec,
+returns that paramspec. Redirect is used typically for
+providing a new implementation of a property in a derived
+type while preserving all the properties from the parent
+type. Redirection is established by creating a property
+of type #GParamSpecOverride. See g_object_class_override_property()
+for an example of the use of this capability.
-Setting @start_position differs from just passing over a shortened
-string and setting #G_REGEX_MATCH_NOTBOL in the case of a pattern that
-begins with any kind of lookbehind assertion, such as "\b".
+Since: 2.4
-Since: 2.14
</description>
<parameters>
-<parameter name="regex">
-<parameter_description> a #GRegex structure
+<parameter name="pspec">
+<parameter_description> a #GParamSpec
</parameter_description>
</parameter>
-<parameter name="string">
-<parameter_description> the string to perform matches against
+</parameters>
+<return> paramspec to which requests on this
+paramspec should be redirected, or %NULL if none.
+</return>
+</function>
+
+<function name="g_param_spec_gtype">
+<description>
+Creates a new #GParamSpecGType instance specifying a
+%G_TYPE_GTYPE property.
+
+See g_param_spec_internal() for details on property names.
+
+Since: 2.10
+
+
+</description>
+<parameters>
+<parameter name="name">
+<parameter_description> canonical name of the property specified
</parameter_description>
</parameter>
-<parameter name="string_len">
-<parameter_description> the length of @string, or -1 if @string is nul-terminated
+<parameter name="nick">
+<parameter_description> nick name for the property specified
</parameter_description>
</parameter>
-<parameter name="start_position">
-<parameter_description> starting index of the string to match
+<parameter name="blurb">
+<parameter_description> description of the property specified
</parameter_description>
</parameter>
-<parameter name="replacement">
-<parameter_description> text to replace each match with
+<parameter name="is_a_type">
+<parameter_description> a #GType whose subtypes are allowed as values
+of the property (use %G_TYPE_NONE for any type)
</parameter_description>
</parameter>
-<parameter name="match_options">
-<parameter_description> options for the match
+<parameter name="flags">
+<parameter_description> flags for the property specified
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> location to store the error occuring, or %NULL to ignore errors
+</parameters>
+<return> a newly created parameter specification
+</return>
+</function>
+
+<function name="g_param_spec_int">
+<description>
+Creates a new #GParamSpecInt instance specifying a %G_TYPE_INT property.
+
+See g_param_spec_internal() for details on property names.
+
+
+</description>
+<parameters>
+<parameter name="name">
+<parameter_description> canonical name of the property specified
+</parameter_description>
+</parameter>
+<parameter name="nick">
+<parameter_description> nick name for the property specified
+</parameter_description>
+</parameter>
+<parameter name="blurb">
+<parameter_description> description of the property specified
+</parameter_description>
+</parameter>
+<parameter name="minimum">
+<parameter_description> minimum value for the property specified
+</parameter_description>
+</parameter>
+<parameter name="maximum">
+<parameter_description> maximum value for the property specified
+</parameter_description>
+</parameter>
+<parameter name="default_value">
+<parameter_description> default value for the property specified
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> flags for the property specified
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated string containing the replacements
-
+<return> a newly created parameter specification
</return>
</function>
-<function name="g_regex_replace_eval">
+<function name="g_param_spec_int64">
<description>
-Replaces occurrences of the pattern in regex with the output of
- eval for that occurrence.
+Creates a new #GParamSpecInt64 instance specifying a %G_TYPE_INT64 property.
-Setting @start_position differs from just passing over a shortened
-string and setting #G_REGEX_MATCH_NOTBOL in the case of a pattern
-that begins with any kind of lookbehind assertion, such as "\b".
+See g_param_spec_internal() for details on property names.
-The following example uses g_regex_replace_eval() to replace multiple
-strings at once:
-|[
-static gboolean
-eval_cb (const GMatchInfo *info,
-GString *res,
-gpointer data)
-{
-gchar *match;
-gchar *r;
-match = g_match_info_fetch (info, 0);
-r = g_hash_table_lookup ((GHashTable *)data, match);
-g_string_append (res, r);
-g_free (match);
+</description>
+<parameters>
+<parameter name="name">
+<parameter_description> canonical name of the property specified
+</parameter_description>
+</parameter>
+<parameter name="nick">
+<parameter_description> nick name for the property specified
+</parameter_description>
+</parameter>
+<parameter name="blurb">
+<parameter_description> description of the property specified
+</parameter_description>
+</parameter>
+<parameter name="minimum">
+<parameter_description> minimum value for the property specified
+</parameter_description>
+</parameter>
+<parameter name="maximum">
+<parameter_description> maximum value for the property specified
+</parameter_description>
+</parameter>
+<parameter name="default_value">
+<parameter_description> default value for the property specified
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> flags for the property specified
+</parameter_description>
+</parameter>
+</parameters>
+<return> a newly created parameter specification
+</return>
+</function>
-return FALSE;
-}
+<function name="g_param_spec_internal">
+<description>
+Creates a new #GParamSpec instance.
-/ * ... * /
+A property name consists of segments consisting of ASCII letters and
+digits, separated by either the '-' or '_' character. The first
+character of a property name must be a letter. Names which violate these
+rules lead to undefined behaviour.
-GRegex *reg;
-GHashTable *h;
-gchar *res;
+When creating and looking up a #GParamSpec, either separator can be
+used, but they cannot be mixed. Using '-' is considerably more
+efficient and in fact required when using property names as detail
+strings for signals.
-h = g_hash_table_new (g_str_hash, g_str_equal);
+Beyond the name, #GParamSpec<!-- -->s have two more descriptive
+strings associated with them, the @nick, which should be suitable
+for use as a label for the property in a property editor, and the
+ blurb, which should be a somewhat longer description, suitable for
+e.g. a tooltip. The @nick and @blurb should ideally be localized.
-g_hash_table_insert (h, "1", "ONE");
-g_hash_table_insert (h, "2", "TWO");
-g_hash_table_insert (h, "3", "THREE");
-g_hash_table_insert (h, "4", "FOUR");
-reg = g_regex_new ("1|2|3|4", 0, 0, NULL);
+</description>
+<parameters>
+<parameter name="param_type">
+<parameter_description> the #GType for the property; must be derived from #G_TYPE_PARAM
+</parameter_description>
+</parameter>
+<parameter name="name">
+<parameter_description> the canonical name of the property
+</parameter_description>
+</parameter>
+<parameter name="nick">
+<parameter_description> the nickname of the property
+</parameter_description>
+</parameter>
+<parameter name="blurb">
+<parameter_description> a short description of the property
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> a combination of #GParamFlags
+</parameter_description>
+</parameter>
+</parameters>
+<return> a newly allocated #GParamSpec instance
+</return>
+</function>
+
+<function name="g_param_spec_long">
+<description>
+Creates a new #GParamSpecLong instance specifying a %G_TYPE_LONG property.
+
+See g_param_spec_internal() for details on property names.
+
+
+</description>
+<parameters>
+<parameter name="name">
+<parameter_description> canonical name of the property specified
+</parameter_description>
+</parameter>
+<parameter name="nick">
+<parameter_description> nick name for the property specified
+</parameter_description>
+</parameter>
+<parameter name="blurb">
+<parameter_description> description of the property specified
+</parameter_description>
+</parameter>
+<parameter name="minimum">
+<parameter_description> minimum value for the property specified
+</parameter_description>
+</parameter>
+<parameter name="maximum">
+<parameter_description> maximum value for the property specified
+</parameter_description>
+</parameter>
+<parameter name="default_value">
+<parameter_description> default value for the property specified
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> flags for the property specified
+</parameter_description>
+</parameter>
+</parameters>
+<return> a newly created parameter specification
+</return>
+</function>
+
+<function name="g_param_spec_object">
+<description>
+Creates a new #GParamSpecBoxed instance specifying a %G_TYPE_OBJECT
+derived property.
+
+See g_param_spec_internal() for details on property names.
+
+
+</description>
+<parameters>
+<parameter name="name">
+<parameter_description> canonical name of the property specified
+</parameter_description>
+</parameter>
+<parameter name="nick">
+<parameter_description> nick name for the property specified
+</parameter_description>
+</parameter>
+<parameter name="blurb">
+<parameter_description> description of the property specified
+</parameter_description>
+</parameter>
+<parameter name="object_type">
+<parameter_description> %G_TYPE_OBJECT derived type of this property
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> flags for the property specified
+</parameter_description>
+</parameter>
+</parameters>
+<return> a newly created parameter specification
+</return>
+</function>
+
+<function name="g_param_spec_override">
+<description>
+Creates a new property of type #GParamSpecOverride. This is used
+to direct operations to another paramspec, and will not be directly
+useful unless you are implementing a new base type similar to GObject.
+
+Since: 2.4
+
+
+</description>
+<parameters>
+<parameter name="name">
+<parameter_description> the name of the property.
+</parameter_description>
+</parameter>
+<parameter name="overridden">
+<parameter_description> The property that is being overridden
+</parameter_description>
+</parameter>
+</parameters>
+<return> the newly created #GParamSpec
+</return>
+</function>
+
+<function name="g_param_spec_param">
+<description>
+Creates a new #GParamSpecParam instance specifying a %G_TYPE_PARAM
+property.
+
+See g_param_spec_internal() for details on property names.
+
+
+</description>
+<parameters>
+<parameter name="name">
+<parameter_description> canonical name of the property specified
+</parameter_description>
+</parameter>
+<parameter name="nick">
+<parameter_description> nick name for the property specified
+</parameter_description>
+</parameter>
+<parameter name="blurb">
+<parameter_description> description of the property specified
+</parameter_description>
+</parameter>
+<parameter name="param_type">
+<parameter_description> a #GType derived from %G_TYPE_PARAM
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> flags for the property specified
+</parameter_description>
+</parameter>
+</parameters>
+<return> a newly created parameter specification
+</return>
+</function>
+
+<function name="g_param_spec_pointer">
+<description>
+Creates a new #GParamSpecPoiner instance specifying a pointer property.
+
+See g_param_spec_internal() for details on property names.
+
+
+</description>
+<parameters>
+<parameter name="name">
+<parameter_description> canonical name of the property specified
+</parameter_description>
+</parameter>
+<parameter name="nick">
+<parameter_description> nick name for the property specified
+</parameter_description>
+</parameter>
+<parameter name="blurb">
+<parameter_description> description of the property specified
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> flags for the property specified
+</parameter_description>
+</parameter>
+</parameters>
+<return> a newly created parameter specification
+</return>
+</function>
+
+<function name="g_param_spec_pool_insert">
+<description>
+Inserts a #GParamSpec in the pool.
+
+</description>
+<parameters>
+<parameter name="pool">
+<parameter_description> a #GParamSpecPool.
+</parameter_description>
+</parameter>
+<parameter name="pspec">
+<parameter_description> the #GParamSpec to insert
+</parameter_description>
+</parameter>
+<parameter name="owner_type">
+<parameter_description> a #GType identifying the owner of @pspec
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_param_spec_pool_list">
+<description>
+Gets an array of all #GParamSpec<!-- -->s owned by @owner_type in
+the pool.
+
+
+</description>
+<parameters>
+<parameter name="pool">
+<parameter_description> a #GParamSpecPool
+</parameter_description>
+</parameter>
+<parameter name="owner_type">
+<parameter_description> the owner to look for
+</parameter_description>
+</parameter>
+<parameter name="n_pspecs_p">
+<parameter_description> return location for the length of the returned array
+</parameter_description>
+</parameter>
+</parameters>
+<return> a newly
+allocated array containing pointers to all #GParamSpecs
+owned by @owner_type in the pool
+</return>
+</function>
+
+<function name="g_param_spec_pool_list_owned">
+<description>
+Gets an #GList of all #GParamSpec<!-- -->s owned by @owner_type in
+the pool.
+
+
+</description>
+<parameters>
+<parameter name="pool">
+<parameter_description> a #GParamSpecPool
+</parameter_description>
+</parameter>
+<parameter name="owner_type">
+<parameter_description> the owner to look for
+</parameter_description>
+</parameter>
+</parameters>
+<return> a
+#GList of all #GParamSpec<!-- -->s owned by @owner_type in
+the pool#GParamSpec<!-- -->s.
+</return>
+</function>
+
+<function name="g_param_spec_pool_lookup">
+<description>
+Looks up a #GParamSpec in the pool.
+
+
+</description>
+<parameters>
+<parameter name="pool">
+<parameter_description> a #GParamSpecPool
+</parameter_description>
+</parameter>
+<parameter name="param_name">
+<parameter_description> the name to look for
+</parameter_description>
+</parameter>
+<parameter name="owner_type">
+<parameter_description> the owner to look for
+</parameter_description>
+</parameter>
+<parameter name="walk_ancestors">
+<parameter_description> If %TRUE, also try to find a #GParamSpec with @param_name
+owned by an ancestor of @owner_type.
+</parameter_description>
+</parameter>
+</parameters>
+<return> The found #GParamSpec, or %NULL if no
+matching #GParamSpec was found.
+</return>
+</function>
+
+<function name="g_param_spec_pool_new">
+<description>
+Creates a new #GParamSpecPool.
+
+If @type_prefixing is %TRUE, lookups in the newly created pool will
+allow to specify the owner as a colon-separated prefix of the
+property name, like "GtkContainer:border-width". This feature is
+deprecated, so you should always set @type_prefixing to %FALSE.
+
+
+</description>
+<parameters>
+<parameter name="type_prefixing">
+<parameter_description> Whether the pool will support type-prefixed property names.
+</parameter_description>
+</parameter>
+</parameters>
+<return> a newly allocated #GParamSpecPool.
+</return>
+</function>
+
+<function name="g_param_spec_pool_remove">
+<description>
+Removes a #GParamSpec from the pool.
+
+</description>
+<parameters>
+<parameter name="pool">
+<parameter_description> a #GParamSpecPool
+</parameter_description>
+</parameter>
+<parameter name="pspec">
+<parameter_description> the #GParamSpec to remove
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_param_spec_ref">
+<description>
+Increments the reference count of @pspec.
+
+
+</description>
+<parameters>
+<parameter name="pspec">
+<parameter_description> a valid #GParamSpec
+</parameter_description>
+</parameter>
+</parameters>
+<return> the #GParamSpec that was passed into this function
+</return>
+</function>
+
+<function name="g_param_spec_ref_sink">
+<description>
+Convenience function to ref and sink a #GParamSpec.
+
+Since: 2.10
+
+</description>
+<parameters>
+<parameter name="pspec">
+<parameter_description> a valid #GParamSpec
+</parameter_description>
+</parameter>
+</parameters>
+<return> the #GParamSpec that was passed into this function
+</return>
+</function>
+
+<function name="g_param_spec_set_qdata">
+<description>
+Sets an opaque, named pointer on a #GParamSpec. The name is
+specified through a #GQuark (retrieved e.g. via
+g_quark_from_static_string()), and the pointer can be gotten back
+from the @pspec with g_param_spec_get_qdata(). Setting a
+previously set user data pointer, overrides (frees) the old pointer
+set, using %NULL as pointer essentially removes the data stored.
+
+</description>
+<parameters>
+<parameter name="pspec">
+<parameter_description> the #GParamSpec to set store a user data pointer
+</parameter_description>
+</parameter>
+<parameter name="quark">
+<parameter_description> a #GQuark, naming the user data pointer
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> an opaque user data pointer
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_param_spec_set_qdata_full">
+<description>
+This function works like g_param_spec_set_qdata(), but in addition,
+a <literal>void (*destroy) (gpointer)</literal> function may be
+specified which is called with @data as argument when the @pspec is
+finalized, or the data is being overwritten by a call to
+g_param_spec_set_qdata() with the same @quark.
+
+</description>
+<parameters>
+<parameter name="pspec">
+<parameter_description> the #GParamSpec to set store a user data pointer
+</parameter_description>
+</parameter>
+<parameter name="quark">
+<parameter_description> a #GQuark, naming the user data pointer
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> an opaque user data pointer
+</parameter_description>
+</parameter>
+<parameter name="destroy">
+<parameter_description> function to invoke with @data as argument, when @data needs to
+be freed
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_param_spec_sink">
+<description>
+The initial reference count of a newly created #GParamSpec is 1,
+even though no one has explicitly called g_param_spec_ref() on it
+yet. So the initial reference count is flagged as "floating", until
+someone calls <literal>g_param_spec_ref (pspec); g_param_spec_sink
+(pspec);</literal> in sequence on it, taking over the initial
+reference count (thus ending up with a @pspec that has a reference
+count of 1 still, but is not flagged "floating" anymore).
+
+</description>
+<parameters>
+<parameter name="pspec">
+<parameter_description> a valid #GParamSpec
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_param_spec_steal_qdata">
+<description>
+Gets back user data pointers stored via g_param_spec_set_qdata()
+and removes the @data from @pspec without invoking its destroy()
+function (if any was set). Usually, calling this function is only
+required to update user data pointers with a destroy notifier.
+
+
+</description>
+<parameters>
+<parameter name="pspec">
+<parameter_description> the #GParamSpec to get a stored user data pointer from
+</parameter_description>
+</parameter>
+<parameter name="quark">
+<parameter_description> a #GQuark, naming the user data pointer
+</parameter_description>
+</parameter>
+</parameters>
+<return> the user data pointer set, or %NULL
+</return>
+</function>
+
+<function name="g_param_spec_string">
+<description>
+Creates a new #GParamSpecString instance.
+
+See g_param_spec_internal() for details on property names.
+
+
+</description>
+<parameters>
+<parameter name="name">
+<parameter_description> canonical name of the property specified
+</parameter_description>
+</parameter>
+<parameter name="nick">
+<parameter_description> nick name for the property specified
+</parameter_description>
+</parameter>
+<parameter name="blurb">
+<parameter_description> description of the property specified
+</parameter_description>
+</parameter>
+<parameter name="default_value">
+<parameter_description> default value for the property specified
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> flags for the property specified
+</parameter_description>
+</parameter>
+</parameters>
+<return> a newly created parameter specification
+</return>
+</function>
+
+<function name="g_param_spec_uchar">
+<description>
+Creates a new #GParamSpecUChar instance specifying a %G_TYPE_UCHAR property.
+
+
+</description>
+<parameters>
+<parameter name="name">
+<parameter_description> canonical name of the property specified
+</parameter_description>
+</parameter>
+<parameter name="nick">
+<parameter_description> nick name for the property specified
+</parameter_description>
+</parameter>
+<parameter name="blurb">
+<parameter_description> description of the property specified
+</parameter_description>
+</parameter>
+<parameter name="minimum">
+<parameter_description> minimum value for the property specified
+</parameter_description>
+</parameter>
+<parameter name="maximum">
+<parameter_description> maximum value for the property specified
+</parameter_description>
+</parameter>
+<parameter name="default_value">
+<parameter_description> default value for the property specified
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> flags for the property specified
+</parameter_description>
+</parameter>
+</parameters>
+<return> a newly created parameter specification
+</return>
+</function>
+
+<function name="g_param_spec_uint">
+<description>
+Creates a new #GParamSpecUInt instance specifying a %G_TYPE_UINT property.
+
+See g_param_spec_internal() for details on property names.
+
+
+</description>
+<parameters>
+<parameter name="name">
+<parameter_description> canonical name of the property specified
+</parameter_description>
+</parameter>
+<parameter name="nick">
+<parameter_description> nick name for the property specified
+</parameter_description>
+</parameter>
+<parameter name="blurb">
+<parameter_description> description of the property specified
+</parameter_description>
+</parameter>
+<parameter name="minimum">
+<parameter_description> minimum value for the property specified
+</parameter_description>
+</parameter>
+<parameter name="maximum">
+<parameter_description> maximum value for the property specified
+</parameter_description>
+</parameter>
+<parameter name="default_value">
+<parameter_description> default value for the property specified
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> flags for the property specified
+</parameter_description>
+</parameter>
+</parameters>
+<return> a newly created parameter specification
+</return>
+</function>
+
+<function name="g_param_spec_uint64">
+<description>
+Creates a new #GParamSpecUInt64 instance specifying a %G_TYPE_UINT64
+property.
+
+See g_param_spec_internal() for details on property names.
+
+
+</description>
+<parameters>
+<parameter name="name">
+<parameter_description> canonical name of the property specified
+</parameter_description>
+</parameter>
+<parameter name="nick">
+<parameter_description> nick name for the property specified
+</parameter_description>
+</parameter>
+<parameter name="blurb">
+<parameter_description> description of the property specified
+</parameter_description>
+</parameter>
+<parameter name="minimum">
+<parameter_description> minimum value for the property specified
+</parameter_description>
+</parameter>
+<parameter name="maximum">
+<parameter_description> maximum value for the property specified
+</parameter_description>
+</parameter>
+<parameter name="default_value">
+<parameter_description> default value for the property specified
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> flags for the property specified
+</parameter_description>
+</parameter>
+</parameters>
+<return> a newly created parameter specification
+</return>
+</function>
+
+<function name="g_param_spec_ulong">
+<description>
+Creates a new #GParamSpecULong instance specifying a %G_TYPE_ULONG
+property.
+
+See g_param_spec_internal() for details on property names.
+
+
+</description>
+<parameters>
+<parameter name="name">
+<parameter_description> canonical name of the property specified
+</parameter_description>
+</parameter>
+<parameter name="nick">
+<parameter_description> nick name for the property specified
+</parameter_description>
+</parameter>
+<parameter name="blurb">
+<parameter_description> description of the property specified
+</parameter_description>
+</parameter>
+<parameter name="minimum">
+<parameter_description> minimum value for the property specified
+</parameter_description>
+</parameter>
+<parameter name="maximum">
+<parameter_description> maximum value for the property specified
+</parameter_description>
+</parameter>
+<parameter name="default_value">
+<parameter_description> default value for the property specified
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> flags for the property specified
+</parameter_description>
+</parameter>
+</parameters>
+<return> a newly created parameter specification
+</return>
+</function>
+
+<function name="g_param_spec_unichar">
+<description>
+Creates a new #GParamSpecUnichar instance specifying a %G_TYPE_UINT
+property. #GValue structures for this property can be accessed with
+g_value_set_uint() and g_value_get_uint().
+
+See g_param_spec_internal() for details on property names.
+
+
+</description>
+<parameters>
+<parameter name="name">
+<parameter_description> canonical name of the property specified
+</parameter_description>
+</parameter>
+<parameter name="nick">
+<parameter_description> nick name for the property specified
+</parameter_description>
+</parameter>
+<parameter name="blurb">
+<parameter_description> description of the property specified
+</parameter_description>
+</parameter>
+<parameter name="default_value">
+<parameter_description> default value for the property specified
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> flags for the property specified
+</parameter_description>
+</parameter>
+</parameters>
+<return> a newly created parameter specification
+</return>
+</function>
+
+<function name="g_param_spec_unref">
+<description>
+Decrements the reference count of a @pspec.
+
+</description>
+<parameters>
+<parameter name="pspec">
+<parameter_description> a valid #GParamSpec
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_param_spec_value_array">
+<description>
+Creates a new #GParamSpecValueArray instance specifying a
+%G_TYPE_VALUE_ARRAY property. %G_TYPE_VALUE_ARRAY is a
+%G_TYPE_BOXED type, as such, #GValue structures for this property
+can be accessed with g_value_set_boxed() and g_value_get_boxed().
+
+See g_param_spec_internal() for details on property names.
+
+
+</description>
+<parameters>
+<parameter name="name">
+<parameter_description> canonical name of the property specified
+</parameter_description>
+</parameter>
+<parameter name="nick">
+<parameter_description> nick name for the property specified
+</parameter_description>
+</parameter>
+<parameter name="blurb">
+<parameter_description> description of the property specified
+</parameter_description>
+</parameter>
+<parameter name="element_spec">
+<parameter_description> a #GParamSpec describing the elements contained in
+arrays of this property, may be %NULL
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> flags for the property specified
+</parameter_description>
+</parameter>
+</parameters>
+<return> a newly created parameter specification
+</return>
+</function>
+
+<function name="g_param_spec_variant">
+<description>
+Creates a new #GParamSpecVariant instance specifying a #GVariant
+property.
+
+If @default_value is floating, it is consumed.
+
+See g_param_spec_internal() for details on property names.
+
+Since: 2.26
+
+</description>
+<parameters>
+<parameter name="name">
+<parameter_description> canonical name of the property specified
+</parameter_description>
+</parameter>
+<parameter name="nick">
+<parameter_description> nick name for the property specified
+</parameter_description>
+</parameter>
+<parameter name="blurb">
+<parameter_description> description of the property specified
+</parameter_description>
+</parameter>
+<parameter name="type">
+<parameter_description> a #GVariantType
+</parameter_description>
+</parameter>
+<parameter name="default_value">
+<parameter_description> a #GVariant of type @type to use as the
+default value, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> flags for the property specified
+</parameter_description>
+</parameter>
+</parameters>
+<return> the newly created #GParamSpec
+
+</return>
+</function>
+
+<function name="g_param_type_register_static">
+<description>
+Registers @name as the name of a new static type derived from
+#G_TYPE_PARAM. The type system uses the information contained in
+the #GParamSpecTypeInfo structure pointed to by @info to manage the
+#GParamSpec type and its instances.
+
+
+</description>
+<parameters>
+<parameter name="name">
+<parameter_description> 0-terminated string used as the name of the new #GParamSpec type.
+</parameter_description>
+</parameter>
+<parameter name="pspec_info">
+<parameter_description> The #GParamSpecTypeInfo for this #GParamSpec type.
+</parameter_description>
+</parameter>
+</parameters>
+<return> The new type identifier.
+</return>
+</function>
+
+<function name="g_param_value_convert">
+<description>
+Transforms @src_value into @dest_value if possible, and then
+validates @dest_value, in order for it to conform to @pspec. If
+ strict_validation is %TRUE this function will only succeed if the
+transformed @dest_value complied to @pspec without modifications.
+
+See also g_value_type_transformable(), g_value_transform() and
+g_param_value_validate().
+
+
+</description>
+<parameters>
+<parameter name="pspec">
+<parameter_description> a valid #GParamSpec
+</parameter_description>
+</parameter>
+<parameter name="src_value">
+<parameter_description> souce #GValue
+</parameter_description>
+</parameter>
+<parameter name="dest_value">
+<parameter_description> destination #GValue of correct type for @pspec
+</parameter_description>
+</parameter>
+<parameter name="strict_validation">
+<parameter_description> %TRUE requires @dest_value to conform to @pspec
+without modifications
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if transformation and validation were successful,
+%FALSE otherwise and @dest_value is left untouched.
+</return>
+</function>
+
+<function name="g_param_value_defaults">
+<description>
+Checks whether @value contains the default value as specified in @pspec.
+
+
+</description>
+<parameters>
+<parameter name="pspec">
+<parameter_description> a valid #GParamSpec
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> a #GValue of correct type for @pspec
+</parameter_description>
+</parameter>
+</parameters>
+<return> whether @value contains the canonical default for this @pspec
+</return>
+</function>
+
+<function name="g_param_value_set_default">
+<description>
+Sets @value to its default value as specified in @pspec.
+
+</description>
+<parameters>
+<parameter name="pspec">
+<parameter_description> a valid #GParamSpec
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> a #GValue of correct type for @pspec
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_param_value_validate">
+<description>
+Ensures that the contents of @value comply with the specifications
+set out by @pspec. For example, a #GParamSpecInt might require
+that integers stored in @value may not be smaller than -42 and not be
+greater than +42. If @value contains an integer outside of this range,
+it is modified accordingly, so the resulting value will fit into the
+range -42 .. +42.
+
+
+</description>
+<parameters>
+<parameter name="pspec">
+<parameter_description> a valid #GParamSpec
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> a #GValue of correct type for @pspec
+</parameter_description>
+</parameter>
+</parameters>
+<return> whether modifying @value was necessary to ensure validity
+</return>
+</function>
+
+<function name="g_param_values_cmp">
+<description>
+Compares @value1 with @value2 according to @pspec, and return -1, 0 or +1,
+if @value1 is found to be less than, equal to or greater than @value2,
+respectively.
+
+
+</description>
+<parameters>
+<parameter name="pspec">
+<parameter_description> a valid #GParamSpec
+</parameter_description>
+</parameter>
+<parameter name="value1">
+<parameter_description> a #GValue of correct type for @pspec
+</parameter_description>
+</parameter>
+<parameter name="value2">
+<parameter_description> a #GValue of correct type for @pspec
+</parameter_description>
+</parameter>
+</parameters>
+<return> -1, 0 or +1, for a less than, equal to or greater than result
+</return>
+</function>
+
+<function name="g_parse_debug_string">
+<description>
+Parses a string containing debugging options
+into a %guint containing bit flags. This is used
+within GDK and GTK+ to parse the debug options passed on the
+command line or through environment variables.
+
+If @string is equal to "all", all flags are set. If @string
+is equal to "help", all the available keys in @keys are printed
+out to standard error.
+
+
+</description>
+<parameters>
+<parameter name="string">
+<parameter_description> a list of debug options separated by colons, spaces, or
+commas, or %NULL.
+</parameter_description>
+</parameter>
+<parameter name="keys">
+<parameter_description> pointer to an array of #GDebugKey which associate
+strings with bit flags.
+</parameter_description>
+</parameter>
+<parameter name="nkeys">
+<parameter_description> the number of #GDebugKey<!-- -->s in the array.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the combined set of bit flags.
+</return>
+</function>
+
+<function name="g_path_get_basename">
+<description>
+Gets the last component of the filename. If @file_name ends with a
+directory separator it gets the component before the last slash. If
+ file_name consists only of directory separators (and on Windows,
+possibly a drive letter), a single separator is returned. If
+ file_name is empty, it gets ".".
+
+
+</description>
+<parameters>
+<parameter name="file_name">
+<parameter_description> the name of the file.
+</parameter_description>
+</parameter>
+</parameters>
+<return> a newly allocated string containing the last component of
+the filename.
+</return>
+</function>
+
+<function name="g_path_get_dirname">
+<description>
+Gets the directory components of a file name. If the file name has no
+directory components "." is returned. The returned string should be
+freed when no longer needed.
+
+
+</description>
+<parameters>
+<parameter name="file_name">
+<parameter_description> the name of the file.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the directory components of the file.
+</return>
+</function>
+
+<function name="g_path_is_absolute">
+<description>
+Returns %TRUE if the given @file_name is an absolute file name.
+Note that this is a somewhat vague concept on Windows.
+
+On POSIX systems, an absolute file name is well-defined. It always
+starts from the single root directory. For example "/usr/local".
+
+On Windows, the concepts of current drive and drive-specific
+current directory introduce vagueness. This function interprets as
+an absolute file name one that either begins with a directory
+separator such as "\Users\tml" or begins with the root on a drive,
+for example "C:\Windows". The first case also includes UNC paths
+such as "\\myserver\docs\foo". In all cases, either slashes or
+backslashes are accepted.
+
+Note that a file name relative to the current drive root does not
+truly specify a file uniquely over time and across processes, as
+the current drive is a per-process value and can be changed.
+
+File names relative the current directory on some specific drive,
+such as "D:foo/bar", are not interpreted as absolute by this
+function, but they obviously are not relative to the normal current
+directory as returned by getcwd() or g_get_current_dir()
+either. Such paths should be avoided, or need to be handled using
+Windows-specific code.
+
+
+</description>
+<parameters>
+<parameter name="file_name">
+<parameter_description> a file name.
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if @file_name is absolute.
+</return>
+</function>
+
+<function name="g_path_skip_root">
+<description>
+Returns a pointer into @file_name after the root component, i.e. after
+the "/" in UNIX or "C:\" under Windows. If @file_name is not an absolute
+path it returns %NULL.
+
+
+</description>
+<parameters>
+<parameter name="file_name">
+<parameter_description> a file name.
+</parameter_description>
+</parameter>
+</parameters>
+<return> a pointer into @file_name after the root component.
+</return>
+</function>
+
+<function name="g_pattern_match">
+<description>
+Matches a string against a compiled pattern. Passing the correct
+length of the string given is mandatory. The reversed string can be
+omitted by passing %NULL, this is more efficient if the reversed
+version of the string to be matched is not at hand, as
+g_pattern_match() will only construct it if the compiled pattern
+requires reverse matches.
+
+Note that, if the user code will (possibly) match a string against a
+multitude of patterns containing wildcards, chances are high that
+some patterns will require a reversed string. In this case, it's
+more efficient to provide the reversed string to avoid multiple
+constructions thereof in the various calls to g_pattern_match().
+
+Note also that the reverse of a UTF-8 encoded string can in general
+<emphasis>not</emphasis> be obtained by g_strreverse(). This works
+only if the string doesn't contain any multibyte characters. GLib
+offers the g_utf8_strreverse() function to reverse UTF-8 encoded
+strings.
+
+</description>
+<parameters>
+<parameter name="pspec">
+<parameter_description> a #GPatternSpec
+</parameter_description>
+</parameter>
+<parameter name="string_length">
+<parameter_description> the length of @string (in bytes, i.e. strlen(),
+<emphasis>not</emphasis> g_utf8_strlen())
+</parameter_description>
+</parameter>
+<parameter name="string">
+<parameter_description> the UTF-8 encoded string to match
+</parameter_description>
+</parameter>
+<parameter name="string_reversed">
+<parameter_description> the reverse of @string or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if @string matches @pspec
+</return>
+</function>
+
+<function name="g_pattern_match_simple">
+<description>
+Matches a string against a pattern given as a string. If this
+function is to be called in a loop, it's more efficient to compile
+the pattern once with g_pattern_spec_new() and call
+g_pattern_match_string() repeatedly.
+
+</description>
+<parameters>
+<parameter name="pattern">
+<parameter_description> the UTF-8 encoded pattern
+</parameter_description>
+</parameter>
+<parameter name="string">
+<parameter_description> the UTF-8 encoded string to match
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if @string matches @pspec
+</return>
+</function>
+
+<function name="g_pattern_match_string">
+<description>
+Matches a string against a compiled pattern. If the string is to be
+matched against more than one pattern, consider using
+g_pattern_match() instead while supplying the reversed string.
+
+</description>
+<parameters>
+<parameter name="pspec">
+<parameter_description> a #GPatternSpec
+</parameter_description>
+</parameter>
+<parameter name="string">
+<parameter_description> the UTF-8 encoded string to match
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if @string matches @pspec
+</return>
+</function>
+
+<function name="g_pattern_spec_equal">
+<description>
+Compares two compiled pattern specs and returns whether they will
+match the same set of strings.
+
+</description>
+<parameters>
+<parameter name="pspec1">
+<parameter_description> a #GPatternSpec
+</parameter_description>
+</parameter>
+<parameter name="pspec2">
+<parameter_description> another #GPatternSpec
+</parameter_description>
+</parameter>
+</parameters>
+<return> Whether the compiled patterns are equal
+</return>
+</function>
+
+<function name="g_pattern_spec_free">
+<description>
+Frees the memory allocated for the #GPatternSpec.
+
+</description>
+<parameters>
+<parameter name="pspec">
+<parameter_description> a #GPatternSpec
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_pattern_spec_new">
+<description>
+Compiles a pattern to a #GPatternSpec.
+
+</description>
+<parameters>
+<parameter name="pattern">
+<parameter_description> a zero-terminated UTF-8 encoded string
+</parameter_description>
+</parameter>
+</parameters>
+<return> a newly-allocated #GPatternSpec
+</return>
+</function>
+
+<function name="g_pointer_bit_lock">
+<description>
+This is equivalent to g_bit_lock, but working on pointers (or other
+pointer-sized values).
+
+For portability reasons, you may only lock on the bottom 32 bits of
+the pointer.
+
+Since: 2.30
+
+</description>
+<parameters>
+<parameter name="address">
+<parameter_description> a pointer to a #gpointer-sized value
+</parameter_description>
+</parameter>
+<parameter name="lock_bit">
+<parameter_description> a bit value between 0 and 31
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_pointer_bit_trylock">
+<description>
+This is equivalent to g_bit_trylock, but working on pointers (or
+other pointer-sized values).
+
+For portability reasons, you may only lock on the bottom 32 bits of
+the pointer.
+
+Since: 2.30
+
+</description>
+<parameters>
+<parameter name="address">
+<parameter_description> a pointer to a #gpointer-sized value
+</parameter_description>
+</parameter>
+<parameter name="lock_bit">
+<parameter_description> a bit value between 0 and 31
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the lock was acquired
+</return>
+</function>
+
+<function name="g_pointer_bit_unlock">
+<description>
+This is equivalent to g_bit_unlock, but working on pointers (or other
+pointer-sized values).
+
+For portability reasons, you may only lock on the bottom 32 bits of
+the pointer.
+
+Since: 2.30
+
+</description>
+<parameters>
+<parameter name="address">
+<parameter_description> a pointer to a #gpointer-sized value
+</parameter_description>
+</parameter>
+<parameter name="lock_bit">
+<parameter_description> a bit value between 0 and 31
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_pointer_type_register_static">
+<description>
+Creates a new %G_TYPE_POINTER derived type id for a new
+pointer type with name @name.
+
+
+</description>
+<parameters>
+<parameter name="name">
+<parameter_description> the name of the new pointer type.
+</parameter_description>
+</parameter>
+</parameters>
+<return> a new %G_TYPE_POINTER derived type id for @name.
+</return>
+</function>
+
+<function name="g_poll">
+<description>
+Polls @fds, as with the poll() system call, but portably. (On
+systems that don't have poll(), it is emulated using select().)
+This is used internally by #GMainContext, but it can be called
+directly if you need to block until a file descriptor is ready, but
+don't want to run the full main loop.
+
+Each element of @fds is a #GPollFD describing a single file
+descriptor to poll. The %fd field indicates the file descriptor,
+and the %events field indicates the events to poll for. On return,
+the %revents fields will be filled with the events that actually
+occurred.
+
+On POSIX systems, the file descriptors in @fds can be any sort of
+file descriptor, but the situation is much more complicated on
+Windows. If you need to use g_poll() in code that has to run on
+Windows, the easiest solution is to construct all of your
+#GPollFD<!-- -->s with g_io_channel_win32_make_pollfd().
+
+Since: 2.20
+
+</description>
+<parameters>
+<parameter name="fds">
+<parameter_description> file descriptors to poll
+</parameter_description>
+</parameter>
+<parameter name="nfds">
+<parameter_description> the number of file descriptors in @fds
+</parameter_description>
+</parameter>
+<parameter name="timeout">
+<parameter_description> amount of time to wait, in milliseconds, or -1 to wait forever
+</parameter_description>
+</parameter>
+</parameters>
+<return> the number of entries in @fds whose %revents fields
+were filled in, or 0 if the operation timed out, or -1 on error or
+if the call was interrupted.
+
+</return>
+</function>
+
+<function name="g_prefix_error">
+<description>
+Formats a string according to @format and
+prefix it to an existing error message. If
+ err is %NULL (ie: no error variable) then do
+nothing.
+
+If * err is %NULL (ie: an error variable is
+present but there is no error condition) then
+also do nothing. Whether or not it makes
+sense to take advantage of this feature is up
+to you.
+
+Since: 2.16
+
+</description>
+<parameters>
+<parameter name="err">
+<parameter_description> a return location for a #GError, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="format">
+<parameter_description> printf()-style format string
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> arguments to @format
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_printf">
+<description>
+An implementation of the standard printf() function which supports
+positional parameters, as specified in the Single Unix Specification.
+
+Since: 2.2
+
+</description>
+<parameters>
+<parameter name="format">
+<parameter_description> a standard printf() format string, but notice
+<link linkend="string-precision">string precision pitfalls</link>.
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> the arguments to insert in the output.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the number of bytes printed.
+
+</return>
+</function>
+
+<function name="g_private_get">
+<description>
+Returns the pointer keyed to @private_key for the current thread. If
+g_private_set() hasn't been called for the current @private_key and
+thread yet, this pointer will be %NULL.
+
+This function can be used even if g_thread_init() has not yet been
+called, and, in that case, will return the value of @private_key
+casted to #gpointer. Note however, that private data set
+<emphasis>before</emphasis> g_thread_init() will
+<emphasis>not</emphasis> be retained <emphasis>after</emphasis> the
+call. Instead, %NULL will be returned in all threads directly after
+g_thread_init(), regardless of any g_private_set() calls issued
+before threading system intialization.
+
+</description>
+<parameters>
+<parameter name="private_key">
+<parameter_description> a #GPrivate.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the corresponding pointer.
+</return>
+</function>
+
+<function name="g_private_new">
+<description>
+Creates a new #GPrivate. If @destructor is non-%NULL, it is a
+pointer to a destructor function. Whenever a thread ends and the
+corresponding pointer keyed to this instance of #GPrivate is
+non-%NULL, the destructor is called with this pointer as the
+argument.
+
+<note><para>@destructor is used quite differently from @notify in
+g_static_private_set().</para></note>
+
+<note><para>A #GPrivate cannot be freed. Reuse it instead, if you
+can, to avoid shortage, or use #GStaticPrivate.</para></note>
+
+<note><para>This function will abort if g_thread_init() has not been
+called yet.</para></note>
+
+</description>
+<parameters>
+<parameter name="destructor">
+<parameter_description> a function to destroy the data keyed to #GPrivate when
+a thread ends.
+</parameter_description>
+</parameter>
+</parameters>
+<return> a new #GPrivate.
+</return>
+</function>
+
+<function name="g_private_set">
+<description>
+Sets the pointer keyed to @private_key for the current thread.
+
+This function can be used even if g_thread_init() has not yet been
+called, and, in that case, will set @private_key to @data casted to
+#GPrivate*. See g_private_get() for resulting caveats.
+
+</description>
+<parameters>
+<parameter name="private_key">
+<parameter_description> a #GPrivate.
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> the new pointer.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_propagate_error">
+<description>
+If @dest is %NULL, free @src; otherwise, moves @src into * dest
+The error variable @dest points to must be %NULL.
+
+</description>
+<parameters>
+<parameter name="dest">
+<parameter_description> error return location
+</parameter_description>
+</parameter>
+<parameter name="src">
+<parameter_description> error to move into the return location
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_propagate_prefixed_error">
+<description>
+If @dest is %NULL, free @src; otherwise,
+moves @src into * dest * dest must be %NULL.
+After the move, add a prefix as with
+g_prefix_error().
+
+Since: 2.16
+
+</description>
+<parameters>
+<parameter name="dest">
+<parameter_description> error return location
+</parameter_description>
+</parameter>
+<parameter name="src">
+<parameter_description> error to move into the return location
+</parameter_description>
+</parameter>
+<parameter name="format">
+<parameter_description> printf()-style format string
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> arguments to @format
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_ptr_array_add">
+<description>
+Adds a pointer to the end of the pointer array. The array will grow
+in size automatically if necessary.
+
+</description>
+<parameters>
+<parameter name="array">
+<parameter_description> a #GPtrArray.
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> the pointer to add.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_ptr_array_foreach">
+<description>
+Calls a function for each element of a #GPtrArray.
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="array">
+<parameter_description> a #GPtrArray
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> the function to call for each array element
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> user data to pass to the function
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_ptr_array_free">
+<description>
+Frees the memory allocated for the #GPtrArray. If @free_seg is %TRUE
+it frees the memory block holding the elements as well. Pass %FALSE
+if you want to free the #GPtrArray wrapper but preserve the
+underlying array for use elsewhere. If the reference count of @array
+is greater than one, the #GPtrArray wrapper is preserved but the
+size of @array will be set to zero.
+
+<note><para>If array contents point to dynamically-allocated
+memory, they should be freed separately if @free_seg is %TRUE and no
+#GDestroyNotify function has been set for @array.</para></note>
+
+</description>
+<parameters>
+<parameter name="array">
+<parameter_description> a #GPtrArray.
+</parameter_description>
+</parameter>
+<parameter name="free_seg">
+<parameter_description> if %TRUE the actual pointer array is freed as well.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the pointer array if @free_seg is %FALSE, otherwise %NULL.
+The pointer array should be freed using g_free().
+</return>
+</function>
+
+<function name="g_ptr_array_index">
+<description>
+Returns the pointer at the given index of the pointer array.
+
+</description>
+<parameters>
+<parameter name="array">
+<parameter_description> a #GPtrArray.
+</parameter_description>
+</parameter>
+<parameter name="index_">
+<parameter_description> the index of the pointer to return.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the pointer at the given index.
+</return>
+</function>
+
+<function name="g_ptr_array_new">
+<description>
+Creates a new #GPtrArray with a reference count of 1.
+
+</description>
+<parameters>
+</parameters>
+<return> the new #GPtrArray.
+</return>
+</function>
+
+<function name="g_ptr_array_new_with_free_func">
+<description>
+Creates a new #GPtrArray with a reference count of 1 and use @element_free_func
+for freeing each element when the array is destroyed either via
+g_ptr_array_unref(), when g_ptr_array_free() is called with @free_segment
+set to %TRUE or when removing elements.
+
+Since: 2.22
+
+</description>
+<parameters>
+<parameter name="element_free_func">
+<parameter_description> A function to free elements with destroy @array or %NULL.
+</parameter_description>
+</parameter>
+</parameters>
+<return> A new #GPtrArray.
+
+</return>
+</function>
+
+<function name="g_ptr_array_ref">
+<description>
+Atomically increments the reference count of @array by one. This
+function is MT-safe and may be called from any thread.
+
+Since: 2.22
+
+</description>
+<parameters>
+<parameter name="array">
+<parameter_description> A #GArray.
+</parameter_description>
+</parameter>
+</parameters>
+<return> The passed in #GPtrArray.
+
+</return>
+</function>
+
+<function name="g_ptr_array_remove">
+<description>
+Removes the first occurrence of the given pointer from the pointer
+array. The following elements are moved down one place. If @array
+has a non-%NULL #GDestroyNotify function it is called for the
+removed element.
+
+It returns %TRUE if the pointer was removed, or %FALSE if the
+pointer was not found.
+
+</description>
+<parameters>
+<parameter name="array">
+<parameter_description> a #GPtrArray.
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> the pointer to remove.
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the pointer is removed. %FALSE if the pointer is
+not found in the array.
+</return>
+</function>
+
+<function name="g_ptr_array_remove_fast">
+<description>
+Removes the first occurrence of the given pointer from the pointer
+array. The last element in the array is used to fill in the space,
+so this function does not preserve the order of the array. But it is
+faster than g_ptr_array_remove(). If @array has a non-%NULL
+#GDestroyNotify function it is called for the removed element.
+
+It returns %TRUE if the pointer was removed, or %FALSE if the
+pointer was not found.
+
+</description>
+<parameters>
+<parameter name="array">
+<parameter_description> a #GPtrArray.
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> the pointer to remove.
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the pointer was found in the array.
+</return>
+</function>
+
+<function name="g_ptr_array_remove_index">
+<description>
+Removes the pointer at the given index from the pointer array. The
+following elements are moved down one place. If @array has a
+non-%NULL #GDestroyNotify function it is called for the removed
+element.
+
+</description>
+<parameters>
+<parameter name="array">
+<parameter_description> a #GPtrArray.
+</parameter_description>
+</parameter>
+<parameter name="index_">
+<parameter_description> the index of the pointer to remove.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the pointer which was removed.
+</return>
+</function>
+
+<function name="g_ptr_array_remove_index_fast">
+<description>
+Removes the pointer at the given index from the pointer array. The
+last element in the array is used to fill in the space, so this
+function does not preserve the order of the array. But it is faster
+than g_ptr_array_remove_index(). If @array has a non-%NULL
+#GDestroyNotify function it is called for the removed element.
+
+</description>
+<parameters>
+<parameter name="array">
+<parameter_description> a #GPtrArray.
+</parameter_description>
+</parameter>
+<parameter name="index_">
+<parameter_description> the index of the pointer to remove.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the pointer which was removed.
+</return>
+</function>
+
+<function name="g_ptr_array_remove_range">
+<description>
+Removes the given number of pointers starting at the given index
+from a #GPtrArray. The following elements are moved to close the
+gap. If @array has a non-%NULL #GDestroyNotify function it is called
+for the removed elements.
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="array">
+<parameter_description> a @GPtrArray.
+</parameter_description>
+</parameter>
+<parameter name="index_">
+<parameter_description> the index of the first pointer to remove.
+</parameter_description>
+</parameter>
+<parameter name="length">
+<parameter_description> the number of pointers to remove.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_ptr_array_set_free_func">
+<description>
+Sets a function for freeing each element when @array is destroyed
+either via g_ptr_array_unref(), when g_ptr_array_free() is called
+with @free_segment set to %TRUE or when removing elements.
+
+Since: 2.22
+
+</description>
+<parameters>
+<parameter name="array">
+<parameter_description> A #GPtrArray.
+</parameter_description>
+</parameter>
+<parameter name="element_free_func">
+<parameter_description> A function to free elements with destroy @array or %NULL.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_ptr_array_set_size">
+<description>
+Sets the size of the array. When making the array larger,
+newly-added elements will be set to %NULL. When making it smaller,
+if @array has a non-%NULL #GDestroyNotify function then it will be
+called for the removed elements.
+
+</description>
+<parameters>
+<parameter name="array">
+<parameter_description> a #GPtrArray.
+</parameter_description>
+</parameter>
+<parameter name="length">
+<parameter_description> the new length of the pointer array.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_ptr_array_sized_new">
+<description>
+Creates a new #GPtrArray with @reserved_size pointers preallocated
+and a reference count of 1. This avoids frequent reallocation, if
+you are going to add many pointers to the array. Note however that
+the size of the array is still 0.
+
+</description>
+<parameters>
+<parameter name="reserved_size">
+<parameter_description> number of pointers preallocated.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the new #GPtrArray.
+</return>
+</function>
+
+<function name="g_ptr_array_sort">
+<description>
+Sorts the array, using @compare_func which should be a qsort()-style
+comparison function (returns less than zero for first arg is less
+than second arg, zero for equal, greater than zero if irst arg is
+greater than second arg).
+
+If two array elements compare equal, their order in the sorted array
+is undefined. If you want equal elements to keep their order &#8211; i.e.
+you want a stable sort &#8211; you can write a comparison function that,
+if two elements would otherwise compare equal, compares them by
+their addresses.
+
+<note><para>The comparison function for g_ptr_array_sort() doesn't
+take the pointers from the array as arguments, it takes pointers to
+the pointers in the array.</para></note>
+
+</description>
+<parameters>
+<parameter name="array">
+<parameter_description> a #GPtrArray.
+</parameter_description>
+</parameter>
+<parameter name="compare_func">
+<parameter_description> comparison function.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_ptr_array_sort_with_data">
+<description>
+Like g_ptr_array_sort(), but the comparison function has an extra
+user data argument.
+
+<note><para>The comparison function for g_ptr_array_sort_with_data()
+doesn't take the pointers from the array as arguments, it takes
+pointers to the pointers in the array.</para></note>
+
+</description>
+<parameters>
+<parameter name="array">
+<parameter_description> a #GPtrArray.
+</parameter_description>
+</parameter>
+<parameter name="compare_func">
+<parameter_description> comparison function.
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> data to pass to @compare_func.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_ptr_array_unref">
+<description>
+Atomically decrements the reference count of @array by one. If the
+reference count drops to 0, the effect is the same as calling
+g_ptr_array_free() with @free_segment set to %TRUE. This function
+is MT-safe and may be called from any thread.
+
+Since: 2.22
+
+</description>
+<parameters>
+<parameter name="array">
+<parameter_description> A #GPtrArray.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_qsort_with_data">
+<description>
+This is just like the standard C qsort() function, but
+the comparison routine accepts a user data argument.
+
+</description>
+<parameters>
+<parameter name="pbase">
+<parameter_description> start of array to sort
+</parameter_description>
+</parameter>
+<parameter name="total_elems">
+<parameter_description> elements in the array
+</parameter_description>
+</parameter>
+<parameter name="size">
+<parameter_description> size of each element
+</parameter_description>
+</parameter>
+<parameter name="compare_func">
+<parameter_description> function to compare elements
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> data to pass to @compare_func
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_quark_from_static_string">
+<description>
+Gets the #GQuark identifying the given (static) string. If the
+string does not currently have an associated #GQuark, a new #GQuark
+is created, linked to the given string.
+
+Note that this function is identical to g_quark_from_string() except
+that if a new #GQuark is created the string itself is used rather
+than a copy. This saves memory, but can only be used if the string
+will <emphasis>always</emphasis> exist. It can be used with
+statically allocated strings in the main program, but not with
+statically allocated memory in dynamically loaded modules, if you
+expect to ever unload the module again (e.g. do not use this
+function in GTK+ theme engines).
+
+</description>
+<parameters>
+<parameter name="string">
+<parameter_description> a string.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the #GQuark identifying the string, or 0 if @string is
+%NULL.
+</return>
+</function>
+
+<function name="g_quark_from_string">
+<description>
+Gets the #GQuark identifying the given string. If the string does
+not currently have an associated #GQuark, a new #GQuark is created,
+using a copy of the string.
+
+</description>
+<parameters>
+<parameter name="string">
+<parameter_description> a string.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the #GQuark identifying the string, or 0 if @string is
+%NULL.
+</return>
+</function>
+
+<function name="g_quark_to_string">
+<description>
+Gets the string associated with the given #GQuark.
+
+</description>
+<parameters>
+<parameter name="quark">
+<parameter_description> a #GQuark.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the string associated with the #GQuark.
+</return>
+</function>
+
+<function name="g_quark_try_string">
+<description>
+Gets the #GQuark associated with the given string, or 0 if string is
+%NULL or it has no associated #GQuark.
+
+If you want the GQuark to be created if it doesn't already exist,
+use g_quark_from_string() or g_quark_from_static_string().
+
+</description>
+<parameters>
+<parameter name="string">
+<parameter_description> a string.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the #GQuark associated with the string, or 0 if @string is
+%NULL or there is no #GQuark associated with it.
+</return>
+</function>
+
+<function name="g_queue_clear">
+<description>
+Removes all the elements in @queue. If queue elements contain
+dynamically-allocated memory, they should be freed first.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="queue">
+<parameter_description> a #GQueue
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_queue_copy">
+<description>
+Copies a @queue. Note that is a shallow copy. If the elements in the
+queue consist of pointers to data, the pointers are copied, but the
+actual data is not.
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="queue">
+<parameter_description> a #GQueue
+</parameter_description>
+</parameter>
+</parameters>
+<return> A copy of @queue
+
+</return>
+</function>
+
+<function name="g_queue_delete_link">
+<description>
+Removes @link_ from @queue and frees it.
+
+ link_ must be part of @queue.
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="queue">
+<parameter_description> a #GQueue
+</parameter_description>
+</parameter>
+<parameter name="link_">
+<parameter_description> a #GList link that <emphasis>must</emphasis> be part of @queue
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_queue_find">
+<description>
+Finds the first link in @queue which contains @data.
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="queue">
+<parameter_description> a #GQueue
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> data to find
+</parameter_description>
+</parameter>
+</parameters>
+<return> The first link in @queue which contains @data.
+
+</return>
+</function>
+
+<function name="g_queue_find_custom">
+<description>
+Finds an element in a #GQueue, using a supplied function to find the
+desired element. It iterates over the queue, calling the given function
+which should return 0 when the desired element is found. The function
+takes two gconstpointer arguments, the #GQueue element's data as the
+first argument and the given user data as the second argument.
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="queue">
+<parameter_description> a #GQueue
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> user data passed to @func
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> a #GCompareFunc to call for each element. It should return 0
+when the desired element is found
+</parameter_description>
+</parameter>
+</parameters>
+<return> The found link, or %NULL if it wasn't found
+
+</return>
+</function>
+
+<function name="g_queue_foreach">
+<description>
+Calls @func for each element in the queue passing @user_data to the
+function.
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="queue">
+<parameter_description> a #GQueue
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> the function to call for each element's data
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> user data to pass to @func
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_queue_free">
+<description>
+Frees the memory allocated for the #GQueue. Only call this function if
+ queue was created with g_queue_new(). If queue elements contain
+dynamically-allocated memory, they should be freed first.
+
+</description>
+<parameters>
+<parameter name="queue">
+<parameter_description> a #GQueue.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_queue_get_length">
+<description>
+Returns the number of items in @queue.
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="queue">
+<parameter_description> a #GQueue
+</parameter_description>
+</parameter>
+</parameters>
+<return> The number of items in @queue.
+
+</return>
+</function>
+
+<function name="g_queue_index">
+<description>
+Returns the position of the first element in @queue which contains @data.
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="queue">
+<parameter_description> a #GQueue
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> the data to find.
+</parameter_description>
+</parameter>
+</parameters>
+<return> The position of the first element in @queue which contains @data, or -1 if no element in @queue contains @data.
+
+</return>
+</function>
+
+<function name="g_queue_init">
+<description>
+A statically-allocated #GQueue must be initialized with this function
+before it can be used. Alternatively you can initialize it with
+#G_QUEUE_INIT. It is not necessary to initialize queues created with
+g_queue_new().
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="queue">
+<parameter_description> an uninitialized #GQueue
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_queue_insert_after">
+<description>
+Inserts @data into @queue after @sibling
+
+ sibling must be part of @queue
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="queue">
+<parameter_description> a #GQueue
+</parameter_description>
+</parameter>
+<parameter name="sibling">
+<parameter_description> a #GList link that <emphasis>must</emphasis> be part of @queue
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> the data to insert
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_queue_insert_before">
+<description>
+Inserts @data into @queue before @sibling.
+
+ sibling must be part of @queue.
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="queue">
+<parameter_description> a #GQueue
+</parameter_description>
+</parameter>
+<parameter name="sibling">
+<parameter_description> a #GList link that <emphasis>must</emphasis> be part of @queue
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> the data to insert
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_queue_insert_sorted">
+<description>
+Inserts @data into @queue using @func to determine the new position.
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="queue">
+<parameter_description> a #GQueue
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> the data to insert
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> the #GCompareDataFunc used to compare elements in the queue. It is
+called with two elements of the @queue and @user_data. It should
+return 0 if the elements are equal, a negative value if the first
+element comes before the second, and a positive value if the second
+element comes before the first.
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> user data passed to @func.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_queue_is_empty">
+<description>
+Returns %TRUE if the queue is empty.
+
+
+</description>
+<parameters>
+<parameter name="queue">
+<parameter_description> a #GQueue.
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the queue is empty.
+</return>
+</function>
+
+<function name="g_queue_link_index">
+<description>
+Returns the position of @link_ in @queue.
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="queue">
+<parameter_description> a #GQueue
+</parameter_description>
+</parameter>
+<parameter name="link_">
+<parameter_description> A #GList link
+</parameter_description>
+</parameter>
+</parameters>
+<return> The position of @link_, or -1 if the link is
+not part of @queue
+
+</return>
+</function>
+
+<function name="g_queue_new">
+<description>
+Creates a new #GQueue.
+
+
+</description>
+<parameters>
+</parameters>
+<return> a new #GQueue.
+</return>
+</function>
+
+<function name="g_queue_peek_head">
+<description>
+Returns the first element of the queue.
+
+
+</description>
+<parameters>
+<parameter name="queue">
+<parameter_description> a #GQueue.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the data of the first element in the queue, or %NULL if the queue
+is empty.
+</return>
+</function>
+
+<function name="g_queue_peek_head_link">
+<description>
+Returns the first link in @queue
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="queue">
+<parameter_description> a #GQueue
+</parameter_description>
+</parameter>
+</parameters>
+<return> the first link in @queue, or %NULL if @queue is empty
+
+</return>
+</function>
+
+<function name="g_queue_peek_nth">
+<description>
+Returns the @n'th element of @queue.
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="queue">
+<parameter_description> a #GQueue
+</parameter_description>
+</parameter>
+<parameter name="n">
+<parameter_description> the position of the element.
+</parameter_description>
+</parameter>
+</parameters>
+<return> The data for the @n'th element of @queue, or %NULL if @n is
+off the end of @queue.
+
+</return>
+</function>
+
+<function name="g_queue_peek_nth_link">
+<description>
+Returns the link at the given position
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="queue">
+<parameter_description> a #GQueue
+</parameter_description>
+</parameter>
+<parameter name="n">
+<parameter_description> the position of the link
+</parameter_description>
+</parameter>
+</parameters>
+<return> The link at the @n'th position, or %NULL if @n is off the
+end of the list
+
+</return>
+</function>
+
+<function name="g_queue_peek_tail">
+<description>
+Returns the last element of the queue.
+
+
+</description>
+<parameters>
+<parameter name="queue">
+<parameter_description> a #GQueue.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the data of the last element in the queue, or %NULL if the queue
+is empty.
+</return>
+</function>
+
+<function name="g_queue_peek_tail_link">
+<description>
+Returns the last link @queue.
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="queue">
+<parameter_description> a #GQueue
+</parameter_description>
+</parameter>
+</parameters>
+<return> the last link in @queue, or %NULL if @queue is empty
+
+</return>
+</function>
+
+<function name="g_queue_pop_head">
+<description>
+Removes the first element of the queue.
+
+
+</description>
+<parameters>
+<parameter name="queue">
+<parameter_description> a #GQueue.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the data of the first element in the queue, or %NULL if the queue
+is empty.
+</return>
+</function>
+
+<function name="g_queue_pop_head_link">
+<description>
+Removes the first element of the queue.
+
+
+</description>
+<parameters>
+<parameter name="queue">
+<parameter_description> a #GQueue.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the #GList element at the head of the queue, or %NULL if the queue
+is empty.
+</return>
+</function>
+
+<function name="g_queue_pop_nth">
+<description>
+Removes the @n'th element of @queue.
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="queue">
+<parameter_description> a #GQueue
+</parameter_description>
+</parameter>
+<parameter name="n">
+<parameter_description> the position of the element.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the element's data, or %NULL if @n is off the end of @queue.
+
+</return>
+</function>
+
+<function name="g_queue_pop_nth_link">
+<description>
+Removes and returns the link at the given position.
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="queue">
+<parameter_description> a #GQueue
+</parameter_description>
+</parameter>
+<parameter name="n">
+<parameter_description> the link's position
+</parameter_description>
+</parameter>
+</parameters>
+<return> The @n'th link, or %NULL if @n is off the end of @queue.
+
+</return>
+</function>
+
+<function name="g_queue_pop_tail">
+<description>
+Removes the last element of the queue.
+
+
+</description>
+<parameters>
+<parameter name="queue">
+<parameter_description> a #GQueue.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the data of the last element in the queue, or %NULL if the queue
+is empty.
+</return>
+</function>
+
+<function name="g_queue_pop_tail_link">
+<description>
+Removes the last element of the queue.
+
+
+</description>
+<parameters>
+<parameter name="queue">
+<parameter_description> a #GQueue.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the #GList element at the tail of the queue, or %NULL if the queue
+is empty.
+</return>
+</function>
+
+<function name="g_queue_push_head">
+<description>
+Adds a new element at the head of the queue.
+
+</description>
+<parameters>
+<parameter name="queue">
+<parameter_description> a #GQueue.
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> the data for the new element.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_queue_push_head_link">
+<description>
+Adds a new element at the head of the queue.
+
+</description>
+<parameters>
+<parameter name="queue">
+<parameter_description> a #GQueue.
+</parameter_description>
+</parameter>
+<parameter name="link_">
+<parameter_description> a single #GList element, <emphasis>not</emphasis> a list with
+more than one element.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_queue_push_nth">
+<description>
+Inserts a new element into @queue at the given position
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="queue">
+<parameter_description> a #GQueue
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> the data for the new element
+</parameter_description>
+</parameter>
+<parameter name="n">
+<parameter_description> the position to insert the new element. If @n is negative or
+larger than the number of elements in the @queue, the element is
+added to the end of the queue.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_queue_push_nth_link">
+<description>
+Inserts @link into @queue at the given position.
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="queue">
+<parameter_description> a #GQueue
+</parameter_description>
+</parameter>
+<parameter name="n">
+<parameter_description> the position to insert the link. If this is negative or larger than
+the number of elements in @queue, the link is added to the end of
+ queue
+</parameter_description>
+</parameter>
+<parameter name="link_">
+<parameter_description> the link to add to @queue
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_queue_push_tail">
+<description>
+Adds a new element at the tail of the queue.
+
+</description>
+<parameters>
+<parameter name="queue">
+<parameter_description> a #GQueue.
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> the data for the new element.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_queue_push_tail_link">
+<description>
+Adds a new element at the tail of the queue.
+
+</description>
+<parameters>
+<parameter name="queue">
+<parameter_description> a #GQueue.
+</parameter_description>
+</parameter>
+<parameter name="link_">
+<parameter_description> a single #GList element, <emphasis>not</emphasis> a list with
+more than one element.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_queue_remove">
+<description>
+Removes the first element in @queue that contains @data.
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="queue">
+<parameter_description> a #GQueue
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> data to remove.
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if @data was found and removed from @queue
+
+</return>
+</function>
+
+<function name="g_queue_remove_all">
+<description>
+Remove all elements whose data equals @data from @queue.
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="queue">
+<parameter_description> a #GQueue
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> data to remove
+</parameter_description>
+</parameter>
+</parameters>
+<return> the number of elements removed from @queue
+
+</return>
+</function>
+
+<function name="g_queue_reverse">
+<description>
+Reverses the order of the items in @queue.
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="queue">
+<parameter_description> a #GQueue
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_queue_sort">
+<description>
+Sorts @queue using @compare_func.
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="queue">
+<parameter_description> a #GQueue
+</parameter_description>
+</parameter>
+<parameter name="compare_func">
+<parameter_description> the #GCompareDataFunc used to sort @queue. This function
+is passed two elements of the queue and should return 0 if they are
+equal, a negative value if the first comes before the second, and
+a positive value if the second comes before the first.
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> user data passed to @compare_func
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_queue_unlink">
+<description>
+Unlinks @link_ so that it will no longer be part of @queue. The link is
+not freed.
+
+ link_ must be part of @queue,
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="queue">
+<parameter_description> a #GQueue
+</parameter_description>
+</parameter>
+<parameter name="link_">
+<parameter_description> a #GList link that <emphasis>must</emphasis> be part of @queue
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_rand_boolean">
+<description>
+Returns a random #gboolean from @rand_. This corresponds to a
+unbiased coin toss.
+
+</description>
+<parameters>
+<parameter name="rand_">
+<parameter_description> a #GRand.
+</parameter_description>
+</parameter>
+</parameters>
+<return> a random #gboolean.
+</return>
+</function>
+
+<function name="g_rand_copy">
+<description>
+Copies a #GRand into a new one with the same exact state as before.
+This way you can take a snapshot of the random number generator for
+replaying later.
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="rand_">
+<parameter_description> a #GRand.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the new #GRand.
+
+</return>
+</function>
+
+<function name="g_rand_double">
+<description>
+Returns the next random #gdouble from @rand_ equally distributed over
+the range [0..1).
+
+
+</description>
+<parameters>
+<parameter name="rand_">
+<parameter_description> a #GRand.
+</parameter_description>
+</parameter>
+</parameters>
+<return> A random number.
+</return>
+</function>
+
+<function name="g_rand_double_range">
+<description>
+Returns the next random #gdouble from @rand_ equally distributed over
+the range [ begin @end).
+
+
+</description>
+<parameters>
+<parameter name="rand_">
+<parameter_description> a #GRand.
+</parameter_description>
+</parameter>
+<parameter name="begin">
+<parameter_description> lower closed bound of the interval.
+</parameter_description>
+</parameter>
+<parameter name="end">
+<parameter_description> upper open bound of the interval.
+</parameter_description>
+</parameter>
+</parameters>
+<return> A random number.
+</return>
+</function>
+
+<function name="g_rand_free">
+<description>
+Frees the memory allocated for the #GRand.
+
+</description>
+<parameters>
+<parameter name="rand_">
+<parameter_description> a #GRand.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_rand_int">
+<description>
+Returns the next random #guint32 from @rand_ equally distributed over
+the range [0..2^32-1].
+
+
+</description>
+<parameters>
+<parameter name="rand_">
+<parameter_description> a #GRand.
+</parameter_description>
+</parameter>
+</parameters>
+<return> A random number.
+</return>
+</function>
+
+<function name="g_rand_int_range">
+<description>
+Returns the next random #gint32 from @rand_ equally distributed over
+the range [ begin @end-1].
+
+
+</description>
+<parameters>
+<parameter name="rand_">
+<parameter_description> a #GRand.
+</parameter_description>
+</parameter>
+<parameter name="begin">
+<parameter_description> lower closed bound of the interval.
+</parameter_description>
+</parameter>
+<parameter name="end">
+<parameter_description> upper open bound of the interval.
+</parameter_description>
+</parameter>
+</parameters>
+<return> A random number.
+</return>
+</function>
+
+<function name="g_rand_new">
+<description>
+Creates a new random number generator initialized with a seed taken
+either from <filename>/dev/urandom</filename> (if existing) or from
+the current time (as a fallback).
+
+
+</description>
+<parameters>
+</parameters>
+<return> the new #GRand.
+</return>
+</function>
+
+<function name="g_rand_new_with_seed">
+<description>
+Creates a new random number generator initialized with @seed.
+
+
+</description>
+<parameters>
+<parameter name="seed">
+<parameter_description> a value to initialize the random number generator.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the new #GRand.
+</return>
+</function>
+
+<function name="g_rand_new_with_seed_array">
+<description>
+Creates a new random number generator initialized with @seed.
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="seed">
+<parameter_description> an array of seeds to initialize the random number generator.
+</parameter_description>
+</parameter>
+<parameter name="seed_length">
+<parameter_description> an array of seeds to initialize the random number generator.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the new #GRand.
+
+</return>
+</function>
+
+<function name="g_rand_set_seed">
+<description>
+Sets the seed for the random number generator #GRand to @seed.
+
+</description>
+<parameters>
+<parameter name="rand_">
+<parameter_description> a #GRand.
+</parameter_description>
+</parameter>
+<parameter name="seed">
+<parameter_description> a value to reinitialize the random number generator.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_rand_set_seed_array">
+<description>
+Initializes the random number generator by an array of
+longs. Array can be of arbitrary size, though only the
+first 624 values are taken. This function is useful
+if you have many low entropy seeds, or if you require more then
+32bits of actual entropy for your application.
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="rand_">
+<parameter_description> a #GRand.
+</parameter_description>
+</parameter>
+<parameter name="seed">
+<parameter_description> array to initialize with
+</parameter_description>
+</parameter>
+<parameter name="seed_length">
+<parameter_description> length of array
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_random_boolean">
+<description>
+Returns a random #gboolean. This corresponds to a unbiased coin toss.
+
+</description>
+<parameters>
+</parameters>
+<return> a random #gboolean.
+</return>
+</function>
+
+<function name="g_random_double">
+<description>
+Returns a random #gdouble equally distributed over the range [0..1).
+
+
+</description>
+<parameters>
+</parameters>
+<return> A random number.
+</return>
+</function>
+
+<function name="g_random_double_range">
+<description>
+Returns a random #gdouble equally distributed over the range [ begin @end).
+
+
+</description>
+<parameters>
+<parameter name="begin">
+<parameter_description> lower closed bound of the interval.
+</parameter_description>
+</parameter>
+<parameter name="end">
+<parameter_description> upper open bound of the interval.
+</parameter_description>
+</parameter>
+</parameters>
+<return> A random number.
+</return>
+</function>
+
+<function name="g_random_int">
+<description>
+Return a random #guint32 equally distributed over the range
+[0..2^32-1].
+
+
+</description>
+<parameters>
+</parameters>
+<return> A random number.
+</return>
+</function>
+
+<function name="g_random_int_range">
+<description>
+Returns a random #gint32 equally distributed over the range
+[ begin @end-1].
+
+
+</description>
+<parameters>
+<parameter name="begin">
+<parameter_description> lower closed bound of the interval.
+</parameter_description>
+</parameter>
+<parameter name="end">
+<parameter_description> upper open bound of the interval.
+</parameter_description>
+</parameter>
+</parameters>
+<return> A random number.
+</return>
+</function>
+
+<function name="g_random_set_seed">
+<description>
+Sets the seed for the global random number generator, which is used
+by the <function>g_random_*</function> functions, to @seed.
+
+</description>
+<parameters>
+<parameter name="seed">
+<parameter_description> a value to reinitialize the global random number generator.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_realloc">
+<description>
+Reallocates the memory pointed to by @mem, so that it now has space for
+ n_bytes bytes of memory. It returns the new address of the memory, which may
+have been moved. @mem may be %NULL, in which case it's considered to
+have zero-length. @n_bytes may be 0, in which case %NULL will be returned
+and @mem will be freed unless it is %NULL.
+
+
+</description>
+<parameters>
+<parameter name="mem">
+<parameter_description> the memory to reallocate
+</parameter_description>
+</parameter>
+<parameter name="n_bytes">
+<parameter_description> new size of the memory in bytes
+</parameter_description>
+</parameter>
+</parameters>
+<return> the new address of the allocated memory
+</return>
+</function>
+
+<function name="g_realloc_n">
+<description>
+This function is similar to g_realloc(), allocating (@n_blocks * @n_block_bytes) bytes,
+but care is taken to detect possible overflow during multiplication.
+
+Since: 2.24
+
+</description>
+<parameters>
+<parameter name="mem">
+<parameter_description> the memory to reallocate
+</parameter_description>
+</parameter>
+<parameter name="n_blocks">
+<parameter_description> the number of blocks to allocate
+</parameter_description>
+</parameter>
+<parameter name="n_block_bytes">
+<parameter_description> the size of each block in bytes
+</parameter_description>
+</parameter>
+</parameters>
+<return> the new address of the allocated memory
+</return>
+</function>
+
+<function name="g_regex_check_replacement">
+<description>
+Checks whether @replacement is a valid replacement string
+(see g_regex_replace()), i.e. that all escape sequences in
+it are valid.
+
+If @has_references is not %NULL then @replacement is checked
+for pattern references. For instance, replacement text 'foo\n'
+does not contain references and may be evaluated without information
+about actual match, but '\0\1' (whole match followed by first
+subpattern) requires valid #GMatchInfo object.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="replacement">
+<parameter_description> the replacement string
+</parameter_description>
+</parameter>
+<parameter name="has_references">
+<parameter_description> location to store information about
+references in @replacement or %NULL
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> location to store error
+</parameter_description>
+</parameter>
+</parameters>
+<return> whether @replacement is a valid replacement string
+
+</return>
+</function>
+
+<function name="g_regex_escape_string">
+<description>
+Escapes the special characters used for regular expressions
+in @string, for instance "a.b*c" becomes "a\.b\*c". This
+function is useful to dynamically generate regular expressions.
+
+ string can contain nul characters that are replaced with "\0",
+in this case remember to specify the correct length of @string
+in @length.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="string">
+<parameter_description> the string to escape
+</parameter_description>
+</parameter>
+<parameter name="length">
+<parameter_description> the length of @string, or -1 if @string is nul-terminated
+</parameter_description>
+</parameter>
+</parameters>
+<return> a newly-allocated escaped string
+
+</return>
+</function>
+
+<function name="g_regex_get_capture_count">
+<description>
+Returns the number of capturing subpatterns in the pattern.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="regex">
+<parameter_description> a #GRegex
+</parameter_description>
+</parameter>
+</parameters>
+<return> the number of capturing subpatterns
+
+</return>
+</function>
+
+<function name="g_regex_get_compile_flags">
+<description>
+Returns the compile options that @regex was created with.
+
+Since: 2.26
+
+</description>
+<parameters>
+<parameter name="regex">
+<parameter_description> a #GRegex
+</parameter_description>
+</parameter>
+</parameters>
+<return> flags from #GRegexCompileFlags
+
+</return>
+</function>
+
+<function name="g_regex_get_match_flags">
+<description>
+Returns the match options that @regex was created with.
+
+Since: 2.26
+
+</description>
+<parameters>
+<parameter name="regex">
+<parameter_description> a #GRegex
+</parameter_description>
+</parameter>
+</parameters>
+<return> flags from #GRegexMatchFlags
+
+</return>
+</function>
+
+<function name="g_regex_get_max_backref">
+<description>
+Returns the number of the highest back reference
+in the pattern, or 0 if the pattern does not contain
+back references.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="regex">
+<parameter_description> a #GRegex
+</parameter_description>
+</parameter>
+</parameters>
+<return> the number of the highest back reference
+
+</return>
+</function>
+
+<function name="g_regex_get_pattern">
+<description>
+Gets the pattern string associated with @regex, i.e. a copy of
+the string passed to g_regex_new().
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="regex">
+<parameter_description> a #GRegex structure
+</parameter_description>
+</parameter>
+</parameters>
+<return> the pattern of @regex
+
+</return>
+</function>
+
+<function name="g_regex_get_string_number">
+<description>
+Retrieves the number of the subexpression named @name.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="regex">
+<parameter_description> #GRegex structure
+</parameter_description>
+</parameter>
+<parameter name="name">
+<parameter_description> name of the subexpression
+</parameter_description>
+</parameter>
+</parameters>
+<return> The number of the subexpression or -1 if @name
+does not exists
+
+</return>
+</function>
+
+<function name="g_regex_match">
+<description>
+Scans for a match in string for the pattern in @regex.
+The @match_options are combined with the match options specified
+when the @regex structure was created, letting you have more
+flexibility in reusing #GRegex structures.
+
+A #GMatchInfo structure, used to get information on the match,
+is stored in @match_info if not %NULL. Note that if @match_info
+is not %NULL then it is created even if the function returns %FALSE,
+i.e. you must free it regardless if regular expression actually matched.
+
+To retrieve all the non-overlapping matches of the pattern in
+string you can use g_match_info_next().
+
+|[
+static void
+print_uppercase_words (const gchar *string)
+{
+/ * Print all uppercase-only words. * /
+GRegex *regex;
+GMatchInfo *match_info;
+ 
+regex = g_regex_new ("[A-Z]+", 0, 0, NULL);
+g_regex_match (regex, string, 0, &match_info);
+while (g_match_info_matches (match_info))
+{
+gchar *word = g_match_info_fetch (match_info, 0);
+g_print ("Found: %s\n", word);
+g_free (word);
+g_match_info_next (match_info, NULL);
+}
+g_match_info_free (match_info);
+g_regex_unref (regex);
+}
+]|
+
+ string is not copied and is used in #GMatchInfo internally. If
+you use any #GMatchInfo method (except g_match_info_free()) after
+freeing or modifying @string then the behaviour is undefined.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="regex">
+<parameter_description> a #GRegex structure from g_regex_new()
+</parameter_description>
+</parameter>
+<parameter name="string">
+<parameter_description> the string to scan for matches
+</parameter_description>
+</parameter>
+<parameter name="match_options">
+<parameter_description> match options
+</parameter_description>
+</parameter>
+<parameter name="match_info">
+<parameter_description> pointer to location where to store
+the #GMatchInfo, or %NULL if you do not need it
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE is the string matched, %FALSE otherwise
+
+</return>
+</function>
+
+<function name="g_regex_match_all">
+<description>
+Using the standard algorithm for regular expression matching only
+the longest match in the string is retrieved. This function uses
+a different algorithm so it can retrieve all the possible matches.
+For more documentation see g_regex_match_all_full().
+
+A #GMatchInfo structure, used to get information on the match, is
+stored in @match_info if not %NULL. Note that if @match_info is
+not %NULL then it is created even if the function returns %FALSE,
+i.e. you must free it regardless if regular expression actually
+matched.
+
+ string is not copied and is used in #GMatchInfo internally. If
+you use any #GMatchInfo method (except g_match_info_free()) after
+freeing or modifying @string then the behaviour is undefined.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="regex">
+<parameter_description> a #GRegex structure from g_regex_new()
+</parameter_description>
+</parameter>
+<parameter name="string">
+<parameter_description> the string to scan for matches
+</parameter_description>
+</parameter>
+<parameter name="match_options">
+<parameter_description> match options
+</parameter_description>
+</parameter>
+<parameter name="match_info">
+<parameter_description> pointer to location where to store
+the #GMatchInfo, or %NULL if you do not need it
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE is the string matched, %FALSE otherwise
+
+</return>
+</function>
+
+<function name="g_regex_match_all_full">
+<description>
+Using the standard algorithm for regular expression matching only
+the longest match in the string is retrieved, it is not possibile
+to obtain all the available matches. For instance matching
+"<a> <b> <c>" against the pattern "<.*>"
+you get "<a> <b> <c>".
+
+This function uses a different algorithm (called DFA, i.e. deterministic
+finite automaton), so it can retrieve all the possible matches, all
+starting at the same point in the string. For instance matching
+"<a> <b> <c>" against the pattern "<.*>"
+you would obtain three matches: "<a> <b> <c>",
+"<a> <b>" and "<a>".
+
+The number of matched strings is retrieved using
+g_match_info_get_match_count(). To obtain the matched strings and
+their position you can use, respectively, g_match_info_fetch() and
+g_match_info_fetch_pos(). Note that the strings are returned in
+reverse order of length; that is, the longest matching string is
+given first.
+
+Note that the DFA algorithm is slower than the standard one and it
+is not able to capture substrings, so backreferences do not work.
+
+Setting @start_position differs from just passing over a shortened
+string and setting #G_REGEX_MATCH_NOTBOL in the case of a pattern
+that begins with any kind of lookbehind assertion, such as "\b".
+
+A #GMatchInfo structure, used to get information on the match, is
+stored in @match_info if not %NULL. Note that if @match_info is
+not %NULL then it is created even if the function returns %FALSE,
+i.e. you must free it regardless if regular expression actually
+matched.
+
+ string is not copied and is used in #GMatchInfo internally. If
+you use any #GMatchInfo method (except g_match_info_free()) after
+freeing or modifying @string then the behaviour is undefined.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="regex">
+<parameter_description> a #GRegex structure from g_regex_new()
+</parameter_description>
+</parameter>
+<parameter name="string">
+<parameter_description> the string to scan for matches
+</parameter_description>
+</parameter>
+<parameter name="string_len">
+<parameter_description> the length of @string, or -1 if @string is nul-terminated
+</parameter_description>
+</parameter>
+<parameter name="start_position">
+<parameter_description> starting index of the string to match
+</parameter_description>
+</parameter>
+<parameter name="match_options">
+<parameter_description> match options
+</parameter_description>
+</parameter>
+<parameter name="match_info">
+<parameter_description> pointer to location where to store
+the #GMatchInfo, or %NULL if you do not need it
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> location to store the error occuring, or %NULL to ignore errors
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE is the string matched, %FALSE otherwise
+
+</return>
+</function>
+
+<function name="g_regex_match_full">
+<description>
+Scans for a match in string for the pattern in @regex.
+The @match_options are combined with the match options specified
+when the @regex structure was created, letting you have more
+flexibility in reusing #GRegex structures.
+
+Setting @start_position differs from just passing over a shortened
+string and setting #G_REGEX_MATCH_NOTBOL in the case of a pattern
+that begins with any kind of lookbehind assertion, such as "\b".
+
+A #GMatchInfo structure, used to get information on the match, is
+stored in @match_info if not %NULL. Note that if @match_info is
+not %NULL then it is created even if the function returns %FALSE,
+i.e. you must free it regardless if regular expression actually
+matched.
+
+ string is not copied and is used in #GMatchInfo internally. If
+you use any #GMatchInfo method (except g_match_info_free()) after
+freeing or modifying @string then the behaviour is undefined.
+
+To retrieve all the non-overlapping matches of the pattern in
+string you can use g_match_info_next().
+
+|[
+static void
+print_uppercase_words (const gchar *string)
+{
+/ * Print all uppercase-only words. * /
+GRegex *regex;
+GMatchInfo *match_info;
+GError *error = NULL;
+ 
+regex = g_regex_new ("[A-Z]+", 0, 0, NULL);
+g_regex_match_full (regex, string, -1, 0, 0, &match_info, &error);
+while (g_match_info_matches (match_info))
+{
+gchar *word = g_match_info_fetch (match_info, 0);
+g_print ("Found: %s\n", word);
+g_free (word);
+g_match_info_next (match_info, &error);
+}
+g_match_info_free (match_info);
+g_regex_unref (regex);
+if (error != NULL)
+{
+g_printerr ("Error while matching: %s\n", error->message);
+g_error_free (error);
+}
+}
+]|
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="regex">
+<parameter_description> a #GRegex structure from g_regex_new()
+</parameter_description>
+</parameter>
+<parameter name="string">
+<parameter_description> the string to scan for matches
+</parameter_description>
+</parameter>
+<parameter name="string_len">
+<parameter_description> the length of @string, or -1 if @string is nul-terminated
+</parameter_description>
+</parameter>
+<parameter name="start_position">
+<parameter_description> starting index of the string to match
+</parameter_description>
+</parameter>
+<parameter name="match_options">
+<parameter_description> match options
+</parameter_description>
+</parameter>
+<parameter name="match_info">
+<parameter_description> pointer to location where to store
+the #GMatchInfo, or %NULL if you do not need it
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> location to store the error occuring, or %NULL to ignore errors
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE is the string matched, %FALSE otherwise
+
+</return>
+</function>
+
+<function name="g_regex_match_simple">
+<description>
+Scans for a match in @string for @pattern.
+
+This function is equivalent to g_regex_match() but it does not
+require to compile the pattern with g_regex_new(), avoiding some
+lines of code when you need just to do a match without extracting
+substrings, capture counts, and so on.
+
+If this function is to be called on the same @pattern more than
+once, it's more efficient to compile the pattern once with
+g_regex_new() and then use g_regex_match().
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="pattern">
+<parameter_description> the regular expression
+</parameter_description>
+</parameter>
+<parameter name="string">
+<parameter_description> the string to scan for matches
+</parameter_description>
+</parameter>
+<parameter name="compile_options">
+<parameter_description> compile options for the regular expression, or 0
+</parameter_description>
+</parameter>
+<parameter name="match_options">
+<parameter_description> match options, or 0
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the string matched, %FALSE otherwise
+
+</return>
+</function>
+
+<function name="g_regex_new">
+<description>
+Compiles the regular expression to an internal form, and does
+the initial setup of the #GRegex structure.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="pattern">
+<parameter_description> the regular expression
+</parameter_description>
+</parameter>
+<parameter name="compile_options">
+<parameter_description> compile options for the regular expression, or 0
+</parameter_description>
+</parameter>
+<parameter name="match_options">
+<parameter_description> match options for the regular expression, or 0
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError
+</parameter_description>
+</parameter>
+</parameters>
+<return> a #GRegex structure. Call g_regex_unref() when you
+are done with it
+
+</return>
+</function>
+
+<function name="g_regex_ref">
+<description>
+Increases reference count of @regex by 1.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="regex">
+<parameter_description> a #GRegex
+</parameter_description>
+</parameter>
+</parameters>
+<return> @regex
+
+</return>
+</function>
+
+<function name="g_regex_replace">
+<description>
+Replaces all occurrences of the pattern in @regex with the
+replacement text. Backreferences of the form '\number' or
+'\g<number>' in the replacement text are interpolated by the
+number-th captured subexpression of the match, '\g<name>' refers
+to the captured subexpression with the given name. '\0' refers to the
+complete match, but '\0' followed by a number is the octal representation
+of a character. To include a literal '\' in the replacement, write '\\'.
+There are also escapes that changes the case of the following text:
+
+<variablelist>
+<varlistentry><term>\l</term>
+<listitem>
+<para>Convert to lower case the next character</para>
+</listitem>
+</varlistentry>
+<varlistentry><term>\u</term>
+<listitem>
+<para>Convert to upper case the next character</para>
+</listitem>
+</varlistentry>
+<varlistentry><term>\L</term>
+<listitem>
+<para>Convert to lower case till \E</para>
+</listitem>
+</varlistentry>
+<varlistentry><term>\U</term>
+<listitem>
+<para>Convert to upper case till \E</para>
+</listitem>
+</varlistentry>
+<varlistentry><term>\E</term>
+<listitem>
+<para>End case modification</para>
+</listitem>
+</varlistentry>
+</variablelist>
+
+If you do not need to use backreferences use g_regex_replace_literal().
+
+The @replacement string must be UTF-8 encoded even if #G_REGEX_RAW was
+passed to g_regex_new(). If you want to use not UTF-8 encoded stings
+you can use g_regex_replace_literal().
+
+Setting @start_position differs from just passing over a shortened
+string and setting #G_REGEX_MATCH_NOTBOL in the case of a pattern that
+begins with any kind of lookbehind assertion, such as "\b".
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="regex">
+<parameter_description> a #GRegex structure
+</parameter_description>
+</parameter>
+<parameter name="string">
+<parameter_description> the string to perform matches against
+</parameter_description>
+</parameter>
+<parameter name="string_len">
+<parameter_description> the length of @string, or -1 if @string is nul-terminated
+</parameter_description>
+</parameter>
+<parameter name="start_position">
+<parameter_description> starting index of the string to match
+</parameter_description>
+</parameter>
+<parameter name="replacement">
+<parameter_description> text to replace each match with
+</parameter_description>
+</parameter>
+<parameter name="match_options">
+<parameter_description> options for the match
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> location to store the error occuring, or %NULL to ignore errors
+</parameter_description>
+</parameter>
+</parameters>
+<return> a newly allocated string containing the replacements
+
+</return>
+</function>
+
+<function name="g_regex_replace_eval">
+<description>
+Replaces occurrences of the pattern in regex with the output of
+ eval for that occurrence.
+
+Setting @start_position differs from just passing over a shortened
+string and setting #G_REGEX_MATCH_NOTBOL in the case of a pattern
+that begins with any kind of lookbehind assertion, such as "\b".
+
+The following example uses g_regex_replace_eval() to replace multiple
+strings at once:
+|[
+static gboolean
+eval_cb (const GMatchInfo *info,
+GString *res,
+gpointer data)
+{
+gchar *match;
+gchar *r;
+
+match = g_match_info_fetch (info, 0);
+r = g_hash_table_lookup ((GHashTable *)data, match);
+g_string_append (res, r);
+g_free (match);
+
+return FALSE;
+}
+
+/ * ... * /
+
+GRegex *reg;
+GHashTable *h;
+gchar *res;
+
+h = g_hash_table_new (g_str_hash, g_str_equal);
+
+g_hash_table_insert (h, "1", "ONE");
+g_hash_table_insert (h, "2", "TWO");
+g_hash_table_insert (h, "3", "THREE");
+g_hash_table_insert (h, "4", "FOUR");
+
+reg = g_regex_new ("1|2|3|4", 0, 0, NULL);
res = g_regex_replace_eval (reg, text, -1, 0, 0, eval_cb, h, NULL);
g_hash_table_destroy (h);
-/ * ... * /
-]|
+/ * ... * /
+]|
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="regex">
+<parameter_description> a #GRegex structure from g_regex_new()
+</parameter_description>
+</parameter>
+<parameter name="string">
+<parameter_description> string to perform matches against
+</parameter_description>
+</parameter>
+<parameter name="string_len">
+<parameter_description> the length of @string, or -1 if @string is nul-terminated
+</parameter_description>
+</parameter>
+<parameter name="start_position">
+<parameter_description> starting index of the string to match
+</parameter_description>
+</parameter>
+<parameter name="match_options">
+<parameter_description> options for the match
+</parameter_description>
+</parameter>
+<parameter name="eval">
+<parameter_description> a function to call for each match
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> user data to pass to the function
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> location to store the error occuring, or %NULL to ignore errors
+</parameter_description>
+</parameter>
+</parameters>
+<return> a newly allocated string containing the replacements
+
+</return>
+</function>
+
+<function name="g_regex_replace_literal">
+<description>
+Replaces all occurrences of the pattern in @regex with the
+replacement text. @replacement is replaced literally, to
+include backreferences use g_regex_replace().
+
+Setting @start_position differs from just passing over a
+shortened string and setting #G_REGEX_MATCH_NOTBOL in the
+case of a pattern that begins with any kind of lookbehind
+assertion, such as "\b".
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="regex">
+<parameter_description> a #GRegex structure
+</parameter_description>
+</parameter>
+<parameter name="string">
+<parameter_description> the string to perform matches against
+</parameter_description>
+</parameter>
+<parameter name="string_len">
+<parameter_description> the length of @string, or -1 if @string is nul-terminated
+</parameter_description>
+</parameter>
+<parameter name="start_position">
+<parameter_description> starting index of the string to match
+</parameter_description>
+</parameter>
+<parameter name="replacement">
+<parameter_description> text to replace each match with
+</parameter_description>
+</parameter>
+<parameter name="match_options">
+<parameter_description> options for the match
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> location to store the error occuring, or %NULL to ignore errors
+</parameter_description>
+</parameter>
+</parameters>
+<return> a newly allocated string containing the replacements
+
+</return>
+</function>
+
+<function name="g_regex_split">
+<description>
+Breaks the string on the pattern, and returns an array of the tokens.
+If the pattern contains capturing parentheses, then the text for each
+of the substrings will also be returned. If the pattern does not match
+anywhere in the string, then the whole string is returned as the first
+token.
+
+As a special case, the result of splitting the empty string "" is an
+empty vector, not a vector containing a single string. The reason for
+this special case is that being able to represent a empty vector is
+typically more useful than consistent handling of empty elements. If
+you do need to represent empty elements, you'll need to check for the
+empty string before calling this function.
+
+A pattern that can match empty strings splits @string into separate
+characters wherever it matches the empty string between characters.
+For example splitting "ab c" using as a separator "\s*", you will get
+"a", "b" and "c".
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="regex">
+<parameter_description> a #GRegex structure
+</parameter_description>
+</parameter>
+<parameter name="string">
+<parameter_description> the string to split with the pattern
+</parameter_description>
+</parameter>
+<parameter name="match_options">
+<parameter_description> match time option flags
+</parameter_description>
+</parameter>
+</parameters>
+<return> a %NULL-terminated gchar ** array. Free it using g_strfreev()
+
+</return>
+</function>
+
+<function name="g_regex_split_full">
+<description>
+Breaks the string on the pattern, and returns an array of the tokens.
+If the pattern contains capturing parentheses, then the text for each
+of the substrings will also be returned. If the pattern does not match
+anywhere in the string, then the whole string is returned as the first
+token.
+
+As a special case, the result of splitting the empty string "" is an
+empty vector, not a vector containing a single string. The reason for
+this special case is that being able to represent a empty vector is
+typically more useful than consistent handling of empty elements. If
+you do need to represent empty elements, you'll need to check for the
+empty string before calling this function.
+
+A pattern that can match empty strings splits @string into separate
+characters wherever it matches the empty string between characters.
+For example splitting "ab c" using as a separator "\s*", you will get
+"a", "b" and "c".
+
+Setting @start_position differs from just passing over a shortened
+string and setting #G_REGEX_MATCH_NOTBOL in the case of a pattern
+that begins with any kind of lookbehind assertion, such as "\b".
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="regex">
+<parameter_description> a #GRegex structure
+</parameter_description>
+</parameter>
+<parameter name="string">
+<parameter_description> the string to split with the pattern
+</parameter_description>
+</parameter>
+<parameter name="string_len">
+<parameter_description> the length of @string, or -1 if @string is nul-terminated
+</parameter_description>
+</parameter>
+<parameter name="start_position">
+<parameter_description> starting index of the string to match
+</parameter_description>
+</parameter>
+<parameter name="match_options">
+<parameter_description> match time option flags
+</parameter_description>
+</parameter>
+<parameter name="max_tokens">
+<parameter_description> the maximum number of tokens to split @string into.
+If this is less than 1, the string is split completely
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError
+</parameter_description>
+</parameter>
+</parameters>
+<return> a %NULL-terminated gchar ** array. Free it using g_strfreev()
+
+</return>
+</function>
+
+<function name="g_regex_split_simple">
+<description>
+Breaks the string on the pattern, and returns an array of
+the tokens. If the pattern contains capturing parentheses,
+then the text for each of the substrings will also be returned.
+If the pattern does not match anywhere in the string, then the
+whole string is returned as the first token.
+
+This function is equivalent to g_regex_split() but it does
+not require to compile the pattern with g_regex_new(), avoiding
+some lines of code when you need just to do a split without
+extracting substrings, capture counts, and so on.
+
+If this function is to be called on the same @pattern more than
+once, it's more efficient to compile the pattern once with
+g_regex_new() and then use g_regex_split().
+
+As a special case, the result of splitting the empty string ""
+is an empty vector, not a vector containing a single string.
+The reason for this special case is that being able to represent
+a empty vector is typically more useful than consistent handling
+of empty elements. If you do need to represent empty elements,
+you'll need to check for the empty string before calling this
+function.
+
+A pattern that can match empty strings splits @string into
+separate characters wherever it matches the empty string between
+characters. For example splitting "ab c" using as a separator
+"\s*", you will get "a", "b" and "c".
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="pattern">
+<parameter_description> the regular expression
+</parameter_description>
+</parameter>
+<parameter name="string">
+<parameter_description> the string to scan for matches
+</parameter_description>
+</parameter>
+<parameter name="compile_options">
+<parameter_description> compile options for the regular expression, or 0
+</parameter_description>
+</parameter>
+<parameter name="match_options">
+<parameter_description> match options, or 0
+</parameter_description>
+</parameter>
+</parameters>
+<return> a %NULL-terminated array of strings. Free it using g_strfreev()
+
+</return>
+</function>
+
+<function name="g_regex_unref">
+<description>
+Decreases reference count of @regex by 1. When reference count drops
+to zero, it frees all the memory associated with the regex structure.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="regex">
+<parameter_description> a #GRegex
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_relation_count">
+<description>
+Returns the number of tuples in a #GRelation that have the given
+value in the given field.
+
+Deprecated: 2.26: Rarely used API
+
+</description>
+<parameters>
+<parameter name="relation">
+<parameter_description> a #GRelation.
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> the value to compare with.
+</parameter_description>
+</parameter>
+<parameter name="field">
+<parameter_description> the field of each record to match.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the number of matches.
+</return>
+</function>
+
+<function name="g_relation_delete">
+<description>
+Deletes any records from a #GRelation that have the given key value
+in the given field.
+
+Deprecated: 2.26: Rarely used API
+
+</description>
+<parameters>
+<parameter name="relation">
+<parameter_description> a #GRelation.
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> the value to compare with.
+</parameter_description>
+</parameter>
+<parameter name="field">
+<parameter_description> the field of each record to match.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the number of records deleted.
+</return>
+</function>
+
+<function name="g_relation_destroy">
+<description>
+Destroys the #GRelation, freeing all memory allocated. However, it
+does not free memory allocated for the tuple data, so you should
+free that first if appropriate.
+
+Deprecated: 2.26: Rarely used API
+
+</description>
+<parameters>
+<parameter name="relation">
+<parameter_description> a #GRelation.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_relation_exists">
+<description>
+Returns %TRUE if a record with the given values exists in a
+#GRelation. Note that the values are compared directly, so that, for
+example, two copies of the same string will not match.
+
+Deprecated: 2.26: Rarely used API
+
+</description>
+<parameters>
+<parameter name="relation">
+<parameter_description> a #GRelation.
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> the fields of the record to compare. The number must match
+the number of fields in the #GRelation.
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if a record matches.
+</return>
+</function>
+
+<function name="g_relation_index">
+<description>
+Creates an index on the given field. Note that this must be called
+before any records are added to the #GRelation.
+
+Deprecated: 2.26: Rarely used API
+
+</description>
+<parameters>
+<parameter name="relation">
+<parameter_description> a #GRelation.
+</parameter_description>
+</parameter>
+<parameter name="field">
+<parameter_description> the field to index, counting from 0.
+</parameter_description>
+</parameter>
+<parameter name="hash_func">
+<parameter_description> a function to produce a hash value from the field data.
+</parameter_description>
+</parameter>
+<parameter name="key_equal_func">
+<parameter_description> a function to compare two values of the given field.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_relation_insert">
+<description>
+Inserts a record into a #GRelation.
+
+Deprecated: 2.26: Rarely used API
+
+</description>
+<parameters>
+<parameter name="relation">
+<parameter_description> a #GRelation.
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> the fields of the record to add. These must match the
+number of fields in the #GRelation, and of type #gpointer
+or #gconstpointer.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_relation_new">
+<description>
+Creates a new #GRelation with the given number of fields. Note that
+currently the number of fields must be 2.
+
+Deprecated: 2.26: Rarely used API
+
+</description>
+<parameters>
+<parameter name="fields">
+<parameter_description> the number of fields.
+</parameter_description>
+</parameter>
+</parameters>
+<return> a new #GRelation.
+</return>
+</function>
+
+<function name="g_relation_print">
+<description>
+Outputs information about all records in a #GRelation, as well as
+the indexes. It is for debugging.
+
+Deprecated: 2.26: Rarely used API
+
+</description>
+<parameters>
+<parameter name="relation">
+<parameter_description> a #GRelation.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_relation_select">
+<description>
+Returns all of the tuples which have the given key in the given
+field. Use g_tuples_index() to access the returned records. The
+returned records should be freed with g_tuples_destroy().
+
+Deprecated: 2.26: Rarely used API
+
+</description>
+<parameters>
+<parameter name="relation">
+<parameter_description> a #GRelation.
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> the value to compare with.
+</parameter_description>
+</parameter>
+<parameter name="field">
+<parameter_description> the field of each record to match.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the records (tuples) that matched.
+</return>
+</function>
+
+<function name="g_reload_user_special_dirs_cache">
+<description>
+Resets the cache used for g_get_user_special_dir(), so
+that the latest on-disk version is used. Call this only
+if you just changed the data on disk yourself.
+
+Due to threadsafety issues this may cause leaking of strings
+that were previously returned from g_get_user_special_dir()
+that can't be freed. We ensure to only leak the data for
+the directories that actually changed value though.
+
+Since: 2.22
+
+</description>
+<parameters>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_remove">
+<description>
+A wrapper for the POSIX remove() function. The remove() function
+deletes a name from the filesystem.
+
+See your C library manual for more details about how remove() works
+on your system. On Unix, remove() removes also directories, as it
+calls unlink() for files and rmdir() for directories. On Windows,
+although remove() in the C library only works for files, this
+function tries first remove() and then if that fails rmdir(), and
+thus works for both files and directories. Note however, that on
+Windows, it is in general not possible to remove a file that is
+open to some process, or mapped into memory.
+
+If this function fails on Windows you can't infer too much from the
+errno value. rmdir() is tried regardless of what caused remove() to
+fail. Any errno value set by remove() will be overwritten by that
+set by rmdir().
+
+Since: 2.6
+
+</description>
+<parameters>
+<parameter name="filename">
+<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows)
+</parameter_description>
+</parameter>
+</parameters>
+<return> 0 if the file was successfully removed, -1 if an error
+occurred
+
+</return>
+</function>
+
+<function name="g_rename">
+<description>
+A wrapper for the POSIX rename() function. The rename() function
+renames a file, moving it between directories if required.
+
+See your C library manual for more details about how rename() works
+on your system. It is not possible in general on Windows to rename
+a file that is open to some process.
+
+Since: 2.6
+
+</description>
+<parameters>
+<parameter name="oldfilename">
+<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows)
+</parameter_description>
+</parameter>
+<parameter name="newfilename">
+<parameter_description> a pathname in the GLib file name encoding
+</parameter_description>
+</parameter>
+</parameters>
+<return> 0 if the renaming succeeded, -1 if an error occurred
+
+</return>
+</function>
+
+<function name="g_rmdir">
+<description>
+A wrapper for the POSIX rmdir() function. The rmdir() function
+deletes a directory from the filesystem.
+
+See your C library manual for more details about how rmdir() works
+on your system.
+
+Since: 2.6
+
+</description>
+<parameters>
+<parameter name="filename">
+<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows)
+</parameter_description>
+</parameter>
+</parameters>
+<return> 0 if the directory was successfully removed, -1 if an error
+occurred
+
+</return>
+</function>
+
+<function name="g_sequence_append">
+<description>
+Adds a new item to the end of @seq.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="seq">
+<parameter_description> a #GSequence
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> the data for the new item
+</parameter_description>
+</parameter>
+</parameters>
+<return> an iterator pointing to the new item
+
+</return>
+</function>
+
+<function name="g_sequence_foreach">
+<description>
+Calls @func for each item in the sequence passing @user_data
+to the function.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="seq">
+<parameter_description> a #GSequence
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> the function to call for each item in @seq
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> user data passed to @func
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_sequence_foreach_range">
+<description>
+Calls @func for each item in the range (@begin, @end) passing
+ user_data to the function.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="begin">
+<parameter_description> a #GSequenceIter
+</parameter_description>
+</parameter>
+<parameter name="end">
+<parameter_description> a #GSequenceIter
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> a #GFunc
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> user data passed to @func
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_sequence_free">
+<description>
+Frees the memory allocated for @seq. If @seq has a data destroy
+function associated with it, that function is called on all items in
+ seq
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="seq">
+<parameter_description> a #GSequence
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_sequence_get">
+<description>
+Returns the data that @iter points to.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="iter">
+<parameter_description> a #GSequenceIter
+</parameter_description>
+</parameter>
+</parameters>
+<return> the data that @iter points to
+
+</return>
+</function>
+
+<function name="g_sequence_get_begin_iter">
+<description>
+Returns the begin iterator for @seq.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="seq">
+<parameter_description> a #GSequence
+</parameter_description>
+</parameter>
+</parameters>
+<return> the begin iterator for @seq.
+
+</return>
+</function>
+
+<function name="g_sequence_get_end_iter">
+<description>
+Returns the end iterator for @seg
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="seq">
+<parameter_description> a #GSequence
+</parameter_description>
+</parameter>
+</parameters>
+<return> the end iterator for @seq
+
+</return>
+</function>
+
+<function name="g_sequence_get_iter_at_pos">
+<description>
+Returns the iterator at position @pos. If @pos is negative or larger
+than the number of items in @seq, the end iterator is returned.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="seq">
+<parameter_description> a #GSequence
+</parameter_description>
+</parameter>
+<parameter name="pos">
+<parameter_description> a position in @seq, or -1 for the end.
+</parameter_description>
+</parameter>
+</parameters>
+<return> The #GSequenceIter at position @pos
+
+</return>
+</function>
+
+<function name="g_sequence_get_length">
+<description>
+Returns the length of @seq
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="seq">
+<parameter_description> a #GSequence
+</parameter_description>
+</parameter>
+</parameters>
+<return> the length of @seq
+
+</return>
+</function>
+
+<function name="g_sequence_insert_before">
+<description>
+Inserts a new item just before the item pointed to by @iter.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="iter">
+<parameter_description> a #GSequenceIter
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> the data for the new item
+</parameter_description>
+</parameter>
+</parameters>
+<return> an iterator pointing to the new item
+
+</return>
+</function>
+
+<function name="g_sequence_insert_sorted">
+<description>
+Inserts @data into @sequence using @func to determine the new
+position. The sequence must already be sorted according to @cmp_func;
+otherwise the new position of @data is undefined.
+
+ cmp_func is called with two items of the @seq and @user_data.
+It should return 0 if the items are equal, a negative value
+if the first item comes before the second, and a positive value
+if the second item comes before the first.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="seq">
+<parameter_description> a #GSequence
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> the data to insert
+</parameter_description>
+</parameter>
+<parameter name="cmp_func">
+<parameter_description> the function used to compare items in the sequence
+</parameter_description>
+</parameter>
+<parameter name="cmp_data">
+<parameter_description> user data passed to @cmp_func.
+</parameter_description>
+</parameter>
+</parameters>
+<return> a #GSequenceIter pointing to the new item.
+
+</return>
+</function>
+
+<function name="g_sequence_insert_sorted_iter">
+<description>
+Like g_sequence_insert_sorted(), but uses
+a #GSequenceIterCompareFunc instead of a #GCompareDataFunc as
+the compare function.
+
+ iter_cmp is called with two iterators pointing into @seq.
+It should return 0 if the iterators are equal, a negative
+value if the first iterator comes before the second, and a
+positive value if the second iterator comes before the first.
+
+It is called with two iterators pointing into @seq. It should
+return 0 if the iterators are equal, a negative value if the
+first iterator comes before the second, and a positive value
+if the second iterator comes before the first.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="seq">
+<parameter_description> a #GSequence
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> data for the new item
+</parameter_description>
+</parameter>
+<parameter name="iter_cmp">
+<parameter_description> the function used to compare iterators in the sequence
+</parameter_description>
+</parameter>
+<parameter name="cmp_data">
+<parameter_description> user data passed to @cmp_func
+</parameter_description>
+</parameter>
+</parameters>
+<return> a #GSequenceIter pointing to the new item
+
+</return>
+</function>
+
+<function name="g_sequence_iter_compare">
+<description>
+Returns a negative number if @a comes before @b, 0 if they are equal,
+and a positive number if @a comes after @b.
+
+The @a and @b iterators must point into the same sequence.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="a">
+<parameter_description> a #GSequenceIter
+</parameter_description>
+</parameter>
+<parameter name="b">
+<parameter_description> a #GSequenceIter
+</parameter_description>
+</parameter>
+</parameters>
+<return> A negative number if @a comes before @b, 0 if they are
+equal, and a positive number if @a comes after @b.
+
+</return>
+</function>
+
+<function name="g_sequence_iter_get_position">
+<description>
+Returns the position of @iter
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="iter">
+<parameter_description> a #GSequenceIter
+</parameter_description>
+</parameter>
+</parameters>
+<return> the position of @iter
+
+</return>
+</function>
+
+<function name="g_sequence_iter_get_sequence">
+<description>
+Returns the #GSequence that @iter points into.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="iter">
+<parameter_description> a #GSequenceIter
+</parameter_description>
+</parameter>
+</parameters>
+<return> the #GSequence that @iter points into.
+
+</return>
+</function>
+
+<function name="g_sequence_iter_is_begin">
+<description>
+Returns whether @iter is the begin iterator
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="iter">
+<parameter_description> a #GSequenceIter
+</parameter_description>
+</parameter>
+</parameters>
+<return> whether @iter is the begin iterator
+
+</return>
+</function>
+
+<function name="g_sequence_iter_is_end">
+<description>
+Returns whether @iter is the end iterator
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="iter">
+<parameter_description> a #GSequenceIter
+</parameter_description>
+</parameter>
+</parameters>
+<return> Whether @iter is the end iterator.
+
+</return>
+</function>
+
+<function name="g_sequence_iter_move">
+<description>
+Returns the #GSequenceIter which is @delta positions away from @iter.
+If @iter is closer than - delta positions to the beginning of the sequence,
+the begin iterator is returned. If @iter is closer than @delta positions
+to the end of the sequence, the end iterator is returned.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="iter">
+<parameter_description> a #GSequenceIter
+</parameter_description>
+</parameter>
+<parameter name="delta">
+<parameter_description> A positive or negative number indicating how many positions away
+from @iter the returned #GSequenceIter will be.
+</parameter_description>
+</parameter>
+</parameters>
+<return> a #GSequenceIter which is @delta positions away from @iter.
+
+</return>
+</function>
+
+<function name="g_sequence_iter_next">
+<description>
+Returns an iterator pointing to the next position after @iter. If
+ iter is the end iterator, the end iterator is returned.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="iter">
+<parameter_description> a #GSequenceIter
+</parameter_description>
+</parameter>
+</parameters>
+<return> a #GSequenceIter pointing to the next position after @iter.
+
+</return>
+</function>
+
+<function name="g_sequence_iter_prev">
+<description>
+Returns an iterator pointing to the previous position before @iter. If
+ iter is the begin iterator, the begin iterator is returned.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="iter">
+<parameter_description> a #GSequenceIter
+</parameter_description>
+</parameter>
+</parameters>
+<return> a #GSequenceIter pointing to the previous position before
+ iter
+
+</return>
+</function>
+
+<function name="g_sequence_lookup">
+<description>
+Returns an iterator pointing to the position of the first item found
+equal to @data according to @cmp_func and @cmp_data. If more than one
+item is equal, it is not guaranteed that it is the first which is
+returned. In that case, you can use g_sequence_iter_next() and
+g_sequence_iter_prev() to get others.
+
+ cmp_func is called with two items of the @seq and @user_data.
+It should return 0 if the items are equal, a negative value if
+the first item comes before the second, and a positive value if
+the second item comes before the first.
+
+Since: 2.28
+
+</description>
+<parameters>
+<parameter name="seq">
+<parameter_description> a #GSequence
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> data to lookup
+</parameter_description>
+</parameter>
+<parameter name="cmp_func">
+<parameter_description> the function used to compare items in the sequence
+</parameter_description>
+</parameter>
+<parameter name="cmp_data">
+<parameter_description> user data passed to @cmp_func.
+</parameter_description>
+</parameter>
+</parameters>
+<return> an #GSequenceIter pointing to the position of the
+first item found equal to @data according to @cmp_func and @cmp_data.
+
+</return>
+</function>
+
+<function name="g_sequence_lookup_iter">
+<description>
+Like g_sequence_lookup(), but uses a #GSequenceIterCompareFunc
+instead of a #GCompareDataFunc as the compare function.
+
+ iter_cmp is called with two iterators pointing into @seq.
+It should return 0 if the iterators are equal, a negative value
+if the first iterator comes before the second, and a positive
+value if the second iterator comes before the first.
+
+Since: 2.28
+
+</description>
+<parameters>
+<parameter name="seq">
+<parameter_description> a #GSequence
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> data to lookup
+</parameter_description>
+</parameter>
+<parameter name="iter_cmp">
+<parameter_description> the function used to compare iterators in the sequence
+</parameter_description>
+</parameter>
+<parameter name="cmp_data">
+<parameter_description> user data passed to @iter_cmp
+</parameter_description>
+</parameter>
+</parameters>
+<return> an #GSequenceIter pointing to the position of
+the first item found equal to @data according to @cmp_func
+and @cmp_data.
+
+</return>
+</function>
+
+<function name="g_sequence_move">
+<description>
+Moves the item pointed to by @src to the position indicated by @dest.
+After calling this function @dest will point to the position immediately
+after @src. It is allowed for @src and @dest to point into different
+sequences.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="src">
+<parameter_description> a #GSequenceIter pointing to the item to move
+</parameter_description>
+</parameter>
+<parameter name="dest">
+<parameter_description> a #GSequenceIter pointing to the position to which
+the item is moved.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_sequence_move_range">
+<description>
+Inserts the (@begin, @end) range at the destination pointed to by ptr.
+The @begin and @end iters must point into the same sequence. It is
+allowed for @dest to point to a different sequence than the one pointed
+into by @begin and @end.
+
+If @dest is NULL, the range indicated by @begin and @end is
+removed from the sequence. If @dest iter points to a place within
+the (@begin, @end) range, the range does not move.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="dest">
+<parameter_description> a #GSequenceIter
+</parameter_description>
+</parameter>
+<parameter name="begin">
+<parameter_description> a #GSequenceIter
+</parameter_description>
+</parameter>
+<parameter name="end">
+<parameter_description> a #GSequenceIter
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_sequence_new">
+<description>
+Creates a new GSequence. The @data_destroy function, if non-%NULL will
+be called on all items when the sequence is destroyed and on items that
+are removed from the sequence.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="data_destroy">
+<parameter_description> a #GDestroyNotify function, or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return> a new #GSequence
+
+</return>
+</function>
+
+<function name="g_sequence_prepend">
+<description>
+Adds a new item to the front of @seq
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="seq">
+<parameter_description> a #GSequence
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> the data for the new item
+</parameter_description>
+</parameter>
+</parameters>
+<return> an iterator pointing to the new item
+
+</return>
+</function>
+
+<function name="g_sequence_range_get_midpoint">
+<description>
+Finds an iterator somewhere in the range (@begin, @end). This
+iterator will be close to the middle of the range, but is not
+guaranteed to be <emphasis>exactly</emphasis> in the middle.
+
+The @begin and @end iterators must both point to the same sequence and
+ begin must come before or be equal to @end in the sequence.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="begin">
+<parameter_description> a #GSequenceIter
+</parameter_description>
+</parameter>
+<parameter name="end">
+<parameter_description> a #GSequenceIter
+</parameter_description>
+</parameter>
+</parameters>
+<return> A #GSequenceIter pointing somewhere in the
+(@begin, @end) range.
+
+</return>
+</function>
+
+<function name="g_sequence_remove">
+<description>
+Removes the item pointed to by @iter. It is an error to pass the
+end iterator to this function.
+
+If the sequnce has a data destroy function associated with it, this
+function is called on the data for the removed item.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="iter">
+<parameter_description> a #GSequenceIter
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_sequence_remove_range">
+<description>
+Removes all items in the (@begin, @end) range.
+
+If the sequence has a data destroy function associated with it, this
+function is called on the data for the removed items.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="begin">
+<parameter_description> a #GSequenceIter
+</parameter_description>
+</parameter>
+<parameter name="end">
+<parameter_description> a #GSequenceIter
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_sequence_search">
+<description>
+Returns an iterator pointing to the position where @data would
+be inserted according to @cmp_func and @cmp_data.
+
+ cmp_func is called with two items of the @seq and @user_data.
+It should return 0 if the items are equal, a negative value if
+the first item comes before the second, and a positive value if
+the second item comes before the first.
+
+If you are simply searching for an existing element of the sequence,
+consider using g_sequence_lookup().
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="seq">
+<parameter_description> a #GSequence
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> data for the new item
+</parameter_description>
+</parameter>
+<parameter name="cmp_func">
+<parameter_description> the function used to compare items in the sequence
+</parameter_description>
+</parameter>
+<parameter name="cmp_data">
+<parameter_description> user data passed to @cmp_func.
+</parameter_description>
+</parameter>
+</parameters>
+<return> an #GSequenceIter pointing to the position where @data
+would have been inserted according to @cmp_func and @cmp_data.
+
+</return>
+</function>
+
+<function name="g_sequence_search_iter">
+<description>
+Like g_sequence_search(), but uses a #GSequenceIterCompareFunc
+instead of a #GCompareDataFunc as the compare function.
+
+ iter_cmp is called with two iterators pointing into @seq.
+It should return 0 if the iterators are equal, a negative value
+if the first iterator comes before the second, and a positive
+value if the second iterator comes before the first.
+
+If you are simply searching for an existing element of the sequence,
+consider using g_sequence_lookup_iter().
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="seq">
+<parameter_description> a #GSequence
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> data for the new item
+</parameter_description>
+</parameter>
+<parameter name="iter_cmp">
+<parameter_description> the function used to compare iterators in the sequence
+</parameter_description>
+</parameter>
+<parameter name="cmp_data">
+<parameter_description> user data passed to @iter_cmp
+</parameter_description>
+</parameter>
+</parameters>
+<return> a #GSequenceIter pointing to the position in @seq
+where @data would have been inserted according to @iter_cmp
+and @cmp_data.
+
+</return>
+</function>
+
+<function name="g_sequence_set">
+<description>
+Changes the data for the item pointed to by @iter to be @data. If
+the sequence has a data destroy function associated with it, that
+function is called on the existing data that @iter pointed to.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="iter">
+<parameter_description> a #GSequenceIter
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> new data for the item
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_sequence_sort">
+<description>
+Sorts @seq using @cmp_func.
+
+ cmp_func is passed two items of @seq and should
+return 0 if they are equal, a negative value if the
+first comes before the second, and a positive value
+if the second comes before the first.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="seq">
+<parameter_description> a #GSequence
+</parameter_description>
+</parameter>
+<parameter name="cmp_func">
+<parameter_description> the function used to sort the sequence
+</parameter_description>
+</parameter>
+<parameter name="cmp_data">
+<parameter_description> user data passed to @cmp_func
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_sequence_sort_changed">
+<description>
+Moves the data pointed to a new position as indicated by @cmp_func. This
+function should be called for items in a sequence already sorted according
+to @cmp_func whenever some aspect of an item changes so that @cmp_func
+may return different values for that item.
+
+ cmp_func is called with two items of the @seq and @user_data.
+It should return 0 if the items are equal, a negative value if
+the first item comes before the second, and a positive value if
+the second item comes before the first.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="iter">
+<parameter_description> A #GSequenceIter
+</parameter_description>
+</parameter>
+<parameter name="cmp_func">
+<parameter_description> the function used to compare items in the sequence
+</parameter_description>
+</parameter>
+<parameter name="cmp_data">
+<parameter_description> user data passed to @cmp_func.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_sequence_sort_changed_iter">
+<description>
+Like g_sequence_sort_changed(), but uses
+a #GSequenceIterCompareFunc instead of a #GCompareDataFunc as
+the compare function.
+
+ iter_cmp is called with two iterators pointing into @seq. It should
+return 0 if the iterators are equal, a negative value if the first
+iterator comes before the second, and a positive value if the second
+iterator comes before the first.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="iter">
+<parameter_description> a #GSequenceIter
+</parameter_description>
+</parameter>
+<parameter name="iter_cmp">
+<parameter_description> the function used to compare iterators in the sequence
+</parameter_description>
+</parameter>
+<parameter name="cmp_data">
+<parameter_description> user data passed to @cmp_func
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_sequence_sort_iter">
+<description>
+Like g_sequence_sort(), but uses a #GSequenceIterCompareFunc instead
+of a GCompareDataFunc as the compare function
+
+ cmp_func is called with two iterators pointing into @seq. It should
+return 0 if the iterators are equal, a negative value if the first
+iterator comes before the second, and a positive value if the second
+iterator comes before the first.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="seq">
+<parameter_description> a #GSequence
+</parameter_description>
+</parameter>
+<parameter name="cmp_func">
+<parameter_description> the function used to compare iterators in the sequence
+</parameter_description>
+</parameter>
+<parameter name="cmp_data">
+<parameter_description> user data passed to @cmp_func
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_sequence_swap">
+<description>
+Swaps the items pointed to by @a and @b. It is allowed for @a and @b
+to point into difference sequences.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="a">
+<parameter_description> a #GSequenceIter
+</parameter_description>
+</parameter>
+<parameter name="b">
+<parameter_description> a #GSequenceIter
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_set_application_name">
+<description>
+Sets a human-readable name for the application. This name should be
+localized if possible, and is intended for display to the user.
+Contrast with g_set_prgname(), which sets a non-localized name.
+g_set_prgname() will be called automatically by gtk_init(),
+but g_set_application_name() will not.
+
+Note that for thread safety reasons, this function can only
+be called once.
+
+The application name will be used in contexts such as error messages,
+or when displaying an application's name in the task list.
+
+Since: 2.2
+
+</description>
+<parameters>
+<parameter name="application_name">
+<parameter_description> localized name of the application
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_set_error">
+<description>
+Does nothing if @err is %NULL; if @err is non-%NULL, then * err
+must be %NULL. A new #GError is created and assigned to * err
+
+</description>
+<parameters>
+<parameter name="err">
+<parameter_description> a return location for a #GError, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="domain">
+<parameter_description> error domain
+</parameter_description>
+</parameter>
+<parameter name="code">
+<parameter_description> error code
+</parameter_description>
+</parameter>
+<parameter name="format">
+<parameter_description> printf()-style format
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> args for @format
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_set_error_literal">
+<description>
+Does nothing if @err is %NULL; if @err is non-%NULL, then * err
+must be %NULL. A new #GError is created and assigned to * err
+Unlike g_set_error(), @message is not a printf()-style format string.
+Use this function if @message contains text you don't have control over,
+that could include printf() escape sequences.
+
+Since: 2.18
+
+</description>
+<parameters>
+<parameter name="err">
+<parameter_description> a return location for a #GError, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="domain">
+<parameter_description> error domain
+</parameter_description>
+</parameter>
+<parameter name="code">
+<parameter_description> error code
+</parameter_description>
+</parameter>
+<parameter name="message">
+<parameter_description> error message
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_set_prgname">
+<description>
+Sets the name of the program. This name should <emphasis>not</emphasis>
+be localized, contrast with g_set_application_name(). Note that for
+thread-safety reasons this function can only be called once.
+
+</description>
+<parameters>
+<parameter name="prgname">
+<parameter_description> the name of the program.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_setenv">
+<description>
+Sets an environment variable. Both the variable's name and value
+should be in the GLib file name encoding. On UNIX, this means that
+they can be any sequence of bytes. On Windows, they should be in
+UTF-8.
+
+Note that on some systems, when variables are overwritten, the memory
+used for the previous variables and its value isn't reclaimed.
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="variable">
+<parameter_description> the environment variable to set, must not contain '='.
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> the value for to set the variable to.
+</parameter_description>
+</parameter>
+<parameter name="overwrite">
+<parameter_description> whether to change the variable if it already exists.
+</parameter_description>
+</parameter>
+</parameters>
+<return> %FALSE if the environment variable couldn't be set.
+
+</return>
+</function>
+
+<function name="g_shell_parse_argv">
+<description>
+Parses a command line into an argument vector, in much the same way
+the shell would, but without many of the expansions the shell would
+perform (variable expansion, globs, operators, filename expansion,
+etc. are not supported). The results are defined to be the same as
+those you would get from a UNIX98 /bin/sh, as long as the input
+contains none of the unsupported shell expansions. If the input
+does contain such expansions, they are passed through
+literally. Possible errors are those from the #G_SHELL_ERROR
+domain. Free the returned vector with g_strfreev().
+
+
+</description>
+<parameters>
+<parameter name="command_line">
+<parameter_description> command line to parse
+</parameter_description>
+</parameter>
+<parameter name="argcp">
+<parameter_description> return location for number of args
+</parameter_description>
+</parameter>
+<parameter name="argvp">
+<parameter_description> return location for array of args
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for error
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE on success, %FALSE if error set
+</return>
+</function>
+
+<function name="g_shell_quote">
+<description>
+Quotes a string so that the shell (/bin/sh) will interpret the
+quoted string to mean @unquoted_string. If you pass a filename to
+the shell, for example, you should first quote it with this
+function. The return value must be freed with g_free(). The
+quoting style used is undefined (single or double quotes may be
+used).
+
+
+</description>
+<parameters>
+<parameter name="unquoted_string">
+<parameter_description> a literal string
+</parameter_description>
+</parameter>
+</parameters>
+<return> quoted string
+</return>
+</function>
+
+<function name="g_shell_unquote">
+<description>
+Unquotes a string as the shell (/bin/sh) would. Only handles
+quotes; if a string contains file globs, arithmetic operators,
+variables, backticks, redirections, or other special-to-the-shell
+features, the result will be different from the result a real shell
+would produce (the variables, backticks, etc. will be passed
+through literally instead of being expanded). This function is
+guaranteed to succeed if applied to the result of
+g_shell_quote(). If it fails, it returns %NULL and sets the
+error. The @quoted_string need not actually contain quoted or
+escaped text; g_shell_unquote() simply goes through the string and
+unquotes/unescapes anything that the shell would. Both single and
+double quotes are handled, as are escapes including escaped
+newlines. The return value must be freed with g_free(). Possible
+errors are in the #G_SHELL_ERROR domain.
+
+Shell quoting rules are a bit strange. Single quotes preserve the
+literal string exactly. escape sequences are not allowed; not even
+\' - if you want a ' in the quoted text, you have to do something
+like 'foo'\''bar'. Double quotes allow $, `, ", \, and newline to
+be escaped with backslash. Otherwise double quotes preserve things
+literally.
+
+
+</description>
+<parameters>
+<parameter name="quoted_string">
+<parameter_description> shell-quoted string
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> error return location or NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return> an unquoted string
+</return>
+</function>
+
+<function name="g_signal_accumulator_first_wins">
+<description>
+A predefined #GSignalAccumulator for signals intended to be used as a
+hook for application code to provide a particular value. Usually
+only one such value is desired and multiple handlers for the same
+signal don't make much sense (except for the case of the default
+handler defined in the class structure, in which case you will
+usually want the signal connection to override the class handler).
+
+This accumulator will use the return value from the first signal
+handler that is run as the return value for the signal and not run
+any further handlers (ie: the first handler "wins").
+
+Since: 2.28
+
+</description>
+<parameters>
+<parameter name="ihint">
+<parameter_description> standard #GSignalAccumulator parameter
+</parameter_description>
+</parameter>
+<parameter name="return_accu">
+<parameter_description> standard #GSignalAccumulator parameter
+</parameter_description>
+</parameter>
+<parameter name="handler_return">
+<parameter_description> standard #GSignalAccumulator parameter
+</parameter_description>
+</parameter>
+<parameter name="dummy">
+<parameter_description> standard #GSignalAccumulator parameter
+</parameter_description>
+</parameter>
+</parameters>
+<return> standard #GSignalAccumulator result
+
+</return>
+</function>
+
+<function name="g_signal_accumulator_true_handled">
+<description>
+A predefined #GSignalAccumulator for signals that return a
+boolean values. The behavior that this accumulator gives is
+that a return of %TRUE stops the signal emission: no further
+callbacks will be invoked, while a return of %FALSE allows
+the emission to continue. The idea here is that a %TRUE return
+indicates that the callback <emphasis>handled</emphasis> the signal,
+and no further handling is needed.
+
+Since: 2.4
+
+
+</description>
+<parameters>
+<parameter name="ihint">
+<parameter_description> standard #GSignalAccumulator parameter
+</parameter_description>
+</parameter>
+<parameter name="return_accu">
+<parameter_description> standard #GSignalAccumulator parameter
+</parameter_description>
+</parameter>
+<parameter name="handler_return">
+<parameter_description> standard #GSignalAccumulator parameter
+</parameter_description>
+</parameter>
+<parameter name="dummy">
+<parameter_description> standard #GSignalAccumulator parameter
+</parameter_description>
+</parameter>
+</parameters>
+<return> standard #GSignalAccumulator result
+</return>
+</function>
+
+<function name="g_signal_add_emission_hook">
+<description>
+Adds an emission hook for a signal, which will get called for any emission
+of that signal, independent of the instance. This is possible only
+for signals which don't have #G_SIGNAL_NO_HOOKS flag set.
+
+
+</description>
+<parameters>
+<parameter name="signal_id">
+<parameter_description> the signal identifier, as returned by g_signal_lookup().
+</parameter_description>
+</parameter>
+<parameter name="detail">
+<parameter_description> the detail on which to call the hook.
+</parameter_description>
+</parameter>
+<parameter name="hook_func">
+<parameter_description> a #GSignalEmissionHook function.
+</parameter_description>
+</parameter>
+<parameter name="hook_data">
+<parameter_description> user data for @hook_func.
+</parameter_description>
+</parameter>
+<parameter name="data_destroy">
+<parameter_description> a #GDestroyNotify for @hook_data.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the hook id, for later use with g_signal_remove_emission_hook().
+</return>
+</function>
+
+<function name="g_signal_chain_from_overridden">
+<description>
+Calls the original class closure of a signal. This function should only
+be called from an overridden class closure; see
+g_signal_override_class_closure() and
+g_signal_override_class_handler().
+
+</description>
+<parameters>
+<parameter name="instance_and_params">
+<parameter_description> the argument list of the signal emission. The first
+element in the array is a #GValue for the instance the signal is being
+emitted on. The rest are any arguments to be passed to the signal.
+</parameter_description>
+</parameter>
+<parameter name="return_value">
+<parameter_description> Location for the return value.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_signal_chain_from_overridden_handler">
+<description>
+Calls the original class closure of a signal. This function should
+only be called from an overridden class closure; see
+g_signal_override_class_closure() and
+g_signal_override_class_handler().
+
+Since: 2.18
+
+</description>
+<parameters>
+<parameter name="instance">
+<parameter_description> the instance the signal is being emitted on.
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> parameters to be passed to the parent class closure, followed by a
+location for the return value. If the return type of the signal
+is #G_TYPE_NONE, the return value location can be omitted.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_signal_connect_closure">
+<description>
+Connects a closure to a signal for a particular object.
+
+
+</description>
+<parameters>
+<parameter name="instance">
+<parameter_description> the instance to connect to.
+</parameter_description>
+</parameter>
+<parameter name="detailed_signal">
+<parameter_description> a string of the form "signal-name::detail".
+</parameter_description>
+</parameter>
+<parameter name="closure">
+<parameter_description> the closure to connect.
+</parameter_description>
+</parameter>
+<parameter name="after">
+<parameter_description> whether the handler should be called before or after the
+default handler of the signal.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the handler id
+</return>
+</function>
+
+<function name="g_signal_connect_closure_by_id">
+<description>
+Connects a closure to a signal for a particular object.
+
+
+</description>
+<parameters>
+<parameter name="instance">
+<parameter_description> the instance to connect to.
+</parameter_description>
+</parameter>
+<parameter name="signal_id">
+<parameter_description> the id of the signal.
+</parameter_description>
+</parameter>
+<parameter name="detail">
+<parameter_description> the detail.
+</parameter_description>
+</parameter>
+<parameter name="closure">
+<parameter_description> the closure to connect.
+</parameter_description>
+</parameter>
+<parameter name="after">
+<parameter_description> whether the handler should be called before or after the
+default handler of the signal.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the handler id
+</return>
+</function>
+
+<function name="g_signal_connect_data">
+<description>
+Connects a #GCallback function to a signal for a particular object. Similar
+to g_signal_connect(), but allows to provide a #GClosureNotify for the data
+which will be called when the signal handler is disconnected and no longer
+used. Specify @connect_flags if you need <literal>..._after()</literal> or
+<literal>..._swapped()</literal> variants of this function.
+
+
+</description>
+<parameters>
+<parameter name="instance">
+<parameter_description> the instance to connect to.
+</parameter_description>
+</parameter>
+<parameter name="detailed_signal">
+<parameter_description> a string of the form "signal-name::detail".
+</parameter_description>
+</parameter>
+<parameter name="c_handler">
+<parameter_description> the #GCallback to connect.
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> data to pass to @c_handler calls.
+</parameter_description>
+</parameter>
+<parameter name="destroy_data">
+<parameter_description> a #GClosureNotify for @data.
+</parameter_description>
+</parameter>
+<parameter name="connect_flags">
+<parameter_description> a combination of #GConnectFlags.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the handler id
+</return>
+</function>
+
+<function name="g_signal_connect_object">
+<description>
+This is similar to g_signal_connect_data(), but uses a closure which
+ensures that the @gobject stays alive during the call to @c_handler
+by temporarily adding a reference count to @gobject.
+
+Note that there is a bug in GObject that makes this function
+much less useful than it might seem otherwise. Once @gobject is
+disposed, the callback will no longer be called, but, the signal
+handler is <emphasis>not</emphasis> currently disconnected. If the
+ instance is itself being freed at the same time than this doesn't
+matter, since the signal will automatically be removed, but
+if @instance persists, then the signal handler will leak. You
+should not remove the signal yourself because in a future versions of
+GObject, the handler <emphasis>will</emphasis> automatically
+be disconnected.
+
+It's possible to work around this problem in a way that will
+continue to work with future versions of GObject by checking
+that the signal handler is still connected before disconnected it:
+<informalexample><programlisting>
+if (g_signal_handler_is_connected (instance, id))
+g_signal_handler_disconnect (instance, id);
+</programlisting></informalexample>
+
+
+</description>
+<parameters>
+<parameter name="instance">
+<parameter_description> the instance to connect to.
+</parameter_description>
+</parameter>
+<parameter name="detailed_signal">
+<parameter_description> a string of the form "signal-name::detail".
+</parameter_description>
+</parameter>
+<parameter name="c_handler">
+<parameter_description> the #GCallback to connect.
+</parameter_description>
+</parameter>
+<parameter name="gobject">
+<parameter_description> the object to pass as data to @c_handler.
+</parameter_description>
+</parameter>
+<parameter name="connect_flags">
+<parameter_description> a combination of #GConnnectFlags.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the handler id.
+</return>
+</function>
+
+<function name="g_signal_emit">
+<description>
+Emits a signal.
+
+Note that g_signal_emit() resets the return value to the default
+if no handlers are connected, in contrast to g_signal_emitv().
+
+</description>
+<parameters>
+<parameter name="instance">
+<parameter_description> the instance the signal is being emitted on.
+</parameter_description>
+</parameter>
+<parameter name="signal_id">
+<parameter_description> the signal id
+</parameter_description>
+</parameter>
+<parameter name="detail">
+<parameter_description> the detail
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> parameters to be passed to the signal, followed by a
+location for the return value. If the return type of the signal
+is #G_TYPE_NONE, the return value location can be omitted.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_signal_emit_by_name">
+<description>
+Emits a signal.
+
+Note that g_signal_emit_by_name() resets the return value to the default
+if no handlers are connected, in contrast to g_signal_emitv().
+
+</description>
+<parameters>
+<parameter name="instance">
+<parameter_description> the instance the signal is being emitted on.
+</parameter_description>
+</parameter>
+<parameter name="detailed_signal">
+<parameter_description> a string of the form "signal-name::detail".
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> parameters to be passed to the signal, followed by a
+location for the return value. If the return type of the signal
+is #G_TYPE_NONE, the return value location can be omitted.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_signal_emit_valist">
+<description>
+Emits a signal.
+
+Note that g_signal_emit_valist() resets the return value to the default
+if no handlers are connected, in contrast to g_signal_emitv().
+
+</description>
+<parameters>
+<parameter name="instance">
+<parameter_description> the instance the signal is being emitted on.
+</parameter_description>
+</parameter>
+<parameter name="signal_id">
+<parameter_description> the signal id
+</parameter_description>
+</parameter>
+<parameter name="detail">
+<parameter_description> the detail
+</parameter_description>
+</parameter>
+<parameter name="var_args">
+<parameter_description> a list of parameters to be passed to the signal, followed by a
+location for the return value. If the return type of the signal
+is #G_TYPE_NONE, the return value location can be omitted.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_signal_emitv">
+<description>
+Emits a signal.
+
+Note that g_signal_emitv() doesn't change @return_value if no handlers are
+connected, in contrast to g_signal_emit() and g_signal_emit_valist().
+
+</description>
+<parameters>
+<parameter name="instance_and_params">
+<parameter_description> argument list for the signal emission. The first
+element in the array is a #GValue for the instance the signal is
+being emitted on. The rest are any arguments to be passed to the
+signal.
+</parameter_description>
+</parameter>
+<parameter name="signal_id">
+<parameter_description> the signal id
+</parameter_description>
+</parameter>
+<parameter name="detail">
+<parameter_description> the detail
+</parameter_description>
+</parameter>
+<parameter name="return_value">
+<parameter_description> Location to store the return value of the signal emission.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_signal_get_invocation_hint">
+<description>
+Returns the invocation hint of the innermost signal emission of instance.
+
+
+</description>
+<parameters>
+<parameter name="instance">
+<parameter_description> the instance to query
+</parameter_description>
+</parameter>
+</parameters>
+<return> the invocation hint of the innermost signal emission.
+</return>
+</function>
+
+<function name="g_signal_handler_block">
+<description>
+Blocks a handler of an instance so it will not be called during any
+signal emissions unless it is unblocked again. Thus "blocking" a
+signal handler means to temporarily deactive it, a signal handler
+has to be unblocked exactly the same amount of times it has been
+blocked before to become active again.
+
+The @handler_id has to be a valid signal handler id, connected to a
+signal of @instance.
+
+</description>
+<parameters>
+<parameter name="instance">
+<parameter_description> The instance to block the signal handler of.
+</parameter_description>
+</parameter>
+<parameter name="handler_id">
+<parameter_description> Handler id of the handler to be blocked.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_signal_handler_disconnect">
+<description>
+Disconnects a handler from an instance so it will not be called during
+any future or currently ongoing emissions of the signal it has been
+connected to. The @handler_id becomes invalid and may be reused.
+
+The @handler_id has to be a valid signal handler id, connected to a
+signal of @instance.
+
+</description>
+<parameters>
+<parameter name="instance">
+<parameter_description> The instance to remove the signal handler from.
+</parameter_description>
+</parameter>
+<parameter name="handler_id">
+<parameter_description> Handler id of the handler to be disconnected.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_signal_handler_find">
+<description>
+Finds the first signal handler that matches certain selection criteria.
+The criteria mask is passed as an OR-ed combination of #GSignalMatchType
+flags, and the criteria values are passed as arguments.
+The match @mask has to be non-0 for successful matches.
+If no handler was found, 0 is returned.
+
+
+</description>
+<parameters>
+<parameter name="instance">
+<parameter_description> The instance owning the signal handler to be found.
+</parameter_description>
+</parameter>
+<parameter name="mask">
+<parameter_description> Mask indicating which of @signal_id, @detail, @closure, @func
+and/or @data the handler has to match.
+</parameter_description>
+</parameter>
+<parameter name="signal_id">
+<parameter_description> Signal the handler has to be connected to.
+</parameter_description>
+</parameter>
+<parameter name="detail">
+<parameter_description> Signal detail the handler has to be connected to.
+</parameter_description>
+</parameter>
+<parameter name="closure">
+<parameter_description> The closure the handler will invoke.
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> The C closure callback of the handler (useless for non-C closures).
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> The closure data of the handler's closure.
+</parameter_description>
+</parameter>
+</parameters>
+<return> A valid non-0 signal handler id for a successful match.
+</return>
+</function>
+
+<function name="g_signal_handler_is_connected">
+<description>
+Returns whether @handler_id is the id of a handler connected to @instance.
+
+
+</description>
+<parameters>
+<parameter name="instance">
+<parameter_description> The instance where a signal handler is sought.
+</parameter_description>
+</parameter>
+<parameter name="handler_id">
+<parameter_description> the handler id.
+</parameter_description>
+</parameter>
+</parameters>
+<return> whether @handler_id identifies a handler connected to @instance.
+</return>
+</function>
+
+<function name="g_signal_handler_unblock">
+<description>
+Undoes the effect of a previous g_signal_handler_block() call. A
+blocked handler is skipped during signal emissions and will not be
+invoked, unblocking it (for exactly the amount of times it has been
+blocked before) reverts its "blocked" state, so the handler will be
+recognized by the signal system and is called upon future or
+currently ongoing signal emissions (since the order in which
+handlers are called during signal emissions is deterministic,
+whether the unblocked handler in question is called as part of a
+currently ongoing emission depends on how far that emission has
+proceeded yet).
+
+The @handler_id has to be a valid id of a signal handler that is
+connected to a signal of @instance and is currently blocked.
+
+</description>
+<parameters>
+<parameter name="instance">
+<parameter_description> The instance to unblock the signal handler of.
+</parameter_description>
+</parameter>
+<parameter name="handler_id">
+<parameter_description> Handler id of the handler to be unblocked.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_signal_handlers_block_matched">
+<description>
+Blocks all handlers on an instance that match a certain selection criteria.
+The criteria mask is passed as an OR-ed combination of #GSignalMatchType
+flags, and the criteria values are passed as arguments.
+Passing at least one of the %G_SIGNAL_MATCH_CLOSURE, %G_SIGNAL_MATCH_FUNC
+or %G_SIGNAL_MATCH_DATA match flags is required for successful matches.
+If no handlers were found, 0 is returned, the number of blocked handlers
+otherwise.
+
+
+</description>
+<parameters>
+<parameter name="instance">
+<parameter_description> The instance to block handlers from.
+</parameter_description>
+</parameter>
+<parameter name="mask">
+<parameter_description> Mask indicating which of @signal_id, @detail, @closure, @func
+and/or @data the handlers have to match.
+</parameter_description>
+</parameter>
+<parameter name="signal_id">
+<parameter_description> Signal the handlers have to be connected to.
+</parameter_description>
+</parameter>
+<parameter name="detail">
+<parameter_description> Signal detail the handlers have to be connected to.
+</parameter_description>
+</parameter>
+<parameter name="closure">
+<parameter_description> The closure the handlers will invoke.
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> The C closure callback of the handlers (useless for non-C closures).
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> The closure data of the handlers' closures.
+</parameter_description>
+</parameter>
+</parameters>
+<return> The number of handlers that matched.
+</return>
+</function>
+
+<function name="g_signal_handlers_disconnect_matched">
+<description>
+Disconnects all handlers on an instance that match a certain
+selection criteria. The criteria mask is passed as an OR-ed
+combination of #GSignalMatchType flags, and the criteria values are
+passed as arguments. Passing at least one of the
+%G_SIGNAL_MATCH_CLOSURE, %G_SIGNAL_MATCH_FUNC or
+%G_SIGNAL_MATCH_DATA match flags is required for successful
+matches. If no handlers were found, 0 is returned, the number of
+disconnected handlers otherwise.
+
+
+</description>
+<parameters>
+<parameter name="instance">
+<parameter_description> The instance to remove handlers from.
+</parameter_description>
+</parameter>
+<parameter name="mask">
+<parameter_description> Mask indicating which of @signal_id, @detail, @closure, @func
+and/or @data the handlers have to match.
+</parameter_description>
+</parameter>
+<parameter name="signal_id">
+<parameter_description> Signal the handlers have to be connected to.
+</parameter_description>
+</parameter>
+<parameter name="detail">
+<parameter_description> Signal detail the handlers have to be connected to.
+</parameter_description>
+</parameter>
+<parameter name="closure">
+<parameter_description> The closure the handlers will invoke.
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> The C closure callback of the handlers (useless for non-C closures).
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> The closure data of the handlers' closures.
+</parameter_description>
+</parameter>
+</parameters>
+<return> The number of handlers that matched.
+</return>
+</function>
+
+<function name="g_signal_handlers_unblock_matched">
+<description>
+Unblocks all handlers on an instance that match a certain selection
+criteria. The criteria mask is passed as an OR-ed combination of
+#GSignalMatchType flags, and the criteria values are passed as arguments.
+Passing at least one of the %G_SIGNAL_MATCH_CLOSURE, %G_SIGNAL_MATCH_FUNC
+or %G_SIGNAL_MATCH_DATA match flags is required for successful matches.
+If no handlers were found, 0 is returned, the number of unblocked handlers
+otherwise. The match criteria should not apply to any handlers that are
+not currently blocked.
+
+
+</description>
+<parameters>
+<parameter name="instance">
+<parameter_description> The instance to unblock handlers from.
+</parameter_description>
+</parameter>
+<parameter name="mask">
+<parameter_description> Mask indicating which of @signal_id, @detail, @closure, @func
+and/or @data the handlers have to match.
+</parameter_description>
+</parameter>
+<parameter name="signal_id">
+<parameter_description> Signal the handlers have to be connected to.
+</parameter_description>
+</parameter>
+<parameter name="detail">
+<parameter_description> Signal detail the handlers have to be connected to.
+</parameter_description>
+</parameter>
+<parameter name="closure">
+<parameter_description> The closure the handlers will invoke.
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> The C closure callback of the handlers (useless for non-C closures).
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> The closure data of the handlers' closures.
+</parameter_description>
+</parameter>
+</parameters>
+<return> The number of handlers that matched.
+</return>
+</function>
+
+<function name="g_signal_has_handler_pending">
+<description>
+Returns whether there are any handlers connected to @instance for the
+given signal id and detail.
+
+One example of when you might use this is when the arguments to the
+signal are difficult to compute. A class implementor may opt to not
+emit the signal if no one is attached anyway, thus saving the cost
+of building the arguments.
+
+
+</description>
+<parameters>
+<parameter name="instance">
+<parameter_description> the object whose signal handlers are sought.
+</parameter_description>
+</parameter>
+<parameter name="signal_id">
+<parameter_description> the signal id.
+</parameter_description>
+</parameter>
+<parameter name="detail">
+<parameter_description> the detail.
+</parameter_description>
+</parameter>
+<parameter name="may_be_blocked">
+<parameter_description> whether blocked handlers should count as match.
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if a handler is connected to the signal, %FALSE
+otherwise.
+</return>
+</function>
+
+<function name="g_signal_list_ids">
+<description>
+Lists the signals by id that a certain instance or interface type
+created. Further information about the signals can be acquired through
+g_signal_query().
+
+
+</description>
+<parameters>
+<parameter name="itype">
+<parameter_description> Instance or interface type.
+</parameter_description>
+</parameter>
+<parameter name="n_ids">
+<parameter_description> Location to store the number of signal ids for @itype.
+</parameter_description>
+</parameter>
+</parameters>
+<return> Newly allocated array of signal IDs.
+</return>
+</function>
+
+<function name="g_signal_lookup">
+<description>
+Given the name of the signal and the type of object it connects to, gets
+the signal's identifying integer. Emitting the signal by number is
+somewhat faster than using the name each time.
+
+Also tries the ancestors of the given type.
+
+See g_signal_new() for details on allowed signal names.
+
+
+</description>
+<parameters>
+<parameter name="name">
+<parameter_description> the signal's name.
+</parameter_description>
+</parameter>
+<parameter name="itype">
+<parameter_description> the type that the signal operates on.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the signal's identifying number, or 0 if no signal was found.
+</return>
+</function>
+
+<function name="g_signal_name">
+<description>
+Given the signal's identifier, finds its name.
+
+Two different signals may have the same name, if they have differing types.
+
+
+</description>
+<parameters>
+<parameter name="signal_id">
+<parameter_description> the signal's identifying number.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the signal name, or %NULL if the signal number was invalid.
+</return>
+</function>
+
+<function name="g_signal_new">
+<description>
+Creates a new signal. (This is usually done in the class initializer.)
+
+A signal name consists of segments consisting of ASCII letters and
+digits, separated by either the '-' or '_' character. The first
+character of a signal name must be a letter. Names which violate these
+rules lead to undefined behaviour of the GSignal system.
+
+When registering a signal and looking up a signal, either separator can
+be used, but they cannot be mixed.
+
+If 0 is used for @class_offset subclasses cannot override the class handler
+in their <code>class_init</code> method by doing
+<code>super_class->signal_handler = my_signal_handler</code>. Instead they
+will have to use g_signal_override_class_handler().
+
+
+</description>
+<parameters>
+<parameter name="signal_name">
+<parameter_description> the name for the signal
+</parameter_description>
+</parameter>
+<parameter name="itype">
+<parameter_description> the type this signal pertains to. It will also pertain to
+types which are derived from this type.
+</parameter_description>
+</parameter>
+<parameter name="signal_flags">
+<parameter_description> a combination of #GSignalFlags specifying detail of when
+the default handler is to be invoked. You should at least specify
+%G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST.
+</parameter_description>
+</parameter>
+<parameter name="class_offset">
+<parameter_description> The offset of the function pointer in the class structure
+for this type. Used to invoke a class method generically. Pass 0 to
+not associate a class method slot with this signal.
+</parameter_description>
+</parameter>
+<parameter name="accumulator">
+<parameter_description> the accumulator for this signal; may be %NULL.
+</parameter_description>
+</parameter>
+<parameter name="accu_data">
+<parameter_description> user data for the @accumulator.
+</parameter_description>
+</parameter>
+<parameter name="c_marshaller">
+<parameter_description> the function to translate arrays of parameter values to
+signal emissions into C language callback invocations.
+</parameter_description>
+</parameter>
+<parameter name="return_type">
+<parameter_description> the type of return value, or #G_TYPE_NONE for a signal
+without a return value.
+</parameter_description>
+</parameter>
+<parameter name="n_params">
+<parameter_description> the number of parameter types to follow.
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> a list of types, one for each parameter.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the signal id
+</return>
+</function>
+
+<function name="g_signal_new_class_handler">
+<description>
+Creates a new signal. (This is usually done in the class initializer.)
+
+This is a variant of g_signal_new() that takes a C callback instead
+off a class offset for the signal's class handler. This function
+doesn't need a function pointer exposed in the class structure of
+an object definition, instead the function pointer is passed
+directly and can be overriden by derived classes with
+g_signal_override_class_closure() or
+g_signal_override_class_handler()and chained to with
+g_signal_chain_from_overridden() or
+g_signal_chain_from_overridden_handler().
+
+See g_signal_new() for information about signal names.
+
+Since: 2.18
+
+</description>
+<parameters>
+<parameter name="signal_name">
+<parameter_description> the name for the signal
+</parameter_description>
+</parameter>
+<parameter name="itype">
+<parameter_description> the type this signal pertains to. It will also pertain to
+types which are derived from this type.
+</parameter_description>
+</parameter>
+<parameter name="signal_flags">
+<parameter_description> a combination of #GSignalFlags specifying detail of when
+the default handler is to be invoked. You should at least specify
+%G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST.
+</parameter_description>
+</parameter>
+<parameter name="class_handler">
+<parameter_description> a #GCallback which acts as class implementation of
+this signal. Used to invoke a class method generically. Pass %NULL to
+not associate a class method with this signal.
+</parameter_description>
+</parameter>
+<parameter name="accumulator">
+<parameter_description> the accumulator for this signal; may be %NULL.
+</parameter_description>
+</parameter>
+<parameter name="accu_data">
+<parameter_description> user data for the @accumulator.
+</parameter_description>
+</parameter>
+<parameter name="c_marshaller">
+<parameter_description> the function to translate arrays of parameter values to
+signal emissions into C language callback invocations.
+</parameter_description>
+</parameter>
+<parameter name="return_type">
+<parameter_description> the type of return value, or #G_TYPE_NONE for a signal
+without a return value.
+</parameter_description>
+</parameter>
+<parameter name="n_params">
+<parameter_description> the number of parameter types to follow.
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> a list of types, one for each parameter.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the signal id
+
+</return>
+</function>
+
+<function name="g_signal_new_valist">
+<description>
+Creates a new signal. (This is usually done in the class initializer.)
+
+See g_signal_new() for details on allowed signal names.
+
+
+</description>
+<parameters>
+<parameter name="signal_name">
+<parameter_description> the name for the signal
+</parameter_description>
+</parameter>
+<parameter name="itype">
+<parameter_description> the type this signal pertains to. It will also pertain to
+types which are derived from this type.
+</parameter_description>
+</parameter>
+<parameter name="signal_flags">
+<parameter_description> a combination of #GSignalFlags specifying detail of when
+the default handler is to be invoked. You should at least specify
+%G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST.
+</parameter_description>
+</parameter>
+<parameter name="class_closure">
+<parameter_description> The closure to invoke on signal emission; may be %NULL.
+</parameter_description>
+</parameter>
+<parameter name="accumulator">
+<parameter_description> the accumulator for this signal; may be %NULL.
+</parameter_description>
+</parameter>
+<parameter name="accu_data">
+<parameter_description> user data for the @accumulator.
+</parameter_description>
+</parameter>
+<parameter name="c_marshaller">
+<parameter_description> the function to translate arrays of parameter values to
+signal emissions into C language callback invocations.
+</parameter_description>
+</parameter>
+<parameter name="return_type">
+<parameter_description> the type of return value, or #G_TYPE_NONE for a signal
+without a return value.
+</parameter_description>
+</parameter>
+<parameter name="n_params">
+<parameter_description> the number of parameter types in @args.
+</parameter_description>
+</parameter>
+<parameter name="args">
+<parameter_description> va_list of #GType, one for each parameter.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the signal id
+</return>
+</function>
+
+<function name="g_signal_newv">
+<description>
+Creates a new signal. (This is usually done in the class initializer.)
+
+See g_signal_new() for details on allowed signal names.
+
+
+</description>
+<parameters>
+<parameter name="signal_name">
+<parameter_description> the name for the signal
+</parameter_description>
+</parameter>
+<parameter name="itype">
+<parameter_description> the type this signal pertains to. It will also pertain to
+types which are derived from this type
+</parameter_description>
+</parameter>
+<parameter name="signal_flags">
+<parameter_description> a combination of #GSignalFlags specifying detail of when
+the default handler is to be invoked. You should at least specify
+%G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST
+</parameter_description>
+</parameter>
+<parameter name="class_closure">
+<parameter_description> The closure to invoke on signal emission; may be %NULL
+</parameter_description>
+</parameter>
+<parameter name="accumulator">
+<parameter_description> the accumulator for this signal; may be %NULL
+</parameter_description>
+</parameter>
+<parameter name="accu_data">
+<parameter_description> user data for the @accumulator
+</parameter_description>
+</parameter>
+<parameter name="c_marshaller">
+<parameter_description> the function to translate arrays of parameter values to
+signal emissions into C language callback invocations
+</parameter_description>
+</parameter>
+<parameter name="return_type">
+<parameter_description> the type of return value, or #G_TYPE_NONE for a signal
+without a return value
+</parameter_description>
+</parameter>
+<parameter name="n_params">
+<parameter_description> the length of @param_types
+</parameter_description>
+</parameter>
+<parameter name="param_types">
+<parameter_description> an array of types, one for each parameter
+</parameter_description>
+</parameter>
+</parameters>
+<return> the signal id
+</return>
+</function>
+
+<function name="g_signal_override_class_closure">
+<description>
+Overrides the class closure (i.e. the default handler) for the given signal
+for emissions on instances of @instance_type. @instance_type must be derived
+from the type to which the signal belongs.
+
+See g_signal_chain_from_overridden() and
+g_signal_chain_from_overridden_handler() for how to chain up to the
+parent class closure from inside the overridden one.
+
+</description>
+<parameters>
+<parameter name="signal_id">
+<parameter_description> the signal id
+</parameter_description>
+</parameter>
+<parameter name="instance_type">
+<parameter_description> the instance type on which to override the class closure
+for the signal.
+</parameter_description>
+</parameter>
+<parameter name="class_closure">
+<parameter_description> the closure.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_signal_override_class_handler">
+<description>
+Overrides the class closure (i.e. the default handler) for the
+given signal for emissions on instances of @instance_type with
+callabck @class_handler. @instance_type must be derived from the
+type to which the signal belongs.
+
+See g_signal_chain_from_overridden() and
+g_signal_chain_from_overridden_handler() for how to chain up to the
+parent class closure from inside the overridden one.
+
+Since: 2.18
+
+</description>
+<parameters>
+<parameter name="signal_name">
+<parameter_description> the name for the signal
+</parameter_description>
+</parameter>
+<parameter name="instance_type">
+<parameter_description> the instance type on which to override the class handler
+for the signal.
+</parameter_description>
+</parameter>
+<parameter name="class_handler">
+<parameter_description> the handler.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_signal_parse_name">
+<description>
+Internal function to parse a signal name into its @signal_id
+and @detail quark.
+
+
+</description>
+<parameters>
+<parameter name="detailed_signal">
+<parameter_description> a string of the form "signal-name::detail".
+</parameter_description>
+</parameter>
+<parameter name="itype">
+<parameter_description> The interface/instance type that introduced "signal-name".
+</parameter_description>
+</parameter>
+<parameter name="signal_id_p">
+<parameter_description> Location to store the signal id.
+</parameter_description>
+</parameter>
+<parameter name="detail_p">
+<parameter_description> Location to store the detail quark.
+</parameter_description>
+</parameter>
+<parameter name="force_detail_quark">
+<parameter_description> %TRUE forces creation of a #GQuark for the detail.
+</parameter_description>
+</parameter>
+</parameters>
+<return> Whether the signal name could successfully be parsed and @signal_id_p and @detail_p contain valid return values.
+</return>
+</function>
+
+<function name="g_signal_query">
+<description>
+Queries the signal system for in-depth information about a
+specific signal. This function will fill in a user-provided
+structure to hold signal-specific information. If an invalid
+signal id is passed in, the @signal_id member of the #GSignalQuery
+is 0. All members filled into the #GSignalQuery structure should
+be considered constant and have to be left untouched.
+
+</description>
+<parameters>
+<parameter name="signal_id">
+<parameter_description> The signal id of the signal to query information for.
+</parameter_description>
+</parameter>
+<parameter name="query">
+<parameter_description> A user provided structure that is filled in with constant
+values upon success.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_signal_remove_emission_hook">
+<description>
+Deletes an emission hook.
+
+</description>
+<parameters>
+<parameter name="signal_id">
+<parameter_description> the id of the signal
+</parameter_description>
+</parameter>
+<parameter name="hook_id">
+<parameter_description> the id of the emission hook, as returned by
+g_signal_add_emission_hook()
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_signal_stop_emission">
+<description>
+Stops a signal's current emission.
+
+This will prevent the default method from running, if the signal was
+%G_SIGNAL_RUN_LAST and you connected normally (i.e. without the "after"
+flag).
+
+Prints a warning if used on a signal which isn't being emitted.
+
+</description>
+<parameters>
+<parameter name="instance">
+<parameter_description> the object whose signal handlers you wish to stop.
+</parameter_description>
+</parameter>
+<parameter name="signal_id">
+<parameter_description> the signal identifier, as returned by g_signal_lookup().
+</parameter_description>
+</parameter>
+<parameter name="detail">
+<parameter_description> the detail which the signal was emitted with.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_signal_stop_emission_by_name">
+<description>
+Stops a signal's current emission.
+
+This is just like g_signal_stop_emission() except it will look up the
+signal id for you.
+
+</description>
+<parameters>
+<parameter name="instance">
+<parameter_description> the object whose signal handlers you wish to stop.
+</parameter_description>
+</parameter>
+<parameter name="detailed_signal">
+<parameter_description> a string of the form "signal-name::detail".
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_signal_type_cclosure_new">
+<description>
+Creates a new closure which invokes the function found at the offset
+ struct_offset in the class structure of the interface or classed type
+identified by @itype.
+
+
+</description>
+<parameters>
+<parameter name="itype">
+<parameter_description> the #GType identifier of an interface or classed type
+</parameter_description>
+</parameter>
+<parameter name="struct_offset">
+<parameter_description> the offset of the member function of @itype's class
+structure which is to be invoked by the new closure
+</parameter_description>
+</parameter>
+</parameters>
+<return> a new #GCClosure
+</return>
+</function>
+
+<function name="g_slist_alloc">
+<description>
+Allocates space for one #GSList element. It is called by the
+g_slist_append(), g_slist_prepend(), g_slist_insert() and
+g_slist_insert_sorted() functions and so is rarely used on its own.
+
+</description>
+<parameters>
+</parameters>
+<return> a pointer to the newly-allocated #GSList element.
+</return>
+</function>
+
+<function name="g_slist_append">
+<description>
+Adds a new element on to the end of the list.
+
+<note><para>
+The return value is the new start of the list, which may
+have changed, so make sure you store the new value.
+</para></note>
+
+<note><para>
+Note that g_slist_append() has to traverse the entire list
+to find the end, which is inefficient when adding multiple
+elements. A common idiom to avoid the inefficiency is to prepend
+the elements and reverse the list when all elements have been added.
+</para></note>
+
+|[
+/ * Notice that these are initialized to the empty list. * /
+GSList *list = NULL, *number_list = NULL;
+
+/ * This is a list of strings. * /
+list = g_slist_append (list, "first");
+list = g_slist_append (list, "second");
+
+/ * This is a list of integers. * /
+number_list = g_slist_append (number_list, GINT_TO_POINTER (27));
+number_list = g_slist_append (number_list, GINT_TO_POINTER (14));
+]|
+
+
+</description>
+<parameters>
+<parameter name="list">
+<parameter_description> a #GSList
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> the data for the new element
+</parameter_description>
+</parameter>
+</parameters>
+<return> the new start of the #GSList
+</return>
+</function>
+
+<function name="g_slist_concat">
+<description>
+Adds the second #GSList onto the end of the first #GSList.
+Note that the elements of the second #GSList are not copied.
+They are used directly.
+
+
+</description>
+<parameters>
+<parameter name="list1">
+<parameter_description> a #GSList
+</parameter_description>
+</parameter>
+<parameter name="list2">
+<parameter_description> the #GSList to add to the end of the first #GSList
+</parameter_description>
+</parameter>
+</parameters>
+<return> the start of the new #GSList
+</return>
+</function>
+
+<function name="g_slist_copy">
+<description>
+Copies a #GSList.
+
+<note><para>
+Note that this is a "shallow" copy. If the list elements
+consist of pointers to data, the pointers are copied but
+the actual data isn't.
+</para></note>
+
+
+</description>
+<parameters>
+<parameter name="list">
+<parameter_description> a #GSList
+</parameter_description>
+</parameter>
+</parameters>
+<return> a copy of @list
+</return>
+</function>
+
+<function name="g_slist_delete_link">
+<description>
+Removes the node link_ from the list and frees it.
+Compare this to g_slist_remove_link() which removes the node
+without freeing it.
+
+
+</description>
+<parameters>
+<parameter name="list">
+<parameter_description> a #GSList
+</parameter_description>
+</parameter>
+<parameter name="link_">
+<parameter_description> node to delete
+</parameter_description>
+</parameter>
+</parameters>
+<return> the new head of @list
+</return>
+</function>
+
+<function name="g_slist_find">
+<description>
+Finds the element in a #GSList which
+contains the given data.
+
+
+</description>
+<parameters>
+<parameter name="list">
+<parameter_description> a #GSList
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> the element data to find
+</parameter_description>
+</parameter>
+</parameters>
+<return> the found #GSList element,
+or %NULL if it is not found
+</return>
+</function>
+
+<function name="g_slist_find_custom">
+<description>
+Finds an element in a #GSList, using a supplied function to
+find the desired element. It iterates over the list, calling
+the given function which should return 0 when the desired
+element is found. The function takes two #gconstpointer arguments,
+the #GSList element's data as the first argument and the
+given user data.
+
+
+</description>
+<parameters>
+<parameter name="list">
+<parameter_description> a #GSList
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> user data passed to the function
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> the function to call for each element.
+It should return 0 when the desired element is found
+</parameter_description>
+</parameter>
+</parameters>
+<return> the found #GSList element, or %NULL if it is not found
+</return>
+</function>
+
+<function name="g_slist_foreach">
+<description>
+Calls a function for each element of a #GSList.
+
+</description>
+<parameters>
+<parameter name="list">
+<parameter_description> a #GSList
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> the function to call with each element's data
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> user data to pass to the function
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_slist_free">
+<description>
+Frees all of the memory used by a #GSList.
+The freed elements are returned to the slice allocator.
+
+<note><para>
+If list elements contain dynamically-allocated memory,
+you should either use g_slist_free_full() or free them manually
+first.
+</para></note>
+
+</description>
+<parameters>
+<parameter name="list">
+<parameter_description> a #GSList
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_slist_free1">
+<description>
+A macro which does the same as g_slist_free_1().
+
+Since: 2.10
+
+</description>
+<parameters>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_slist_free_1">
+<description>
+Frees one #GSList element.
+It is usually used after g_slist_remove_link().
+
+</description>
+<parameters>
+<parameter name="list">
+<parameter_description> a #GSList element
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_slist_free_full">
+<description>
+Convenience method, which frees all the memory used by a #GSList, and
+calls the specified destroy function on every element's data.
+
+Since: 2.28
+
+</description>
+<parameters>
+<parameter name="list">
+<parameter_description> a pointer to a #GSList
+</parameter_description>
+</parameter>
+<parameter name="free_func">
+<parameter_description> the function to be called to free each element's data
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_slist_index">
+<description>
+Gets the position of the element containing
+the given data (starting from 0).
+
+
+</description>
+<parameters>
+<parameter name="list">
+<parameter_description> a #GSList
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> the data to find
+</parameter_description>
+</parameter>
+</parameters>
+<return> the index of the element containing the data,
+or -1 if the data is not found
+</return>
+</function>
+
+<function name="g_slist_insert">
+<description>
+Inserts a new element into the list at the given position.
+
+
+</description>
+<parameters>
+<parameter name="list">
+<parameter_description> a #GSList
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> the data for the new element
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> the position to insert the element.
+If this is negative, or is larger than the number
+of elements in the list, the new element is added on
+to the end of the list.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the new start of the #GSList
+</return>
+</function>
+
+<function name="g_slist_insert_before">
+<description>
+Inserts a node before @sibling containing @data.
+
+
+</description>
+<parameters>
+<parameter name="slist">
+<parameter_description> a #GSList
+</parameter_description>
+</parameter>
+<parameter name="sibling">
+<parameter_description> node to insert @data before
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> data to put in the newly-inserted node
+</parameter_description>
+</parameter>
+</parameters>
+<return> the new head of the list.
+</return>
+</function>
+
+<function name="g_slist_insert_sorted">
+<description>
+Inserts a new element into the list, using the given
+comparison function to determine its position.
+
+
+</description>
+<parameters>
+<parameter name="list">
+<parameter_description> a #GSList
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> the data for the new element
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> the function to compare elements in the list.
+It should return a number > 0 if the first parameter
+comes after the second parameter in the sort order.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the new start of the #GSList
+</return>
+</function>
+
+<function name="g_slist_insert_sorted_with_data">
+<description>
+Inserts a new element into the list, using the given
+comparison function to determine its position.
+
+Since: 2.10
+
+</description>
+<parameters>
+<parameter name="list">
+<parameter_description> a #GSList
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> the data for the new element
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> the function to compare elements in the list.
+It should return a number > 0 if the first parameter
+comes after the second parameter in the sort order.
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> data to pass to comparison function
+</parameter_description>
+</parameter>
+</parameters>
+<return> the new start of the #GSList
+
+</return>
+</function>
+
+<function name="g_slist_last">
+<description>
+Gets the last element in a #GSList.
+
+<note><para>
+This function iterates over the whole list.
+</para></note>
+
+
+</description>
+<parameters>
+<parameter name="list">
+<parameter_description> a #GSList
+</parameter_description>
+</parameter>
+</parameters>
+<return> the last element in the #GSList,
+or %NULL if the #GSList has no elements
+</return>
+</function>
+
+<function name="g_slist_length">
+<description>
+Gets the number of elements in a #GSList.
+
+<note><para>
+This function iterates over the whole list to
+count its elements.
+</para></note>
+
+
+</description>
+<parameters>
+<parameter name="list">
+<parameter_description> a #GSList
+</parameter_description>
+</parameter>
+</parameters>
+<return> the number of elements in the #GSList
+</return>
+</function>
+
+<function name="g_slist_next">
+<description>
+A convenience macro to get the next element in a #GSList.
+
+</description>
+<parameters>
+<parameter name="slist">
+<parameter_description> an element in a #GSList.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the next element, or %NULL if there are no more elements.
+</return>
+</function>
+
+<function name="g_slist_nth">
+<description>
+Gets the element at the given position in a #GSList.
+
+
+</description>
+<parameters>
+<parameter name="list">
+<parameter_description> a #GSList
+</parameter_description>
+</parameter>
+<parameter name="n">
+<parameter_description> the position of the element, counting from 0
+</parameter_description>
+</parameter>
+</parameters>
+<return> the element, or %NULL if the position is off
+the end of the #GSList
+</return>
+</function>
+
+<function name="g_slist_nth_data">
+<description>
+Gets the data of the element at the given position.
+
+
+</description>
+<parameters>
+<parameter name="list">
+<parameter_description> a #GSList
+</parameter_description>
+</parameter>
+<parameter name="n">
+<parameter_description> the position of the element
+</parameter_description>
+</parameter>
+</parameters>
+<return> the element's data, or %NULL if the position
+is off the end of the #GSList
+</return>
+</function>
+
+<function name="g_slist_pop_allocator">
+<description>
+Restores the previous #GAllocator, used when allocating #GSList
+elements.
+
+Note that this function is not available if GLib has been compiled
+with <option>--disable-mem-pools</option>
+
+Deprecated: 2.10: It does nothing, since #GSList has been converted
+to the <link linkend="glib-Memory-Slices">slice
+allocator</link>
+
+</description>
+<parameters>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_slist_position">
+<description>
+Gets the position of the given element
+in the #GSList (starting from 0).
+
+
+</description>
+<parameters>
+<parameter name="list">
+<parameter_description> a #GSList
+</parameter_description>
+</parameter>
+<parameter name="llink">
+<parameter_description> an element in the #GSList
+</parameter_description>
+</parameter>
+</parameters>
+<return> the position of the element in the #GSList,
+or -1 if the element is not found
+</return>
+</function>
+
+<function name="g_slist_prepend">
+<description>
+Adds a new element on to the start of the list.
+
+<note><para>
+The return value is the new start of the list, which
+may have changed, so make sure you store the new value.
+</para></note>
+
+|[
+/ * Notice that it is initialized to the empty list. * /
+GSList *list = NULL;
+list = g_slist_prepend (list, "last");
+list = g_slist_prepend (list, "first");
+]|
+
+
+</description>
+<parameters>
+<parameter name="list">
+<parameter_description> a #GSList
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> the data for the new element
+</parameter_description>
+</parameter>
+</parameters>
+<return> the new start of the #GSList
+</return>
+</function>
+
+<function name="g_slist_push_allocator">
+<description>
+Sets the allocator to use to allocate #GSList elements. Use
+g_slist_pop_allocator() to restore the previous allocator.
+
+Note that this function is not available if GLib has been compiled
+with <option>--disable-mem-pools</option>
+
+Deprecated: 2.10: It does nothing, since #GSList has been converted
+to the <link linkend="glib-Memory-Slices">slice
+allocator</link>
+
+</description>
+<parameters>
+<parameter name="dummy">
+<parameter_description> the #GAllocator to use when allocating #GSList elements.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_slist_remove">
+<description>
+Removes an element from a #GSList.
+If two elements contain the same data, only the first is removed.
+If none of the elements contain the data, the #GSList is unchanged.
+
+
+</description>
+<parameters>
+<parameter name="list">
+<parameter_description> a #GSList
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> the data of the element to remove
+</parameter_description>
+</parameter>
+</parameters>
+<return> the new start of the #GSList
+</return>
+</function>
+
+<function name="g_slist_remove_all">
+<description>
+Removes all list nodes with data equal to @data.
+Returns the new head of the list. Contrast with
+g_slist_remove() which removes only the first node
+matching the given data.
+
+
+</description>
+<parameters>
+<parameter name="list">
+<parameter_description> a #GSList
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> data to remove
+</parameter_description>
+</parameter>
+</parameters>
+<return> new head of @list
+</return>
+</function>
+
+<function name="g_slist_remove_link">
+<description>
+Removes an element from a #GSList, without
+freeing the element. The removed element's next
+link is set to %NULL, so that it becomes a
+self-contained list with one element.
+
+
+</description>
+<parameters>
+<parameter name="list">
+<parameter_description> a #GSList
+</parameter_description>
+</parameter>
+<parameter name="link_">
+<parameter_description> an element in the #GSList
+</parameter_description>
+</parameter>
+</parameters>
+<return> the new start of the #GSList, without the element
+</return>
+</function>
+
+<function name="g_slist_reverse">
+<description>
+Reverses a #GSList.
+
+
+</description>
+<parameters>
+<parameter name="list">
+<parameter_description> a #GSList
+</parameter_description>
+</parameter>
+</parameters>
+<return> the start of the reversed #GSList
+</return>
+</function>
+
+<function name="g_slist_sort">
+<description>
+Sorts a #GSList using the given comparison function.
+
+
+</description>
+<parameters>
+<parameter name="list">
+<parameter_description> a #GSList
+</parameter_description>
+</parameter>
+<parameter name="compare_func">
+<parameter_description> the comparison function used to sort the #GSList.
+This function is passed the data from 2 elements of the #GSList
+and should return 0 if they are equal, a negative value if the
+first element comes before the second, or a positive value if
+the first element comes after the second.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the start of the sorted #GSList
+</return>
+</function>
+
+<function name="g_slist_sort_with_data">
+<description>
+Like g_slist_sort(), but the sort function accepts a user data argument.
+
+
+</description>
+<parameters>
+<parameter name="list">
+<parameter_description> a #GSList
+</parameter_description>
+</parameter>
+<parameter name="compare_func">
+<parameter_description> comparison function
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> data to pass to comparison function
+</parameter_description>
+</parameter>
+</parameters>
+<return> new head of the list
+</return>
+</function>
+
+<function name="g_snprintf">
+<description>
+A safer form of the standard sprintf() function. The output is guaranteed
+to not exceed @n characters (including the terminating nul character), so
+it is easy to ensure that a buffer overflow cannot occur.
+
+See also g_strdup_printf().
+
+In versions of GLib prior to 1.2.3, this function may return -1 if the
+output was truncated, and the truncated string may not be nul-terminated.
+In versions prior to 1.3.12, this function returns the length of the output
+string.
+
+The return value of g_snprintf() conforms to the snprintf()
+function as standardized in ISO C99. Note that this is different from
+traditional snprintf(), which returns the length of the output string.
+
+The format string may contain positional parameters, as specified in
+the Single Unix Specification.
+
+
+</description>
+<parameters>
+<parameter name="string">
+<parameter_description> the buffer to hold the output.
+</parameter_description>
+</parameter>
+<parameter name="n">
+<parameter_description> the maximum number of bytes to produce (including the
+terminating nul character).
+</parameter_description>
+</parameter>
+<parameter name="format">
+<parameter_description> a standard printf() format string, but notice
+<link linkend="string-precision">string precision pitfalls</link>.
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> the arguments to insert in the output.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the number of bytes which would be produced if the buffer
+was large enough.
+</return>
+</function>
+
+<function name="g_source_add_child_source">
+<description>
+Adds @child_source to @source as a "polled" source; when @source is
+added to a #GMainContext, @child_source will be automatically added
+with the same priority, when @child_source is triggered, it will
+cause @source to dispatch (in addition to calling its own
+callback), and when @source is destroyed, it will destroy
+ child_source as well. (@source will also still be dispatched if
+its own prepare/check functions indicate that it is ready.)
+
+If you don't need @child_source to do anything on its own when it
+triggers, you can call g_source_set_dummy_callback() on it to set a
+callback that does nothing (except return %TRUE if appropriate).
+
+ source will hold a reference on @child_source while @child_source
+is attached to it.
+
+Since: 2.28
+
+</description>
+<parameters>
+<parameter name="source">
+<parameter_description>a #GSource
+</parameter_description>
+</parameter>
+<parameter name="child_source">
+<parameter_description> a second #GSource that @source should "poll"
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_source_add_poll">
+<description>
+Adds a file descriptor to the set of file descriptors polled for
+this source. This is usually combined with g_source_new() to add an
+event source. The event source's check function will typically test
+the @revents field in the #GPollFD struct and return %TRUE if events need
+to be processed.
+
+</description>
+<parameters>
+<parameter name="source">
+<parameter_description>a #GSource
+</parameter_description>
+</parameter>
+<parameter name="fd">
+<parameter_description> a #GPollFD structure holding information about a file
+descriptor to watch.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_source_attach">
+<description>
+Adds a #GSource to a @context so that it will be executed within
+that context. Remove it by calling g_source_destroy().
+
+
+</description>
+<parameters>
+<parameter name="source">
+<parameter_description> a #GSource
+</parameter_description>
+</parameter>
+<parameter name="context">
+<parameter_description> a #GMainContext (if %NULL, the default context will be used)
+</parameter_description>
+</parameter>
+</parameters>
+<return> the ID (greater than 0) for the source within the
+#GMainContext.
+</return>
+</function>
+
+<function name="g_source_destroy">
+<description>
+Removes a source from its #GMainContext, if any, and mark it as
+destroyed. The source cannot be subsequently added to another
+context.
+
+</description>
+<parameters>
+<parameter name="source">
+<parameter_description> a #GSource
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_source_get_can_recurse">
+<description>
+Checks whether a source is allowed to be called recursively.
+see g_source_set_can_recurse().
+
+
+</description>
+<parameters>
+<parameter name="source">
+<parameter_description> a #GSource
+</parameter_description>
+</parameter>
+</parameters>
+<return> whether recursion is allowed.
+</return>
+</function>
+
+<function name="g_source_get_context">
+<description>
+Gets the #GMainContext with which the source is associated.
+Calling this function on a destroyed source is an error.
+
+
+</description>
+<parameters>
+<parameter name="source">
+<parameter_description> a #GSource
+</parameter_description>
+</parameter>
+</parameters>
+<return> the #GMainContext with which the source is associated,
+or %NULL if the context has not yet been added
+to a source.
+</return>
+</function>
+
+<function name="g_source_get_current_time">
+<description>
+Gets the "current time" to be used when checking
+this source. The advantage of calling this function over
+calling g_get_current_time() directly is that when
+checking multiple sources, GLib can cache a single value
+instead of having to repeatedly get the system time.
+
+Deprecated: 2.28: use g_source_get_time() instead
+
+</description>
+<parameters>
+<parameter name="source">
+<parameter_description> a #GSource
+</parameter_description>
+</parameter>
+<parameter name="timeval">
+<parameter_description> #GTimeVal structure in which to store current time.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_source_get_id">
+<description>
+Returns the numeric ID for a particular source. The ID of a source
+is a positive integer which is unique within a particular main loop
+context. The reverse
+mapping from ID to source is done by g_main_context_find_source_by_id().
+
+
+</description>
+<parameters>
+<parameter name="source">
+<parameter_description> a #GSource
+</parameter_description>
+</parameter>
+</parameters>
+<return> the ID (greater than 0) for the source
+</return>
+</function>
+
+<function name="g_source_get_name">
+<description>
+Gets a name for the source, used in debugging and profiling.
+The name may be #NULL if it has never been set with
+g_source_set_name().
+
+Since: 2.26
+
+</description>
+<parameters>
+<parameter name="source">
+<parameter_description> a #GSource
+</parameter_description>
+</parameter>
+</parameters>
+<return> the name of the source
+</return>
+</function>
+
+<function name="g_source_get_priority">
+<description>
+Gets the priority of a source.
+
+
+</description>
+<parameters>
+<parameter name="source">
+<parameter_description> a #GSource
+</parameter_description>
+</parameter>
+</parameters>
+<return> the priority of the source
+</return>
+</function>
+
+<function name="g_source_get_time">
+<description>
+Gets the time to be used when checking this source. The advantage of
+calling this function over calling g_get_monotonic_time() directly is
+that when checking multiple sources, GLib can cache a single value
+instead of having to repeatedly get the system monotonic time.
+
+The time here is the system monotonic time, if available, or some
+other reasonable alternative otherwise. See g_get_monotonic_time().
+
+Since: 2.28
+
+</description>
+<parameters>
+<parameter name="source">
+<parameter_description> a #GSource
+</parameter_description>
+</parameter>
+</parameters>
+<return> the monotonic time in microseconds
+
+</return>
+</function>
+
+<function name="g_source_is_destroyed">
+<description>
+Returns whether @source has been destroyed.
+
+This is important when you operate upon your objects
+from within idle handlers, but may have freed the object
+before the dispatch of your idle handler.
+
+|[
+static gboolean
+idle_callback (gpointer data)
+{
+SomeWidget *self = data;
+
+GDK_THREADS_ENTER (<!-- -->);
+/<!-- -->* do stuff with self *<!-- -->/
+self->idle_id = 0;
+GDK_THREADS_LEAVE (<!-- -->);
+
+return FALSE;
+}
+
+static void
+some_widget_do_stuff_later (SomeWidget *self)
+{
+self->idle_id = g_idle_add (idle_callback, self);
+}
+
+static void
+some_widget_finalize (GObject *object)
+{
+SomeWidget *self = SOME_WIDGET (object);
+
+if (self->idle_id)
+g_source_remove (self->idle_id);
+
+G_OBJECT_CLASS (parent_class)->finalize (object);
+}
+]|
+
+This will fail in a multi-threaded application if the
+widget is destroyed before the idle handler fires due
+to the use after free in the callback. A solution, to
+this particular problem, is to check to if the source
+has already been destroy within the callback.
+
+|[
+static gboolean
+idle_callback (gpointer data)
+{
+SomeWidget *self = data;
+
+GDK_THREADS_ENTER ();
+if (!g_source_is_destroyed (g_main_current_source ()))
+{
+/<!-- -->* do stuff with self *<!-- -->/
+}
+GDK_THREADS_LEAVE ();
+
+return FALSE;
+}
+]|
+
+Since: 2.12
+
+</description>
+<parameters>
+<parameter name="source">
+<parameter_description> a #GSource
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the source has been destroyed
+
+</return>
+</function>
+
+<function name="g_source_new">
+<description>
+Creates a new #GSource structure. The size is specified to
+allow creating structures derived from #GSource that contain
+additional data. The size passed in must be at least
+<literal>sizeof (GSource)</literal>.
+
+The source will not initially be associated with any #GMainContext
+and must be added to one with g_source_attach() before it will be
+executed.
+
+
+</description>
+<parameters>
+<parameter name="source_funcs">
+<parameter_description> structure containing functions that implement
+the sources behavior.
+</parameter_description>
+</parameter>
+<parameter name="struct_size">
+<parameter_description> size of the #GSource structure to create.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the newly-created #GSource.
+</return>
+</function>
+
+<function name="g_source_ref">
+<description>
+Increases the reference count on a source by one.
+
+
+</description>
+<parameters>
+<parameter name="source">
+<parameter_description> a #GSource
+</parameter_description>
+</parameter>
+</parameters>
+<return> @source
+</return>
+</function>
+
+<function name="g_source_remove">
+<description>
+Removes the source with the given id from the default main context.
+The id of
+a #GSource is given by g_source_get_id(), or will be returned by the
+functions g_source_attach(), g_idle_add(), g_idle_add_full(),
+g_timeout_add(), g_timeout_add_full(), g_child_watch_add(),
+g_child_watch_add_full(), g_io_add_watch(), and g_io_add_watch_full().
+
+See also g_source_destroy(). You must use g_source_destroy() for sources
+added to a non-default main context.
+
+
+</description>
+<parameters>
+<parameter name="tag">
+<parameter_description> the ID of the source to remove.
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the source was found and removed.
+</return>
+</function>
+
+<function name="g_source_remove_by_funcs_user_data">
+<description>
+Removes a source from the default main loop context given the
+source functions and user data. If multiple sources exist with the
+same source functions and user data, only one will be destroyed.
+
+
+</description>
+<parameters>
+<parameter name="funcs">
+<parameter_description> The @source_funcs passed to g_source_new()
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> the user data for the callback
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if a source was found and removed.
+</return>
+</function>
+
+<function name="g_source_remove_by_user_data">
+<description>
+Removes a source from the default main loop context given the user
+data for the callback. If multiple sources exist with the same user
+data, only one will be destroyed.
+
+
+</description>
+<parameters>
+<parameter name="user_data">
+<parameter_description> the user_data for the callback.
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if a source was found and removed.
+</return>
+</function>
+
+<function name="g_source_remove_child_source">
+<description>
+Detaches @child_source from @source and destroys it.
+
+Since: 2.28
+
+</description>
+<parameters>
+<parameter name="source">
+<parameter_description>a #GSource
+</parameter_description>
+</parameter>
+<parameter name="child_source">
+<parameter_description> a #GSource previously passed to
+g_source_add_child_source().
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_source_remove_poll">
+<description>
+Removes a file descriptor from the set of file descriptors polled for
+this source.
+
+</description>
+<parameters>
+<parameter name="source">
+<parameter_description>a #GSource
+</parameter_description>
+</parameter>
+<parameter name="fd">
+<parameter_description> a #GPollFD structure previously passed to g_source_add_poll().
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_source_set_callback">
+<description>
+Sets the callback function for a source. The callback for a source is
+called from the source's dispatch function.
+
+The exact type of @func depends on the type of source; ie. you
+should not count on @func being called with @data as its first
+parameter.
+
+Typically, you won't use this function. Instead use functions specific
+to the type of source you are using.
+
+</description>
+<parameters>
+<parameter name="source">
+<parameter_description> the source
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> a callback function
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> the data to pass to callback function
+</parameter_description>
+</parameter>
+<parameter name="notify">
+<parameter_description> a function to call when @data is no longer in use, or %NULL.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_source_set_callback_indirect">
+<description>
+Sets the callback function storing the data as a refcounted callback
+"object". This is used internally. Note that calling
+g_source_set_callback_indirect() assumes
+an initial reference count on @callback_data, and thus
+ callback_funcs->unref will eventually be called once more
+than @callback_funcs->ref.
+
+</description>
+<parameters>
+<parameter name="source">
+<parameter_description> the source
+</parameter_description>
+</parameter>
+<parameter name="callback_data">
+<parameter_description> pointer to callback data "object"
+</parameter_description>
+</parameter>
+<parameter name="callback_funcs">
+<parameter_description> functions for reference counting @callback_data
+and getting the callback and data
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_source_set_can_recurse">
+<description>
+Sets whether a source can be called recursively. If @can_recurse is
+%TRUE, then while the source is being dispatched then this source
+will be processed normally. Otherwise, all processing of this
+source is blocked until the dispatch function returns.
+
+</description>
+<parameters>
+<parameter name="source">
+<parameter_description> a #GSource
+</parameter_description>
+</parameter>
+<parameter name="can_recurse">
+<parameter_description> whether recursion is allowed for this source
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_source_set_closure">
+<description>
+Set the callback for a source as a #GClosure.
+
+If the source is not one of the standard GLib types, the @closure_callback
+and @closure_marshal fields of the #GSourceFuncs structure must have been
+filled in with pointers to appropriate functions.
+
+</description>
+<parameters>
+<parameter name="source">
+<parameter_description> the source
+</parameter_description>
+</parameter>
+<parameter name="closure">
+<parameter_description> a #GClosure
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_source_set_dummy_callback">
+<description>
+Sets a dummy callback for @source. The callback will do nothing, and
+if the source expects a #gboolean return value, it will return %TRUE.
+(If the source expects any other type of return value, it will return
+a 0/%NULL value; whatever g_value_init() initializes a #GValue to for
+that type.)
+
+If the source is not one of the standard GLib types, the
+ closure_callback and @closure_marshal fields of the #GSourceFuncs
+structure must have been filled in with pointers to appropriate
+functions.
+
+</description>
+<parameters>
+<parameter name="source">
+<parameter_description> the source
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_source_set_funcs">
+<description>
+Sets the source functions (can be used to override
+default implementations) of an unattached source.
+
+Since: 2.12
+
+</description>
+<parameters>
+<parameter name="source">
+<parameter_description> a #GSource
+</parameter_description>
+</parameter>
+<parameter name="funcs">
+<parameter_description> the new #GSourceFuncs
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_source_set_name">
+<description>
+Sets a name for the source, used in debugging and profiling.
+The name defaults to #NULL.
+
+The source name should describe in a human-readable way
+what the source does. For example, "X11 event queue"
+or "GTK+ repaint idle handler" or whatever it is.
+
+It is permitted to call this function multiple times, but is not
+recommended due to the potential performance impact. For example,
+one could change the name in the "check" function of a #GSourceFuncs
+to include details like the event type in the source name.
+
+Since: 2.26
+
+</description>
+<parameters>
+<parameter name="source">
+<parameter_description> a #GSource
+</parameter_description>
+</parameter>
+<parameter name="name">
+<parameter_description> debug name for the source
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_source_set_name_by_id">
+<description>
+Sets the name of a source using its ID.
+
+This is a convenience utility to set source names from the return
+value of g_idle_add(), g_timeout_add(), etc.
+
+Since: 2.26
+
+</description>
+<parameters>
+<parameter name="tag">
+<parameter_description> a #GSource ID
+</parameter_description>
+</parameter>
+<parameter name="name">
+<parameter_description> debug name for the source
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_source_set_priority">
+<description>
+Sets the priority of a source. While the main loop is being run, a
+source will be dispatched if it is ready to be dispatched and no
+sources at a higher (numerically smaller) priority are ready to be
+dispatched.
+
+</description>
+<parameters>
+<parameter name="source">
+<parameter_description> a #GSource
+</parameter_description>
+</parameter>
+<parameter name="priority">
+<parameter_description> the new priority.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_source_unref">
+<description>
+Decreases the reference count of a source by one. If the
+resulting reference count is zero the source and associated
+memory will be destroyed.
+
+</description>
+<parameters>
+<parameter name="source">
+<parameter_description> a #GSource
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_spaced_primes_closest">
+<description>
+Gets the smallest prime number from a built-in array of primes which
+is larger than @num. This is used within GLib to calculate the optimum
+size of a #GHashTable.
+
+The built-in array of primes ranges from 11 to 13845163 such that
+each prime is approximately 1.5-2 times the previous prime.
+
+
+</description>
+<parameters>
+<parameter name="num">
+<parameter_description> a #guint
+</parameter_description>
+</parameter>
+</parameters>
+<return> the smallest prime number from a built-in array of primes
+which is larger than @num
+</return>
+</function>
+
+<function name="g_spawn_async">
+<description>
+See g_spawn_async_with_pipes() for a full description; this function
+simply calls the g_spawn_async_with_pipes() without any pipes.
+
+You should call g_spawn_close_pid() on the returned child process
+reference when you don't need it any more.
+
+<note><para>
+If you are writing a GTK+ application, and the program you
+are spawning is a graphical application, too, then you may
+want to use gdk_spawn_on_screen() instead to ensure that
+the spawned program opens its windows on the right screen.
+</para></note>
+
+<note><para> Note that the returned @child_pid on Windows is a
+handle to the child process and not its identifier. Process handles
+and process identifiers are different concepts on Windows.
+</para></note>
+
+
+</description>
+<parameters>
+<parameter name="working_directory">
+<parameter_description> child's current working directory, or %NULL to inherit parent's
+</parameter_description>
+</parameter>
+<parameter name="argv">
+<parameter_description> child's argument vector
+</parameter_description>
+</parameter>
+<parameter name="envp">
+<parameter_description> child's environment, or %NULL to inherit parent's
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> flags from #GSpawnFlags
+</parameter_description>
+</parameter>
+<parameter name="child_setup">
+<parameter_description> function to run in the child just before exec()
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> user data for @child_setup
+</parameter_description>
+</parameter>
+<parameter name="child_pid">
+<parameter_description> return location for child process reference, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for error
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE on success, %FALSE if error is set
+</return>
+</function>
+
+<function name="g_spawn_async_with_pipes">
+<description>
+Executes a child program asynchronously (your program will not
+block waiting for the child to exit). The child program is
+specified by the only argument that must be provided, @argv. @argv
+should be a %NULL-terminated array of strings, to be passed as the
+argument vector for the child. The first string in @argv is of
+course the name of the program to execute. By default, the name of
+the program must be a full path; the <envar>PATH</envar> shell variable
+will only be searched if you pass the %G_SPAWN_SEARCH_PATH flag.
+
+On Windows, note that all the string or string vector arguments to
+this function and the other g_spawn*() functions are in UTF-8, the
+GLib file name encoding. Unicode characters that are not part of
+the system codepage passed in these arguments will be correctly
+available in the spawned program only if it uses wide character API
+to retrieve its command line. For C programs built with Microsoft's
+tools it is enough to make the program have a wmain() instead of
+main(). wmain() has a wide character argument vector as parameter.
+
+At least currently, mingw doesn't support wmain(), so if you use
+mingw to develop the spawned program, it will have to call the
+undocumented function __wgetmainargs() to get the wide character
+argument vector and environment. See gspawn-win32-helper.c in the
+GLib sources or init.c in the mingw runtime sources for a prototype
+for that function. Alternatively, you can retrieve the Win32 system
+level wide character command line passed to the spawned program
+using the GetCommandLineW() function.
+
+On Windows the low-level child process creation API
+<function>CreateProcess()</function> doesn't use argument vectors,
+but a command line. The C runtime library's
+<function>spawn*()</function> family of functions (which
+g_spawn_async_with_pipes() eventually calls) paste the argument
+vector elements together into a command line, and the C runtime startup code
+does a corresponding reconstruction of an argument vector from the
+command line, to be passed to main(). Complications arise when you have
+argument vector elements that contain spaces of double quotes. The
+<function>spawn*()</function> functions don't do any quoting or
+escaping, but on the other hand the startup code does do unquoting
+and unescaping in order to enable receiving arguments with embedded
+spaces or double quotes. To work around this asymmetry,
+g_spawn_async_with_pipes() will do quoting and escaping on argument
+vector elements that need it before calling the C runtime
+spawn() function.
+
+The returned @child_pid on Windows is a handle to the child
+process, not its identifier. Process handles and process
+identifiers are different concepts on Windows.
+
+ envp is a %NULL-terminated array of strings, where each string
+has the form <literal>KEY=VALUE</literal>. This will become
+the child's environment. If @envp is %NULL, the child inherits its
+parent's environment.
+
+ flags should be the bitwise OR of any flags you want to affect the
+function's behaviour. The %G_SPAWN_DO_NOT_REAP_CHILD means that
+the child will not automatically be reaped; you must use a
+#GChildWatch source to be notified about the death of the child
+process. Eventually you must call g_spawn_close_pid() on the
+ child_pid, in order to free resources which may be associated
+with the child process. (On Unix, using a #GChildWatch source is
+equivalent to calling waitpid() or handling the %SIGCHLD signal
+manually. On Windows, calling g_spawn_close_pid() is equivalent
+to calling CloseHandle() on the process handle returned in
+ child_pid).
+
+%G_SPAWN_LEAVE_DESCRIPTORS_OPEN means that the parent's open file
+descriptors will be inherited by the child; otherwise all
+descriptors except stdin/stdout/stderr will be closed before
+calling exec() in the child. %G_SPAWN_SEARCH_PATH
+means that <literal>argv[0]</literal> need not be an absolute path, it
+will be looked for in the user's <envar>PATH</envar>.
+%G_SPAWN_STDOUT_TO_DEV_NULL means that the child's standard output will
+be discarded, instead of going to the same location as the parent's
+standard output. If you use this flag, @standard_output must be %NULL.
+%G_SPAWN_STDERR_TO_DEV_NULL means that the child's standard error
+will be discarded, instead of going to the same location as the parent's
+standard error. If you use this flag, @standard_error must be %NULL.
+%G_SPAWN_CHILD_INHERITS_STDIN means that the child will inherit the parent's
+standard input (by default, the child's standard input is attached to
+/dev/null). If you use this flag, @standard_input must be %NULL.
+%G_SPAWN_FILE_AND_ARGV_ZERO means that the first element of @argv is
+the file to execute, while the remaining elements are the
+actual argument vector to pass to the file. Normally
+g_spawn_async_with_pipes() uses @argv[0] as the file to execute, and
+passes all of @argv to the child.
+
+ child_setup and @user_data are a function and user data. On POSIX
+platforms, the function is called in the child after GLib has
+performed all the setup it plans to perform (including creating
+pipes, closing file descriptors, etc.) but before calling
+exec(). That is, @child_setup is called just
+before calling exec() in the child. Obviously
+actions taken in this function will only affect the child, not the
+parent.
+
+On Windows, there is no separate fork() and exec()
+functionality. Child processes are created and run with a single
+API call, CreateProcess(). There is no sensible thing @child_setup
+could be used for on Windows so it is ignored and not called.
+
+If non-%NULL, @child_pid will on Unix be filled with the child's
+process ID. You can use the process ID to send signals to the
+child, or to use g_child_watch_add() (or waitpid()) if you specified the
+%G_SPAWN_DO_NOT_REAP_CHILD flag. On Windows, @child_pid will be
+filled with a handle to the child process only if you specified the
+%G_SPAWN_DO_NOT_REAP_CHILD flag. You can then access the child
+process using the Win32 API, for example wait for its termination
+with the <function>WaitFor*()</function> functions, or examine its
+exit code with GetExitCodeProcess(). You should close the handle
+with CloseHandle() or g_spawn_close_pid() when you no longer need it.
+
+If non-%NULL, the @standard_input, @standard_output, @standard_error
+locations will be filled with file descriptors for writing to the child's
+standard input or reading from its standard output or standard error.
+The caller of g_spawn_async_with_pipes() must close these file descriptors
+when they are no longer in use. If these parameters are %NULL, the corresponding
+pipe won't be created.
+
+If @standard_input is NULL, the child's standard input is attached to
+/dev/null unless %G_SPAWN_CHILD_INHERITS_STDIN is set.
+
+If @standard_error is NULL, the child's standard error goes to the same
+location as the parent's standard error unless %G_SPAWN_STDERR_TO_DEV_NULL
+is set.
+
+If @standard_output is NULL, the child's standard output goes to the same
+location as the parent's standard output unless %G_SPAWN_STDOUT_TO_DEV_NULL
+is set.
+
+ error can be %NULL to ignore errors, or non-%NULL to report errors.
+If an error is set, the function returns %FALSE. Errors
+are reported even if they occur in the child (for example if the
+executable in <literal>argv[0]</literal> is not found). Typically
+the <literal>message</literal> field of returned errors should be displayed
+to users. Possible errors are those from the #G_SPAWN_ERROR domain.
+
+If an error occurs, @child_pid, @standard_input, @standard_output,
+and @standard_error will not be filled with valid values.
+
+If @child_pid is not %NULL and an error does not occur then the returned
+process reference must be closed using g_spawn_close_pid().
+
+<note><para>
+If you are writing a GTK+ application, and the program you
+are spawning is a graphical application, too, then you may
+want to use gdk_spawn_on_screen_with_pipes() instead to ensure that
+the spawned program opens its windows on the right screen.
+</para></note>
+
+
+</description>
+<parameters>
+<parameter name="working_directory">
+<parameter_description> child's current working directory, or %NULL to inherit parent's, in the GLib file name encoding
+</parameter_description>
+</parameter>
+<parameter name="argv">
+<parameter_description> child's argument vector, in the GLib file name encoding
+</parameter_description>
+</parameter>
+<parameter name="envp">
+<parameter_description> child's environment, or %NULL to inherit parent's, in the GLib file name encoding
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> flags from #GSpawnFlags
+</parameter_description>
+</parameter>
+<parameter name="child_setup">
+<parameter_description> function to run in the child just before exec()
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> user data for @child_setup
+</parameter_description>
+</parameter>
+<parameter name="child_pid">
+<parameter_description> return location for child process ID, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="standard_input">
+<parameter_description> return location for file descriptor to write to child's stdin, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="standard_output">
+<parameter_description> return location for file descriptor to read child's stdout, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="standard_error">
+<parameter_description> return location for file descriptor to read child's stderr, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for error
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE on success, %FALSE if an error was set
+</return>
+</function>
+
+<function name="g_spawn_close_pid">
+<description>
+On some platforms, notably Windows, the #GPid type represents a resource
+which must be closed to prevent resource leaking. g_spawn_close_pid()
+is provided for this purpose. It should be used on all platforms, even
+though it doesn't do anything under UNIX.
+
+</description>
+<parameters>
+<parameter name="pid">
+<parameter_description> The process reference to close
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_spawn_command_line_async">
+<description>
+A simple version of g_spawn_async() that parses a command line with
+g_shell_parse_argv() and passes it to g_spawn_async(). Runs a
+command line in the background. Unlike g_spawn_async(), the
+%G_SPAWN_SEARCH_PATH flag is enabled, other flags are not. Note
+that %G_SPAWN_SEARCH_PATH can have security implications, so
+consider using g_spawn_async() directly if appropriate. Possible
+errors are those from g_shell_parse_argv() and g_spawn_async().
+
+The same concerns on Windows apply as for g_spawn_command_line_sync().
-Since: 2.14
</description>
<parameters>
-<parameter name="regex">
-<parameter_description> a #GRegex structure from g_regex_new()
-</parameter_description>
-</parameter>
-<parameter name="string">
-<parameter_description> string to perform matches against
+<parameter name="command_line">
+<parameter_description> a command line
</parameter_description>
</parameter>
-<parameter name="string_len">
-<parameter_description> the length of @string, or -1 if @string is nul-terminated
+<parameter name="error">
+<parameter_description> return location for errors
</parameter_description>
</parameter>
-<parameter name="start_position">
-<parameter_description> starting index of the string to match
+</parameters>
+<return> %TRUE on success, %FALSE if error is set.
+</return>
+</function>
+
+<function name="g_spawn_command_line_sync">
+<description>
+A simple version of g_spawn_sync() with little-used parameters
+removed, taking a command line instead of an argument vector. See
+g_spawn_sync() for full details. @command_line will be parsed by
+g_shell_parse_argv(). Unlike g_spawn_sync(), the %G_SPAWN_SEARCH_PATH flag
+is enabled. Note that %G_SPAWN_SEARCH_PATH can have security
+implications, so consider using g_spawn_sync() directly if
+appropriate. Possible errors are those from g_spawn_sync() and those
+from g_shell_parse_argv().
+
+If @exit_status is non-%NULL, the exit status of the child is stored there as
+it would be returned by waitpid(); standard UNIX macros such as WIFEXITED()
+and WEXITSTATUS() must be used to evaluate the exit status.
+
+On Windows, please note the implications of g_shell_parse_argv()
+parsing @command_line. Parsing is done according to Unix shell rules, not
+Windows command interpreter rules.
+Space is a separator, and backslashes are
+special. Thus you cannot simply pass a @command_line containing
+canonical Windows paths, like "c:\\program files\\app\\app.exe", as
+the backslashes will be eaten, and the space will act as a
+separator. You need to enclose such paths with single quotes, like
+"'c:\\program files\\app\\app.exe' 'e:\\folder\\argument.txt'".
+
+
+</description>
+<parameters>
+<parameter name="command_line">
+<parameter_description> a command line
</parameter_description>
</parameter>
-<parameter name="match_options">
-<parameter_description> options for the match
+<parameter name="standard_output">
+<parameter_description> return location for child output
</parameter_description>
</parameter>
-<parameter name="eval">
-<parameter_description> a function to call for each match
+<parameter name="standard_error">
+<parameter_description> return location for child errors
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> user data to pass to the function
+<parameter name="exit_status">
+<parameter_description> return location for child exit status, as returned by waitpid()
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> location to store the error occuring, or %NULL to ignore errors
+<parameter_description> return location for errors
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated string containing the replacements
-
+<return> %TRUE on success, %FALSE if an error was set
</return>
</function>
-<function name="g_regex_replace_literal">
+<function name="g_spawn_sync">
<description>
-Replaces all occurrences of the pattern in @regex with the
-replacement text. @replacement is replaced literally, to
-include backreferences use g_regex_replace().
+Executes a child synchronously (waits for the child to exit before returning).
+All output from the child is stored in @standard_output and @standard_error,
+if those parameters are non-%NULL. Note that you must set the
+%G_SPAWN_STDOUT_TO_DEV_NULL and %G_SPAWN_STDERR_TO_DEV_NULL flags when
+passing %NULL for @standard_output and @standard_error.
+If @exit_status is non-%NULL, the exit status of the child is stored
+there as it would be returned by waitpid(); standard UNIX macros such
+as WIFEXITED() and WEXITSTATUS() must be used to evaluate the exit status.
+Note that this function call waitpid() even if @exit_status is %NULL, and
+does not accept the %G_SPAWN_DO_NOT_REAP_CHILD flag.
+If an error occurs, no data is returned in @standard_output,
+ standard_error, or @exit_status.
-Setting @start_position differs from just passing over a
-shortened string and setting #G_REGEX_MATCH_NOTBOL in the
-case of a pattern that begins with any kind of lookbehind
-assertion, such as "\b".
+This function calls g_spawn_async_with_pipes() internally; see that
+function for full details on the other parameters and details on
+how these functions work on Windows.
-Since: 2.14
</description>
<parameters>
-<parameter name="regex">
-<parameter_description> a #GRegex structure
+<parameter name="working_directory">
+<parameter_description> child's current working directory, or %NULL to inherit parent's
</parameter_description>
</parameter>
-<parameter name="string">
-<parameter_description> the string to perform matches against
+<parameter name="argv">
+<parameter_description> child's argument vector
</parameter_description>
</parameter>
-<parameter name="string_len">
-<parameter_description> the length of @string, or -1 if @string is nul-terminated
+<parameter name="envp">
+<parameter_description> child's environment, or %NULL to inherit parent's
</parameter_description>
</parameter>
-<parameter name="start_position">
-<parameter_description> starting index of the string to match
+<parameter name="flags">
+<parameter_description> flags from #GSpawnFlags
</parameter_description>
</parameter>
-<parameter name="replacement">
-<parameter_description> text to replace each match with
+<parameter name="child_setup">
+<parameter_description> function to run in the child just before exec()
</parameter_description>
</parameter>
-<parameter name="match_options">
-<parameter_description> options for the match
+<parameter name="user_data">
+<parameter_description> user data for @child_setup
+</parameter_description>
+</parameter>
+<parameter name="standard_output">
+<parameter_description> return location for child output, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="standard_error">
+<parameter_description> return location for child error messages, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="exit_status">
+<parameter_description> return location for child exit status, as returned by waitpid(), or %NULL
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> location to store the error occuring, or %NULL to ignore errors
+<parameter_description> return location for error, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated string containing the replacements
-
+<return> %TRUE on success, %FALSE if an error was set.
</return>
</function>
-<function name="g_regex_split">
+<function name="g_sprintf">
<description>
-Breaks the string on the pattern, and returns an array of the tokens.
-If the pattern contains capturing parentheses, then the text for each
-of the substrings will also be returned. If the pattern does not match
-anywhere in the string, then the whole string is returned as the first
-token.
+An implementation of the standard sprintf() function which supports
+positional parameters, as specified in the Single Unix Specification.
-As a special case, the result of splitting the empty string "" is an
-empty vector, not a vector containing a single string. The reason for
-this special case is that being able to represent a empty vector is
-typically more useful than consistent handling of empty elements. If
-you do need to represent empty elements, you'll need to check for the
-empty string before calling this function.
+Note that it is usually better to use g_snprintf(), to avoid the
+risk of buffer overflow.
-A pattern that can match empty strings splits @string into separate
-characters wherever it matches the empty string between characters.
-For example splitting "ab c" using as a separator "\s*", you will get
-"a", "b" and "c".
+See also g_strdup_printf().
-Since: 2.14
+Since: 2.2
</description>
<parameters>
-<parameter name="regex">
-<parameter_description> a #GRegex structure
+<parameter name="string">
+<parameter_description> A pointer to a memory buffer to contain the resulting string. It
+is up to the caller to ensure that the allocated buffer is large
+enough to hold the formatted result
</parameter_description>
</parameter>
-<parameter name="string">
-<parameter_description> the string to split with the pattern
+<parameter name="format">
+<parameter_description> a standard printf() format string, but notice
+<link linkend="string-precision">string precision pitfalls</link>.
</parameter_description>
</parameter>
-<parameter name="match_options">
-<parameter_description> match time option flags
+<parameter name="Varargs">
+<parameter_description> the arguments to insert in the output.
</parameter_description>
</parameter>
</parameters>
-<return> a %NULL-terminated gchar ** array. Free it using g_strfreev()
+<return> the number of bytes printed.
</return>
</function>
-<function name="g_regex_split_full">
+<function name="g_stat">
<description>
-Breaks the string on the pattern, and returns an array of the tokens.
-If the pattern contains capturing parentheses, then the text for each
-of the substrings will also be returned. If the pattern does not match
-anywhere in the string, then the whole string is returned as the first
-token.
+A wrapper for the POSIX stat() function. The stat() function
+returns information about a file. On Windows the stat() function in
+the C library checks only the FAT-style READONLY attribute and does
+not look at the ACL at all. Thus on Windows the protection bits in
+the st_mode field are a fabrication of little use.
-As a special case, the result of splitting the empty string "" is an
-empty vector, not a vector containing a single string. The reason for
-this special case is that being able to represent a empty vector is
-typically more useful than consistent handling of empty elements. If
-you do need to represent empty elements, you'll need to check for the
-empty string before calling this function.
+On Windows the Microsoft C libraries have several variants of the
+<structname>stat</structname> struct and stat() function with names
+like "_stat", "_stat32", "_stat32i64" and "_stat64i32". The one
+used here is for 32-bit code the one with 32-bit size and time
+fields, specifically called "_stat32".
-A pattern that can match empty strings splits @string into separate
-characters wherever it matches the empty string between characters.
-For example splitting "ab c" using as a separator "\s*", you will get
-"a", "b" and "c".
+In Microsoft's compiler, by default "struct stat" means one with
+64-bit time fields while in MinGW "struct stat" is the legacy one
+with 32-bit fields. To hopefully clear up this messs, the gstdio.h
+header defines a type GStatBuf which is the appropriate struct type
+depending on the platform and/or compiler being used. On POSIX it
+is just "struct stat", but note that even on POSIX platforms,
+"stat" might be a macro.
-Setting @start_position differs from just passing over a shortened
-string and setting #G_REGEX_MATCH_NOTBOL in the case of a pattern
-that begins with any kind of lookbehind assertion, such as "\b".
+See your C library manual for more details about stat().
-Since: 2.14
+Since: 2.6
</description>
<parameters>
-<parameter name="regex">
-<parameter_description> a #GRegex structure
-</parameter_description>
-</parameter>
-<parameter name="string">
-<parameter_description> the string to split with the pattern
-</parameter_description>
-</parameter>
-<parameter name="string_len">
-<parameter_description> the length of @string, or -1 if @string is nul-terminated
-</parameter_description>
-</parameter>
-<parameter name="start_position">
-<parameter_description> starting index of the string to match
-</parameter_description>
-</parameter>
-<parameter name="match_options">
-<parameter_description> match time option flags
-</parameter_description>
-</parameter>
-<parameter name="max_tokens">
-<parameter_description> the maximum number of tokens to split @string into.
-If this is less than 1, the string is split completely
+<parameter name="filename">
+<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows)
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError
+<parameter name="buf">
+<parameter_description> a pointer to a <structname>stat</structname> struct, which
+will be filled with the file information
</parameter_description>
</parameter>
</parameters>
-<return> a %NULL-terminated gchar ** array. Free it using g_strfreev()
+<return> 0 if the information was successfully retrieved, -1 if an error
+occurred
</return>
</function>
-<function name="g_regex_split_simple">
+<function name="g_static_mutex_free">
<description>
-Breaks the string on the pattern, and returns an array of
-the tokens. If the pattern contains capturing parentheses,
-then the text for each of the substrings will also be returned.
-If the pattern does not match anywhere in the string, then the
-whole string is returned as the first token.
-
-This function is equivalent to g_regex_split() but it does
-not require to compile the pattern with g_regex_new(), avoiding
-some lines of code when you need just to do a split without
-extracting substrings, capture counts, and so on.
+Releases all resources allocated to @mutex.
-If this function is to be called on the same @pattern more than
-once, it's more efficient to compile the pattern once with
-g_regex_new() and then use g_regex_split().
+You don't have to call this functions for a #GStaticMutex with an
+unbounded lifetime, i.e. objects declared 'static', but if you have
+a #GStaticMutex as a member of a structure and the structure is
+freed, you should also free the #GStaticMutex.
-As a special case, the result of splitting the empty string ""
-is an empty vector, not a vector containing a single string.
-The reason for this special case is that being able to represent
-a empty vector is typically more useful than consistent handling
-of empty elements. If you do need to represent empty elements,
-you'll need to check for the empty string before calling this
-function.
+<note><para>Calling g_static_mutex_free() on a locked mutex may
+result in undefined behaviour.</para></note>
-A pattern that can match empty strings splits @string into
-separate characters wherever it matches the empty string between
-characters. For example splitting "ab c" using as a separator
-"\s*", you will get "a", "b" and "c".
+</description>
+<parameters>
+<parameter name="mutex">
+<parameter_description> a #GStaticMutex to be freed.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
-Since: 2.14
+<function name="g_static_mutex_get_mutex">
+<description>
+For some operations (like g_cond_wait()) you must have a #GMutex
+instead of a #GStaticMutex. This function will return the
+corresponding #GMutex for @mutex.
</description>
<parameters>
-<parameter name="pattern">
-<parameter_description> the regular expression
+<parameter name="mutex">
+<parameter_description> a #GStaticMutex.
</parameter_description>
</parameter>
-<parameter name="string">
-<parameter_description> the string to scan for matches
+</parameters>
+<return> the #GMutex corresponding to @mutex.
+</return>
+</function>
+
+<function name="g_static_mutex_init">
+<description>
+Initializes @mutex. Alternatively you can initialize it with
+#G_STATIC_MUTEX_INIT.
+
+</description>
+<parameters>
+<parameter name="mutex">
+<parameter_description> a #GStaticMutex to be initialized.
</parameter_description>
</parameter>
-<parameter name="compile_options">
-<parameter_description> compile options for the regular expression, or 0
+</parameters>
+<return></return>
+</function>
+
+<function name="g_static_mutex_lock">
+<description>
+Works like g_mutex_lock(), but for a #GStaticMutex.
+
+</description>
+<parameters>
+<parameter name="mutex">
+<parameter_description> a #GStaticMutex.
</parameter_description>
</parameter>
-<parameter name="match_options">
-<parameter_description> match options, or 0
+</parameters>
+<return></return>
+</function>
+
+<function name="g_static_mutex_trylock">
+<description>
+Works like g_mutex_trylock(), but for a #GStaticMutex.
+
+</description>
+<parameters>
+<parameter name="mutex">
+<parameter_description> a #GStaticMutex.
</parameter_description>
</parameter>
</parameters>
-<return> a %NULL-terminated array of strings. Free it using g_strfreev()
-
+<return> %TRUE, if the #GStaticMutex could be locked.
</return>
</function>
-<function name="g_regex_unref">
+<function name="g_static_mutex_unlock">
<description>
-Decreases reference count of @regex by 1. When reference count drops
-to zero, it frees all the memory associated with the regex structure.
-
-Since: 2.14
+Works like g_mutex_unlock(), but for a #GStaticMutex.
</description>
<parameters>
-<parameter name="regex">
-<parameter_description> a #GRegex
+<parameter name="mutex">
+<parameter_description> a #GStaticMutex.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_relation_count">
+<function name="g_static_private_free">
<description>
-Returns the number of tuples in a #GRelation that have the given
-value in the given field.
+Releases all resources allocated to @private_key.
-Deprecated: 2.26: Rarely used API
+You don't have to call this functions for a #GStaticPrivate with an
+unbounded lifetime, i.e. objects declared 'static', but if you have
+a #GStaticPrivate as a member of a structure and the structure is
+freed, you should also free the #GStaticPrivate.
</description>
<parameters>
-<parameter name="relation">
-<parameter_description> a #GRelation.
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> the value to compare with.
-</parameter_description>
-</parameter>
-<parameter name="field">
-<parameter_description> the field of each record to match.
+<parameter name="private_key">
+<parameter_description> a #GStaticPrivate to be freed.
</parameter_description>
</parameter>
</parameters>
-<return> the number of matches.
-</return>
+<return></return>
</function>
-<function name="g_relation_delete">
+<function name="g_static_private_get">
<description>
-Deletes any records from a #GRelation that have the given key value
-in the given field.
+Works like g_private_get() only for a #GStaticPrivate.
-Deprecated: 2.26: Rarely used API
+This function works even if g_thread_init() has not yet been called.
</description>
<parameters>
-<parameter name="relation">
-<parameter_description> a #GRelation.
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> the value to compare with.
-</parameter_description>
-</parameter>
-<parameter name="field">
-<parameter_description> the field of each record to match.
+<parameter name="private_key">
+<parameter_description> a #GStaticPrivate.
</parameter_description>
</parameter>
</parameters>
-<return> the number of records deleted.
+<return> the corresponding pointer.
</return>
</function>
-<function name="g_relation_destroy">
+<function name="g_static_private_init">
<description>
-Destroys the #GRelation, freeing all memory allocated. However, it
-does not free memory allocated for the tuple data, so you should
-free that first if appropriate.
-
-Deprecated: 2.26: Rarely used API
+Initializes @private_key. Alternatively you can initialize it with
+#G_STATIC_PRIVATE_INIT.
</description>
<parameters>
-<parameter name="relation">
-<parameter_description> a #GRelation.
+<parameter name="private_key">
+<parameter_description> a #GStaticPrivate to be initialized.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_relation_exists">
+<function name="g_static_private_set">
<description>
-Returns %TRUE if a record with the given values exists in a
-#GRelation. Note that the values are compared directly, so that, for
-example, two copies of the same string will not match.
+Sets the pointer keyed to @private_key for the current thread and
+the function @notify to be called with that pointer (%NULL or
+non-%NULL), whenever the pointer is set again or whenever the
+current thread ends.
-Deprecated: 2.26: Rarely used API
+This function works even if g_thread_init() has not yet been called.
+If g_thread_init() is called later, the @data keyed to @private_key
+will be inherited only by the main thread, i.e. the one that called
+g_thread_init().
+
+<note><para>@notify is used quite differently from @destructor in
+g_private_new().</para></note>
</description>
<parameters>
-<parameter name="relation">
-<parameter_description> a #GRelation.
+<parameter name="private_key">
+<parameter_description> a #GStaticPrivate.
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> the fields of the record to compare. The number must match
-the number of fields in the #GRelation.
+<parameter name="data">
+<parameter_description> the new pointer.
+</parameter_description>
+</parameter>
+<parameter name="notify">
+<parameter_description> a function to be called with the pointer whenever the
+current thread ends or sets this pointer again.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if a record matches.
-</return>
+<return></return>
</function>
-<function name="g_relation_index">
+<function name="g_static_rec_mutex_free">
<description>
-Creates an index on the given field. Note that this must be called
-before any records are added to the #GRelation.
+Releases all resources allocated to a #GStaticRecMutex.
-Deprecated: 2.26: Rarely used API
+You don't have to call this functions for a #GStaticRecMutex with an
+unbounded lifetime, i.e. objects declared 'static', but if you have
+a #GStaticRecMutex as a member of a structure and the structure is
+freed, you should also free the #GStaticRecMutex.
</description>
<parameters>
-<parameter name="relation">
-<parameter_description> a #GRelation.
-</parameter_description>
-</parameter>
-<parameter name="field">
-<parameter_description> the field to index, counting from 0.
+<parameter name="mutex">
+<parameter_description> a #GStaticRecMutex to be freed.
</parameter_description>
</parameter>
-<parameter name="hash_func">
-<parameter_description> a function to produce a hash value from the field data.
+</parameters>
+<return></return>
+</function>
+
+<function name="g_static_rec_mutex_init">
+<description>
+A #GStaticRecMutex must be initialized with this function before it
+can be used. Alternatively you can initialize it with
+#G_STATIC_REC_MUTEX_INIT.
+
+</description>
+<parameters>
+<parameter name="mutex">
+<parameter_description> a #GStaticRecMutex to be initialized.
</parameter_description>
</parameter>
-<parameter name="key_equal_func">
-<parameter_description> a function to compare two values of the given field.
+</parameters>
+<return></return>
+</function>
+
+<function name="g_static_rec_mutex_lock">
+<description>
+Locks @mutex. If @mutex is already locked by another thread, the
+current thread will block until @mutex is unlocked by the other
+thread. If @mutex is already locked by the calling thread, this
+functions increases the depth of @mutex and returns immediately.
+
+</description>
+<parameters>
+<parameter name="mutex">
+<parameter_description> a #GStaticRecMutex to lock.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_relation_insert">
+<function name="g_static_rec_mutex_lock_full">
<description>
-Inserts a record into a #GRelation.
-
-Deprecated: 2.26: Rarely used API
+Works like calling g_static_rec_mutex_lock() for @mutex @depth times.
</description>
<parameters>
-<parameter name="relation">
-<parameter_description> a #GRelation.
+<parameter name="mutex">
+<parameter_description> a #GStaticRecMutex to lock.
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> the fields of the record to add. These must match the
-number of fields in the #GRelation, and of type #gpointer
-or #gconstpointer.
+<parameter name="depth">
+<parameter_description> number of times this mutex has to be unlocked to be
+completely unlocked.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_relation_new">
+<function name="g_static_rec_mutex_trylock">
<description>
-Creates a new #GRelation with the given number of fields. Note that
-currently the number of fields must be 2.
-
-Deprecated: 2.26: Rarely used API
+Tries to lock @mutex. If @mutex is already locked by another thread,
+it immediately returns %FALSE. Otherwise it locks @mutex and returns
+%TRUE. If @mutex is already locked by the calling thread, this
+functions increases the depth of @mutex and immediately returns
+%TRUE.
</description>
<parameters>
-<parameter name="fields">
-<parameter_description> the number of fields.
+<parameter name="mutex">
+<parameter_description> a #GStaticRecMutex to lock.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GRelation.
+<return> %TRUE, if @mutex could be locked.
</return>
</function>
-<function name="g_relation_print">
+<function name="g_static_rec_mutex_unlock">
<description>
-Outputs information about all records in a #GRelation, as well as
-the indexes. It is for debugging.
-
-Deprecated: 2.26: Rarely used API
+Unlocks @mutex. Another thread will be allowed to lock @mutex only
+when it has been unlocked as many times as it had been locked
+before. If @mutex is completely unlocked and another thread is
+blocked in a g_static_rec_mutex_lock() call for @mutex, it will be
+woken and can lock @mutex itself.
</description>
<parameters>
-<parameter name="relation">
-<parameter_description> a #GRelation.
+<parameter name="mutex">
+<parameter_description> a #GStaticRecMutex to unlock.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_relation_select">
+<function name="g_static_rec_mutex_unlock_full">
<description>
-Returns all of the tuples which have the given key in the given
-field. Use g_tuples_index() to access the returned records. The
-returned records should be freed with g_tuples_destroy().
-
-Deprecated: 2.26: Rarely used API
+Completely unlocks @mutex. If another thread is blocked in a
+g_static_rec_mutex_lock() call for @mutex, it will be woken and can
+lock @mutex itself. This function returns the number of times that
+ mutex has been locked by the current thread. To restore the state
+before the call to g_static_rec_mutex_unlock_full() you can call
+g_static_rec_mutex_lock_full() with the depth returned by this
+function.
</description>
<parameters>
-<parameter name="relation">
-<parameter_description> a #GRelation.
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> the value to compare with.
-</parameter_description>
-</parameter>
-<parameter name="field">
-<parameter_description> the field of each record to match.
+<parameter name="mutex">
+<parameter_description> a #GStaticRecMutex to completely unlock.
</parameter_description>
</parameter>
</parameters>
-<return> the records (tuples) that matched.
+<return> number of times @mutex has been locked by the current
+thread.
</return>
</function>
-<function name="g_reload_user_special_dirs_cache">
+<function name="g_static_rw_lock_free">
<description>
-Resets the cache used for g_get_user_special_dir(), so
-that the latest on-disk version is used. Call this only
-if you just changed the data on disk yourself.
-
-Due to threadsafety issues this may cause leaking of strings
-that were previously returned from g_get_user_special_dir()
-that can't be freed. We ensure to only leak the data for
-the directories that actually changed value though.
+Releases all resources allocated to @lock.
-Since: 2.22
+You don't have to call this functions for a #GStaticRWLock with an
+unbounded lifetime, i.e. objects declared 'static', but if you have
+a #GStaticRWLock as a member of a structure, and the structure is
+freed, you should also free the #GStaticRWLock.
</description>
<parameters>
+<parameter name="lock">
+<parameter_description> a #GStaticRWLock to be freed.
+</parameter_description>
+</parameter>
</parameters>
<return></return>
</function>
-<function name="g_remove">
+<function name="g_static_rw_lock_init">
<description>
-A wrapper for the POSIX remove() function. The remove() function
-deletes a name from the filesystem.
-
-See your C library manual for more details about how remove() works
-on your system. On Unix, remove() removes also directories, as it
-calls unlink() for files and rmdir() for directories. On Windows,
-although remove() in the C library only works for files, this
-function tries first remove() and then if that fails rmdir(), and
-thus works for both files and directories. Note however, that on
-Windows, it is in general not possible to remove a file that is
-open to some process, or mapped into memory.
-
-If this function fails on Windows you can't infer too much from the
-errno value. rmdir() is tried regardless of what caused remove() to
-fail. Any errno value set by remove() will be overwritten by that
-set by rmdir().
-
-Since: 2.6
+A #GStaticRWLock must be initialized with this function before it
+can be used. Alternatively you can initialize it with
+#G_STATIC_RW_LOCK_INIT.
</description>
<parameters>
-<parameter name="filename">
-<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows)
+<parameter name="lock">
+<parameter_description> a #GStaticRWLock to be initialized.
</parameter_description>
</parameter>
</parameters>
-<return> 0 if the file was successfully removed, -1 if an error
-occurred
-
-</return>
+<return></return>
</function>
-<function name="g_rename">
+<function name="g_static_rw_lock_reader_lock">
<description>
-A wrapper for the POSIX rename() function. The rename() function
-renames a file, moving it between directories if required.
-
-See your C library manual for more details about how rename() works
-on your system. It is not possible in general on Windows to rename
-a file that is open to some process.
+Locks @lock for reading. There may be unlimited concurrent locks for
+reading of a #GStaticRWLock at the same time. If @lock is already
+locked for writing by another thread or if another thread is already
+waiting to lock @lock for writing, this function will block until
+ lock is unlocked by the other writing thread and no other writing
+threads want to lock @lock. This lock has to be unlocked by
+g_static_rw_lock_reader_unlock().
-Since: 2.6
+#GStaticRWLock is not recursive. It might seem to be possible to
+recursively lock for reading, but that can result in a deadlock, due
+to writer preference.
</description>
<parameters>
-<parameter name="oldfilename">
-<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows)
-</parameter_description>
-</parameter>
-<parameter name="newfilename">
-<parameter_description> a pathname in the GLib file name encoding
+<parameter name="lock">
+<parameter_description> a #GStaticRWLock to lock for reading.
</parameter_description>
</parameter>
</parameters>
-<return> 0 if the renaming succeeded, -1 if an error occurred
-
-</return>
+<return></return>
</function>
-<function name="g_rmdir">
+<function name="g_static_rw_lock_reader_trylock">
<description>
-A wrapper for the POSIX rmdir() function. The rmdir() function
-deletes a directory from the filesystem.
-
-See your C library manual for more details about how rmdir() works
-on your system.
-
-Since: 2.6
+Tries to lock @lock for reading. If @lock is already locked for
+writing by another thread or if another thread is already waiting to
+lock @lock for writing, immediately returns %FALSE. Otherwise locks
+ lock for reading and returns %TRUE. This lock has to be unlocked by
+g_static_rw_lock_reader_unlock().
</description>
<parameters>
-<parameter name="filename">
-<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows)
+<parameter name="lock">
+<parameter_description> a #GStaticRWLock to lock for reading.
</parameter_description>
</parameter>
</parameters>
-<return> 0 if the directory was successfully removed, -1 if an error
-occurred
-
+<return> %TRUE, if @lock could be locked for reading.
</return>
</function>
-<function name="g_sequence_append">
+<function name="g_static_rw_lock_reader_unlock">
<description>
-Adds a new item to the end of @seq.
-
-Since: 2.14
+Unlocks @lock. If a thread waits to lock @lock for writing and all
+locks for reading have been unlocked, the waiting thread is woken up
+and can lock @lock for writing.
</description>
<parameters>
-<parameter name="seq">
-<parameter_description> a #GSequencePointer
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> the data for the new item
+<parameter name="lock">
+<parameter_description> a #GStaticRWLock to unlock after reading.
</parameter_description>
</parameter>
</parameters>
-<return> an iterator pointing to the new item
-
-</return>
+<return></return>
</function>
-<function name="g_sequence_foreach">
+<function name="g_static_rw_lock_writer_lock">
<description>
-Calls @func for each item in the sequence passing @user_data
-to the function.
-
-Since: 2.14
+Locks @lock for writing. If @lock is already locked for writing or
+reading by other threads, this function will block until @lock is
+completely unlocked and then lock @lock for writing. While this
+functions waits to lock @lock, no other thread can lock @lock for
+reading. When @lock is locked for writing, no other thread can lock
+ lock (neither for reading nor writing). This lock has to be
+unlocked by g_static_rw_lock_writer_unlock().
</description>
<parameters>
-<parameter name="seq">
-<parameter_description> a #GSequence
-</parameter_description>
-</parameter>
-<parameter name="func">
-<parameter_description> the function to call for each item in @seq
-</parameter_description>
-</parameter>
-<parameter name="user_data">
-<parameter_description> user data passed to @func
+<parameter name="lock">
+<parameter_description> a #GStaticRWLock to lock for writing.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_sequence_foreach_range">
+<function name="g_static_rw_lock_writer_trylock">
<description>
-Calls @func for each item in the range (@begin, @end) passing
- user_data to the function.
-
-Since: 2.14
+Tries to lock @lock for writing. If @lock is already locked (for
+either reading or writing) by another thread, it immediately returns
+%FALSE. Otherwise it locks @lock for writing and returns %TRUE. This
+lock has to be unlocked by g_static_rw_lock_writer_unlock().
</description>
<parameters>
-<parameter name="begin">
-<parameter_description> a #GSequenceIter
-</parameter_description>
-</parameter>
-<parameter name="end">
-<parameter_description> a #GSequenceIter
-</parameter_description>
-</parameter>
-<parameter name="func">
-<parameter_description> a #GFunc
-</parameter_description>
-</parameter>
-<parameter name="user_data">
-<parameter_description> user data passed to @func
+<parameter name="lock">
+<parameter_description> a #GStaticRWLock to lock for writing.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE, if @lock could be locked for writing.
+</return>
</function>
-<function name="g_sequence_free">
+<function name="g_static_rw_lock_writer_unlock">
<description>
-Frees the memory allocated for @seq. If @seq has a data destroy
-function associated with it, that function is called on all items in
- seq
-
-Since: 2.14
+Unlocks @lock. If a thread is waiting to lock @lock for writing and
+all locks for reading have been unlocked, the waiting thread is
+woken up and can lock @lock for writing. If no thread is waiting to
+lock @lock for writing, and some thread or threads are waiting to
+lock @lock for reading, the waiting threads are woken up and can
+lock @lock for reading.
</description>
<parameters>
-<parameter name="seq">
-<parameter_description> a #GSequence
+<parameter name="lock">
+<parameter_description> a #GStaticRWLock to unlock after writing.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_sequence_get">
+<function name="g_stpcpy">
<description>
-Returns the data that @iter points to.
+Copies a nul-terminated string into the dest buffer, include the
+trailing nul, and return a pointer to the trailing nul byte.
+This is useful for concatenating multiple strings together
+without having to repeatedly scan for the end.
-Since: 2.14
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GSequenceIter
+<parameter name="dest">
+<parameter_description> destination buffer.
</parameter_description>
</parameter>
-</parameters>
-<return> the data that @iter points to
-
-</return>
-</function>
-
-<function name="g_sequence_get_begin_iter">
-<description>
-Returns the begin iterator for @seq.
-
-Since: 2.14
-
-</description>
-<parameters>
-<parameter name="seq">
-<parameter_description> a #GSequence
+<parameter name="src">
+<parameter_description> source string.
</parameter_description>
</parameter>
</parameters>
-<return> the begin iterator for @seq.
-
+<return> a pointer to trailing nul byte.
</return>
</function>
-<function name="g_sequence_get_end_iter">
+<function name="g_str_equal">
<description>
-Returns the end iterator for @seg
+Compares two strings for byte-by-byte equality and returns %TRUE
+if they are equal. It can be passed to g_hash_table_new() as the
+ key_equal_func parameter, when using strings as keys in a #GHashTable.
+
+Note that this function is primarily meant as a hash table comparison
+function. For a general-purpose, %NULL-safe string comparison function,
+see g_strcmp0().
-Since: 2.14
</description>
<parameters>
-<parameter name="seq">
-<parameter_description> a #GSequence
+<parameter name="v1">
+<parameter_description> a key
+</parameter_description>
+</parameter>
+<parameter name="v2">
+<parameter_description> a key to compare with @v1
</parameter_description>
</parameter>
</parameters>
-<return> the end iterator for @seq
-
+<return> %TRUE if the two keys match
</return>
</function>
-<function name="g_sequence_get_iter_at_pos">
+<function name="g_str_has_prefix">
<description>
-Returns the iterator at position @pos. If @pos is negative or larger
-than the number of items in @seq, the end iterator is returned.
+Looks whether the string @str begins with @prefix.
-Since: 2.14
+Since: 2.2
</description>
<parameters>
-<parameter name="seq">
-<parameter_description> a #GSequence
+<parameter name="str">
+<parameter_description> a nul-terminated string.
</parameter_description>
</parameter>
-<parameter name="pos">
-<parameter_description> a position in @seq, or -1 for the end.
+<parameter name="prefix">
+<parameter_description> the nul-terminated prefix to look for.
</parameter_description>
</parameter>
</parameters>
-<return> The #GSequenceIter at position @pos
+<return> %TRUE if @str begins with @prefix, %FALSE otherwise.
</return>
</function>
-<function name="g_sequence_get_length">
+<function name="g_str_has_suffix">
<description>
-Returns the length of @seq
+Looks whether the string @str ends with @suffix.
-Since: 2.14
+Since: 2.2
</description>
<parameters>
-<parameter name="seq">
-<parameter_description> a #GSequence
+<parameter name="str">
+<parameter_description> a nul-terminated string.
+</parameter_description>
+</parameter>
+<parameter name="suffix">
+<parameter_description> the nul-terminated suffix to look for.
</parameter_description>
</parameter>
</parameters>
-<return> the length of @seq
+<return> %TRUE if @str end with @suffix, %FALSE otherwise.
</return>
</function>
-<function name="g_sequence_insert_before">
+<function name="g_str_hash">
<description>
-Inserts a new item just before the item pointed to by @iter.
+Converts a string to a hash value.
+
+This function implements the widely used "djb" hash apparently posted
+by Daniel Bernstein to comp.lang.c some time ago. The 32 bit
+unsigned hash value starts at 5381 and for each byte 'c' in the
+string, is updated: <literal>hash = hash * 33 + c</literal>. This
+function uses the signed value of each byte.
+
+It can be passed to g_hash_table_new() as the @hash_func parameter,
+when using strings as keys in a #GHashTable.
-Since: 2.14
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GSequenceIter
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> the data for the new item
+<parameter name="v">
+<parameter_description> a string key
</parameter_description>
</parameter>
</parameters>
-<return> an iterator pointing to the new item
-
+<return> a hash value corresponding to the key
</return>
</function>
-<function name="g_sequence_insert_sorted">
+<function name="g_strcasecmp">
<description>
-Inserts @data into @sequence using @func to determine the new position.
-The sequence must already be sorted according to @cmp_func; otherwise the
-new position of @data is undefined.
+A case-insensitive string comparison, corresponding to the standard
+strcasecmp() function on platforms which support it.
-Since: 2.14
+Deprecated:2.2: See g_strncasecmp() for a discussion of why this function
+is deprecated and how to replace it.
</description>
<parameters>
-<parameter name="seq">
-<parameter_description> a #GSequence
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> the data to insert
-</parameter_description>
-</parameter>
-<parameter name="cmp_func">
-<parameter_description> the #GCompareDataFunc used to compare items in the sequence. It
-is called with two items of the @seq and @user_data. It should
-return 0 if the items are equal, a negative value if the first
-item comes before the second, and a positive value if the second
-item comes before the first.
+<parameter name="s1">
+<parameter_description> a string.
</parameter_description>
</parameter>
-<parameter name="cmp_data">
-<parameter_description> user data passed to @cmp_func.
+<parameter name="s2">
+<parameter_description> a string to compare with @s1.
</parameter_description>
</parameter>
</parameters>
-<return> a #GSequenceIter pointing to the new item.
+<return> 0 if the strings match, a negative value if @s1 < @s2,
+or a positive value if @s1 > @s2.
</return>
</function>
-<function name="g_sequence_insert_sorted_iter">
+<function name="g_strcmp0">
<description>
-Like g_sequence_insert_sorted(), but uses
-a #GSequenceIterCompareFunc instead of a #GCompareDataFunc as
-the compare function.
+Compares @str1 and @str2 like strcmp(). Handles %NULL
+gracefully by sorting it before non-%NULL strings.
+Comparing two %NULL pointers returns 0.
-Since: 2.14
+Since: 2.16
</description>
<parameters>
-<parameter name="seq">
-<parameter_description> a #GSequence
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> data for the new item
-</parameter_description>
-</parameter>
-<parameter name="iter_cmp">
-<parameter_description> the #GSequenceItercompare used to compare iterators in the
-sequence. It is called with two iterators pointing into @seq. It should
-return 0 if the iterators are equal, a negative value if the first
-iterator comes before the second, and a positive value if the second
-iterator comes before the first.
+<parameter name="str1">
+<parameter_description> a C string or %NULL
</parameter_description>
</parameter>
-<parameter name="cmp_data">
-<parameter_description> user data passed to @cmp_func
+<parameter name="str2">
+<parameter_description> another C string or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a #GSequenceIter pointing to the new item
+<return> -1, 0 or 1, if @str1 is <, == or > than @str2.
</return>
</function>
-<function name="g_sequence_iter_compare">
+<function name="g_strconcat">
<description>
-Returns a negative number if @a comes before @b, 0 if they are equal,
-and a positive number if @a comes after @b.
+Concatenates all of the given strings into one long string.
+The returned string should be freed with g_free() when no longer needed.
-The @a and @b iterators must point into the same sequence.
+Note that this function is usually not the right function to use to
+assemble a translated message from pieces, since proper translation
+often requires the pieces to be reordered.
+
+<warning><para>The variable argument list <emphasis>must</emphasis> end
+with %NULL. If you forget the %NULL, g_strconcat() will start appending
+random memory junk to your string.</para></warning>
-Since: 2.14
</description>
<parameters>
-<parameter name="a">
-<parameter_description> a #GSequenceIter
+<parameter name="string1">
+<parameter_description> the first string to add, which must not be %NULL
</parameter_description>
</parameter>
-<parameter name="b">
-<parameter_description> a #GSequenceIter
+<parameter name="Varargs">
+<parameter_description> a %NULL-terminated list of strings to append to the string
</parameter_description>
</parameter>
</parameters>
-<return> A negative number if @a comes before @b, 0 if they are
-equal, and a positive number if @a comes after @b.
-
+<return> a newly-allocated string containing all the string arguments
</return>
</function>
-<function name="g_sequence_iter_get_position">
+<function name="g_strdown">
<description>
-Returns the position of @iter
+Converts a string to lower case.
-Since: 2.14
+Deprecated:2.2: This function is totally broken for the reasons discussed
+in the g_strncasecmp() docs - use g_ascii_strdown() or g_utf8_strdown()
+instead.
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GSequenceIter
+<parameter name="string">
+<parameter_description> the string to convert.
</parameter_description>
</parameter>
</parameters>
-<return> the position of @iter
+<return> the string
</return>
</function>
-<function name="g_sequence_iter_get_sequence">
+<function name="g_strdup">
<description>
-Returns the #GSequence that @iter points into.
+Duplicates a string. If @str is %NULL it returns %NULL.
+The returned string should be freed with g_free()
+when no longer needed.
-Since: 2.14
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GSequenceIter
+<parameter name="str">
+<parameter_description> the string to duplicate
</parameter_description>
</parameter>
</parameters>
-<return> the #GSequence that @iter points into.
-
+<return> a newly-allocated copy of @str
</return>
</function>
-<function name="g_sequence_iter_is_begin">
+<function name="g_strdup_printf">
<description>
-Returns whether @iter is the begin iterator
+Similar to the standard C sprintf() function but safer, since it
+calculates the maximum space required and allocates memory to hold
+the result. The returned string should be freed with g_free() when no
+longer needed.
-Since: 2.14
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GSequenceIter
+<parameter name="format">
+<parameter_description> a standard printf() format string, but notice
+<link linkend="string-precision">string precision pitfalls</link>
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> the parameters to insert into the format string
</parameter_description>
</parameter>
</parameters>
-<return> whether @iter is the begin iterator
-
+<return> a newly-allocated string holding the result
</return>
</function>
-<function name="g_sequence_iter_is_end">
+<function name="g_strdup_value_contents">
<description>
-Returns whether @iter is the end iterator
+Return a newly allocated string, which describes the contents of a
+#GValue. The main purpose of this function is to describe #GValue
+contents for debugging output, the way in which the contents are
+described may change between different GLib versions.
-Since: 2.14
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GSequenceIter
+<parameter name="value">
+<parameter_description> #GValue which contents are to be described.
</parameter_description>
</parameter>
</parameters>
-<return> Whether @iter is the end iterator.
-
+<return> Newly allocated string.
</return>
</function>
-<function name="g_sequence_iter_move">
+<function name="g_strdup_vprintf">
<description>
-Returns the #GSequenceIter which is @delta positions away from @iter.
-If @iter is closer than - delta positions to the beginning of the sequence,
-the begin iterator is returned. If @iter is closer than @delta positions
-to the end of the sequence, the end iterator is returned.
+Similar to the standard C vsprintf() function but safer, since it
+calculates the maximum space required and allocates memory to hold
+the result. The returned string should be freed with g_free() when
+no longer needed.
+
+See also g_vasprintf(), which offers the same functionality, but
+additionally returns the length of the allocated string.
-Since: 2.14
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GSequenceIter
+<parameter name="format">
+<parameter_description> a standard printf() format string, but notice
+<link linkend="string-precision">string precision pitfalls</link>
</parameter_description>
</parameter>
-<parameter name="delta">
-<parameter_description> A positive or negative number indicating how many positions away
-from @iter the returned #GSequenceIter will be.
+<parameter name="args">
+<parameter_description> the list of parameters to insert into the format string
</parameter_description>
</parameter>
</parameters>
-<return> a #GSequenceIter which is @delta positions away from @iter.
-
+<return> a newly-allocated string holding the result
</return>
</function>
-<function name="g_sequence_iter_next">
+<function name="g_strdupv">
<description>
-Returns an iterator pointing to the next position after @iter. If
- iter is the end iterator, the end iterator is returned.
+Copies %NULL-terminated array of strings. The copy is a deep copy;
+the new array should be freed by first freeing each string, then
+the array itself. g_strfreev() does this for you. If called
+on a %NULL value, g_strdupv() simply returns %NULL.
-Since: 2.14
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GSequenceIter
+<parameter name="str_array">
+<parameter_description> %NULL-terminated array of strings.
</parameter_description>
</parameter>
</parameters>
-<return> a #GSequenceIter pointing to the next position after @iter.
-
+<return> a new %NULL-terminated array of strings.
</return>
</function>
-<function name="g_sequence_iter_prev">
+<function name="g_strerror">
<description>
-Returns an iterator pointing to the previous position before @iter. If
- iter is the begin iterator, the begin iterator is returned.
+Returns a string corresponding to the given error code, e.g.
+"no such process". You should use this function in preference to
+strerror(), because it returns a string in UTF-8 encoding, and since
+not all platforms support the strerror() function.
-Since: 2.14
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GSequenceIter
+<parameter name="errnum">
+<parameter_description> the system error number. See the standard C %errno
+documentation
</parameter_description>
</parameter>
</parameters>
-<return> a #GSequenceIter pointing to the previous position before
- iter
-
+<return> a UTF-8 string describing the error code. If the error code
+is unknown, it returns "unknown error (<code>)". The string
+can only be used until the next call to g_strerror()
</return>
</function>
-<function name="g_sequence_lookup">
+<function name="g_strfreev">
<description>
-Returns an iterator pointing to the position of the first item found
-equal to @data according to @cmp_func and @cmp_data. If more than one item
-is equal, it is not guaranteed that it is the first which is returned.
-In that case, you can use g_sequence_iter_next() and g_sequence_iter_prev()
-to get others.
-
-Since: 2.28
+Frees a %NULL-terminated array of strings, and the array itself.
+If called on a %NULL value, g_strfreev() simply returns.
</description>
<parameters>
-<parameter name="seq">
-<parameter_description> a #GSequence
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> data to lookup
-</parameter_description>
-</parameter>
-<parameter name="cmp_func">
-<parameter_description> the #GCompareDataFunc used to compare items in the sequence. It
-is called with two items of the @seq and @user_data. It should
-return 0 if the items are equal, a negative value if the first
-item comes before the second, and a positive value if the second
-item comes before the first.
-</parameter_description>
-</parameter>
-<parameter name="cmp_data">
-<parameter_description> user data passed to @cmp_func.
+<parameter name="str_array">
+<parameter_description> a %NULL-terminated array of strings to free.
</parameter_description>
</parameter>
</parameters>
-<return> an #GSequenceIter pointing to the position of the first item
-found equal to @data according to @cmp_func and @cmp_data.
-
-</return>
+<return></return>
</function>
-<function name="g_sequence_lookup_iter">
+<function name="g_string_append">
<description>
-Like g_sequence_lookup(), but uses
-a #GSequenceIterCompareFunc instead of a #GCompareDataFunc as
-the compare function.
+Adds a string onto the end of a #GString, expanding
+it if necessary.
-Since: 2.28
</description>
<parameters>
-<parameter name="seq">
-<parameter_description> a #GSequence
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> data to lookup
-</parameter_description>
-</parameter>
-<parameter name="iter_cmp">
-<parameter_description> the #GSequenceIterCompare function used to compare iterators
-in the sequence. It is called with two iterators pointing into @seq.
-It should return 0 if the iterators are equal, a negative value if the
-first iterator comes before the second, and a positive value if the
-second iterator comes before the first.
+<parameter name="string">
+<parameter_description> a #GString
</parameter_description>
</parameter>
-<parameter name="cmp_data">
-<parameter_description> user data passed to @iter_cmp
+<parameter name="val">
+<parameter_description> the string to append onto the end of @string
</parameter_description>
</parameter>
</parameters>
-<return> an #GSequenceIter pointing to the position of the first item
-found equal to @data according to @cmp_func and @cmp_data.
-
+<return> @string
</return>
</function>
-<function name="g_sequence_move">
+<function name="g_string_append_c">
<description>
-Moves the item pointed to by @src to the position indicated by @dest.
-After calling this function @dest will point to the position immediately
-after @src. It is allowed for @src and @dest to point into different
-sequences.
+Adds a byte onto the end of a #GString, expanding
+it if necessary.
-Since: 2.14
</description>
<parameters>
-<parameter name="src">
-<parameter_description> a #GSequenceIter pointing to the item to move
+<parameter name="string">
+<parameter_description> a #GString
</parameter_description>
</parameter>
-<parameter name="dest">
-<parameter_description> a #GSequenceIter pointing to the position to which
-the item is moved.
+<parameter name="c">
+<parameter_description> the byte to append onto the end of @string
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> @string
+</return>
</function>
-<function name="g_sequence_move_range">
+<function name="g_string_append_len">
<description>
-Inserts the (@begin, @end) range at the destination pointed to by ptr.
-The @begin and @end iters must point into the same sequence. It is
-allowed for @dest to point to a different sequence than the one pointed
-into by @begin and @end.
+Appends @len bytes of @val to @string. Because @len is
+provided, @val may contain embedded nuls and need not
+be nul-terminated.
-If @dest is NULL, the range indicated by @begin and @end is
-removed from the sequence. If @dest iter points to a place within
-the (@begin, @end) range, the range does not move.
+Since this function does not stop at nul bytes, it is
+the caller's responsibility to ensure that @val has at
+least @len addressable bytes.
-Since: 2.14
</description>
<parameters>
-<parameter name="dest">
-<parameter_description> a #GSequenceIter
+<parameter name="string">
+<parameter_description> a #GString
</parameter_description>
</parameter>
-<parameter name="begin">
-<parameter_description> a #GSequenceIter
+<parameter name="val">
+<parameter_description> bytes to append
</parameter_description>
</parameter>
-<parameter name="end">
-<parameter_description> a #GSequenceIter
+<parameter name="len">
+<parameter_description> number of bytes of @val to use
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> @string
+</return>
</function>
-<function name="g_sequence_new">
+<function name="g_string_append_printf">
<description>
-Creates a new GSequence. The @data_destroy function, if non-%NULL will
-be called on all items when the sequence is destroyed and on items that
-are removed from the sequence.
-
-Since: 2.14
+Appends a formatted string onto the end of a #GString.
+This function is similar to g_string_printf() except
+that the text is appended to the #GString.
</description>
<parameters>
-<parameter name="data_destroy">
-<parameter_description> a #GDestroyNotify function, or %NULL
+<parameter name="string">
+<parameter_description> a #GString
+</parameter_description>
+</parameter>
+<parameter name="format">
+<parameter_description> the string format. See the printf() documentation
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> the parameters to insert into the format string
</parameter_description>
</parameter>
</parameters>
-<return> a new #GSequence
-
-</return>
+<return></return>
</function>
-<function name="g_sequence_prepend">
+<function name="g_string_append_unichar">
<description>
-Adds a new item to the front of @seq
+Converts a Unicode character into UTF-8, and appends it
+to the string.
-Since: 2.14
</description>
<parameters>
-<parameter name="seq">
-<parameter_description> a #GSequence
+<parameter name="string">
+<parameter_description> a #GString
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> the data for the new item
+<parameter name="wc">
+<parameter_description> a Unicode character
</parameter_description>
</parameter>
</parameters>
-<return> an iterator pointing to the new item
-
+<return> @string
</return>
</function>
-<function name="g_sequence_range_get_midpoint">
+<function name="g_string_append_uri_escaped">
<description>
-Finds an iterator somewhere in the range (@begin, @end). This
-iterator will be close to the middle of the range, but is not
-guaranteed to be <emphasis>exactly</emphasis> in the middle.
-
-The @begin and @end iterators must both point to the same sequence and
- begin must come before or be equal to @end in the sequence.
+Appends @unescaped to @string, escaped any characters that
+are reserved in URIs using URI-style escape sequences.
-Since: 2.14
+Since: 2.16
</description>
<parameters>
-<parameter name="begin">
-<parameter_description> a #GSequenceIter
+<parameter name="string">
+<parameter_description> a #GString
</parameter_description>
</parameter>
-<parameter name="end">
-<parameter_description> a #GSequenceIter
+<parameter name="unescaped">
+<parameter_description> a string
+</parameter_description>
+</parameter>
+<parameter name="reserved_chars_allowed">
+<parameter_description> a string of reserved characters allowed to be used, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="allow_utf8">
+<parameter_description> set %TRUE if the escaped string may include UTF8 characters
</parameter_description>
</parameter>
</parameters>
-<return> A #GSequenceIter pointing somewhere in the
-(@begin, @end) range.
+<return> @string
</return>
</function>
-<function name="g_sequence_remove">
+<function name="g_string_append_vprintf">
<description>
-Removes the item pointed to by @iter. It is an error to pass the
-end iterator to this function.
-
-If the sequnce has a data destroy function associated with it, this
-function is called on the data for the removed item.
+Appends a formatted string onto the end of a #GString.
+This function is similar to g_string_append_printf()
+except that the arguments to the format string are passed
+as a va_list.
Since: 2.14
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GSequenceIter
+<parameter name="string">
+<parameter_description> a #GString
+</parameter_description>
+</parameter>
+<parameter name="format">
+<parameter_description> the string format. See the printf() documentation
+</parameter_description>
+</parameter>
+<parameter name="args">
+<parameter_description> the list of arguments to insert in the output
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_sequence_remove_range">
+<function name="g_string_ascii_down">
<description>
-Removes all items in the (@begin, @end) range.
-
-If the sequence has a data destroy function associated with it, this
-function is called on the data for the removed items.
+Converts all upper case ASCII letters to lower case ASCII letters.
-Since: 2.14
</description>
<parameters>
-<parameter name="begin">
-<parameter_description> a #GSequenceIter
-</parameter_description>
-</parameter>
-<parameter name="end">
-<parameter_description> a #GSequenceIter
+<parameter name="string">
+<parameter_description> a GString
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> passed-in @string pointer, with all the upper case
+characters converted to lower case in place, with
+semantics that exactly match g_ascii_tolower().
+</return>
</function>
-<function name="g_sequence_search">
+<function name="g_string_ascii_up">
<description>
-Returns an iterator pointing to the position where @data would
-be inserted according to @cmp_func and @cmp_data.
-
-If you are simply searching for an existing element of the sequence,
-consider using g_sequence_lookup().
+Converts all lower case ASCII letters to upper case ASCII letters.
-Since: 2.14
</description>
<parameters>
-<parameter name="seq">
-<parameter_description> a #GSequence
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> data for the new item
-</parameter_description>
-</parameter>
-<parameter name="cmp_func">
-<parameter_description> the #GCompareDataFunc used to compare items in the sequence. It
-is called with two items of the @seq and @user_data. It should
-return 0 if the items are equal, a negative value if the first
-item comes before the second, and a positive value if the second
-item comes before the first.
-</parameter_description>
-</parameter>
-<parameter name="cmp_data">
-<parameter_description> user data passed to @cmp_func.
+<parameter name="string">
+<parameter_description> a GString
</parameter_description>
</parameter>
</parameters>
-<return> an #GSequenceIter pointing to the position where @data
-would have been inserted according to @cmp_func and @cmp_data.
-
+<return> passed-in @string pointer, with all the lower case
+characters converted to upper case in place, with
+semantics that exactly match g_ascii_toupper().
</return>
</function>
-<function name="g_sequence_search_iter">
+<function name="g_string_assign">
<description>
-Like g_sequence_search(), but uses
-a #GSequenceIterCompareFunc instead of a #GCompareDataFunc as
-the compare function.
-
-If you are simply searching for an existing element of the sequence,
-consider using g_sequence_lookup_iter().
+Copies the bytes from a string into a #GString,
+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.
-Since: 2.14
</description>
<parameters>
-<parameter name="seq">
-<parameter_description> a #GSequence
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> data for the new item
-</parameter_description>
-</parameter>
-<parameter name="iter_cmp">
-<parameter_description> the #GSequenceIterCompare function used to compare iterators
-in the sequence. It is called with two iterators pointing into @seq.
-It should return 0 if the iterators are equal, a negative value if the
-first iterator comes before the second, and a positive value if the
-second iterator comes before the first.
+<parameter name="string">
+<parameter_description> the destination #GString. Its current contents
+are destroyed.
</parameter_description>
</parameter>
-<parameter name="cmp_data">
-<parameter_description> user data passed to @iter_cmp
+<parameter name="rval">
+<parameter_description> the string to copy into @string
</parameter_description>
</parameter>
</parameters>
-<return> a #GSequenceIter pointing to the position in @seq
-where @data would have been inserted according to @iter_cmp and @cmp_data.
-
+<return> @string
</return>
</function>
-<function name="g_sequence_set">
+<function name="g_string_chunk_clear">
<description>
-Changes the data for the item pointed to by @iter to be @data. If
-the sequence has a data destroy function associated with it, that
-function is called on the existing data that @iter pointed to.
+Frees all strings contained within the #GStringChunk.
+After calling g_string_chunk_clear() it is not safe to
+access any of the strings which were contained within it.
Since: 2.14
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GSequenceIter
+<parameter name="chunk">
+<parameter_description> a #GStringChunk
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> new data for the item
+</parameters>
+<return></return>
+</function>
+
+<function name="g_string_chunk_free">
+<description>
+Frees all memory allocated by the #GStringChunk.
+After calling g_string_chunk_free() it is not safe to
+access any of the strings which were contained within it.
+
+</description>
+<parameters>
+<parameter name="chunk">
+<parameter_description> a #GStringChunk
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_sequence_sort">
+<function name="g_string_chunk_insert">
<description>
-Sorts @seq using @cmp_func.
+Adds a copy of @string to the #GStringChunk.
+It returns a pointer to the new copy of the string
+in the #GStringChunk. The characters in the string
+can be changed, if necessary, though you should not
+change anything after the end of the string.
+
+Unlike g_string_chunk_insert_const(), this function
+does not check for duplicates. Also strings added
+with g_string_chunk_insert() will not be searched
+by g_string_chunk_insert_const() when looking for
+duplicates.
-Since: 2.14
</description>
<parameters>
-<parameter name="seq">
-<parameter_description> a #GSequence
-</parameter_description>
-</parameter>
-<parameter name="cmp_func">
-<parameter_description> the #GCompareDataFunc used to sort @seq. This function is
-passed two items of @seq and should return 0 if they are equal,
-a negative value if the first comes before the second, and a
-positive value if the second comes before the first.
+<parameter name="chunk">
+<parameter_description> a #GStringChunk
</parameter_description>
</parameter>
-<parameter name="cmp_data">
-<parameter_description> user data passed to @cmp_func
+<parameter name="string">
+<parameter_description> the string to add
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a pointer to the copy of @string within
+the #GStringChunk
+</return>
</function>
-<function name="g_sequence_sort_changed">
+<function name="g_string_chunk_insert_const">
<description>
-Moves the data pointed to a new position as indicated by @cmp_func. This
-function should be called for items in a sequence already sorted according
-to @cmp_func whenever some aspect of an item changes so that @cmp_func
-may return different values for that item.
+Adds a copy of @string to the #GStringChunk, unless the same
+string has already been added to the #GStringChunk with
+g_string_chunk_insert_const().
+
+This function is useful if you need to copy a large number
+of strings but do not want to waste space storing duplicates.
+But you must remember that there may be several pointers to
+the same string, and so any changes made to the strings
+should be done very carefully.
+
+Note that g_string_chunk_insert_const() will not return a
+pointer to a string added with g_string_chunk_insert(), even
+if they do match.
-Since: 2.14
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> A #GSequenceIter
-</parameter_description>
-</parameter>
-<parameter name="cmp_func">
-<parameter_description> the #GCompareDataFunc used to compare items in the sequence. It
-is called with two items of the @seq and @user_data. It should
-return 0 if the items are equal, a negative value if the first
-item comes before the second, and a positive value if the second
-item comes before the first.
+<parameter name="chunk">
+<parameter_description> a #GStringChunk
</parameter_description>
</parameter>
-<parameter name="cmp_data">
-<parameter_description> user data passed to @cmp_func.
+<parameter name="string">
+<parameter_description> the string to add
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a pointer to the new or existing copy of @string
+within the #GStringChunk
+</return>
</function>
-<function name="g_sequence_sort_changed_iter">
+<function name="g_string_chunk_insert_len">
<description>
-Like g_sequence_sort_changed(), but uses
-a #GSequenceIterCompareFunc instead of a #GCompareDataFunc as
-the compare function.
+Adds a copy of the first @len bytes of @string to the #GStringChunk.
+The copy is nul-terminated.
-Since: 2.14
+Since this function does not stop at nul bytes, it is the caller's
+responsibility to ensure that @string has at least @len addressable
+bytes.
+
+The characters in the returned string can be changed, if necessary,
+though you should not change anything after the end of the string.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GSequenceIter
+<parameter name="chunk">
+<parameter_description> a #GStringChunk
</parameter_description>
</parameter>
-<parameter name="iter_cmp">
-<parameter_description> the #GSequenceItercompare used to compare iterators in the
-sequence. It is called with two iterators pointing into @seq. It should
-return 0 if the iterators are equal, a negative value if the first
-iterator comes before the second, and a positive value if the second
-iterator comes before the first.
+<parameter name="string">
+<parameter_description> bytes to insert
</parameter_description>
</parameter>
-<parameter name="cmp_data">
-<parameter_description> user data passed to @cmp_func
+<parameter name="len">
+<parameter_description> number of bytes of @string to insert, or -1 to insert a
+nul-terminated string
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a pointer to the copy of @string within the #GStringChunk
+
+</return>
</function>
-<function name="g_sequence_sort_iter">
+<function name="g_string_chunk_new">
<description>
-Like g_sequence_sort(), but uses a #GSequenceIterCompareFunc instead
-of a GCompareDataFunc as the compare function
+Creates a new #GStringChunk.
-Since: 2.14
</description>
<parameters>
-<parameter name="seq">
-<parameter_description> a #GSequence
-</parameter_description>
-</parameter>
-<parameter name="cmp_func">
-<parameter_description> the #GSequenceItercompare used to compare iterators in the
-sequence. It is called with two iterators pointing into @seq. It should
-return 0 if the iterators are equal, a negative value if the first
-iterator comes before the second, and a positive value if the second
-iterator comes before the first.
-</parameter_description>
-</parameter>
-<parameter name="cmp_data">
-<parameter_description> user data passed to @cmp_func
+<parameter name="size">
+<parameter_description> the default size of the blocks of memory which are
+allocated to store the strings. If a particular string
+is larger than this default size, a larger block of
+memory will be allocated for it.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a new #GStringChunk
+</return>
</function>
-<function name="g_sequence_swap">
+<function name="g_string_down">
<description>
-Swaps the items pointed to by @a and @b. It is allowed for @a and @b
-to point into difference sequences.
+Converts a #GString to lowercase.
-Since: 2.14
+Deprecated:2.2: This function uses the locale-specific
+tolower() function, which is almost never the right thing.
+Use g_string_ascii_down() or g_utf8_strdown() instead.
</description>
<parameters>
-<parameter name="a">
-<parameter_description> a #GSequenceIter
-</parameter_description>
-</parameter>
-<parameter name="b">
-<parameter_description> a #GSequenceIter
+<parameter name="string">
+<parameter_description> a #GString
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the #GString.
+
+</return>
</function>
-<function name="g_set_application_name">
+<function name="g_string_equal">
<description>
-Sets a human-readable name for the application. This name should be
-localized if possible, and is intended for display to the user.
-Contrast with g_set_prgname(), which sets a non-localized name.
-g_set_prgname() will be called automatically by gtk_init(),
-but g_set_application_name() will not.
-
-Note that for thread safety reasons, this function can only
-be called once.
-
-The application name will be used in contexts such as error messages,
-or when displaying an application's name in the task list.
+Compares two strings for equality, returning %TRUE if they are equal.
+For use with #GHashTable.
-Since: 2.2
</description>
<parameters>
-<parameter name="application_name">
-<parameter_description> localized name of the application
+<parameter name="v">
+<parameter_description> a #GString
+</parameter_description>
+</parameter>
+<parameter name="v2">
+<parameter_description> another #GString
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if they strings are the same length and contain the
+same bytes
+</return>
</function>
-<function name="g_set_error">
+<function name="g_string_erase">
<description>
-Does nothing if @err is %NULL; if @err is non-%NULL, then * err
-must be %NULL. A new #GError is created and assigned to * err
+Removes @len bytes from a #GString, starting at position @pos.
+The rest of the #GString is shifted down to fill the gap.
+
</description>
<parameters>
-<parameter name="err">
-<parameter_description> a return location for a #GError, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="domain">
-<parameter_description> error domain
-</parameter_description>
-</parameter>
-<parameter name="code">
-<parameter_description> error code
+<parameter name="string">
+<parameter_description> a #GString
</parameter_description>
</parameter>
-<parameter name="format">
-<parameter_description> printf()-style format
+<parameter name="pos">
+<parameter_description> the position of the content to remove
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> args for @format
+<parameter name="len">
+<parameter_description> the number of bytes to remove, or -1 to remove all
+following bytes
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> @string
+</return>
</function>
-<function name="g_set_error_literal">
+<function name="g_string_free">
<description>
-Does nothing if @err is %NULL; if @err is non-%NULL, then * err
-must be %NULL. A new #GError is created and assigned to * err
-Unlike g_set_error(), @message is not a printf()-style format string.
-Use this function if @message contains text you don't have control over,
-that could include printf() escape sequences.
+Frees the memory allocated for the #GString.
+If @free_segment is %TRUE it also frees the character data. If
+it's %FALSE, the caller gains ownership of the buffer and must
+free it after use with g_free().
-Since: 2.18
</description>
<parameters>
-<parameter name="err">
-<parameter_description> a return location for a #GError, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="domain">
-<parameter_description> error domain
-</parameter_description>
-</parameter>
-<parameter name="code">
-<parameter_description> error code
+<parameter name="string">
+<parameter_description> a #GString
</parameter_description>
</parameter>
-<parameter name="message">
-<parameter_description> error message
+<parameter name="free_segment">
+<parameter_description> if %TRUE the actual character data is freed as well
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the character data of @string
+(i.e. %NULL if @free_segment is %TRUE)
+</return>
</function>
-<function name="g_set_prgname">
+<function name="g_string_hash">
<description>
-Sets the name of the program. This name should <emphasis>not</emphasis>
-be localized, contrast with g_set_application_name(). Note that for
-thread-safety reasons this function can only be called once.
+Creates a hash code for @str; for use with #GHashTable.
+
</description>
<parameters>
-<parameter name="prgname">
-<parameter_description> the name of the program.
+<parameter name="str">
+<parameter_description> a string to hash
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> hash code for @str
+</return>
</function>
-<function name="g_setenv">
+<function name="g_string_insert">
<description>
-Sets an environment variable. Both the variable's name and value
-should be in the GLib file name encoding. On UNIX, this means that
-they can be any sequence of bytes. On Windows, they should be in
-UTF-8.
-
-Note that on some systems, when variables are overwritten, the memory
-used for the previous variables and its value isn't reclaimed.
+Inserts a copy of a string into a #GString,
+expanding it if necessary.
-Since: 2.4
</description>
<parameters>
-<parameter name="variable">
-<parameter_description> the environment variable to set, must not contain '='.
+<parameter name="string">
+<parameter_description> a #GString
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> the value for to set the variable to.
+<parameter name="pos">
+<parameter_description> the position to insert the copy of the string
</parameter_description>
</parameter>
-<parameter name="overwrite">
-<parameter_description> whether to change the variable if it already exists.
+<parameter name="val">
+<parameter_description> the string to insert
</parameter_description>
</parameter>
</parameters>
-<return> %FALSE if the environment variable couldn't be set.
-
+<return> @string
</return>
</function>
-<function name="g_shell_parse_argv">
+<function name="g_string_insert_c">
<description>
-Parses a command line into an argument vector, in much the same way
-the shell would, but without many of the expansions the shell would
-perform (variable expansion, globs, operators, filename expansion,
-etc. are not supported). The results are defined to be the same as
-those you would get from a UNIX98 /bin/sh, as long as the input
-contains none of the unsupported shell expansions. If the input
-does contain such expansions, they are passed through
-literally. Possible errors are those from the #G_SHELL_ERROR
-domain. Free the returned vector with g_strfreev().
+Inserts a byte into a #GString, expanding it if necessary.
</description>
<parameters>
-<parameter name="command_line">
-<parameter_description> command line to parse
-</parameter_description>
-</parameter>
-<parameter name="argcp">
-<parameter_description> return location for number of args
+<parameter name="string">
+<parameter_description> a #GString
</parameter_description>
</parameter>
-<parameter name="argvp">
-<parameter_description> return location for array of args
+<parameter name="pos">
+<parameter_description> the position to insert the byte
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for error
+<parameter name="c">
+<parameter_description> the byte to insert
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE on success, %FALSE if error set
+<return> @string
</return>
</function>
-<function name="g_shell_quote">
+<function name="g_string_insert_len">
<description>
-Quotes a string so that the shell (/bin/sh) will interpret the
-quoted string to mean @unquoted_string. If you pass a filename to
-the shell, for example, you should first quote it with this
-function. The return value must be freed with g_free(). The
-quoting style used is undefined (single or double quotes may be
-used).
+Inserts @len bytes of @val into @string at @pos.
+Because @len is provided, @val may contain embedded
+nuls and need not be nul-terminated. If @pos is -1,
+bytes are inserted at the end of the string.
+
+Since this function does not stop at nul bytes, it is
+the caller's responsibility to ensure that @val has at
+least @len addressable bytes.
</description>
<parameters>
-<parameter name="unquoted_string">
-<parameter_description> a literal string
+<parameter name="string">
+<parameter_description> a #GString
+</parameter_description>
+</parameter>
+<parameter name="pos">
+<parameter_description> position in @string where insertion should
+happen, or -1 for at the end
+</parameter_description>
+</parameter>
+<parameter name="val">
+<parameter_description> bytes to insert
+</parameter_description>
+</parameter>
+<parameter name="len">
+<parameter_description> number of bytes of @val to insert
</parameter_description>
</parameter>
</parameters>
-<return> quoted string
+<return> @string
</return>
</function>
-<function name="g_shell_unquote">
+<function name="g_string_insert_unichar">
<description>
-Unquotes a string as the shell (/bin/sh) would. Only handles
-quotes; if a string contains file globs, arithmetic operators,
-variables, backticks, redirections, or other special-to-the-shell
-features, the result will be different from the result a real shell
-would produce (the variables, backticks, etc. will be passed
-through literally instead of being expanded). This function is
-guaranteed to succeed if applied to the result of
-g_shell_quote(). If it fails, it returns %NULL and sets the
-error. The @quoted_string need not actually contain quoted or
-escaped text; g_shell_unquote() simply goes through the string and
-unquotes/unescapes anything that the shell would. Both single and
-double quotes are handled, as are escapes including escaped
-newlines. The return value must be freed with g_free(). Possible
-errors are in the #G_SHELL_ERROR domain.
-
-Shell quoting rules are a bit strange. Single quotes preserve the
-literal string exactly. escape sequences are not allowed; not even
-\' - if you want a ' in the quoted text, you have to do something
-like 'foo'\''bar'. Double quotes allow $, `, ", \, and newline to
-be escaped with backslash. Otherwise double quotes preserve things
-literally.
+Converts a Unicode character into UTF-8, and insert it
+into the string at the given position.
</description>
<parameters>
-<parameter name="quoted_string">
-<parameter_description> shell-quoted string
+<parameter name="string">
+<parameter_description> a #GString
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> error return location or NULL
+<parameter name="pos">
+<parameter_description> the position at which to insert character, or -1 to
+append at the end of the string
+</parameter_description>
+</parameter>
+<parameter name="wc">
+<parameter_description> a Unicode character
</parameter_description>
</parameter>
</parameters>
-<return> an unquoted string
+<return> @string
</return>
</function>
-<function name="g_slist_alloc">
+<function name="g_string_new">
<description>
-Allocates space for one #GSList element. It is called by the
-g_slist_append(), g_slist_prepend(), g_slist_insert() and
-g_slist_insert_sorted() functions and so is rarely used on its own.
+Creates a new #GString, initialized with the given string.
+
</description>
<parameters>
+<parameter name="init">
+<parameter_description> the initial text to copy into the string
+</parameter_description>
+</parameter>
</parameters>
-<return> a pointer to the newly-allocated #GSList element.
+<return> the new #GString
</return>
</function>
-<function name="g_slist_append">
+<function name="g_string_new_len">
<description>
-Adds a new element on to the end of the list.
-
-<note><para>
-The return value is the new start of the list, which may
-have changed, so make sure you store the new value.
-</para></note>
-
-<note><para>
-Note that g_slist_append() has to traverse the entire list
-to find the end, which is inefficient when adding multiple
-elements. A common idiom to avoid the inefficiency is to prepend
-the elements and reverse the list when all elements have been added.
-</para></note>
-
-|[
-/ * Notice that these are initialized to the empty list. * /
-GSList *list = NULL, *number_list = NULL;
-
-/ * This is a list of strings. * /
-list = g_slist_append (list, "first");
-list = g_slist_append (list, "second");
+Creates a new #GString with @len bytes of the @init buffer.
+Because a length is provided, @init need not be nul-terminated,
+and can contain embedded nul bytes.
-/ * This is a list of integers. * /
-number_list = g_slist_append (number_list, GINT_TO_POINTER (27));
-number_list = g_slist_append (number_list, GINT_TO_POINTER (14));
-]|
+Since this function does not stop at nul bytes, it is the caller's
+responsibility to ensure that @init has at least @len addressable
+bytes.
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GSList
+<parameter name="init">
+<parameter_description> initial contents of the string
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> the data for the new element
+<parameter name="len">
+<parameter_description> length of @init to use
</parameter_description>
</parameter>
</parameters>
-<return> the new start of the #GSList
+<return> a new #GString
</return>
</function>
-<function name="g_slist_concat">
+<function name="g_string_overwrite">
<description>
-Adds the second #GSList onto the end of the first #GSList.
-Note that the elements of the second #GSList are not copied.
-They are used directly.
+Overwrites part of a string, lengthening it if necessary.
+Since: 2.14
</description>
<parameters>
-<parameter name="list1">
-<parameter_description> a #GSList
+<parameter name="string">
+<parameter_description> a #GString
</parameter_description>
</parameter>
-<parameter name="list2">
-<parameter_description> the #GSList to add to the end of the first #GSList
+<parameter name="pos">
+<parameter_description> the position at which to start overwriting
+</parameter_description>
+</parameter>
+<parameter name="val">
+<parameter_description> the string that will overwrite the @string starting at @pos
</parameter_description>
</parameter>
</parameters>
-<return> the start of the new #GSList
+<return> @string
+
</return>
</function>
-<function name="g_slist_copy">
+<function name="g_string_overwrite_len">
<description>
-Copies a #GSList.
-
-<note><para>
-Note that this is a "shallow" copy. If the list elements
-consist of pointers to data, the pointers are copied but
-the actual data isn't.
-</para></note>
+Overwrites part of a string, lengthening it if necessary.
+This function will work with embedded nuls.
+Since: 2.14
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GSList
+<parameter name="string">
+<parameter_description> a #GString
+</parameter_description>
+</parameter>
+<parameter name="pos">
+<parameter_description> the position at which to start overwriting
+</parameter_description>
+</parameter>
+<parameter name="val">
+<parameter_description> the string that will overwrite the @string starting at @pos
+</parameter_description>
+</parameter>
+<parameter name="len">
+<parameter_description> the number of bytes to write from @val
</parameter_description>
</parameter>
</parameters>
-<return> a copy of @list
+<return> @string
+
</return>
</function>
-<function name="g_slist_delete_link">
+<function name="g_string_prepend">
<description>
-Removes the node link_ from the list and frees it.
-Compare this to g_slist_remove_link() which removes the node
-without freeing it.
+Adds a string on to the start of a #GString,
+expanding it if necessary.
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GSList
+<parameter name="string">
+<parameter_description> a #GString
</parameter_description>
</parameter>
-<parameter name="link_">
-<parameter_description> node to delete
+<parameter name="val">
+<parameter_description> the string to prepend on the start of @string
</parameter_description>
</parameter>
</parameters>
-<return> the new head of @list
+<return> @string
</return>
</function>
-<function name="g_slist_find">
+<function name="g_string_prepend_c">
<description>
-Finds the element in a #GSList which
-contains the given data.
+Adds a byte onto the start of a #GString,
+expanding it if necessary.
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GSList
+<parameter name="string">
+<parameter_description> a #GString
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> the element data to find
+<parameter name="c">
+<parameter_description> the byte to prepend on the start of the #GString
</parameter_description>
</parameter>
</parameters>
-<return> the found #GSList element,
-or %NULL if it is not found
+<return> @string
</return>
</function>
-<function name="g_slist_find_custom">
+<function name="g_string_prepend_len">
<description>
-Finds an element in a #GSList, using a supplied function to
-find the desired element. It iterates over the list, calling
-the given function which should return 0 when the desired
-element is found. The function takes two #gconstpointer arguments,
-the #GSList element's data as the first argument and the
-given user data.
+Prepends @len bytes of @val to @string.
+Because @len is provided, @val may contain
+embedded nuls and need not be nul-terminated.
+
+Since this function does not stop at nul bytes,
+it is the caller's responsibility to ensure that
+ val has at least @len addressable bytes.
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GSList
+<parameter name="string">
+<parameter_description> a #GString
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> user data passed to the function
+<parameter name="val">
+<parameter_description> bytes to prepend
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> the function to call for each element.
-It should return 0 when the desired element is found
+<parameter name="len">
+<parameter_description> number of bytes in @val to prepend
</parameter_description>
</parameter>
</parameters>
-<return> the found #GSList element, or %NULL if it is not found
+<return> @string
</return>
</function>
-<function name="g_slist_foreach">
+<function name="g_string_prepend_unichar">
<description>
-Calls a function for each element of a #GSList.
+Converts a Unicode character into UTF-8, and prepends it
+to the string.
+
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GSList
-</parameter_description>
-</parameter>
-<parameter name="func">
-<parameter_description> the function to call with each element's data
+<parameter name="string">
+<parameter_description> a #GString
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> user data to pass to the function
+<parameter name="wc">
+<parameter_description> a Unicode character
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> @string
+</return>
</function>
-<function name="g_slist_free">
+<function name="g_string_printf">
<description>
-Frees all of the memory used by a #GSList.
-The freed elements are returned to the slice allocator.
-
-<note><para>
-If list elements contain dynamically-allocated memory,
-you should either use g_slist_free_full() or free them manually
-first.
-</para></note>
+Writes a formatted string into a #GString.
+This is similar to the standard sprintf() function,
+except that the #GString buffer automatically expands
+to contain the results. The previous contents of the
+#GString are destroyed.
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GSList
+<parameter name="string">
+<parameter_description> a #GString
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="g_slist_free1">
-<description>
-A macro which does the same as g_slist_free_1().
-
-Since: 2.10
-
-</description>
-<parameters>
-</parameters>
-<return></return>
-</function>
-
-<function name="g_slist_free_1">
-<description>
-Frees one #GSList element.
-It is usually used after g_slist_remove_link().
-
-</description>
-<parameters>
-<parameter name="list">
-<parameter_description> a #GSList element
+<parameter name="format">
+<parameter_description> the string format. See the printf() documentation
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> the parameters to insert into the format string
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_slist_free_full">
+<function name="g_string_set_size">
<description>
-Convenience method, which frees all the memory used by a #GSList, and
-calls the specified destroy function on every element's data.
+Sets the length of a #GString. If the length is less than
+the current length, the string will be truncated. If the
+length is greater than the current length, the contents
+of the newly added area are undefined. (However, as
+always, string->str[string->len] will be a nul byte.)
-Since: 2.28
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a pointer to a #GSList
+<parameter name="string">
+<parameter_description> a #GString
</parameter_description>
</parameter>
-<parameter name="free_func">
-<parameter_description> the function to be called to free each element's data
+<parameter name="len">
+<parameter_description> the new length
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> @string
+</return>
</function>
-<function name="g_slist_index">
+<function name="g_string_sized_new">
<description>
-Gets the position of the element containing
-the given data (starting from 0).
+Creates a new #GString, with enough space for @dfl_size
+bytes. 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.
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GSList
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> the data to find
+<parameter name="dfl_size">
+<parameter_description> the default size of the space allocated to
+hold the string
</parameter_description>
</parameter>
</parameters>
-<return> the index of the element containing the data,
-or -1 if the data is not found
+<return> the new #GString
</return>
</function>
-<function name="g_slist_insert">
+<function name="g_string_sprintf">
<description>
-Inserts a new element into the list at the given position.
+Writes a formatted string into a #GString.
+This is similar to the standard sprintf() function,
+except that the #GString buffer automatically expands
+to contain the results. The previous contents of the
+#GString are destroyed.
+Deprecated: This function has been renamed to g_string_printf().
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GSList
+<parameter name="string">
+<parameter_description> a #GString
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> the data for the new element
+<parameter name="format">
+<parameter_description> the string format. See the sprintf() documentation
</parameter_description>
</parameter>
-<parameter name="position">
-<parameter_description> the position to insert the element.
-If this is negative, or is larger than the number
-of elements in the list, the new element is added on
-to the end of the list.
+<parameter name="Varargs">
+<parameter_description> the parameters to insert into the format string
</parameter_description>
</parameter>
</parameters>
-<return> the new start of the #GSList
-</return>
+<return></return>
</function>
-<function name="g_slist_insert_before">
+<function name="g_string_sprintfa">
<description>
-Inserts a node before @sibling containing @data.
+Appends a formatted string onto the end of a #GString.
+This function is similar to g_string_sprintf() except that
+the text is appended to the #GString.
+Deprecated: This function has been renamed to g_string_append_printf()
</description>
<parameters>
-<parameter name="slist">
-<parameter_description> a #GSList
+<parameter name="string">
+<parameter_description> a #GString
</parameter_description>
</parameter>
-<parameter name="sibling">
-<parameter_description> node to insert @data before
+<parameter name="format">
+<parameter_description> the string format. See the sprintf() documentation
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> data to put in the newly-inserted node
+<parameter name="Varargs">
+<parameter_description> the parameters to insert into the format string
</parameter_description>
</parameter>
</parameters>
-<return> the new head of the list.
-</return>
+<return></return>
</function>
-<function name="g_slist_insert_sorted">
+<function name="g_string_truncate">
<description>
-Inserts a new element into the list, using the given
-comparison function to determine its position.
+Cuts off the end of the GString, leaving the first @len bytes.
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GSList
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> the data for the new element
+<parameter name="string">
+<parameter_description> a #GString
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> the function to compare elements in the list.
-It should return a number > 0 if the first parameter
-comes after the second parameter in the sort order.
+<parameter name="len">
+<parameter_description> the new size of @string
</parameter_description>
</parameter>
</parameters>
-<return> the new start of the #GSList
+<return> @string
</return>
</function>
-<function name="g_slist_insert_sorted_with_data">
+<function name="g_string_up">
<description>
-Inserts a new element into the list, using the given
-comparison function to determine its position.
+Converts a #GString to uppercase.
-Since: 2.10
+Deprecated:2.2: This function uses the locale-specific
+toupper() function, which is almost never the right thing.
+Use g_string_ascii_up() or g_utf8_strup() instead.
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GSList
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> the data for the new element
-</parameter_description>
-</parameter>
-<parameter name="func">
-<parameter_description> the function to compare elements in the list.
-It should return a number > 0 if the first parameter
-comes after the second parameter in the sort order.
-</parameter_description>
-</parameter>
-<parameter name="user_data">
-<parameter_description> data to pass to comparison function
+<parameter name="string">
+<parameter_description> a #GString
</parameter_description>
</parameter>
</parameters>
-<return> the new start of the #GSList
+<return> @string
</return>
</function>
-<function name="g_slist_last">
+<function name="g_string_vprintf">
<description>
-Gets the last element in a #GSList.
-
-<note><para>
-This function iterates over the whole list.
-</para></note>
+Writes a formatted string into a #GString.
+This function is similar to g_string_printf() except that
+the arguments to the format string are passed as a va_list.
+Since: 2.14
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GSList
+<parameter name="string">
+<parameter_description> a #GString
+</parameter_description>
+</parameter>
+<parameter name="format">
+<parameter_description> the string format. See the printf() documentation
+</parameter_description>
+</parameter>
+<parameter name="args">
+<parameter_description> the parameters to insert into the format string
</parameter_description>
</parameter>
</parameters>
-<return> the last element in the #GSList,
-or %NULL if the #GSList has no elements
-</return>
+<return></return>
</function>
-<function name="g_slist_length">
+<function name="g_strip_context">
<description>
-Gets the number of elements in a #GSList.
-
-<note><para>
-This function iterates over the whole list to
-count its elements.
-</para></note>
+An auxiliary function for gettext() support (see Q_()).
+Since: 2.4
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GSList
+<parameter name="msgid">
+<parameter_description> a string
+</parameter_description>
+</parameter>
+<parameter name="msgval">
+<parameter_description> another string
</parameter_description>
</parameter>
</parameters>
-<return> the number of elements in the #GSList
+<return> @msgval, unless @msgval is identical to @msgid and contains
+a '|' character, in which case a pointer to the substring of msgid after
+the first '|' character is returned.
+
</return>
</function>
-<function name="g_slist_next">
+<function name="g_strjoin">
<description>
-A convenience macro to get the next element in a #GSList.
+Joins a number of strings together to form one long string, with the
+optional @separator inserted between each of them. The returned string
+should be freed with g_free().
+
</description>
<parameters>
-<parameter name="slist">
-<parameter_description> an element in a #GSList.
+<parameter name="separator">
+<parameter_description> a string to insert between each of the strings, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> a %NULL-terminated list of strings to join
</parameter_description>
</parameter>
</parameters>
-<return> the next element, or %NULL if there are no more elements.
+<return> a newly-allocated string containing all of the strings joined
+together, with @separator between them
</return>
</function>
-<function name="g_slist_nth">
+<function name="g_strjoinv">
<description>
-Gets the element at the given position in a #GSList.
+Joins a number of strings together to form one long string, with the
+optional @separator inserted between each of them. The returned string
+should be freed with g_free().
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GSList
+<parameter name="separator">
+<parameter_description> a string to insert between each of the strings, or %NULL
</parameter_description>
</parameter>
-<parameter name="n">
-<parameter_description> the position of the element, counting from 0
+<parameter name="str_array">
+<parameter_description> a %NULL-terminated array of strings to join
</parameter_description>
</parameter>
</parameters>
-<return> the element, or %NULL if the position is off
-the end of the #GSList
+<return> a newly-allocated string containing all of the strings joined
+together, with @separator between them
</return>
</function>
-<function name="g_slist_nth_data">
+<function name="g_strlcat">
<description>
-Gets the data of the element at the given position.
+Portability wrapper that calls strlcat() on systems which have it,
+and emulates it otherwise. Appends nul-terminated @src string to @dest,
+guaranteeing nul-termination for @dest. The total size of @dest won't
+exceed @dest_size.
+
+At most dest_size - 1 characters will be copied.
+Unlike strncat, dest_size is the full size of dest, not the space left over.
+This function does NOT allocate memory.
+This always NUL terminates (unless siz == 0 or there were no NUL characters
+in the dest_size characters of dest to start with).
+
+<note><para>Caveat: this is supposedly a more secure alternative to
+strcat() or strncat(), but for real security g_strconcat() is harder
+to mess up.</para></note>
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GSList
+<parameter name="dest">
+<parameter_description> destination buffer, already containing one nul-terminated string
</parameter_description>
</parameter>
-<parameter name="n">
-<parameter_description> the position of the element
+<parameter name="src">
+<parameter_description> source buffer
+</parameter_description>
+</parameter>
+<parameter name="dest_size">
+<parameter_description> length of @dest buffer in bytes (not length of existing string
+inside @dest)
</parameter_description>
</parameter>
</parameters>
-<return> the element's data, or %NULL if the position
-is off the end of the #GSList
+<return> size of attempted result, which is MIN (dest_size, strlen
+(original dest)) + strlen (src), so if retval >= dest_size,
+truncation occurred.
</return>
</function>
-<function name="g_slist_pop_allocator">
+<function name="g_strlcpy">
<description>
-Restores the previous #GAllocator, used when allocating #GSList
-elements.
+Portability wrapper that calls strlcpy() on systems which have it,
+and emulates strlcpy() otherwise. Copies @src to @dest; @dest is
+guaranteed to be nul-terminated; @src must be nul-terminated;
+ dest_size is the buffer size, not the number of chars to copy.
-Note that this function is not available if GLib has been compiled
-with <option>--disable-mem-pools</option>
+At most dest_size - 1 characters will be copied. Always nul-terminates
+(unless dest_size == 0). This function does <emphasis>not</emphasis>
+allocate memory. Unlike strncpy(), this function doesn't pad dest (so
+it's often faster). It returns the size of the attempted result,
+strlen (src), so if @retval >= @dest_size, truncation occurred.
+
+<note><para>Caveat: strlcpy() is supposedly more secure than
+strcpy() or strncpy(), but if you really want to avoid screwups,
+g_strdup() is an even better idea.</para></note>
-Deprecated: 2.10: It does nothing, since #GSList has been converted
-to the <link linkend="glib-Memory-Slices">slice
-allocator</link>
</description>
<parameters>
+<parameter name="dest">
+<parameter_description> destination buffer
+</parameter_description>
+</parameter>
+<parameter name="src">
+<parameter_description> source buffer
+</parameter_description>
+</parameter>
+<parameter name="dest_size">
+<parameter_description> length of @dest in bytes
+</parameter_description>
+</parameter>
</parameters>
-<return></return>
+<return> length of @src
+</return>
</function>
-<function name="g_slist_position">
+<function name="g_strncasecmp">
<description>
-Gets the position of the given element
-in the #GSList (starting from 0).
+A case-insensitive string comparison, corresponding to the standard
+strncasecmp() function on platforms which support it.
+It is similar to g_strcasecmp() except it only compares the first @n
+characters of the strings.
+Deprecated:2.2: The problem with g_strncasecmp() is that it does the
+comparison by calling toupper()/tolower(). These functions are
+locale-specific and operate on single bytes. However, it is impossible
+to handle things correctly from an I18N standpoint by operating on
+bytes, since characters may be multibyte. Thus g_strncasecmp() is
+broken if your string is guaranteed to be ASCII, since it's
+locale-sensitive, and it's broken if your string is localized, since
+it doesn't work on many encodings at all, including UTF-8, EUC-JP,
+etc.
+
+There are therefore two replacement functions: g_ascii_strncasecmp(),
+which only works on ASCII and is not locale-sensitive, and
+g_utf8_casefold(), which is good for case-insensitive sorting of UTF-8.
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GSList
+<parameter name="s1">
+<parameter_description> a string.
</parameter_description>
</parameter>
-<parameter name="llink">
-<parameter_description> an element in the #GSList
+<parameter name="s2">
+<parameter_description> a string to compare with @s1.
+</parameter_description>
+</parameter>
+<parameter name="n">
+<parameter_description> the maximum number of characters to compare.
</parameter_description>
</parameter>
</parameters>
-<return> the position of the element in the #GSList,
-or -1 if the element is not found
+<return> 0 if the strings match, a negative value if @s1 < @s2,
+or a positive value if @s1 > @s2.
+
</return>
</function>
-<function name="g_slist_prepend">
+<function name="g_strndup">
<description>
-Adds a new element on to the start of the list.
+Duplicates the first @n bytes of a string, returning a newly-allocated
+buffer @n + 1 bytes long which will always be nul-terminated.
+If @str is less than @n bytes long the buffer is padded with nuls.
+If @str is %NULL it returns %NULL.
+The returned value should be freed when no longer needed.
<note><para>
-The return value is the new start of the list, which
-may have changed, so make sure you store the new value.
+To copy a number of characters from a UTF-8 encoded string, use
+g_utf8_strncpy() instead.
</para></note>
-|[
-/ * Notice that it is initialized to the empty list. * /
-GSList *list = NULL;
-list = g_slist_prepend (list, "last");
-list = g_slist_prepend (list, "first");
-]|
-
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GSList
+<parameter name="str">
+<parameter_description> the string to duplicate
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> the data for the new element
+<parameter name="n">
+<parameter_description> the maximum number of bytes to copy from @str
</parameter_description>
</parameter>
</parameters>
-<return> the new start of the #GSList
+<return> a newly-allocated buffer containing the first @n bytes
+of @str, nul-terminated
</return>
</function>
-<function name="g_slist_push_allocator">
+<function name="g_strnfill">
<description>
-Sets the allocator to use to allocate #GSList elements. Use
-g_slist_pop_allocator() to restore the previous allocator.
-
-Note that this function is not available if GLib has been compiled
-with <option>--disable-mem-pools</option>
+Creates a new string @length bytes long filled with @fill_char.
+The returned string should be freed when no longer needed.
-Deprecated: 2.10: It does nothing, since #GSList has been converted
-to the <link linkend="glib-Memory-Slices">slice
-allocator</link>
</description>
<parameters>
-<parameter name="dummy">
-<parameter_description> the #GAllocator to use when allocating #GSList elements.
+<parameter name="length">
+<parameter_description> the length of the new string
+</parameter_description>
+</parameter>
+<parameter name="fill_char">
+<parameter_description> the byte to fill the string with
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a newly-allocated string filled the @fill_char
+</return>
</function>
-<function name="g_slist_remove">
+<function name="g_strreverse">
<description>
-Removes an element from a #GSList.
-If two elements contain the same data, only the first is removed.
-If none of the elements contain the data, the #GSList is unchanged.
+Reverses all of the bytes in a string. For example,
+<literal>g_strreverse ("abcdef")</literal> will result
+in "fedcba".
+
+Note that g_strreverse() doesn't work on UTF-8 strings
+containing multibyte characters. For that purpose, use
+g_utf8_strreverse().
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GSList
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> the data of the element to remove
+<parameter name="string">
+<parameter_description> the string to reverse
</parameter_description>
</parameter>
</parameters>
-<return> the new start of the #GSList
+<return> the same pointer passed in as @string
</return>
</function>
-<function name="g_slist_remove_all">
+<function name="g_strrstr">
<description>
-Removes all list nodes with data equal to @data.
-Returns the new head of the list. Contrast with
-g_slist_remove() which removes only the first node
-matching the given data.
+Searches the string @haystack for the last occurrence
+of the string @needle.
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GSList
+<parameter name="haystack">
+<parameter_description> a nul-terminated string.
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> data to remove
+<parameter name="needle">
+<parameter_description> the nul-terminated string to search for.
</parameter_description>
</parameter>
</parameters>
-<return> new head of @list
+<return> a pointer to the found occurrence, or
+%NULL if not found.
</return>
</function>
-<function name="g_slist_remove_link">
+<function name="g_strrstr_len">
<description>
-Removes an element from a #GSList, without
-freeing the element. The removed element's next
-link is set to %NULL, so that it becomes a
-self-contained list with one element.
+Searches the string @haystack for the last occurrence
+of the string @needle, limiting the length of the search
+to @haystack_len.
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GSList
+<parameter name="haystack">
+<parameter_description> a nul-terminated string.
</parameter_description>
</parameter>
-<parameter name="link_">
-<parameter_description> an element in the #GSList
+<parameter name="haystack_len">
+<parameter_description> the maximum length of @haystack.
+</parameter_description>
+</parameter>
+<parameter name="needle">
+<parameter_description> the nul-terminated string to search for.
</parameter_description>
</parameter>
</parameters>
-<return> the new start of the #GSList, without the element
+<return> a pointer to the found occurrence, or
+%NULL if not found.
</return>
</function>
-<function name="g_slist_reverse">
+<function name="g_strsignal">
<description>
-Reverses a #GSList.
+Returns a string describing the given signal, e.g. "Segmentation fault".
+You should use this function in preference to strsignal(), because it
+returns a string in UTF-8 encoding, and since not all platforms support
+the strsignal() function.
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GSList
+<parameter name="signum">
+<parameter_description> the signal number. See the <literal>signal</literal>
+documentation
</parameter_description>
</parameter>
</parameters>
-<return> the start of the reversed #GSList
+<return> a UTF-8 string describing the signal. If the signal is unknown,
+it returns "unknown signal (<signum>)". The string can only be
+used until the next call to g_strsignal()
</return>
</function>
-<function name="g_slist_sort">
+<function name="g_strsplit">
<description>
-Sorts a #GSList using the given comparison function.
+Splits a string into a maximum of @max_tokens pieces, using the given
+ delimiter If @max_tokens is reached, the remainder of @string is appended
+to the last token.
+
+As a special case, the result of splitting the empty string "" is an empty
+vector, not a vector containing a single string. The reason for this
+special case is that being able to represent a empty vector is typically
+more useful than consistent handling of empty elements. If you do need
+to represent empty elements, you'll need to check for the empty string
+before calling g_strsplit().
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GSList
+<parameter name="string">
+<parameter_description> a string to split.
</parameter_description>
</parameter>
-<parameter name="compare_func">
-<parameter_description> the comparison function used to sort the #GSList.
-This function is passed the data from 2 elements of the #GSList
-and should return 0 if they are equal, a negative value if the
-first element comes before the second, or a positive value if
-the first element comes after the second.
+<parameter name="delimiter">
+<parameter_description> a string which specifies the places at which to split the string.
+The delimiter is not included in any of the resulting strings, unless
+ max_tokens is reached.
+</parameter_description>
+</parameter>
+<parameter name="max_tokens">
+<parameter_description> the maximum number of pieces to split @string into. If this is
+less than 1, the string is split completely.
</parameter_description>
</parameter>
</parameters>
-<return> the start of the sorted #GSList
+<return> a newly-allocated %NULL-terminated array of strings. Use
+g_strfreev() to free it.
</return>
</function>
-<function name="g_slist_sort_with_data">
+<function name="g_strsplit_set">
<description>
-Like g_slist_sort(), but the sort function accepts a user data argument.
+Splits @string into a number of tokens not containing any of the characters
+in @delimiter. A token is the (possibly empty) longest string that does not
+contain any of the characters in @delimiters. If @max_tokens is reached, the
+remainder is appended to the last token.
+
+For example the result of g_strsplit_set ("abc:def/ghi", ":/", -1) is a
+%NULL-terminated vector containing the three strings "abc", "def",
+and "ghi".
+
+The result if g_strsplit_set (":def/ghi:", ":/", -1) is a %NULL-terminated
+vector containing the four strings "", "def", "ghi", and "".
+
+As a special case, the result of splitting the empty string "" is an empty
+vector, not a vector containing a single string. The reason for this
+special case is that being able to represent a empty vector is typically
+more useful than consistent handling of empty elements. If you do need
+to represent empty elements, you'll need to check for the empty string
+before calling g_strsplit_set().
+Note that this function works on bytes not characters, so it can't be used
+to delimit UTF-8 strings for anything but ASCII characters.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GSList
+<parameter name="string">
+<parameter_description> The string to be tokenized
</parameter_description>
</parameter>
-<parameter name="compare_func">
-<parameter_description> comparison function
+<parameter name="delimiters">
+<parameter_description> A nul-terminated string containing bytes that are used
+to split the string.
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> data to pass to comparison function
+<parameter name="max_tokens">
+<parameter_description> The maximum number of tokens to split @string into.
+If this is less than 1, the string is split completely
</parameter_description>
</parameter>
</parameters>
-<return> new head of the list
+<return> a newly-allocated %NULL-terminated array of strings. Use
+g_strfreev() to free it.
+
</return>
</function>
-<function name="g_snprintf">
+<function name="g_strstr_len">
<description>
-A safer form of the standard sprintf() function. The output is guaranteed
-to not exceed @n characters (including the terminating nul character), so
-it is easy to ensure that a buffer overflow cannot occur.
-
-See also g_strdup_printf().
-
-In versions of GLib prior to 1.2.3, this function may return -1 if the
-output was truncated, and the truncated string may not be nul-terminated.
-In versions prior to 1.3.12, this function returns the length of the output
-string.
-
-The return value of g_snprintf() conforms to the snprintf()
-function as standardized in ISO C99. Note that this is different from
-traditional snprintf(), which returns the length of the output string.
-
-The format string may contain positional parameters, as specified in
-the Single Unix Specification.
+Searches the string @haystack for the first occurrence
+of the string @needle, limiting the length of the search
+to @haystack_len.
</description>
<parameters>
-<parameter name="string">
-<parameter_description> the buffer to hold the output.
-</parameter_description>
-</parameter>
-<parameter name="n">
-<parameter_description> the maximum number of bytes to produce (including the
-terminating nul character).
+<parameter name="haystack">
+<parameter_description> a string.
</parameter_description>
</parameter>
-<parameter name="format">
-<parameter_description> a standard printf() format string, but notice
-<link linkend="string-precision">string precision pitfalls</link>.
+<parameter name="haystack_len">
+<parameter_description> the maximum length of @haystack. Note that -1 is
+a valid length, if @haystack is nul-terminated, meaning it will
+search through the whole string.
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> the arguments to insert in the output.
+<parameter name="needle">
+<parameter_description> the string to search for.
</parameter_description>
</parameter>
</parameters>
-<return> the number of bytes which would be produced if the buffer
-was large enough.
+<return> a pointer to the found occurrence, or
+%NULL if not found.
</return>
</function>
-<function name="g_source_add_child_source">
+<function name="g_strtod">
<description>
-Adds @child_source to @source as a "polled" source; when @source is
-added to a #GMainContext, @child_source will be automatically added
-with the same priority, when @child_source is triggered, it will
-cause @source to dispatch (in addition to calling its own
-callback), and when @source is destroyed, it will destroy
- child_source as well. (@source will also still be dispatched if
-its own prepare/check functions indicate that it is ready.)
-
-If you don't need @child_source to do anything on its own when it
-triggers, you can call g_source_set_dummy_callback() on it to set a
-callback that does nothing (except return %TRUE if appropriate).
+Converts a string to a #gdouble value.
+It calls the standard strtod() function to handle the conversion, but
+if the string is not completely converted it attempts the conversion
+again with g_ascii_strtod(), and returns the best match.
- source will hold a reference on @child_source while @child_source
-is attached to it.
+This function should seldomly be used. The normal situation when reading
+numbers not for human consumption is to use g_ascii_strtod(). Only when
+you know that you must expect both locale formatted and C formatted numbers
+should you use this. Make sure that you don't pass strings such as comma
+separated lists of values, since the commas may be interpreted as a decimal
+point in some locales, causing unexpected results.
-Since: 2.28
</description>
<parameters>
-<parameter name="source">
-<parameter_description>a #GSource
+<parameter name="nptr">
+<parameter_description> the string to convert to a numeric value.
</parameter_description>
</parameter>
-<parameter name="child_source">
-<parameter_description> a second #GSource that @source should "poll"
+<parameter name="endptr">
+<parameter_description> if non-%NULL, it returns the character after
+the last character used in the conversion.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the #gdouble value.
+</return>
</function>
-<function name="g_source_add_poll">
+<function name="g_strup">
<description>
-Adds a file descriptor to the set of file descriptors polled for
-this source. This is usually combined with g_source_new() to add an
-event source. The event source's check function will typically test
-the @revents field in the #GPollFD struct and return %TRUE if events need
-to be processed.
+Converts a string to upper case.
+
+Deprecated:2.2: This function is totally broken for the reasons discussed
+in the g_strncasecmp() docs - use g_ascii_strup() or g_utf8_strup() instead.
</description>
<parameters>
-<parameter name="source">
-<parameter_description>a #GSource
-</parameter_description>
-</parameter>
-<parameter name="fd">
-<parameter_description> a #GPollFD structure holding information about a file
-descriptor to watch.
+<parameter name="string">
+<parameter_description> the string to convert.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the string
+
+</return>
</function>
-<function name="g_source_attach">
+<function name="g_strv_length">
<description>
-Adds a #GSource to a @context so that it will be executed within
-that context. Remove it by calling g_source_destroy().
+Returns the length of the given %NULL-terminated
+string array @str_array.
+Since: 2.6
</description>
<parameters>
-<parameter name="source">
-<parameter_description> a #GSource
-</parameter_description>
-</parameter>
-<parameter name="context">
-<parameter_description> a #GMainContext (if %NULL, the default context will be used)
+<parameter name="str_array">
+<parameter_description> a %NULL-terminated array of strings.
</parameter_description>
</parameter>
</parameters>
-<return> the ID (greater than 0) for the source within the
-#GMainContext.
+<return> length of @str_array.
+
</return>
</function>
-<function name="g_source_destroy">
+<function name="g_test_add">
<description>
-Removes a source from its #GMainContext, if any, and mark it as
-destroyed. The source cannot be subsequently added to another
-context.
+Hook up a new test case at @testpath, similar to g_test_add_func().
+A fixture data structure with setup and teardown function may be provided
+though, similar to g_test_create_case().
+g_test_add() is implemented as a macro, so that the fsetup(), ftest() and
+fteardown() callbacks can expect a @Fixture pointer as first argument in
+a type safe manner.
+
+Since: 2.16
</description>
<parameters>
-<parameter name="source">
-<parameter_description> a #GSource
+<parameter name="testpath">
+<parameter_description> The test path for a new test case.
+</parameter_description>
+</parameter>
+<parameter name="Fixture">
+<parameter_description> The type of a fixture data structure.
+</parameter_description>
+</parameter>
+<parameter name="tdata">
+<parameter_description> Data argument for the test functions.
+</parameter_description>
+</parameter>
+<parameter name="fsetup">
+<parameter_description> The function to set up the fixture data.
+</parameter_description>
+</parameter>
+<parameter name="ftest">
+<parameter_description> The actual test function.
+</parameter_description>
+</parameter>
+<parameter name="fteardown">
+<parameter_description> The function to tear down the fixture data.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_source_get_can_recurse">
+<function name="g_test_add_data_func">
<description>
-Checks whether a source is allowed to be called recursively.
-see g_source_set_can_recurse().
+Create a new test case, similar to g_test_create_case(). However
+the test is assumed to use no fixture, and test suites are automatically
+created on the fly and added to the root fixture, based on the
+slash-separated portions of @testpath. The @test_data argument
+will be passed as first argument to @test_func.
+Since: 2.16
</description>
<parameters>
-<parameter name="source">
-<parameter_description> a #GSource
+<parameter name="testpath">
+<parameter_description> Slash-separated test case path name for the test.
</parameter_description>
</parameter>
-</parameters>
-<return> whether recursion is allowed.
-</return>
-</function>
-
-<function name="g_source_get_context">
-<description>
-Gets the #GMainContext with which the source is associated.
-Calling this function on a destroyed source is an error.
-
-
-</description>
-<parameters>
-<parameter name="source">
-<parameter_description> a #GSource
+<parameter name="test_data">
+<parameter_description> Test data argument for the test function.
+</parameter_description>
+</parameter>
+<parameter name="test_func">
+<parameter_description> The test function to invoke for this test.
</parameter_description>
</parameter>
</parameters>
-<return> the #GMainContext with which the source is associated,
-or %NULL if the context has not yet been added
-to a source.
-</return>
+<return></return>
</function>
-<function name="g_source_get_current_time">
+<function name="g_test_add_func">
<description>
-Gets the "current time" to be used when checking
-this source. The advantage of calling this function over
-calling g_get_current_time() directly is that when
-checking multiple sources, GLib can cache a single value
-instead of having to repeatedly get the system time.
+Create a new test case, similar to g_test_create_case(). However
+the test is assumed to use no fixture, and test suites are automatically
+created on the fly and added to the root fixture, based on the
+slash-separated portions of @testpath.
-Deprecated: 2.28: use g_source_get_time() instead
+Since: 2.16
</description>
<parameters>
-<parameter name="source">
-<parameter_description> a #GSource
+<parameter name="testpath">
+<parameter_description> Slash-separated test case path name for the test.
</parameter_description>
</parameter>
-<parameter name="timeval">
-<parameter_description> #GTimeVal structure in which to store current time.
+<parameter name="test_func">
+<parameter_description> The test function to invoke for this test.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_source_get_id">
+<function name="g_test_bug">
<description>
-Returns the numeric ID for a particular source. The ID of a source
-is a positive integer which is unique within a particular main loop
-context. The reverse
-mapping from ID to source is done by g_main_context_find_source_by_id().
+This function adds a message to test reports that
+associates a bug URI with a test case.
+Bug URIs are constructed from a base URI set with g_test_bug_base()
+and @bug_uri_snippet.
+Since: 2.16
</description>
<parameters>
-<parameter name="source">
-<parameter_description> a #GSource
+<parameter name="bug_uri_snippet">
+<parameter_description> Bug specific bug tracker URI portion.
</parameter_description>
</parameter>
</parameters>
-<return> the ID (greater than 0) for the source
-</return>
+<return></return>
</function>
-<function name="g_source_get_name">
+<function name="g_test_bug_base">
<description>
-Gets a name for the source, used in debugging and profiling.
-The name may be #NULL if it has never been set with
-g_source_set_name().
+Specify the base URI for bug reports.
-Since: 2.26
+The base URI is used to construct bug report messages for
+g_test_message() when g_test_bug() is called.
+Calling this function outside of a test case sets the
+default base URI for all test cases. Calling it from within
+a test case changes the base URI for the scope of the test
+case only.
+Bug URIs are constructed by appending a bug specific URI
+portion to @uri_pattern, or by replacing the special string
+'%s' within @uri_pattern if that is present.
+
+Since: 2.16
</description>
<parameters>
-<parameter name="source">
-<parameter_description> a #GSource
+<parameter name="uri_pattern">
+<parameter_description> the base pattern for bug URIs
</parameter_description>
</parameter>
</parameters>
-<return> the name of the source
-</return>
+<return></return>
</function>
-<function name="g_source_get_priority">
+<function name="g_test_create_case">
<description>
-Gets the priority of a source.
+Create a new #GTestCase, named @test_name, this API is fairly
+low level, calling g_test_add() or g_test_add_func() is preferable.
+When this test is executed, a fixture structure of size @data_size
+will be allocated and filled with 0s. Then data_setup() is called
+to initialize the fixture. After fixture setup, the actual test
+function data_test() is called. Once the test run completed, the
+fixture structure is torn down by calling data_teardown() and
+after that the memory is released.
+
+Splitting up a test run into fixture setup, test function and
+fixture teardown is most usful if the same fixture is used for
+multiple tests. In this cases, g_test_create_case() will be
+called with the same fixture, but varying @test_name and
+ data_test arguments.
+Since: 2.16
</description>
<parameters>
-<parameter name="source">
-<parameter_description> a #GSource
+<parameter name="test_name">
+<parameter_description> the name for the test case
+</parameter_description>
+</parameter>
+<parameter name="data_size">
+<parameter_description> the size of the fixture data structure
+</parameter_description>
+</parameter>
+<parameter name="test_data">
+<parameter_description> test data argument for the test functions
+</parameter_description>
+</parameter>
+<parameter name="data_setup">
+<parameter_description> the function to set up the fixture data
+</parameter_description>
+</parameter>
+<parameter name="data_test">
+<parameter_description> the actual test function
+</parameter_description>
+</parameter>
+<parameter name="data_teardown">
+<parameter_description> the function to teardown the fixture data
</parameter_description>
</parameter>
</parameters>
-<return> the priority of the source
+<return> a newly allocated #GTestCase.
+
</return>
</function>
-<function name="g_source_get_time">
+<function name="g_test_create_suite">
<description>
-Gets the time to be used when checking this source. The advantage of
-calling this function over calling g_get_monotonic_time() directly is
-that when checking multiple sources, GLib can cache a single value
-instead of having to repeatedly get the system monotonic time.
-
-The time here is the system monotonic time, if available, or some
-other reasonable alternative otherwise. See g_get_monotonic_time().
+Create a new test suite with the name @suite_name.
-Since: 2.28
+Since: 2.16
</description>
<parameters>
-<parameter name="source">
-<parameter_description> a #GSource
+<parameter name="suite_name">
+<parameter_description> a name for the suite
</parameter_description>
</parameter>
</parameters>
-<return> the monotonic time in microseconds
+<return> A newly allocated #GTestSuite instance.
</return>
</function>
-<function name="g_source_is_destroyed">
+<function name="g_test_fail">
<description>
-Returns whether @source has been destroyed.
-
-This is important when you operate upon your objects
-from within idle handlers, but may have freed the object
-before the dispatch of your idle handler.
-
-|[
-static gboolean
-idle_callback (gpointer data)
-{
-SomeWidget *self = data;
-
-GDK_THREADS_ENTER (<!-- -->);
-/<!-- -->* do stuff with self *<!-- -->/
-self->idle_id = 0;
-GDK_THREADS_LEAVE (<!-- -->);
-
-return FALSE;
-}
-
-static void
-some_widget_do_stuff_later (SomeWidget *self)
-{
-self->idle_id = g_idle_add (idle_callback, self);
-}
-
-static void
-some_widget_finalize (GObject *object)
-{
-SomeWidget *self = SOME_WIDGET (object);
+Indicates that a test failed. This function can be called
+multiple times from the same test. You can use this function
+if your test failed in a recoverable way.
-if (self->idle_id)
-g_source_remove (self->idle_id);
+Do not use this function if the failure of a test could cause
+other tests to malfunction.
-G_OBJECT_CLASS (parent_class)->finalize (object);
-}
-]|
+Calling this function will not stop the test from running, you
+need to return from the test function yourself. So you can
+produce additional diagnostic messages or even continue running
+the test.
-This will fail in a multi-threaded application if the
-widget is destroyed before the idle handler fires due
-to the use after free in the callback. A solution, to
-this particular problem, is to check to if the source
-has already been destroy within the callback.
+If not called from inside a test, this function does nothing.
-|[
-static gboolean
-idle_callback (gpointer data)
-{
-SomeWidget *self = data;
+Since: 2.30
-GDK_THREADS_ENTER ();
-if (!g_source_is_destroyed (g_main_current_source ()))
-{
-/<!-- -->* do stuff with self *<!-- -->/
-}
-GDK_THREADS_LEAVE ();
+</description>
+<parameters>
+</parameters>
+<return></return>
+</function>
-return FALSE;
-}
-]|
+<function name="g_test_get_root">
+<description>
+Get the toplevel test suite for the test path API.
-Since: 2.12
+Since: 2.16
</description>
<parameters>
-<parameter name="source">
-<parameter_description> a #GSource
-</parameter_description>
-</parameter>
</parameters>
-<return> %TRUE if the source has been destroyed
+<return> the toplevel #GTestSuite
</return>
</function>
-<function name="g_source_new">
+<function name="g_test_init">
<description>
-Creates a new #GSource structure. The size is specified to
-allow creating structures derived from #GSource that contain
-additional data. The size passed in must be at least
-<literal>sizeof (GSource)</literal>.
-
-The source will not initially be associated with any #GMainContext
-and must be added to one with g_source_attach() before it will be
-executed.
+Initialize the GLib testing framework, e.g. by seeding the
+test random number generator, the name for g_get_prgname()
+and parsing test related command line args.
+So far, the following arguments are understood:
+<variablelist>
+<varlistentry>
+<term><option>-l</option></term>
+<listitem><para>
+list test cases available in a test executable.
+</para></listitem>
+</varlistentry>
+<varlistentry>
+<term><option>--seed=<replaceable>RANDOMSEED</replaceable></option></term>
+<listitem><para>
+provide a random seed to reproduce test runs using random numbers.
+</para></listitem>
+</varlistentry>
+<varlistentry>
+<term><option>--verbose</option></term>
+<listitem><para>run tests verbosely.</para></listitem>
+</varlistentry>
+<varlistentry>
+<term><option>-q</option>, <option>--quiet</option></term>
+<listitem><para>run tests quietly.</para></listitem>
+</varlistentry>
+<varlistentry>
+<term><option>-p <replaceable>TESTPATH</replaceable></option></term>
+<listitem><para>
+execute all tests matching <replaceable>TESTPATH</replaceable>.
+</para></listitem>
+</varlistentry>
+<varlistentry>
+<term><option>-m {perf|slow|thorough|quick}</option></term>
+<listitem><para>
+execute tests according to these test modes:
+<variablelist>
+<varlistentry>
+<term>perf</term>
+<listitem><para>
+performance tests, may take long and report results.
+</para></listitem>
+</varlistentry>
+<varlistentry>
+<term>slow, thorough</term>
+<listitem><para>
+slow and thorough tests, may take quite long and
+maximize coverage.
+</para></listitem>
+</varlistentry>
+<varlistentry>
+<term>quick</term>
+<listitem><para>
+quick tests, should run really quickly and give good coverage.
+</para></listitem>
+</varlistentry>
+</variablelist>
+</para></listitem>
+</varlistentry>
+<varlistentry>
+<term><option>--debug-log</option></term>
+<listitem><para>debug test logging output.</para></listitem>
+</varlistentry>
+<varlistentry>
+<term><option>-k</option>, <option>--keep-going</option></term>
+<listitem><para>gtester-specific argument.</para></listitem>
+</varlistentry>
+<varlistentry>
+<term><option>--GTestLogFD <replaceable>N</replaceable></option></term>
+<listitem><para>gtester-specific argument.</para></listitem>
+</varlistentry>
+<varlistentry>
+<term><option>--GTestSkipCount <replaceable>N</replaceable></option></term>
+<listitem><para>gtester-specific argument.</para></listitem>
+</varlistentry>
+</variablelist>
+Since: 2.16
</description>
<parameters>
-<parameter name="source_funcs">
-<parameter_description> structure containing functions that implement
-the sources behavior.
+<parameter name="argc">
+<parameter_description> Address of the @argc parameter of the main() function.
+Changed if any arguments were handled.
</parameter_description>
</parameter>
-<parameter name="struct_size">
-<parameter_description> size of the #GSource structure to create.
+<parameter name="argv">
+<parameter_description> Address of the @argv parameter of main().
+Any parameters understood by g_test_init() stripped before return.
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> Reserved for future extension. Currently, you must pass %NULL.
</parameter_description>
</parameter>
</parameters>
-<return> the newly-created #GSource.
-</return>
+<return></return>
</function>
-<function name="g_source_ref">
+<function name="g_test_log_buffer_free">
<description>
-Increases the reference count on a source by one.
-
+Internal function for gtester to free test log messages, no ABI guarantees provided.
</description>
<parameters>
-<parameter name="source">
-<parameter_description> a #GSource
-</parameter_description>
-</parameter>
</parameters>
-<return> @source
-</return>
+<return></return>
</function>
-<function name="g_source_remove">
+<function name="g_test_log_buffer_new">
<description>
-Removes the source with the given id from the default main context.
-The id of
-a #GSource is given by g_source_get_id(), or will be returned by the
-functions g_source_attach(), g_idle_add(), g_idle_add_full(),
-g_timeout_add(), g_timeout_add_full(), g_child_watch_add(),
-g_child_watch_add_full(), g_io_add_watch(), and g_io_add_watch_full().
-
-See also g_source_destroy(). You must use g_source_destroy() for sources
-added to a non-default main context.
-
+Internal function for gtester to decode test log messages, no ABI guarantees provided.
</description>
<parameters>
-<parameter name="tag">
-<parameter_description> the ID of the source to remove.
-</parameter_description>
-</parameter>
</parameters>
-<return> %TRUE if the source was found and removed.
-</return>
+<return></return>
</function>
-<function name="g_source_remove_by_funcs_user_data">
+<function name="g_test_log_buffer_pop">
<description>
-Removes a source from the default main loop context given the
-source functions and user data. If multiple sources exist with the
-same source functions and user data, only one will be destroyed.
-
+Internal function for gtester to retrieve test log messages, no ABI guarantees provided.
</description>
<parameters>
-<parameter name="funcs">
-<parameter_description> The @source_funcs passed to g_source_new()
-</parameter_description>
-</parameter>
-<parameter name="user_data">
-<parameter_description> the user data for the callback
-</parameter_description>
-</parameter>
</parameters>
-<return> %TRUE if a source was found and removed.
-</return>
+<return></return>
</function>
-<function name="g_source_remove_by_user_data">
+<function name="g_test_log_buffer_push">
<description>
-Removes a source from the default main loop context given the user
-data for the callback. If multiple sources exist with the same user
-data, only one will be destroyed.
-
+Internal function for gtester to decode test log messages, no ABI guarantees provided.
</description>
<parameters>
-<parameter name="user_data">
-<parameter_description> the user_data for the callback.
-</parameter_description>
-</parameter>
</parameters>
-<return> %TRUE if a source was found and removed.
-</return>
+<return></return>
</function>
-<function name="g_source_remove_child_source">
+<function name="g_test_log_msg_free">
<description>
-Detaches @child_source from @source and destroys it.
-
-Since: 2.28
+Internal function for gtester to free test log messages, no ABI guarantees provided.
</description>
<parameters>
-<parameter name="source">
-<parameter_description>a #GSource
-</parameter_description>
-</parameter>
-<parameter name="child_source">
-<parameter_description> a #GSource previously passed to
-g_source_add_child_source().
-</parameter_description>
-</parameter>
</parameters>
<return></return>
</function>
-<function name="g_source_remove_poll">
+<function name="g_test_log_set_fatal_handler">
<description>
-Removes a file descriptor from the set of file descriptors polled for
-this source.
+Installs a non-error fatal log handler which can be
+used to decide whether log messages which are counted
+as fatal abort the program.
+
+The use case here is that you are running a test case
+that depends on particular libraries or circumstances
+and cannot prevent certain known critical or warning
+messages. So you install a handler that compares the
+domain and message to precisely not abort in such a case.
+
+Note that the handler is reset at the beginning of
+any test case, so you have to set it inside each test
+function which needs the special behavior.
+
+This handler has no effect on g_error messages.
+
+Since: 2.22
</description>
<parameters>
-<parameter name="source">
-<parameter_description>a #GSource
+<parameter name="log_func">
+<parameter_description> the log handler function.
</parameter_description>
</parameter>
-<parameter name="fd">
-<parameter_description> a #GPollFD structure previously passed to g_source_add_poll().
+<parameter name="user_data">
+<parameter_description> data passed to the log handler.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_source_set_callback">
+<function name="g_test_maximized_result">
<description>
-Sets the callback function for a source. The callback for a source is
-called from the source's dispatch function.
-
-The exact type of @func depends on the type of source; ie. you
-should not count on @func being called with @data as its first
-parameter.
+Report the result of a performance or measurement test.
+The test should generally strive to maximize the reported
+quantities (larger values are better than smaller ones),
+this and @maximized_quantity can determine sorting
+order for test result reports.
-Typically, you won't use this function. Instead use functions specific
-to the type of source you are using.
+Since: 2.16
</description>
<parameters>
-<parameter name="source">
-<parameter_description> the source
-</parameter_description>
-</parameter>
-<parameter name="func">
-<parameter_description> a callback function
+<parameter name="maximized_quantity">
+<parameter_description> the reported value
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> the data to pass to callback function
+<parameter name="format">
+<parameter_description> the format string of the report message
</parameter_description>
</parameter>
-<parameter name="notify">
-<parameter_description> a function to call when @data is no longer in use, or %NULL.
+<parameter name="Varargs">
+<parameter_description> arguments to pass to the printf() function
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_source_set_callback_indirect">
+<function name="g_test_message">
<description>
-Sets the callback function storing the data as a refcounted callback
-"object". This is used internally. Note that calling
-g_source_set_callback_indirect() assumes
-an initial reference count on @callback_data, and thus
- callback_funcs->unref will eventually be called once more
-than @callback_funcs->ref.
+Add a message to the test report.
+
+Since: 2.16
</description>
<parameters>
-<parameter name="source">
-<parameter_description> the source
-</parameter_description>
-</parameter>
-<parameter name="callback_data">
-<parameter_description> pointer to callback data "object"
+<parameter name="format">
+<parameter_description> the format string
</parameter_description>
</parameter>
-<parameter name="callback_funcs">
-<parameter_description> functions for reference counting @callback_data
-and getting the callback and data
+<parameter name="Varargs">
+<parameter_description> printf-like arguments to @format
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_source_set_can_recurse">
+<function name="g_test_minimized_result">
<description>
-Sets whether a source can be called recursively. If @can_recurse is
-%TRUE, then while the source is being dispatched then this source
-will be processed normally. Otherwise, all processing of this
-source is blocked until the dispatch function returns.
+Report the result of a performance or measurement test.
+The test should generally strive to minimize the reported
+quantities (smaller values are better than larger ones),
+this and @minimized_quantity can determine sorting
+order for test result reports.
+
+Since: 2.16
</description>
<parameters>
-<parameter name="source">
-<parameter_description> a #GSource
+<parameter name="minimized_quantity">
+<parameter_description> the reported value
</parameter_description>
</parameter>
-<parameter name="can_recurse">
-<parameter_description> whether recursion is allowed for this source
+<parameter name="format">
+<parameter_description> the format string of the report message
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> arguments to pass to the printf() function
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_source_set_funcs">
+<function name="g_test_queue_destroy">
<description>
-Sets the source functions (can be used to override
-default implementations) of an unattached source.
+This function enqueus a callback @destroy_func() to be executed
+during the next test case teardown phase. This is most useful
+to auto destruct allocted test resources at the end of a test run.
+Resources are released in reverse queue order, that means enqueueing
+callback A before callback B will cause B() to be called before
+A() during teardown.
-Since: 2.12
+Since: 2.16
</description>
<parameters>
-<parameter name="source">
-<parameter_description> a #GSource
+<parameter name="destroy_func">
+<parameter_description> Destroy callback for teardown phase.
</parameter_description>
</parameter>
-<parameter name="funcs">
-<parameter_description> the new #GSourceFuncs
+<parameter name="destroy_data">
+<parameter_description> Destroy callback data.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_source_set_name">
+<function name="g_test_queue_free">
<description>
-Sets a name for the source, used in debugging and profiling.
-The name defaults to #NULL.
-
-The source name should describe in a human-readable way
-what the source does. For example, "X11 event queue"
-or "GTK+ repaint idle handler" or whatever it is.
-
-It is permitted to call this function multiple times, but is not
-recommended due to the potential performance impact. For example,
-one could change the name in the "check" function of a #GSourceFuncs
-to include details like the event type in the source name.
+Enqueue a pointer to be released with g_free() during the next
+teardown phase. This is equivalent to calling g_test_queue_destroy()
+with a destroy callback of g_free().
-Since: 2.26
+Since: 2.16
</description>
<parameters>
-<parameter name="source">
-<parameter_description> a #GSource
-</parameter_description>
-</parameter>
-<parameter name="name">
-<parameter_description> debug name for the source
+<parameter name="gfree_pointer">
+<parameter_description> the pointer to be stored.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_source_set_name_by_id">
+<function name="g_test_rand_double">
<description>
-Sets the name of a source using its ID.
-
-This is a convenience utility to set source names from the return
-value of g_idle_add(), g_timeout_add(), etc.
+Get a reproducible random floating point number,
+see g_test_rand_int() for details on test case random numbers.
-Since: 2.26
+Since: 2.16
</description>
<parameters>
-<parameter name="tag">
-<parameter_description> a #GSource ID
-</parameter_description>
-</parameter>
-<parameter name="name">
-<parameter_description> debug name for the source
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> a random number from the seeded random number generator.
+
+</return>
</function>
-<function name="g_source_set_priority">
+<function name="g_test_rand_double_range">
<description>
-Sets the priority of a source. While the main loop is being run, a
-source will be dispatched if it is ready to be dispatched and no
-sources at a higher (numerically smaller) priority are ready to be
-dispatched.
+Get a reproducible random floating pointer number out of a specified range,
+see g_test_rand_int() for details on test case random numbers.
+
+Since: 2.16
</description>
<parameters>
-<parameter name="source">
-<parameter_description> a #GSource
+<parameter name="range_start">
+<parameter_description> the minimum value returned by this function
</parameter_description>
</parameter>
-<parameter name="priority">
-<parameter_description> the new priority.
+<parameter name="range_end">
+<parameter_description> the minimum value not returned by this function
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a number with @range_start <= number < @range_end.
+
+</return>
</function>
-<function name="g_source_unref">
+<function name="g_test_rand_int">
<description>
-Decreases the reference count of a source by one. If the
-resulting reference count is zero the source and associated
-memory will be destroyed.
+Get a reproducible random integer number.
+
+The random numbers generated by the g_test_rand_*() family of functions
+change with every new test program start, unless the --seed option is
+given when starting test programs.
+
+For individual test cases however, the random number generator is
+reseeded, to avoid dependencies between tests and to make --seed
+effective for all test cases.
+
+Since: 2.16
</description>
<parameters>
-<parameter name="source">
-<parameter_description> a #GSource
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> a random number from the seeded random number generator.
+
+</return>
</function>
-<function name="g_spawn_async">
+<function name="g_test_rand_int_range">
<description>
-See g_spawn_async_with_pipes() for a full description; this function
-simply calls the g_spawn_async_with_pipes() without any pipes.
-
-You should call g_spawn_close_pid() on the returned child process
-reference when you don't need it any more.
-
-<note><para>
-If you are writing a GTK+ application, and the program you
-are spawning is a graphical application, too, then you may
-want to use gdk_spawn_on_screen() instead to ensure that
-the spawned program opens its windows on the right screen.
-</para></note>
-
-<note><para> Note that the returned @child_pid on Windows is a
-handle to the child process and not its identifier. Process handles
-and process identifiers are different concepts on Windows.
-</para></note>
+Get a reproducible random integer number out of a specified range,
+see g_test_rand_int() for details on test case random numbers.
+Since: 2.16
</description>
<parameters>
-<parameter name="working_directory">
-<parameter_description> child's current working directory, or %NULL to inherit parent's
-</parameter_description>
-</parameter>
-<parameter name="argv">
-<parameter_description> child's argument vector
-</parameter_description>
-</parameter>
-<parameter name="envp">
-<parameter_description> child's environment, or %NULL to inherit parent's
-</parameter_description>
-</parameter>
-<parameter name="flags">
-<parameter_description> flags from #GSpawnFlags
-</parameter_description>
-</parameter>
-<parameter name="child_setup">
-<parameter_description> function to run in the child just before exec()
-</parameter_description>
-</parameter>
-<parameter name="user_data">
-<parameter_description> user data for @child_setup
-</parameter_description>
-</parameter>
-<parameter name="child_pid">
-<parameter_description> return location for child process reference, or %NULL
+<parameter name="begin">
+<parameter_description> the minimum value returned by this function
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for error
+<parameter name="end">
+<parameter_description> the smallest value not to be returned by this function
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE on success, %FALSE if error is set
+<return> a number with @begin <= number < @end.
+
</return>
</function>
-<function name="g_spawn_async_with_pipes">
+<function name="g_test_run">
<description>
-Executes a child program asynchronously (your program will not
-block waiting for the child to exit). The child program is
-specified by the only argument that must be provided, @argv. @argv
-should be a %NULL-terminated array of strings, to be passed as the
-argument vector for the child. The first string in @argv is of
-course the name of the program to execute. By default, the name of
-the program must be a full path; the <envar>PATH</envar> shell variable
-will only be searched if you pass the %G_SPAWN_SEARCH_PATH flag.
-
-On Windows, note that all the string or string vector arguments to
-this function and the other g_spawn*() functions are in UTF-8, the
-GLib file name encoding. Unicode characters that are not part of
-the system codepage passed in these arguments will be correctly
-available in the spawned program only if it uses wide character API
-to retrieve its command line. For C programs built with Microsoft's
-tools it is enough to make the program have a wmain() instead of
-main(). wmain() has a wide character argument vector as parameter.
-
-At least currently, mingw doesn't support wmain(), so if you use
-mingw to develop the spawned program, it will have to call the
-undocumented function __wgetmainargs() to get the wide character
-argument vector and environment. See gspawn-win32-helper.c in the
-GLib sources or init.c in the mingw runtime sources for a prototype
-for that function. Alternatively, you can retrieve the Win32 system
-level wide character command line passed to the spawned program
-using the GetCommandLineW() function.
-
-On Windows the low-level child process creation API
-<function>CreateProcess()</function> doesn't use argument vectors,
-but a command line. The C runtime library's
-<function>spawn*()</function> family of functions (which
-g_spawn_async_with_pipes() eventually calls) paste the argument
-vector elements together into a command line, and the C runtime startup code
-does a corresponding reconstruction of an argument vector from the
-command line, to be passed to main(). Complications arise when you have
-argument vector elements that contain spaces of double quotes. The
-<function>spawn*()</function> functions don't do any quoting or
-escaping, but on the other hand the startup code does do unquoting
-and unescaping in order to enable receiving arguments with embedded
-spaces or double quotes. To work around this asymmetry,
-g_spawn_async_with_pipes() will do quoting and escaping on argument
-vector elements that need it before calling the C runtime
-spawn() function.
-
-The returned @child_pid on Windows is a handle to the child
-process, not its identifier. Process handles and process
-identifiers are different concepts on Windows.
-
- envp is a %NULL-terminated array of strings, where each string
-has the form <literal>KEY=VALUE</literal>. This will become
-the child's environment. If @envp is %NULL, the child inherits its
-parent's environment.
-
- flags should be the bitwise OR of any flags you want to affect the
-function's behaviour. The %G_SPAWN_DO_NOT_REAP_CHILD means that
-the child will not automatically be reaped; you must use a
-#GChildWatch source to be notified about the death of the child
-process. Eventually you must call g_spawn_close_pid() on the
- child_pid, in order to free resources which may be associated
-with the child process. (On Unix, using a #GChildWatch source is
-equivalent to calling waitpid() or handling the %SIGCHLD signal
-manually. On Windows, calling g_spawn_close_pid() is equivalent
-to calling CloseHandle() on the process handle returned in
- child_pid).
-
-%G_SPAWN_LEAVE_DESCRIPTORS_OPEN means that the parent's open file
-descriptors will be inherited by the child; otherwise all
-descriptors except stdin/stdout/stderr will be closed before
-calling exec() in the child. %G_SPAWN_SEARCH_PATH
-means that <literal>argv[0]</literal> need not be an absolute path, it
-will be looked for in the user's <envar>PATH</envar>.
-%G_SPAWN_STDOUT_TO_DEV_NULL means that the child's standard output will
-be discarded, instead of going to the same location as the parent's
-standard output. If you use this flag, @standard_output must be %NULL.
-%G_SPAWN_STDERR_TO_DEV_NULL means that the child's standard error
-will be discarded, instead of going to the same location as the parent's
-standard error. If you use this flag, @standard_error must be %NULL.
-%G_SPAWN_CHILD_INHERITS_STDIN means that the child will inherit the parent's
-standard input (by default, the child's standard input is attached to
-/dev/null). If you use this flag, @standard_input must be %NULL.
-%G_SPAWN_FILE_AND_ARGV_ZERO means that the first element of @argv is
-the file to execute, while the remaining elements are the
-actual argument vector to pass to the file. Normally
-g_spawn_async_with_pipes() uses @argv[0] as the file to execute, and
-passes all of @argv to the child.
-
- child_setup and @user_data are a function and user data. On POSIX
-platforms, the function is called in the child after GLib has
-performed all the setup it plans to perform (including creating
-pipes, closing file descriptors, etc.) but before calling
-exec(). That is, @child_setup is called just
-before calling exec() in the child. Obviously
-actions taken in this function will only affect the child, not the
-parent.
-
-On Windows, there is no separate fork() and exec()
-functionality. Child processes are created and run with a single
-API call, CreateProcess(). There is no sensible thing @child_setup
-could be used for on Windows so it is ignored and not called.
-
-If non-%NULL, @child_pid will on Unix be filled with the child's
-process ID. You can use the process ID to send signals to the
-child, or to use g_child_watch_add() (or waitpid()) if you specified the
-%G_SPAWN_DO_NOT_REAP_CHILD flag. On Windows, @child_pid will be
-filled with a handle to the child process only if you specified the
-%G_SPAWN_DO_NOT_REAP_CHILD flag. You can then access the child
-process using the Win32 API, for example wait for its termination
-with the <function>WaitFor*()</function> functions, or examine its
-exit code with GetExitCodeProcess(). You should close the handle
-with CloseHandle() or g_spawn_close_pid() when you no longer need it.
-
-If non-%NULL, the @standard_input, @standard_output, @standard_error
-locations will be filled with file descriptors for writing to the child's
-standard input or reading from its standard output or standard error.
-The caller of g_spawn_async_with_pipes() must close these file descriptors
-when they are no longer in use. If these parameters are %NULL, the corresponding
-pipe won't be created.
-
-If @standard_input is NULL, the child's standard input is attached to
-/dev/null unless %G_SPAWN_CHILD_INHERITS_STDIN is set.
-
-If @standard_error is NULL, the child's standard error goes to the same
-location as the parent's standard error unless %G_SPAWN_STDERR_TO_DEV_NULL
-is set.
-
-If @standard_output is NULL, the child's standard output goes to the same
-location as the parent's standard output unless %G_SPAWN_STDOUT_TO_DEV_NULL
-is set.
-
- error can be %NULL to ignore errors, or non-%NULL to report errors.
-If an error is set, the function returns %FALSE. Errors
-are reported even if they occur in the child (for example if the
-executable in <literal>argv[0]</literal> is not found). Typically
-the <literal>message</literal> field of returned errors should be displayed
-to users. Possible errors are those from the #G_SPAWN_ERROR domain.
+Runs all tests under the toplevel suite which can be retrieved
+with g_test_get_root(). Similar to g_test_run_suite(), the test
+cases to be run are filtered according to
+test path arguments (-p <replaceable>testpath</replaceable>) as
+parsed by g_test_init().
+g_test_run_suite() or g_test_run() may only be called once
+in a program.
-If an error occurs, @child_pid, @standard_input, @standard_output,
-and @standard_error will not be filled with valid values.
+Since: 2.16
-If @child_pid is not %NULL and an error does not occur then the returned
-process reference must be closed using g_spawn_close_pid().
+</description>
+<parameters>
+</parameters>
+<return> 0 on success
-<note><para>
-If you are writing a GTK+ application, and the program you
-are spawning is a graphical application, too, then you may
-want to use gdk_spawn_on_screen_with_pipes() instead to ensure that
-the spawned program opens its windows on the right screen.
-</para></note>
+</return>
+</function>
+
+<function name="g_test_run_suite">
+<description>
+Execute the tests within @suite and all nested #GTestSuites.
+The test suites to be executed are filtered according to
+test path arguments (-p <replaceable>testpath</replaceable>)
+as parsed by g_test_init().
+g_test_run_suite() or g_test_run() may only be called once
+in a program.
+Since: 2.16
</description>
<parameters>
-<parameter name="working_directory">
-<parameter_description> child's current working directory, or %NULL to inherit parent's, in the GLib file name encoding
-</parameter_description>
-</parameter>
-<parameter name="argv">
-<parameter_description> child's argument vector, in the GLib file name encoding
-</parameter_description>
-</parameter>
-<parameter name="envp">
-<parameter_description> child's environment, or %NULL to inherit parent's, in the GLib file name encoding
-</parameter_description>
-</parameter>
-<parameter name="flags">
-<parameter_description> flags from #GSpawnFlags
-</parameter_description>
-</parameter>
-<parameter name="child_setup">
-<parameter_description> function to run in the child just before exec()
-</parameter_description>
-</parameter>
-<parameter name="user_data">
-<parameter_description> user data for @child_setup
-</parameter_description>
-</parameter>
-<parameter name="child_pid">
-<parameter_description> return location for child process ID, or %NULL
+<parameter name="suite">
+<parameter_description> a #GTestSuite
</parameter_description>
</parameter>
-<parameter name="standard_input">
-<parameter_description> return location for file descriptor to write to child's stdin, or %NULL
+</parameters>
+<return> 0 on success
+
+</return>
+</function>
+
+<function name="g_test_suite_add">
+<description>
+Adds @test_case to @suite.
+
+Since: 2.16
+
+</description>
+<parameters>
+<parameter name="suite">
+<parameter_description> a #GTestSuite
</parameter_description>
</parameter>
-<parameter name="standard_output">
-<parameter_description> return location for file descriptor to read child's stdout, or %NULL
+<parameter name="test_case">
+<parameter_description> a #GTestCase
</parameter_description>
</parameter>
-<parameter name="standard_error">
-<parameter_description> return location for file descriptor to read child's stderr, or %NULL
+</parameters>
+<return></return>
+</function>
+
+<function name="g_test_suite_add_suite">
+<description>
+Adds @nestedsuite to @suite.
+
+Since: 2.16
+
+</description>
+<parameters>
+<parameter name="suite">
+<parameter_description> a #GTestSuite
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for error
+<parameter name="nestedsuite">
+<parameter_description> another #GTestSuite
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE on success, %FALSE if an error was set
+<return></return>
+</function>
+
+<function name="g_test_timer_elapsed">
+<description>
+Get the time since the last start of the timer with g_test_timer_start().
+
+Since: 2.16
+
+</description>
+<parameters>
+</parameters>
+<return> the time since the last start of the timer, as a double
+
</return>
</function>
-<function name="g_spawn_close_pid">
+<function name="g_test_timer_last">
<description>
-On some platforms, notably Windows, the #GPid type represents a resource
-which must be closed to prevent resource leaking. g_spawn_close_pid()
-is provided for this purpose. It should be used on all platforms, even
-though it doesn't do anything under UNIX.
+Report the last result of g_test_timer_elapsed().
+
+Since: 2.16
+
+</description>
+<parameters>
+</parameters>
+<return> the last result of g_test_timer_elapsed(), as a double
+
+</return>
+</function>
+
+<function name="g_test_timer_start">
+<description>
+Start a timing test. Call g_test_timer_elapsed() when the task is supposed
+to be done. Call this function again to restart the timer.
+
+Since: 2.16
</description>
<parameters>
-<parameter name="pid">
-<parameter_description> The process reference to close
-</parameter_description>
-</parameter>
</parameters>
<return></return>
</function>
-<function name="g_spawn_command_line_async">
+<function name="g_test_trap_fork">
<description>
-A simple version of g_spawn_async() that parses a command line with
-g_shell_parse_argv() and passes it to g_spawn_async(). Runs a
-command line in the background. Unlike g_spawn_async(), the
-%G_SPAWN_SEARCH_PATH flag is enabled, other flags are not. Note
-that %G_SPAWN_SEARCH_PATH can have security implications, so
-consider using g_spawn_async() directly if appropriate. Possible
-errors are those from g_shell_parse_argv() and g_spawn_async().
+Fork the current test program to execute a test case that might
+not return or that might abort. The forked test case is aborted
+and considered failing if its run time exceeds @usec_timeout.
-The same concerns on Windows apply as for g_spawn_command_line_sync().
+The forking behavior can be configured with the #GTestTrapFlags flags.
+
+In the following example, the test code forks, the forked child
+process produces some sample output and exits successfully.
+The forking parent process then asserts successful child program
+termination and validates child program outputs.
+
+|[
+static void
+test_fork_patterns (void)
+{
+if (g_test_trap_fork (0, G_TEST_TRAP_SILENCE_STDOUT | G_TEST_TRAP_SILENCE_STDERR))
+{
+g_print ("some stdout text: somagic17\n");
+g_printerr ("some stderr text: semagic43\n");
+exit (0); / * successful test run * /
+}
+g_test_trap_assert_passed();
+g_test_trap_assert_stdout ("*somagic17*");
+g_test_trap_assert_stderr ("*semagic43*");
+}
+]|
+
+This function is implemented only on Unix platforms.
+Since: 2.16
</description>
<parameters>
-<parameter name="command_line">
-<parameter_description> a command line
+<parameter name="usec_timeout">
+<parameter_description> Timeout for the forked test in micro seconds.
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for errors
+<parameter name="test_trap_flags">
+<parameter_description> Flags to modify forking behaviour.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE on success, %FALSE if error is set.
+<return> %TRUE for the forked child and %FALSE for the executing parent process.
+
</return>
</function>
-<function name="g_spawn_command_line_sync">
+<function name="g_test_trap_has_passed">
<description>
-A simple version of g_spawn_sync() with little-used parameters
-removed, taking a command line instead of an argument vector. See
-g_spawn_sync() for full details. @command_line will be parsed by
-g_shell_parse_argv(). Unlike g_spawn_sync(), the %G_SPAWN_SEARCH_PATH flag
-is enabled. Note that %G_SPAWN_SEARCH_PATH can have security
-implications, so consider using g_spawn_sync() directly if
-appropriate. Possible errors are those from g_spawn_sync() and those
-from g_shell_parse_argv().
+Check the result of the last g_test_trap_fork() call.
-If @exit_status is non-%NULL, the exit status of the child is stored there as
-it would be returned by waitpid(); standard UNIX macros such as WIFEXITED()
-and WEXITSTATUS() must be used to evaluate the exit status.
+Since: 2.16
-On Windows, please note the implications of g_shell_parse_argv()
-parsing @command_line. Parsing is done according to Unix shell rules, not
-Windows command interpreter rules.
-Space is a separator, and backslashes are
-special. Thus you cannot simply pass a @command_line containing
-canonical Windows paths, like "c:\\program files\\app\\app.exe", as
-the backslashes will be eaten, and the space will act as a
-separator. You need to enclose such paths with single quotes, like
-"'c:\\program files\\app\\app.exe' 'e:\\folder\\argument.txt'".
+</description>
+<parameters>
+</parameters>
+<return> %TRUE if the last forked child terminated successfully.
+
+</return>
+</function>
+<function name="g_test_trap_reached_timeout">
+<description>
+Check the result of the last g_test_trap_fork() call.
+
+Since: 2.16
</description>
<parameters>
-<parameter name="command_line">
-<parameter_description> a command line
-</parameter_description>
-</parameter>
-<parameter name="standard_output">
-<parameter_description> return location for child output
+</parameters>
+<return> %TRUE if the last forked child got killed due to a fork timeout.
+
+</return>
+</function>
+
+<function name="g_thread_create">
+<description>
+This function creates a new thread with the default priority.
+
+If @joinable is %TRUE, you can wait for this threads termination
+calling g_thread_join(). Otherwise the thread will just disappear
+when it terminates.
+
+The new thread executes the function @func with the argument @data.
+If the thread was created successfully, it is returned.
+
+ error can be %NULL to ignore errors, or non-%NULL to report errors.
+The error is set, if and only if the function returns %NULL.
+
+</description>
+<parameters>
+<parameter name="func">
+<parameter_description> a function to execute in the new thread.
</parameter_description>
</parameter>
-<parameter name="standard_error">
-<parameter_description> return location for child errors
+<parameter name="data">
+<parameter_description> an argument to supply to the new thread.
</parameter_description>
</parameter>
-<parameter name="exit_status">
-<parameter_description> return location for child exit status, as returned by waitpid()
+<parameter name="joinable">
+<parameter_description> should this thread be joinable?
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> return location for errors
+<parameter_description> return location for error.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE on success, %FALSE if an error was set
+<return> the new #GThread on success.
</return>
</function>
-<function name="g_spawn_sync">
+<function name="g_thread_create_full">
<description>
-Executes a child synchronously (waits for the child to exit before returning).
-All output from the child is stored in @standard_output and @standard_error,
-if those parameters are non-%NULL. Note that you must set the
-%G_SPAWN_STDOUT_TO_DEV_NULL and %G_SPAWN_STDERR_TO_DEV_NULL flags when
-passing %NULL for @standard_output and @standard_error.
-If @exit_status is non-%NULL, the exit status of the child is stored
-there as it would be returned by waitpid(); standard UNIX macros such
-as WIFEXITED() and WEXITSTATUS() must be used to evaluate the exit status.
-Note that this function call waitpid() even if @exit_status is %NULL, and
-does not accept the %G_SPAWN_DO_NOT_REAP_CHILD flag.
-If an error occurs, no data is returned in @standard_output,
- standard_error, or @exit_status.
+This function creates a new thread with the priority @priority. If
+the underlying thread implementation supports it, the thread gets a
+stack size of @stack_size or the default value for the current
+platform, if @stack_size is 0.
-This function calls g_spawn_async_with_pipes() internally; see that
-function for full details on the other parameters and details on
-how these functions work on Windows.
+If @joinable is %TRUE, you can wait for this threads termination
+calling g_thread_join(). Otherwise the thread will just disappear
+when it terminates. If @bound is %TRUE, this thread will be
+scheduled in the system scope, otherwise the implementation is free
+to do scheduling in the process scope. The first variant is more
+expensive resource-wise, but generally faster. On some systems (e.g.
+Linux) all threads are bound.
+
+The new thread executes the function @func with the argument @data.
+If the thread was created successfully, it is returned.
+
+ error can be %NULL to ignore errors, or non-%NULL to report errors.
+The error is set, if and only if the function returns %NULL.
+
+<note><para>It is not guaranteed that threads with different priorities
+really behave accordingly. On some systems (e.g. Linux) there are no
+thread priorities. On other systems (e.g. Solaris) there doesn't
+seem to be different scheduling for different priorities. All in all
+try to avoid being dependent on priorities. Use
+%G_THREAD_PRIORITY_NORMAL here as a default.</para></note>
+<note><para>Only use g_thread_create_full() if you really can't use
+g_thread_create() instead. g_thread_create() does not take
+ stack_size, @bound, and @priority as arguments, as they should only
+be used in cases in which it is unavoidable.</para></note>
</description>
<parameters>
-<parameter name="working_directory">
-<parameter_description> child's current working directory, or %NULL to inherit parent's
-</parameter_description>
-</parameter>
-<parameter name="argv">
-<parameter_description> child's argument vector
-</parameter_description>
-</parameter>
-<parameter name="envp">
-<parameter_description> child's environment, or %NULL to inherit parent's
-</parameter_description>
-</parameter>
-<parameter name="flags">
-<parameter_description> flags from #GSpawnFlags
+<parameter name="func">
+<parameter_description> a function to execute in the new thread.
</parameter_description>
</parameter>
-<parameter name="child_setup">
-<parameter_description> function to run in the child just before exec()
+<parameter name="data">
+<parameter_description> an argument to supply to the new thread.
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> user data for @child_setup
+<parameter name="stack_size">
+<parameter_description> a stack size for the new thread.
</parameter_description>
</parameter>
-<parameter name="standard_output">
-<parameter_description> return location for child output, or %NULL
+<parameter name="joinable">
+<parameter_description> should this thread be joinable?
</parameter_description>
</parameter>
-<parameter name="standard_error">
-<parameter_description> return location for child error messages, or %NULL
+<parameter name="bound">
+<parameter_description> should this thread be bound to a system thread?
</parameter_description>
</parameter>
-<parameter name="exit_status">
-<parameter_description> return location for child exit status, as returned by waitpid(), or %NULL
+<parameter name="priority">
+<parameter_description> a priority for the thread.
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> return location for error, or %NULL
+<parameter_description> return location for error.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE on success, %FALSE if an error was set.
+<return> the new #GThread on success.
</return>
</function>
-<function name="g_sprintf">
+<function name="g_thread_exit">
<description>
-An implementation of the standard sprintf() function which supports
-positional parameters, as specified in the Single Unix Specification.
+Exits the current thread. If another thread is waiting for that
+thread using g_thread_join() and the current thread is joinable, the
+waiting thread will be woken up and get @retval as the return value
+of g_thread_join(). If the current thread is not joinable, @retval
+is ignored. Calling
-Note that it is usually better to use g_snprintf(), to avoid the
-risk of buffer overflow.
+<informalexample>
+<programlisting>
+g_thread_exit (retval);
+</programlisting>
+</informalexample>
-See also g_strdup_printf().
+is equivalent to returning @retval from the function @func, as given
+to g_thread_create().
-Since: 2.2
+<note><para>Never call g_thread_exit() from within a thread of a
+#GThreadPool, as that will mess up the bookkeeping and lead to funny
+and unwanted results.</para></note>
</description>
<parameters>
-<parameter name="string">
-<parameter_description> A pointer to a memory buffer to contain the resulting string. It
-is up to the caller to ensure that the allocated buffer is large
-enough to hold the formatted result
-</parameter_description>
-</parameter>
-<parameter name="format">
-<parameter_description> a standard printf() format string, but notice
-<link linkend="string-precision">string precision pitfalls</link>.
-</parameter_description>
-</parameter>
-<parameter name="Varargs">
-<parameter_description> the arguments to insert in the output.
+<parameter name="retval">
+<parameter_description> the return value of this thread.
</parameter_description>
</parameter>
</parameters>
-<return> the number of bytes printed.
-
-</return>
+<return></return>
</function>
-<function name="g_stat">
+<function name="g_thread_foreach">
<description>
-A wrapper for the POSIX stat() function. The stat() function
-returns information about a file. On Windows the stat() function in
-the C library checks only the FAT-style READONLY attribute and does
-not look at the ACL at all. Thus on Windows the protection bits in
-the st_mode field are a fabrication of little use.
-
-On Windows the Microsoft C libraries have several variants of the
-<structname>stat</structname> struct and stat() function with names
-like "_stat", "_stat32", "_stat32i64" and "_stat64i32". The one
-used here is for 32-bit code the one with 32-bit size and time
-fields, specifically called "_stat32".
-
-In Microsoft's compiler, by default "struct stat" means one with
-64-bit time fields while in MinGW "struct stat" is the legacy one
-with 32-bit fields. To hopefully clear up this messs, the gstdio.h
-header defines a type GStatBuf which is the appropriate struct type
-depending on the platform and/or compiler being used. On POSIX it
-is just "struct stat", but note that even on POSIX platforms,
-"stat" might be a macro.
+Call @thread_func on all existing #GThread structures. Note that
+threads may decide to exit while @thread_func is running, so
+without intimate knowledge about the lifetime of foreign threads,
+ thread_func shouldn't access the GThread* pointer passed in as
+first argument. However, @thread_func will not be called for threads
+which are known to have exited already.
-See your C library manual for more details about stat().
+Due to thread lifetime checks, this function has an execution complexity
+which is quadratic in the number of existing threads.
-Since: 2.6
+Since: 2.10
</description>
<parameters>
-<parameter name="filename">
-<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows)
+<parameter name="thread_func">
+<parameter_description> function to call for all GThread structures
</parameter_description>
</parameter>
-<parameter name="buf">
-<parameter_description> a pointer to a <structname>stat</structname> struct, which
-will be filled with the file information
+<parameter name="user_data">
+<parameter_description> second argument to @thread_func
</parameter_description>
</parameter>
</parameters>
-<return> 0 if the information was successfully retrieved, -1 if an error
-occurred
-
-</return>
+<return></return>
</function>
-<function name="g_static_mutex_free">
+<function name="g_thread_get_initialized">
<description>
-Releases all resources allocated to @mutex.
-
-You don't have to call this functions for a #GStaticMutex with an
-unbounded lifetime, i.e. objects declared 'static', but if you have
-a #GStaticMutex as a member of a structure and the structure is
-freed, you should also free the #GStaticMutex.
+Indicates if g_thread_init() has been called.
-<note><para>Calling g_static_mutex_free() on a locked mutex may
-result in undefined behaviour.</para></note>
+Since: 2.20
</description>
<parameters>
-<parameter name="mutex">
-<parameter_description> a #GStaticMutex to be freed.
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> %TRUE if threads have been initialized.
+
+</return>
</function>
-<function name="g_static_mutex_get_mutex">
+<function name="g_thread_init">
<description>
-For some operations (like g_cond_wait()) you must have a #GMutex
-instead of a #GStaticMutex. This function will return the
-corresponding #GMutex for @mutex.
+If you use GLib from more than one thread, you must initialize the
+thread system by calling g_thread_init(). Most of the time you will
+only have to call <literal>g_thread_init (NULL)</literal>.
+
+<note><para>Do not call g_thread_init() with a non-%NULL parameter unless
+you really know what you are doing.</para></note>
+
+<note><para>g_thread_init() must not be called directly or indirectly as a
+callback from GLib. Also no mutexes may be currently locked while
+calling g_thread_init().</para></note>
+
+<note><para>g_thread_init() changes the way in which #GTimer measures
+elapsed time. As a consequence, timers that are running while
+g_thread_init() is called may report unreliable times.</para></note>
+
+Calling g_thread_init() multiple times is allowed (since version
+2.24), but nothing happens except for the first call. If the
+argument is non-%NULL on such a call a warning will be printed, but
+otherwise the argument is ignored.
+
+If no thread system is available and @vtable is %NULL or if not all
+elements of @vtable are non-%NULL, then g_thread_init() will abort.
+
+<note><para>To use g_thread_init() in your program, you have to link with
+the libraries that the command <command>pkg-config --libs
+gthread-2.0</command> outputs. This is not the case for all the
+other thread related functions of GLib. Those can be used without
+having to link with the thread libraries.</para></note>
</description>
<parameters>
-<parameter name="mutex">
-<parameter_description> a #GStaticMutex.
+<parameter name="vtable">
+<parameter_description> a function table of type #GThreadFunctions, that provides
+the entry points to the thread system to be used.
</parameter_description>
</parameter>
</parameters>
-<return> the #GMutex corresponding to @mutex.
-</return>
+<return></return>
</function>
-<function name="g_static_mutex_init">
+<function name="g_thread_join">
<description>
-Initializes @mutex. Alternatively you can initialize it with
-#G_STATIC_MUTEX_INIT.
+Waits until @thread finishes, i.e. the function @func, as given to
+g_thread_create(), returns or g_thread_exit() is called by @thread.
+All resources of @thread including the #GThread struct are released.
+ thread must have been created with @joinable=%TRUE in
+g_thread_create(). The value returned by @func or given to
+g_thread_exit() by @thread is returned by this function.
</description>
<parameters>
-<parameter name="mutex">
-<parameter_description> a #GStaticMutex to be initialized.
+<parameter name="thread">
+<parameter_description> a #GThread to be waited for.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the return value of the thread.
+</return>
</function>
-<function name="g_static_mutex_lock">
+<function name="g_thread_pool_free">
<description>
-Works like g_mutex_lock(), but for a #GStaticMutex.
+Frees all resources allocated for @pool.
+
+If @immediate is %TRUE, no new task is processed for
+ pool Otherwise @pool is not freed before the last task is
+processed. Note however, that no thread of this pool is
+interrupted, while processing a task. Instead at least all still
+running threads can finish their tasks before the @pool is freed.
+
+If @wait_ is %TRUE, the functions does not return before all tasks
+to be processed (dependent on @immediate, whether all or only the
+currently running) are ready. Otherwise the function returns immediately.
+
+After calling this function @pool must not be used anymore.
</description>
<parameters>
-<parameter name="mutex">
-<parameter_description> a #GStaticMutex.
+<parameter name="pool">
+<parameter_description> a #GThreadPool
+</parameter_description>
+</parameter>
+<parameter name="immediate">
+<parameter_description> should @pool shut down immediately?
+</parameter_description>
+</parameter>
+<parameter name="wait_">
+<parameter_description> should the function wait for all tasks to be finished?
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_static_mutex_trylock">
+<function name="g_thread_pool_get_max_idle_time">
<description>
-Works like g_mutex_trylock(), but for a #GStaticMutex.
+This function will return the maximum @interval that a thread will
+wait in the thread pool for new tasks before being stopped.
+
+If this function returns 0, threads waiting in the thread pool for
+new work are not stopped.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="mutex">
-<parameter_description> a #GStaticMutex.
-</parameter_description>
-</parameter>
</parameters>
-<return> %TRUE, if the #GStaticMutex could be locked.
+<return> the maximum @interval to wait for new tasks in the
+thread pool before stopping the thread (1/1000ths of a second).
+
</return>
</function>
-<function name="g_static_mutex_unlock">
+<function name="g_thread_pool_get_max_threads">
<description>
-Works like g_mutex_unlock(), but for a #GStaticMutex.
+Returns the maximal number of threads for @pool.
+
</description>
<parameters>
-<parameter name="mutex">
-<parameter_description> a #GStaticMutex.
+<parameter name="pool">
+<parameter_description> a #GThreadPool
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the maximal number of threads
+</return>
</function>
-<function name="g_static_private_free">
+<function name="g_thread_pool_get_max_unused_threads">
<description>
-Releases all resources allocated to @private_key.
+Returns the maximal allowed number of unused threads.
-You don't have to call this functions for a #GStaticPrivate with an
-unbounded lifetime, i.e. objects declared 'static', but if you have
-a #GStaticPrivate as a member of a structure and the structure is
-freed, you should also free the #GStaticPrivate.
</description>
<parameters>
-<parameter name="private_key">
-<parameter_description> a #GStaticPrivate to be freed.
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> the maximal number of unused threads
+</return>
</function>
-<function name="g_static_private_get">
+<function name="g_thread_pool_get_num_threads">
<description>
-Works like g_private_get() only for a #GStaticPrivate.
+Returns the number of threads currently running in @pool.
-This function works even if g_thread_init() has not yet been called.
</description>
<parameters>
-<parameter name="private_key">
-<parameter_description> a #GStaticPrivate.
+<parameter name="pool">
+<parameter_description> a #GThreadPool
</parameter_description>
</parameter>
</parameters>
-<return> the corresponding pointer.
+<return> the number of threads currently running
</return>
</function>
-<function name="g_static_private_init">
+<function name="g_thread_pool_get_num_unused_threads">
<description>
-Initializes @private_key. Alternatively you can initialize it with
-#G_STATIC_PRIVATE_INIT.
+Returns the number of currently unused threads.
+
</description>
<parameters>
-<parameter name="private_key">
-<parameter_description> a #GStaticPrivate to be initialized.
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> the number of currently unused threads
+</return>
</function>
-<function name="g_static_private_set">
+<function name="g_thread_pool_new">
<description>
-Sets the pointer keyed to @private_key for the current thread and
-the function @notify to be called with that pointer (%NULL or
-non-%NULL), whenever the pointer is set again or whenever the
-current thread ends.
+This function creates a new thread pool.
-This function works even if g_thread_init() has not yet been called.
-If g_thread_init() is called later, the @data keyed to @private_key
-will be inherited only by the main thread, i.e. the one that called
-g_thread_init().
+Whenever you call g_thread_pool_push(), either a new thread is
+created or an unused one is reused. At most @max_threads threads
+are running concurrently for this thread pool. @max_threads = -1
+allows unlimited threads to be created for this thread pool. The
+newly created or reused thread now executes the function @func with
+the two arguments. The first one is the parameter to
+g_thread_pool_push() and the second one is @user_data.
+
+The parameter @exclusive determines, whether the thread pool owns
+all threads exclusive or whether the threads are shared
+globally. If @exclusive is %TRUE, @max_threads threads are started
+immediately and they will run exclusively for this thread pool until
+it is destroyed by g_thread_pool_free(). If @exclusive is %FALSE,
+threads are created, when needed and shared between all
+non-exclusive thread pools. This implies that @max_threads may not
+be -1 for exclusive thread pools.
+
+ error can be %NULL to ignore errors, or non-%NULL to report
+errors. An error can only occur when @exclusive is set to %TRUE and
+not all @max_threads threads could be created.
-<note><para>@notify is used quite differently from @destructor in
-g_private_new().</para></note>
</description>
<parameters>
-<parameter name="private_key">
-<parameter_description> a #GStaticPrivate.
+<parameter name="func">
+<parameter_description> a function to execute in the threads of the new thread pool
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> the new pointer.
+<parameter name="user_data">
+<parameter_description> user data that is handed over to @func every time it
+is called
</parameter_description>
</parameter>
-<parameter name="notify">
-<parameter_description> a function to be called with the pointer whenever the
-current thread ends or sets this pointer again.
+<parameter name="max_threads">
+<parameter_description> the maximal number of threads to execute concurrently in
+the new thread pool, -1 means no limit
+</parameter_description>
+</parameter>
+<parameter name="exclusive">
+<parameter_description> should this thread pool be exclusive?
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for error
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the new #GThreadPool
+</return>
</function>
-<function name="g_static_rec_mutex_free">
+<function name="g_thread_pool_push">
<description>
-Releases all resources allocated to a #GStaticRecMutex.
+Inserts @data into the list of tasks to be executed by @pool. When
+the number of currently running threads is lower than the maximal
+allowed number of threads, a new thread is started (or reused) with
+the properties given to g_thread_pool_new (). Otherwise @data stays
+in the queue until a thread in this pool finishes its previous task
+and processes @data.
-You don't have to call this functions for a #GStaticRecMutex with an
-unbounded lifetime, i.e. objects declared 'static', but if you have
-a #GStaticRecMutex as a member of a structure and the structure is
-freed, you should also free the #GStaticRecMutex.
+ error can be %NULL to ignore errors, or non-%NULL to report
+errors. An error can only occur when a new thread couldn't be
+created. In that case @data is simply appended to the queue of work
+to do.
</description>
<parameters>
-<parameter name="mutex">
-<parameter_description> a #GStaticRecMutex to be freed.
+<parameter name="pool">
+<parameter_description> a #GThreadPool
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="g_static_rec_mutex_init">
-<description>
-A #GStaticRecMutex must be initialized with this function before it
-can be used. Alternatively you can initialize it with
-#G_STATIC_REC_MUTEX_INIT.
-
-</description>
-<parameters>
-<parameter name="mutex">
-<parameter_description> a #GStaticRecMutex to be initialized.
+<parameter name="data">
+<parameter_description> a new task for @pool
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for error
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_static_rec_mutex_lock">
+<function name="g_thread_pool_set_max_idle_time">
<description>
-Locks @mutex. If @mutex is already locked by another thread, the
-current thread will block until @mutex is unlocked by the other
-thread. If @mutex is already locked by the calling thread, this
-functions increases the depth of @mutex and returns immediately.
+This function will set the maximum @interval that a thread waiting
+in the pool for new tasks can be idle for before being
+stopped. This function is similar to calling
+g_thread_pool_stop_unused_threads() on a regular timeout, except,
+this is done on a per thread basis.
+
+By setting @interval to 0, idle threads will not be stopped.
+
+This function makes use of g_async_queue_timed_pop () using
+ interval
+
+Since: 2.10
</description>
<parameters>
-<parameter name="mutex">
-<parameter_description> a #GStaticRecMutex to lock.
+<parameter name="interval">
+<parameter_description> the maximum @interval (1/1000ths of a second) a thread
+can be idle.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_static_rec_mutex_lock_full">
+<function name="g_thread_pool_set_max_threads">
<description>
-Works like calling g_static_rec_mutex_lock() for @mutex @depth times.
+Sets the maximal allowed number of threads for @pool. A value of -1
+means, that the maximal number of threads is unlimited.
+
+Setting @max_threads to 0 means stopping all work for @pool. It is
+effectively frozen until @max_threads is set to a non-zero value
+again.
+
+A thread is never terminated while calling @func, as supplied by
+g_thread_pool_new (). Instead the maximal number of threads only
+has effect for the allocation of new threads in g_thread_pool_push().
+A new thread is allocated, whenever the number of currently
+running threads in @pool is smaller than the maximal number.
+
+ error can be %NULL to ignore errors, or non-%NULL to report
+errors. An error can only occur when a new thread couldn't be
+created.
</description>
<parameters>
-<parameter name="mutex">
-<parameter_description> a #GStaticRecMutex to lock.
+<parameter name="pool">
+<parameter_description> a #GThreadPool
</parameter_description>
</parameter>
-<parameter name="depth">
-<parameter_description> number of times this mutex has to be unlocked to be
-completely unlocked.
+<parameter name="max_threads">
+<parameter_description> a new maximal number of threads for @pool
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="g_static_rec_mutex_trylock">
-<description>
-Tries to lock @mutex. If @mutex is already locked by another thread,
-it immediately returns %FALSE. Otherwise it locks @mutex and returns
-%TRUE. If @mutex is already locked by the calling thread, this
-functions increases the depth of @mutex and immediately returns
-%TRUE.
-
-</description>
-<parameters>
-<parameter name="mutex">
-<parameter_description> a #GStaticRecMutex to lock.
+<parameter name="error">
+<parameter_description> return location for error
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE, if @mutex could be locked.
-</return>
+<return></return>
</function>
-<function name="g_static_rec_mutex_unlock">
+<function name="g_thread_pool_set_max_unused_threads">
<description>
-Unlocks @mutex. Another thread will be allowed to lock @mutex only
-when it has been unlocked as many times as it had been locked
-before. If @mutex is completely unlocked and another thread is
-blocked in a g_static_rec_mutex_lock() call for @mutex, it will be
-woken and can lock @mutex itself.
+Sets the maximal number of unused threads to @max_threads. If
+ max_threads is -1, no limit is imposed on the number of unused
+threads.
</description>
<parameters>
-<parameter name="mutex">
-<parameter_description> a #GStaticRecMutex to unlock.
+<parameter name="max_threads">
+<parameter_description> maximal number of unused threads
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_static_rec_mutex_unlock_full">
+<function name="g_thread_pool_set_sort_function">
<description>
-Completely unlocks @mutex. If another thread is blocked in a
-g_static_rec_mutex_lock() call for @mutex, it will be woken and can
-lock @mutex itself. This function returns the number of times that
- mutex has been locked by the current thread. To restore the state
-before the call to g_static_rec_mutex_unlock_full() you can call
-g_static_rec_mutex_lock_full() with the depth returned by this
-function.
-
-</description>
-<parameters>
-<parameter name="mutex">
-<parameter_description> a #GStaticRecMutex to completely unlock.
-</parameter_description>
-</parameter>
-</parameters>
-<return> number of times @mutex has been locked by the current
-thread.
-</return>
-</function>
+Sets the function used to sort the list of tasks. This allows the
+tasks to be processed by a priority determined by @func, and not
+just in the order in which they were added to the pool.
-<function name="g_static_rw_lock_free">
-<description>
-Releases all resources allocated to @lock.
+Note, if the maximum number of threads is more than 1, the order
+that threads are executed cannot be guranteed 100%. Threads are
+scheduled by the operating system and are executed at random. It
+cannot be assumed that threads are executed in the order they are
+created.
-You don't have to call this functions for a #GStaticRWLock with an
-unbounded lifetime, i.e. objects declared 'static', but if you have
-a #GStaticRWLock as a member of a structure, and the structure is
-freed, you should also free the #GStaticRWLock.
+Since: 2.10
</description>
<parameters>
-<parameter name="lock">
-<parameter_description> a #GStaticRWLock to be freed.
+<parameter name="pool">
+<parameter_description> a #GThreadPool
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> the #GCompareDataFunc used to sort the list of tasks.
+This function is passed two tasks. It should return
+0 if the order in which they are handled does not matter,
+a negative value if the first task should be processed before
+the second or a positive value if the second task should be
+processed first.
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> user data passed to @func.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_static_rw_lock_init">
+<function name="g_thread_pool_stop_unused_threads">
<description>
-A #GStaticRWLock must be initialized with this function before it
-can be used. Alternatively you can initialize it with
-#G_STATIC_RW_LOCK_INIT.
+Stops all currently unused threads. This does not change the
+maximal number of unused threads. This function can be used to
+regularly stop all unused threads e.g. from g_timeout_add().
</description>
<parameters>
-<parameter name="lock">
-<parameter_description> a #GStaticRWLock to be initialized.
-</parameter_description>
-</parameter>
</parameters>
<return></return>
</function>
-<function name="g_static_rw_lock_reader_lock">
+<function name="g_thread_pool_unprocessed">
<description>
-Locks @lock for reading. There may be unlimited concurrent locks for
-reading of a #GStaticRWLock at the same time. If @lock is already
-locked for writing by another thread or if another thread is already
-waiting to lock @lock for writing, this function will block until
- lock is unlocked by the other writing thread and no other writing
-threads want to lock @lock. This lock has to be unlocked by
-g_static_rw_lock_reader_unlock().
+Returns the number of tasks still unprocessed in @pool.
-#GStaticRWLock is not recursive. It might seem to be possible to
-recursively lock for reading, but that can result in a deadlock, due
-to writer preference.
</description>
<parameters>
-<parameter name="lock">
-<parameter_description> a #GStaticRWLock to lock for reading.
+<parameter name="pool">
+<parameter_description> a #GThreadPool
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the number of unprocessed tasks
+</return>
</function>
-<function name="g_static_rw_lock_reader_trylock">
+<function name="g_thread_self">
<description>
-Tries to lock @lock for reading. If @lock is already locked for
-writing by another thread or if another thread is already waiting to
-lock @lock for writing, immediately returns %FALSE. Otherwise locks
- lock for reading and returns %TRUE. This lock has to be unlocked by
-g_static_rw_lock_reader_unlock().
+This functions returns the #GThread corresponding to the calling
+thread.
</description>
<parameters>
-<parameter name="lock">
-<parameter_description> a #GStaticRWLock to lock for reading.
-</parameter_description>
-</parameter>
</parameters>
-<return> %TRUE, if @lock could be locked for reading.
+<return> the current thread.
</return>
</function>
-<function name="g_static_rw_lock_reader_unlock">
+<function name="g_thread_set_priority">
<description>
-Unlocks @lock. If a thread waits to lock @lock for writing and all
-locks for reading have been unlocked, the waiting thread is woken up
-and can lock @lock for writing.
+Changes the priority of @thread to @priority.
+
+<note><para>It is not guaranteed that threads with different
+priorities really behave accordingly. On some systems (e.g. Linux)
+there are no thread priorities. On other systems (e.g. Solaris) there
+doesn't seem to be different scheduling for different priorities. All
+in all try to avoid being dependent on priorities.</para></note>
</description>
<parameters>
-<parameter name="lock">
-<parameter_description> a #GStaticRWLock to unlock after reading.
+<parameter name="thread">
+<parameter_description> a #GThread.
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="g_static_rw_lock_writer_lock">
-<description>
-Locks @lock for writing. If @lock is already locked for writing or
-reading by other threads, this function will block until @lock is
-completely unlocked and then lock @lock for writing. While this
-functions waits to lock @lock, no other thread can lock @lock for
-reading. When @lock is locked for writing, no other thread can lock
- lock (neither for reading nor writing). This lock has to be
-unlocked by g_static_rw_lock_writer_unlock().
-
-</description>
-<parameters>
-<parameter name="lock">
-<parameter_description> a #GStaticRWLock to lock for writing.
+<parameter name="priority">
+<parameter_description> a new priority for @thread.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_static_rw_lock_writer_trylock">
+<function name="g_thread_supported">
<description>
-Tries to lock @lock for writing. If @lock is already locked (for
-either reading or writing) by another thread, it immediately returns
-%FALSE. Otherwise it locks @lock for writing and returns %TRUE. This
-lock has to be unlocked by g_static_rw_lock_writer_unlock().
-
-</description>
-<parameters>
-<parameter name="lock">
-<parameter_description> a #GStaticRWLock to lock for writing.
-</parameter_description>
-</parameter>
-</parameters>
-<return> %TRUE, if @lock could be locked for writing.
-</return>
-</function>
+This function returns %TRUE if the thread system is initialized, and
+%FALSE if it is not.
-<function name="g_static_rw_lock_writer_unlock">
-<description>
-Unlocks @lock. If a thread is waiting to lock @lock for writing and
-all locks for reading have been unlocked, the waiting thread is
-woken up and can lock @lock for writing. If no thread is waiting to
-lock @lock for writing, and some thread or threads are waiting to
-lock @lock for reading, the waiting threads are woken up and can
-lock @lock for reading.
+<note><para>This function is actually a macro. Apart from taking the
+address of it you can however use it as if it was a
+function.</para></note>
</description>
<parameters>
-<parameter name="lock">
-<parameter_description> a #GStaticRWLock to unlock after writing.
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> %TRUE, if the thread system is initialized.
+</return>
</function>
-<function name="g_stpcpy">
+<function name="g_thread_yield">
<description>
-Copies a nul-terminated string into the dest buffer, include the
-trailing nul, and return a pointer to the trailing nul byte.
-This is useful for concatenating multiple strings together
-without having to repeatedly scan for the end.
+Gives way to other threads waiting to be scheduled.
+This function is often used as a method to make busy wait less evil.
+But in most cases you will encounter, there are better methods to do
+that. So in general you shouldn't use this function.
</description>
<parameters>
-<parameter name="dest">
-<parameter_description> destination buffer.
-</parameter_description>
-</parameter>
-<parameter name="src">
-<parameter_description> source string.
-</parameter_description>
-</parameter>
</parameters>
-<return> a pointer to trailing nul byte.
-</return>
+<return></return>
</function>
-<function name="g_str_equal">
+<function name="g_time_val_add">
<description>
-Compares two strings for byte-by-byte equality and returns %TRUE
-if they are equal. It can be passed to g_hash_table_new() as the
- key_equal_func parameter, when using strings as keys in a #GHashTable.
-
-Note that this function is primarily meant as a hash table comparison
-function. For a general-purpose, %NULL-safe string comparison function,
-see g_strcmp0().
-
+Adds the given number of microseconds to @time_. @microseconds can
+also be negative to decrease the value of @time_.
</description>
<parameters>
-<parameter name="v1">
-<parameter_description> a key
+<parameter name="time_">
+<parameter_description> a #GTimeVal
</parameter_description>
</parameter>
-<parameter name="v2">
-<parameter_description> a key to compare with @v1
+<parameter name="microseconds">
+<parameter_description> number of microseconds to add to @time
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the two keys match
-</return>
+<return></return>
</function>
-<function name="g_str_has_prefix">
+<function name="g_time_val_from_iso8601">
<description>
-Looks whether the string @str begins with @prefix.
+Converts a string containing an ISO 8601 encoded date and time
+to a #GTimeVal and puts it into @time_.
-Since: 2.2
+Since: 2.12
</description>
<parameters>
-<parameter name="str">
-<parameter_description> a nul-terminated string.
+<parameter name="iso_date">
+<parameter_description> an ISO 8601 encoded date string
</parameter_description>
</parameter>
-<parameter name="prefix">
-<parameter_description> the nul-terminated prefix to look for.
+<parameter name="time_">
+<parameter_description> a #GTimeVal
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @str begins with @prefix, %FALSE otherwise.
+<return> %TRUE if the conversion was successful.
</return>
</function>
-<function name="g_str_has_suffix">
+<function name="g_time_val_to_iso8601">
<description>
-Looks whether the string @str ends with @suffix.
+Converts @time_ into an ISO 8601 encoded string, relative to the
+Coordinated Universal Time (UTC).
-Since: 2.2
+Since: 2.12
</description>
<parameters>
-<parameter name="str">
-<parameter_description> a nul-terminated string.
-</parameter_description>
-</parameter>
-<parameter name="suffix">
-<parameter_description> the nul-terminated suffix to look for.
+<parameter name="time_">
+<parameter_description> a #GTimeVal
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @str end with @suffix, %FALSE otherwise.
+<return> a newly allocated string containing an ISO 8601 date
</return>
</function>
-<function name="g_str_hash">
+<function name="g_time_zone_adjust_time">
<description>
-Converts a string to a hash value.
+Finds an interval within @tz that corresponds to the given @time_,
+possibly adjusting @time_ if required to fit into an interval.
+The meaning of @time_ depends on @type.
-This function implements the widely used "djb" hash apparently posted
-by Daniel Bernstein to comp.lang.c some time ago. The 32 bit
-unsigned hash value starts at 5381 and for each byte 'c' in the
-string, is updated: <literal>hash = hash * 33 + c</literal>. This
-function uses the signed value of each byte.
+This function is similar to g_time_zone_find_interval(), with the
+difference that it always succeeds (by making the adjustments
+described below).
-It can be passed to g_hash_table_new() as the @hash_func parameter,
-when using strings as keys in a #GHashTable.
+In any of the cases where g_time_zone_find_interval() succeeds then
+this function returns the same value, without modifying @time_.
+
+This function may, however, modify @time_ in order to deal with
+non-existent times. If the non-existent local @time_ of 02:30 were
+requested on March 13th 2010 in Toronto then this function would
+adjust @time_ to be 03:00 and return the interval containing the
+adjusted time.
+Since: 2.26
</description>
<parameters>
-<parameter name="v">
-<parameter_description> a string key
+<parameter name="tz">
+<parameter_description> a #GTimeZone
+</parameter_description>
+</parameter>
+<parameter name="type">
+<parameter_description> the #GTimeType of @time_
+</parameter_description>
+</parameter>
+<parameter name="time_">
+<parameter_description> a pointer to a number of seconds since January 1, 1970
</parameter_description>
</parameter>
</parameters>
-<return> a hash value corresponding to the key
+<return> the interval containing @time_, never -1
+
</return>
</function>
-<function name="g_strcasecmp">
+<function name="g_time_zone_find_interval">
<description>
-A case-insensitive string comparison, corresponding to the standard
-strcasecmp() function on platforms which support it.
+Finds an the interval within @tz that corresponds to the given @time_.
+The meaning of @time_ depends on @type.
-Deprecated:2.2: See g_strncasecmp() for a discussion of why this function
-is deprecated and how to replace it.
+If @type is %G_TIME_TYPE_UNIVERSAL then this function will always
+succeed (since universal time is monotonic and continuous).
+
+Otherwise @time_ is treated is local time. The distinction between
+%G_TIME_TYPE_STANDARD and %G_TIME_TYPE_DAYLIGHT is ignored except in
+the case that the given @time_ is ambiguous. In Toronto, for example,
+01:30 on November 7th 2010 occured twice (once inside of daylight
+savings time and the next, an hour later, outside of daylight savings
+time). In this case, the different value of @type would result in a
+different interval being returned.
+
+It is still possible for this function to fail. In Toronto, for
+example, 02:00 on March 14th 2010 does not exist (due to the leap
+forward to begin daylight savings time). -1 is returned in that
+case.
+
+Since: 2.26
</description>
<parameters>
-<parameter name="s1">
-<parameter_description> a string.
+<parameter name="tz">
+<parameter_description> a #GTimeZone
</parameter_description>
</parameter>
-<parameter name="s2">
-<parameter_description> a string to compare with @s1.
+<parameter name="type">
+<parameter_description> the #GTimeType of @time_
+</parameter_description>
+</parameter>
+<parameter name="time_">
+<parameter_description> a number of seconds since January 1, 1970
</parameter_description>
</parameter>
</parameters>
-<return> 0 if the strings match, a negative value if @s1 < @s2,
-or a positive value if @s1 > @s2.
+<return> the interval containing @time_, or -1 in case of failure
</return>
</function>
-<function name="g_strcmp0">
+<function name="g_time_zone_get_abbreviation">
<description>
-Compares @str1 and @str2 like strcmp(). Handles %NULL
-gracefully by sorting it before non-%NULL strings.
-Comparing two %NULL pointers returns 0.
+Determines the time zone abbreviation to be used during a particular
+ interval of time in the time zone @tz.
-Since: 2.16
+For example, in Toronto this is currently "EST" during the winter
+months and "EDT" during the summer months when daylight savings time
+is in effect.
+
+Since: 2.26
</description>
<parameters>
-<parameter name="str1">
-<parameter_description> a C string or %NULL
+<parameter name="tz">
+<parameter_description> a #GTimeZone
</parameter_description>
</parameter>
-<parameter name="str2">
-<parameter_description> another C string or %NULL
+<parameter name="interval">
+<parameter_description> an interval within the timezone
</parameter_description>
</parameter>
</parameters>
-<return> -1, 0 or 1, if @str1 is <, == or > than @str2.
+<return> the time zone abbreviation, which belongs to @tz
</return>
</function>
-<function name="g_strconcat">
+<function name="g_time_zone_get_offset">
<description>
-Concatenates all of the given strings into one long string.
-The returned string should be freed with g_free() when no longer needed.
-
-Note that this function is usually not the right function to use to
-assemble a translated message from pieces, since proper translation
-often requires the pieces to be reordered.
+Determines the offset to UTC in effect during a particular @interval
+of time in the time zone @tz.
-<warning><para>The variable argument list <emphasis>must</emphasis> end
-with %NULL. If you forget the %NULL, g_strconcat() will start appending
-random memory junk to your string.</para></warning>
+The offset is the number of seconds that you add to UTC time to
+arrive at local time for @tz (ie: negative numbers for time zones
+west of GMT, positive numbers for east).
+Since: 2.26
</description>
<parameters>
-<parameter name="string1">
-<parameter_description> the first string to add, which must not be %NULL
+<parameter name="tz">
+<parameter_description> a #GTimeZone
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> a %NULL-terminated list of strings to append to the string
+<parameter name="interval">
+<parameter_description> an interval within the timezone
</parameter_description>
</parameter>
</parameters>
-<return> a newly-allocated string containing all the string arguments
+<return> the number of seconds that should be added to UTC to get the
+local time in @tz
+
</return>
</function>
-<function name="g_strdown">
+<function name="g_time_zone_is_dst">
<description>
-Converts a string to lower case.
+Determines if daylight savings time is in effect during a particular
+ interval of time in the time zone @tz.
-Deprecated:2.2: This function is totally broken for the reasons discussed
-in the g_strncasecmp() docs - use g_ascii_strdown() or g_utf8_strdown()
-instead.
+Since: 2.26
</description>
<parameters>
-<parameter name="string">
-<parameter_description> the string to convert.
+<parameter name="tz">
+<parameter_description> a #GTimeZone
+</parameter_description>
+</parameter>
+<parameter name="interval">
+<parameter_description> an interval within the timezone
</parameter_description>
</parameter>
</parameters>
-<return> the string
+<return> %TRUE if daylight savings time is in effect
</return>
</function>
-<function name="g_strdup">
+<function name="g_time_zone_new">
<description>
-Duplicates a string. If @str is %NULL it returns %NULL.
-The returned string should be freed with g_free()
-when no longer needed.
+Creates a #GTimeZone corresponding to @identifier.
+
+ identifier can either be an RFC3339/ISO 8601 time offset or
+something that would pass as a valid value for the
+<varname>TZ</varname> environment variable (including %NULL).
+
+Valid RFC3339 time offsets are <literal>"Z"</literal> (for UTC) or
+<literal>"Âhh:mm"</literal>. ISO 8601 additionally specifies
+<literal>"Âhhmm"</literal> and <literal>"Âhh"</literal>.
+
+The <varname>TZ</varname> environment variable typically corresponds
+to the name of a file in the zoneinfo database, but there are many
+other possibilities. Note that those other possibilities are not
+currently implemented, but are planned.
+
+g_time_zone_new_local() calls this function with the value of the
+<varname>TZ</varname> environment variable. This function itself is
+independent of the value of <varname>TZ</varname>, but if @identifier
+is %NULL then <filename>/etc/localtime</filename> will be consulted
+to discover the correct timezone.
+
+See <ulink
+url='http://tools.ietf.org/html/rfc3339#section-5.6'>RFC3339
+Â5.6</ulink> for a precise definition of valid RFC3339 time offsets
+(the <varname>time-offset</varname> expansion) and ISO 8601 for the
+full list of valid time offsets. See <ulink
+url='http://www.gnu.org/s/libc/manual/html_node/TZ-Variable.html'>The
+GNU C Library manual</ulink> for an explanation of the possible
+values of the <varname>TZ</varname> environment variable.
+
+You should release the return value by calling g_time_zone_unref()
+when you are done with it.
+Since: 2.26
</description>
<parameters>
-<parameter name="str">
-<parameter_description> the string to duplicate
+<parameter name="identifier">
+<parameter_description> a timezone identifier
</parameter_description>
</parameter>
</parameters>
-<return> a newly-allocated copy of @str
+<return> the requested timezone
+
</return>
</function>
-<function name="g_strdup_printf">
+<function name="g_time_zone_new_local">
<description>
-Similar to the standard C sprintf() function but safer, since it
-calculates the maximum space required and allocates memory to hold
-the result. The returned string should be freed with g_free() when no
-longer needed.
+Creates a #GTimeZone corresponding to local time.
+
+This is equivalent to calling g_time_zone_new() with the value of the
+<varname>TZ</varname> environment variable (including the possibility
+of %NULL). Changes made to <varname>TZ</varname> after the first
+call to this function may or may not be noticed by future calls.
+
+You should release the return value by calling g_time_zone_unref()
+when you are done with it.
+Since: 2.26
</description>
<parameters>
-<parameter name="format">
-<parameter_description> a standard printf() format string, but notice
-<link linkend="string-precision">string precision pitfalls</link>
-</parameter_description>
-</parameter>
-<parameter name="Varargs">
-<parameter_description> the parameters to insert into the format string
-</parameter_description>
-</parameter>
</parameters>
-<return> a newly-allocated string holding the result
+<return> the local timezone
+
</return>
</function>
-<function name="g_strdup_vprintf">
+<function name="g_time_zone_new_utc">
<description>
-Similar to the standard C vsprintf() function but safer, since it
-calculates the maximum space required and allocates memory to hold
-the result. The returned string should be freed with g_free() when
-no longer needed.
+Creates a #GTimeZone corresponding to UTC.
-See also g_vasprintf(), which offers the same functionality, but
-additionally returns the length of the allocated string.
+This is equivalent to calling g_time_zone_new() with a value like
+"Z", "UTC", "+00", etc.
+You should release the return value by calling g_time_zone_unref()
+when you are done with it.
+
+Since: 2.26
</description>
<parameters>
-<parameter name="format">
-<parameter_description> a standard printf() format string, but notice
-<link linkend="string-precision">string precision pitfalls</link>
-</parameter_description>
-</parameter>
-<parameter name="args">
-<parameter_description> the list of parameters to insert into the format string
-</parameter_description>
-</parameter>
</parameters>
-<return> a newly-allocated string holding the result
+<return> the universal timezone
+
</return>
</function>
-<function name="g_strdupv">
+<function name="g_time_zone_ref">
<description>
-Copies %NULL-terminated array of strings. The copy is a deep copy;
-the new array should be freed by first freeing each string, then
-the array itself. g_strfreev() does this for you. If called
-on a %NULL value, g_strdupv() simply returns %NULL.
+Increases the reference count on @tz.
+Since: 2.26
</description>
<parameters>
-<parameter name="str_array">
-<parameter_description> %NULL-terminated array of strings.
+<parameter name="tz">
+<parameter_description> a #GTimeZone
</parameter_description>
</parameter>
</parameters>
-<return> a new %NULL-terminated array of strings.
+<return> a new reference to @tz.
+
</return>
</function>
-<function name="g_strerror">
+<function name="g_time_zone_refresh_local">
<description>
-Returns a string corresponding to the given error code, e.g.
-"no such process". You should use this function in preference to
-strerror(), because it returns a string in UTF-8 encoding, and since
-not all platforms support the strerror() function.
+Notifies #GTimeZone that the local timezone may have changed.
+In response, #GTimeZone will drop its cache of the local time zone.
+No existing #GTimeZone will be modified and no #GDateTime will change
+its timezone but future calls to g_time_zone_new_local() will start
+returning the new timezone.
+
+#GTimeZone does no monitoring of the local timezone on its own, which
+is why you have to call this function to notify it of the change.
+
+If you use #GTimeZoneMonitor to watch for changes then this function
+will automatically be called for you.
</description>
<parameters>
-<parameter name="errnum">
-<parameter_description> the system error number. See the standard C %errno
-documentation
-</parameter_description>
-</parameter>
</parameters>
-<return> a UTF-8 string describing the error code. If the error code
-is unknown, it returns "unknown error (<code>)". The string
-can only be used until the next call to g_strerror()
-</return>
+<return></return>
</function>
-<function name="g_strfreev">
+<function name="g_time_zone_unref">
<description>
-Frees a %NULL-terminated array of strings, and the array itself.
-If called on a %NULL value, g_strfreev() simply returns.
+Decreases the reference count on @tz.
+
+Since: 2.26
</description>
<parameters>
-<parameter name="str_array">
-<parameter_description> a %NULL-terminated array of strings to free.
+<parameter name="tz">
+<parameter_description> a #GTimeZone
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_string_append">
+<function name="g_timeout_add">
<description>
-Adds a string onto the end of a #GString, expanding
-it if necessary.
+Sets a function to be called at regular intervals, with the default
+priority, #G_PRIORITY_DEFAULT. The function is called repeatedly
+until it returns %FALSE, at which point the timeout is automatically
+destroyed and the function will not be called again. The first call
+to the function will be at the end of the first @interval.
+
+Note that timeout functions may be delayed, due to the processing of other
+event sources. Thus they should not be relied on for precise timing.
+After each call to the timeout function, the time of the next
+timeout is recalculated based on the current time and the given interval
+(it does not try to 'catch up' time lost in delays).
+
+If you want to have a timer in the "seconds" range and do not care
+about the exact time of the first call of the timer, use the
+g_timeout_add_seconds() function; this function allows for more
+optimizations and more efficient system power usage.
+
+This internally creates a main loop source using g_timeout_source_new()
+and attaches it to the main loop context using g_source_attach(). You can
+do these steps manually if you need greater control.
</description>
<parameters>
-<parameter name="string">
-<parameter_description> a #GString
+<parameter name="interval">
+<parameter_description> the time between calls to the function, in milliseconds
+(1/1000ths of a second)
</parameter_description>
</parameter>
-<parameter name="val">
-<parameter_description> the string to append onto the end of @string
+<parameter name="function">
+<parameter_description> function to call
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> data to pass to @function
</parameter_description>
</parameter>
</parameters>
-<return> @string
+<return> the ID (greater than 0) of the event source.
</return>
</function>
-<function name="g_string_append_c">
+<function name="g_timeout_add_full">
<description>
-Adds a byte onto the end of a #GString, expanding
-it if necessary.
+Sets a function to be called at regular intervals, with the given
+priority. The function is called repeatedly until it returns
+%FALSE, at which point the timeout is automatically destroyed and
+the function will not be called again. The @notify function is
+called when the timeout is destroyed. The first call to the
+function will be at the end of the first @interval.
+
+Note that timeout functions may be delayed, due to the processing of other
+event sources. Thus they should not be relied on for precise timing.
+After each call to the timeout function, the time of the next
+timeout is recalculated based on the current time and the given interval
+(it does not try to 'catch up' time lost in delays).
+
+This internally creates a main loop source using g_timeout_source_new()
+and attaches it to the main loop context using g_source_attach(). You can
+do these steps manually if you need greater control.
</description>
<parameters>
-<parameter name="string">
-<parameter_description> a #GString
+<parameter name="priority">
+<parameter_description> the priority of the timeout source. Typically this will be in
+the range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH.
</parameter_description>
</parameter>
-<parameter name="c">
-<parameter_description> the byte to append onto the end of @string
+<parameter name="interval">
+<parameter_description> the time between calls to the function, in milliseconds
+(1/1000ths of a second)
+</parameter_description>
+</parameter>
+<parameter name="function">
+<parameter_description> function to call
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> data to pass to @function
+</parameter_description>
+</parameter>
+<parameter name="notify">
+<parameter_description> function to call when the timeout is removed, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> @string
+<return> the ID (greater than 0) of the event source.
</return>
</function>
-<function name="g_string_append_len">
+<function name="g_timeout_add_seconds">
<description>
-Appends @len bytes of @val to @string. Because @len is
-provided, @val may contain embedded nuls and need not
-be nul-terminated.
+Sets a function to be called at regular intervals with the default
+priority, #G_PRIORITY_DEFAULT. The function is called repeatedly until
+it returns %FALSE, at which point the timeout is automatically destroyed
+and the function will not be called again.
-Since this function does not stop at nul bytes, it is
-the caller's responsibility to ensure that @val has at
-least @len addressable bytes.
+This internally creates a main loop source using
+g_timeout_source_new_seconds() and attaches it to the main loop context
+using g_source_attach(). You can do these steps manually if you need
+greater control. Also see g_timeout_add_seconds_full().
+
+Note that the first call of the timer may not be precise for timeouts
+of one second. If you need finer precision and have such a timeout,
+you may want to use g_timeout_add() instead.
+Since: 2.14
</description>
<parameters>
-<parameter name="string">
-<parameter_description> a #GString
+<parameter name="interval">
+<parameter_description> the time between calls to the function, in seconds
</parameter_description>
</parameter>
-<parameter name="val">
-<parameter_description> bytes to append
+<parameter name="function">
+<parameter_description> function to call
</parameter_description>
</parameter>
-<parameter name="len">
-<parameter_description> number of bytes of @val to use
+<parameter name="data">
+<parameter_description> data to pass to @function
</parameter_description>
</parameter>
</parameters>
-<return> @string
+<return> the ID (greater than 0) of the event source.
+
</return>
</function>
-<function name="g_string_append_printf">
+<function name="g_timeout_add_seconds_full">
<description>
-Appends a formatted string onto the end of a #GString.
-This function is similar to g_string_printf() except
-that the text is appended to the #GString.
+Sets a function to be called at regular intervals, with @priority.
+The function is called repeatedly until it returns %FALSE, at which
+point the timeout is automatically destroyed and the function will
+not be called again.
+
+Unlike g_timeout_add(), this function operates at whole second granularity.
+The initial starting point of the timer is determined by the implementation
+and the implementation is expected to group multiple timers together so that
+they fire all at the same time.
+To allow this grouping, the @interval to the first timer is rounded
+and can deviate up to one second from the specified interval.
+Subsequent timer iterations will generally run at the specified interval.
+
+Note that timeout functions may be delayed, due to the processing of other
+event sources. Thus they should not be relied on for precise timing.
+After each call to the timeout function, the time of the next
+timeout is recalculated based on the current time and the given @interval
+
+If you want timing more precise than whole seconds, use g_timeout_add()
+instead.
+
+The grouping of timers to fire at the same time results in a more power
+and CPU efficient behavior so if your timer is in multiples of seconds
+and you don't require the first timer exactly one second from now, the
+use of g_timeout_add_seconds() is preferred over g_timeout_add().
+
+This internally creates a main loop source using
+g_timeout_source_new_seconds() and attaches it to the main loop context
+using g_source_attach(). You can do these steps manually if you need
+greater control.
+
+Since: 2.14
</description>
<parameters>
-<parameter name="string">
-<parameter_description> a #GString
+<parameter name="priority">
+<parameter_description> the priority of the timeout source. Typically this will be in
+the range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH.
</parameter_description>
</parameter>
-<parameter name="format">
-<parameter_description> the string format. See the printf() documentation
+<parameter name="interval">
+<parameter_description> the time between calls to the function, in seconds
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> the parameters to insert into the format string
+<parameter name="function">
+<parameter_description> function to call
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> data to pass to @function
+</parameter_description>
+</parameter>
+<parameter name="notify">
+<parameter_description> function to call when the timeout is removed, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the ID (greater than 0) of the event source.
+
+</return>
</function>
-<function name="g_string_append_unichar">
+<function name="g_timeout_source_new">
<description>
-Converts a Unicode character into UTF-8, and appends it
-to the string.
-
+Creates a new timeout source.
-</description>
-<parameters>
-<parameter name="string">
-<parameter_description> a #GString
-</parameter_description>
-</parameter>
-<parameter name="wc">
-<parameter_description> a Unicode character
+The source will not initially be associated with any #GMainContext
+and must be added to one with g_source_attach() before it will be
+executed.
+
+
+</description>
+<parameters>
+<parameter name="interval">
+<parameter_description> the timeout interval in milliseconds.
</parameter_description>
</parameter>
</parameters>
-<return> @string
+<return> the newly-created timeout source
</return>
</function>
-<function name="g_string_append_uri_escaped">
+<function name="g_timeout_source_new_seconds">
<description>
-Appends @unescaped to @string, escaped any characters that
-are reserved in URIs using URI-style escape sequences.
+Creates a new timeout source.
-Since: 2.16
+The source will not initially be associated with any #GMainContext
+and must be added to one with g_source_attach() before it will be
+executed.
+
+The scheduling granularity/accuracy of this timeout source will be
+in seconds.
+
+Since: 2.14
</description>
<parameters>
-<parameter name="string">
-<parameter_description> a #GString
-</parameter_description>
-</parameter>
-<parameter name="unescaped">
-<parameter_description> a string
-</parameter_description>
-</parameter>
-<parameter name="reserved_chars_allowed">
-<parameter_description> a string of reserved characters allowed to be used, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="allow_utf8">
-<parameter_description> set %TRUE if the escaped string may include UTF8 characters
+<parameter name="interval">
+<parameter_description> the timeout interval in seconds
</parameter_description>
</parameter>
</parameters>
-<return> @string
+<return> the newly-created timeout source
</return>
</function>
-<function name="g_string_append_vprintf">
+<function name="g_timer_continue">
<description>
-Appends a formatted string onto the end of a #GString.
-This function is similar to g_string_append_printf()
-except that the arguments to the format string are passed
-as a va_list.
+Resumes a timer that has previously been stopped with
+g_timer_stop(). g_timer_stop() must be called before using this
+function.
-Since: 2.14
+Since: 2.4
</description>
<parameters>
-<parameter name="string">
-<parameter_description> a #GString
-</parameter_description>
-</parameter>
-<parameter name="format">
-<parameter_description> the string format. See the printf() documentation
-</parameter_description>
-</parameter>
-<parameter name="args">
-<parameter_description> the list of arguments to insert in the output
+<parameter name="timer">
+<parameter_description> a #GTimer.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_string_ascii_down">
+<function name="g_timer_destroy">
<description>
-Converts all upper case ASCII letters to lower case ASCII letters.
-
+Destroys a timer, freeing associated resources.
</description>
<parameters>
-<parameter name="string">
-<parameter_description> a GString
+<parameter name="timer">
+<parameter_description> a #GTimer to destroy.
</parameter_description>
</parameter>
</parameters>
-<return> passed-in @string pointer, with all the upper case
-characters converted to lower case in place, with
-semantics that exactly match g_ascii_tolower().
-</return>
+<return></return>
</function>
-<function name="g_string_ascii_up">
+<function name="g_timer_elapsed">
<description>
-Converts all lower case ASCII letters to upper case ASCII letters.
+If @timer has been started but not stopped, obtains the time since
+the timer was started. If @timer has been stopped, obtains the
+elapsed time between the time it was started and the time it was
+stopped. The return value is the number of seconds elapsed,
+including any fractional part. The @microseconds out parameter is
+essentially useless.
+<warning><para>
+Calling initialization functions, in particular g_thread_init(), while a
+timer is running will cause invalid return values from this function.
+</para></warning>
</description>
<parameters>
-<parameter name="string">
-<parameter_description> a GString
+<parameter name="timer">
+<parameter_description> a #GTimer.
+</parameter_description>
+</parameter>
+<parameter name="microseconds">
+<parameter_description> return location for the fractional part of seconds
+elapsed, in microseconds (that is, the total number
+of microseconds elapsed, modulo 1000000), or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> passed-in @string pointer, with all the lower case
-characters converted to upper case in place, with
-semantics that exactly match g_ascii_toupper().
+<return> seconds elapsed as a floating point value, including any
+fractional part.
</return>
</function>
-<function name="g_string_assign">
+<function name="g_timer_new">
<description>
-Copies the bytes from a string into a #GString,
-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.
-
+Creates a new timer, and starts timing (i.e. g_timer_start() is
+implicitly called for you).
</description>
<parameters>
-<parameter name="string">
-<parameter_description> the destination #GString. Its current contents
-are destroyed.
-</parameter_description>
-</parameter>
-<parameter name="rval">
-<parameter_description> the string to copy into @string
-</parameter_description>
-</parameter>
</parameters>
-<return> @string
+<return> a new #GTimer.
</return>
</function>
-<function name="g_string_chunk_clear">
+<function name="g_timer_reset">
<description>
-Frees all strings contained within the #GStringChunk.
-After calling g_string_chunk_clear() it is not safe to
-access any of the strings which were contained within it.
-
-Since: 2.14
+This function is useless; it's fine to call g_timer_start() on an
+already-started timer to reset the start time, so g_timer_reset()
+serves no purpose.
</description>
<parameters>
-<parameter name="chunk">
-<parameter_description> a #GStringChunk
+<parameter name="timer">
+<parameter_description> a #GTimer.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_string_chunk_free">
+<function name="g_timer_start">
<description>
-Frees all memory allocated by the #GStringChunk.
-After calling g_string_chunk_free() it is not safe to
-access any of the strings which were contained within it.
+Marks a start time, so that future calls to g_timer_elapsed() will
+report the time since g_timer_start() was called. g_timer_new()
+automatically marks the start time, so no need to call
+g_timer_start() immediately after creating the timer.
</description>
<parameters>
-<parameter name="chunk">
-<parameter_description> a #GStringChunk
+<parameter name="timer">
+<parameter_description> a #GTimer.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_string_chunk_insert">
+<function name="g_timer_stop">
<description>
-Adds a copy of @string to the #GStringChunk.
-It returns a pointer to the new copy of the string
-in the #GStringChunk. The characters in the string
-can be changed, if necessary, though you should not
-change anything after the end of the string.
-
-Unlike g_string_chunk_insert_const(), this function
-does not check for duplicates. Also strings added
-with g_string_chunk_insert() will not be searched
-by g_string_chunk_insert_const() when looking for
-duplicates.
-
+Marks an end time, so calls to g_timer_elapsed() will return the
+difference between this end time and the start time.
</description>
<parameters>
-<parameter name="chunk">
-<parameter_description> a #GStringChunk
-</parameter_description>
-</parameter>
-<parameter name="string">
-<parameter_description> the string to add
+<parameter name="timer">
+<parameter_description> a #GTimer.
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to the copy of @string within
-the #GStringChunk
-</return>
+<return></return>
</function>
-<function name="g_string_chunk_insert_const">
+<function name="g_tree_destroy">
<description>
-Adds a copy of @string to the #GStringChunk, unless the same
-string has already been added to the #GStringChunk with
-g_string_chunk_insert_const().
-
-This function is useful if you need to copy a large number
-of strings but do not want to waste space storing duplicates.
-But you must remember that there may be several pointers to
-the same string, and so any changes made to the strings
-should be done very carefully.
-
-Note that g_string_chunk_insert_const() will not return a
-pointer to a string added with g_string_chunk_insert(), even
-if they do match.
-
+Removes all keys and values from the #GTree and decreases its
+reference count by one. If keys and/or values are dynamically
+allocated, you should either free them first or create the #GTree
+using g_tree_new_full(). In the latter case the destroy functions
+you supplied will be called on all keys and values before destroying
+the #GTree.
</description>
<parameters>
-<parameter name="chunk">
-<parameter_description> a #GStringChunk
-</parameter_description>
-</parameter>
-<parameter name="string">
-<parameter_description> the string to add
+<parameter name="tree">
+<parameter_description> a #GTree.
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to the new or existing copy of @string
-within the #GStringChunk
-</return>
+<return></return>
</function>
-<function name="g_string_chunk_insert_len">
+<function name="g_tree_foreach">
<description>
-Adds a copy of the first @len bytes of @string to the #GStringChunk.
-The copy is nul-terminated.
-
-Since this function does not stop at nul bytes, it is the caller's
-responsibility to ensure that @string has at least @len addressable
-bytes.
-
-The characters in the returned string can be changed, if necessary,
-though you should not change anything after the end of the string.
+Calls the given function for each of the key/value pairs in the #GTree.
+The function is passed the key and value of each pair, and the given
+ data parameter. The tree is traversed in sorted order.
-Since: 2.4
+The tree may not be modified while iterating over it (you can't
+add/remove items). To remove all items matching a predicate, you need
+to add each item to a list in your #GTraverseFunc as you walk over
+the tree, then walk the list and remove each item.
</description>
<parameters>
-<parameter name="chunk">
-<parameter_description> a #GStringChunk
+<parameter name="tree">
+<parameter_description> a #GTree.
</parameter_description>
</parameter>
-<parameter name="string">
-<parameter_description> bytes to insert
+<parameter name="func">
+<parameter_description> the function to call for each node visited. If this function
+returns %TRUE, the traversal is stopped.
</parameter_description>
</parameter>
-<parameter name="len">
-<parameter_description> number of bytes of @string to insert, or -1 to insert a
-nul-terminated string
+<parameter name="user_data">
+<parameter_description> user data to pass to the function.
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to the copy of @string within the #GStringChunk
-
-</return>
+<return></return>
</function>
-<function name="g_string_chunk_new">
+<function name="g_tree_height">
<description>
-Creates a new #GStringChunk.
+Gets the height of a #GTree.
+
+If the #GTree contains no nodes, the height is 0.
+If the #GTree contains only one root node the height is 1.
+If the root node has children the height is 2, etc.
</description>
<parameters>
-<parameter name="size">
-<parameter_description> the default size of the blocks of memory which are
-allocated to store the strings. If a particular string
-is larger than this default size, a larger block of
-memory will be allocated for it.
+<parameter name="tree">
+<parameter_description> a #GTree.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GStringChunk
+<return> the height of the #GTree.
</return>
</function>
-<function name="g_string_down">
+<function name="g_tree_insert">
<description>
-Converts a #GString to lowercase.
+Inserts a key/value pair into a #GTree. If the given key already exists
+in the #GTree its corresponding value is set to the new value. If you
+supplied a value_destroy_func when creating the #GTree, the old value is
+freed using that function. If you supplied a @key_destroy_func when
+creating the #GTree, the passed key is freed using that function.
-Deprecated:2.2: This function uses the locale-specific
-tolower() function, which is almost never the right thing.
-Use g_string_ascii_down() or g_utf8_strdown() instead.
+The tree is automatically 'balanced' as new key/value pairs are added,
+so that the distance from the root to every leaf is as small as possible.
</description>
<parameters>
-<parameter name="string">
-<parameter_description> a #GString
+<parameter name="tree">
+<parameter_description> a #GTree.
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> the key to insert.
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> the value corresponding to the key.
</parameter_description>
</parameter>
</parameters>
-<return> the #GString.
-
-</return>
+<return></return>
</function>
-<function name="g_string_equal">
+<function name="g_tree_lookup">
<description>
-Compares two strings for equality, returning %TRUE if they are equal.
-For use with #GHashTable.
+Gets the value corresponding to the given key. Since a #GTree is
+automatically balanced as key/value pairs are added, key lookup is very
+fast.
</description>
<parameters>
-<parameter name="v">
-<parameter_description> a #GString
+<parameter name="tree">
+<parameter_description> a #GTree.
</parameter_description>
</parameter>
-<parameter name="v2">
-<parameter_description> another #GString
+<parameter name="key">
+<parameter_description> the key to look up.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if they strings are the same length and contain the
-same bytes
+<return> the value corresponding to the key, or %NULL if the key was
+not found.
</return>
</function>
-<function name="g_string_erase">
+<function name="g_tree_lookup_extended">
<description>
-Removes @len bytes from a #GString, starting at position @pos.
-The rest of the #GString is shifted down to fill the gap.
+Looks up a key in the #GTree, returning the original key and the
+associated value and a #gboolean which is %TRUE if the key was found. This
+is useful if you need to free the memory allocated for the original key,
+for example before calling g_tree_remove().
</description>
<parameters>
-<parameter name="string">
-<parameter_description> a #GString
+<parameter name="tree">
+<parameter_description> a #GTree.
</parameter_description>
</parameter>
-<parameter name="pos">
-<parameter_description> the position of the content to remove
+<parameter name="lookup_key">
+<parameter_description> the key to look up.
</parameter_description>
</parameter>
-<parameter name="len">
-<parameter_description> the number of bytes to remove, or -1 to remove all
-following bytes
+<parameter name="orig_key">
+<parameter_description> returns the original key.
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> returns the value associated with the key.
</parameter_description>
</parameter>
</parameters>
-<return> @string
+<return> %TRUE if the key was found in the #GTree.
</return>
</function>
-<function name="g_string_free">
+<function name="g_tree_new">
<description>
-Frees the memory allocated for the #GString.
-If @free_segment is %TRUE it also frees the character data. If
-it's %FALSE, the caller gains ownership of the buffer and must
-free it after use with g_free().
+Creates a new #GTree.
</description>
<parameters>
-<parameter name="string">
-<parameter_description> a #GString
-</parameter_description>
-</parameter>
-<parameter name="free_segment">
-<parameter_description> if %TRUE the actual character data is freed as well
+<parameter name="key_compare_func">
+<parameter_description> the function used to order the nodes in the #GTree.
+It should return values similar to the standard strcmp() function -
+0 if the two arguments are equal, a negative value if the first argument
+comes before the second, or a positive value if the first argument comes
+after the second.
</parameter_description>
</parameter>
</parameters>
-<return> the character data of @string
-(i.e. %NULL if @free_segment is %TRUE)
+<return> a new #GTree.
</return>
</function>
-<function name="g_string_hash">
+<function name="g_tree_new_full">
<description>
-Creates a hash code for @str; for use with #GHashTable.
+Creates a new #GTree like g_tree_new() and allows to specify functions
+to free the memory allocated for the key and value that get called when
+removing the entry from the #GTree.
</description>
<parameters>
-<parameter name="str">
-<parameter_description> a string to hash
+<parameter name="key_compare_func">
+<parameter_description> qsort()-style comparison function.
+</parameter_description>
+</parameter>
+<parameter name="key_compare_data">
+<parameter_description> data to pass to comparison function.
+</parameter_description>
+</parameter>
+<parameter name="key_destroy_func">
+<parameter_description> a function to free the memory allocated for the key
+used when removing the entry from the #GTree or %NULL if you don't
+want to supply such a function.
+</parameter_description>
+</parameter>
+<parameter name="value_destroy_func">
+<parameter_description> a function to free the memory allocated for the
+value used when removing the entry from the #GTree or %NULL if you
+don't want to supply such a function.
</parameter_description>
</parameter>
</parameters>
-<return> hash code for @str
+<return> a new #GTree.
</return>
</function>
-<function name="g_string_insert">
+<function name="g_tree_new_with_data">
<description>
-Inserts a copy of a string into a #GString,
-expanding it if necessary.
+Creates a new #GTree with a comparison function that accepts user data.
+See g_tree_new() for more details.
</description>
<parameters>
-<parameter name="string">
-<parameter_description> a #GString
-</parameter_description>
-</parameter>
-<parameter name="pos">
-<parameter_description> the position to insert the copy of the string
+<parameter name="key_compare_func">
+<parameter_description> qsort()-style comparison function.
</parameter_description>
</parameter>
-<parameter name="val">
-<parameter_description> the string to insert
+<parameter name="key_compare_data">
+<parameter_description> data to pass to comparison function.
</parameter_description>
</parameter>
</parameters>
-<return> @string
+<return> a new #GTree.
</return>
</function>
-<function name="g_string_insert_c">
+<function name="g_tree_nnodes">
<description>
-Inserts a byte into a #GString, expanding it if necessary.
+Gets the number of nodes in a #GTree.
</description>
<parameters>
-<parameter name="string">
-<parameter_description> a #GString
-</parameter_description>
-</parameter>
-<parameter name="pos">
-<parameter_description> the position to insert the byte
-</parameter_description>
-</parameter>
-<parameter name="c">
-<parameter_description> the byte to insert
+<parameter name="tree">
+<parameter_description> a #GTree.
</parameter_description>
</parameter>
</parameters>
-<return> @string
+<return> the number of nodes in the #GTree.
</return>
</function>
-<function name="g_string_insert_len">
+<function name="g_tree_ref">
<description>
-Inserts @len bytes of @val into @string at @pos.
-Because @len is provided, @val may contain embedded
-nuls and need not be nul-terminated. If @pos is -1,
-bytes are inserted at the end of the string.
-
-Since this function does not stop at nul bytes, it is
-the caller's responsibility to ensure that @val has at
-least @len addressable bytes.
+Increments the reference count of @tree by one. It is safe to call
+this function from any thread.
+Since: 2.22
</description>
<parameters>
-<parameter name="string">
-<parameter_description> a #GString
-</parameter_description>
-</parameter>
-<parameter name="pos">
-<parameter_description> position in @string where insertion should
-happen, or -1 for at the end
-</parameter_description>
-</parameter>
-<parameter name="val">
-<parameter_description> bytes to insert
-</parameter_description>
-</parameter>
-<parameter name="len">
-<parameter_description> number of bytes of @val to insert
+<parameter name="tree">
+<parameter_description> a #GTree.
</parameter_description>
</parameter>
</parameters>
-<return> @string
+<return> the passed in #GTree.
+
</return>
</function>
-<function name="g_string_insert_unichar">
+<function name="g_tree_remove">
<description>
-Converts a Unicode character into UTF-8, and insert it
-into the string at the given position.
+Removes a key/value pair from a #GTree.
+
+If the #GTree was created using g_tree_new_full(), the key and value
+are freed using the supplied destroy functions, otherwise you have to
+make sure that any dynamically allocated values are freed yourself.
+If the key does not exist in the #GTree, the function does nothing.
</description>
<parameters>
-<parameter name="string">
-<parameter_description> a #GString
-</parameter_description>
-</parameter>
-<parameter name="pos">
-<parameter_description> the position at which to insert character, or -1 to
-append at the end of the string
+<parameter name="tree">
+<parameter_description> a #GTree.
</parameter_description>
</parameter>
-<parameter name="wc">
-<parameter_description> a Unicode character
+<parameter name="key">
+<parameter_description> the key to remove.
</parameter_description>
</parameter>
</parameters>
-<return> @string
+<return> %TRUE if the key was found (prior to 2.8, this function returned
+nothing)
</return>
</function>
-<function name="g_string_new">
+<function name="g_tree_replace">
<description>
-Creates a new #GString, initialized with the given string.
+Inserts a new key and value into a #GTree similar to g_tree_insert().
+The difference is that if the key already exists in the #GTree, it gets
+replaced by the new key. If you supplied a @value_destroy_func when
+creating the #GTree, the old value is freed using that function. If you
+supplied a @key_destroy_func when creating the #GTree, the old key is
+freed using that function.
+The tree is automatically 'balanced' as new key/value pairs are added,
+so that the distance from the root to every leaf is as small as possible.
</description>
<parameters>
-<parameter name="init">
-<parameter_description> the initial text to copy into the string
+<parameter name="tree">
+<parameter_description> a #GTree.
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> the key to insert.
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> the value corresponding to the key.
</parameter_description>
</parameter>
</parameters>
-<return> the new #GString
-</return>
+<return></return>
</function>
-<function name="g_string_new_len">
+<function name="g_tree_search">
<description>
-Creates a new #GString with @len bytes of the @init buffer.
-Because a length is provided, @init need not be nul-terminated,
-and can contain embedded nul bytes.
+Searches a #GTree using @search_func.
-Since this function does not stop at nul bytes, it is the caller's
-responsibility to ensure that @init has at least @len addressable
-bytes.
+The @search_func is called with a pointer to the key of a key/value
+pair in the tree, and the passed in @user_data. If @search_func returns
+0 for a key/value pair, then the corresponding value is returned as
+the result of g_tree_search(). If @search_func returns -1, searching
+will proceed among the key/value pairs that have a smaller key; if
+ search_func returns 1, searching will proceed among the key/value
+pairs that have a larger key.
</description>
<parameters>
-<parameter name="init">
-<parameter_description> initial contents of the string
+<parameter name="tree">
+<parameter_description> a #GTree
</parameter_description>
</parameter>
-<parameter name="len">
-<parameter_description> length of @init to use
+<parameter name="search_func">
+<parameter_description> a function used to search the #GTree
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> the data passed as the second argument to @search_func
</parameter_description>
</parameter>
</parameters>
-<return> a new #GString
+<return> the value corresponding to the found key, or %NULL if
+the key was not found.
</return>
</function>
-<function name="g_string_overwrite">
+<function name="g_tree_steal">
<description>
-Overwrites part of a string, lengthening it if necessary.
+Removes a key and its associated value from a #GTree without calling
+the key and value destroy functions.
+
+If the key does not exist in the #GTree, the function does nothing.
-Since: 2.14
</description>
<parameters>
-<parameter name="string">
-<parameter_description> a #GString
-</parameter_description>
-</parameter>
-<parameter name="pos">
-<parameter_description> the position at which to start overwriting
+<parameter name="tree">
+<parameter_description> a #GTree.
</parameter_description>
</parameter>
-<parameter name="val">
-<parameter_description> the string that will overwrite the @string starting at @pos
+<parameter name="key">
+<parameter_description> the key to remove.
</parameter_description>
</parameter>
</parameters>
-<return> @string
-
+<return> %TRUE if the key was found (prior to 2.8, this function returned
+nothing)
</return>
</function>
-<function name="g_string_overwrite_len">
+<function name="g_tree_traverse">
<description>
-Overwrites part of a string, lengthening it if necessary.
-This function will work with embedded nuls.
+Calls the given function for each node in the #GTree.
-Since: 2.14
+Deprecated:2.2: The order of a balanced tree is somewhat arbitrary. If you
+just want to visit all nodes in sorted order, use g_tree_foreach()
+instead. If you really need to visit nodes in a different order, consider
+using an <link linkend="glib-N-ary-Trees">N-ary Tree</link>.
</description>
<parameters>
-<parameter name="string">
-<parameter_description> a #GString
+<parameter name="tree">
+<parameter_description> a #GTree.
</parameter_description>
</parameter>
-<parameter name="pos">
-<parameter_description> the position at which to start overwriting
+<parameter name="traverse_func">
+<parameter_description> the function to call for each node visited. If this
+function returns %TRUE, the traversal is stopped.
</parameter_description>
</parameter>
-<parameter name="val">
-<parameter_description> the string that will overwrite the @string starting at @pos
+<parameter name="traverse_type">
+<parameter_description> the order in which nodes are visited, one of %G_IN_ORDER,
+%G_PRE_ORDER and %G_POST_ORDER.
</parameter_description>
</parameter>
-<parameter name="len">
-<parameter_description> the number of bytes to write from @val
+<parameter name="user_data">
+<parameter_description> user data to pass to the function.
</parameter_description>
</parameter>
</parameters>
-<return> @string
-
-</return>
+<return></return>
</function>
-<function name="g_string_prepend">
+<function name="g_tree_unref">
<description>
-Adds a string on to the start of a #GString,
-expanding it if necessary.
+Decrements the reference count of @tree by one. If the reference count
+drops to 0, all keys and values will be destroyed (if destroy
+functions were specified) and all memory allocated by @tree will be
+released.
+It is safe to call this function from any thread.
+
+Since: 2.22
</description>
<parameters>
-<parameter name="string">
-<parameter_description> a #GString
+<parameter name="tree">
+<parameter_description> a #GTree.
</parameter_description>
</parameter>
-<parameter name="val">
-<parameter_description> the string to prepend on the start of @string
+</parameters>
+<return></return>
+</function>
+
+<function name="g_try_malloc">
+<description>
+Attempts to allocate @n_bytes, and returns %NULL on failure.
+Contrast with g_malloc(), which aborts the program on failure.
+
+
+</description>
+<parameters>
+<parameter name="n_bytes">
+<parameter_description> number of bytes to allocate.
</parameter_description>
</parameter>
</parameters>
-<return> @string
+<return> the allocated memory, or %NULL.
</return>
</function>
-<function name="g_string_prepend_c">
+<function name="g_try_malloc0">
<description>
-Adds a byte onto the start of a #GString,
-expanding it if necessary.
+Attempts to allocate @n_bytes, initialized to 0's, and returns %NULL on
+failure. Contrast with g_malloc0(), which aborts the program on failure.
+Since: 2.8
</description>
<parameters>
-<parameter name="string">
-<parameter_description> a #GString
-</parameter_description>
-</parameter>
-<parameter name="c">
-<parameter_description> the byte to prepend on the start of the #GString
+<parameter name="n_bytes">
+<parameter_description> number of bytes to allocate
</parameter_description>
</parameter>
</parameters>
-<return> @string
+<return> the allocated memory, or %NULL
</return>
</function>
-<function name="g_string_prepend_len">
+<function name="g_try_malloc0_n">
<description>
-Prepends @len bytes of @val to @string.
-Because @len is provided, @val may contain
-embedded nuls and need not be nul-terminated.
-
-Since this function does not stop at nul bytes,
-it is the caller's responsibility to ensure that
- val has at least @len addressable bytes.
+This function is similar to g_try_malloc0(), allocating (@n_blocks * @n_block_bytes) bytes,
+but care is taken to detect possible overflow during multiplication.
+Since: 2.24
</description>
<parameters>
-<parameter name="string">
-<parameter_description> a #GString
-</parameter_description>
-</parameter>
-<parameter name="val">
-<parameter_description> bytes to prepend
+<parameter name="n_blocks">
+<parameter_description> the number of blocks to allocate
</parameter_description>
</parameter>
-<parameter name="len">
-<parameter_description> number of bytes in @val to prepend
+<parameter name="n_block_bytes">
+<parameter_description> the size of each block in bytes
</parameter_description>
</parameter>
</parameters>
-<return> @string
+<return> the allocated memory, or %NULL
</return>
</function>
-<function name="g_string_prepend_unichar">
+<function name="g_try_malloc_n">
<description>
-Converts a Unicode character into UTF-8, and prepends it
-to the string.
+This function is similar to g_try_malloc(), allocating (@n_blocks * @n_block_bytes) bytes,
+but care is taken to detect possible overflow during multiplication.
+Since: 2.24
</description>
<parameters>
-<parameter name="string">
-<parameter_description> a #GString
+<parameter name="n_blocks">
+<parameter_description> the number of blocks to allocate
</parameter_description>
</parameter>
-<parameter name="wc">
-<parameter_description> a Unicode character
+<parameter name="n_block_bytes">
+<parameter_description> the size of each block in bytes
</parameter_description>
</parameter>
</parameters>
-<return> @string
+<return> the allocated memory, or %NULL.
</return>
</function>
-<function name="g_string_printf">
+<function name="g_try_realloc">
<description>
-Writes a formatted string into a #GString.
-This is similar to the standard sprintf() function,
-except that the #GString buffer automatically expands
-to contain the results. The previous contents of the
-#GString are destroyed.
+Attempts to realloc @mem to a new size, @n_bytes, and returns %NULL
+on failure. Contrast with g_realloc(), which aborts the program
+on failure. If @mem is %NULL, behaves the same as g_try_malloc().
+
</description>
<parameters>
-<parameter name="string">
-<parameter_description> a #GString
-</parameter_description>
-</parameter>
-<parameter name="format">
-<parameter_description> the string format. See the printf() documentation
+<parameter name="mem">
+<parameter_description> previously-allocated memory, or %NULL.
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> the parameters to insert into the format string
+<parameter name="n_bytes">
+<parameter_description> number of bytes to allocate.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the allocated memory, or %NULL.
+</return>
</function>
-<function name="g_string_set_size">
+<function name="g_try_realloc_n">
<description>
-Sets the length of a #GString. If the length is less than
-the current length, the string will be truncated. If the
-length is greater than the current length, the contents
-of the newly added area are undefined. (However, as
-always, string->str[string->len] will be a nul byte.)
+This function is similar to g_try_realloc(), allocating (@n_blocks * @n_block_bytes) bytes,
+but care is taken to detect possible overflow during multiplication.
+Since: 2.24
</description>
<parameters>
-<parameter name="string">
-<parameter_description> a #GString
+<parameter name="mem">
+<parameter_description> previously-allocated memory, or %NULL.
</parameter_description>
</parameter>
-<parameter name="len">
-<parameter_description> the new length
+<parameter name="n_blocks">
+<parameter_description> the number of blocks to allocate
+</parameter_description>
+</parameter>
+<parameter name="n_block_bytes">
+<parameter_description> the size of each block in bytes
</parameter_description>
</parameter>
</parameters>
-<return> @string
+<return> the allocated memory, or %NULL.
</return>
</function>
-<function name="g_string_sized_new">
+<function name="g_tuples_destroy">
<description>
-Creates a new #GString, with enough space for @dfl_size
-bytes. 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.
+Frees the records which were returned by g_relation_select(). This
+should always be called after g_relation_select() when you are
+finished with the records. The records are not removed from the
+#GRelation.
+Deprecated: 2.26: Rarely used API
</description>
<parameters>
-<parameter name="dfl_size">
-<parameter_description> the default size of the space allocated to
-hold the string
+<parameter name="tuples">
+<parameter_description> the tuple data to free.
</parameter_description>
</parameter>
</parameters>
-<return> the new #GString
-</return>
+<return></return>
</function>
-<function name="g_string_sprintf">
+<function name="g_tuples_index">
<description>
-Writes a formatted string into a #GString.
-This is similar to the standard sprintf() function,
-except that the #GString buffer automatically expands
-to contain the results. The previous contents of the
-#GString are destroyed.
+Gets a field from the records returned by g_relation_select(). It
+returns the given field of the record at the given index. The
+returned value should not be changed.
-Deprecated: This function has been renamed to g_string_printf().
+Deprecated: 2.26: Rarely used API
</description>
<parameters>
-<parameter name="string">
-<parameter_description> a #GString
+<parameter name="tuples">
+<parameter_description> the tuple data, returned by g_relation_select().
</parameter_description>
</parameter>
-<parameter name="format">
-<parameter_description> the string format. See the sprintf() documentation
+<parameter name="index_">
+<parameter_description> the index of the record.
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> the parameters to insert into the format string
+<parameter name="field">
+<parameter_description> the field to return.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the field of the record.
+</return>
</function>
-<function name="g_string_sprintfa">
+<function name="g_type_add_class_cache_func">
<description>
-Appends a formatted string onto the end of a #GString.
-This function is similar to g_string_sprintf() except that
-the text is appended to the #GString.
-
-Deprecated: This function has been renamed to g_string_append_printf()
+Adds a #GTypeClassCacheFunc to be called before the reference count of a
+class goes from one to zero. This can be used to prevent premature class
+destruction. All installed #GTypeClassCacheFunc functions will be chained
+until one of them returns %TRUE. The functions have to check the class id
+passed in to figure whether they actually want to cache the class of this
+type, since all classes are routed through the same #GTypeClassCacheFunc
+chain.
</description>
<parameters>
-<parameter name="string">
-<parameter_description> a #GString
-</parameter_description>
-</parameter>
-<parameter name="format">
-<parameter_description> the string format. See the sprintf() documentation
+<parameter name="cache_data">
+<parameter_description> data to be passed to @cache_func
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> the parameters to insert into the format string
+<parameter name="cache_func">
+<parameter_description> a #GTypeClassCacheFunc
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_string_truncate">
+<function name="g_type_add_class_private">
<description>
-Cuts off the end of the GString, leaving the first @len bytes.
+Registers a private class structure for a classed type;
+when the class is allocated, the private structures for
+the class and all of its parent types are allocated
+sequentially in the same memory block as the public
+structures. This function should be called in the
+type's get_type() function after the type is registered.
+The private structure can be retrieved using the
+G_TYPE_CLASS_GET_PRIVATE() macro.
+Since: 2.24
</description>
<parameters>
-<parameter name="string">
-<parameter_description> a #GString
+<parameter name="class_type">
+<parameter_description> GType of an classed type.
</parameter_description>
</parameter>
-<parameter name="len">
-<parameter_description> the new size of @string
+<parameter name="private_size">
+<parameter_description> size of private structure.
</parameter_description>
</parameter>
</parameters>
-<return> @string
-</return>
+<return></return>
</function>
-<function name="g_string_up">
+<function name="g_type_add_interface_check">
<description>
-Converts a #GString to uppercase.
+Adds a function to be called after an interface vtable is
+initialized for any class (i.e. after the @interface_init member of
+#GInterfaceInfo has been called).
-Deprecated:2.2: This function uses the locale-specific
-toupper() function, which is almost never the right thing.
-Use g_string_ascii_up() or g_utf8_strup() instead.
+This function is useful when you want to check an invariant that
+depends on the interfaces of a class. For instance, the
+implementation of #GObject uses this facility to check that an
+object implements all of the properties that are defined on its
+interfaces.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="string">
-<parameter_description> a #GString
+<parameter name="check_data">
+<parameter_description> data to pass to @check_func
+</parameter_description>
+</parameter>
+<parameter name="check_func">
+<parameter_description> function to be called after each interface
+is initialized.
</parameter_description>
</parameter>
</parameters>
-<return> @string
-
-</return>
+<return></return>
</function>
-<function name="g_string_vprintf">
+<function name="g_type_add_interface_dynamic">
<description>
-Writes a formatted string into a #GString.
-This function is similar to g_string_printf() except that
-the arguments to the format string are passed as a va_list.
-
-Since: 2.14
+Adds the dynamic @interface_type to @instantiable_type. The information
+contained in the #GTypePlugin structure pointed to by @plugin
+is used to manage the relationship.
</description>
<parameters>
-<parameter name="string">
-<parameter_description> a #GString
+<parameter name="instance_type">
+<parameter_description> the #GType value of an instantiable type.
</parameter_description>
</parameter>
-<parameter name="format">
-<parameter_description> the string format. See the printf() documentation
+<parameter name="interface_type">
+<parameter_description> the #GType value of an interface type.
</parameter_description>
</parameter>
-<parameter name="args">
-<parameter_description> the parameters to insert into the format string
+<parameter name="plugin">
+<parameter_description> the #GTypePlugin structure to retrieve the #GInterfaceInfo from.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_strip_context">
+<function name="g_type_add_interface_static">
<description>
-An auxiliary function for gettext() support (see Q_()).
-
-Since: 2.4
+Adds the static @interface_type to @instantiable_type. The information
+contained in the #GTypeInterfaceInfo structure pointed to by @info
+is used to manage the relationship.
</description>
<parameters>
-<parameter name="msgid">
-<parameter_description> a string
+<parameter name="instance_type">
+<parameter_description> #GType value of an instantiable type.
</parameter_description>
</parameter>
-<parameter name="msgval">
-<parameter_description> another string
+<parameter name="interface_type">
+<parameter_description> #GType value of an interface type.
+</parameter_description>
+</parameter>
+<parameter name="info">
+<parameter_description> The #GInterfaceInfo structure for this
+(@instance_type, @interface_type) combination.
</parameter_description>
</parameter>
</parameters>
-<return> @msgval, unless @msgval is identical to @msgid and contains
-a '|' character, in which case a pointer to the substring of msgid after
-the first '|' character is returned.
-
-</return>
+<return></return>
</function>
-<function name="g_strjoin">
+<function name="g_type_check_instance">
<description>
-Joins a number of strings together to form one long string, with the
-optional @separator inserted between each of them. The returned string
-should be freed with g_free().
+Private helper function to aid implementation of the G_TYPE_CHECK_INSTANCE()
+macro.
</description>
<parameters>
-<parameter name="separator">
-<parameter_description> a string to insert between each of the strings, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="Varargs">
-<parameter_description> a %NULL-terminated list of strings to join
+<parameter name="instance">
+<parameter_description> A valid #GTypeInstance structure.
</parameter_description>
</parameter>
</parameters>
-<return> a newly-allocated string containing all of the strings joined
-together, with @separator between them
+<return> #TRUE if @instance is valid, #FALSE otherwise.
</return>
</function>
-<function name="g_strjoinv">
+<function name="g_type_children">
<description>
-Joins a number of strings together to form one long string, with the
-optional @separator inserted between each of them. The returned string
-should be freed with g_free().
+Return a newly allocated and 0-terminated array of type IDs, listing the
+child types of @type. The return value has to be g_free()ed after use.
</description>
<parameters>
-<parameter name="separator">
-<parameter_description> a string to insert between each of the strings, or %NULL
+<parameter name="type">
+<parameter_description> The parent type.
</parameter_description>
</parameter>
-<parameter name="str_array">
-<parameter_description> a %NULL-terminated array of strings to join
+<parameter name="n_children">
+<parameter_description> Optional #guint pointer to contain
+the number of child types.
</parameter_description>
</parameter>
</parameters>
-<return> a newly-allocated string containing all of the strings joined
-together, with @separator between them
+<return> Newly allocated
+and 0-terminated array of child types.
</return>
</function>
-<function name="g_strlcat">
+<function name="g_type_class_add_private">
<description>
-Portability wrapper that calls strlcat() on systems which have it,
-and emulates it otherwise. Appends nul-terminated @src string to @dest,
-guaranteeing nul-termination for @dest. The total size of @dest won't
-exceed @dest_size.
+Registers a private structure for an instantiatable type.
-At most dest_size - 1 characters will be copied.
-Unlike strncat, dest_size is the full size of dest, not the space left over.
-This function does NOT allocate memory.
-This always NUL terminates (unless siz == 0 or there were no NUL characters
-in the dest_size characters of dest to start with).
+When an object is allocated, the private structures for
+the type and all of its parent types are allocated
+sequentially in the same memory block as the public
+structures.
-<note><para>Caveat: this is supposedly a more secure alternative to
-strcat() or strncat(), but for real security g_strconcat() is harder
-to mess up.</para></note>
+Note that the accumulated size of the private structures of
+a type and all its parent types cannot excced 64kB.
+This function should be called in the type's class_init() function.
+The private structure can be retrieved using the
+G_TYPE_INSTANCE_GET_PRIVATE() macro.
-</description>
-<parameters>
-<parameter name="dest">
-<parameter_description> destination buffer, already containing one nul-terminated string
-</parameter_description>
-</parameter>
-<parameter name="src">
-<parameter_description> source buffer
-</parameter_description>
-</parameter>
-<parameter name="dest_size">
-<parameter_description> length of @dest buffer in bytes (not length of existing string
-inside @dest)
-</parameter_description>
-</parameter>
-</parameters>
-<return> size of attempted result, which is MIN (dest_size, strlen
-(original dest)) + strlen (src), so if retval >= dest_size,
-truncation occurred.
-</return>
-</function>
+The following example shows attaching a private structure
+<structname>MyObjectPrivate</structname> to an object
+<structname>MyObject</structname> defined in the standard GObject
+fashion.
+type's class_init() function.
-<function name="g_strlcpy">
-<description>
-Portability wrapper that calls strlcpy() on systems which have it,
-and emulates strlcpy() otherwise. Copies @src to @dest; @dest is
-guaranteed to be nul-terminated; @src must be nul-terminated;
- dest_size is the buffer size, not the number of chars to copy.
+|[
+typedef struct _MyObject MyObject;
+typedef struct _MyObjectPrivate MyObjectPrivate;
-At most dest_size - 1 characters will be copied. Always nul-terminates
-(unless dest_size == 0). This function does <emphasis>not</emphasis>
-allocate memory. Unlike strncpy(), this function doesn't pad dest (so
-it's often faster). It returns the size of the attempted result,
-strlen (src), so if @retval >= @dest_size, truncation occurred.
+struct _MyObject {
+GObject parent;
-<note><para>Caveat: strlcpy() is supposedly more secure than
-strcpy() or strncpy(), but if you really want to avoid screwups,
-g_strdup() is an even better idea.</para></note>
+MyObjectPrivate *priv;
+};
+struct _MyObjectPrivate {
+int some_field;
+};
-</description>
-<parameters>
-<parameter name="dest">
-<parameter_description> destination buffer
-</parameter_description>
-</parameter>
-<parameter name="src">
-<parameter_description> source buffer
-</parameter_description>
-</parameter>
-<parameter name="dest_size">
-<parameter_description> length of @dest in bytes
-</parameter_description>
-</parameter>
-</parameters>
-<return> length of @src
-</return>
-</function>
+static void
+my_object_class_init (MyObjectClass *klass)
+{
+g_type_class_add_private (klass, sizeof (MyObjectPrivate));
+}
-<function name="g_strncasecmp">
-<description>
-A case-insensitive string comparison, corresponding to the standard
-strncasecmp() function on platforms which support it.
-It is similar to g_strcasecmp() except it only compares the first @n
-characters of the strings.
+static void
+my_object_init (MyObject *my_object)
+{
+my_object->priv = G_TYPE_INSTANCE_GET_PRIVATE (my_object,
+MY_TYPE_OBJECT,
+MyObjectPrivate);
+}
-Deprecated:2.2: The problem with g_strncasecmp() is that it does the
-comparison by calling toupper()/tolower(). These functions are
-locale-specific and operate on single bytes. However, it is impossible
-to handle things correctly from an I18N standpoint by operating on
-bytes, since characters may be multibyte. Thus g_strncasecmp() is
-broken if your string is guaranteed to be ASCII, since it's
-locale-sensitive, and it's broken if your string is localized, since
-it doesn't work on many encodings at all, including UTF-8, EUC-JP,
-etc.
+static int
+my_object_get_some_field (MyObject *my_object)
+{
+MyObjectPrivate *priv = my_object->priv;
-There are therefore two replacement functions: g_ascii_strncasecmp(),
-which only works on ASCII and is not locale-sensitive, and
-g_utf8_casefold(), which is good for case-insensitive sorting of UTF-8.
+return priv->some_field;
+}
+]|
+
+Since: 2.4
</description>
<parameters>
-<parameter name="s1">
-<parameter_description> a string.
-</parameter_description>
-</parameter>
-<parameter name="s2">
-<parameter_description> a string to compare with @s1.
+<parameter name="g_class">
+<parameter_description> class structure for an instantiatable type
</parameter_description>
</parameter>
-<parameter name="n">
-<parameter_description> the maximum number of characters to compare.
+<parameter name="private_size">
+<parameter_description> size of private structure.
</parameter_description>
</parameter>
</parameters>
-<return> 0 if the strings match, a negative value if @s1 < @s2,
-or a positive value if @s1 > @s2.
-
-</return>
+<return></return>
</function>
-<function name="g_strndup">
+<function name="g_type_class_peek">
<description>
-Duplicates the first @n bytes of a string, returning a newly-allocated
-buffer @n + 1 bytes long which will always be nul-terminated.
-If @str is less than @n bytes long the buffer is padded with nuls.
-If @str is %NULL it returns %NULL.
-The returned value should be freed when no longer needed.
-
-<note><para>
-To copy a number of characters from a UTF-8 encoded string, use
-g_utf8_strncpy() instead.
-</para></note>
+This function is essentially the same as g_type_class_ref(), except that
+the classes reference count isn't incremented. As a consequence, this function
+may return %NULL if the class of the type passed in does not currently
+exist (hasn't been referenced before).
</description>
<parameters>
-<parameter name="str">
-<parameter_description> the string to duplicate
-</parameter_description>
-</parameter>
-<parameter name="n">
-<parameter_description> the maximum number of bytes to copy from @str
+<parameter name="type">
+<parameter_description> Type ID of a classed type.
</parameter_description>
</parameter>
</parameters>
-<return> a newly-allocated buffer containing the first @n bytes
-of @str, nul-terminated
+<return> The #GTypeClass
+structure for the given type ID or %NULL if the class does not
+currently exist.
</return>
</function>
-<function name="g_strnfill">
+<function name="g_type_class_peek_parent">
<description>
-Creates a new string @length bytes long filled with @fill_char.
-The returned string should be freed when no longer needed.
+This is a convenience function often needed in class initializers.
+It returns the class structure of the immediate parent type of the
+class passed in. Since derived classes hold a reference count on
+their parent classes as long as they are instantiated, the returned
+class will always exist. This function is essentially equivalent
+to:
+
+<programlisting>
+g_type_class_peek (g_type_parent (G_TYPE_FROM_CLASS (g_class)));
+</programlisting>
</description>
<parameters>
-<parameter name="length">
-<parameter_description> the length of the new string
-</parameter_description>
-</parameter>
-<parameter name="fill_char">
-<parameter_description> the byte to fill the string with
+<parameter name="g_class">
+<parameter_description> The #GTypeClass structure to
+retrieve the parent class for.
</parameter_description>
</parameter>
</parameters>
-<return> a newly-allocated string filled the @fill_char
+<return> The parent class
+of @g_class.
</return>
</function>
-<function name="g_strreverse">
+<function name="g_type_class_peek_static">
<description>
-Reverses all of the bytes in a string. For example,
-<literal>g_strreverse ("abcdef")</literal> will result
-in "fedcba".
-
-Note that g_strreverse() doesn't work on UTF-8 strings
-containing multibyte characters. For that purpose, use
-g_utf8_strreverse().
+A more efficient version of g_type_class_peek() which works only for
+static types.
+Since: 2.4
</description>
<parameters>
-<parameter name="string">
-<parameter_description> the string to reverse
+<parameter name="type">
+<parameter_description> Type ID of a classed type.
</parameter_description>
</parameter>
</parameters>
-<return> the same pointer passed in as @string
+<return> The #GTypeClass
+structure for the given type ID or %NULL if the class does not
+currently exist or is dynamically loaded.
</return>
</function>
-<function name="g_strrstr">
+<function name="g_type_class_ref">
<description>
-Searches the string @haystack for the last occurrence
-of the string @needle.
+Increments the reference count of the class structure belonging to
+ type This function will demand-create the class if it doesn't
+exist already.
</description>
<parameters>
-<parameter name="haystack">
-<parameter_description> a nul-terminated string.
-</parameter_description>
-</parameter>
-<parameter name="needle">
-<parameter_description> the nul-terminated string to search for.
+<parameter name="type">
+<parameter_description> Type ID of a classed type.
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to the found occurrence, or
-%NULL if not found.
+<return> The #GTypeClass
+structure for the given type ID.
</return>
</function>
-<function name="g_strrstr_len">
+<function name="g_type_class_unref">
<description>
-Searches the string @haystack for the last occurrence
-of the string @needle, limiting the length of the search
-to @haystack_len.
-
+Decrements the reference count of the class structure being passed in.
+Once the last reference count of a class has been released, classes
+may be finalized by the type system, so further dereferencing of a
+class pointer after g_type_class_unref() are invalid.
</description>
<parameters>
-<parameter name="haystack">
-<parameter_description> a nul-terminated string.
+<parameter name="g_class">
+<parameter_description> The #GTypeClass structure to
+unreference.
</parameter_description>
</parameter>
-<parameter name="haystack_len">
-<parameter_description> the maximum length of @haystack.
-</parameter_description>
-</parameter>
-<parameter name="needle">
-<parameter_description> the nul-terminated string to search for.
+</parameters>
+<return></return>
+</function>
+
+<function name="g_type_class_unref_uncached">
+<description>
+A variant of g_type_class_unref() for use in #GTypeClassCacheFunc
+implementations. It unreferences a class without consulting the chain
+of #GTypeClassCacheFunc<!-- -->s, avoiding the recursion which would occur
+otherwise.
+
+</description>
+<parameters>
+<parameter name="g_class">
+<parameter_description> The #GTypeClass structure to
+unreference.
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to the found occurrence, or
-%NULL if not found.
-</return>
+<return></return>
</function>
-<function name="g_strsignal">
+<function name="g_type_create_instance">
<description>
-Returns a string describing the given signal, e.g. "Segmentation fault".
-You should use this function in preference to strsignal(), because it
-returns a string in UTF-8 encoding, and since not all platforms support
-the strsignal() function.
+Creates and initializes an instance of @type if @type is valid and
+can be instantiated. The type system only performs basic allocation
+and structure setups for instances: actual instance creation should
+happen through functions supplied by the type's fundamental type
+implementation. So use of g_type_create_instance() is reserved for
+implementators of fundamental types only. E.g. instances of the
+#GObject hierarchy should be created via g_object_new() and
+<emphasis>never</emphasis> directly through
+g_type_create_instance() which doesn't handle things like singleton
+objects or object construction. Note: Do <emphasis>not</emphasis>
+use this function, unless you're implementing a fundamental
+type. Also language bindings should <emphasis>not</emphasis> use
+this function but g_object_new() instead.
</description>
<parameters>
-<parameter name="signum">
-<parameter_description> the signal number. See the <literal>signal</literal>
-documentation
+<parameter name="type">
+<parameter_description> An instantiatable type to create an instance for.
</parameter_description>
</parameter>
</parameters>
-<return> a UTF-8 string describing the signal. If the signal is unknown,
-it returns "unknown signal (<signum>)". The string can only be
-used until the next call to g_strsignal()
+<return> An allocated and initialized instance, subject to further
+treatment by the fundamental type implementation.
</return>
</function>
-<function name="g_strsplit">
+<function name="g_type_default_interface_peek">
<description>
-Splits a string into a maximum of @max_tokens pieces, using the given
- delimiter If @max_tokens is reached, the remainder of @string is appended
-to the last token.
+If the interface type @g_type is currently in use, returns its
+default interface vtable.
-As a special case, the result of splitting the empty string "" is an empty
-vector, not a vector containing a single string. The reason for this
-special case is that being able to represent a empty vector is typically
-more useful than consistent handling of empty elements. If you do need
-to represent empty elements, you'll need to check for the empty string
-before calling g_strsplit().
+Since: 2.4
</description>
<parameters>
-<parameter name="string">
-<parameter_description> a string to split.
-</parameter_description>
-</parameter>
-<parameter name="delimiter">
-<parameter_description> a string which specifies the places at which to split the string.
-The delimiter is not included in any of the resulting strings, unless
- max_tokens is reached.
-</parameter_description>
-</parameter>
-<parameter name="max_tokens">
-<parameter_description> the maximum number of pieces to split @string into. If this is
-less than 1, the string is split completely.
+<parameter name="g_type">
+<parameter_description> an interface type
</parameter_description>
</parameter>
</parameters>
-<return> a newly-allocated %NULL-terminated array of strings. Use
-g_strfreev() to free it.
+<return> the default
+vtable for the interface, or %NULL if the type is not currently in
+use.
</return>
</function>
-<function name="g_strsplit_set">
+<function name="g_type_default_interface_ref">
<description>
-Splits @string into a number of tokens not containing any of the characters
-in @delimiter. A token is the (possibly empty) longest string that does not
-contain any of the characters in @delimiters. If @max_tokens is reached, the
-remainder is appended to the last token.
-
-For example the result of g_strsplit_set ("abc:def/ghi", ":/", -1) is a
-%NULL-terminated vector containing the three strings "abc", "def",
-and "ghi".
-
-The result if g_strsplit_set (":def/ghi:", ":/", -1) is a %NULL-terminated
-vector containing the four strings "", "def", "ghi", and "".
-
-As a special case, the result of splitting the empty string "" is an empty
-vector, not a vector containing a single string. The reason for this
-special case is that being able to represent a empty vector is typically
-more useful than consistent handling of empty elements. If you do need
-to represent empty elements, you'll need to check for the empty string
-before calling g_strsplit_set().
+Increments the reference count for the interface type @g_type,
+and returns the default interface vtable for the type.
-Note that this function works on bytes not characters, so it can't be used
-to delimit UTF-8 strings for anything but ASCII characters.
+If the type is not currently in use, then the default vtable
+for the type will be created and initalized by calling
+the base interface init and default vtable init functions for
+the type (the @<structfield>base_init</structfield>
+and <structfield>class_init</structfield> members of #GTypeInfo).
+Calling g_type_default_interface_ref() is useful when you
+want to make sure that signals and properties for an interface
+have been installed.
Since: 2.4
+
</description>
<parameters>
-<parameter name="string">
-<parameter_description> The string to be tokenized
-</parameter_description>
-</parameter>
-<parameter name="delimiters">
-<parameter_description> A nul-terminated string containing bytes that are used
-to split the string.
-</parameter_description>
-</parameter>
-<parameter name="max_tokens">
-<parameter_description> The maximum number of tokens to split @string into.
-If this is less than 1, the string is split completely
+<parameter name="g_type">
+<parameter_description> an interface type
</parameter_description>
</parameter>
</parameters>
-<return> a newly-allocated %NULL-terminated array of strings. Use
-g_strfreev() to free it.
-
+<return> the default
+vtable for the interface; call g_type_default_interface_unref()
+when you are done using the interface.
</return>
</function>
-<function name="g_strstr_len">
+<function name="g_type_default_interface_unref">
<description>
-Searches the string @haystack for the first occurrence
-of the string @needle, limiting the length of the search
-to @haystack_len.
+Decrements the reference count for the type corresponding to the
+interface default vtable @g_iface. If the type is dynamic, then
+when no one is using the interface and all references have
+been released, the finalize function for the interface's default
+vtable (the <structfield>class_finalize</structfield> member of
+#GTypeInfo) will be called.
+Since: 2.4
</description>
<parameters>
-<parameter name="haystack">
-<parameter_description> a string.
-</parameter_description>
-</parameter>
-<parameter name="haystack_len">
-<parameter_description> the maximum length of @haystack. Note that -1 is
-a valid length, if @haystack is nul-terminated, meaning it will
-search through the whole string.
+<parameter name="g_iface">
+<parameter_description> the default vtable
+structure for a interface, as returned by
+g_type_default_interface_ref()
</parameter_description>
</parameter>
-<parameter name="needle">
-<parameter_description> the string to search for.
+</parameters>
+<return></return>
+</function>
+
+<function name="g_type_depth">
+<description>
+Returns the length of the ancestry of the passed in type. This
+includes the type itself, so that e.g. a fundamental type has depth 1.
+
+
+</description>
+<parameters>
+<parameter name="type">
+<parameter_description> A #GType value.
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to the found occurrence, or
-%NULL if not found.
+<return> The depth of @type.
</return>
</function>
-<function name="g_strtod">
+<function name="g_type_free_instance">
<description>
-Converts a string to a #gdouble value.
-It calls the standard strtod() function to handle the conversion, but
-if the string is not completely converted it attempts the conversion
-again with g_ascii_strtod(), and returns the best match.
-
-This function should seldomly be used. The normal situation when reading
-numbers not for human consumption is to use g_ascii_strtod(). Only when
-you know that you must expect both locale formatted and C formatted numbers
-should you use this. Make sure that you don't pass strings such as comma
-separated lists of values, since the commas may be interpreted as a decimal
-point in some locales, causing unexpected results.
+Frees an instance of a type, returning it to the instance pool for
+the type, if there is one.
+Like g_type_create_instance(), this function is reserved for
+implementors of fundamental types.
</description>
<parameters>
-<parameter name="nptr">
-<parameter_description> the string to convert to a numeric value.
-</parameter_description>
-</parameter>
-<parameter name="endptr">
-<parameter_description> if non-%NULL, it returns the character after
-the last character used in the conversion.
+<parameter name="instance">
+<parameter_description> an instance of a type.
</parameter_description>
</parameter>
</parameters>
-<return> the #gdouble value.
-</return>
+<return></return>
</function>
-<function name="g_strup">
+<function name="g_type_from_name">
<description>
-Converts a string to upper case.
+Lookup the type ID from a given type name, returning 0 if no type
+has been registered under this name (this is the preferred method
+to find out by name whether a specific type has been registered
+yet).
-Deprecated:2.2: This function is totally broken for the reasons discussed
-in the g_strncasecmp() docs - use g_ascii_strup() or g_utf8_strup() instead.
</description>
<parameters>
-<parameter name="string">
-<parameter_description> the string to convert.
+<parameter name="name">
+<parameter_description> Type name to lookup.
</parameter_description>
</parameter>
</parameters>
-<return> the string
-
+<return> Corresponding type ID or 0.
</return>
</function>
-<function name="g_strv_length">
+<function name="g_type_fundamental">
<description>
-Returns the length of the given %NULL-terminated
-string array @str_array.
+Internal function, used to extract the fundamental type ID portion.
+use G_TYPE_FUNDAMENTAL() instead.
-Since: 2.6
</description>
<parameters>
-<parameter name="str_array">
-<parameter_description> a %NULL-terminated array of strings.
+<parameter name="type_id">
+<parameter_description> valid type ID
</parameter_description>
</parameter>
</parameters>
-<return> length of @str_array.
-
+<return> fundamental type ID
</return>
</function>
-<function name="g_test_add">
+<function name="g_type_fundamental_next">
<description>
-Hook up a new test case at @testpath, similar to g_test_add_func().
-A fixture data structure with setup and teardown function may be provided
-though, similar to g_test_create_case().
-g_test_add() is implemented as a macro, so that the fsetup(), ftest() and
-fteardown() callbacks can expect a @Fixture pointer as first argument in
-a type safe manner.
+Returns the next free fundamental type id which can be used to
+register a new fundamental type with g_type_register_fundamental().
+The returned type ID represents the highest currently registered
+fundamental type identifier.
-Since: 2.16
</description>
<parameters>
-<parameter name="testpath">
-<parameter_description> The test path for a new test case.
-</parameter_description>
-</parameter>
-<parameter name="Fixture">
-<parameter_description> The type of a fixture data structure.
-</parameter_description>
-</parameter>
-<parameter name="tdata">
-<parameter_description> Data argument for the test functions.
-</parameter_description>
-</parameter>
-<parameter name="fsetup">
-<parameter_description> The function to set up the fixture data.
-</parameter_description>
-</parameter>
-<parameter name="ftest">
-<parameter_description> The actual test function.
-</parameter_description>
-</parameter>
-<parameter name="fteardown">
-<parameter_description> The function to tear down the fixture data.
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> The nextmost fundamental type ID to be registered,
+or 0 if the type system ran out of fundamental type IDs.
+</return>
</function>
-<function name="g_test_add_data_func">
+<function name="g_type_get_plugin">
<description>
-Create a new test case, similar to g_test_create_case(). However
-the test is assumed to use no fixture, and test suites are automatically
-created on the fly and added to the root fixture, based on the
-slash-separated portions of @testpath. The @test_data argument
-will be passed as first argument to @test_func.
+Returns the #GTypePlugin structure for @type or
+%NULL if @type does not have a #GTypePlugin structure.
-Since: 2.16
</description>
<parameters>
-<parameter name="testpath">
-<parameter_description> Slash-separated test case path name for the test.
-</parameter_description>
-</parameter>
-<parameter name="test_data">
-<parameter_description> Test data argument for the test function.
-</parameter_description>
-</parameter>
-<parameter name="test_func">
-<parameter_description> The test function to invoke for this test.
+<parameter name="type">
+<parameter_description> The #GType to retrieve the plugin for.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The corresponding plugin if @type is a
+dynamic type, %NULL otherwise.
+</return>
</function>
-<function name="g_test_add_func">
+<function name="g_type_get_qdata">
<description>
-Create a new test case, similar to g_test_create_case(). However
-the test is assumed to use no fixture, and test suites are automatically
-created on the fly and added to the root fixture, based on the
-slash-separated portions of @testpath.
+Obtains data which has previously been attached to @type
+with g_type_set_qdata().
+
+Note that this does not take subtyping into account; data
+attached to one type with g_type_set_qdata() cannot
+be retrieved from a subtype using g_type_get_qdata().
-Since: 2.16
</description>
<parameters>
-<parameter name="testpath">
-<parameter_description> Slash-separated test case path name for the test.
+<parameter name="type">
+<parameter_description> a #GType
</parameter_description>
</parameter>
-<parameter name="test_func">
-<parameter_description> The test function to invoke for this test.
+<parameter name="quark">
+<parameter_description> a #GQuark id to identify the data
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the data, or %NULL if no data was found
+</return>
</function>
-<function name="g_test_bug">
+<function name="g_type_init">
<description>
-This function adds a message to test reports that
-associates a bug URI with a test case.
-Bug URIs are constructed from a base URI set with g_test_bug_base()
-and @bug_uri_snippet.
+Prior to any use of the type system, g_type_init() has to be called
+to initialize the type system and assorted other code portions
+(such as the various fundamental type implementations or the signal
+system).
-Since: 2.16
+Since version 2.24 this also initializes the thread system
</description>
<parameters>
-<parameter name="bug_uri_snippet">
-<parameter_description> Bug specific bug tracker URI portion.
-</parameter_description>
-</parameter>
</parameters>
<return></return>
</function>
-<function name="g_test_bug_base">
+<function name="g_type_init_with_debug_flags">
<description>
-Specify the base URI for bug reports.
-
-The base URI is used to construct bug report messages for
-g_test_message() when g_test_bug() is called.
-Calling this function outside of a test case sets the
-default base URI for all test cases. Calling it from within
-a test case changes the base URI for the scope of the test
-case only.
-Bug URIs are constructed by appending a bug specific URI
-portion to @uri_pattern, or by replacing the special string
-'%s' within @uri_pattern if that is present.
-
-Since: 2.16
+Similar to g_type_init(), but additionally sets debug flags.
</description>
<parameters>
-<parameter name="uri_pattern">
-<parameter_description> the base pattern for bug URIs
+<parameter name="debug_flags">
+<parameter_description> Bitwise combination of #GTypeDebugFlags values for
+debugging purposes.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_test_create_case">
+<function name="g_type_interface_add_prerequisite">
<description>
-Create a new #GTestCase, named @test_name, this API is fairly
-low level, calling g_test_add() or g_test_add_func() is preferable.
-When this test is executed, a fixture structure of size @data_size
-will be allocated and filled with 0s. Then data_setup() is called
-to initialize the fixture. After fixture setup, the actual test
-function data_test() is called. Once the test run completed, the
-fixture structure is torn down by calling data_teardown() and
-after that the memory is released.
-
-Splitting up a test run into fixture setup, test function and
-fixture teardown is most usful if the same fixture is used for
-multiple tests. In this cases, g_test_create_case() will be
-called with the same fixture, but varying @test_name and
- data_test arguments.
-
-Since: 2.16
+Adds @prerequisite_type to the list of prerequisites of @interface_type.
+This means that any type implementing @interface_type must also implement
+ prerequisite_type Prerequisites can be thought of as an alternative to
+interface derivation (which GType doesn't support). An interface can have
+at most one instantiatable prerequisite type.
</description>
<parameters>
-<parameter name="test_name">
-<parameter_description> the name for the test case
-</parameter_description>
-</parameter>
-<parameter name="data_size">
-<parameter_description> the size of the fixture data structure
-</parameter_description>
-</parameter>
-<parameter name="test_data">
-<parameter_description> test data argument for the test functions
-</parameter_description>
-</parameter>
-<parameter name="data_setup">
-<parameter_description> the function to set up the fixture data
-</parameter_description>
-</parameter>
-<parameter name="data_test">
-<parameter_description> the actual test function
+<parameter name="interface_type">
+<parameter_description> #GType value of an interface type.
</parameter_description>
</parameter>
-<parameter name="data_teardown">
-<parameter_description> the function to teardown the fixture data
+<parameter name="prerequisite_type">
+<parameter_description> #GType value of an interface or instantiatable type.
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated #GTestCase.
-
-</return>
+<return></return>
</function>
-<function name="g_test_create_suite">
+<function name="g_type_interface_get_plugin">
<description>
-Create a new test suite with the name @suite_name.
+Returns the #GTypePlugin structure for the dynamic interface
+ interface_type which has been added to @instance_type, or %NULL if
+ interface_type has not been added to @instance_type or does not
+have a #GTypePlugin structure. See g_type_add_interface_dynamic().
-Since: 2.16
</description>
<parameters>
-<parameter name="suite_name">
-<parameter_description> a name for the suite
+<parameter name="instance_type">
+<parameter_description> the #GType value of an instantiatable type.
+</parameter_description>
+</parameter>
+<parameter name="interface_type">
+<parameter_description> the #GType value of an interface type.
</parameter_description>
</parameter>
</parameters>
-<return> A newly allocated #GTestSuite instance.
-
+<return> the #GTypePlugin for the dynamic
+interface @interface_type of @instance_type.
</return>
</function>
-<function name="g_test_get_root">
+<function name="g_type_interface_peek">
<description>
-Get the toplevel test suite for the test path API.
+Returns the #GTypeInterface structure of an interface to which the
+passed in class conforms.
-Since: 2.16
</description>
<parameters>
+<parameter name="instance_class">
+<parameter_description> A #GTypeClass structure.
+</parameter_description>
+</parameter>
+<parameter name="iface_type">
+<parameter_description> An interface ID which this class conforms to.
+</parameter_description>
+</parameter>
</parameters>
-<return> the toplevel #GTestSuite
-
+<return> The GTypeInterface
+structure of iface_type if implemented by @instance_class, %NULL
+otherwise
</return>
</function>
-<function name="g_test_init">
+<function name="g_type_interface_peek_parent">
<description>
-Initialize the GLib testing framework, e.g. by seeding the
-test random number generator, the name for g_get_prgname()
-and parsing test related command line args.
-So far, the following arguments are understood:
-<variablelist>
-<varlistentry>
-<term><option>-l</option></term>
-<listitem><para>
-list test cases available in a test executable.
-</para></listitem>
-</varlistentry>
-<varlistentry>
-<term><option>--seed=<replaceable>RANDOMSEED</replaceable></option></term>
-<listitem><para>
-provide a random seed to reproduce test runs using random numbers.
-</para></listitem>
-</varlistentry>
-<varlistentry>
-<term><option>--verbose</option></term>
-<listitem><para>run tests verbosely.</para></listitem>
-</varlistentry>
-<varlistentry>
-<term><option>-q</option>, <option>--quiet</option></term>
-<listitem><para>run tests quietly.</para></listitem>
-</varlistentry>
-<varlistentry>
-<term><option>-p <replaceable>TESTPATH</replaceable></option></term>
-<listitem><para>
-execute all tests matching <replaceable>TESTPATH</replaceable>.
-</para></listitem>
-</varlistentry>
-<varlistentry>
-<term><option>-m {perf|slow|thorough|quick}</option></term>
-<listitem><para>
-execute tests according to these test modes:
-<variablelist>
-<varlistentry>
-<term>perf</term>
-<listitem><para>
-performance tests, may take long and report results.
-</para></listitem>
-</varlistentry>
-<varlistentry>
-<term>slow, thorough</term>
-<listitem><para>
-slow and thorough tests, may take quite long and
-maximize coverage.
-</para></listitem>
-</varlistentry>
-<varlistentry>
-<term>quick</term>
-<listitem><para>
-quick tests, should run really quickly and give good coverage.
-</para></listitem>
-</varlistentry>
-</variablelist>
-</para></listitem>
-</varlistentry>
-<varlistentry>
-<term><option>--debug-log</option></term>
-<listitem><para>debug test logging output.</para></listitem>
-</varlistentry>
-<varlistentry>
-<term><option>-k</option>, <option>--keep-going</option></term>
-<listitem><para>gtester-specific argument.</para></listitem>
-</varlistentry>
-<varlistentry>
-<term><option>--GTestLogFD <replaceable>N</replaceable></option></term>
-<listitem><para>gtester-specific argument.</para></listitem>
-</varlistentry>
-<varlistentry>
-<term><option>--GTestSkipCount <replaceable>N</replaceable></option></term>
-<listitem><para>gtester-specific argument.</para></listitem>
-</varlistentry>
-</variablelist>
+Returns the corresponding #GTypeInterface structure of the parent type
+of the instance type to which @g_iface belongs. This is useful when
+deriving the implementation of an interface from the parent type and
+then possibly overriding some methods.
-Since: 2.16
</description>
<parameters>
-<parameter name="argc">
-<parameter_description> Address of the @argc parameter of the main() function.
-Changed if any arguments were handled.
-</parameter_description>
-</parameter>
-<parameter name="argv">
-<parameter_description> Address of the @argv parameter of main().
-Any parameters understood by g_test_init() stripped before return.
-</parameter_description>
-</parameter>
-<parameter name="Varargs">
-<parameter_description> Reserved for future extension. Currently, you must pass %NULL.
+<parameter name="g_iface">
+<parameter_description> A #GTypeInterface structure.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The
+corresponding #GTypeInterface structure of the parent type of the
+instance type to which @g_iface belongs, or %NULL if the parent
+type doesn't conform to the interface.
+</return>
</function>
-<function name="g_test_log_buffer_free">
+<function name="g_type_interface_prerequisites">
<description>
-Internal function for gtester to free test log messages, no ABI guarantees provided.
+Returns the prerequisites of an interfaces type.
-</description>
-<parameters>
-</parameters>
-<return></return>
-</function>
+Since: 2.2
-<function name="g_test_log_buffer_new">
-<description>
-Internal function for gtester to decode test log messages, no ABI guarantees provided.
</description>
<parameters>
+<parameter name="interface_type">
+<parameter_description> an interface type
+</parameter_description>
+</parameter>
+<parameter name="n_prerequisites">
+<parameter_description> location to return the number
+of prerequisites, or %NULL
+</parameter_description>
+</parameter>
</parameters>
-<return></return>
+<return> a
+newly-allocated zero-terminated array of #GType containing
+the prerequisites of @interface_type
+</return>
</function>
-<function name="g_test_log_buffer_pop">
+<function name="g_type_interfaces">
<description>
-Internal function for gtester to retrieve test log messages, no ABI guarantees provided.
+Return a newly allocated and 0-terminated array of type IDs, listing the
+interface types that @type conforms to. The return value has to be
+g_free()ed after use.
+
</description>
<parameters>
+<parameter name="type">
+<parameter_description> The type to list interface types for.
+</parameter_description>
+</parameter>
+<parameter name="n_interfaces">
+<parameter_description> Optional #guint pointer to
+contain the number of interface types.
+</parameter_description>
+</parameter>
</parameters>
-<return></return>
+<return> Newly
+allocated and 0-terminated array of interface types.
+</return>
</function>
-<function name="g_test_log_buffer_push">
+<function name="g_type_is_a">
<description>
-Internal function for gtester to decode test log messages, no ABI guarantees provided.
+If @is_a_type is a derivable type, check whether @type is a
+descendant of @is_a_type. If @is_a_type is an interface, check
+whether @type conforms to it.
+
</description>
<parameters>
+<parameter name="type">
+<parameter_description> Type to check anchestry for.
+</parameter_description>
+</parameter>
+<parameter name="is_a_type">
+<parameter_description> Possible anchestor of @type or interface @type could conform to.
+</parameter_description>
+</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @type is_a @is_a_type holds true.
+</return>
</function>
-<function name="g_test_log_msg_free">
+<function name="g_type_module_add_interface">
<description>
-Internal function for gtester to free test log messages, no ABI guarantees provided.
+Registers an additional interface for a type, whose interface lives
+in the given type plugin. If the interface was already registered
+for the type in this plugin, nothing will be done.
+
+As long as any instances of the type exist, the type plugin will
+not be unloaded.
</description>
<parameters>
+<parameter name="module">
+<parameter_description> a #GTypeModule
+</parameter_description>
+</parameter>
+<parameter name="instance_type">
+<parameter_description> type to which to add the interface.
+</parameter_description>
+</parameter>
+<parameter name="interface_type">
+<parameter_description> interface type to add
+</parameter_description>
+</parameter>
+<parameter name="interface_info">
+<parameter_description> type information structure
+</parameter_description>
+</parameter>
</parameters>
<return></return>
</function>
-<function name="g_test_log_set_fatal_handler">
+<function name="g_type_module_register_enum">
<description>
-Installs a non-error fatal log handler which can be
-used to decide whether log messages which are counted
-as fatal abort the program.
-
-The use case here is that you are running a test case
-that depends on particular libraries or circumstances
-and cannot prevent certain known critical or warning
-messages. So you install a handler that compares the
-domain and message to precisely not abort in such a case.
+Looks up or registers an enumeration that is implemented with a particular
+type plugin. If a type with name @type_name was previously registered,
+the #GType identifier for the type is returned, otherwise the type
+is newly registered, and the resulting #GType identifier returned.
-Note that the handler is reset at the beginning of
-any test case, so you have to set it inside each test
-function which needs the special behavior.
+As long as any instances of the type exist, the type plugin will
+not be unloaded.
-This handler has no effect on g_error messages.
+Since: 2.6
-Since: 2.22
</description>
<parameters>
-<parameter name="log_func">
-<parameter_description> the log handler function.
+<parameter name="module">
+<parameter_description> a #GTypeModule
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> data passed to the log handler.
+<parameter name="name">
+<parameter_description> name for the type
+</parameter_description>
+</parameter>
+<parameter name="const_static_values">
+<parameter_description> an array of #GEnumValue structs for the
+possible enumeration values. The array is
+terminated by a struct with all members being
+0.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the new or existing type ID
+</return>
</function>
-<function name="g_test_maximized_result">
+<function name="g_type_module_register_flags">
<description>
-Report the result of a performance or measurement test.
-The test should generally strive to maximize the reported
-quantities (larger values are better than smaller ones),
-this and @maximized_quantity can determine sorting
-order for test result reports.
+Looks up or registers a flags type that is implemented with a particular
+type plugin. If a type with name @type_name was previously registered,
+the #GType identifier for the type is returned, otherwise the type
+is newly registered, and the resulting #GType identifier returned.
+
+As long as any instances of the type exist, the type plugin will
+not be unloaded.
+
+Since: 2.6
-Since: 2.16
</description>
<parameters>
-<parameter name="maximized_quantity">
-<parameter_description> the reported value
+<parameter name="module">
+<parameter_description> a #GTypeModule
</parameter_description>
</parameter>
-<parameter name="format">
-<parameter_description> the format string of the report message
+<parameter name="name">
+<parameter_description> name for the type
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> arguments to pass to the printf() function
+<parameter name="const_static_values">
+<parameter_description> an array of #GFlagsValue structs for the
+possible flags values. The array is
+terminated by a struct with all members being
+0.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the new or existing type ID
+</return>
</function>
-<function name="g_test_message">
+<function name="g_type_module_register_type">
<description>
-Add a message to the test report.
+Looks up or registers a type that is implemented with a particular
+type plugin. If a type with name @type_name was previously registered,
+the #GType identifier for the type is returned, otherwise the type
+is newly registered, and the resulting #GType identifier returned.
+
+When reregistering a type (typically because a module is unloaded
+then reloaded, and reinitialized), @module and @parent_type must
+be the same as they were previously.
+
+As long as any instances of the type exist, the type plugin will
+not be unloaded.
-Since: 2.16
</description>
<parameters>
-<parameter name="format">
-<parameter_description> the format string
+<parameter name="module">
+<parameter_description> a #GTypeModule
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> printf-like arguments to @format
+<parameter name="parent_type">
+<parameter_description> the type for the parent class
+</parameter_description>
+</parameter>
+<parameter name="type_name">
+<parameter_description> name for the type
+</parameter_description>
+</parameter>
+<parameter name="type_info">
+<parameter_description> type information structure
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> flags field providing details about the type
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the new or existing type ID
+</return>
</function>
-<function name="g_test_minimized_result">
+<function name="g_type_module_set_name">
<description>
-Report the result of a performance or measurement test.
-The test should generally strive to minimize the reported
-quantities (smaller values are better than larger ones),
-this and @minimized_quantity can determine sorting
-order for test result reports.
-
-Since: 2.16
+Sets the name for a #GTypeModule
</description>
<parameters>
-<parameter name="minimized_quantity">
-<parameter_description> the reported value
-</parameter_description>
-</parameter>
-<parameter name="format">
-<parameter_description> the format string of the report message
+<parameter name="module">
+<parameter_description> a #GTypeModule.
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> arguments to pass to the printf() function
+<parameter name="name">
+<parameter_description> a human-readable name to use in error messages.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_test_queue_destroy">
+<function name="g_type_module_unuse">
<description>
-This function enqueus a callback @destroy_func() to be executed
-during the next test case teardown phase. This is most useful
-to auto destruct allocted test resources at the end of a test run.
-Resources are released in reverse queue order, that means enqueueing
-callback A before callback B will cause B() to be called before
-A() during teardown.
-
-Since: 2.16
+Decreases the use count of a #GTypeModule by one. If the
+result is zero, the module will be unloaded. (However, the
+#GTypeModule will not be freed, and types associated with the
+#GTypeModule are not unregistered. Once a #GTypeModule is
+initialized, it must exist forever.)
</description>
<parameters>
-<parameter name="destroy_func">
-<parameter_description> Destroy callback for teardown phase.
-</parameter_description>
-</parameter>
-<parameter name="destroy_data">
-<parameter_description> Destroy callback data.
+<parameter name="module">
+<parameter_description> a #GTypeModule
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_test_queue_free">
+<function name="g_type_module_use">
<description>
-Enqueue a pointer to be released with g_free() during the next
-teardown phase. This is equivalent to calling g_test_queue_destroy()
-with a destroy callback of g_free().
+Increases the use count of a #GTypeModule by one. If the
+use count was zero before, the plugin will be loaded.
+If loading the plugin fails, the use count is reset to
+its prior value.
-Since: 2.16
</description>
<parameters>
-<parameter name="gfree_pointer">
-<parameter_description> the pointer to be stored.
+<parameter name="module">
+<parameter_description> a #GTypeModule
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %FALSE if the plugin needed to be loaded and
+loading the plugin failed.
+</return>
</function>
-<function name="g_test_rand_double">
+<function name="g_type_name">
<description>
-Get a reproducible random floating point number,
-see g_test_rand_int() for details on test case random numbers.
+Get the unique name that is assigned to a type ID. Note that this
+function (like all other GType API) cannot cope with invalid type
+IDs. %G_TYPE_INVALID may be passed to this function, as may be any
+other validly registered type ID, but randomized type IDs should
+not be passed in and will most likely lead to a crash.
-Since: 2.16
</description>
<parameters>
+<parameter name="type">
+<parameter_description> Type to return name for.
+</parameter_description>
+</parameter>
</parameters>
-<return> a random number from the seeded random number generator.
-
+<return> Static type name or %NULL.
</return>
</function>
-<function name="g_test_rand_double_range">
+<function name="g_type_next_base">
<description>
-Get a reproducible random floating pointer number out of a specified range,
-see g_test_rand_int() for details on test case random numbers.
+Given a @leaf_type and a @root_type which is contained in its
+anchestry, return the type that @root_type is the immediate parent
+of. In other words, this function determines the type that is
+derived directly from @root_type which is also a base class of
+ leaf_type Given a root type and a leaf type, this function can
+be used to determine the types and order in which the leaf type is
+descended from the root type.
-Since: 2.16
</description>
<parameters>
-<parameter name="range_start">
-<parameter_description> the minimum value returned by this function
+<parameter name="leaf_type">
+<parameter_description> Descendant of @root_type and the type to be returned.
</parameter_description>
</parameter>
-<parameter name="range_end">
-<parameter_description> the minimum value not returned by this function
+<parameter name="root_type">
+<parameter_description> Immediate parent of the returned type.
</parameter_description>
</parameter>
</parameters>
-<return> a number with @range_start <= number < @range_end.
-
+<return> Immediate child of @root_type and anchestor of @leaf_type.
</return>
</function>
-<function name="g_test_rand_int">
+<function name="g_type_parent">
<description>
-Get a reproducible random integer number.
-
-The random numbers generated by the g_test_rand_*() family of functions
-change with every new test program start, unless the --seed option is
-given when starting test programs.
-
-For individual test cases however, the random number generator is
-reseeded, to avoid dependencies between tests and to make --seed
-effective for all test cases.
+Return the direct parent type of the passed in type. If the passed
+in type has no parent, i.e. is a fundamental type, 0 is returned.
-Since: 2.16
</description>
<parameters>
+<parameter name="type">
+<parameter_description> The derived type.
+</parameter_description>
+</parameter>
</parameters>
-<return> a random number from the seeded random number generator.
-
+<return> The parent type.
</return>
</function>
-<function name="g_test_rand_int_range">
+<function name="g_type_plugin_complete_interface_info">
<description>
-Get a reproducible random integer number out of a specified range,
-see g_test_rand_int() for details on test case random numbers.
-
-Since: 2.16
+Calls the @complete_interface_info function from the
+#GTypePluginClass of @plugin. There should be no need to use this
+function outside of the GObject type system itself.
</description>
<parameters>
-<parameter name="begin">
-<parameter_description> the minimum value returned by this function
+<parameter name="plugin">
+<parameter_description> the #GTypePlugin
</parameter_description>
</parameter>
-<parameter name="end">
-<parameter_description> the smallest value not to be returned by this function
+<parameter name="instance_type">
+<parameter_description> the #GType of an instantiable type to which the interface
+is added
+</parameter_description>
+</parameter>
+<parameter name="interface_type">
+<parameter_description> the #GType of the interface whose info is completed
+</parameter_description>
+</parameter>
+<parameter name="info">
+<parameter_description> the #GInterfaceInfo to fill in
</parameter_description>
</parameter>
</parameters>
-<return> a number with @begin <= number < @end.
-
-</return>
+<return></return>
</function>
-<function name="g_test_run">
+<function name="g_type_plugin_complete_type_info">
<description>
-Runs all tests under the toplevel suite which can be retrieved
-with g_test_get_root(). Similar to g_test_run_suite(), the test
-cases to be run are filtered according to
-test path arguments (-p <replaceable>testpath</replaceable>) as
-parsed by g_test_init().
-g_test_run_suite() or g_test_run() may only be called once
-in a program.
+Calls the @complete_type_info function from the #GTypePluginClass of @plugin.
+There should be no need to use this function outside of the GObject
+type system itself.
-Since: 2.16
+</description>
+<parameters>
+<parameter name="plugin">
+<parameter_description> a #GTypePlugin
+</parameter_description>
+</parameter>
+<parameter name="g_type">
+<parameter_description> the #GType whose info is completed
+</parameter_description>
+</parameter>
+<parameter name="info">
+<parameter_description> the #GTypeInfo struct to fill in
+</parameter_description>
+</parameter>
+<parameter name="value_table">
+<parameter_description> the #GTypeValueTable to fill in
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="g_type_plugin_unuse">
+<description>
+Calls the @unuse_plugin function from the #GTypePluginClass of
+ plugin There should be no need to use this function outside of
+the GObject type system itself.
</description>
<parameters>
+<parameter name="plugin">
+<parameter_description> a #GTypePlugin
+</parameter_description>
+</parameter>
</parameters>
-<return> 0 on success
+<return></return>
+</function>
-</return>
+<function name="g_type_plugin_use">
+<description>
+Calls the @use_plugin function from the #GTypePluginClass of
+ plugin There should be no need to use this function outside of
+the GObject type system itself.
+
+</description>
+<parameters>
+<parameter name="plugin">
+<parameter_description> a #GTypePlugin
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="g_test_run_suite">
+<function name="g_type_qname">
<description>
-Execute the tests within @suite and all nested #GTestSuites.
-The test suites to be executed are filtered according to
-test path arguments (-p <replaceable>testpath</replaceable>)
-as parsed by g_test_init().
-g_test_run_suite() or g_test_run() may only be called once
-in a program.
+Get the corresponding quark of the type IDs name.
-Since: 2.16
</description>
<parameters>
-<parameter name="suite">
-<parameter_description> a #GTestSuite
+<parameter name="type">
+<parameter_description> Type to return quark of type name for.
</parameter_description>
</parameter>
</parameters>
-<return> 0 on success
-
+<return> The type names quark or 0.
</return>
</function>
-<function name="g_test_suite_add">
+<function name="g_type_query">
<description>
-Adds @test_case to @suite.
-
-Since: 2.16
+Queries the type system for information about a specific type.
+This function will fill in a user-provided structure to hold
+type-specific information. If an invalid #GType is passed in, the
+ type member of the #GTypeQuery is 0. All members filled into the
+#GTypeQuery structure should be considered constant and have to be
+left untouched.
</description>
<parameters>
-<parameter name="suite">
-<parameter_description> a #GTestSuite
+<parameter name="type">
+<parameter_description> the #GType value of a static, classed type.
</parameter_description>
</parameter>
-<parameter name="test_case">
-<parameter_description> a #GTestCase
+<parameter name="query">
+<parameter_description> A user provided structure that is
+filled in with constant values upon success.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_test_suite_add_suite">
+<function name="g_type_register_dynamic">
<description>
-Adds @nestedsuite to @suite.
+Registers @type_name as the name of a new dynamic type derived from
+ parent_type The type system uses the information contained in the
+#GTypePlugin structure pointed to by @plugin to manage the type and its
+instances (if not abstract). The value of @flags determines the nature
+(e.g. abstract or not) of the type.
-Since: 2.16
</description>
<parameters>
-<parameter name="suite">
-<parameter_description> a #GTestSuite
+<parameter name="parent_type">
+<parameter_description> Type from which this type will be derived.
</parameter_description>
</parameter>
-<parameter name="nestedsuite">
-<parameter_description> another #GTestSuite
+<parameter name="type_name">
+<parameter_description> 0-terminated string used as the name of the new type.
+</parameter_description>
+</parameter>
+<parameter name="plugin">
+<parameter_description> The #GTypePlugin structure to retrieve the #GTypeInfo from.
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> Bitwise combination of #GTypeFlags values.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The new type identifier or #G_TYPE_INVALID if registration failed.
+</return>
</function>
-<function name="g_test_timer_elapsed">
+<function name="g_type_register_fundamental">
<description>
-Get the time since the last start of the timer with g_test_timer_start().
+Registers @type_id as the predefined identifier and @type_name as the
+name of a fundamental type. The type system uses the information
+contained in the #GTypeInfo structure pointed to by @info and the
+#GTypeFundamentalInfo structure pointed to by @finfo to manage the
+type and its instances. The value of @flags determines additional
+characteristics of the fundamental type.
-Since: 2.16
</description>
<parameters>
+<parameter name="type_id">
+<parameter_description> A predefined type identifier.
+</parameter_description>
+</parameter>
+<parameter name="type_name">
+<parameter_description> 0-terminated string used as the name of the new type.
+</parameter_description>
+</parameter>
+<parameter name="info">
+<parameter_description> The #GTypeInfo structure for this type.
+</parameter_description>
+</parameter>
+<parameter name="finfo">
+<parameter_description> The #GTypeFundamentalInfo structure for this type.
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> Bitwise combination of #GTypeFlags values.
+</parameter_description>
+</parameter>
</parameters>
-<return> the time since the last start of the timer, as a double
-
+<return> The predefined type identifier.
</return>
</function>
-<function name="g_test_timer_last">
+<function name="g_type_register_static">
<description>
-Report the last result of g_test_timer_elapsed().
+Registers @type_name as the name of a new static type derived from
+ parent_type The type system uses the information contained in the
+#GTypeInfo structure pointed to by @info to manage the type and its
+instances (if not abstract). The value of @flags determines the nature
+(e.g. abstract or not) of the type.
-Since: 2.16
</description>
<parameters>
+<parameter name="parent_type">
+<parameter_description> Type from which this type will be derived.
+</parameter_description>
+</parameter>
+<parameter name="type_name">
+<parameter_description> 0-terminated string used as the name of the new type.
+</parameter_description>
+</parameter>
+<parameter name="info">
+<parameter_description> The #GTypeInfo structure for this type.
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> Bitwise combination of #GTypeFlags values.
+</parameter_description>
+</parameter>
</parameters>
-<return> the last result of g_test_timer_elapsed(), as a double
-
+<return> The new type identifier.
</return>
</function>
-<function name="g_test_timer_start">
+<function name="g_type_register_static_simple">
<description>
-Start a timing test. Call g_test_timer_elapsed() when the task is supposed
-to be done. Call this function again to restart the timer.
+Registers @type_name as the name of a new static type derived from
+ parent_type The value of @flags determines the nature (e.g.
+abstract or not) of the type. It works by filling a #GTypeInfo
+struct and calling g_type_register_static().
+
+Since: 2.12
-Since: 2.16
</description>
<parameters>
+<parameter name="parent_type">
+<parameter_description> Type from which this type will be derived.
+</parameter_description>
+</parameter>
+<parameter name="type_name">
+<parameter_description> 0-terminated string used as the name of the new type.
+</parameter_description>
+</parameter>
+<parameter name="class_size">
+<parameter_description> Size of the class structure (see #GTypeInfo)
+</parameter_description>
+</parameter>
+<parameter name="class_init">
+<parameter_description> Location of the class initialization function (see #GTypeInfo)
+</parameter_description>
+</parameter>
+<parameter name="instance_size">
+<parameter_description> Size of the instance structure (see #GTypeInfo)
+</parameter_description>
+</parameter>
+<parameter name="instance_init">
+<parameter_description> Location of the instance initialization function (see #GTypeInfo)
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> Bitwise combination of #GTypeFlags values.
+</parameter_description>
+</parameter>
</parameters>
-<return></return>
+<return> The new type identifier.
+</return>
</function>
-<function name="g_test_trap_fork">
+<function name="g_type_remove_class_cache_func">
<description>
-Fork the current test program to execute a test case that might
-not return or that might abort. The forked test case is aborted
-and considered failing if its run time exceeds @usec_timeout.
-
-The forking behavior can be configured with the #GTestTrapFlags flags.
-
-In the following example, the test code forks, the forked child
-process produces some sample output and exits successfully.
-The forking parent process then asserts successful child program
-termination and validates child program outputs.
+Removes a previously installed #GTypeClassCacheFunc. The cache
+maintained by @cache_func has to be empty when calling
+g_type_remove_class_cache_func() to avoid leaks.
-|[
-static void
-test_fork_patterns (void)
-{
-if (g_test_trap_fork (0, G_TEST_TRAP_SILENCE_STDOUT | G_TEST_TRAP_SILENCE_STDERR))
-{
-g_print ("some stdout text: somagic17\n");
-g_printerr ("some stderr text: semagic43\n");
-exit (0); / * successful test run * /
-}
-g_test_trap_assert_passed();
-g_test_trap_assert_stdout ("*somagic17*");
-g_test_trap_assert_stderr ("*semagic43*");
-}
-]|
+</description>
+<parameters>
+<parameter name="cache_data">
+<parameter_description> data that was given when adding @cache_func
+</parameter_description>
+</parameter>
+<parameter name="cache_func">
+<parameter_description> a #GTypeClassCacheFunc
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
-This function is implemented only on Unix platforms.
+<function name="g_type_remove_interface_check">
+<description>
+Removes an interface check function added with
+g_type_add_interface_check().
-Since: 2.16
+Since: 2.4
</description>
<parameters>
-<parameter name="usec_timeout">
-<parameter_description> Timeout for the forked test in micro seconds.
+<parameter name="check_data">
+<parameter_description> callback data passed to g_type_add_interface_check()
</parameter_description>
</parameter>
-<parameter name="test_trap_flags">
-<parameter_description> Flags to modify forking behaviour.
+<parameter name="check_func">
+<parameter_description> callback function passed to g_type_add_interface_check()
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE for the forked child and %FALSE for the executing parent process.
-
-</return>
+<return></return>
</function>
-<function name="g_test_trap_has_passed">
+<function name="g_type_set_qdata">
<description>
-Check the result of the last g_test_trap_fork() call.
-
-Since: 2.16
+Attaches arbitrary data to a type.
</description>
<parameters>
+<parameter name="type">
+<parameter_description> a #GType
+</parameter_description>
+</parameter>
+<parameter name="quark">
+<parameter_description> a #GQuark id to identify the data
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> the data
+</parameter_description>
+</parameter>
</parameters>
-<return> %TRUE if the last forked child terminated successfully.
-
-</return>
+<return></return>
</function>
-<function name="g_test_trap_reached_timeout">
+<function name="g_type_value_table_peek">
<description>
-Check the result of the last g_test_trap_fork() call.
+Returns the location of the #GTypeValueTable associated with @type.
+<emphasis>Note that this function should only be used from source code
+that implements or has internal knowledge of the implementation of
+ type </emphasis>
-Since: 2.16
</description>
<parameters>
+<parameter name="type">
+<parameter_description> A #GType value.
+</parameter_description>
+</parameter>
</parameters>
-<return> %TRUE if the last forked child got killed due to a fork timeout.
-
+<return> Location of the #GTypeValueTable associated with @type or
+%NULL if there is no #GTypeValueTable associated with @type.
</return>
</function>
-<function name="g_thread_create">
+<function name="g_ucs4_to_utf16">
<description>
-This function creates a new thread with the default priority.
-
-If @joinable is %TRUE, you can wait for this threads termination
-calling g_thread_join(). Otherwise the thread will just disappear
-when it terminates.
-
-The new thread executes the function @func with the argument @data.
-If the thread was created successfully, it is returned.
+Convert a string from UCS-4 to UTF-16. A 0 character will be
+added to the result after the converted text.
- error can be %NULL to ignore errors, or non-%NULL to report errors.
-The error is set, if and only if the function returns %NULL.
</description>
<parameters>
-<parameter name="func">
-<parameter_description> a function to execute in the new thread.
+<parameter name="str">
+<parameter_description> a UCS-4 encoded string
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> an argument to supply to the new thread.
+<parameter name="len">
+<parameter_description> the maximum length (number of characters) of @str to use.
+If @len < 0, then the string is nul-terminated.
</parameter_description>
</parameter>
-<parameter name="joinable">
-<parameter_description> should this thread be joinable?
+<parameter name="items_read">
+<parameter_description> location to store number of bytes read, or %NULL.
+If an error occurs then the index of the invalid input
+is stored here.
+</parameter_description>
+</parameter>
+<parameter name="items_written">
+<parameter_description> location to store number of <type>gunichar2</type>
+written, or %NULL. The value stored here does not
+include the trailing 0.
</parameter_description>
</parameter>
<parameter name="error">
-<parameter_description> return location for error.
+<parameter_description> location to store the error occuring, or %NULL to ignore
+errors. Any of the errors in #GConvertError other than
+%G_CONVERT_ERROR_NO_CONVERSION may occur.
</parameter_description>
</parameter>
</parameters>
-<return> the new #GThread on success.
+<return> a pointer to a newly allocated UTF-16 string.
+This value must be freed with g_free(). If an
+error occurs, %NULL will be returned and
+ error set.
</return>
</function>
-<function name="g_thread_create_full">
+<function name="g_ucs4_to_utf8">
<description>
-This function creates a new thread with the priority @priority. If
-the underlying thread implementation supports it, the thread gets a
-stack size of @stack_size or the default value for the current
-platform, if @stack_size is 0.
-
-If @joinable is %TRUE, you can wait for this threads termination
-calling g_thread_join(). Otherwise the thread will just disappear
-when it terminates. If @bound is %TRUE, this thread will be
-scheduled in the system scope, otherwise the implementation is free
-to do scheduling in the process scope. The first variant is more
-expensive resource-wise, but generally faster. On some systems (e.g.
-Linux) all threads are bound.
-
-The new thread executes the function @func with the argument @data.
-If the thread was created successfully, it is returned.
-
- error can be %NULL to ignore errors, or non-%NULL to report errors.
-The error is set, if and only if the function returns %NULL.
-
-<note><para>It is not guaranteed that threads with different priorities
-really behave accordingly. On some systems (e.g. Linux) there are no
-thread priorities. On other systems (e.g. Solaris) there doesn't
-seem to be different scheduling for different priorities. All in all
-try to avoid being dependent on priorities. Use
-%G_THREAD_PRIORITY_NORMAL here as a default.</para></note>
+Convert a string from a 32-bit fixed width representation as UCS-4.
+to UTF-8. The result will be terminated with a 0 byte.
-<note><para>Only use g_thread_create_full() if you really can't use
-g_thread_create() instead. g_thread_create() does not take
- stack_size, @bound, and @priority as arguments, as they should only
-be used in cases in which it is unavoidable.</para></note>
</description>
<parameters>
-<parameter name="func">
-<parameter_description> a function to execute in the new thread.
+<parameter name="str">
+<parameter_description> a UCS-4 encoded string
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> an argument to supply to the new thread.
+<parameter name="len">
+<parameter_description> the maximum length (number of characters) of @str to use.
+If @len < 0, then the string is nul-terminated.
</parameter_description>
</parameter>
-<parameter name="stack_size">
-<parameter_description> a stack size for the new thread.
+<parameter name="items_read">
+<parameter_description> location to store number of characters read, or %NULL.
</parameter_description>
</parameter>
-<parameter name="joinable">
-<parameter_description> should this thread be joinable?
+<parameter name="items_written">
+<parameter_description> location to store number of bytes written or %NULL.
+The value here stored does not include the trailing 0
+byte.
</parameter_description>
</parameter>
-<parameter name="bound">
-<parameter_description> should this thread be bound to a system thread?
+<parameter name="error">
+<parameter_description> location to store the error occuring, or %NULL to ignore
+errors. Any of the errors in #GConvertError other than
+%G_CONVERT_ERROR_NO_CONVERSION may occur.
</parameter_description>
</parameter>
-<parameter name="priority">
-<parameter_description> a priority for the thread.
+</parameters>
+<return> a pointer to a newly allocated UTF-8 string.
+This value must be freed with g_free(). If an
+error occurs, %NULL will be returned and
+ error set. In that case, @items_read will be
+set to the position of the first invalid input
+character.
+</return>
+</function>
+
+<function name="g_unichar_break_type">
+<description>
+Determines the break type of @c. @c should be a Unicode character
+(to derive a character from UTF-8 encoded text, use
+g_utf8_get_char()). The break type is used to find word and line
+breaks ("text boundaries"), Pango implements the Unicode boundary
+resolution algorithms and normally you would use a function such
+as pango_break() instead of caring about break types yourself.
+
+
+</description>
+<parameters>
+<parameter name="c">
+<parameter_description> a Unicode character
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for error.
+</parameters>
+<return> the break type of @c
+</return>
+</function>
+
+<function name="g_unichar_combining_class">
+<description>
+Determines the canonical combining class of a Unicode character.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="uc">
+<parameter_description> a Unicode character
</parameter_description>
</parameter>
</parameters>
-<return> the new #GThread on success.
+<return> the combining class of the character
+
</return>
</function>
-<function name="g_thread_exit">
+<function name="g_unichar_digit_value">
<description>
-Exits the current thread. If another thread is waiting for that
-thread using g_thread_join() and the current thread is joinable, the
-waiting thread will be woken up and get @retval as the return value
-of g_thread_join(). If the current thread is not joinable, @retval
-is ignored. Calling
+Determines the numeric value of a character as a decimal
+digit.
-<informalexample>
-<programlisting>
-g_thread_exit (retval);
-</programlisting>
-</informalexample>
-is equivalent to returning @retval from the function @func, as given
-to g_thread_create().
+</description>
+<parameters>
+<parameter name="c">
+<parameter_description> a Unicode character
+</parameter_description>
+</parameter>
+</parameters>
+<return> If @c is a decimal digit (according to
+g_unichar_isdigit()), its numeric value. Otherwise, -1.
+</return>
+</function>
-<note><para>Never call g_thread_exit() from within a thread of a
-#GThreadPool, as that will mess up the bookkeeping and lead to funny
-and unwanted results.</para></note>
+<function name="g_unichar_get_mirror_char">
+<description>
+In Unicode, some characters are <firstterm>mirrored</firstterm>. This
+means that their images are mirrored horizontally in text that is laid
+out from right to left. For instance, "(" would become its mirror image,
+")", in right-to-left text.
+
+If @ch has the Unicode mirrored property and there is another unicode
+character that typically has a glyph that is the mirror image of @ch's
+glyph and @mirrored_ch is set, it puts that character in the address
+pointed to by @mirrored_ch. Otherwise the original character is put.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="retval">
-<parameter_description> the return value of this thread.
+<parameter name="ch">
+<parameter_description> a Unicode character
+</parameter_description>
+</parameter>
+<parameter name="mirrored_ch">
+<parameter_description> location to store the mirrored character
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @ch has a mirrored character, %FALSE otherwise
+
+</return>
</function>
-<function name="g_thread_foreach">
+<function name="g_unichar_get_script">
<description>
-Call @thread_func on all existing #GThread structures. Note that
-threads may decide to exit while @thread_func is running, so
-without intimate knowledge about the lifetime of foreign threads,
- thread_func shouldn't access the GThread* pointer passed in as
-first argument. However, @thread_func will not be called for threads
-which are known to have exited already.
+Looks up the #GUnicodeScript for a particular character (as defined
+by Unicode Standard Annex #24). No check is made for @ch being a
+valid Unicode character; if you pass in invalid character, the
+result is undefined.
-Due to thread lifetime checks, this function has an execution complexity
-which is quadratic in the number of existing threads.
+This function is equivalent to pango_script_for_unichar() and the
+two are interchangeable.
-Since: 2.10
+Since: 2.14
</description>
<parameters>
-<parameter name="thread_func">
-<parameter_description> function to call for all GThread structures
-</parameter_description>
-</parameter>
-<parameter name="user_data">
-<parameter_description> second argument to @thread_func
+<parameter name="ch">
+<parameter_description> a Unicode character
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the #GUnicodeScript for the character.
+
+</return>
</function>
-<function name="g_thread_get_initialized">
+<function name="g_unichar_isalnum">
<description>
-Indicates if g_thread_init() has been called.
+Determines whether a character is alphanumeric.
+Given some UTF-8 text, obtain a character value
+with g_utf8_get_char().
-Since: 2.20
</description>
<parameters>
+<parameter name="c">
+<parameter_description> a Unicode character
+</parameter_description>
+</parameter>
</parameters>
-<return> %TRUE if threads have been initialized.
-
+<return> %TRUE if @c is an alphanumeric character
</return>
</function>
-<function name="g_thread_init">
+<function name="g_unichar_isalpha">
<description>
-If you use GLib from more than one thread, you must initialize the
-thread system by calling g_thread_init(). Most of the time you will
-only have to call <literal>g_thread_init (NULL)</literal>.
-
-<note><para>Do not call g_thread_init() with a non-%NULL parameter unless
-you really know what you are doing.</para></note>
-
-<note><para>g_thread_init() must not be called directly or indirectly as a
-callback from GLib. Also no mutexes may be currently locked while
-calling g_thread_init().</para></note>
-
-<note><para>g_thread_init() changes the way in which #GTimer measures
-elapsed time. As a consequence, timers that are running while
-g_thread_init() is called may report unreliable times.</para></note>
-
-Calling g_thread_init() multiple times is allowed (since version
-2.24), but nothing happens except for the first call. If the
-argument is non-%NULL on such a call a warning will be printed, but
-otherwise the argument is ignored.
-
-If no thread system is available and @vtable is %NULL or if not all
-elements of @vtable are non-%NULL, then g_thread_init() will abort.
+Determines whether a character is alphabetic (i.e. a letter).
+Given some UTF-8 text, obtain a character value with
+g_utf8_get_char().
-<note><para>To use g_thread_init() in your program, you have to link with
-the libraries that the command <command>pkg-config --libs
-gthread-2.0</command> outputs. This is not the case for all the
-other thread related functions of GLib. Those can be used without
-having to link with the thread libraries.</para></note>
</description>
<parameters>
-<parameter name="vtable">
-<parameter_description> a function table of type #GThreadFunctions, that provides
-the entry points to the thread system to be used.
+<parameter name="c">
+<parameter_description> a Unicode character
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @c is an alphabetic character
+</return>
</function>
-<function name="g_thread_join">
+<function name="g_unichar_iscntrl">
<description>
-Waits until @thread finishes, i.e. the function @func, as given to
-g_thread_create(), returns or g_thread_exit() is called by @thread.
-All resources of @thread including the #GThread struct are released.
- thread must have been created with @joinable=%TRUE in
-g_thread_create(). The value returned by @func or given to
-g_thread_exit() by @thread is returned by this function.
+Determines whether a character is a control character.
+Given some UTF-8 text, obtain a character value with
+g_utf8_get_char().
+
</description>
<parameters>
-<parameter name="thread">
-<parameter_description> a #GThread to be waited for.
+<parameter name="c">
+<parameter_description> a Unicode character
</parameter_description>
</parameter>
</parameters>
-<return> the return value of the thread.
+<return> %TRUE if @c is a control character
</return>
</function>
-<function name="g_thread_pool_free">
+<function name="g_unichar_isdefined">
<description>
-Frees all resources allocated for @pool.
-
-If @immediate is %TRUE, no new task is processed for
- pool Otherwise @pool is not freed before the last task is
-processed. Note however, that no thread of this pool is
-interrupted, while processing a task. Instead at least all still
-running threads can finish their tasks before the @pool is freed.
-
-If @wait_ is %TRUE, the functions does not return before all tasks
-to be processed (dependent on @immediate, whether all or only the
-currently running) are ready. Otherwise the function returns immediately.
+Determines if a given character is assigned in the Unicode
+standard.
-After calling this function @pool must not be used anymore.
</description>
<parameters>
-<parameter name="pool">
-<parameter_description> a #GThreadPool
-</parameter_description>
-</parameter>
-<parameter name="immediate">
-<parameter_description> should @pool shut down immediately?
-</parameter_description>
-</parameter>
-<parameter name="wait_">
-<parameter_description> should the function wait for all tasks to be finished?
+<parameter name="c">
+<parameter_description> a Unicode character
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the character has an assigned value
+</return>
</function>
-<function name="g_thread_pool_get_max_idle_time">
+<function name="g_unichar_isdigit">
<description>
-This function will return the maximum @interval that a thread will
-wait in the thread pool for new tasks before being stopped.
-
-If this function returns 0, threads waiting in the thread pool for
-new work are not stopped.
+Determines whether a character is numeric (i.e. a digit). This
+covers ASCII 0-9 and also digits in other languages/scripts. Given
+some UTF-8 text, obtain a character value with g_utf8_get_char().
-Since: 2.10
</description>
<parameters>
+<parameter name="c">
+<parameter_description> a Unicode character
+</parameter_description>
+</parameter>
</parameters>
-<return> the maximum @interval to wait for new tasks in the
-thread pool before stopping the thread (1/1000ths of a second).
-
+<return> %TRUE if @c is a digit
</return>
</function>
-<function name="g_thread_pool_get_max_threads">
+<function name="g_unichar_isgraph">
<description>
-Returns the maximal number of threads for @pool.
+Determines whether a character is printable and not a space
+(returns %FALSE for control characters, format characters, and
+spaces). g_unichar_isprint() is similar, but returns %TRUE for
+spaces. Given some UTF-8 text, obtain a character value with
+g_utf8_get_char().
</description>
<parameters>
-<parameter name="pool">
-<parameter_description> a #GThreadPool
+<parameter name="c">
+<parameter_description> a Unicode character
</parameter_description>
</parameter>
</parameters>
-<return> the maximal number of threads
+<return> %TRUE if @c is printable unless it's a space
</return>
</function>
-<function name="g_thread_pool_get_max_unused_threads">
+<function name="g_unichar_islower">
<description>
-Returns the maximal allowed number of unused threads.
+Determines whether a character is a lowercase letter.
+Given some UTF-8 text, obtain a character value with
+g_utf8_get_char().
</description>
<parameters>
+<parameter name="c">
+<parameter_description> a Unicode character
+</parameter_description>
+</parameter>
</parameters>
-<return> the maximal number of unused threads
+<return> %TRUE if @c is a lowercase letter
</return>
</function>
-<function name="g_thread_pool_get_num_threads">
+<function name="g_unichar_ismark">
<description>
-Returns the number of threads currently running in @pool.
+Determines whether a character is a mark (non-spacing mark,
+combining mark, or enclosing mark in Unicode speak).
+Given some UTF-8 text, obtain a character value
+with g_utf8_get_char().
+
+Note: in most cases where isalpha characters are allowed,
+ismark characters should be allowed to as they are essential
+for writing most European languages as well as many non-Latin
+scripts.
+Since: 2.14
</description>
<parameters>
-<parameter name="pool">
-<parameter_description> a #GThreadPool
+<parameter name="c">
+<parameter_description> a Unicode character
</parameter_description>
</parameter>
</parameters>
-<return> the number of threads currently running
+<return> %TRUE if @c is a mark character
+
</return>
</function>
-<function name="g_thread_pool_get_num_unused_threads">
+<function name="g_unichar_isprint">
<description>
-Returns the number of currently unused threads.
+Determines whether a character is printable.
+Unlike g_unichar_isgraph(), returns %TRUE for spaces.
+Given some UTF-8 text, obtain a character value with
+g_utf8_get_char().
</description>
<parameters>
+<parameter name="c">
+<parameter_description> a Unicode character
+</parameter_description>
+</parameter>
</parameters>
-<return> the number of currently unused threads
+<return> %TRUE if @c is printable
</return>
</function>
-<function name="g_thread_pool_new">
+<function name="g_unichar_ispunct">
<description>
-This function creates a new thread pool.
-
-Whenever you call g_thread_pool_push(), either a new thread is
-created or an unused one is reused. At most @max_threads threads
-are running concurrently for this thread pool. @max_threads = -1
-allows unlimited threads to be created for this thread pool. The
-newly created or reused thread now executes the function @func with
-the two arguments. The first one is the parameter to
-g_thread_pool_push() and the second one is @user_data.
-
-The parameter @exclusive determines, whether the thread pool owns
-all threads exclusive or whether the threads are shared
-globally. If @exclusive is %TRUE, @max_threads threads are started
-immediately and they will run exclusively for this thread pool until
-it is destroyed by g_thread_pool_free(). If @exclusive is %FALSE,
-threads are created, when needed and shared between all
-non-exclusive thread pools. This implies that @max_threads may not
-be -1 for exclusive thread pools.
-
- error can be %NULL to ignore errors, or non-%NULL to report
-errors. An error can only occur when @exclusive is set to %TRUE and
-not all @max_threads threads could be created.
+Determines whether a character is punctuation or a symbol.
+Given some UTF-8 text, obtain a character value with
+g_utf8_get_char().
</description>
<parameters>
-<parameter name="func">
-<parameter_description> a function to execute in the threads of the new thread pool
-</parameter_description>
-</parameter>
-<parameter name="user_data">
-<parameter_description> user data that is handed over to @func every time it
-is called
-</parameter_description>
-</parameter>
-<parameter name="max_threads">
-<parameter_description> the maximal number of threads to execute concurrently in
-the new thread pool, -1 means no limit
-</parameter_description>
-</parameter>
-<parameter name="exclusive">
-<parameter_description> should this thread pool be exclusive?
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for error
+<parameter name="c">
+<parameter_description> a Unicode character
</parameter_description>
</parameter>
</parameters>
-<return> the new #GThreadPool
+<return> %TRUE if @c is a punctuation or symbol character
</return>
</function>
-<function name="g_thread_pool_push">
+<function name="g_unichar_isspace">
<description>
-Inserts @data into the list of tasks to be executed by @pool. When
-the number of currently running threads is lower than the maximal
-allowed number of threads, a new thread is started (or reused) with
-the properties given to g_thread_pool_new (). Otherwise @data stays
-in the queue until a thread in this pool finishes its previous task
-and processes @data.
+Determines whether a character is a space, tab, or line separator
+(newline, carriage return, etc.). Given some UTF-8 text, obtain a
+character value with g_utf8_get_char().
+
+(Note: don't use this to do word breaking; you have to use
+Pango or equivalent to get word breaking right, the algorithm
+is fairly complex.)
- error can be %NULL to ignore errors, or non-%NULL to report
-errors. An error can only occur when a new thread couldn't be
-created. In that case @data is simply appended to the queue of work
-to do.
</description>
<parameters>
-<parameter name="pool">
-<parameter_description> a #GThreadPool
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> a new task for @pool
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for error
+<parameter name="c">
+<parameter_description> a Unicode character
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @c is a space character
+</return>
</function>
-<function name="g_thread_pool_set_max_idle_time">
+<function name="g_unichar_istitle">
<description>
-This function will set the maximum @interval that a thread waiting
-in the pool for new tasks can be idle for before being
-stopped. This function is similar to calling
-g_thread_pool_stop_unused_threads() on a regular timeout, except,
-this is done on a per thread basis.
-
-By setting @interval to 0, idle threads will not be stopped.
-
-This function makes use of g_async_queue_timed_pop () using
- interval
+Determines if a character is titlecase. Some characters in
+Unicode which are composites, such as the DZ digraph
+have three case variants instead of just two. The titlecase
+form is used at the beginning of a word where only the
+first letter is capitalized. The titlecase form of the DZ
+digraph is U+01F2 LATIN CAPITAL LETTTER D WITH SMALL LETTER Z.
-Since: 2.10
</description>
<parameters>
-<parameter name="interval">
-<parameter_description> the maximum @interval (1/1000ths of a second) a thread
-can be idle.
+<parameter name="c">
+<parameter_description> a Unicode character
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the character is titlecase
+</return>
</function>
-<function name="g_thread_pool_set_max_threads">
+<function name="g_unichar_isupper">
<description>
-Sets the maximal allowed number of threads for @pool. A value of -1
-means, that the maximal number of threads is unlimited.
-
-Setting @max_threads to 0 means stopping all work for @pool. It is
-effectively frozen until @max_threads is set to a non-zero value
-again.
-
-A thread is never terminated while calling @func, as supplied by
-g_thread_pool_new (). Instead the maximal number of threads only
-has effect for the allocation of new threads in g_thread_pool_push().
-A new thread is allocated, whenever the number of currently
-running threads in @pool is smaller than the maximal number.
+Determines if a character is uppercase.
- error can be %NULL to ignore errors, or non-%NULL to report
-errors. An error can only occur when a new thread couldn't be
-created.
</description>
<parameters>
-<parameter name="pool">
-<parameter_description> a #GThreadPool
-</parameter_description>
-</parameter>
-<parameter name="max_threads">
-<parameter_description> a new maximal number of threads for @pool
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for error
+<parameter name="c">
+<parameter_description> a Unicode character
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @c is an uppercase character
+</return>
</function>
-<function name="g_thread_pool_set_max_unused_threads">
+<function name="g_unichar_iswide">
<description>
-Sets the maximal number of unused threads to @max_threads. If
- max_threads is -1, no limit is imposed on the number of unused
-threads.
+Determines if a character is typically rendered in a double-width
+cell.
+
</description>
<parameters>
-<parameter name="max_threads">
-<parameter_description> maximal number of unused threads
+<parameter name="c">
+<parameter_description> a Unicode character
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the character is wide
+</return>
</function>
-<function name="g_thread_pool_set_sort_function">
+<function name="g_unichar_iswide_cjk">
<description>
-Sets the function used to sort the list of tasks. This allows the
-tasks to be processed by a priority determined by @func, and not
-just in the order in which they were added to the pool.
+Determines if a character is typically rendered in a double-width
+cell under legacy East Asian locales. If a character is wide according to
+g_unichar_iswide(), then it is also reported wide with this function, but
+the converse is not necessarily true. See the
+<ulink url="http://www.unicode.org/reports/tr11/">Unicode Standard
+Annex #11</ulink> for details.
-Note, if the maximum number of threads is more than 1, the order
-that threads are executed cannot be guranteed 100%. Threads are
-scheduled by the operating system and are executed at random. It
-cannot be assumed that threads are executed in the order they are
-created.
+If a character passes the g_unichar_iswide() test then it will also pass
+this test, but not the other way around. Note that some characters may
+pas both this test and g_unichar_iszerowidth().
-Since: 2.10
+Since: 2.12
</description>
<parameters>
-<parameter name="pool">
-<parameter_description> a #GThreadPool
-</parameter_description>
-</parameter>
-<parameter name="func">
-<parameter_description> the #GCompareDataFunc used to sort the list of tasks.
-This function is passed two tasks. It should return
-0 if the order in which they are handled does not matter,
-a negative value if the first task should be processed before
-the second or a positive value if the second task should be
-processed first.
-</parameter_description>
-</parameter>
-<parameter name="user_data">
-<parameter_description> user data passed to @func.
+<parameter name="c">
+<parameter_description> a Unicode character
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the character is wide in legacy East Asian locales
+
+</return>
</function>
-<function name="g_thread_pool_stop_unused_threads">
+<function name="g_unichar_isxdigit">
<description>
-Stops all currently unused threads. This does not change the
-maximal number of unused threads. This function can be used to
-regularly stop all unused threads e.g. from g_timeout_add().
+Determines if a character is a hexidecimal digit.
+
</description>
<parameters>
+<parameter name="c">
+<parameter_description> a Unicode character.
+</parameter_description>
+</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the character is a hexadecimal digit
+</return>
</function>
-<function name="g_thread_pool_unprocessed">
+<function name="g_unichar_iszerowidth">
<description>
-Returns the number of tasks still unprocessed in @pool.
+Determines if a given character typically takes zero width when rendered.
+The return value is %TRUE for all non-spacing and enclosing marks
+(e.g., combining accents), format characters, zero-width
+space, but not U+00AD SOFT HYPHEN.
+
+A typical use of this function is with one of g_unichar_iswide() or
+g_unichar_iswide_cjk() to determine the number of cells a string occupies
+when displayed on a grid display (terminals). However, note that not all
+terminals support zero-width rendering of zero-width marks.
+Since: 2.14
</description>
<parameters>
-<parameter name="pool">
-<parameter_description> a #GThreadPool
+<parameter name="c">
+<parameter_description> a Unicode character
</parameter_description>
</parameter>
</parameters>
-<return> the number of unprocessed tasks
+<return> %TRUE if the character has zero width
+
</return>
</function>
-<function name="g_thread_self">
+<function name="g_unichar_to_utf8">
<description>
-This functions returns the #GThread corresponding to the calling
-thread.
+Converts a single character to UTF-8.
+
</description>
<parameters>
+<parameter name="c">
+<parameter_description> a Unicode character code
+</parameter_description>
+</parameter>
+<parameter name="outbuf">
+<parameter_description> output buffer, must have at least 6 bytes of space.
+If %NULL, the length will be computed and returned
+and nothing will be written to @outbuf.
+</parameter_description>
+</parameter>
</parameters>
-<return> the current thread.
+<return> number of bytes written
</return>
</function>
-<function name="g_thread_set_priority">
+<function name="g_unichar_tolower">
<description>
-Changes the priority of @thread to @priority.
+Converts a character to lower case.
-<note><para>It is not guaranteed that threads with different
-priorities really behave accordingly. On some systems (e.g. Linux)
-there are no thread priorities. On other systems (e.g. Solaris) there
-doesn't seem to be different scheduling for different priorities. All
-in all try to avoid being dependent on priorities.</para></note>
</description>
<parameters>
-<parameter name="thread">
-<parameter_description> a #GThread.
-</parameter_description>
-</parameter>
-<parameter name="priority">
-<parameter_description> a new priority for @thread.
+<parameter name="c">
+<parameter_description> a Unicode character.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the result of converting @c to lower case.
+If @c is not an upperlower or titlecase character,
+or has no lowercase equivalent @c is returned unchanged.
+</return>
</function>
-<function name="g_thread_supported">
+<function name="g_unichar_totitle">
<description>
-This function returns %TRUE if the thread system is initialized, and
-%FALSE if it is not.
+Converts a character to the titlecase.
-<note><para>This function is actually a macro. Apart from taking the
-address of it you can however use it as if it was a
-function.</para></note>
</description>
<parameters>
+<parameter name="c">
+<parameter_description> a Unicode character
+</parameter_description>
+</parameter>
</parameters>
-<return> %TRUE, if the thread system is initialized.
+<return> the result of converting @c to titlecase.
+If @c is not an uppercase or lowercase character,
+ c is returned unchanged.
</return>
</function>
-<function name="g_thread_yield">
+<function name="g_unichar_toupper">
<description>
-Gives way to other threads waiting to be scheduled.
+Converts a character to uppercase.
-This function is often used as a method to make busy wait less evil.
-But in most cases you will encounter, there are better methods to do
-that. So in general you shouldn't use this function.
</description>
<parameters>
+<parameter name="c">
+<parameter_description> a Unicode character
+</parameter_description>
+</parameter>
</parameters>
-<return></return>
+<return> the result of converting @c to uppercase.
+If @c is not an lowercase or titlecase character,
+or has no upper case equivalent @c is returned unchanged.
+</return>
</function>
-<function name="g_time_val_add">
+<function name="g_unichar_type">
<description>
-Adds the given number of microseconds to @time_. @microseconds can
-also be negative to decrease the value of @time_.
+Classifies a Unicode character by type.
+
</description>
<parameters>
-<parameter name="time_">
-<parameter_description> a #GTimeVal
-</parameter_description>
-</parameter>
-<parameter name="microseconds">
-<parameter_description> number of microseconds to add to @time
+<parameter name="c">
+<parameter_description> a Unicode character
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the type of the character.
+</return>
</function>
-<function name="g_time_val_from_iso8601">
+<function name="g_unichar_validate">
<description>
-Converts a string containing an ISO 8601 encoded date and time
-to a #GTimeVal and puts it into @time_.
+Checks whether @ch is a valid Unicode character. Some possible
+integer values of @ch will not be valid. 0 is considered a valid
+character, though it's normally a string terminator.
-Since: 2.12
</description>
<parameters>
-<parameter name="iso_date">
-<parameter_description> an ISO 8601 encoded date string
-</parameter_description>
-</parameter>
-<parameter name="time_">
-<parameter_description> a #GTimeVal
+<parameter name="ch">
+<parameter_description> a Unicode character
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the conversion was successful.
-
+<return> %TRUE if @ch is a valid Unicode character
</return>
</function>
-<function name="g_time_val_to_iso8601">
+<function name="g_unichar_xdigit_value">
<description>
-Converts @time_ into an ISO 8601 encoded string, relative to the
-Coordinated Universal Time (UTC).
+Determines the numeric value of a character as a hexidecimal
+digit.
-Since: 2.12
</description>
<parameters>
-<parameter name="time_">
-<parameter_description> a #GTimeVal
+<parameter name="c">
+<parameter_description> a Unicode character
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated string containing an ISO 8601 date
-
+<return> If @c is a hex digit (according to
+g_unichar_isxdigit()), its numeric value. Otherwise, -1.
</return>
</function>
-<function name="g_time_zone_adjust_time">
+<function name="g_unicode_canonical_decomposition">
<description>
-Finds an interval within @tz that corresponds to the given @time,
-possibly adjusting @time if required to fit into an interval.
-The meaning of @time depends on @type.
-
-This function is similar to g_time_zone_find_interval(), with the
-difference that it always succeeds (by making the adjustments
-described below).
-
-In any of the cases where g_time_zone_find_interval() succeeds then
-this function returns the same value, without modifying @time.
-
-This function may, however, modify @time in order to deal with
-non-existent times. If the non-existent local @time of 02:30 were
-requested on March 13th 2010 in Toronto then this function would
-adjust @time to be 03:00 and return the interval containing the
-adjusted time.
+Computes the canonical decomposition of a Unicode character.
-Since: 2.26
</description>
<parameters>
-<parameter name="tz">
-<parameter_description> a #GTimeZone
-</parameter_description>
-</parameter>
-<parameter name="type">
-<parameter_description> the #GTimeType of @time
+<parameter name="ch">
+<parameter_description> a Unicode character.
</parameter_description>
</parameter>
-<parameter name="time">
-<parameter_description> a pointer to a number of seconds since January 1, 1970
+<parameter name="result_len">
+<parameter_description> location to store the length of the return value.
</parameter_description>
</parameter>
</parameters>
-<return> the interval containing @time, never -1
-
+<return> a newly allocated string of Unicode characters.
+ result_len is set to the resulting length of the string.
</return>
</function>
-<function name="g_time_zone_find_interval">
+<function name="g_unicode_canonical_ordering">
<description>
-Finds an the interval within @tz that corresponds to the given @time_.
-The meaning of @time_ depends on @type.
-
-If @type is %G_TIME_TYPE_UNIVERSAL then this function will always
-succeed (since universal time is monotonic and continuous).
-
-Otherwise @time_ is treated is local time. The distinction between
-%G_TIME_TYPE_STANDARD and %G_TIME_TYPE_DAYLIGHT is ignored except in
-the case that the given @time_ is ambiguous. In Toronto, for example,
-01:30 on November 7th 2010 occured twice (once inside of daylight
-savings time and the next, an hour later, outside of daylight savings
-time). In this case, the different value of @type would result in a
-different interval being returned.
-
-It is still possible for this function to fail. In Toronto, for
-example, 02:00 on March 14th 2010 does not exist (due to the leap
-forward to begin daylight savings time). -1 is returned in that
-case.
-
-Since: 2.26
+Computes the canonical ordering of a string in-place.
+This rearranges decomposed characters in the string
+according to their combining classes. See the Unicode
+manual for more information.
</description>
<parameters>
-<parameter name="tz">
-<parameter_description> a #GTimeZone
-</parameter_description>
-</parameter>
-<parameter name="type">
-<parameter_description> the #GTimeType of @time_
+<parameter name="string">
+<parameter_description> a UCS-4 encoded string.
</parameter_description>
</parameter>
-<parameter name="time_">
-<parameter_description> a number of seconds since January 1, 1970
+<parameter name="len">
+<parameter_description> the maximum length of @string to use.
</parameter_description>
</parameter>
</parameters>
-<return> the interval containing @time_, or -1 in case of failure
-
-</return>
+<return></return>
</function>
-<function name="g_time_zone_get_abbreviation">
+<function name="g_unix_open_pipe">
<description>
-Determines the time zone abbreviation to be used during a particular
- interval of time in the time zone @tz.
+Similar to the UNIX pipe() call, but on modern systems like Linux
+uses the pipe2() system call, which atomically creates a pipe with
+the configured flags. The only supported flag currently is
+%FD_CLOEXEC. If for example you want to configure %O_NONBLOCK,
+that must still be done separately with fcntl().
-For example, in Toronto this is currently "EST" during the winter
-months and "EDT" during the summer months when daylight savings time
-is in effect.
+<note>This function does *not* take %O_CLOEXEC, it takes
+%FD_CLOEXEC as if for fcntl(); these are different on
+Linux/glibc.</note>
-Since: 2.26
+Since: 2.30
</description>
<parameters>
-<parameter name="tz">
-<parameter_description> a #GTimeZone
+<parameter name="fds">
+<parameter_description> Array of two integers
</parameter_description>
</parameter>
-<parameter name="interval">
-<parameter_description> an interval within the timezone
+<parameter name="flags">
+<parameter_description> Bitfield of file descriptor flags, see "man 2 fcntl"
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a #GError
</parameter_description>
</parameter>
</parameters>
-<return> the time zone abbreviation, which belongs to @tz
+<return> %TRUE on success, %FALSE if not (and errno will be set).
</return>
</function>
-<function name="g_time_zone_get_offset">
+<function name="g_unix_set_fd_nonblocking">
<description>
-Determines the offset to UTC in effect during a particular @interval
-of time in the time zone @tz.
-
-The offset is the number of seconds that you add to UTC time to
-arrive at local time for @tz (ie: negative numbers for time zones
-west of GMT, positive numbers for east).
+Control the non-blocking state of the given file descriptor,
+according to @nonblock. On most systems this uses %O_NONBLOCK, but
+on some older ones may use %O_NDELAY.
-Since: 2.26
+Since: 2.30
</description>
<parameters>
-<parameter name="tz">
-<parameter_description> a #GTimeZone
+<parameter name="fd">
+<parameter_description> A file descriptor
</parameter_description>
</parameter>
-<parameter name="interval">
-<parameter_description> an interval within the timezone
+<parameter name="nonblock">
+<parameter_description> If %TRUE, set the descriptor to be non-blocking
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a #GError
</parameter_description>
</parameter>
</parameters>
-<return> the number of seconds that should be added to UTC to get the
-local time in @tz
+<return> %TRUE if successful
</return>
</function>
-<function name="g_time_zone_is_dst">
+<function name="g_unix_signal_add_watch_full">
<description>
-Determines if daylight savings time is in effect during a particular
- interval of time in the time zone @tz.
+A convenience function for g_unix_signal_source_new(), which
+attaches to the default #GMainContext. You can remove the watch
+using g_source_remove().
-Since: 2.26
+Since: 2.30
</description>
<parameters>
-<parameter name="tz">
-<parameter_description> a #GTimeZone
+<parameter name="signum">
+<parameter_description> Signal number
</parameter_description>
</parameter>
-<parameter name="interval">
-<parameter_description> an interval within the timezone
+<parameter name="priority">
+<parameter_description> the priority of the signal source. Typically this will be in
+the range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH.
+</parameter_description>
+</parameter>
+<parameter name="handler">
+<parameter_description> Callback
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> Data for @handler
+</parameter_description>
+</parameter>
+<parameter name="notify">
+<parameter_description> #GDestroyNotify for @handler
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if daylight savings time is in effect
+<return> An ID (greater than 0) for the event source
</return>
</function>
-<function name="g_time_zone_new">
+<function name="g_unix_signal_source_new">
<description>
-Creates a #GTimeZone corresponding to @identifier.
-
- identifier can either be an RFC3339/ISO 8601 time offset or
-something that would pass as a valid value for the
-<varname>TZ</varname> environment variable (including %NULL).
-
-Valid RFC3339 time offsets are <literal>"Z"</literal> (for UTC) or
-<literal>"Âhh:mm"</literal>. ISO 8601 additionally specifies
-<literal>"Âhhmm"</literal> and <literal>"Âhh"</literal>.
+Create a #GSource that will be dispatched upon delivery of the UNIX
+signal @signum. Currently only %SIGHUP, %SIGINT, and %SIGTERM can
+be monitored. Note that unlike the UNIX default, all sources which
+have created a watch will be dispatched, regardless of which
+underlying thread invoked g_unix_signal_source_new().
-The <varname>TZ</varname> environment variable typically corresponds
-to the name of a file in the zoneinfo database, but there are many
-other possibilities. Note that those other possibilities are not
-currently implemented, but are planned.
+For example, an effective use of this function is to handle SIGTERM
+cleanly; flushing any outstanding files, and then calling
+g_main_loop_quit (). It is not safe to do any of this a regular
+UNIX signal handler; your handler may be invoked while malloc() or
+another library function is running, causing reentrancy if you
+attempt to use it from the handler. None of the GLib/GObject API
+is safe against this kind of reentrancy.
-g_time_zone_new_local() calls this function with the value of the
-<varname>TZ</varname> environment variable. This function itself is
-independent of the value of <varname>TZ</varname>, but if @identifier
-is %NULL then <filename>/etc/localtime</filename> will be consulted
-to discover the correct timezone.
+The interaction of this source when combined with native UNIX
+functions like sigprocmask() is not defined.
-See <ulink
-url='http://tools.ietf.org/html/rfc3339#section-5.6'>RFC3339
-Â5.6</ulink> for a precise definition of valid RFC3339 time offsets
-(the <varname>time-offset</varname> expansion) and ISO 8601 for the
-full list of valid time offsets. See <ulink
-url='http://www.gnu.org/s/libc/manual/html_node/TZ-Variable.html'>The
-GNU C Library manual</ulink> for an explanation of the possible
-values of the <varname>TZ</varname> environment variable.
+<note>For reliable behavior, if your program links to gthread
+(either directly or indirectly via GObject, GIO, or a higher level
+library), you should ensure g_thread_init() is called before using
+this function. For example, if your program uses GObject, call
+g_type_init().</note>
-You should release the return value by calling g_time_zone_unref()
-when you are done with it.
+The source will not initially be associated with any #GMainContext
+and must be added to one with g_source_attach() before it will be
+executed.
-Since: 2.26
+Since: 2.30
</description>
<parameters>
-<parameter name="identifier">
-<parameter_description> a timezone identifier
+<parameter name="signum">
+<parameter_description> A signal number
</parameter_description>
</parameter>
</parameters>
-<return> the requested timezone
+<return> A newly created #GSource
</return>
</function>
-<function name="g_time_zone_new_local">
+<function name="g_unlink">
<description>
-Creates a #GTimeZone corresponding to local time.
-
-This is equivalent to calling g_time_zone_new() with the value of the
-<varname>TZ</varname> environment variable (including the possibility
-of %NULL). Changes made to <varname>TZ</varname> after the first
-call to this function may or may not be noticed by future calls.
+A wrapper for the POSIX unlink() function. The unlink() function
+deletes a name from the filesystem. If this was the last link to the
+file and no processes have it opened, the diskspace occupied by the
+file is freed.
-You should release the return value by calling g_time_zone_unref()
-when you are done with it.
+See your C library manual for more details about unlink(). Note
+that on Windows, it is in general not possible to delete files that
+are open to some process, or mapped into memory.
-Since: 2.26
+Since: 2.6
</description>
<parameters>
+<parameter name="filename">
+<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows)
+</parameter_description>
+</parameter>
</parameters>
-<return> the local timezone
+<return> 0 if the name was successfully deleted, -1 if an error
+occurred
</return>
</function>
-<function name="g_time_zone_new_utc">
+<function name="g_unsetenv">
<description>
-Creates a #GTimeZone corresponding to UTC.
-
-This is equivalent to calling g_time_zone_new() with a value like
-"Z", "UTC", "+00", etc.
+Removes an environment variable from the environment.
-You should release the return value by calling g_time_zone_unref()
-when you are done with it.
+Note that on some systems, when variables are overwritten, the memory
+used for the previous variables and its value isn't reclaimed.
+Furthermore, this function can't be guaranteed to operate in a
+threadsafe way.
-Since: 2.26
+Since: 2.4
</description>
<parameters>
+<parameter name="variable">
+<parameter_description> the environment variable to remove, must not contain '='.
+</parameter_description>
+</parameter>
</parameters>
-<return> the universal timezone
-
-</return>
+<return></return>
</function>
-<function name="g_time_zone_ref">
+<function name="g_uri_escape_string">
<description>
-Increases the reference count on @tz.
+Escapes a string for use in a URI.
-Since: 2.26
+Normally all characters that are not "unreserved" (i.e. ASCII alphanumerical
+characters plus dash, dot, underscore and tilde) are escaped.
+But if you specify characters in @reserved_chars_allowed they are not
+escaped. This is useful for the "reserved" characters in the URI
+specification, since those are allowed unescaped in some portions of
+a URI.
+
+Since: 2.16
</description>
<parameters>
-<parameter name="tz">
-<parameter_description> a #GTimeZone
+<parameter name="unescaped">
+<parameter_description> the unescaped input string.
+</parameter_description>
+</parameter>
+<parameter name="reserved_chars_allowed">
+<parameter_description> a string of reserved characters that are
+allowed to be used, or %NULL.
+</parameter_description>
+</parameter>
+<parameter name="allow_utf8">
+<parameter_description> %TRUE if the result can include UTF-8 characters.
</parameter_description>
</parameter>
</parameters>
-<return> a new reference to @tz.
+<return> an escaped version of @unescaped. The returned string should be
+freed when no longer needed.
</return>
</function>
-<function name="g_time_zone_unref">
+<function name="g_uri_list_extract_uris">
<description>
-Decreases the reference count on @tz.
+Splits an URI list conforming to the text/uri-list
+mime type defined in RFC 2483 into individual URIs,
+discarding any comments. The URIs are not validated.
-Since: 2.26
+Since: 2.6
</description>
<parameters>
-<parameter name="tz">
-<parameter_description> a #GTimeZone
+<parameter name="uri_list">
+<parameter_description> an URI list
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a newly allocated %NULL-terminated list of
+strings holding the individual URIs. The array should
+be freed with g_strfreev().
+
+</return>
</function>
-<function name="g_timeout_add">
+<function name="g_uri_parse_scheme">
<description>
-Sets a function to be called at regular intervals, with the default
-priority, #G_PRIORITY_DEFAULT. The function is called repeatedly
-until it returns %FALSE, at which point the timeout is automatically
-destroyed and the function will not be called again. The first call
-to the function will be at the end of the first @interval.
-
-Note that timeout functions may be delayed, due to the processing of other
-event sources. Thus they should not be relied on for precise timing.
-After each call to the timeout function, the time of the next
-timeout is recalculated based on the current time and the given interval
-(it does not try to 'catch up' time lost in delays).
-
-If you want to have a timer in the "seconds" range and do not care
-about the exact time of the first call of the timer, use the
-g_timeout_add_seconds() function; this function allows for more
-optimizations and more efficient system power usage.
-
-This internally creates a main loop source using g_timeout_source_new()
-and attaches it to the main loop context using g_source_attach(). You can
-do these steps manually if you need greater control.
+Gets the scheme portion of a URI string. RFC 3986 decodes the scheme as:
+<programlisting>
+URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]
+</programlisting>
+Common schemes include "file", "http", "svn+ssh", etc.
+Since: 2.16
</description>
<parameters>
-<parameter name="interval">
-<parameter_description> the time between calls to the function, in milliseconds
-(1/1000ths of a second)
-</parameter_description>
-</parameter>
-<parameter name="function">
-<parameter_description> function to call
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> data to pass to @function
+<parameter name="uri">
+<parameter_description> a valid URI.
</parameter_description>
</parameter>
</parameters>
-<return> the ID (greater than 0) of the event source.
+<return> The "Scheme" component of the URI, or %NULL on error.
+The returned string should be freed when no longer needed.
+
</return>
</function>
-<function name="g_timeout_add_full">
+<function name="g_uri_unescape_segment">
<description>
-Sets a function to be called at regular intervals, with the given
-priority. The function is called repeatedly until it returns
-%FALSE, at which point the timeout is automatically destroyed and
-the function will not be called again. The @notify function is
-called when the timeout is destroyed. The first call to the
-function will be at the end of the first @interval.
-
-Note that timeout functions may be delayed, due to the processing of other
-event sources. Thus they should not be relied on for precise timing.
-After each call to the timeout function, the time of the next
-timeout is recalculated based on the current time and the given interval
-(it does not try to 'catch up' time lost in delays).
+Unescapes a segment of an escaped string.
-This internally creates a main loop source using g_timeout_source_new()
-and attaches it to the main loop context using g_source_attach(). You can
-do these steps manually if you need greater control.
+If any of the characters in @illegal_characters or the character zero appears
+as an escaped character in @escaped_string then that is an error and %NULL
+will be returned. This is useful it you want to avoid for instance having a
+slash being expanded in an escaped path element, which might confuse pathname
+handling.
+Since: 2.16
</description>
<parameters>
-<parameter name="priority">
-<parameter_description> the priority of the timeout source. Typically this will be in
-the range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH.
-</parameter_description>
-</parameter>
-<parameter name="interval">
-<parameter_description> the time between calls to the function, in milliseconds
-(1/1000ths of a second)
-</parameter_description>
-</parameter>
-<parameter name="function">
-<parameter_description> function to call
+<parameter name="escaped_string">
+<parameter_description> a string.
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> data to pass to @function
+<parameter name="escaped_string_end">
+<parameter_description> a string.
</parameter_description>
</parameter>
-<parameter name="notify">
-<parameter_description> function to call when the timeout is removed, or %NULL
+<parameter name="illegal_characters">
+<parameter_description> an optional string of illegal characters not to be allowed.
</parameter_description>
</parameter>
</parameters>
-<return> the ID (greater than 0) of the event source.
+<return> an unescaped version of @escaped_string or %NULL on error.
+The returned string should be freed when no longer needed.
+
</return>
</function>
-<function name="g_timeout_add_seconds">
+<function name="g_uri_unescape_string">
<description>
-Sets a function to be called at regular intervals with the default
-priority, #G_PRIORITY_DEFAULT. The function is called repeatedly until
-it returns %FALSE, at which point the timeout is automatically destroyed
-and the function will not be called again.
-
-This internally creates a main loop source using
-g_timeout_source_new_seconds() and attaches it to the main loop context
-using g_source_attach(). You can do these steps manually if you need
-greater control. Also see g_timout_add_seconds_full().
+Unescapes a whole escaped string.
-Note that the first call of the timer may not be precise for timeouts
-of one second. If you need finer precision and have such a timeout,
-you may want to use g_timeout_add() instead.
+If any of the characters in @illegal_characters or the character zero appears
+as an escaped character in @escaped_string then that is an error and %NULL
+will be returned. This is useful it you want to avoid for instance having a
+slash being expanded in an escaped path element, which might confuse pathname
+handling.
-Since: 2.14
+Since: 2.16
</description>
<parameters>
-<parameter name="interval">
-<parameter_description> the time between calls to the function, in seconds
-</parameter_description>
-</parameter>
-<parameter name="function">
-<parameter_description> function to call
+<parameter name="escaped_string">
+<parameter_description> an escaped string to be unescaped.
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> data to pass to @function
+<parameter name="illegal_characters">
+<parameter_description> an optional string of illegal characters not to be allowed.
</parameter_description>
</parameter>
</parameters>
-<return> the ID (greater than 0) of the event source.
+<return> an unescaped version of @escaped_string. The returned string
+should be freed when no longer needed.
</return>
</function>
-<function name="g_timeout_add_seconds_full">
+<function name="g_utf16_to_ucs4">
<description>
-Sets a function to be called at regular intervals, with @priority.
-The function is called repeatedly until it returns %FALSE, at which
-point the timeout is automatically destroyed and the function will
-not be called again.
+Convert a string from UTF-16 to UCS-4. The result will be
+nul-terminated.
-Unlike g_timeout_add(), this function operates at whole second granularity.
-The initial starting point of the timer is determined by the implementation
-and the implementation is expected to group multiple timers together so that
-they fire all at the same time.
-To allow this grouping, the @interval to the first timer is rounded
-and can deviate up to one second from the specified interval.
-Subsequent timer iterations will generally run at the specified interval.
-Note that timeout functions may be delayed, due to the processing of other
-event sources. Thus they should not be relied on for precise timing.
-After each call to the timeout function, the time of the next
-timeout is recalculated based on the current time and the given @interval
+</description>
+<parameters>
+<parameter name="str">
+<parameter_description> a UTF-16 encoded string
+</parameter_description>
+</parameter>
+<parameter name="len">
+<parameter_description> the maximum length (number of <type>gunichar2</type>) of @str to use.
+If @len < 0, then the string is nul-terminated.
+</parameter_description>
+</parameter>
+<parameter name="items_read">
+<parameter_description> location to store number of words read, or %NULL.
+If %NULL, then %G_CONVERT_ERROR_PARTIAL_INPUT will be
+returned in case @str contains a trailing partial
+character. If an error occurs then the index of the
+invalid input is stored here.
+</parameter_description>
+</parameter>
+<parameter name="items_written">
+<parameter_description> location to store number of characters written, or %NULL.
+The value stored here does not include the trailing
+0 character.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> location to store the error occuring, or %NULL to ignore
+errors. Any of the errors in #GConvertError other than
+%G_CONVERT_ERROR_NO_CONVERSION may occur.
+</parameter_description>
+</parameter>
+</parameters>
+<return> a pointer to a newly allocated UCS-4 string.
+This value must be freed with g_free(). If an
+error occurs, %NULL will be returned and
+ error set.
+</return>
+</function>
-If you want timing more precise than whole seconds, use g_timeout_add()
-instead.
+<function name="g_utf16_to_utf8">
+<description>
+Convert a string from UTF-16 to UTF-8. The result will be
+terminated with a 0 byte.
-The grouping of timers to fire at the same time results in a more power
-and CPU efficient behavior so if your timer is in multiples of seconds
-and you don't require the first timer exactly one second from now, the
-use of g_timeout_add_seconds() is preferred over g_timeout_add().
+Note that the input is expected to be already in native endianness,
+an initial byte-order-mark character is not handled specially.
+g_convert() can be used to convert a byte buffer of UTF-16 data of
+ambiguous endianess.
-This internally creates a main loop source using
-g_timeout_source_new_seconds() and attaches it to the main loop context
-using g_source_attach(). You can do these steps manually if you need
-greater control.
+Further note that this function does not validate the result
+string; it may e.g. include embedded NUL characters. The only
+validation done by this function is to ensure that the input can
+be correctly interpreted as UTF-16, i.e. it doesn't contain
+things unpaired surrogates.
-Since: 2.14
</description>
<parameters>
-<parameter name="priority">
-<parameter_description> the priority of the timeout source. Typically this will be in
-the range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH.
+<parameter name="str">
+<parameter_description> a UTF-16 encoded string
</parameter_description>
</parameter>
-<parameter name="interval">
-<parameter_description> the time between calls to the function, in seconds
+<parameter name="len">
+<parameter_description> the maximum length (number of <type>gunichar2</type>) of @str to use.
+If @len < 0, then the string is nul-terminated.
</parameter_description>
</parameter>
-<parameter name="function">
-<parameter_description> function to call
+<parameter name="items_read">
+<parameter_description> location to store number of words read, or %NULL.
+If %NULL, then %G_CONVERT_ERROR_PARTIAL_INPUT will be
+returned in case @str contains a trailing partial
+character. If an error occurs then the index of the
+invalid input is stored here.
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> data to pass to @function
+<parameter name="items_written">
+<parameter_description> location to store number of bytes written, or %NULL.
+The value stored here does not include the trailing
+0 byte.
</parameter_description>
</parameter>
-<parameter name="notify">
-<parameter_description> function to call when the timeout is removed, or %NULL
+<parameter name="error">
+<parameter_description> location to store the error occuring, or %NULL to ignore
+errors. Any of the errors in #GConvertError other than
+%G_CONVERT_ERROR_NO_CONVERSION may occur.
</parameter_description>
</parameter>
</parameters>
-<return> the ID (greater than 0) of the event source.
-
+<return> a pointer to a newly allocated UTF-8 string.
+This value must be freed with g_free(). If an
+error occurs, %NULL will be returned and
+ error set.
</return>
</function>
-<function name="g_timeout_source_new">
+<function name="g_utf8_casefold">
<description>
-Creates a new timeout source.
+Converts a string into a form that is independent of case. The
+result will not correspond to any particular case, but can be
+compared for equality or ordered with the results of calling
+g_utf8_casefold() on other strings.
-The source will not initially be associated with any #GMainContext
-and must be added to one with g_source_attach() before it will be
-executed.
+Note that calling g_utf8_casefold() followed by g_utf8_collate() is
+only an approximation to the correct linguistic case insensitive
+ordering, though it is a fairly good one. Getting this exactly
+right would require a more sophisticated collation function that
+takes case sensitivity into account. GLib does not currently
+provide such a function.
</description>
<parameters>
-<parameter name="interval">
-<parameter_description> the timeout interval in milliseconds.
+<parameter name="str">
+<parameter_description> a UTF-8 encoded string
+</parameter_description>
+</parameter>
+<parameter name="len">
+<parameter_description> length of @str, in bytes, or -1 if @str is nul-terminated.
</parameter_description>
</parameter>
</parameters>
-<return> the newly-created timeout source
+<return> a newly allocated string, that is a
+case independent form of @str.
</return>
</function>
-<function name="g_timeout_source_new_seconds">
+<function name="g_utf8_collate">
<description>
-Creates a new timeout source.
-
-The source will not initially be associated with any #GMainContext
-and must be added to one with g_source_attach() before it will be
-executed.
-
-The scheduling granularity/accuracy of this timeout source will be
-in seconds.
+Compares two strings for ordering using the linguistically
+correct rules for the <link linkend="setlocale">current locale</link>.
+When sorting a large number of strings, it will be significantly
+faster to obtain collation keys with g_utf8_collate_key() and
+compare the keys with strcmp() when sorting instead of sorting
+the original strings.
-Since: 2.14
</description>
<parameters>
-<parameter name="interval">
-<parameter_description> the timeout interval in seconds
+<parameter name="str1">
+<parameter_description> a UTF-8 encoded string
+</parameter_description>
+</parameter>
+<parameter name="str2">
+<parameter_description> a UTF-8 encoded string
</parameter_description>
</parameter>
</parameters>
-<return> the newly-created timeout source
-
+<return> < 0 if @str1 compares before @str2,
+0 if they compare equal, > 0 if @str1 compares after @str2.
</return>
</function>
-<function name="g_timer_continue">
+<function name="g_utf8_collate_key">
<description>
-Resumes a timer that has previously been stopped with
-g_timer_stop(). g_timer_stop() must be called before using this
-function.
+Converts a string into a collation key that can be compared
+with other collation keys produced by the same function using
+strcmp().
-Since: 2.4
+The results of comparing the collation keys of two strings
+with strcmp() will always be the same as comparing the two
+original keys with g_utf8_collate().
-</description>
-<parameters>
-<parameter name="timer">
-<parameter_description> a #GTimer.
-</parameter_description>
-</parameter>
-</parameters>
-<return></return>
-</function>
+Note that this function depends on the
+<link linkend="setlocale">current locale</link>.
-<function name="g_timer_destroy">
-<description>
-Destroys a timer, freeing associated resources.
</description>
<parameters>
-<parameter name="timer">
-<parameter_description> a #GTimer to destroy.
+<parameter name="str">
+<parameter_description> a UTF-8 encoded string.
+</parameter_description>
+</parameter>
+<parameter name="len">
+<parameter_description> length of @str, in bytes, or -1 if @str is nul-terminated.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a newly allocated string. This string should
+be freed with g_free() when you are done with it.
+</return>
</function>
-<function name="g_timer_elapsed">
+<function name="g_utf8_collate_key_for_filename">
<description>
-If @timer has been started but not stopped, obtains the time since
-the timer was started. If @timer has been stopped, obtains the
-elapsed time between the time it was started and the time it was
-stopped. The return value is the number of seconds elapsed,
-including any fractional part. The @microseconds out parameter is
-essentially useless.
+Converts a string into a collation key that can be compared
+with other collation keys produced by the same function using strcmp().
-<warning><para>
-Calling initialization functions, in particular g_thread_init(), while a
-timer is running will cause invalid return values from this function.
-</para></warning>
+In order to sort filenames correctly, this function treats the dot '.'
+as a special case. Most dictionary orderings seem to consider it
+insignificant, thus producing the ordering "event.c" "eventgenerator.c"
+"event.h" instead of "event.c" "event.h" "eventgenerator.c". Also, we
+would like to treat numbers intelligently so that "file1" "file10" "file5"
+is sorted as "file1" "file5" "file10".
+
+Note that this function depends on the
+<link linkend="setlocale">current locale</link>.
+
+Since: 2.8
</description>
<parameters>
-<parameter name="timer">
-<parameter_description> a #GTimer.
+<parameter name="str">
+<parameter_description> a UTF-8 encoded string.
</parameter_description>
</parameter>
-<parameter name="microseconds">
-<parameter_description> return location for the fractional part of seconds
-elapsed, in microseconds (that is, the total number
-of microseconds elapsed, modulo 1000000), or %NULL
+<parameter name="len">
+<parameter_description> length of @str, in bytes, or -1 if @str is nul-terminated.
</parameter_description>
</parameter>
</parameters>
-<return> seconds elapsed as a floating point value, including any
-fractional part.
+<return> a newly allocated string. This string should
+be freed with g_free() when you are done with it.
+
</return>
</function>
-<function name="g_timer_new">
+<function name="g_utf8_find_next_char">
<description>
-Creates a new timer, and starts timing (i.e. g_timer_start() is
-implicitly called for you).
+Finds the start of the next UTF-8 character in the string after @p.
-</description>
-<parameters>
-</parameters>
-<return> a new #GTimer.
-</return>
-</function>
+ p does not have to be at the beginning of a UTF-8 character. No check
+is made to see if the character found is actually valid other than
+it starts with an appropriate byte.
-<function name="g_timer_reset">
-<description>
-This function is useless; it's fine to call g_timer_start() on an
-already-started timer to reset the start time, so g_timer_reset()
-serves no purpose.
</description>
<parameters>
-<parameter name="timer">
-<parameter_description> a #GTimer.
+<parameter name="p">
+<parameter_description> a pointer to a position within a UTF-8 encoded string
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="g_timer_start">
-<description>
-Marks a start time, so that future calls to g_timer_elapsed() will
-report the time since g_timer_start() was called. g_timer_new()
-automatically marks the start time, so no need to call
-g_timer_start() immediately after creating the timer.
-
-</description>
-<parameters>
-<parameter name="timer">
-<parameter_description> a #GTimer.
+<parameter name="end">
+<parameter_description> a pointer to the byte following the end of the string,
+or %NULL to indicate that the string is nul-terminated.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a pointer to the found character or %NULL
+</return>
</function>
-<function name="g_timer_stop">
+<function name="g_utf8_find_prev_char">
<description>
-Marks an end time, so calls to g_timer_elapsed() will return the
-difference between this end time and the start time.
+Given a position @p with a UTF-8 encoded string @str, find the start
+of the previous UTF-8 character starting before @p. Returns %NULL if no
+UTF-8 characters are present in @str before @p.
-</description>
-<parameters>
-<parameter name="timer">
-<parameter_description> a #GTimer.
-</parameter_description>
-</parameter>
-</parameters>
-<return></return>
-</function>
+ p does not have to be at the beginning of a UTF-8 character. No check
+is made to see if the character found is actually valid other than
+it starts with an appropriate byte.
-<function name="g_tree_destroy">
-<description>
-Removes all keys and values from the #GTree and decreases its
-reference count by one. If keys and/or values are dynamically
-allocated, you should either free them first or create the #GTree
-using g_tree_new_full(). In the latter case the destroy functions
-you supplied will be called on all keys and values before destroying
-the #GTree.
</description>
<parameters>
-<parameter name="tree">
-<parameter_description> a #GTree.
+<parameter name="str">
+<parameter_description> pointer to the beginning of a UTF-8 encoded string
+</parameter_description>
+</parameter>
+<parameter name="p">
+<parameter_description> pointer to some position within @str
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a pointer to the found character or %NULL.
+</return>
</function>
-<function name="g_tree_foreach">
+<function name="g_utf8_get_char">
<description>
-Calls the given function for each of the key/value pairs in the #GTree.
-The function is passed the key and value of each pair, and the given
- data parameter. The tree is traversed in sorted order.
+Converts a sequence of bytes encoded as UTF-8 to a Unicode character.
+If @p does not point to a valid UTF-8 encoded character, results are
+undefined. If you are not sure that the bytes are complete
+valid Unicode characters, you should use g_utf8_get_char_validated()
+instead.
-The tree may not be modified while iterating over it (you can't
-add/remove items). To remove all items matching a predicate, you need
-to add each item to a list in your #GTraverseFunc as you walk over
-the tree, then walk the list and remove each item.
</description>
<parameters>
-<parameter name="tree">
-<parameter_description> a #GTree.
-</parameter_description>
-</parameter>
-<parameter name="func">
-<parameter_description> the function to call for each node visited. If this function
-returns %TRUE, the traversal is stopped.
-</parameter_description>
-</parameter>
-<parameter name="user_data">
-<parameter_description> user data to pass to the function.
+<parameter name="p">
+<parameter_description> a pointer to Unicode character encoded as UTF-8
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the resulting character
+</return>
</function>
-<function name="g_tree_height">
+<function name="g_utf8_get_char_validated">
<description>
-Gets the height of a #GTree.
-
-If the #GTree contains no nodes, the height is 0.
-If the #GTree contains only one root node the height is 1.
-If the root node has children the height is 2, etc.
+Convert a sequence of bytes encoded as UTF-8 to a Unicode character.
+This function checks for incomplete characters, for invalid characters
+such as characters that are out of the range of Unicode, and for
+overlong encodings of valid characters.
</description>
<parameters>
-<parameter name="tree">
-<parameter_description> a #GTree.
+<parameter name="p">
+<parameter_description> a pointer to Unicode character encoded as UTF-8
+</parameter_description>
+</parameter>
+<parameter name="max_len">
+<parameter_description> the maximum number of bytes to read, or -1, for no maximum or
+if @p is nul-terminated
</parameter_description>
</parameter>
</parameters>
-<return> the height of the #GTree.
+<return> the resulting character. If @p points to a partial
+sequence at the end of a string that could begin a valid
+character (or if @max_len is zero), returns (gunichar)-2;
+otherwise, if @p does not point to a valid UTF-8 encoded
+Unicode character, returns (gunichar)-1.
</return>
</function>
-<function name="g_tree_insert">
+<function name="g_utf8_normalize">
<description>
-Inserts a key/value pair into a #GTree. If the given key already exists
-in the #GTree its corresponding value is set to the new value. If you
-supplied a value_destroy_func when creating the #GTree, the old value is
-freed using that function. If you supplied a @key_destroy_func when
-creating the #GTree, the passed key is freed using that function.
+Converts a string into canonical form, standardizing
+such issues as whether a character with an accent
+is represented as a base character and combining
+accent or as a single precomposed character. The
+string has to be valid UTF-8, otherwise %NULL is
+returned. You should generally call g_utf8_normalize()
+before comparing two Unicode strings.
+
+The normalization mode %G_NORMALIZE_DEFAULT only
+standardizes differences that do not affect the
+text content, such as the above-mentioned accent
+representation. %G_NORMALIZE_ALL also standardizes
+the "compatibility" characters in Unicode, such
+as SUPERSCRIPT THREE to the standard forms
+(in this case DIGIT THREE). Formatting information
+may be lost but for most text operations such
+characters should be considered the same.
+
+%G_NORMALIZE_DEFAULT_COMPOSE and %G_NORMALIZE_ALL_COMPOSE
+are like %G_NORMALIZE_DEFAULT and %G_NORMALIZE_ALL,
+but returned a result with composed forms rather
+than a maximally decomposed form. This is often
+useful if you intend to convert the string to
+a legacy encoding or pass it to a system with
+less capable Unicode handling.
-The tree is automatically 'balanced' as new key/value pairs are added,
-so that the distance from the root to every leaf is as small as possible.
</description>
<parameters>
-<parameter name="tree">
-<parameter_description> a #GTree.
+<parameter name="str">
+<parameter_description> a UTF-8 encoded string.
</parameter_description>
</parameter>
-<parameter name="key">
-<parameter_description> the key to insert.
+<parameter name="len">
+<parameter_description> length of @str, in bytes, or -1 if @str is nul-terminated.
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> the value corresponding to the key.
+<parameter name="mode">
+<parameter_description> the type of normalization to perform.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a newly allocated string, that is the
+normalized form of @str, or %NULL if @str is not
+valid UTF-8.
+</return>
</function>
-<function name="g_tree_lookup">
+<function name="g_utf8_offset_to_pointer">
<description>
-Gets the value corresponding to the given key. Since a #GTree is
-automatically balanced as key/value pairs are added, key lookup is very
-fast.
+Converts from an integer character offset to a pointer to a position
+within the string.
+
+Since 2.10, this function allows to pass a negative @offset to
+step backwards. It is usually worth stepping backwards from the end
+instead of forwards if @offset is in the last fourth of the string,
+since moving forward is about 3 times faster than moving backward.
+
+<note><para>
+This function doesn't abort when reaching the end of @str. Therefore
+you should be sure that @offset is within string boundaries before
+calling that function. Call g_utf8_strlen() when unsure.
+
+This limitation exists as this function is called frequently during
+text rendering and therefore has to be as fast as possible.
+</para></note>
</description>
<parameters>
-<parameter name="tree">
-<parameter_description> a #GTree.
+<parameter name="str">
+<parameter_description> a UTF-8 encoded string
</parameter_description>
</parameter>
-<parameter name="key">
-<parameter_description> the key to look up.
+<parameter name="offset">
+<parameter_description> a character offset within @str
</parameter_description>
</parameter>
</parameters>
-<return> the value corresponding to the key, or %NULL if the key was
-not found.
+<return> the resulting pointer
</return>
</function>
-<function name="g_tree_lookup_extended">
+<function name="g_utf8_pointer_to_offset">
<description>
-Looks up a key in the #GTree, returning the original key and the
-associated value and a #gboolean which is %TRUE if the key was found. This
-is useful if you need to free the memory allocated for the original key,
-for example before calling g_tree_remove().
+Converts from a pointer to position within a string to a integer
+character offset.
+
+Since 2.10, this function allows @pos to be before @str, and returns
+a negative offset in this case.
</description>
<parameters>
-<parameter name="tree">
-<parameter_description> a #GTree.
-</parameter_description>
-</parameter>
-<parameter name="lookup_key">
-<parameter_description> the key to look up.
-</parameter_description>
-</parameter>
-<parameter name="orig_key">
-<parameter_description> returns the original key.
+<parameter name="str">
+<parameter_description> a UTF-8 encoded string
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> returns the value associated with the key.
+<parameter name="pos">
+<parameter_description> a pointer to a position within @str
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the key was found in the #GTree.
+<return> the resulting character offset
</return>
</function>
-<function name="g_tree_new">
+<function name="g_utf8_prev_char">
<description>
-Creates a new #GTree.
+Finds the previous UTF-8 character in the string before @p.
+
+ p does not have to be at the beginning of a UTF-8 character. No check
+is made to see if the character found is actually valid other than
+it starts with an appropriate byte. If @p might be the first
+character of the string, you must use g_utf8_find_prev_char() instead.
</description>
<parameters>
-<parameter name="key_compare_func">
-<parameter_description> the function used to order the nodes in the #GTree.
-It should return values similar to the standard strcmp() function -
-0 if the two arguments are equal, a negative value if the first argument
-comes before the second, or a positive value if the first argument comes
-after the second.
+<parameter name="p">
+<parameter_description> a pointer to a position within a UTF-8 encoded string
</parameter_description>
</parameter>
</parameters>
-<return> a new #GTree.
+<return> a pointer to the found character.
</return>
</function>
-<function name="g_tree_new_full">
+<function name="g_utf8_strchr">
<description>
-Creates a new #GTree like g_tree_new() and allows to specify functions
-to free the memory allocated for the key and value that get called when
-removing the entry from the #GTree.
+Finds the leftmost occurrence of the given Unicode character
+in a UTF-8 encoded string, while limiting the search to @len bytes.
+If @len is -1, allow unbounded search.
</description>
<parameters>
-<parameter name="key_compare_func">
-<parameter_description> qsort()-style comparison function.
+<parameter name="p">
+<parameter_description> a nul-terminated UTF-8 encoded string
</parameter_description>
</parameter>
-<parameter name="key_compare_data">
-<parameter_description> data to pass to comparison function.
+<parameter name="len">
+<parameter_description> the maximum length of @p
</parameter_description>
</parameter>
-<parameter name="key_destroy_func">
-<parameter_description> a function to free the memory allocated for the key
-used when removing the entry from the #GTree or %NULL if you don't
-want to supply such a function.
+<parameter name="c">
+<parameter_description> a Unicode character
</parameter_description>
</parameter>
-<parameter name="value_destroy_func">
-<parameter_description> a function to free the memory allocated for the
-value used when removing the entry from the #GTree or %NULL if you
-don't want to supply such a function.
+</parameters>
+<return> %NULL if the string does not contain the character,
+otherwise, a pointer to the start of the leftmost occurrence of
+the character in the string.
+</return>
+</function>
+
+<function name="g_utf8_strdown">
+<description>
+Converts all Unicode characters in the string that have a case
+to lowercase. The exact manner that this is done depends
+on the current locale, and may result in the number of
+characters in the string changing.
+
+
+</description>
+<parameters>
+<parameter name="str">
+<parameter_description> a UTF-8 encoded string
+</parameter_description>
+</parameter>
+<parameter name="len">
+<parameter_description> length of @str, in bytes, or -1 if @str is nul-terminated.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GTree.
+<return> a newly allocated string, with all characters
+converted to lowercase.
</return>
</function>
-<function name="g_tree_new_with_data">
+<function name="g_utf8_strlen">
<description>
-Creates a new #GTree with a comparison function that accepts user data.
-See g_tree_new() for more details.
+Computes the length of the string in characters, not including
+the terminating nul character.
</description>
<parameters>
-<parameter name="key_compare_func">
-<parameter_description> qsort()-style comparison function.
+<parameter name="p">
+<parameter_description> pointer to the start of a UTF-8 encoded string
</parameter_description>
</parameter>
-<parameter name="key_compare_data">
-<parameter_description> data to pass to comparison function.
+<parameter name="max">
+<parameter_description> the maximum number of bytes to examine. If @max
+is less than 0, then the string is assumed to be
+nul-terminated. If @max is 0, @p will not be examined and
+may be %NULL.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GTree.
+<return> the length of the string in characters
</return>
</function>
-<function name="g_tree_nnodes">
+<function name="g_utf8_strncpy">
<description>
-Gets the number of nodes in a #GTree.
+Like the standard C strncpy() function, but
+copies a given number of characters instead of a given number of
+bytes. The @src string must be valid UTF-8 encoded text.
+(Use g_utf8_validate() on all text before trying to use UTF-8
+utility functions with it.)
</description>
<parameters>
-<parameter name="tree">
-<parameter_description> a #GTree.
+<parameter name="dest">
+<parameter_description> buffer to fill with characters from @src
+</parameter_description>
+</parameter>
+<parameter name="src">
+<parameter_description> UTF-8 encoded string
+</parameter_description>
+</parameter>
+<parameter name="n">
+<parameter_description> character count
</parameter_description>
</parameter>
</parameters>
-<return> the number of nodes in the #GTree.
+<return> @dest
</return>
</function>
-<function name="g_tree_ref">
+<function name="g_utf8_strrchr">
<description>
-Increments the reference count of @tree by one. It is safe to call
-this function from any thread.
+Find the rightmost occurrence of the given Unicode character
+in a UTF-8 encoded string, while limiting the search to @len bytes.
+If @len is -1, allow unbounded search.
-Since: 2.22
</description>
<parameters>
-<parameter name="tree">
-<parameter_description> a #GTree.
+<parameter name="p">
+<parameter_description> a nul-terminated UTF-8 encoded string
+</parameter_description>
+</parameter>
+<parameter name="len">
+<parameter_description> the maximum length of @p
+</parameter_description>
+</parameter>
+<parameter name="c">
+<parameter_description> a Unicode character
</parameter_description>
</parameter>
</parameters>
-<return> the passed in #GTree.
-
+<return> %NULL if the string does not contain the character,
+otherwise, a pointer to the start of the rightmost occurrence of the
+character in the string.
</return>
</function>
-<function name="g_tree_remove">
+<function name="g_utf8_strreverse">
<description>
-Removes a key/value pair from a #GTree.
+Reverses a UTF-8 string. @str must be valid UTF-8 encoded text.
+(Use g_utf8_validate() on all text before trying to use UTF-8
+utility functions with it.)
-If the #GTree was created using g_tree_new_full(), the key and value
-are freed using the supplied destroy functions, otherwise you have to
-make sure that any dynamically allocated values are freed yourself.
-If the key does not exist in the #GTree, the function does nothing.
+This function is intended for programmatic uses of reversed strings.
+It pays no attention to decomposed characters, combining marks, byte
+order marks, directional indicators (LRM, LRO, etc) and similar
+characters which might need special handling when reversing a string
+for display purposes.
+
+Note that unlike g_strreverse(), this function returns
+newly-allocated memory, which should be freed with g_free() when
+no longer needed.
+Since: 2.2
</description>
<parameters>
-<parameter name="tree">
-<parameter_description> a #GTree.
+<parameter name="str">
+<parameter_description> a UTF-8 encoded string
</parameter_description>
</parameter>
-<parameter name="key">
-<parameter_description> the key to remove.
+<parameter name="len">
+<parameter_description> the maximum length of @str to use, in bytes. If @len < 0,
+then the string is nul-terminated.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the key was found (prior to 2.8, this function returned
-nothing)
+<return> a newly-allocated string which is the reverse of @str.
+
</return>
</function>
-<function name="g_tree_replace">
+<function name="g_utf8_strup">
<description>
-Inserts a new key and value into a #GTree similar to g_tree_insert().
-The difference is that if the key already exists in the #GTree, it gets
-replaced by the new key. If you supplied a @value_destroy_func when
-creating the #GTree, the old value is freed using that function. If you
-supplied a @key_destroy_func when creating the #GTree, the old key is
-freed using that function.
+Converts all Unicode characters in the string that have a case
+to uppercase. The exact manner that this is done depends
+on the current locale, and may result in the number of
+characters in the string increasing. (For instance, the
+German ess-zet will be changed to SS.)
-The tree is automatically 'balanced' as new key/value pairs are added,
-so that the distance from the root to every leaf is as small as possible.
</description>
<parameters>
-<parameter name="tree">
-<parameter_description> a #GTree.
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> the key to insert.
+<parameter name="str">
+<parameter_description> a UTF-8 encoded string
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> the value corresponding to the key.
+<parameter name="len">
+<parameter_description> length of @str, in bytes, or -1 if @str is nul-terminated.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a newly allocated string, with all characters
+converted to uppercase.
+</return>
</function>
-<function name="g_tree_search">
+<function name="g_utf8_to_ucs4">
<description>
-Searches a #GTree using @search_func.
-
-The @search_func is called with a pointer to the key of a key/value pair in
-the tree, and the passed in @user_data. If @search_func returns 0 for a
-key/value pair, then g_tree_search_func() will return the value of that
-pair. If @search_func returns -1, searching will proceed among the
-key/value pairs that have a smaller key; if @search_func returns 1,
-searching will proceed among the key/value pairs that have a larger key.
+Convert a string from UTF-8 to a 32-bit fixed width
+representation as UCS-4. A trailing 0 will be added to the
+string after the converted text.
</description>
<parameters>
-<parameter name="tree">
-<parameter_description> a #GTree.
+<parameter name="str">
+<parameter_description> a UTF-8 encoded string
</parameter_description>
</parameter>
-<parameter name="search_func">
-<parameter_description> a function used to search the #GTree.
+<parameter name="len">
+<parameter_description> the maximum length of @str to use, in bytes. If @len < 0,
+then the string is nul-terminated.
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> the data passed as the second argument to the @search_func
-function.
+<parameter name="items_read">
+<parameter_description> location to store number of bytes read, or %NULL.
+If %NULL, then %G_CONVERT_ERROR_PARTIAL_INPUT will be
+returned in case @str contains a trailing partial
+character. If an error occurs then the index of the
+invalid input is stored here.
+</parameter_description>
+</parameter>
+<parameter name="items_written">
+<parameter_description> location to store number of characters written or %NULL.
+The value here stored does not include the trailing 0
+character.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> location to store the error occuring, or %NULL to ignore
+errors. Any of the errors in #GConvertError other than
+%G_CONVERT_ERROR_NO_CONVERSION may occur.
</parameter_description>
</parameter>
</parameters>
-<return> the value corresponding to the found key, or %NULL if the key
-was not found.
+<return> a pointer to a newly allocated UCS-4 string.
+This value must be freed with g_free(). If an
+error occurs, %NULL will be returned and
+ error set.
</return>
</function>
-<function name="g_tree_steal">
+<function name="g_utf8_to_ucs4_fast">
<description>
-Removes a key and its associated value from a #GTree without calling
-the key and value destroy functions.
-
-If the key does not exist in the #GTree, the function does nothing.
+Convert a string from UTF-8 to a 32-bit fixed width
+representation as UCS-4, assuming valid UTF-8 input.
+This function is roughly twice as fast as g_utf8_to_ucs4()
+but does no error checking on the input.
</description>
<parameters>
-<parameter name="tree">
-<parameter_description> a #GTree.
+<parameter name="str">
+<parameter_description> a UTF-8 encoded string
</parameter_description>
</parameter>
-<parameter name="key">
-<parameter_description> the key to remove.
+<parameter name="len">
+<parameter_description> the maximum length of @str to use, in bytes. If @len < 0,
+then the string is nul-terminated.
+</parameter_description>
+</parameter>
+<parameter name="items_written">
+<parameter_description> location to store the number of characters in the
+result, or %NULL.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the key was found (prior to 2.8, this function returned
-nothing)
+<return> a pointer to a newly allocated UCS-4 string.
+This value must be freed with g_free().
</return>
</function>
-<function name="g_tree_traverse">
+<function name="g_utf8_to_utf16">
<description>
-Calls the given function for each node in the #GTree.
+Convert a string from UTF-8 to UTF-16. A 0 character will be
+added to the result after the converted text.
-Deprecated:2.2: The order of a balanced tree is somewhat arbitrary. If you
-just want to visit all nodes in sorted order, use g_tree_foreach()
-instead. If you really need to visit nodes in a different order, consider
-using an <link linkend="glib-N-ary-Trees">N-ary Tree</link>.
</description>
<parameters>
-<parameter name="tree">
-<parameter_description> a #GTree.
+<parameter name="str">
+<parameter_description> a UTF-8 encoded string
</parameter_description>
</parameter>
-<parameter name="traverse_func">
-<parameter_description> the function to call for each node visited. If this
-function returns %TRUE, the traversal is stopped.
+<parameter name="len">
+<parameter_description> the maximum length (number of bytes) of @str to use.
+If @len < 0, then the string is nul-terminated.
</parameter_description>
</parameter>
-<parameter name="traverse_type">
-<parameter_description> the order in which nodes are visited, one of %G_IN_ORDER,
-%G_PRE_ORDER and %G_POST_ORDER.
+<parameter name="items_read">
+<parameter_description> location to store number of bytes read, or %NULL.
+If %NULL, then %G_CONVERT_ERROR_PARTIAL_INPUT will be
+returned in case @str contains a trailing partial
+character. If an error occurs then the index of the
+invalid input is stored here.
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> user data to pass to the function.
+<parameter name="items_written">
+<parameter_description> location to store number of <type>gunichar2</type> written,
+or %NULL.
+The value stored here does not include the trailing 0.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> location to store the error occuring, or %NULL to ignore
+errors. Any of the errors in #GConvertError other than
+%G_CONVERT_ERROR_NO_CONVERSION may occur.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a pointer to a newly allocated UTF-16 string.
+This value must be freed with g_free(). If an
+error occurs, %NULL will be returned and
+ error set.
+</return>
</function>
-<function name="g_tree_unref">
+<function name="g_utf8_validate">
<description>
-Decrements the reference count of @tree by one. If the reference count
-drops to 0, all keys and values will be destroyed (if destroy
-functions were specified) and all memory allocated by @tree will be
-released.
+Validates UTF-8 encoded text. @str is the text to validate;
+if @str is nul-terminated, then @max_len can be -1, otherwise
+ max_len should be the number of bytes to validate.
+If @end is non-%NULL, then the end of the valid range
+will be stored there (i.e. the start of the first invalid
+character if some bytes were invalid, or the end of the text
+being validated otherwise).
-It is safe to call this function from any thread.
+Note that g_utf8_validate() returns %FALSE if @max_len is
+positive and NUL is met before @max_len bytes have been read.
-Since: 2.22
</description>
<parameters>
-<parameter name="tree">
-<parameter_description> a #GTree.
+<parameter name="str">
+<parameter_description> a pointer to character data
+</parameter_description>
+</parameter>
+<parameter name="max_len">
+<parameter_description> max bytes to validate, or -1 to go until NUL
+</parameter_description>
+</parameter>
+<parameter name="end">
+<parameter_description> return location for end of valid data
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the text was valid UTF-8
+</return>
</function>
-<function name="g_try_malloc">
+<function name="g_utime">
<description>
-Attempts to allocate @n_bytes, and returns %NULL on failure.
-Contrast with g_malloc(), which aborts the program on failure.
+A wrapper for the POSIX utime() function. The utime() function
+sets the access and modification timestamps of a file.
+
+See your C library manual for more details about how utime() works
+on your system.
+Since: 2.18
</description>
<parameters>
-<parameter name="n_bytes">
-<parameter_description> number of bytes to allocate.
+<parameter name="filename">
+<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows)
+</parameter_description>
+</parameter>
+<parameter name="utb">
+<parameter_description> a pointer to a struct utimbuf.
</parameter_description>
</parameter>
</parameters>
-<return> the allocated memory, or %NULL.
+<return> 0 if the operation was successful, -1 if an error
+occurred
+
</return>
</function>
-<function name="g_try_malloc0">
+<function name="g_value_array_append">
<description>
-Attempts to allocate @n_bytes, initialized to 0's, and returns %NULL on
-failure. Contrast with g_malloc0(), which aborts the program on failure.
+Insert a copy of @value as last element of @value_array. If @value is
+%NULL, an uninitialized value is appended.
-Since: 2.8
</description>
<parameters>
-<parameter name="n_bytes">
-<parameter_description> number of bytes to allocate
+<parameter name="value_array">
+<parameter_description> #GValueArray to add an element to
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> #GValue to copy into #GValueArray, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the allocated memory, or %NULL
+<return> the #GValueArray passed in as @value_array
</return>
</function>
-<function name="g_try_malloc0_n">
+<function name="g_value_array_copy">
<description>
-This function is similar to g_try_malloc0(), allocating (@n_blocks * @n_block_bytes) bytes,
-but care is taken to detect possible overflow during multiplication.
+Construct an exact copy of a #GValueArray by duplicating all its
+contents.
-Since: 2.24
</description>
<parameters>
-<parameter name="n_blocks">
-<parameter_description> the number of blocks to allocate
-</parameter_description>
-</parameter>
-<parameter name="n_block_bytes">
-<parameter_description> the size of each block in bytes
+<parameter name="value_array">
+<parameter_description> #GValueArray to copy
</parameter_description>
</parameter>
</parameters>
-<return> the allocated memory, or %NULL
+<return> Newly allocated copy of #GValueArray
</return>
</function>
-<function name="g_try_malloc_n">
+<function name="g_value_array_free">
<description>
-This function is similar to g_try_malloc(), allocating (@n_blocks * @n_block_bytes) bytes,
-but care is taken to detect possible overflow during multiplication.
-
-Since: 2.24
+Free a #GValueArray including its contents.
</description>
<parameters>
-<parameter name="n_blocks">
-<parameter_description> the number of blocks to allocate
-</parameter_description>
-</parameter>
-<parameter name="n_block_bytes">
-<parameter_description> the size of each block in bytes
+<parameter name="value_array">
+<parameter_description> #GValueArray to free
</parameter_description>
</parameter>
</parameters>
-<return> the allocated memory, or %NULL.
-</return>
+<return></return>
</function>
-<function name="g_try_realloc">
+<function name="g_value_array_get_nth">
<description>
-Attempts to realloc @mem to a new size, @n_bytes, and returns %NULL
-on failure. Contrast with g_realloc(), which aborts the program
-on failure. If @mem is %NULL, behaves the same as g_try_malloc().
+Return a pointer to the value at @index_ containd in @value_array.
</description>
<parameters>
-<parameter name="mem">
-<parameter_description> previously-allocated memory, or %NULL.
+<parameter name="value_array">
+<parameter_description> #GValueArray to get a value from
</parameter_description>
</parameter>
-<parameter name="n_bytes">
-<parameter_description> number of bytes to allocate.
+<parameter name="index_">
+<parameter_description> index of the value of interest
</parameter_description>
</parameter>
</parameters>
-<return> the allocated memory, or %NULL.
+<return> pointer to a value at @index_ in @value_array
</return>
</function>
-<function name="g_try_realloc_n">
+<function name="g_value_array_insert">
<description>
-This function is similar to g_try_realloc(), allocating (@n_blocks * @n_block_bytes) bytes,
-but care is taken to detect possible overflow during multiplication.
+Insert a copy of @value at specified position into @value_array. If @value
+is %NULL, an uninitialized value is inserted.
-Since: 2.24
</description>
<parameters>
-<parameter name="mem">
-<parameter_description> previously-allocated memory, or %NULL.
+<parameter name="value_array">
+<parameter_description> #GValueArray to add an element to
</parameter_description>
</parameter>
-<parameter name="n_blocks">
-<parameter_description> the number of blocks to allocate
+<parameter name="index_">
+<parameter_description> insertion position, must be <= value_array->n_values
</parameter_description>
</parameter>
-<parameter name="n_block_bytes">
-<parameter_description> the size of each block in bytes
+<parameter name="value">
+<parameter_description> #GValue to copy into #GValueArray, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the allocated memory, or %NULL.
+<return> the #GValueArray passed in as @value_array
</return>
</function>
-<function name="g_tuples_destroy">
+<function name="g_value_array_new">
<description>
-Frees the records which were returned by g_relation_select(). This
-should always be called after g_relation_select() when you are
-finished with the records. The records are not removed from the
-#GRelation.
+Allocate and initialize a new #GValueArray, optionally preserve space
+for @n_prealloced elements. New arrays always contain 0 elements,
+regardless of the value of @n_prealloced.
-Deprecated: 2.26: Rarely used API
</description>
<parameters>
-<parameter name="tuples">
-<parameter_description> the tuple data to free.
+<parameter name="n_prealloced">
+<parameter_description> number of values to preallocate space for
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a newly allocated #GValueArray with 0 values
+</return>
</function>
-<function name="g_tuples_index">
+<function name="g_value_array_prepend">
<description>
-Gets a field from the records returned by g_relation_select(). It
-returns the given field of the record at the given index. The
-returned value should not be changed.
+Insert a copy of @value as first element of @value_array. If @value is
+%NULL, an uninitialized value is prepended.
+
-Deprecated: 2.26: Rarely used API
</description>
<parameters>
-<parameter name="tuples">
-<parameter_description> the tuple data, returned by g_relation_select().
-</parameter_description>
-</parameter>
-<parameter name="index_">
-<parameter_description> the index of the record.
+<parameter name="value_array">
+<parameter_description> #GValueArray to add an element to
</parameter_description>
</parameter>
-<parameter name="field">
-<parameter_description> the field to return.
+<parameter name="value">
+<parameter_description> #GValue to copy into #GValueArray, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the field of the record.
+<return> the #GValueArray passed in as @value_array
</return>
</function>
-<function name="g_ucs4_to_utf16">
+<function name="g_value_array_remove">
<description>
-Convert a string from UCS-4 to UTF-16. A 0 character will be
-added to the result after the converted text.
+Remove the value at position @index_ from @value_array.
</description>
<parameters>
-<parameter name="str">
-<parameter_description> a UCS-4 encoded string
-</parameter_description>
-</parameter>
-<parameter name="len">
-<parameter_description> the maximum length (number of characters) of @str to use.
-If @len < 0, then the string is nul-terminated.
-</parameter_description>
-</parameter>
-<parameter name="items_read">
-<parameter_description> location to store number of bytes read, or %NULL.
-If an error occurs then the index of the invalid input
-is stored here.
-</parameter_description>
-</parameter>
-<parameter name="items_written">
-<parameter_description> location to store number of <type>gunichar2</type>
-written, or %NULL. The value stored here does not
-include the trailing 0.
+<parameter name="value_array">
+<parameter_description> #GValueArray to remove an element from
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> location to store the error occuring, or %NULL to ignore
-errors. Any of the errors in #GConvertError other than
-%G_CONVERT_ERROR_NO_CONVERSION may occur.
+<parameter name="index_">
+<parameter_description> position of value to remove, which must be less than
+<code>value_array-><link
+linkend="GValueArray.n-values">n_values</link></code>
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to a newly allocated UTF-16 string.
-This value must be freed with g_free(). If an
-error occurs, %NULL will be returned and
- error set.
+<return> the #GValueArray passed in as @value_array
</return>
</function>
-<function name="g_ucs4_to_utf8">
+<function name="g_value_array_sort">
<description>
-Convert a string from a 32-bit fixed width representation as UCS-4.
-to UTF-8. The result will be terminated with a 0 byte.
+Sort @value_array using @compare_func to compare the elements accoring to
+the semantics of #GCompareFunc.
+
+The current implementation uses Quick-Sort as sorting algorithm.
</description>
<parameters>
-<parameter name="str">
-<parameter_description> a UCS-4 encoded string
-</parameter_description>
-</parameter>
-<parameter name="len">
-<parameter_description> the maximum length (number of characters) of @str to use.
-If @len < 0, then the string is nul-terminated.
-</parameter_description>
-</parameter>
-<parameter name="items_read">
-<parameter_description> location to store number of characters read, or %NULL.
-</parameter_description>
-</parameter>
-<parameter name="items_written">
-<parameter_description> location to store number of bytes written or %NULL.
-The value here stored does not include the trailing 0
-byte.
+<parameter name="value_array">
+<parameter_description> #GValueArray to sort
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> location to store the error occuring, or %NULL to ignore
-errors. Any of the errors in #GConvertError other than
-%G_CONVERT_ERROR_NO_CONVERSION may occur.
+<parameter name="compare_func">
+<parameter_description> function to compare elements
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to a newly allocated UTF-8 string.
-This value must be freed with g_free(). If an
-error occurs, %NULL will be returned and
- error set. In that case, @items_read will be
-set to the position of the first invalid input
-character.
+<return> the #GValueArray passed in as @value_array
</return>
</function>
-<function name="g_unichar_break_type">
+<function name="g_value_array_sort_with_data">
<description>
-Determines the break type of @c. @c should be a Unicode character
-(to derive a character from UTF-8 encoded text, use
-g_utf8_get_char()). The break type is used to find word and line
-breaks ("text boundaries"), Pango implements the Unicode boundary
-resolution algorithms and normally you would use a function such
-as pango_break() instead of caring about break types yourself.
+Sort @value_array using @compare_func to compare the elements accoring
+to the semantics of #GCompareDataFunc.
+
+The current implementation uses Quick-Sort as sorting algorithm.
</description>
<parameters>
-<parameter name="c">
-<parameter_description> a Unicode character
+<parameter name="value_array">
+<parameter_description> #GValueArray to sort
+</parameter_description>
+</parameter>
+<parameter name="compare_func">
+<parameter_description> function to compare elements
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> extra data argument provided for @compare_func
</parameter_description>
</parameter>
</parameters>
-<return> the break type of @c
+<return> the #GValueArray passed in as @value_array
</return>
</function>
-<function name="g_unichar_combining_class">
+<function name="g_value_copy">
<description>
-Determines the canonical combining class of a Unicode character.
-
-Since: 2.14
+Copies the value of @src_value into @dest_value.
</description>
<parameters>
-<parameter name="uc">
-<parameter_description> a Unicode character
+<parameter name="src_value">
+<parameter_description> An initialized #GValue structure.
+</parameter_description>
+</parameter>
+<parameter name="dest_value">
+<parameter_description> An initialized #GValue structure of the same type as @src_value.
</parameter_description>
</parameter>
</parameters>
-<return> the combining class of the character
-
-</return>
+<return></return>
</function>
-<function name="g_unichar_digit_value">
+<function name="g_value_dup_boxed">
<description>
-Determines the numeric value of a character as a decimal
-digit.
+Get the contents of a %G_TYPE_BOXED derived #GValue. Upon getting,
+the boxed value is duplicated and needs to be later freed with
+g_boxed_free(), e.g. like: g_boxed_free (G_VALUE_TYPE (@value),
+return_value);
</description>
<parameters>
-<parameter name="c">
-<parameter_description> a Unicode character
+<parameter name="value">
+<parameter_description> a valid #GValue of %G_TYPE_BOXED derived type
</parameter_description>
</parameter>
</parameters>
-<return> If @c is a decimal digit (according to
-g_unichar_isdigit()), its numeric value. Otherwise, -1.
+<return> boxed contents of @value
</return>
</function>
-<function name="g_unichar_get_mirror_char">
+<function name="g_value_dup_object">
<description>
-In Unicode, some characters are <firstterm>mirrored</firstterm>. This
-means that their images are mirrored horizontally in text that is laid
-out from right to left. For instance, "(" would become its mirror image,
-")", in right-to-left text.
+Get the contents of a %G_TYPE_OBJECT derived #GValue, increasing
+its reference count. If the contents of the #GValue are %NULL, then
+%NULL will be returned.
-If @ch has the Unicode mirrored property and there is another unicode
-character that typically has a glyph that is the mirror image of @ch's
-glyph and @mirrored_ch is set, it puts that character in the address
-pointed to by @mirrored_ch. Otherwise the original character is put.
-
-Since: 2.4
</description>
<parameters>
-<parameter name="ch">
-<parameter_description> a Unicode character
-</parameter_description>
-</parameter>
-<parameter name="mirrored_ch">
-<parameter_description> location to store the mirrored character
+<parameter name="value">
+<parameter_description> a valid #GValue whose type is derived from %G_TYPE_OBJECT
</parameter_description>
</parameter>
-</parameters>
-<return> %TRUE if @ch has a mirrored character, %FALSE otherwise
-
+</parameters>
+<return> object content of @value,
+should be unreferenced when no longer needed.
</return>
</function>
-<function name="g_unichar_get_script">
+<function name="g_value_dup_param">
<description>
-Looks up the #GUnicodeScript for a particular character (as defined
-by Unicode Standard Annex #24). No check is made for @ch being a
-valid Unicode character; if you pass in invalid character, the
-result is undefined.
-
-This function is equivalent to pango_script_for_unichar() and the
-two are interchangeable.
+Get the contents of a %G_TYPE_PARAM #GValue, increasing its
+reference count.
-Since: 2.14
</description>
<parameters>
-<parameter name="ch">
-<parameter_description> a Unicode character
+<parameter name="value">
+<parameter_description> a valid #GValue whose type is derived from %G_TYPE_PARAM
</parameter_description>
</parameter>
</parameters>
-<return> the #GUnicodeScript for the character.
-
+<return> #GParamSpec content of @value, should be unreferenced when
+no longer needed.
</return>
</function>
-<function name="g_unichar_isalnum">
+<function name="g_value_dup_string">
<description>
-Determines whether a character is alphanumeric.
-Given some UTF-8 text, obtain a character value
-with g_utf8_get_char().
+Get a copy the contents of a %G_TYPE_STRING #GValue.
</description>
<parameters>
-<parameter name="c">
-<parameter_description> a Unicode character
+<parameter name="value">
+<parameter_description> a valid #GValue of type %G_TYPE_STRING
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @c is an alphanumeric character
+<return> a newly allocated copy of the string content of @value
</return>
</function>
-<function name="g_unichar_isalpha">
+<function name="g_value_dup_variant">
<description>
-Determines whether a character is alphabetic (i.e. a letter).
-Given some UTF-8 text, obtain a character value with
-g_utf8_get_char().
+Get the contents of a variant #GValue, increasing its refcount.
+Since: 2.26
</description>
<parameters>
-<parameter name="c">
-<parameter_description> a Unicode character
+<parameter name="value">
+<parameter_description> a valid #GValue of type %G_TYPE_VARIANT
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @c is an alphabetic character
+<return> variant contents of @value, should be unrefed using
+g_variant_unref() when no longer needed
+
</return>
</function>
-<function name="g_unichar_iscntrl">
+<function name="g_value_fits_pointer">
<description>
-Determines whether a character is a control character.
-Given some UTF-8 text, obtain a character value with
-g_utf8_get_char().
+Determines if @value will fit inside the size of a pointer value.
+This is an internal function introduced mainly for C marshallers.
</description>
<parameters>
-<parameter name="c">
-<parameter_description> a Unicode character
+<parameter name="value">
+<parameter_description> An initialized #GValue structure.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @c is a control character
+<return> %TRUE if @value will fit inside a pointer value.
</return>
</function>
-<function name="g_unichar_isdefined">
+<function name="g_value_get_boolean">
<description>
-Determines if a given character is assigned in the Unicode
-standard.
+Get the contents of a %G_TYPE_BOOLEAN #GValue.
</description>
<parameters>
-<parameter name="c">
-<parameter_description> a Unicode character
+<parameter name="value">
+<parameter_description> a valid #GValue of type %G_TYPE_BOOLEAN
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the character has an assigned value
+<return> boolean contents of @value
</return>
</function>
-<function name="g_unichar_isdigit">
+<function name="g_value_get_boxed">
<description>
-Determines whether a character is numeric (i.e. a digit). This
-covers ASCII 0-9 and also digits in other languages/scripts. Given
-some UTF-8 text, obtain a character value with g_utf8_get_char().
+Get the contents of a %G_TYPE_BOXED derived #GValue.
</description>
<parameters>
-<parameter name="c">
-<parameter_description> a Unicode character
+<parameter name="value">
+<parameter_description> a valid #GValue of %G_TYPE_BOXED derived type
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @c is a digit
+<return> boxed contents of @value
</return>
</function>
-<function name="g_unichar_isgraph">
+<function name="g_value_get_char">
<description>
-Determines whether a character is printable and not a space
-(returns %FALSE for control characters, format characters, and
-spaces). g_unichar_isprint() is similar, but returns %TRUE for
-spaces. Given some UTF-8 text, obtain a character value with
-g_utf8_get_char().
+Get the contents of a %G_TYPE_CHAR #GValue.
</description>
<parameters>
-<parameter name="c">
-<parameter_description> a Unicode character
+<parameter name="value">
+<parameter_description> a valid #GValue of type %G_TYPE_CHAR
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @c is printable unless it's a space
+<return> character contents of @value
</return>
</function>
-<function name="g_unichar_islower">
+<function name="g_value_get_double">
<description>
-Determines whether a character is a lowercase letter.
-Given some UTF-8 text, obtain a character value with
-g_utf8_get_char().
+Get the contents of a %G_TYPE_DOUBLE #GValue.
</description>
<parameters>
-<parameter name="c">
-<parameter_description> a Unicode character
+<parameter name="value">
+<parameter_description> a valid #GValue of type %G_TYPE_DOUBLE
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @c is a lowercase letter
+<return> double contents of @value
</return>
</function>
-<function name="g_unichar_ismark">
+<function name="g_value_get_enum">
<description>
-Determines whether a character is a mark (non-spacing mark,
-combining mark, or enclosing mark in Unicode speak).
-Given some UTF-8 text, obtain a character value
-with g_utf8_get_char().
+Get the contents of a %G_TYPE_ENUM #GValue.
-Note: in most cases where isalpha characters are allowed,
-ismark characters should be allowed to as they are essential
-for writing most European languages as well as many non-Latin
-scripts.
-
-Since: 2.14
</description>
<parameters>
-<parameter name="c">
-<parameter_description> a Unicode character
+<parameter name="value">
+<parameter_description> a valid #GValue whose type is derived from %G_TYPE_ENUM
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @c is a mark character
-
+<return> enum contents of @value
</return>
</function>
-<function name="g_unichar_isprint">
+<function name="g_value_get_flags">
<description>
-Determines whether a character is printable.
-Unlike g_unichar_isgraph(), returns %TRUE for spaces.
-Given some UTF-8 text, obtain a character value with
-g_utf8_get_char().
+Get the contents of a %G_TYPE_FLAGS #GValue.
</description>
<parameters>
-<parameter name="c">
-<parameter_description> a Unicode character
+<parameter name="value">
+<parameter_description> a valid #GValue whose type is derived from %G_TYPE_FLAGS
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @c is printable
+<return> flags contents of @value
</return>
</function>
-<function name="g_unichar_ispunct">
+<function name="g_value_get_float">
<description>
-Determines whether a character is punctuation or a symbol.
-Given some UTF-8 text, obtain a character value with
-g_utf8_get_char().
+Get the contents of a %G_TYPE_FLOAT #GValue.
</description>
<parameters>
-<parameter name="c">
-<parameter_description> a Unicode character
+<parameter name="value">
+<parameter_description> a valid #GValue of type %G_TYPE_FLOAT
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @c is a punctuation or symbol character
+<return> float contents of @value
</return>
</function>
-<function name="g_unichar_isspace">
+<function name="g_value_get_gtype">
<description>
-Determines whether a character is a space, tab, or line separator
-(newline, carriage return, etc.). Given some UTF-8 text, obtain a
-character value with g_utf8_get_char().
+Get the contents of a %G_TYPE_GTYPE #GValue.
-(Note: don't use this to do word breaking; you have to use
-Pango or equivalent to get word breaking right, the algorithm
-is fairly complex.)
+Since: 2.12
</description>
<parameters>
-<parameter name="c">
-<parameter_description> a Unicode character
+<parameter name="value">
+<parameter_description> a valid #GValue of type %G_TYPE_GTYPE
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @c is a space character
+<return> the #GType stored in @value
</return>
</function>
-<function name="g_unichar_istitle">
+<function name="g_value_get_int">
<description>
-Determines if a character is titlecase. Some characters in
-Unicode which are composites, such as the DZ digraph
-have three case variants instead of just two. The titlecase
-form is used at the beginning of a word where only the
-first letter is capitalized. The titlecase form of the DZ
-digraph is U+01F2 LATIN CAPITAL LETTTER D WITH SMALL LETTER Z.
+Get the contents of a %G_TYPE_INT #GValue.
</description>
<parameters>
-<parameter name="c">
-<parameter_description> a Unicode character
+<parameter name="value">
+<parameter_description> a valid #GValue of type %G_TYPE_INT
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the character is titlecase
+<return> integer contents of @value
</return>
</function>
-<function name="g_unichar_isupper">
+<function name="g_value_get_int64">
<description>
-Determines if a character is uppercase.
+Get the contents of a %G_TYPE_INT64 #GValue.
</description>
<parameters>
-<parameter name="c">
-<parameter_description> a Unicode character
+<parameter name="value">
+<parameter_description> a valid #GValue of type %G_TYPE_INT64
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @c is an uppercase character
+<return> 64bit integer contents of @value
</return>
</function>
-<function name="g_unichar_iswide">
+<function name="g_value_get_long">
<description>
-Determines if a character is typically rendered in a double-width
-cell.
+Get the contents of a %G_TYPE_LONG #GValue.
</description>
<parameters>
-<parameter name="c">
-<parameter_description> a Unicode character
+<parameter name="value">
+<parameter_description> a valid #GValue of type %G_TYPE_LONG
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the character is wide
+<return> long integer contents of @value
</return>
</function>
-<function name="g_unichar_iswide_cjk">
+<function name="g_value_get_object">
<description>
-Determines if a character is typically rendered in a double-width
-cell under legacy East Asian locales. If a character is wide according to
-g_unichar_iswide(), then it is also reported wide with this function, but
-the converse is not necessarily true. See the
-<ulink url="http://www.unicode.org/reports/tr11/">Unicode Standard
-Annex #11</ulink> for details.
-
-If a character passes the g_unichar_iswide() test then it will also pass
-this test, but not the other way around. Note that some characters may
-pas both this test and g_unichar_iszerowidth().
+Get the contents of a %G_TYPE_OBJECT derived #GValue.
-Since: 2.12
</description>
<parameters>
-<parameter name="c">
-<parameter_description> a Unicode character
+<parameter name="value">
+<parameter_description> a valid #GValue of %G_TYPE_OBJECT derived type
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the character is wide in legacy East Asian locales
-
+<return> object contents of @value
</return>
</function>
-<function name="g_unichar_isxdigit">
+<function name="g_value_get_param">
<description>
-Determines if a character is a hexidecimal digit.
+Get the contents of a %G_TYPE_PARAM #GValue.
</description>
<parameters>
-<parameter name="c">
-<parameter_description> a Unicode character.
+<parameter name="value">
+<parameter_description> a valid #GValue whose type is derived from %G_TYPE_PARAM
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the character is a hexadecimal digit
+<return> #GParamSpec content of @value
</return>
</function>
-<function name="g_unichar_iszerowidth">
+<function name="g_value_get_pointer">
<description>
-Determines if a given character typically takes zero width when rendered.
-The return value is %TRUE for all non-spacing and enclosing marks
-(e.g., combining accents), format characters, zero-width
-space, but not U+00AD SOFT HYPHEN.
-
-A typical use of this function is with one of g_unichar_iswide() or
-g_unichar_iswide_cjk() to determine the number of cells a string occupies
-when displayed on a grid display (terminals). However, note that not all
-terminals support zero-width rendering of zero-width marks.
+Get the contents of a pointer #GValue.
-Since: 2.14
</description>
<parameters>
-<parameter name="c">
-<parameter_description> a Unicode character
+<parameter name="value">
+<parameter_description> a valid #GValue of %G_TYPE_POINTER
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the character has zero width
-
+<return> pointer contents of @value
</return>
</function>
-<function name="g_unichar_to_utf8">
+<function name="g_value_get_string">
<description>
-Converts a single character to UTF-8.
+Get the contents of a %G_TYPE_STRING #GValue.
</description>
<parameters>
-<parameter name="c">
-<parameter_description> a Unicode character code
-</parameter_description>
-</parameter>
-<parameter name="outbuf">
-<parameter_description> output buffer, must have at least 6 bytes of space.
-If %NULL, the length will be computed and returned
-and nothing will be written to @outbuf.
+<parameter name="value">
+<parameter_description> a valid #GValue of type %G_TYPE_STRING
</parameter_description>
</parameter>
</parameters>
-<return> number of bytes written
+<return> string content of @value
</return>
</function>
-<function name="g_unichar_tolower">
+<function name="g_value_get_uchar">
<description>
-Converts a character to lower case.
+Get the contents of a %G_TYPE_UCHAR #GValue.
</description>
<parameters>
-<parameter name="c">
-<parameter_description> a Unicode character.
+<parameter name="value">
+<parameter_description> a valid #GValue of type %G_TYPE_UCHAR
</parameter_description>
</parameter>
</parameters>
-<return> the result of converting @c to lower case.
-If @c is not an upperlower or titlecase character,
-or has no lowercase equivalent @c is returned unchanged.
+<return> unsigned character contents of @value
</return>
</function>
-<function name="g_unichar_totitle">
+<function name="g_value_get_uint">
<description>
-Converts a character to the titlecase.
+Get the contents of a %G_TYPE_UINT #GValue.
</description>
<parameters>
-<parameter name="c">
-<parameter_description> a Unicode character
+<parameter name="value">
+<parameter_description> a valid #GValue of type %G_TYPE_UINT
</parameter_description>
</parameter>
</parameters>
-<return> the result of converting @c to titlecase.
-If @c is not an uppercase or lowercase character,
- c is returned unchanged.
+<return> unsigned integer contents of @value
</return>
</function>
-<function name="g_unichar_toupper">
+<function name="g_value_get_uint64">
<description>
-Converts a character to uppercase.
+Get the contents of a %G_TYPE_UINT64 #GValue.
</description>
<parameters>
-<parameter name="c">
-<parameter_description> a Unicode character
+<parameter name="value">
+<parameter_description> a valid #GValue of type %G_TYPE_UINT64
</parameter_description>
</parameter>
</parameters>
-<return> the result of converting @c to uppercase.
-If @c is not an lowercase or titlecase character,
-or has no upper case equivalent @c is returned unchanged.
+<return> unsigned 64bit integer contents of @value
</return>
</function>
-<function name="g_unichar_type">
+<function name="g_value_get_ulong">
<description>
-Classifies a Unicode character by type.
+Get the contents of a %G_TYPE_ULONG #GValue.
</description>
<parameters>
-<parameter name="c">
-<parameter_description> a Unicode character
+<parameter name="value">
+<parameter_description> a valid #GValue of type %G_TYPE_ULONG
</parameter_description>
</parameter>
</parameters>
-<return> the type of the character.
+<return> unsigned long integer contents of @value
</return>
</function>
-<function name="g_unichar_validate">
+<function name="g_value_get_variant">
<description>
-Checks whether @ch is a valid Unicode character. Some possible
-integer values of @ch will not be valid. 0 is considered a valid
-character, though it's normally a string terminator.
+Get the contents of a variant #GValue.
+Since: 2.26
</description>
<parameters>
-<parameter name="ch">
-<parameter_description> a Unicode character
+<parameter name="value">
+<parameter_description> a valid #GValue of type %G_TYPE_VARIANT
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @ch is a valid Unicode character
+<return> variant contents of @value
+
</return>
</function>
-<function name="g_unichar_xdigit_value">
+<function name="g_value_init">
<description>
-Determines the numeric value of a character as a hexidecimal
-digit.
+Initializes @value with the default value of @type.
</description>
<parameters>
-<parameter name="c">
-<parameter_description> a Unicode character
+<parameter name="value">
+<parameter_description> A zero-filled (uninitialized) #GValue structure.
+</parameter_description>
+</parameter>
+<parameter name="g_type">
+<parameter_description> Type the #GValue should hold values of.
</parameter_description>
</parameter>
</parameters>
-<return> If @c is a hex digit (according to
-g_unichar_isxdigit()), its numeric value. Otherwise, -1.
+<return> the #GValue structure that has been passed in
</return>
</function>
-<function name="g_unicode_canonical_decomposition">
+<function name="g_value_peek_pointer">
<description>
-Computes the canonical decomposition of a Unicode character.
-
</description>
<parameters>
-<parameter name="ch">
-<parameter_description> a Unicode character.
-</parameter_description>
-</parameter>
-<parameter name="result_len">
-<parameter_description> location to store the length of the return value.
+<parameter name="value">
+<parameter_description> An initialized #GValue structure.
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated string of Unicode characters.
- result_len is set to the resulting length of the string.
+<return> the value contents as pointer. This
+function asserts that g_value_fits_pointer() returned %TRUE for the
+passed in value. This is an internal function introduced mainly
+for C marshallers.
</return>
</function>
-<function name="g_unicode_canonical_ordering">
+<function name="g_value_register_transform_func">
<description>
-Computes the canonical ordering of a string in-place.
-This rearranges decomposed characters in the string
-according to their combining classes. See the Unicode
-manual for more information.
+Registers a value transformation function for use in g_value_transform().
+A previously registered transformation function for @src_type and @dest_type
+will be replaced.
</description>
<parameters>
-<parameter name="string">
-<parameter_description> a UCS-4 encoded string.
+<parameter name="src_type">
+<parameter_description> Source type.
</parameter_description>
</parameter>
-<parameter name="len">
-<parameter_description> the maximum length of @string to use.
+<parameter name="dest_type">
+<parameter_description> Target type.
+</parameter_description>
+</parameter>
+<parameter name="transform_func">
+<parameter_description> a function which transforms values of type @src_type
+into value of type @dest_type
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_unlink">
+<function name="g_value_reset">
<description>
-A wrapper for the POSIX unlink() function. The unlink() function
-deletes a name from the filesystem. If this was the last link to the
-file and no processes have it opened, the diskspace occupied by the
-file is freed.
-
-See your C library manual for more details about unlink(). Note
-that on Windows, it is in general not possible to delete files that
-are open to some process, or mapped into memory.
+Clears the current value in @value and resets it to the default value
+(as if the value had just been initialized).
-Since: 2.6
</description>
<parameters>
-<parameter name="filename">
-<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows)
+<parameter name="value">
+<parameter_description> An initialized #GValue structure.
</parameter_description>
</parameter>
</parameters>
-<return> 0 if the name was successfully deleted, -1 if an error
-occurred
-
+<return> the #GValue structure that has been passed in
</return>
</function>
-<function name="g_unsetenv">
+<function name="g_value_set_boolean">
<description>
-Removes an environment variable from the environment.
-
-Note that on some systems, when variables are overwritten, the memory
-used for the previous variables and its value isn't reclaimed.
-Furthermore, this function can't be guaranteed to operate in a
-threadsafe way.
-
-Since: 2.4
+Set the contents of a %G_TYPE_BOOLEAN #GValue to @v_boolean.
</description>
<parameters>
-<parameter name="variable">
-<parameter_description> the environment variable to remove, must not contain '='.
+<parameter name="value">
+<parameter_description> a valid #GValue of type %G_TYPE_BOOLEAN
+</parameter_description>
+</parameter>
+<parameter name="v_boolean">
+<parameter_description> boolean value to be set
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="g_uri_escape_string">
+<function name="g_value_set_boxed">
<description>
-Escapes a string for use in a URI.
-
-Normally all characters that are not "unreserved" (i.e. ASCII alphanumerical
-characters plus dash, dot, underscore and tilde) are escaped.
-But if you specify characters in @reserved_chars_allowed they are not
-escaped. This is useful for the "reserved" characters in the URI
-specification, since those are allowed unescaped in some portions of
-a URI.
-
-Since: 2.16
+Set the contents of a %G_TYPE_BOXED derived #GValue to @v_boxed.
</description>
<parameters>
-<parameter name="unescaped">
-<parameter_description> the unescaped input string.
-</parameter_description>
-</parameter>
-<parameter name="reserved_chars_allowed">
-<parameter_description> a string of reserved characters that are
-allowed to be used, or %NULL.
+<parameter name="value">
+<parameter_description> a valid #GValue of %G_TYPE_BOXED derived type
</parameter_description>
</parameter>
-<parameter name="allow_utf8">
-<parameter_description> %TRUE if the result can include UTF-8 characters.
+<parameter name="v_boxed">
+<parameter_description> boxed value to be set
</parameter_description>
</parameter>
</parameters>
-<return> an escaped version of @unescaped. The returned string should be
-freed when no longer needed.
-
-</return>
+<return></return>
</function>
-<function name="g_uri_list_extract_uris">
+<function name="g_value_set_boxed_take_ownership">
<description>
-Splits an URI list conforming to the text/uri-list
-mime type defined in RFC 2483 into individual URIs,
-discarding any comments. The URIs are not validated.
+This is an internal function introduced mainly for C marshallers.
-Since: 2.6
+Deprecated: 2.4: Use g_value_take_boxed() instead.
</description>
<parameters>
-<parameter name="uri_list">
-<parameter_description> an URI list
+<parameter name="value">
+<parameter_description> a valid #GValue of %G_TYPE_BOXED derived type
+</parameter_description>
+</parameter>
+<parameter name="v_boxed">
+<parameter_description> duplicated unowned boxed value to be set
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated %NULL-terminated list of
-strings holding the individual URIs. The array should
-be freed with g_strfreev().
-
-</return>
+<return></return>
</function>
-<function name="g_uri_parse_scheme">
+<function name="g_value_set_char">
<description>
-Gets the scheme portion of a URI string. RFC 3986 decodes the scheme as:
-<programlisting>
-URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]
-</programlisting>
-Common schemes include "file", "http", "svn+ssh", etc.
-
-Since: 2.16
+Set the contents of a %G_TYPE_CHAR #GValue to @v_char.
</description>
<parameters>
-<parameter name="uri">
-<parameter_description> a valid URI.
+<parameter name="value">
+<parameter_description> a valid #GValue of type %G_TYPE_CHAR
+</parameter_description>
+</parameter>
+<parameter name="v_char">
+<parameter_description> character value to be set
</parameter_description>
</parameter>
</parameters>
-<return> The "Scheme" component of the URI, or %NULL on error.
-The returned string should be freed when no longer needed.
-
-</return>
+<return></return>
</function>
-<function name="g_uri_unescape_segment">
+<function name="g_value_set_double">
<description>
-Unescapes a segment of an escaped string.
-
-If any of the characters in @illegal_characters or the character zero appears
-as an escaped character in @escaped_string then that is an error and %NULL
-will be returned. This is useful it you want to avoid for instance having a
-slash being expanded in an escaped path element, which might confuse pathname
-handling.
-
-Since: 2.16
+Set the contents of a %G_TYPE_DOUBLE #GValue to @v_double.
</description>
<parameters>
-<parameter name="escaped_string">
-<parameter_description> a string.
-</parameter_description>
-</parameter>
-<parameter name="escaped_string_end">
-<parameter_description> a string.
+<parameter name="value">
+<parameter_description> a valid #GValue of type %G_TYPE_DOUBLE
</parameter_description>
</parameter>
-<parameter name="illegal_characters">
-<parameter_description> an optional string of illegal characters not to be allowed.
+<parameter name="v_double">
+<parameter_description> double value to be set
</parameter_description>
</parameter>
</parameters>
-<return> an unescaped version of @escaped_string or %NULL on error.
-The returned string should be freed when no longer needed.
-
-</return>
+<return></return>
</function>
-<function name="g_uri_unescape_string">
+<function name="g_value_set_enum">
<description>
-Unescapes a whole escaped string.
-
-If any of the characters in @illegal_characters or the character zero appears
-as an escaped character in @escaped_string then that is an error and %NULL
-will be returned. This is useful it you want to avoid for instance having a
-slash being expanded in an escaped path element, which might confuse pathname
-handling.
-
-Since: 2.16
+Set the contents of a %G_TYPE_ENUM #GValue to @v_enum.
</description>
<parameters>
-<parameter name="escaped_string">
-<parameter_description> an escaped string to be unescaped.
+<parameter name="value">
+<parameter_description> a valid #GValue whose type is derived from %G_TYPE_ENUM
</parameter_description>
</parameter>
-<parameter name="illegal_characters">
-<parameter_description> an optional string of illegal characters not to be allowed.
+<parameter name="v_enum">
+<parameter_description> enum value to be set
</parameter_description>
</parameter>
</parameters>
-<return> an unescaped version of @escaped_string. The returned string
-should be freed when no longer needed.
-
-</return>
+<return></return>
</function>
-<function name="g_utf16_to_ucs4">
+<function name="g_value_set_flags">
<description>
-Convert a string from UTF-16 to UCS-4. The result will be
-nul-terminated.
-
+Set the contents of a %G_TYPE_FLAGS #GValue to @v_flags.
</description>
<parameters>
-<parameter name="str">
-<parameter_description> a UTF-16 encoded string
-</parameter_description>
-</parameter>
-<parameter name="len">
-<parameter_description> the maximum length (number of <type>gunichar2</type>) of @str to use.
-If @len < 0, then the string is nul-terminated.
+<parameter name="value">
+<parameter_description> a valid #GValue whose type is derived from %G_TYPE_FLAGS
</parameter_description>
</parameter>
-<parameter name="items_read">
-<parameter_description> location to store number of words read, or %NULL.
-If %NULL, then %G_CONVERT_ERROR_PARTIAL_INPUT will be
-returned in case @str contains a trailing partial
-character. If an error occurs then the index of the
-invalid input is stored here.
+<parameter name="v_flags">
+<parameter_description> flags value to be set
</parameter_description>
</parameter>
-<parameter name="items_written">
-<parameter_description> location to store number of characters written, or %NULL.
-The value stored here does not include the trailing
-0 character.
+</parameters>
+<return></return>
+</function>
+
+<function name="g_value_set_float">
+<description>
+Set the contents of a %G_TYPE_FLOAT #GValue to @v_float.
+
+</description>
+<parameters>
+<parameter name="value">
+<parameter_description> a valid #GValue of type %G_TYPE_FLOAT
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> location to store the error occuring, or %NULL to ignore
-errors. Any of the errors in #GConvertError other than
-%G_CONVERT_ERROR_NO_CONVERSION may occur.
+<parameter name="v_float">
+<parameter_description> float value to be set
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to a newly allocated UCS-4 string.
-This value must be freed with g_free(). If an
-error occurs, %NULL will be returned and
- error set.
-</return>
+<return></return>
</function>
-<function name="g_utf16_to_utf8">
+<function name="g_value_set_gtype">
<description>
-Convert a string from UTF-16 to UTF-8. The result will be
-terminated with a 0 byte.
-
-Note that the input is expected to be already in native endianness,
-an initial byte-order-mark character is not handled specially.
-g_convert() can be used to convert a byte buffer of UTF-16 data of
-ambiguous endianess.
-
-Further note that this function does not validate the result
-string; it may e.g. include embedded NUL characters. The only
-validation done by this function is to ensure that the input can
-be correctly interpreted as UTF-16, i.e. it doesn't contain
-things unpaired surrogates.
+Set the contents of a %G_TYPE_GTYPE #GValue to @v_gtype.
+Since: 2.12
</description>
<parameters>
-<parameter name="str">
-<parameter_description> a UTF-16 encoded string
-</parameter_description>
-</parameter>
-<parameter name="len">
-<parameter_description> the maximum length (number of <type>gunichar2</type>) of @str to use.
-If @len < 0, then the string is nul-terminated.
+<parameter name="value">
+<parameter_description> a valid #GValue of type %G_TYPE_GTYPE
</parameter_description>
</parameter>
-<parameter name="items_read">
-<parameter_description> location to store number of words read, or %NULL.
-If %NULL, then %G_CONVERT_ERROR_PARTIAL_INPUT will be
-returned in case @str contains a trailing partial
-character. If an error occurs then the index of the
-invalid input is stored here.
+<parameter name="v_gtype">
+<parameter_description> #GType to be set
</parameter_description>
</parameter>
-<parameter name="items_written">
-<parameter_description> location to store number of bytes written, or %NULL.
-The value stored here does not include the trailing
-0 byte.
+</parameters>
+<return></return>
+</function>
+
+<function name="g_value_set_instance">
+<description>
+Sets @value from an instantiatable type via the
+value_table's collect_value() function.
+
+</description>
+<parameters>
+<parameter name="value">
+<parameter_description> An initialized #GValue structure.
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> location to store the error occuring, or %NULL to ignore
-errors. Any of the errors in #GConvertError other than
-%G_CONVERT_ERROR_NO_CONVERSION may occur.
+<parameter name="instance">
+<parameter_description> the instance
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to a newly allocated UTF-8 string.
-This value must be freed with g_free(). If an
-error occurs, %NULL will be returned and
- error set.
-</return>
+<return></return>
</function>
-<function name="g_utf8_casefold">
+<function name="g_value_set_int">
<description>
-Converts a string into a form that is independent of case. The
-result will not correspond to any particular case, but can be
-compared for equality or ordered with the results of calling
-g_utf8_casefold() on other strings.
+Set the contents of a %G_TYPE_INT #GValue to @v_int.
-Note that calling g_utf8_casefold() followed by g_utf8_collate() is
-only an approximation to the correct linguistic case insensitive
-ordering, though it is a fairly good one. Getting this exactly
-right would require a more sophisticated collation function that
-takes case sensitivity into account. GLib does not currently
-provide such a function.
+</description>
+<parameters>
+<parameter name="value">
+<parameter_description> a valid #GValue of type %G_TYPE_INT
+</parameter_description>
+</parameter>
+<parameter name="v_int">
+<parameter_description> integer value to be set
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+<function name="g_value_set_int64">
+<description>
+Set the contents of a %G_TYPE_INT64 #GValue to @v_int64.
</description>
<parameters>
-<parameter name="str">
-<parameter_description> a UTF-8 encoded string
+<parameter name="value">
+<parameter_description> a valid #GValue of type %G_TYPE_INT64
</parameter_description>
</parameter>
-<parameter name="len">
-<parameter_description> length of @str, in bytes, or -1 if @str is nul-terminated.
+<parameter name="v_int64">
+<parameter_description> 64bit integer value to be set
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated string, that is a
-case independent form of @str.
-</return>
+<return></return>
</function>
-<function name="g_utf8_collate">
+<function name="g_value_set_long">
<description>
-Compares two strings for ordering using the linguistically
-correct rules for the <link linkend="setlocale">current locale</link>.
-When sorting a large number of strings, it will be significantly
-faster to obtain collation keys with g_utf8_collate_key() and
-compare the keys with strcmp() when sorting instead of sorting
-the original strings.
-
+Set the contents of a %G_TYPE_LONG #GValue to @v_long.
</description>
<parameters>
-<parameter name="str1">
-<parameter_description> a UTF-8 encoded string
+<parameter name="value">
+<parameter_description> a valid #GValue of type %G_TYPE_LONG
</parameter_description>
</parameter>
-<parameter name="str2">
-<parameter_description> a UTF-8 encoded string
+<parameter name="v_long">
+<parameter_description> long integer value to be set
</parameter_description>
</parameter>
</parameters>
-<return> < 0 if @str1 compares before @str2,
-0 if they compare equal, > 0 if @str1 compares after @str2.
-</return>
+<return></return>
</function>
-<function name="g_utf8_collate_key">
+<function name="g_value_set_object">
<description>
-Converts a string into a collation key that can be compared
-with other collation keys produced by the same function using
-strcmp().
-
-The results of comparing the collation keys of two strings
-with strcmp() will always be the same as comparing the two
-original keys with g_utf8_collate().
+Set the contents of a %G_TYPE_OBJECT derived #GValue to @v_object.
-Note that this function depends on the
-<link linkend="setlocale">current locale</link>.
+g_value_set_object() increases the reference count of @v_object
+(the #GValue holds a reference to @v_object). If you do not wish
+to increase the reference count of the object (i.e. you wish to
+pass your current reference to the #GValue because you no longer
+need it), use g_value_take_object() instead.
+It is important that your #GValue holds a reference to @v_object (either its
+own, or one it has taken) to ensure that the object won't be destroyed while
+the #GValue still exists).
</description>
<parameters>
-<parameter name="str">
-<parameter_description> a UTF-8 encoded string.
+<parameter name="value">
+<parameter_description> a valid #GValue of %G_TYPE_OBJECT derived type
</parameter_description>
</parameter>
-<parameter name="len">
-<parameter_description> length of @str, in bytes, or -1 if @str is nul-terminated.
+<parameter name="v_object">
+<parameter_description> object value to be set
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated string. This string should
-be freed with g_free() when you are done with it.
-</return>
+<return></return>
</function>
-<function name="g_utf8_collate_key_for_filename">
+<function name="g_value_set_object_take_ownership">
<description>
-Converts a string into a collation key that can be compared
-with other collation keys produced by the same function using strcmp().
-
-In order to sort filenames correctly, this function treats the dot '.'
-as a special case. Most dictionary orderings seem to consider it
-insignificant, thus producing the ordering "event.c" "eventgenerator.c"
-"event.h" instead of "event.c" "event.h" "eventgenerator.c". Also, we
-would like to treat numbers intelligently so that "file1" "file10" "file5"
-is sorted as "file1" "file5" "file10".
+This is an internal function introduced mainly for C marshallers.
-Note that this function depends on the
-<link linkend="setlocale">current locale</link>.
-
-Since: 2.8
+Deprecated: 2.4: Use g_value_take_object() instead.
</description>
<parameters>
-<parameter name="str">
-<parameter_description> a UTF-8 encoded string.
+<parameter name="value">
+<parameter_description> a valid #GValue of %G_TYPE_OBJECT derived type
</parameter_description>
</parameter>
-<parameter name="len">
-<parameter_description> length of @str, in bytes, or -1 if @str is nul-terminated.
+<parameter name="v_object">
+<parameter_description> object value to be set
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated string. This string should
-be freed with g_free() when you are done with it.
-
-</return>
+<return></return>
</function>
-<function name="g_utf8_find_next_char">
+<function name="g_value_set_param">
<description>
-Finds the start of the next UTF-8 character in the string after @p.
-
- p does not have to be at the beginning of a UTF-8 character. No check
-is made to see if the character found is actually valid other than
-it starts with an appropriate byte.
-
+Set the contents of a %G_TYPE_PARAM #GValue to @param.
</description>
<parameters>
-<parameter name="p">
-<parameter_description> a pointer to a position within a UTF-8 encoded string
+<parameter name="value">
+<parameter_description> a valid #GValue of type %G_TYPE_PARAM
</parameter_description>
</parameter>
-<parameter name="end">
-<parameter_description> a pointer to the byte following the end of the string,
-or %NULL to indicate that the string is nul-terminated.
+<parameter name="param">
+<parameter_description> the #GParamSpec to be set
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to the found character or %NULL
-</return>
+<return></return>
</function>
-<function name="g_utf8_find_prev_char">
+<function name="g_value_set_param_take_ownership">
<description>
-Given a position @p with a UTF-8 encoded string @str, find the start
-of the previous UTF-8 character starting before @p. Returns %NULL if no
-UTF-8 characters are present in @str before @p.
-
- p does not have to be at the beginning of a UTF-8 character. No check
-is made to see if the character found is actually valid other than
-it starts with an appropriate byte.
+This is an internal function introduced mainly for C marshallers.
+Deprecated: 2.4: Use g_value_take_param() instead.
</description>
<parameters>
-<parameter name="str">
-<parameter_description> pointer to the beginning of a UTF-8 encoded string
+<parameter name="value">
+<parameter_description> a valid #GValue of type %G_TYPE_PARAM
</parameter_description>
</parameter>
-<parameter name="p">
-<parameter_description> pointer to some position within @str
+<parameter name="param">
+<parameter_description> the #GParamSpec to be set
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to the found character or %NULL.
-</return>
+<return></return>
</function>
-<function name="g_utf8_get_char">
+<function name="g_value_set_pointer">
<description>
-Converts a sequence of bytes encoded as UTF-8 to a Unicode character.
-If @p does not point to a valid UTF-8 encoded character, results are
-undefined. If you are not sure that the bytes are complete
-valid Unicode characters, you should use g_utf8_get_char_validated()
-instead.
-
+Set the contents of a pointer #GValue to @v_pointer.
</description>
<parameters>
-<parameter name="p">
-<parameter_description> a pointer to Unicode character encoded as UTF-8
+<parameter name="value">
+<parameter_description> a valid #GValue of %G_TYPE_POINTER
+</parameter_description>
+</parameter>
+<parameter name="v_pointer">
+<parameter_description> pointer value to be set
</parameter_description>
</parameter>
</parameters>
-<return> the resulting character
-</return>
+<return></return>
</function>
-<function name="g_utf8_get_char_validated">
+<function name="g_value_set_static_boxed">
<description>
-Convert a sequence of bytes encoded as UTF-8 to a Unicode character.
-This function checks for incomplete characters, for invalid characters
-such as characters that are out of the range of Unicode, and for
-overlong encodings of valid characters.
-
+Set the contents of a %G_TYPE_BOXED derived #GValue to @v_boxed.
+The boxed value is assumed to be static, and is thus not duplicated
+when setting the #GValue.
</description>
<parameters>
-<parameter name="p">
-<parameter_description> a pointer to Unicode character encoded as UTF-8
+<parameter name="value">
+<parameter_description> a valid #GValue of %G_TYPE_BOXED derived type
</parameter_description>
</parameter>
-<parameter name="max_len">
-<parameter_description> the maximum number of bytes to read, or -1, for no maximum or
-if @p is nul-terminated
+<parameter name="v_boxed">
+<parameter_description> static boxed value to be set
</parameter_description>
</parameter>
</parameters>
-<return> the resulting character. If @p points to a partial
-sequence at the end of a string that could begin a valid
-character (or if @max_len is zero), returns (gunichar)-2;
-otherwise, if @p does not point to a valid UTF-8 encoded
-Unicode character, returns (gunichar)-1.
-</return>
+<return></return>
</function>
-<function name="g_utf8_normalize">
+<function name="g_value_set_static_string">
<description>
-Converts a string into canonical form, standardizing
-such issues as whether a character with an accent
-is represented as a base character and combining
-accent or as a single precomposed character. The
-string has to be valid UTF-8, otherwise %NULL is
-returned. You should generally call g_utf8_normalize()
-before comparing two Unicode strings.
-
-The normalization mode %G_NORMALIZE_DEFAULT only
-standardizes differences that do not affect the
-text content, such as the above-mentioned accent
-representation. %G_NORMALIZE_ALL also standardizes
-the "compatibility" characters in Unicode, such
-as SUPERSCRIPT THREE to the standard forms
-(in this case DIGIT THREE). Formatting information
-may be lost but for most text operations such
-characters should be considered the same.
-
-%G_NORMALIZE_DEFAULT_COMPOSE and %G_NORMALIZE_ALL_COMPOSE
-are like %G_NORMALIZE_DEFAULT and %G_NORMALIZE_ALL,
-but returned a result with composed forms rather
-than a maximally decomposed form. This is often
-useful if you intend to convert the string to
-a legacy encoding or pass it to a system with
-less capable Unicode handling.
-
+Set the contents of a %G_TYPE_STRING #GValue to @v_string.
+The string is assumed to be static, and is thus not duplicated
+when setting the #GValue.
</description>
<parameters>
-<parameter name="str">
-<parameter_description> a UTF-8 encoded string.
-</parameter_description>
-</parameter>
-<parameter name="len">
-<parameter_description> length of @str, in bytes, or -1 if @str is nul-terminated.
+<parameter name="value">
+<parameter_description> a valid #GValue of type %G_TYPE_STRING
</parameter_description>
</parameter>
-<parameter name="mode">
-<parameter_description> the type of normalization to perform.
+<parameter name="v_string">
+<parameter_description> static string to be set
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated string, that is the
-normalized form of @str, or %NULL if @str is not
-valid UTF-8.
-</return>
+<return></return>
</function>
-<function name="g_utf8_offset_to_pointer">
+<function name="g_value_set_string">
<description>
-Converts from an integer character offset to a pointer to a position
-within the string.
-
-Since 2.10, this function allows to pass a negative @offset to
-step backwards. It is usually worth stepping backwards from the end
-instead of forwards if @offset is in the last fourth of the string,
-since moving forward is about 3 times faster than moving backward.
-
-<note><para>
-This function doesn't abort when reaching the end of @str. Therefore
-you should be sure that @offset is within string boundaries before
-calling that function. Call g_utf8_strlen() when unsure.
-
-This limitation exists as this function is called frequently during
-text rendering and therefore has to be as fast as possible.
-</para></note>
-
+Set the contents of a %G_TYPE_STRING #GValue to @v_string.
</description>
<parameters>
-<parameter name="str">
-<parameter_description> a UTF-8 encoded string
+<parameter name="value">
+<parameter_description> a valid #GValue of type %G_TYPE_STRING
</parameter_description>
</parameter>
-<parameter name="offset">
-<parameter_description> a character offset within @str
+<parameter name="v_string">
+<parameter_description> caller-owned string to be duplicated for the #GValue
</parameter_description>
</parameter>
</parameters>
-<return> the resulting pointer
-</return>
+<return></return>
</function>
-<function name="g_utf8_pointer_to_offset">
+<function name="g_value_set_string_take_ownership">
<description>
-Converts from a pointer to position within a string to a integer
-character offset.
-
-Since 2.10, this function allows @pos to be before @str, and returns
-a negative offset in this case.
+This is an internal function introduced mainly for C marshallers.
+Deprecated: 2.4: Use g_value_take_string() instead.
</description>
<parameters>
-<parameter name="str">
-<parameter_description> a UTF-8 encoded string
+<parameter name="value">
+<parameter_description> a valid #GValue of type %G_TYPE_STRING
</parameter_description>
</parameter>
-<parameter name="pos">
-<parameter_description> a pointer to a position within @str
+<parameter name="v_string">
+<parameter_description> duplicated unowned string to be set
</parameter_description>
</parameter>
</parameters>
-<return> the resulting character offset
-</return>
+<return></return>
</function>
-<function name="g_utf8_prev_char">
+<function name="g_value_set_uchar">
<description>
-Finds the previous UTF-8 character in the string before @p.
-
- p does not have to be at the beginning of a UTF-8 character. No check
-is made to see if the character found is actually valid other than
-it starts with an appropriate byte. If @p might be the first
-character of the string, you must use g_utf8_find_prev_char() instead.
-
+Set the contents of a %G_TYPE_UCHAR #GValue to @v_uchar.
</description>
<parameters>
-<parameter name="p">
-<parameter_description> a pointer to a position within a UTF-8 encoded string
+<parameter name="value">
+<parameter_description> a valid #GValue of type %G_TYPE_UCHAR
+</parameter_description>
+</parameter>
+<parameter name="v_uchar">
+<parameter_description> unsigned character value to be set
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to the found character.
-</return>
+<return></return>
</function>
-<function name="g_utf8_strchr">
+<function name="g_value_set_uint">
<description>
-Finds the leftmost occurrence of the given Unicode character
-in a UTF-8 encoded string, while limiting the search to @len bytes.
-If @len is -1, allow unbounded search.
-
+Set the contents of a %G_TYPE_UINT #GValue to @v_uint.
</description>
<parameters>
-<parameter name="p">
-<parameter_description> a nul-terminated UTF-8 encoded string
-</parameter_description>
-</parameter>
-<parameter name="len">
-<parameter_description> the maximum length of @p
+<parameter name="value">
+<parameter_description> a valid #GValue of type %G_TYPE_UINT
</parameter_description>
</parameter>
-<parameter name="c">
-<parameter_description> a Unicode character
+<parameter name="v_uint">
+<parameter_description> unsigned integer value to be set
</parameter_description>
</parameter>
</parameters>
-<return> %NULL if the string does not contain the character,
-otherwise, a pointer to the start of the leftmost occurrence of
-the character in the string.
-</return>
+<return></return>
</function>
-<function name="g_utf8_strdown">
+<function name="g_value_set_uint64">
<description>
-Converts all Unicode characters in the string that have a case
-to lowercase. The exact manner that this is done depends
-on the current locale, and may result in the number of
-characters in the string changing.
-
+Set the contents of a %G_TYPE_UINT64 #GValue to @v_uint64.
</description>
<parameters>
-<parameter name="str">
-<parameter_description> a UTF-8 encoded string
+<parameter name="value">
+<parameter_description> a valid #GValue of type %G_TYPE_UINT64
</parameter_description>
</parameter>
-<parameter name="len">
-<parameter_description> length of @str, in bytes, or -1 if @str is nul-terminated.
+<parameter name="v_uint64">
+<parameter_description> unsigned 64bit integer value to be set
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated string, with all characters
-converted to lowercase.
-</return>
+<return></return>
</function>
-<function name="g_utf8_strlen">
+<function name="g_value_set_ulong">
<description>
-Computes the length of the string in characters, not including
-the terminating nul character.
-
+Set the contents of a %G_TYPE_ULONG #GValue to @v_ulong.
</description>
<parameters>
-<parameter name="p">
-<parameter_description> pointer to the start of a UTF-8 encoded string
+<parameter name="value">
+<parameter_description> a valid #GValue of type %G_TYPE_ULONG
</parameter_description>
</parameter>
-<parameter name="max">
-<parameter_description> the maximum number of bytes to examine. If @max
-is less than 0, then the string is assumed to be
-nul-terminated. If @max is 0, @p will not be examined and
-may be %NULL.
+<parameter name="v_ulong">
+<parameter_description> unsigned long integer value to be set
</parameter_description>
</parameter>
</parameters>
-<return> the length of the string in characters
-</return>
+<return></return>
</function>
-<function name="g_utf8_strncpy">
+<function name="g_value_set_variant">
<description>
-Like the standard C strncpy() function, but
-copies a given number of characters instead of a given number of
-bytes. The @src string must be valid UTF-8 encoded text.
-(Use g_utf8_validate() on all text before trying to use UTF-8
-utility functions with it.)
+Set the contents of a variant #GValue to @variant.
+If the variant is floating, it is consumed.
+Since: 2.26
</description>
<parameters>
-<parameter name="dest">
-<parameter_description> buffer to fill with characters from @src
-</parameter_description>
-</parameter>
-<parameter name="src">
-<parameter_description> UTF-8 encoded string
+<parameter name="value">
+<parameter_description> a valid #GValue of type %G_TYPE_VARIANT
</parameter_description>
</parameter>
-<parameter name="n">
-<parameter_description> character count
+<parameter name="variant">
+<parameter_description> a #GVariant, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> @dest
-</return>
+<return></return>
</function>
-<function name="g_utf8_strrchr">
+<function name="g_value_take_boxed">
<description>
-Find the rightmost occurrence of the given Unicode character
-in a UTF-8 encoded string, while limiting the search to @len bytes.
-If @len is -1, allow unbounded search.
+Sets the contents of a %G_TYPE_BOXED derived #GValue to @v_boxed
+and takes over the ownership of the callers reference to @v_boxed;
+the caller doesn't have to unref it any more.
+Since: 2.4
</description>
<parameters>
-<parameter name="p">
-<parameter_description> a nul-terminated UTF-8 encoded string
-</parameter_description>
-</parameter>
-<parameter name="len">
-<parameter_description> the maximum length of @p
+<parameter name="value">
+<parameter_description> a valid #GValue of %G_TYPE_BOXED derived type
</parameter_description>
</parameter>
-<parameter name="c">
-<parameter_description> a Unicode character
+<parameter name="v_boxed">
+<parameter_description> duplicated unowned boxed value to be set
</parameter_description>
</parameter>
</parameters>
-<return> %NULL if the string does not contain the character,
-otherwise, a pointer to the start of the rightmost occurrence of the
-character in the string.
-</return>
+<return></return>
</function>
-<function name="g_utf8_strreverse">
+<function name="g_value_take_object">
<description>
-Reverses a UTF-8 string. @str must be valid UTF-8 encoded text.
-(Use g_utf8_validate() on all text before trying to use UTF-8
-utility functions with it.)
+Sets the contents of a %G_TYPE_OBJECT derived #GValue to @v_object
+and takes over the ownership of the callers reference to @v_object;
+the caller doesn't have to unref it any more (i.e. the reference
+count of the object is not increased).
-This function is intended for programmatic uses of reversed strings.
-It pays no attention to decomposed characters, combining marks, byte
-order marks, directional indicators (LRM, LRO, etc) and similar
-characters which might need special handling when reversing a string
-for display purposes.
-
-Note that unlike g_strreverse(), this function returns
-newly-allocated memory, which should be freed with g_free() when
-no longer needed.
+If you want the #GValue to hold its own reference to @v_object, use
+g_value_set_object() instead.
-Since: 2.2
+Since: 2.4
</description>
<parameters>
-<parameter name="str">
-<parameter_description> a UTF-8 encoded string
+<parameter name="value">
+<parameter_description> a valid #GValue of %G_TYPE_OBJECT derived type
</parameter_description>
</parameter>
-<parameter name="len">
-<parameter_description> the maximum length of @str to use, in bytes. If @len < 0,
-then the string is nul-terminated.
+<parameter name="v_object">
+<parameter_description> object value to be set
</parameter_description>
</parameter>
</parameters>
-<return> a newly-allocated string which is the reverse of @str.
-
-</return>
+<return></return>
</function>
-<function name="g_utf8_strup">
+<function name="g_value_take_param">
<description>
-Converts all Unicode characters in the string that have a case
-to uppercase. The exact manner that this is done depends
-on the current locale, and may result in the number of
-characters in the string increasing. (For instance, the
-German ess-zet will be changed to SS.)
+Sets the contents of a %G_TYPE_PARAM #GValue to @param and takes
+over the ownership of the callers reference to @param; the caller
+doesn't have to unref it any more.
+Since: 2.4
</description>
<parameters>
-<parameter name="str">
-<parameter_description> a UTF-8 encoded string
+<parameter name="value">
+<parameter_description> a valid #GValue of type %G_TYPE_PARAM
</parameter_description>
</parameter>
-<parameter name="len">
-<parameter_description> length of @str, in bytes, or -1 if @str is nul-terminated.
+<parameter name="param">
+<parameter_description> the #GParamSpec to be set
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated string, with all characters
-converted to uppercase.
-</return>
+<return></return>
</function>
-<function name="g_utf8_to_ucs4">
+<function name="g_value_take_string">
<description>
-Convert a string from UTF-8 to a 32-bit fixed width
-representation as UCS-4. A trailing 0 will be added to the
-string after the converted text.
+Sets the contents of a %G_TYPE_STRING #GValue to @v_string.
+Since: 2.4
</description>
<parameters>
-<parameter name="str">
-<parameter_description> a UTF-8 encoded string
-</parameter_description>
-</parameter>
-<parameter name="len">
-<parameter_description> the maximum length of @str to use, in bytes. If @len < 0,
-then the string is nul-terminated.
+<parameter name="value">
+<parameter_description> a valid #GValue of type %G_TYPE_STRING
</parameter_description>
</parameter>
-<parameter name="items_read">
-<parameter_description> location to store number of bytes read, or %NULL.
-If %NULL, then %G_CONVERT_ERROR_PARTIAL_INPUT will be
-returned in case @str contains a trailing partial
-character. If an error occurs then the index of the
-invalid input is stored here.
+<parameter name="v_string">
+<parameter_description> string to take ownership of
</parameter_description>
</parameter>
-<parameter name="items_written">
-<parameter_description> location to store number of characters written or %NULL.
-The value here stored does not include the trailing 0
-character.
+</parameters>
+<return></return>
+</function>
+
+<function name="g_value_take_variant">
+<description>
+Set the contents of a variant #GValue to @variant, and takes over
+the ownership of the caller's reference to @variant;
+the caller doesn't have to unref it any more (i.e. the reference
+count of the variant is not increased).
+
+It is a programmer error to pass a floating variant to this function.
+In particular this means that callbacks in closures, and signal handlers
+for signals of return type %G_TYPE_VARIANT, must never return floating
+variants.
+
+If you want the #GValue to hold its own reference to @variant, use
+g_value_set_variant() instead.
+
+This is an internal function introduced mainly for C marshallers.
+
+Since: 2.26
+
+</description>
+<parameters>
+<parameter name="value">
+<parameter_description> a valid #GValue of type %G_TYPE_VARIANT
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> location to store the error occuring, or %NULL to ignore
-errors. Any of the errors in #GConvertError other than
-%G_CONVERT_ERROR_NO_CONVERSION may occur.
+<parameter name="variant">
+<parameter_description> a #GVariant, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to a newly allocated UCS-4 string.
-This value must be freed with g_free(). If an
-error occurs, %NULL will be returned and
- error set.
-</return>
+<return></return>
</function>
-<function name="g_utf8_to_ucs4_fast">
+<function name="g_value_transform">
<description>
-Convert a string from UTF-8 to a 32-bit fixed width
-representation as UCS-4, assuming valid UTF-8 input.
-This function is roughly twice as fast as g_utf8_to_ucs4()
-but does no error checking on the input.
+Tries to cast the contents of @src_value into a type appropriate
+to store in @dest_value, e.g. to transform a %G_TYPE_INT value
+into a %G_TYPE_FLOAT value. Performing transformations between
+value types might incur precision lossage. Especially
+transformations into strings might reveal seemingly arbitrary
+results and shouldn't be relied upon for production code (such
+as rcfile value or object property serialization).
</description>
<parameters>
-<parameter name="str">
-<parameter_description> a UTF-8 encoded string
-</parameter_description>
-</parameter>
-<parameter name="len">
-<parameter_description> the maximum length of @str to use, in bytes. If @len < 0,
-then the string is nul-terminated.
+<parameter name="src_value">
+<parameter_description> Source value.
</parameter_description>
</parameter>
-<parameter name="items_written">
-<parameter_description> location to store the number of characters in the
-result, or %NULL.
+<parameter name="dest_value">
+<parameter_description> Target value.
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to a newly allocated UCS-4 string.
-This value must be freed with g_free().
+<return> Whether a transformation rule was found and could be applied.
+Upon failing transformations, @dest_value is left untouched.
</return>
</function>
-<function name="g_utf8_to_utf16">
+<function name="g_value_type_compatible">
<description>
-Convert a string from UTF-8 to UTF-16. A 0 character will be
-added to the result after the converted text.
+Returns whether a #GValue of type @src_type can be copied into
+a #GValue of type @dest_type.
</description>
<parameters>
-<parameter name="str">
-<parameter_description> a UTF-8 encoded string
-</parameter_description>
-</parameter>
-<parameter name="len">
-<parameter_description> the maximum length (number of bytes) of @str to use.
-If @len < 0, then the string is nul-terminated.
-</parameter_description>
-</parameter>
-<parameter name="items_read">
-<parameter_description> location to store number of bytes read, or %NULL.
-If %NULL, then %G_CONVERT_ERROR_PARTIAL_INPUT will be
-returned in case @str contains a trailing partial
-character. If an error occurs then the index of the
-invalid input is stored here.
-</parameter_description>
-</parameter>
-<parameter name="items_written">
-<parameter_description> location to store number of <type>gunichar2</type> written,
-or %NULL.
-The value stored here does not include the trailing 0.
+<parameter name="src_type">
+<parameter_description> source type to be copied.
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> location to store the error occuring, or %NULL to ignore
-errors. Any of the errors in #GConvertError other than
-%G_CONVERT_ERROR_NO_CONVERSION may occur.
+<parameter name="dest_type">
+<parameter_description> destination type for copying.
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to a newly allocated UTF-16 string.
-This value must be freed with g_free(). If an
-error occurs, %NULL will be returned and
- error set.
+<return> %TRUE if g_value_copy() is possible with @src_type and @dest_type.
</return>
</function>
-<function name="g_utf8_validate">
+<function name="g_value_type_transformable">
<description>
-Validates UTF-8 encoded text. @str is the text to validate;
-if @str is nul-terminated, then @max_len can be -1, otherwise
- max_len should be the number of bytes to validate.
-If @end is non-%NULL, then the end of the valid range
-will be stored there (i.e. the start of the first invalid
-character if some bytes were invalid, or the end of the text
-being validated otherwise).
-
-Note that g_utf8_validate() returns %FALSE if @max_len is
-positive and NUL is met before @max_len bytes have been read.
+Check whether g_value_transform() is able to transform values
+of type @src_type into values of type @dest_type.
</description>
<parameters>
-<parameter name="str">
-<parameter_description> a pointer to character data
-</parameter_description>
-</parameter>
-<parameter name="max_len">
-<parameter_description> max bytes to validate, or -1 to go until NUL
+<parameter name="src_type">
+<parameter_description> Source type.
</parameter_description>
</parameter>
-<parameter name="end">
-<parameter_description> return location for end of valid data
+<parameter name="dest_type">
+<parameter_description> Target type.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the text was valid UTF-8
+<return> %TRUE if the transformation is possible, %FALSE otherwise.
</return>
</function>
-<function name="g_utime">
+<function name="g_value_unset">
<description>
-A wrapper for the POSIX utime() function. The utime() function
-sets the access and modification timestamps of a file.
-
-See your C library manual for more details about how utime() works
-on your system.
-
-Since: 2.18
+Clears the current value in @value and "unsets" the type,
+this releases all resources associated with this GValue.
+An unset value is the same as an uninitialized (zero-filled)
+#GValue structure.
</description>
<parameters>
-<parameter name="filename">
-<parameter_description> a pathname in the GLib file name encoding (UTF-8 on Windows)
-</parameter_description>
-</parameter>
-<parameter name="utb">
-<parameter_description> a pointer to a struct utimbuf.
+<parameter name="value">
+<parameter_description> An initialized #GValue structure.
</parameter_description>
</parameter>
</parameters>
-<return> 0 if the operation was successful, -1 if an error
-occurred
-
-</return>
+<return></return>
</function>
<function name="g_variant_builder_add">
@@ -31408,6 +41195,17 @@ Since: 2.24
</return>
</function>
+<function name="g_variant_get_gtype">
+<description>
+Since: 2.24
+Deprecated: 2.26
+
+</description>
+<parameters>
+</parameters>
+<return></return>
+</function>
+
<function name="g_variant_get_handle">
<description>
Returns the 32-bit signed integer value of @value.
@@ -32227,7 +42025,7 @@ iterate_container_recursive (GVariant *container)
GVariantIter iter;
GVariant *child;
-g_variant_iter_init (&iter, dictionary);
+g_variant_iter_init (&iter, container);
while ((child = g_variant_iter_next_value (&iter)))
{
g_print ("type '%s'\n", g_variant_get_type_string (child));
@@ -32519,10 +42317,8 @@ Since: 2.26
<function name="g_variant_new_dict_entry">
<description>
-Creates a new dictionary entry #GVariant. @key and @value must be
-non-%NULL.
-
- key must be a value of a basic type (ie: not a container).
+Creates a new dictionary entry #GVariant. @key and @value must be
+non-%NULL. @key must be a value of a basic type (ie: not a container).
If the @key or @value are floating references (see g_variant_ref_sink()),
the new instance takes ownership of them as if via g_variant_ref_sink().
diff --git a/glib/src/glib_enums.defs b/glib/src/glib_enums.defs
index db84fb1..e309f23 100644
--- a/glib/src/glib_enums.defs
+++ b/glib/src/glib_enums.defs
@@ -68,7 +68,7 @@
;; From gconvert.h
;; Original typedef:
-;; typedef enum
+;; typedef enum
;; {
;; G_CONVERT_ERROR_NO_CONVERSION,
;; G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
@@ -393,7 +393,7 @@
)
;; Original typedef:
-;; typedef enum
+;; typedef enum /*< flags >*/
;; {
;; G_IO_IN GLIB_SYSDEF_POLLIN,
;; G_IO_OUT GLIB_SYSDEF_POLLOUT,
@@ -1256,6 +1256,26 @@
)
)
+;; From gtimezone.h
+
+;; Original typedef:
+;; typedef enum
+;; {
+;; G_TIME_TYPE_STANDARD,
+;; G_TIME_TYPE_DAYLIGHT,
+;; G_TIME_TYPE_UNIVERSAL
+;; } GTimeType;
+
+(define-enum-extended TimeType
+ (in-module "G")
+ (c-name "GTimeType")
+ (values
+ '("standard" "G_TIME_TYPE_STANDARD" "0")
+ '("daylight" "G_TIME_TYPE_DAYLIGHT" "1")
+ '("universal" "G_TIME_TYPE_UNIVERSAL" "2")
+ )
+)
+
;; From gunicode.h
;; Original typedef:
@@ -1368,7 +1388,8 @@
;; G_UNICODE_BREAK_HANGUL_V_JAMO,
;; G_UNICODE_BREAK_HANGUL_T_JAMO,
;; G_UNICODE_BREAK_HANGUL_LV_SYLLABLE,
-;; G_UNICODE_BREAK_HANGUL_LVT_SYLLABLE
+;; G_UNICODE_BREAK_HANGUL_LVT_SYLLABLE,
+;; G_UNICODE_BREAK_CLOSE_PARANTHESIS
;; } GUnicodeBreakType;
(define-enum-extended UnicodeBreakType
@@ -1411,6 +1432,7 @@
'("hangul-t-jamo" "G_UNICODE_BREAK_HANGUL_T_JAMO" "33")
'("hangul-lv-syllable" "G_UNICODE_BREAK_HANGUL_LV_SYLLABLE" "34")
'("hangul-lvt-syllable" "G_UNICODE_BREAK_HANGUL_LVT_SYLLABLE" "35")
+ '("close-paranthesis" "G_UNICODE_BREAK_CLOSE_PARANTHESIS" "36")
)
)
@@ -1474,7 +1496,7 @@
;; G_UNICODE_SCRIPT_LINEAR_B, /* Linb */
;; G_UNICODE_SCRIPT_TAI_LE, /* Tale */
;; G_UNICODE_SCRIPT_UGARITIC, /* Ugar */
-;;
+;;
;; /* Unicode-4.1 additions */
;; G_UNICODE_SCRIPT_NEW_TAI_LUE, /* Talu */
;; G_UNICODE_SCRIPT_BUGINESE, /* Bugi */
@@ -1503,7 +1525,29 @@
;; G_UNICODE_SCRIPT_VAI, /* Vaii */
;; G_UNICODE_SCRIPT_CARIAN, /* Cari */
;; G_UNICODE_SCRIPT_LYCIAN, /* Lyci */
-;; G_UNICODE_SCRIPT_LYDIAN /* Lydi */
+;; G_UNICODE_SCRIPT_LYDIAN, /* Lydi */
+;;
+;; /* Unicode-5.2 additions */
+;; G_UNICODE_SCRIPT_AVESTAN, /* Avst */
+;; G_UNICODE_SCRIPT_BAMUM, /* Bamu */
+;; G_UNICODE_SCRIPT_EGYPTIAN_HIEROGLYPHS, /* Egyp */
+;; G_UNICODE_SCRIPT_IMPERIAL_ARAMAIC, /* Armi */
+;; G_UNICODE_SCRIPT_INSCRIPTIONAL_PAHLAVI, /* Phli */
+;; G_UNICODE_SCRIPT_INSCRIPTIONAL_PARTHIAN, /* Prti */
+;; G_UNICODE_SCRIPT_JAVANESE, /* Java */
+;; G_UNICODE_SCRIPT_KAITHI, /* Kthi */
+;; G_UNICODE_SCRIPT_LISU, /* Lisu */
+;; G_UNICODE_SCRIPT_MEETEI_MAYEK, /* Mtei */
+;; G_UNICODE_SCRIPT_OLD_SOUTH_ARABIAN, /* Sarb */
+;; G_UNICODE_SCRIPT_OLD_TURKIC, /* Orkh */
+;; G_UNICODE_SCRIPT_SAMARITAN, /* Samr */
+;; G_UNICODE_SCRIPT_TAI_THAM, /* Lana */
+;; G_UNICODE_SCRIPT_TAI_VIET, /* Tavt */
+;;
+;; /* Unicode-6.0 additions */
+;; G_UNICODE_SCRIPT_BATAK, /* Batk */
+;; G_UNICODE_SCRIPT_BRAHMI, /* Brah */
+;; G_UNICODE_SCRIPT_MANDAIC /* Mand */
;; } GUnicodeScript;
(define-enum-extended UnicodeScript
@@ -1589,6 +1633,24 @@
'("carian" "G_UNICODE_SCRIPT_CARIAN" "75")
'("lycian" "G_UNICODE_SCRIPT_LYCIAN" "76")
'("lydian" "G_UNICODE_SCRIPT_LYDIAN" "77")
+ '("avestan" "G_UNICODE_SCRIPT_AVESTAN" "78")
+ '("bamum" "G_UNICODE_SCRIPT_BAMUM" "79")
+ '("egyptian-hieroglyphs" "G_UNICODE_SCRIPT_EGYPTIAN_HIEROGLYPHS" "80")
+ '("imperial-aramaic" "G_UNICODE_SCRIPT_IMPERIAL_ARAMAIC" "81")
+ '("inscriptional-pahlavi" "G_UNICODE_SCRIPT_INSCRIPTIONAL_PAHLAVI" "82")
+ '("inscriptional-parthian" "G_UNICODE_SCRIPT_INSCRIPTIONAL_PARTHIAN" "83")
+ '("javanese" "G_UNICODE_SCRIPT_JAVANESE" "84")
+ '("kaithi" "G_UNICODE_SCRIPT_KAITHI" "85")
+ '("lisu" "G_UNICODE_SCRIPT_LISU" "86")
+ '("meetei-mayek" "G_UNICODE_SCRIPT_MEETEI_MAYEK" "87")
+ '("old-south-arabian" "G_UNICODE_SCRIPT_OLD_SOUTH_ARABIAN" "88")
+ '("old-turkic" "G_UNICODE_SCRIPT_OLD_TURKIC" "89")
+ '("samaritan" "G_UNICODE_SCRIPT_SAMARITAN" "90")
+ '("tai-tham" "G_UNICODE_SCRIPT_TAI_THAM" "91")
+ '("tai-viet" "G_UNICODE_SCRIPT_TAI_VIET" "92")
+ '("batak" "G_UNICODE_SCRIPT_BATAK" "93")
+ '("brahmi" "G_UNICODE_SCRIPT_BRAHMI" "94")
+ '("mandaic" "G_UNICODE_SCRIPT_MANDAIC" "95")
)
)
@@ -1701,3 +1763,51 @@
)
)
+;; Original typedef:
+;; typedef enum
+;; {
+;; G_VARIANT_PARSE_ERROR_FAILED,
+;; G_VARIANT_PARSE_ERROR_BASIC_TYPE_EXPECTED,
+;; G_VARIANT_PARSE_ERROR_CANNOT_INFER_TYPE,
+;; G_VARIANT_PARSE_ERROR_DEFINITE_TYPE_EXPECTED,
+;; G_VARIANT_PARSE_ERROR_INPUT_NOT_AT_END,
+;; G_VARIANT_PARSE_ERROR_INVALID_CHARACTER,
+;; G_VARIANT_PARSE_ERROR_INVALID_FORMAT_STRING,
+;; G_VARIANT_PARSE_ERROR_INVALID_OBJECT_PATH,
+;; G_VARIANT_PARSE_ERROR_INVALID_SIGNATURE,
+;; G_VARIANT_PARSE_ERROR_INVALID_TYPE_STRING,
+;; G_VARIANT_PARSE_ERROR_NO_COMMON_TYPE,
+;; G_VARIANT_PARSE_ERROR_NUMBER_OUT_OF_RANGE,
+;; G_VARIANT_PARSE_ERROR_NUMBER_TOO_BIG,
+;; G_VARIANT_PARSE_ERROR_TYPE_ERROR,
+;; G_VARIANT_PARSE_ERROR_UNEXPECTED_TOKEN,
+;; G_VARIANT_PARSE_ERROR_UNKNOWN_KEYWORD,
+;; G_VARIANT_PARSE_ERROR_UNTERMINATED_STRING_CONSTANT,
+;; G_VARIANT_PARSE_ERROR_VALUE_EXPECTED
+;; } GVariantParseError;
+
+(define-enum-extended VariantParseError
+ (in-module "G")
+ (c-name "GVariantParseError")
+ (values
+ '("failed" "G_VARIANT_PARSE_ERROR_FAILED" "0")
+ '("basic-type-expected" "G_VARIANT_PARSE_ERROR_BASIC_TYPE_EXPECTED" "1")
+ '("cannot-infer-type" "G_VARIANT_PARSE_ERROR_CANNOT_INFER_TYPE" "2")
+ '("definite-type-expected" "G_VARIANT_PARSE_ERROR_DEFINITE_TYPE_EXPECTED" "3")
+ '("input-not-at-end" "G_VARIANT_PARSE_ERROR_INPUT_NOT_AT_END" "4")
+ '("invalid-character" "G_VARIANT_PARSE_ERROR_INVALID_CHARACTER" "5")
+ '("invalid-format-string" "G_VARIANT_PARSE_ERROR_INVALID_FORMAT_STRING" "6")
+ '("invalid-object-path" "G_VARIANT_PARSE_ERROR_INVALID_OBJECT_PATH" "7")
+ '("invalid-signature" "G_VARIANT_PARSE_ERROR_INVALID_SIGNATURE" "8")
+ '("invalid-type-string" "G_VARIANT_PARSE_ERROR_INVALID_TYPE_STRING" "9")
+ '("no-common-type" "G_VARIANT_PARSE_ERROR_NO_COMMON_TYPE" "10")
+ '("number-out-of-range" "G_VARIANT_PARSE_ERROR_NUMBER_OUT_OF_RANGE" "11")
+ '("number-too-big" "G_VARIANT_PARSE_ERROR_NUMBER_TOO_BIG" "12")
+ '("type-error" "G_VARIANT_PARSE_ERROR_TYPE_ERROR" "13")
+ '("unexpected-token" "G_VARIANT_PARSE_ERROR_UNEXPECTED_TOKEN" "14")
+ '("unknown-keyword" "G_VARIANT_PARSE_ERROR_UNKNOWN_KEYWORD" "15")
+ '("unterminated-string-constant" "G_VARIANT_PARSE_ERROR_UNTERMINATED_STRING_CONSTANT" "16")
+ '("value-expected" "G_VARIANT_PARSE_ERROR_VALUE_EXPECTED" "17")
+ )
+)
+
diff --git a/glib/src/glib_functions.defs b/glib/src/glib_functions.defs
index b420e94..4adc3ff 100644
--- a/glib/src/glib_functions.defs
+++ b/glib/src/glib_functions.defs
@@ -18,6 +18,16 @@
)
)
+(define-flags ArrayFlags
+ (in-module "GBSearch")
+ (c-name "GBSearchArrayFlags")
+ (gtype-id "G_TYPE_B_SEARCH_ARRAY_FLAGS")
+ (values
+ '("lign-power2" "G_BSEARCH_ARRAY_ALIGN_POWER2")
+ '("uto-shrink" "G_BSEARCH_ARRAY_AUTO_SHRINK")
+ )
+)
+
(define-enum Type
(in-module "GChecksum")
(c-name "GChecksumType")
@@ -91,6 +101,16 @@
)
)
+(define-flags Flag
+ (in-module "GDebug")
+ (c-name "GDebugFlag")
+ (gtype-id "G_TYPE_DEBUG_FLAG")
+ (values
+ '("warnings" "G_DEBUG_FATAL_WARNINGS")
+ '("criticals" "G_DEBUG_FATAL_CRITICALS")
+ )
+)
+
(define-enum Error
(in-module "GFile")
(c-name "GFileError")
@@ -724,6 +744,7 @@
'("hangul-t-jamo" "G_UNICODE_BREAK_HANGUL_T_JAMO")
'("hangul-lv-syllable" "G_UNICODE_BREAK_HANGUL_LV_SYLLABLE")
'("hangul-lvt-syllable" "G_UNICODE_BREAK_HANGUL_LVT_SYLLABLE")
+ '("close-paranthesis" "G_UNICODE_BREAK_CLOSE_PARANTHESIS")
)
)
@@ -822,10 +843,13 @@
'("lisu" "G_UNICODE_SCRIPT_LISU")
'("meetei-mayek" "G_UNICODE_SCRIPT_MEETEI_MAYEK")
'("old-south-arabian" "G_UNICODE_SCRIPT_OLD_SOUTH_ARABIAN")
- '("old-turkish" "G_UNICODE_SCRIPT_OLD_TURKISH")
+ '("old-turkic" "G_UNICODE_SCRIPT_OLD_TURKIC")
'("samaritan" "G_UNICODE_SCRIPT_SAMARITAN")
'("tai-tham" "G_UNICODE_SCRIPT_TAI_THAM")
'("tai-viet" "G_UNICODE_SCRIPT_TAI_VIET")
+ '("batak" "G_UNICODE_SCRIPT_BATAK")
+ '("brahmi" "G_UNICODE_SCRIPT_BRAHMI")
+ '("mandaic" "G_UNICODE_SCRIPT_MANDAIC")
)
)
@@ -894,6 +918,23 @@
(gtype-id "G_TYPE_VARIANT_PARSE_ERROR")
(values
'("failed" "G_VARIANT_PARSE_ERROR_FAILED")
+ '("basic-type-expected" "G_VARIANT_PARSE_ERROR_BASIC_TYPE_EXPECTED")
+ '("cannot-infer-type" "G_VARIANT_PARSE_ERROR_CANNOT_INFER_TYPE")
+ '("definite-type-expected" "G_VARIANT_PARSE_ERROR_DEFINITE_TYPE_EXPECTED")
+ '("input-not-at-end" "G_VARIANT_PARSE_ERROR_INPUT_NOT_AT_END")
+ '("invalid-character" "G_VARIANT_PARSE_ERROR_INVALID_CHARACTER")
+ '("invalid-format-string" "G_VARIANT_PARSE_ERROR_INVALID_FORMAT_STRING")
+ '("invalid-object-path" "G_VARIANT_PARSE_ERROR_INVALID_OBJECT_PATH")
+ '("invalid-signature" "G_VARIANT_PARSE_ERROR_INVALID_SIGNATURE")
+ '("invalid-type-string" "G_VARIANT_PARSE_ERROR_INVALID_TYPE_STRING")
+ '("no-common-type" "G_VARIANT_PARSE_ERROR_NO_COMMON_TYPE")
+ '("number-out-of-range" "G_VARIANT_PARSE_ERROR_NUMBER_OUT_OF_RANGE")
+ '("number-too-big" "G_VARIANT_PARSE_ERROR_NUMBER_TOO_BIG")
+ '("type-error" "G_VARIANT_PARSE_ERROR_TYPE_ERROR")
+ '("unexpected-token" "G_VARIANT_PARSE_ERROR_UNEXPECTED_TOKEN")
+ '("unknown-keyword" "G_VARIANT_PARSE_ERROR_UNKNOWN_KEYWORD")
+ '("unterminated-string-constant" "G_VARIANT_PARSE_ERROR_UNTERMINATED_STRING_CONSTANT")
+ '("value-expected" "G_VARIANT_PARSE_ERROR_VALUE_EXPECTED")
)
)
@@ -1478,21 +1519,36 @@
;; From gatomic.h
-(define-function g_atomic_int_exchange_and_add
- (c-name "g_atomic_int_exchange_and_add")
+(define-function g_atomic_int_get
+ (c-name "g_atomic_int_get")
(return-type "gint")
(parameters
- '("volatile-gint-G_GNUC_MAY_ALIAS*" "atomic")
- '("gint" "val")
+ '("volatile-gint*" "atomic")
)
)
-(define-function g_atomic_int_add
- (c-name "g_atomic_int_add")
+(define-function g_atomic_int_set
+ (c-name "g_atomic_int_set")
(return-type "none")
(parameters
- '("volatile-gint-G_GNUC_MAY_ALIAS*" "atomic")
- '("gint" "val")
+ '("volatile-gint*" "atomic")
+ '("gint" "newval")
+ )
+)
+
+(define-function g_atomic_int_inc
+ (c-name "g_atomic_int_inc")
+ (return-type "none")
+ (parameters
+ '("volatile-gint*" "atomic")
+ )
+)
+
+(define-function g_atomic_int_dec_and_test
+ (c-name "g_atomic_int_dec_and_test")
+ (return-type "gboolean")
+ (parameters
+ '("volatile-gint*" "atomic")
)
)
@@ -1500,36 +1556,45 @@
(c-name "g_atomic_int_compare_and_exchange")
(return-type "gboolean")
(parameters
- '("volatile-gint-G_GNUC_MAY_ALIAS*" "atomic")
+ '("volatile-gint*" "atomic")
'("gint" "oldval")
'("gint" "newval")
)
)
-(define-function g_atomic_pointer_compare_and_exchange
- (c-name "g_atomic_pointer_compare_and_exchange")
- (return-type "gboolean")
+(define-function g_atomic_int_add
+ (c-name "g_atomic_int_add")
+ (return-type "gint")
(parameters
- '("volatile-gpointer-G_GNUC_MAY_ALIAS*" "atomic")
- '("gpointer" "oldval")
- '("gpointer" "newval")
+ '("volatile-gint*" "atomic")
+ '("gint" "val")
)
)
-(define-function g_atomic_int_get
- (c-name "g_atomic_int_get")
- (return-type "gint")
+(define-function g_atomic_int_and
+ (c-name "g_atomic_int_and")
+ (return-type "guint")
(parameters
- '("volatile-gint-G_GNUC_MAY_ALIAS*" "atomic")
+ '("volatile-guint*" "atomic")
+ '("guint" "val")
)
)
-(define-function g_atomic_int_set
- (c-name "g_atomic_int_set")
- (return-type "none")
+(define-function g_atomic_int_or
+ (c-name "g_atomic_int_or")
+ (return-type "guint")
(parameters
- '("volatile-gint-G_GNUC_MAY_ALIAS*" "atomic")
- '("gint" "newval")
+ '("volatile-guint*" "atomic")
+ '("guint" "val")
+ )
+)
+
+(define-function g_atomic_int_xor
+ (c-name "g_atomic_int_xor")
+ (return-type "guint")
+ (parameters
+ '("volatile-guint*" "atomic")
+ '("guint" "val")
)
)
@@ -1537,7 +1602,7 @@
(c-name "g_atomic_pointer_get")
(return-type "gpointer")
(parameters
- '("volatile-gpointer-G_GNUC_MAY_ALIAS*" "atomic")
+ '("volatile-void*" "atomic")
)
)
@@ -1545,11 +1610,66 @@
(c-name "g_atomic_pointer_set")
(return-type "none")
(parameters
- '("volatile-gpointer-G_GNUC_MAY_ALIAS*" "atomic")
+ '("volatile-void*" "atomic")
+ '("gpointer" "newval")
+ )
+)
+
+(define-function g_atomic_pointer_compare_and_exchange
+ (c-name "g_atomic_pointer_compare_and_exchange")
+ (return-type "gboolean")
+ (parameters
+ '("volatile-void*" "atomic")
+ '("gpointer" "oldval")
'("gpointer" "newval")
)
)
+(define-function g_atomic_pointer_add
+ (c-name "g_atomic_pointer_add")
+ (return-type "gssize")
+ (parameters
+ '("volatile-void*" "atomic")
+ '("gssize" "val")
+ )
+)
+
+(define-function g_atomic_pointer_and
+ (c-name "g_atomic_pointer_and")
+ (return-type "gsize")
+ (parameters
+ '("volatile-void*" "atomic")
+ '("gsize" "val")
+ )
+)
+
+(define-function g_atomic_pointer_or
+ (c-name "g_atomic_pointer_or")
+ (return-type "gsize")
+ (parameters
+ '("volatile-void*" "atomic")
+ '("gsize" "val")
+ )
+)
+
+(define-function g_atomic_pointer_xor
+ (c-name "g_atomic_pointer_xor")
+ (return-type "gsize")
+ (parameters
+ '("volatile-void*" "atomic")
+ '("gsize" "val")
+ )
+)
+
+(define-function g_atomic_int_exchange_and_add
+ (c-name "g_atomic_int_exchange_and_add")
+ (return-type "gint")
+ (parameters
+ '("volatile-gint*" "atomic")
+ '("gint" "val")
+ )
+)
+
;; From gbacktrace.h
@@ -1668,6 +1788,33 @@
)
)
+(define-function g_pointer_bit_lock
+ (c-name "g_pointer_bit_lock")
+ (return-type "none")
+ (parameters
+ '("volatile-void*" "address")
+ '("gint" "lock_bit")
+ )
+)
+
+(define-function g_pointer_bit_trylock
+ (c-name "g_pointer_bit_trylock")
+ (return-type "gboolean")
+ (parameters
+ '("volatile-void*" "address")
+ '("gint" "lock_bit")
+ )
+)
+
+(define-function g_pointer_bit_unlock
+ (c-name "g_pointer_bit_unlock")
+ (return-type "none")
+ (parameters
+ '("volatile-void*" "address")
+ '("gint" "lock_bit")
+ )
+)
+
;; From gbookmarkfile.h
@@ -2077,6 +2224,30 @@
+;; From gbsearcharray.h
+
+(define-function if
+ (c-name "if")
+ (return-type "else")
+ (parameters
+ '("cmp-<" "0")
+ )
+)
+
+(define-function MIN
+ (c-name "MIN")
+ (return-type "return")
+ (parameters
+ '("barray->n_nodes-+" "1")
+ )
+)
+
+
+
+;; From gbufferprivate.h
+
+
+
;; From gcache.h
(define-function g_cache_new
@@ -2311,12 +2482,38 @@
)
)
+(define-method iconv
+ (of-object "GIConv")
+ (c-name "g_iconv")
+ (return-type "gsize")
+ (parameters
+ '("gchar**" "inbuf")
+ '("gsize*" "inbytes_left")
+ '("gchar**" "outbuf")
+ '("gsize*" "outbytes_left")
+ )
+)
+
(define-method close
(of-object "GIConv")
(c-name "g_iconv_close")
(return-type "gint")
)
+(define-function g_convert
+ (c-name "g_convert")
+ (return-type "gchar*")
+ (parameters
+ '("const-gchar*" "str")
+ '("gssize" "len")
+ '("const-gchar*" "to_codeset")
+ '("const-gchar*" "from_codeset")
+ '("gsize*" "bytes_read")
+ '("gsize*" "bytes_written")
+ '("GError**" "error")
+ )
+)
+
(define-function g_convert_with_iconv
(c-name "g_convert_with_iconv")
(return-type "gchar*")
@@ -2547,6 +2744,15 @@
)
)
+(define-function g_datalist_get_data
+ (c-name "g_datalist_get_data")
+ (return-type "gpointer")
+ (parameters
+ '("GData**" "datalist")
+ '("const-gchar*" "key")
+ )
+)
+
(define-function g_dataset_id_set_data_full
(c-name "g_dataset_id_set_data_full")
(return-type "none")
@@ -2579,6 +2785,10 @@
+;; From gdatasetprivate.h
+
+
+
;; From gdate.h
(define-function g_date_new
@@ -3259,6 +3469,10 @@
+;; From gdebug.h
+
+
+
;; From gdir.h
(define-function g_dir_open
@@ -4645,6 +4859,18 @@
)
)
+(define-method has_key_full
+ (of-object "GKeyFile")
+ (c-name "g_key_file_has_key_full")
+ (return-type "gboolean")
+ (parameters
+ '("const-gchar*" "group_name")
+ '("const-gchar*" "key")
+ '("gboolean*" "has_key")
+ '("GError**" "error")
+ )
+)
+
(define-method get_value
(of-object "GKeyFile")
(c-name "g_key_file_get_value")
@@ -5002,6 +5228,93 @@
+;; From glibconfig.h
+
+
+
+;; From glib.h
+
+
+
+;; From glibintl.h
+
+(define-function glib_gettext
+ (c-name "glib_gettext")
+ (return-type "const-gchar*")
+ (parameters
+ '("const-gchar*" "str")
+ )
+)
+
+(define-function glib_pgettext
+ (c-name "glib_pgettext")
+ (return-type "const-gchar*")
+ (parameters
+ '("const-gchar*" "msgctxtid")
+ '("gsize" "msgidoffset")
+ )
+)
+
+
+
+;; From glib-object.h
+
+
+
+;; From glib_trace.h
+
+
+
+;; From glib-unix.h
+
+(define-function g_unix_error_quark
+ (c-name "g_unix_error_quark")
+ (return-type "GQuark")
+)
+
+(define-function g_unix_open_pipe
+ (c-name "g_unix_open_pipe")
+ (return-type "gboolean")
+ (parameters
+ '("gint*" "fds")
+ '("gint" "flags")
+ '("GError**" "error")
+ )
+)
+
+(define-function g_unix_set_fd_nonblocking
+ (c-name "g_unix_set_fd_nonblocking")
+ (return-type "gboolean")
+ (parameters
+ '("gint" "fd")
+ '("gboolean" "nonblock")
+ '("GError**" "error")
+ )
+)
+
+(define-function g_unix_signal_source_new
+ (c-name "g_unix_signal_source_new")
+ (is-constructor-of "GUnixSignalSource")
+ (return-type "GSource*")
+ (parameters
+ '("gint" "signum")
+ )
+)
+
+(define-function g_unix_signal_add_watch_full
+ (c-name "g_unix_signal_add_watch_full")
+ (return-type "guint")
+ (parameters
+ '("gint" "signum")
+ '("gint" "priority")
+ '("GSourceFunc" "handler")
+ '("gpointer" "user_data")
+ '("GDestroyNotify" "notify")
+ )
+)
+
+
+
;; From glist.h
(define-function g_list_alloc
@@ -5680,6 +5993,24 @@
)
)
+(define-method add_child_source
+ (of-object "GSource")
+ (c-name "g_source_add_child_source")
+ (return-type "none")
+ (parameters
+ '("GSource*" "child_source")
+ )
+)
+
+(define-method remove_child_source
+ (of-object "GSource")
+ (c-name "g_source_remove_child_source")
+ (return-type "none")
+ (parameters
+ '("GSource*" "child_source")
+ )
+)
+
(define-method get_current_time
(of-object "GSource")
(c-name "g_source_get_current_time")
@@ -5888,6 +6219,10 @@
+;; From gmain-internal.h
+
+
+
;; From gmappedfile.h
(define-function g_mapped_file_new
@@ -6435,6 +6770,10 @@
+;; From gmirroringtable.h
+
+
+
;; From gnode.h
(define-function g_node_new
@@ -7047,6 +7386,10 @@
+;; From gprintfint.h
+
+
+
;; From gqsort.h
(define-function g_qsort_with_data
@@ -7284,7 +7627,7 @@
(define-method remove
(of-object "GQueue")
(c-name "g_queue_remove")
- (return-type "none")
+ (return-type "gboolean")
(parameters
'("gconstpointer" "data")
)
@@ -7293,7 +7636,7 @@
(define-method remove_all
(of-object "GQueue")
(c-name "g_queue_remove_all")
- (return-type "none")
+ (return-type "guint")
(parameters
'("gconstpointer" "data")
)
@@ -8166,6 +8509,10 @@
+;; From gscripttable.h
+
+
+
;; From gsequence.h
(define-function g_sequence_new
@@ -8387,6 +8734,28 @@
)
)
+(define-method lookup
+ (of-object "GSequence")
+ (c-name "g_sequence_lookup")
+ (return-type "GSequenceIter*")
+ (parameters
+ '("gpointer" "data")
+ '("GCompareDataFunc" "cmp_func")
+ '("gpointer" "cmp_data")
+ )
+)
+
+(define-method lookup_iter
+ (of-object "GSequence")
+ (c-name "g_sequence_lookup_iter")
+ (return-type "GSequenceIter*")
+ (parameters
+ '("gpointer" "data")
+ '("GSequenceIterCompareFunc" "iter_cmp")
+ '("gpointer" "cmp_data")
+ )
+)
+
(define-function g_sequence_get
(c-name "g_sequence_get")
(return-type "gpointer")
@@ -9999,6 +10368,11 @@
)
)
+(define-function g_test_fail
+ (c-name "g_test_fail")
+ (return-type "none")
+)
+
(define-function g_test_message
(c-name "g_test_message")
(return-type "none")
@@ -10665,6 +11039,15 @@
+;; From gthreadprivate.h
+
+(define-function g_thread_init_glib
+ (c-name "g_thread_init_glib")
+ (return-type "none")
+)
+
+
+
;; From gtimer.h
(define-function g_timer_new
@@ -10748,6 +11131,11 @@
;; From gtimezone.h
+(define-function g_time_zone_refresh_local
+ (c-name "g_time_zone_refresh_local")
+ (return-type "none")
+)
+
(define-function g_time_zone_new
(c-name "g_time_zone_new")
(is-constructor-of "GTimeZone")
@@ -10785,7 +11173,7 @@
(return-type "gint")
(parameters
'("GTimeType" "type")
- '("gint64" "time")
+ '("gint64" "time_")
)
)
@@ -10795,7 +11183,7 @@
(return-type "gint")
(parameters
'("GTimeType" "type")
- '("gint64*" "time")
+ '("gint64*" "time_")
)
)
@@ -10984,6 +11372,14 @@
+;; From gunibreak.h
+
+
+
+;; From gunichartables.h
+
+
+
;; From gunicode.h
(define-function g_get_charset
@@ -11459,6 +11855,18 @@
+;; From gunicodeprivate.h
+
+
+
+;; From gunicomp.h
+
+
+
+;; From gunidecomp.h
+
+
+
;; From gurifuncs.h
(define-function g_uri_unescape_string
@@ -11573,27 +11981,17 @@
(return-type "const-gchar*")
)
-(define-function g_get_system_data_dirs
- (c-name "g_get_system_data_dirs")
- (return-type "const-gchar**")
-)
-
-(define-function g_win32_get_system_data_dirs_for_module
- (c-name "g_win32_get_system_data_dirs_for_module")
- (return-type "const-gchar**")
- (parameters
- '("somepointer" "address_of_function")
- )
-)
-
(define-function g_get_user_runtime_dir
(c-name "g_get_user_runtime_dir")
(return-type "const-gchar*")
)
-(define-function g_get_language_names
- (c-name "g_get_language_names")
- (return-type "const-gchar**")
+(define-function g_get_locale_variants
+ (c-name "g_get_locale_variants")
+ (return-type "gchar**")
+ (parameters
+ '("const-gchar*" "locale")
+ )
)
(define-function g_get_user_special_dir
@@ -11753,6 +12151,10 @@
+;; From gvariant-core.h
+
+
+
;; From gvariant.h
(define-method unref
@@ -11816,7 +12218,7 @@
(c-name "g_variant_new_boolean")
(return-type "GVariant*")
(parameters
- '("gboolean" "boolean")
+ '("gboolean" "value")
)
)
@@ -11824,7 +12226,7 @@
(c-name "g_variant_new_byte")
(return-type "GVariant*")
(parameters
- '("guchar" "byte")
+ '("guchar" "value")
)
)
@@ -11832,7 +12234,7 @@
(c-name "g_variant_new_int16")
(return-type "GVariant*")
(parameters
- '("gint16" "int16")
+ '("gint16" "value")
)
)
@@ -11840,7 +12242,7 @@
(c-name "g_variant_new_uint16")
(return-type "GVariant*")
(parameters
- '("guint16" "uint16")
+ '("guint16" "value")
)
)
@@ -11848,7 +12250,7 @@
(c-name "g_variant_new_int32")
(return-type "GVariant*")
(parameters
- '("gint32" "int32")
+ '("gint32" "value")
)
)
@@ -11856,7 +12258,7 @@
(c-name "g_variant_new_uint32")
(return-type "GVariant*")
(parameters
- '("guint32" "uint32")
+ '("guint32" "value")
)
)
@@ -11864,7 +12266,7 @@
(c-name "g_variant_new_int64")
(return-type "GVariant*")
(parameters
- '("gint64" "int64")
+ '("gint64" "value")
)
)
@@ -11872,7 +12274,7 @@
(c-name "g_variant_new_uint64")
(return-type "GVariant*")
(parameters
- '("guint64" "uint64")
+ '("guint64" "value")
)
)
@@ -11880,7 +12282,7 @@
(c-name "g_variant_new_handle")
(return-type "GVariant*")
(parameters
- '("gint32" "handle")
+ '("gint32" "value")
)
)
@@ -11888,7 +12290,7 @@
(c-name "g_variant_new_double")
(return-type "GVariant*")
(parameters
- '("gdouble" "floating")
+ '("gdouble" "value")
)
)
@@ -12185,7 +12587,7 @@
(return-type "GVariant*")
(parameters
'("const-gchar*" "key")
- '("const-GVariantType*" "type")
+ '("const-GVariantType*" "expected_type")
)
)
@@ -12519,6 +12921,110 @@
+;; From gvariant-internal.h
+
+(define-function g_variant_format_string_scan
+ (c-name "g_variant_format_string_scan")
+ (return-type "gboolean")
+ (parameters
+ '("const-gchar*" "string")
+ '("const-gchar*" "limit")
+ '("const-gchar**" "endptr")
+ )
+)
+
+(define-function g_variant_format_string_scan_type
+ (c-name "g_variant_format_string_scan_type")
+ (return-type "GVariantType*")
+ (parameters
+ '("const-gchar*" "string")
+ '("const-gchar*" "limit")
+ '("const-gchar**" "endptr")
+ )
+)
+
+
+
+;; From gvariant-serialiser.h
+
+(define-method n_children
+ (of-object "GVariantSerialised")
+ (c-name "g_variant_serialised_n_children")
+ (return-type "gsize")
+)
+
+(define-method get_child
+ (of-object "GVariantSerialised")
+ (c-name "g_variant_serialised_get_child")
+ (return-type "GVariantSerialised")
+ (parameters
+ '("gsize" "index")
+ )
+)
+
+(define-function g_variant_serialiser_needed_size
+ (c-name "g_variant_serialiser_needed_size")
+ (return-type "gsize")
+ (parameters
+ '("GVariantTypeInfo*" "info")
+ '("GVariantSerialisedFiller" "gsv_filler")
+ '("const-gpointer*" "children")
+ '("gsize" "n_children")
+ )
+)
+
+(define-function g_variant_serialiser_serialise
+ (c-name "g_variant_serialiser_serialise")
+ (return-type "none")
+ (parameters
+ '("GVariantSerialised" "container")
+ '("GVariantSerialisedFiller" "gsv_filler")
+ '("const-gpointer*" "children")
+ '("gsize" "n_children")
+ )
+)
+
+(define-method is_normal
+ (of-object "GVariantSerialised")
+ (c-name "g_variant_serialised_is_normal")
+ (return-type "gboolean")
+)
+
+(define-method byteswap
+ (of-object "GVariantSerialised")
+ (c-name "g_variant_serialised_byteswap")
+ (return-type "none")
+)
+
+(define-function g_variant_serialiser_is_string
+ (c-name "g_variant_serialiser_is_string")
+ (return-type "gboolean")
+ (parameters
+ '("gconstpointer" "data")
+ '("gsize" "size")
+ )
+)
+
+(define-function g_variant_serialiser_is_object_path
+ (c-name "g_variant_serialiser_is_object_path")
+ (return-type "gboolean")
+ (parameters
+ '("gconstpointer" "data")
+ '("gsize" "size")
+ )
+)
+
+(define-function g_variant_serialiser_is_signature
+ (c-name "g_variant_serialiser_is_signature")
+ (return-type "gboolean")
+ (parameters
+ '("gconstpointer" "data")
+ '("gsize" "size")
+ )
+)
+
+
+
;; From gvarianttype.h
(define-function g_variant_type_string_is_valid
@@ -12728,6 +13234,80 @@
+;; From gvarianttypeinfo.h
+
+(define-method get_type_string
+ (of-object "GVariantTypeInfo")
+ (c-name "g_variant_type_info_get_type_string")
+ (return-type "const-gchar*")
+)
+
+(define-method query
+ (of-object "GVariantTypeInfo")
+ (c-name "g_variant_type_info_query")
+ (return-type "none")
+ (parameters
+ '("guint*" "alignment")
+ '("gsize*" "size")
+ )
+)
+
+(define-method element
+ (of-object "GVariantTypeInfo")
+ (c-name "g_variant_type_info_element")
+ (return-type "GVariantTypeInfo*")
+)
+
+(define-method query_element
+ (of-object "GVariantTypeInfo")
+ (c-name "g_variant_type_info_query_element")
+ (return-type "none")
+ (parameters
+ '("guint*" "alignment")
+ '("gsize*" "size")
+ )
+)
+
+(define-method n_members
+ (of-object "GVariantTypeInfo")
+ (c-name "g_variant_type_info_n_members")
+ (return-type "gsize")
+)
+
+(define-method member_info
+ (of-object "GVariantTypeInfo")
+ (c-name "g_variant_type_info_member_info")
+ (return-type "const-GVariantMemberInfo*")
+ (parameters
+ '("gsize" "index")
+ )
+)
+
+(define-method info_get
+ (of-object "GVariantType")
+ (c-name "g_variant_type_info_get")
+ (return-type "GVariantTypeInfo*")
+)
+
+(define-method ref
+ (of-object "GVariantTypeInfo")
+ (c-name "g_variant_type_info_ref")
+ (return-type "GVariantTypeInfo*")
+)
+
+(define-method unref
+ (of-object "GVariantTypeInfo")
+ (c-name "g_variant_type_info_unref")
+ (return-type "none")
+)
+
+(define-function g_variant_type_info_assert_no_infos
+ (c-name "g_variant_type_info_assert_no_infos")
+ (return-type "none")
+)
+
+
+
;; From gwin32.h
(define-function g_win32_ftruncate
@@ -12791,3 +13371,5 @@
'("const-gchar*" "utf8filename")
)
)
+
+
diff --git a/glib/src/gobject_enums.defs b/glib/src/gobject_enums.defs
index 3985c26..03ca6ba 100644
--- a/glib/src/gobject_enums.defs
+++ b/glib/src/gobject_enums.defs
@@ -1,3 +1,25 @@
+;; From gbinding.h
+
+;; Original typedef:
+;; typedef enum { /*< prefix=G_BINDING >*/
+;; G_BINDING_DEFAULT = 0,
+;;
+;; G_BINDING_BIDIRECTIONAL = 1 << 0,
+;; G_BINDING_SYNC_CREATE = 1 << 1,
+;; G_BINDING_INVERT_BOOLEAN = 1 << 2
+;; } GBindingFlags;
+
+(define-flags-extended BindingFlags
+ (in-module "G")
+ (c-name "GBindingFlags")
+ (values
+ '("default" "G_BINDING_DEFAULT" "0x0")
+ '("bidirectional" "G_BINDING_BIDIRECTIONAL" "1 << 0")
+ '("sync-create" "G_BINDING_SYNC_CREATE" "1 << 1")
+ '("invert-boolean" "G_BINDING_INVERT_BOOLEAN" "1 << 2")
+ )
+)
+
;; From gparam.h
;; Original typedef:
@@ -13,7 +35,9 @@
;; G_PARAM_PRIVATE = G_PARAM_STATIC_NAME,
;; #endif
;; G_PARAM_STATIC_NICK = 1 << 6,
-;; G_PARAM_STATIC_BLURB = 1 << 7
+;; G_PARAM_STATIC_BLURB = 1 << 7,
+;; /* User defined flags go up to 30 */
+;; G_PARAM_DEPRECATED = 1 << 31
;; } GParamFlags;
(define-flags-extended ParamFlags
@@ -29,6 +53,7 @@
'("private" "G_PARAM_PRIVATE" "0x20")
'("static-nick" "G_PARAM_STATIC_NICK" "1 << 6")
'("static-blurb" "G_PARAM_STATIC_BLURB" "1 << 7")
+ '("deprecated" "G_PARAM_DEPRECATED" "1 << 31")
)
)
@@ -43,7 +68,8 @@
;; G_SIGNAL_NO_RECURSE = 1 << 3,
;; G_SIGNAL_DETAILED = 1 << 4,
;; G_SIGNAL_ACTION = 1 << 5,
-;; G_SIGNAL_NO_HOOKS = 1 << 6
+;; G_SIGNAL_NO_HOOKS = 1 << 6,
+;; G_SIGNAL_MUST_COLLECT = 1 << 7
;; } GSignalFlags;
(define-flags-extended SignalFlags
@@ -57,6 +83,7 @@
'("detailed" "G_SIGNAL_DETAILED" "1 << 4")
'("action" "G_SIGNAL_ACTION" "1 << 5")
'("no-hooks" "G_SIGNAL_NO_HOOKS" "1 << 6")
+ '("must-collect" "G_SIGNAL_MUST_COLLECT" "1 << 7")
)
)
diff --git a/glib/src/gobject_functions.defs b/glib/src/gobject_functions.defs
index d821cef..af0e6a2 100644
--- a/glib/src/gobject_functions.defs
+++ b/glib/src/gobject_functions.defs
@@ -32,16 +32,16 @@
(c-name "GParamFlags")
(gtype-id "G_TYPE_PARAM_FLAGS")
(values
- '("readable" "G_PARAM_READABLE")
- '("writable" "G_PARAM_WRITABLE")
- '("construct" "G_PARAM_CONSTRUCT")
- '("construct-only" "G_PARAM_CONSTRUCT_ONLY")
- '("lax-validation" "G_PARAM_LAX_VALIDATION")
- '("static-name" "G_PARAM_STATIC_NAME")
- '("private" "G_PARAM_PRIVATE")
- '("static-nick" "G_PARAM_STATIC_NICK")
- '("static-blurb" "G_PARAM_STATIC_BLURB")
- '("deprecated" "G_PARAM_DEPRECATED")
+ '("g-param-readable" "G_PARAM_READABLE")
+ '("g-param-writable" "G_PARAM_WRITABLE")
+ '("g-param-construct" "G_PARAM_CONSTRUCT")
+ '("g-param-construct-only" "G_PARAM_CONSTRUCT_ONLY")
+ '("g-param-lax-validation" "G_PARAM_LAX_VALIDATION")
+ '("g-param-static-name" "G_PARAM_STATIC_NAME")
+ '("#ifndef" "#ifndef")
+ '("#endif" "#endif")
+ '("g-param-static-blurb" "G_PARAM_STATIC_BLURB")
+ '("g-param-deprecated" "G_PARAM_DEPRECATED")
)
)
@@ -57,6 +57,7 @@
'("detailed" "G_SIGNAL_DETAILED")
'("action" "G_SIGNAL_ACTION")
'("no-hooks" "G_SIGNAL_NO_HOOKS")
+ '("must-collect" "G_SIGNAL_MUST_COLLECT")
)
)
@@ -119,6 +120,10 @@
)
+;; From gatomicarray.h
+
+
+
;; From gbinding.h
(define-function g_binding_flags_get_type
@@ -243,6 +248,24 @@
)
)
+(define-method take_boxed
+ (of-object "GValue")
+ (c-name "g_value_take_boxed")
+ (return-type "none")
+ (parameters
+ '("gconstpointer" "v_boxed")
+ )
+)
+
+(define-method set_boxed_take_ownership
+ (of-object "GValue")
+ (c-name "g_value_set_boxed_take_ownership")
+ (return-type "none")
+ (parameters
+ '("gconstpointer" "v_boxed")
+ )
+)
+
(define-method get_boxed
(of-object "GValue")
(c-name "g_value_get_boxed")
@@ -265,24 +288,6 @@
)
)
-(define-method take_boxed
- (of-object "GValue")
- (c-name "g_value_take_boxed")
- (return-type "none")
- (parameters
- '("gconstpointer" "v_boxed")
- )
-)
-
-(define-method set_boxed_take_ownership
- (of-object "GValue")
- (c-name "g_value_set_boxed_take_ownership")
- (return-type "none")
- (parameters
- '("gconstpointer" "v_boxed")
- )
-)
-
(define-function g_closure_get_type
(c-name "g_closure_get_type")
(return-type "GType")
@@ -298,66 +303,6 @@
(return-type "GType")
)
-(define-function g_date_get_type
- (c-name "g_date_get_type")
- (return-type "GType")
-)
-
-(define-function g_strv_get_type
- (c-name "g_strv_get_type")
- (return-type "GType")
-)
-
-(define-function g_gstring_get_type
- (c-name "g_gstring_get_type")
- (return-type "GType")
-)
-
-(define-function g_hash_table_get_type
- (c-name "g_hash_table_get_type")
- (return-type "GType")
-)
-
-(define-function g_array_get_type
- (c-name "g_array_get_type")
- (return-type "GType")
-)
-
-(define-function g_byte_array_get_type
- (c-name "g_byte_array_get_type")
- (return-type "GType")
-)
-
-(define-function g_ptr_array_get_type
- (c-name "g_ptr_array_get_type")
- (return-type "GType")
-)
-
-(define-function g_variant_type_get_gtype
- (c-name "g_variant_type_get_gtype")
- (return-type "GType")
-)
-
-(define-function g_regex_get_type
- (c-name "g_regex_get_type")
- (return-type "GType")
-)
-
-(define-function g_error_get_type
- (c-name "g_error_get_type")
- (return-type "GType")
-)
-
-(define-function g_date_time_get_type
- (c-name "g_date_time_get_type")
- (return-type "GType")
-)
-
-(define-function g_variant_get_gtype
- (c-name "g_variant_get_gtype")
- (return-type "GType")
-)
-
;; From gclosure.h
@@ -509,6 +454,19 @@
)
)
+(define-function g_cclosure_marshal_generic
+ (c-name "g_cclosure_marshal_generic")
+ (return-type "none")
+ (parameters
+ '("GClosure*" "closure")
+ '("GValue*" "return_gvalue")
+ '("guint" "n_param_values")
+ '("const-GValue*" "param_values")
+ '("gpointer" "invocation_hint")
+ '("gpointer" "marshal_data")
+ )
+)
+
;; From genums.h
@@ -637,6 +595,85 @@
+;; From glib-types.h
+
+(define-function g_date_get_type
+ (c-name "g_date_get_type")
+ (return-type "GType")
+)
+
+(define-function g_strv_get_type
+ (c-name "g_strv_get_type")
+ (return-type "GType")
+)
+
+(define-function g_gstring_get_type
+ (c-name "g_gstring_get_type")
+ (return-type "GType")
+)
+
+(define-function g_hash_table_get_type
+ (c-name "g_hash_table_get_type")
+ (return-type "GType")
+)
+
+(define-function g_array_get_type
+ (c-name "g_array_get_type")
+ (return-type "GType")
+)
+
+(define-function g_byte_array_get_type
+ (c-name "g_byte_array_get_type")
+ (return-type "GType")
+)
+
+(define-function g_ptr_array_get_type
+ (c-name "g_ptr_array_get_type")
+ (return-type "GType")
+)
+
+(define-function g_variant_type_get_gtype
+ (c-name "g_variant_type_get_gtype")
+ (return-type "GType")
+)
+
+(define-function g_regex_get_type
+ (c-name "g_regex_get_type")
+ (return-type "GType")
+)
+
+(define-function g_error_get_type
+ (c-name "g_error_get_type")
+ (return-type "GType")
+)
+
+(define-function g_date_time_get_type
+ (c-name "g_date_time_get_type")
+ (return-type "GType")
+)
+
+(define-function g_io_channel_get_type
+ (c-name "g_io_channel_get_type")
+ (return-type "GType")
+)
+
+(define-function g_io_condition_get_type
+ (c-name "g_io_condition_get_type")
+ (return-type "GType")
+)
+
+(define-function g_variant_builder_get_type
+ (c-name "g_variant_builder_get_type")
+ (return-type "GType")
+)
+
+(define-function g_variant_get_gtype
+ (c-name "g_variant_get_gtype")
+ (return-type "GType")
+)
+
+
+
;; From gmarshal.h
@@ -1154,6 +1191,10 @@
+;; From gobject_trace.h
+
+
+
;; From gparam.h
(define-method ref
@@ -2138,14 +2179,10 @@
)
)
-(define-function g_io_channel_get_type
- (c-name "g_io_channel_get_type")
- (return-type "GType")
-)
-
-(define-function g_io_condition_get_type
- (c-name "g_io_condition_get_type")
- (return-type "GType")
+(define-method set_dummy_callback
+ (of-object "GSource")
+ (c-name "g_source_set_dummy_callback")
+ (return-type "none")
)
@@ -2754,6 +2791,10 @@
+;; From gtype-private.h
+
+
+
;; From gvaluearray.h
(define-method get_nth
@@ -3237,3 +3278,7 @@
)
+
+;; From stamp-gmarshal.h
+
+
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
