Patch from David Benson <daveb@idealab.com> to add user_data support to
[platform/upstream/glib.git] / glib / gslist.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_SLIST_H__
28 #define __G_SLIST_H__
29
30 #include <gmem.h>
31
32 G_BEGIN_DECLS
33
34 typedef struct _GSList          GSList;
35
36 struct _GSList
37 {
38   gpointer data;
39   GSList *next;
40 };
41
42 /* Singly linked lists
43  */
44 void     g_slist_push_allocator (GAllocator       *allocator);
45 void     g_slist_pop_allocator  (void);
46 GSList*  g_slist_alloc          (void);
47 void     g_slist_free           (GSList           *list);
48 void     g_slist_free_1         (GSList           *list);
49 GSList*  g_slist_append         (GSList           *list,
50                                  gpointer          data);
51 GSList*  g_slist_prepend        (GSList           *list,
52                                  gpointer          data);
53 GSList*  g_slist_insert         (GSList           *list,
54                                  gpointer          data,
55                                  gint              position);
56 GSList*  g_slist_insert_sorted  (GSList           *list,
57                                  gpointer          data,
58                                  GCompareFunc      func);
59 GSList*  g_slist_insert_before  (GSList           *slist,
60                                  GSList           *sibling,
61                                  gpointer          data);
62 GSList*  g_slist_concat         (GSList           *list1,
63                                  GSList           *list2);
64 GSList*  g_slist_remove         (GSList           *list,
65                                  gconstpointer     data);
66 GSList*  g_slist_remove_link    (GSList           *list,
67                                  GSList           *link);
68 GSList*  g_slist_delete_link    (GSList           *list,
69                                  GSList           *link);
70 GSList*  g_slist_reverse        (GSList           *list);
71 GSList*  g_slist_copy           (GSList           *list);
72 GSList*  g_slist_nth            (GSList           *list,
73                                  guint             n);
74 GSList*  g_slist_find           (GSList           *list,
75                                  gconstpointer     data);
76 GSList*  g_slist_find_custom    (GSList           *list,
77                                  gconstpointer     data,
78                                  GCompareFunc      func);
79 gint     g_slist_position       (GSList           *list,
80                                  GSList           *llink);
81 gint     g_slist_index          (GSList           *list,
82                                  gconstpointer     data);
83 GSList*  g_slist_last           (GSList           *list);
84 guint    g_slist_length         (GSList           *list);
85 void     g_slist_foreach        (GSList           *list,
86                                  GFunc             func,
87                                  gpointer          user_data);
88 GSList*  g_slist_sort           (GSList           *list,
89                                  GCompareFunc      compare_func);
90 GSList*  g_slist_sort_with_data (GSList           *list,
91                                  GCompareFuncData  compare_func,
92                                  gpointer          user_data);
93 gpointer g_slist_nth_data       (GSList           *list,
94                                  guint             n);
95 #define  g_slist_next(slist)    ((slist) ? (((GSList *)(slist))->next) : NULL)
96
97 G_END_DECLS
98
99 #endif /* __G_SLIST_H__ */
100