mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2025-10-03 04:09:20 +02:00
d761fb4b3b
* glib/gstrfuncs.c, glib/giochannel.c: documentation update.
* glib/gqueue.c: add documentation.
* glib/tmpl/iochannel.sgml, glib/tmpl/macros_misc.sgml,
glib/tmpl/queue.sgml: update docs.
* glib/tmpl/modules.sgml, glib/tmpl/threads.sgml: Remove
references to glib-config.
162 lines
2.3 KiB
Plaintext
162 lines
2.3 KiB
Plaintext
<!-- ##### SECTION Title ##### -->
|
|
Double-ended Queues
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
|
double-ended queue data structure
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
<para>
|
|
The #GQueue structure and its associated functions provide a standard
|
|
queue data structure. Internally, #GQueue uses the same data structure as
|
|
#GList to store elements.
|
|
</para>
|
|
<para>
|
|
The data contained in each element can be either integer values, by using one
|
|
of the
|
|
<link linkend="glib-Type-Conversion-Macros">Type Conversion Macros</link>,
|
|
or simply pointers to any type of data.
|
|
</para>
|
|
<para>
|
|
To create a new #GQueue, use g_queue_new().
|
|
</para>
|
|
<para>
|
|
To add elements, use g_queue_push_head(), g_queue_push_head_link(),
|
|
g_queue_push_tail() and g_queue_push_tail_link().
|
|
</para>
|
|
<para>
|
|
To remove elements, use g_queue_pop_head() and g_queue_pop_tail().
|
|
</para>
|
|
<para>
|
|
To free the entire queue, use g_queue_free().
|
|
</para>
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### STRUCT GQueue ##### -->
|
|
<para>
|
|
Contains the public fields of a <link linkend="glib-queues">Queue</link>.
|
|
</para>
|
|
|
|
@head: a pointer to the first element of the queue.
|
|
@tail: a pointer to the last element of the queue.
|
|
@length: the number of elements in the queue.
|
|
|
|
<!-- ##### FUNCTION g_queue_new ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION g_queue_free ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@queue:
|
|
|
|
|
|
<!-- ##### FUNCTION g_queue_push_head ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@queue:
|
|
@data:
|
|
|
|
|
|
<!-- ##### FUNCTION g_queue_push_tail ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@queue:
|
|
@data:
|
|
|
|
|
|
<!-- ##### FUNCTION g_queue_pop_head ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@queue:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION g_queue_pop_tail ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@queue:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION g_queue_is_empty ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@queue:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION g_queue_peek_head ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@queue:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION g_queue_peek_tail ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@queue:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION g_queue_push_head_link ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@queue:
|
|
@link:
|
|
|
|
|
|
<!-- ##### FUNCTION g_queue_push_tail_link ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@queue:
|
|
@link:
|
|
|
|
|
|
<!-- ##### FUNCTION g_queue_pop_head_link ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@queue:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION g_queue_pop_tail_link ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@queue:
|
|
@Returns:
|
|
|
|
|