1 /* GLIB - Library of useful routines for C programming
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GLib Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GLib Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GLib at ftp://ftp.gtk.org/pub/gtk/.
30 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
31 #error "Only <glib.h> can be included directly."
34 #include <glib/glist.h>
38 typedef struct _GQueue GQueue;
42 * @head: a pointer to the first element of the queue
43 * @tail: a pointer to the last element of the queue
44 * @length: the number of elements in the queue
46 * Contains the public fields of a
47 * <link linkend="glib-Double-ended-Queues">Queue</link>.
59 * A statically-allocated #GQueue must be initialized with this
60 * macro before it can be used. This macro can be used to initialize
61 * a variable, but it cannot be assigned to a variable. In that case
62 * you have to use g_queue_init().
65 * GQueue my_queue = G_QUEUE_INIT;
70 #define G_QUEUE_INIT { NULL, NULL, 0 }
75 GQueue* g_queue_new (void);
77 void g_queue_free (GQueue *queue);
79 void g_queue_free_full (GQueue *queue,
80 GDestroyNotify free_func);
82 void g_queue_init (GQueue *queue);
84 void g_queue_clear (GQueue *queue);
86 gboolean g_queue_is_empty (GQueue *queue);
88 guint g_queue_get_length (GQueue *queue);
90 void g_queue_reverse (GQueue *queue);
92 GQueue * g_queue_copy (GQueue *queue);
94 void g_queue_foreach (GQueue *queue,
98 GList * g_queue_find (GQueue *queue,
100 GLIB_AVAILABLE_IN_ALL
101 GList * g_queue_find_custom (GQueue *queue,
104 GLIB_AVAILABLE_IN_ALL
105 void g_queue_sort (GQueue *queue,
106 GCompareDataFunc compare_func,
109 GLIB_AVAILABLE_IN_ALL
110 void g_queue_push_head (GQueue *queue,
112 GLIB_AVAILABLE_IN_ALL
113 void g_queue_push_tail (GQueue *queue,
115 GLIB_AVAILABLE_IN_ALL
116 void g_queue_push_nth (GQueue *queue,
119 GLIB_AVAILABLE_IN_ALL
120 gpointer g_queue_pop_head (GQueue *queue);
121 GLIB_AVAILABLE_IN_ALL
122 gpointer g_queue_pop_tail (GQueue *queue);
123 GLIB_AVAILABLE_IN_ALL
124 gpointer g_queue_pop_nth (GQueue *queue,
126 GLIB_AVAILABLE_IN_ALL
127 gpointer g_queue_peek_head (GQueue *queue);
128 GLIB_AVAILABLE_IN_ALL
129 gpointer g_queue_peek_tail (GQueue *queue);
130 GLIB_AVAILABLE_IN_ALL
131 gpointer g_queue_peek_nth (GQueue *queue,
133 GLIB_AVAILABLE_IN_ALL
134 gint g_queue_index (GQueue *queue,
136 GLIB_AVAILABLE_IN_ALL
137 gboolean g_queue_remove (GQueue *queue,
139 GLIB_AVAILABLE_IN_ALL
140 guint g_queue_remove_all (GQueue *queue,
142 GLIB_AVAILABLE_IN_ALL
143 void g_queue_insert_before (GQueue *queue,
146 GLIB_AVAILABLE_IN_ALL
147 void g_queue_insert_after (GQueue *queue,
150 GLIB_AVAILABLE_IN_ALL
151 void g_queue_insert_sorted (GQueue *queue,
153 GCompareDataFunc func,
156 GLIB_AVAILABLE_IN_ALL
157 void g_queue_push_head_link (GQueue *queue,
159 GLIB_AVAILABLE_IN_ALL
160 void g_queue_push_tail_link (GQueue *queue,
162 GLIB_AVAILABLE_IN_ALL
163 void g_queue_push_nth_link (GQueue *queue,
166 GLIB_AVAILABLE_IN_ALL
167 GList* g_queue_pop_head_link (GQueue *queue);
168 GLIB_AVAILABLE_IN_ALL
169 GList* g_queue_pop_tail_link (GQueue *queue);
170 GLIB_AVAILABLE_IN_ALL
171 GList* g_queue_pop_nth_link (GQueue *queue,
173 GLIB_AVAILABLE_IN_ALL
174 GList* g_queue_peek_head_link (GQueue *queue);
175 GLIB_AVAILABLE_IN_ALL
176 GList* g_queue_peek_tail_link (GQueue *queue);
177 GLIB_AVAILABLE_IN_ALL
178 GList* g_queue_peek_nth_link (GQueue *queue,
180 GLIB_AVAILABLE_IN_ALL
181 gint g_queue_link_index (GQueue *queue,
183 GLIB_AVAILABLE_IN_ALL
184 void g_queue_unlink (GQueue *queue,
186 GLIB_AVAILABLE_IN_ALL
187 void g_queue_delete_link (GQueue *queue,
192 #endif /* __G_QUEUE_H__ */