glib/gqueue.h

   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
  34 G_BEGIN_DECLS
  35
  36 typedef 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  */
  47 struct _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  */
  72 GLIB_AVAILABLE_IN_ALL
  73 GQueue*  g_queue_new            (void);
  74 GLIB_AVAILABLE_IN_ALL
  75 void     g_queue_free           (GQueue           *queue);
  76 GLIB_AVAILABLE_IN_ALL
  77 void     g_queue_free_full      (GQueue           *queue,
  78                                 GDestroyNotify    free_func);
  79 GLIB_AVAILABLE_IN_ALL
  80 void     g_queue_init           (GQueue           *queue);
  81 GLIB_AVAILABLE_IN_ALL
  82 void     g_queue_clear          (GQueue           *queue);
  83 GLIB_AVAILABLE_IN_ALL
  84 gboolean g_queue_is_empty       (GQueue           *queue);
  85 GLIB_AVAILABLE_IN_ALL
  86 guint    g_queue_get_length     (GQueue           *queue);
  87 GLIB_AVAILABLE_IN_ALL
  88 void     g_queue_reverse        (GQueue           *queue);
  89 GLIB_AVAILABLE_IN_ALL
  90 GQueue * g_queue_copy           (GQueue           *queue);
  91 GLIB_AVAILABLE_IN_ALL
  92 void     g_queue_foreach        (GQueue           *queue,
  93                                  GFunc             func,
  94                                  gpointer          user_data);
  95 GLIB_AVAILABLE_IN_ALL
  96 GList *  g_queue_find           (GQueue           *queue,
  97                                  gconstpointer     data);
  98 GLIB_AVAILABLE_IN_ALL
  99 GList *  g_queue_find_custom    (GQueue           *queue,
 100                                  gconstpointer     data,
 101                                  GCompareFunc      func);
 102 GLIB_AVAILABLE_IN_ALL
 103 void     g_queue_sort           (GQueue           *queue,
 104                                  GCompareDataFunc  compare_func,
 105                                  gpointer          user_data);
 106
 107 GLIB_AVAILABLE_IN_ALL
 108 void     g_queue_push_head      (GQueue           *queue,
 109                                  gpointer          data);
 110 GLIB_AVAILABLE_IN_ALL
 111 void     g_queue_push_tail      (GQueue           *queue,
 112                                  gpointer          data);
 113 GLIB_AVAILABLE_IN_ALL
 114 void     g_queue_push_nth       (GQueue           *queue,
 115                                  gpointer          data,
 116                                  gint              n);
 117 GLIB_AVAILABLE_IN_ALL
 118 gpointer g_queue_pop_head       (GQueue           *queue);
 119 GLIB_AVAILABLE_IN_ALL
 120 gpointer g_queue_pop_tail       (GQueue           *queue);
 121 GLIB_AVAILABLE_IN_ALL
 122 gpointer g_queue_pop_nth        (GQueue           *queue,
 123                                  guint             n);
 124 GLIB_AVAILABLE_IN_ALL
 125 gpointer g_queue_peek_head      (GQueue           *queue);
 126 GLIB_AVAILABLE_IN_ALL
 127 gpointer g_queue_peek_tail      (GQueue           *queue);
 128 GLIB_AVAILABLE_IN_ALL
 129 gpointer g_queue_peek_nth       (GQueue           *queue,
 130                                  guint             n);
 131 GLIB_AVAILABLE_IN_ALL
 132 gint     g_queue_index          (GQueue           *queue,
 133                                  gconstpointer     data);
 134 GLIB_AVAILABLE_IN_ALL
 135 gboolean g_queue_remove         (GQueue           *queue,
 136                                  gconstpointer     data);
 137 GLIB_AVAILABLE_IN_ALL
 138 guint    g_queue_remove_all     (GQueue           *queue,
 139                                  gconstpointer     data);
 140 GLIB_AVAILABLE_IN_ALL
 141 void     g_queue_insert_before  (GQueue           *queue,
 142                                  GList            *sibling,
 143                                  gpointer          data);
 144 GLIB_AVAILABLE_IN_ALL
 145 void     g_queue_insert_after   (GQueue           *queue,
 146                                  GList            *sibling,
 147                                  gpointer          data);
 148 GLIB_AVAILABLE_IN_ALL
 149 void     g_queue_insert_sorted  (GQueue           *queue,
 150                                  gpointer          data,
 151                                  GCompareDataFunc  func,
 152                                  gpointer          user_data);
 153
 154 GLIB_AVAILABLE_IN_ALL
 155 void     g_queue_push_head_link (GQueue           *queue,
 156                                  GList            *link_);
 157 GLIB_AVAILABLE_IN_ALL
 158 void     g_queue_push_tail_link (GQueue           *queue,
 159                                  GList            *link_);
 160 GLIB_AVAILABLE_IN_ALL
 161 void     g_queue_push_nth_link  (GQueue           *queue,
 162                                  gint              n,
 163                                  GList            *link_);
 164 GLIB_AVAILABLE_IN_ALL
 165 GList*   g_queue_pop_head_link  (GQueue           *queue);
 166 GLIB_AVAILABLE_IN_ALL
 167 GList*   g_queue_pop_tail_link  (GQueue           *queue);
 168 GLIB_AVAILABLE_IN_ALL
 169 GList*   g_queue_pop_nth_link   (GQueue           *queue,
 170                                  guint             n);
 171 GLIB_AVAILABLE_IN_ALL
 172 GList*   g_queue_peek_head_link (GQueue           *queue);
 173 GLIB_AVAILABLE_IN_ALL
 174 GList*   g_queue_peek_tail_link (GQueue           *queue);
 175 GLIB_AVAILABLE_IN_ALL
 176 GList*   g_queue_peek_nth_link  (GQueue           *queue,
 177                                  guint             n);
 178 GLIB_AVAILABLE_IN_ALL
 179 gint     g_queue_link_index     (GQueue           *queue,
 180                                  GList            *link_);
 181 GLIB_AVAILABLE_IN_ALL
 182 void     g_queue_unlink         (GQueue           *queue,
 183                                  GList            *link_);
 184 GLIB_AVAILABLE_IN_ALL
 185 void     g_queue_delete_link    (GQueue           *queue,
 186                                  GList            *link_);
 187
 188 G_END_DECLS
 189
 190 #endif /* __G_QUEUE_H__ */