2003-01-27 Anders Carlsson <andersca@codefactory.se>
[platform/upstream/dbus.git] / dbus / dbus-list.h
1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-list.h Generic linked list utility (internal to D-BUS implementation)
3  * 
4  * Copyright (C) 2002  Red Hat, Inc.
5  *
6  * Licensed under the Academic Free License version 1.2
7  * 
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  * 
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21  *
22  */
23
24 #ifndef DBUS_LIST_H
25 #define DBUS_LIST_H
26
27 #include <dbus/dbus-internals.h>
28 #include <dbus/dbus-memory.h>
29 #include <dbus/dbus-types.h>
30
31 DBUS_BEGIN_DECLS;
32
33 typedef struct DBusList DBusList;
34
35 struct DBusList
36 {
37   DBusList *prev; /**< Previous list node. */
38   DBusList *next; /**< Next list node. */
39   void     *data; /**< Data stored at this element. */
40 };
41
42 dbus_bool_t _dbus_list_append         (DBusList **list,
43                                        void      *data);
44 dbus_bool_t _dbus_list_prepend        (DBusList **list,
45                                        void      *data);
46 dbus_bool_t _dbus_list_insert_before  (DBusList **list,
47                                        DBusList  *before_this_link,
48                                        void      *data);
49 dbus_bool_t _dbus_list_insert_after   (DBusList **list,
50                                        DBusList  *after_this_link,
51                                        void      *data);
52 dbus_bool_t _dbus_list_remove         (DBusList **list,
53                                        void      *data);
54 dbus_bool_t _dbus_list_remove_last    (DBusList **list,
55                                        void      *data);
56 void        _dbus_list_remove_link    (DBusList **list,
57                                        DBusList  *link);
58 void        _dbus_list_clear          (DBusList **list);
59 DBusList*   _dbus_list_get_first_link (DBusList **list);
60 DBusList*   _dbus_list_get_last_link  (DBusList **list);
61 void*       _dbus_list_get_last       (DBusList **list);
62 void*       _dbus_list_get_first      (DBusList **list);
63 void*       _dbus_list_pop_first      (DBusList **list);
64 void*       _dbus_list_pop_last       (DBusList **list);
65 dbus_bool_t _dbus_list_copy           (DBusList **list,
66                                        DBusList **dest);
67 int         _dbus_list_get_length     (DBusList **list);
68
69 void _dbus_list_foreach (DBusList            **list,
70                          DBusForeachFunction   function,
71                          void                 *data);
72
73 #define _dbus_list_get_next_link(list, link) ((link)->next == *(list) ? NULL : (link)->next)
74 #define _dbus_list_get_prev_link(list, link) ((link) == *(list) ? NULL : (link)->prev)
75
76 DBUS_END_DECLS;
77
78 #endif /* DBUS_LIST_H */