1/* GLIB - Library of useful routines for C programming
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
3 *
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.
8 *
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.
13 *
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
16 */
17
18/*
19 * Modified by the GLib Team and others 1997-2000. See the AUTHORS
20 * file for a list of people on the GLib Team. See the ChangeLog
21 * files for a list of changes. These files are distributed with
22 * GLib at ftp://ftp.gtk.org/pub/gtk/.
23 */
24
25#ifndef __G_QUEUE_H__
26#define __G_QUEUE_H__
27
28#if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
29#error "Only <glib.h> can be included directly."
30#endif
31
32#include <glib/glist.h>
33
34G_BEGIN_DECLS
35
36typedef struct _GQueue GQueue;
37
38/**
39 * GQueue:
40 * @head: a pointer to the first element of the queue
41 * @tail: a pointer to the last element of the queue
42 * @length: the number of elements in the queue
43 *
44 * Contains the public fields of a
45 * [Queue][glib-Double-ended-Queues].
46 */
47struct _GQueue
48{
49 GList *head;
50 GList *tail;
51 guint length;
52};
53
54/**
55 * G_QUEUE_INIT:
56 *
57 * A statically-allocated #GQueue must be initialized with this
58 * macro before it can be used. This macro can be used to initialize
59 * a variable, but it cannot be assigned to a variable. In that case
60 * you have to use g_queue_init().
61 *
62 * |[
63 * GQueue my_queue = G_QUEUE_INIT;
64 * ]|
65 *
66 * Since: 2.14
67 */
68#define G_QUEUE_INIT { NULL, NULL, 0 }
69
70/* Queues
71 */
72GLIB_AVAILABLE_IN_ALL
73GQueue* g_queue_new (void);
74GLIB_AVAILABLE_IN_ALL
75void g_queue_free (GQueue *queue);
76GLIB_AVAILABLE_IN_ALL
77void g_queue_free_full (GQueue *queue,
78 GDestroyNotify free_func);
79GLIB_AVAILABLE_IN_ALL
80void g_queue_init (GQueue *queue);
81GLIB_AVAILABLE_IN_ALL
82void g_queue_clear (GQueue *queue);
83GLIB_AVAILABLE_IN_ALL
84gboolean g_queue_is_empty (GQueue *queue);
85GLIB_AVAILABLE_IN_ALL
86guint g_queue_get_length (GQueue *queue);
87GLIB_AVAILABLE_IN_ALL
88void g_queue_reverse (GQueue *queue);
89GLIB_AVAILABLE_IN_ALL
90GQueue * g_queue_copy (GQueue *queue);
91GLIB_AVAILABLE_IN_ALL
92void g_queue_foreach (GQueue *queue,
93 GFunc func,
94 gpointer user_data);
95GLIB_AVAILABLE_IN_ALL
96GList * g_queue_find (GQueue *queue,
97 gconstpointer data);
98GLIB_AVAILABLE_IN_ALL
99GList * g_queue_find_custom (GQueue *queue,
100 gconstpointer data,
101 GCompareFunc func);
102GLIB_AVAILABLE_IN_ALL
103void g_queue_sort (GQueue *queue,
104 GCompareDataFunc compare_func,
105 gpointer user_data);
106
107GLIB_AVAILABLE_IN_ALL
108void g_queue_push_head (GQueue *queue,
109 gpointer data);
110GLIB_AVAILABLE_IN_ALL
111void g_queue_push_tail (GQueue *queue,
112 gpointer data);
113GLIB_AVAILABLE_IN_ALL
114void g_queue_push_nth (GQueue *queue,
115 gpointer data,
116 gint n);
117GLIB_AVAILABLE_IN_ALL
118gpointer g_queue_pop_head (GQueue *queue);
119GLIB_AVAILABLE_IN_ALL
120gpointer g_queue_pop_tail (GQueue *queue);
121GLIB_AVAILABLE_IN_ALL
122gpointer g_queue_pop_nth (GQueue *queue,
123 guint n);
124GLIB_AVAILABLE_IN_ALL
125gpointer g_queue_peek_head (GQueue *queue);
126GLIB_AVAILABLE_IN_ALL
127gpointer g_queue_peek_tail (GQueue *queue);
128GLIB_AVAILABLE_IN_ALL
129gpointer g_queue_peek_nth (GQueue *queue,
130 guint n);
131GLIB_AVAILABLE_IN_ALL
132gint g_queue_index (GQueue *queue,
133 gconstpointer data);
134GLIB_AVAILABLE_IN_ALL
135gboolean g_queue_remove (GQueue *queue,
136 gconstpointer data);
137GLIB_AVAILABLE_IN_ALL
138guint g_queue_remove_all (GQueue *queue,
139 gconstpointer data);
140GLIB_AVAILABLE_IN_ALL
141void g_queue_insert_before (GQueue *queue,
142 GList *sibling,
143 gpointer data);
144GLIB_AVAILABLE_IN_ALL
145void g_queue_insert_after (GQueue *queue,
146 GList *sibling,
147 gpointer data);
148GLIB_AVAILABLE_IN_ALL
149void g_queue_insert_sorted (GQueue *queue,
150 gpointer data,
151 GCompareDataFunc func,
152 gpointer user_data);
153
154GLIB_AVAILABLE_IN_ALL
155void g_queue_push_head_link (GQueue *queue,
156 GList *link_);
157GLIB_AVAILABLE_IN_ALL
158void g_queue_push_tail_link (GQueue *queue,
159 GList *link_);
160GLIB_AVAILABLE_IN_ALL
161void g_queue_push_nth_link (GQueue *queue,
162 gint n,
163 GList *link_);
164GLIB_AVAILABLE_IN_ALL
165GList* g_queue_pop_head_link (GQueue *queue);
166GLIB_AVAILABLE_IN_ALL
167GList* g_queue_pop_tail_link (GQueue *queue);
168GLIB_AVAILABLE_IN_ALL
169GList* g_queue_pop_nth_link (GQueue *queue,
170 guint n);
171GLIB_AVAILABLE_IN_ALL
172GList* g_queue_peek_head_link (GQueue *queue);
173GLIB_AVAILABLE_IN_ALL
174GList* g_queue_peek_tail_link (GQueue *queue);
175GLIB_AVAILABLE_IN_ALL
176GList* g_queue_peek_nth_link (GQueue *queue,
177 guint n);
178GLIB_AVAILABLE_IN_ALL
179gint g_queue_link_index (GQueue *queue,
180 GList *link_);
181GLIB_AVAILABLE_IN_ALL
182void g_queue_unlink (GQueue *queue,
183 GList *link_);
184GLIB_AVAILABLE_IN_ALL
185void g_queue_delete_link (GQueue *queue,
186 GList *link_);
187
188G_END_DECLS
189
190#endif /* __G_QUEUE_H__ */
191