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, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 /*
  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/.
  25  */
  26
  27 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
  28 #error "Only <glib.h> can be included directly."
  29 #endif
  30
  31 #ifndef __G_QUEUE_H__
  32 #define __G_QUEUE_H__
  33
  34 #include <glib/glist.h>
  35
  36 G_BEGIN_DECLS
  37
  38 typedef struct _GQueue GQueue;
  39
  40 /**
  41  * 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
  45  *
  46  * Contains the public fields of a
  47  * <link linkend="glib-Double-ended-Queues">Queue</link>.
  48  */
  49 struct _GQueue
  50 {
  51   GList *head;
  52   GList *tail;
  53   guint  length;
  54 };
  55
  56 /**
  57  * G_QUEUE_INIT:
  58  *
  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().
  63  *
  64  * |[
  65  * GQueue my_queue = G_QUEUE_INIT;
  66  * ]|
  67  *
  68  * Since: 2.14
  69  */
  70 #define G_QUEUE_INIT { NULL, NULL, 0 }
  71
  72 /* Queues
  73  */
  74 GQueue*  g_queue_new            (void);
  75 void     g_queue_free           (GQueue           *queue);
  76 void     g_queue_free_full      (GQueue           *queue,
  77                                 GDestroyNotify    free_func);
  78 void     g_queue_init           (GQueue           *queue);
  79 void     g_queue_clear          (GQueue           *queue);
  80 gboolean g_queue_is_empty       (GQueue           *queue);
  81 guint    g_queue_get_length     (GQueue           *queue);
  82 void     g_queue_reverse        (GQueue           *queue);
  83 GQueue * g_queue_copy           (GQueue           *queue);
  84 void     g_queue_foreach        (GQueue           *queue,
  85                                  GFunc             func,
  86                                  gpointer          user_data);
  87 GList *  g_queue_find           (GQueue           *queue,
  88                                  gconstpointer     data);
  89 GList *  g_queue_find_custom    (GQueue           *queue,
  90                                  gconstpointer     data,
  91                                  GCompareFunc      func);
  92 void     g_queue_sort           (GQueue           *queue,
  93                                  GCompareDataFunc  compare_func,
  94                                  gpointer          user_data);
  95
  96 void     g_queue_push_head      (GQueue           *queue,
  97                                  gpointer          data);
  98 void     g_queue_push_tail      (GQueue           *queue,
  99                                  gpointer          data);
 100 void     g_queue_push_nth       (GQueue           *queue,
 101                                  gpointer          data,
 102                                  gint              n);
 103 gpointer g_queue_pop_head       (GQueue           *queue);
 104 gpointer g_queue_pop_tail       (GQueue           *queue);
 105 gpointer g_queue_pop_nth        (GQueue           *queue,
 106                                  guint             n);
 107 gpointer g_queue_peek_head      (GQueue           *queue);
 108 gpointer g_queue_peek_tail      (GQueue           *queue);
 109 gpointer g_queue_peek_nth       (GQueue           *queue,
 110                                  guint             n);
 111 gint     g_queue_index          (GQueue           *queue,
 112                                  gconstpointer     data);
 113 gboolean g_queue_remove         (GQueue           *queue,
 114                                  gconstpointer     data);
 115 guint    g_queue_remove_all     (GQueue           *queue,
 116                                  gconstpointer     data);
 117 void     g_queue_insert_before  (GQueue           *queue,
 118                                  GList            *sibling,
 119                                  gpointer          data);
 120 void     g_queue_insert_after   (GQueue           *queue,
 121                                  GList            *sibling,
 122                                  gpointer          data);
 123 void     g_queue_insert_sorted  (GQueue           *queue,
 124                                  gpointer          data,
 125                                  GCompareDataFunc  func,
 126                                  gpointer          user_data);
 127
 128 void     g_queue_push_head_link (GQueue           *queue,
 129                                  GList            *link_);
 130 void     g_queue_push_tail_link (GQueue           *queue,
 131                                  GList            *link_);
 132 void     g_queue_push_nth_link  (GQueue           *queue,
 133                                  gint              n,
 134                                  GList            *link_);
 135 GList*   g_queue_pop_head_link  (GQueue           *queue);
 136 GList*   g_queue_pop_tail_link  (GQueue           *queue);
 137 GList*   g_queue_pop_nth_link   (GQueue           *queue,
 138                                  guint             n);
 139 GList*   g_queue_peek_head_link (GQueue           *queue);
 140 GList*   g_queue_peek_tail_link (GQueue           *queue);
 141 GList*   g_queue_peek_nth_link  (GQueue           *queue,
 142                                  guint             n);
 143 gint     g_queue_link_index     (GQueue           *queue,
 144                                  GList            *link_);
 145 void     g_queue_unlink         (GQueue           *queue,
 146                                  GList            *link_);
 147 void     g_queue_delete_link    (GQueue           *queue,
 148                                  GList            *link_);
 149
 150 G_END_DECLS
 151
 152 #endif /* __G_QUEUE_H__ */