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 #ifndef __G_QUEUE_H__
  28 #define __G_QUEUE_H__
  29
  30 #include <glib/glist.h>
  31
  32 G_BEGIN_DECLS
  33
  34 typedef struct _GQueue          GQueue;
  35
  36 struct _GQueue
  37 {
  38   GList *head;
  39   GList *tail;
  40   guint  length;
  41 };
  42
  43 #define G_QUEUE_INIT { NULL, NULL, 0 }
  44
  45 /* Queues
  46  */
  47 GQueue*  g_queue_new            (void);
  48 void     g_queue_free           (GQueue           *queue);
  49 void     g_queue_init           (GQueue           *queue);
  50 void     g_queue_clear          (GQueue           *queue);
  51 gboolean g_queue_is_empty       (GQueue           *queue);
  52 guint    g_queue_get_length     (GQueue           *queue);
  53 void     g_queue_reverse        (GQueue           *queue);
  54 GQueue * g_queue_copy           (GQueue           *queue);
  55 void     g_queue_foreach        (GQueue           *queue,
  56                                  GFunc             func,
  57                                  gpointer          user_data);
  58 GList *  g_queue_find           (GQueue           *queue,
  59                                  gconstpointer     data);
  60 GList *  g_queue_find_custom    (GQueue           *queue,
  61                                  gconstpointer     data,
  62                                  GCompareFunc      func);
  63 void     g_queue_sort           (GQueue           *queue,
  64                                  GCompareDataFunc  compare_func,
  65                                  gpointer          user_data);
  66
  67 void     g_queue_push_head      (GQueue           *queue,
  68                                  gpointer          data);
  69 void     g_queue_push_tail      (GQueue           *queue,
  70                                  gpointer          data);
  71 void     g_queue_push_nth       (GQueue           *queue,
  72                                  gpointer          data,
  73                                  gint              n);
  74 gpointer g_queue_pop_head       (GQueue           *queue);
  75 gpointer g_queue_pop_tail       (GQueue           *queue);
  76 gpointer g_queue_pop_nth        (GQueue           *queue,
  77                                  guint             n);
  78 gpointer g_queue_peek_head      (GQueue           *queue);
  79 gpointer g_queue_peek_tail      (GQueue           *queue);
  80 gpointer g_queue_peek_nth       (GQueue           *queue,
  81                                  guint             n);
  82 gint     g_queue_index          (GQueue           *queue,
  83                                  gconstpointer     data);
  84 void     g_queue_remove         (GQueue           *queue,
  85                                  gconstpointer     data);
  86 void     g_queue_remove_all     (GQueue           *queue,
  87                                  gconstpointer     data);
  88 void     g_queue_insert_before  (GQueue           *queue,
  89                                  GList            *sibling,
  90                                  gpointer          data);
  91 void     g_queue_insert_after   (GQueue           *queue,
  92                                  GList            *sibling,
  93                                  gpointer          data);
  94 void     g_queue_insert_sorted  (GQueue           *queue,
  95                                  gpointer          data,
  96                                  GCompareDataFunc  func,
  97                                  gpointer          user_data);
  98
  99 void     g_queue_push_head_link (GQueue           *queue,
 100                                  GList            *link_);
 101 void     g_queue_push_tail_link (GQueue           *queue,
 102                                  GList            *link_);
 103 void     g_queue_push_nth_link  (GQueue           *queue,
 104                                  gint              n,
 105                                  GList            *link_);
 106 GList*   g_queue_pop_head_link  (GQueue           *queue);
 107 GList*   g_queue_pop_tail_link  (GQueue           *queue);
 108 GList*   g_queue_pop_nth_link   (GQueue           *queue,
 109                                  guint             n);
 110 GList*   g_queue_peek_head_link (GQueue           *queue);
 111 GList*   g_queue_peek_tail_link (GQueue           *queue);
 112 GList*   g_queue_peek_nth_link  (GQueue           *queue,
 113                                  guint             n);
 114 gint     g_queue_link_index     (GQueue           *queue,
 115                                  GList            *link_);
 116 void     g_queue_unlink         (GQueue           *queue,
 117                                  GList            *link_);
 118 void     g_queue_delete_link    (GQueue           *queue,
 119                                  GList            *link_);
 120
 121 G_END_DECLS
 122
 123 #endif /* __G_QUEUE_H__ */