D-Bus  1.13.7
dbus-list.h
1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-list.h Generic linked list utility (internal to D-Bus implementation)
3  *
4  * Copyright (C) 2002, 2003 Red Hat, Inc.
5  *
6  * Licensed under the Academic Free License version 2.1
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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 #include <dbus/dbus-sysdeps.h>
31 
33 
34 struct DBusList
35 {
38  void *data;
39 };
40 DBUS_PRIVATE_EXPORT
42  void *data);
43 DBUS_PRIVATE_EXPORT
45  void *data);
46 dbus_bool_t _dbus_list_insert_before (DBusList **list,
47  DBusList *before_this_link,
48  void *data);
49 DBUS_PRIVATE_EXPORT
51  DBusList *after_this_link,
52  void *data);
53 DBUS_PRIVATE_EXPORT
55  DBusList *before_this_link,
56  DBusList *link);
57 DBUS_PRIVATE_EXPORT
59  DBusList *after_this_link,
60  DBusList *link);
61 DBUS_PRIVATE_EXPORT
63  void *data);
64 DBUS_PRIVATE_EXPORT
66  void *data);
67 DBUS_PRIVATE_EXPORT
68 void _dbus_list_remove_link (DBusList **list,
69  DBusList *link);
70 DBUS_PRIVATE_EXPORT
72  void *data);
73 DBUS_PRIVATE_EXPORT
74 void _dbus_list_clear (DBusList **list);
75 DBUS_PRIVATE_EXPORT
76 void _dbus_list_clear_full (DBusList **list,
77  DBusFreeFunction function);
78 DBUS_PRIVATE_EXPORT
80 DBUS_PRIVATE_EXPORT
82 DBUS_PRIVATE_EXPORT
83 void* _dbus_list_get_last (DBusList **list);
84 DBUS_PRIVATE_EXPORT
85 void* _dbus_list_get_first (DBusList **list);
86 DBUS_PRIVATE_EXPORT
87 void* _dbus_list_pop_first (DBusList **list);
88 DBUS_PRIVATE_EXPORT
89 void* _dbus_list_pop_last (DBusList **list);
90 DBUS_PRIVATE_EXPORT
92 DBUS_PRIVATE_EXPORT
94  DBusList **dest);
95 DBUS_PRIVATE_EXPORT
96 int _dbus_list_get_length (DBusList **list);
97 DBUS_PRIVATE_EXPORT
99 DBUS_PRIVATE_EXPORT
100 void _dbus_list_free_link (DBusList *link);
101 DBUS_PRIVATE_EXPORT
102 void _dbus_list_unlink (DBusList **list,
103  DBusList *link);
104 DBUS_PRIVATE_EXPORT
105 void _dbus_list_append_link (DBusList **list,
106  DBusList *link);
107 DBUS_PRIVATE_EXPORT
108 void _dbus_list_prepend_link (DBusList **list,
109  DBusList *link);
110 DBUS_PRIVATE_EXPORT
112 
113 
114 DBUS_PRIVATE_EXPORT
115 void _dbus_list_foreach (DBusList **list,
116  DBusForeachFunction function,
117  void *data);
118 
119 #define _dbus_list_get_next_link(list, link) ((link)->next == *(list) ? NULL : (link)->next)
120 #define _dbus_list_get_prev_link(list, link) ((link) == *(list) ? NULL : (link)->prev)
121 
122 /* if DBUS_ENABLE_STATS */
123 DBUS_PRIVATE_EXPORT
124 void _dbus_list_get_stats (dbus_uint32_t *in_use_p,
125  dbus_uint32_t *in_free_list_p,
126  dbus_uint32_t *allocated_p);
127 
129 
130 #endif /* DBUS_LIST_H */
DBUS_PRIVATE_EXPORT void * _dbus_list_get_last(DBusList **list)
Gets the last data in the list.
Definition: dbus-list.c:624
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_list_prepend(DBusList **list, void *data)
Prepends a value to the list.
Definition: dbus-list.c:293
void(* DBusFreeFunction)(void *memory)
The type of a function which frees a block of memory.
Definition: dbus-memory.h:63
DBUS_PRIVATE_EXPORT void * _dbus_list_pop_last(DBusList **list)
Removes the last value in the list and returns it.
Definition: dbus-list.c:700
DBusList * next
Next list node.
Definition: dbus-list.h:37
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_list_length_is_one(DBusList **list)
Check whether length is exactly one.
Definition: dbus-list.c:811
DBUS_PRIVATE_EXPORT DBusList * _dbus_list_get_last_link(DBusList **list)
Gets the last link in the list.
Definition: dbus-list.c:608
DBUS_PRIVATE_EXPORT DBusList * _dbus_list_find_last(DBusList **list, void *data)
Finds a value in the list.
Definition: dbus-list.c:473
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_list_insert_after(DBusList **list, DBusList *after_this_link, void *data)
Inserts data into the list after the given existing link.
Definition: dbus-list.c:349
DBUS_PRIVATE_EXPORT void _dbus_list_remove_link(DBusList **list, DBusList *link)
Removes a link from the list.
Definition: dbus-list.c:528
DBUS_PRIVATE_EXPORT void _dbus_list_append_link(DBusList **list, DBusList *link)
Appends a link to the list.
Definition: dbus-list.c:316
void * data
Data stored at this element.
Definition: dbus-list.h:38
DBUS_PRIVATE_EXPORT void _dbus_list_insert_before_link(DBusList **list, DBusList *before_this_link, DBusList *link)
Inserts a link into the list before the given existing link.
Definition: dbus-list.c:377
DBUS_PRIVATE_EXPORT void _dbus_list_clear_full(DBusList **list, DBusFreeFunction function)
Free every link and every element in the list.
Definition: dbus-list.c:568
DBUS_PRIVATE_EXPORT DBusList * _dbus_list_alloc_link(void *data)
Allocates a linked list node.
Definition: dbus-list.c:243
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_list_remove(DBusList **list, void *data)
Removes a value from the list.
Definition: dbus-list.c:416
DBUS_PRIVATE_EXPORT DBusList * _dbus_list_pop_first_link(DBusList **list)
Removes the first link in the list and returns it.
Definition: dbus-list.c:656
DBusList * prev
Previous list node.
Definition: dbus-list.h:36
DBUS_PRIVATE_EXPORT void * _dbus_list_get_first(DBusList **list)
Gets the first data in the list.
Definition: dbus-list.c:640
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_list_copy(DBusList **list, DBusList **dest)
Copies a list.
Definition: dbus-list.c:725
DBUS_PRIVATE_EXPORT void _dbus_list_insert_after_link(DBusList **list, DBusList *after_this_link, DBusList *link)
Inserts a link into the list after the given existing link.
Definition: dbus-list.c:395
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_list_remove_last(DBusList **list, void *data)
Removes a value from the list.
Definition: dbus-list.c:447
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_list_append(DBusList **list, void *data)
Appends a value to the list.
Definition: dbus-list.c:271
DBUS_PRIVATE_EXPORT void _dbus_list_foreach(DBusList **list, DBusForeachFunction function, void *data)
Calls the given function for each element in the list.
Definition: dbus-list.c:787
DBUS_PRIVATE_EXPORT void * _dbus_list_pop_first(DBusList **list)
Removes the first value in the list and returns it.
Definition: dbus-list.c:677
DBUS_PRIVATE_EXPORT void _dbus_list_free_link(DBusList *link)
Frees a linked list node allocated with _dbus_list_alloc_link.
Definition: dbus-list.c:255
A node in a linked list.
Definition: dbus-list.h:34
DBUS_PRIVATE_EXPORT void _dbus_list_unlink(DBusList **list, DBusList *link)
Removes the given link from the list, but doesn&#39;t free it.
Definition: dbus-list.c:500
DBUS_PRIVATE_EXPORT int _dbus_list_get_length(DBusList **list)
Gets the length of a list.
Definition: dbus-list.c:758
void(* DBusForeachFunction)(void *element, void *data)
Used to iterate over each item in a collection, such as a DBusList.
DBUS_PRIVATE_EXPORT DBusList * _dbus_list_get_first_link(DBusList **list)
Gets the first link in the list.
Definition: dbus-list.c:595
DBUS_PRIVATE_EXPORT void _dbus_list_prepend_link(DBusList **list, DBusList *link)
Prepends a link to the list.
Definition: dbus-list.c:334
DBUS_PRIVATE_EXPORT void _dbus_list_clear(DBusList **list)
Frees all links in the list and sets the list head to NULL.
Definition: dbus-list.c:543
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.