epoc32/include/stdapis/glib-2.0/glib/gqueue.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
permissions -rw-r--r--
Final list of Symbian^2 public API header files
     1 /* GLIB - Library of useful routines for C programming
     2  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
     3  * Portions copyright (c) 2006 Nokia Corporation.  All rights reserved.
     4  *
     5  * This library is free software; you can redistribute it and/or
     6  * modify it under the terms of the GNU Lesser General Public
     7  * License as published by the Free Software Foundation; either
     8  * version 2 of the License, or (at your option) any later version.
     9  *
    10  * This library is distributed in the hope that it will be useful,
    11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
    12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU
    13  * Lesser General Public License for more details.
    14  *
    15  * You should have received a copy of the GNU Lesser General Public
    16  * License along with this library; if not, write to the
    17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
    18  * Boston, MA 02111-1307, USA.
    19  */
    20 
    21 /*
    22  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
    23  * file for a list of people on the GLib Team.  See the ChangeLog
    24  * files for a list of changes.  These files are distributed with
    25  * GLib at ftp://ftp.gtk.org/pub/gtk/. 
    26  */
    27 
    28 #ifndef __G_QUEUE_H__
    29 #define __G_QUEUE_H__
    30 
    31 #include <_ansi.h>
    32 #include <glib/glist.h>
    33 
    34 G_BEGIN_DECLS
    35 
    36 typedef struct _GQueue		GQueue;
    37 
    38 struct _GQueue
    39 {
    40   GList *head;
    41   GList *tail;
    42   guint  length;
    43 };
    44 
    45 /* Queues
    46  */
    47 IMPORT_C GQueue*  g_queue_new            (void);
    48 IMPORT_C void     g_queue_free           (GQueue           *queue);
    49 IMPORT_C gboolean g_queue_is_empty       (GQueue           *queue);
    50 IMPORT_C guint    g_queue_get_length     (GQueue           *queue);
    51 IMPORT_C void     g_queue_reverse        (GQueue           *queue);
    52 IMPORT_C GQueue * g_queue_copy           (GQueue           *queue);
    53 IMPORT_C void     g_queue_foreach        (GQueue           *queue,
    54 				 GFunc             func,
    55 				 gpointer          user_data);
    56 IMPORT_C GList *  g_queue_find           (GQueue           *queue,
    57 				 gconstpointer     data);
    58 IMPORT_C GList *  g_queue_find_custom    (GQueue           *queue,
    59 				 gconstpointer     data,
    60 				 GCompareFunc      func);
    61 IMPORT_C void     g_queue_sort           (GQueue           *queue,
    62 				 GCompareDataFunc  compare_func,
    63 				 gpointer          user_data);
    64 
    65 IMPORT_C void     g_queue_push_head      (GQueue           *queue,
    66 				 gpointer          data);
    67 IMPORT_C void     g_queue_push_tail      (GQueue           *queue,
    68 				 gpointer          data);
    69 IMPORT_C void     g_queue_push_nth       (GQueue           *queue,
    70 				 gpointer          data,
    71 				 gint              n);
    72 IMPORT_C gpointer g_queue_pop_head       (GQueue           *queue);
    73 IMPORT_C gpointer g_queue_pop_tail       (GQueue           *queue);
    74 IMPORT_C gpointer g_queue_pop_nth        (GQueue           *queue,
    75 				 guint             n);
    76 IMPORT_C gpointer g_queue_peek_head      (GQueue           *queue);
    77 IMPORT_C gpointer g_queue_peek_tail      (GQueue           *queue);
    78 IMPORT_C gpointer g_queue_peek_nth       (GQueue           *queue,
    79 				 guint             n);
    80 IMPORT_C gint     g_queue_index          (GQueue           *queue,
    81 				 gconstpointer     data);
    82 IMPORT_C void     g_queue_remove         (GQueue           *queue,
    83 				 gconstpointer     data);
    84 IMPORT_C void     g_queue_remove_all     (GQueue           *queue,
    85 				 gconstpointer     data);
    86 IMPORT_C void     g_queue_insert_before  (GQueue           *queue,
    87 				 GList            *sibling,
    88 				 gpointer          data);
    89 IMPORT_C void     g_queue_insert_after   (GQueue           *queue,
    90 				 GList            *sibling,
    91 				 gpointer          data);
    92 IMPORT_C void     g_queue_insert_sorted  (GQueue           *queue,
    93 				 gpointer          data,
    94 				 GCompareDataFunc  func,
    95 				 gpointer          user_data);
    96 
    97 IMPORT_C void     g_queue_push_head_link (GQueue           *queue,
    98 				 GList            *link_);
    99 IMPORT_C void     g_queue_push_tail_link (GQueue           *queue,
   100 				 GList            *link_);
   101 IMPORT_C void     g_queue_push_nth_link  (GQueue           *queue,
   102 				 gint              n,
   103 				 GList            *link_);
   104 IMPORT_C GList*   g_queue_pop_head_link  (GQueue           *queue);
   105 IMPORT_C GList*   g_queue_pop_tail_link  (GQueue           *queue);
   106 IMPORT_C GList*   g_queue_pop_nth_link   (GQueue           *queue,
   107 				 guint             n);
   108 IMPORT_C GList*   g_queue_peek_head_link (GQueue           *queue);
   109 IMPORT_C GList*   g_queue_peek_tail_link (GQueue           *queue);
   110 IMPORT_C GList*   g_queue_peek_nth_link  (GQueue           *queue,
   111 				 guint             n);
   112 IMPORT_C gint     g_queue_link_index     (GQueue           *queue,
   113 				 GList            *link_);
   114 IMPORT_C void     g_queue_unlink         (GQueue           *queue,
   115 				 GList            *link_);
   116 IMPORT_C void     g_queue_delete_link    (GQueue           *queue,
   117 				 GList            *link_);
   118 
   119 G_END_DECLS
   120 
   121 #endif /* __G_QUEUE_H__ */