D-Bus  1.16.2
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  * SPDX-License-Identifier: AFL-2.1 OR GPL-2.0-or-later
7  *
8  * Licensed under the Academic Free License version 2.1
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23  *
24  */
25 
26 #ifndef DBUS_LIST_H
27 #define DBUS_LIST_H
28 
29 #include <dbus/dbus-internals.h>
30 #include <dbus/dbus-memory.h>
31 #include <dbus/dbus-types.h>
32 #include <dbus/dbus-sysdeps.h>
33 
35 
36 struct DBusList
37 {
40  void *data;
41 };
42 DBUS_PRIVATE_EXPORT
44  void *data);
45 DBUS_PRIVATE_EXPORT
47  void *data);
48 dbus_bool_t _dbus_list_insert_before (DBusList **list,
49  DBusList *before_this_link,
50  void *data);
51 DBUS_PRIVATE_EXPORT
53  DBusList *after_this_link,
54  void *data);
55 DBUS_PRIVATE_EXPORT
57  DBusList *before_this_link,
58  DBusList *link);
59 DBUS_PRIVATE_EXPORT
61  DBusList *after_this_link,
62  DBusList *link);
63 DBUS_PRIVATE_EXPORT
65  void *data);
66 DBUS_PRIVATE_EXPORT
68  void *data);
69 DBUS_PRIVATE_EXPORT
70 void _dbus_list_remove_link (DBusList **list,
71  DBusList *link);
72 DBUS_PRIVATE_EXPORT
74  void *data);
75 DBUS_PRIVATE_EXPORT
76 void _dbus_list_clear (DBusList **list);
77 DBUS_PRIVATE_EXPORT
78 void _dbus_list_clear_full (DBusList **list,
79  DBusFreeFunction function);
80 DBUS_PRIVATE_EXPORT
82 DBUS_PRIVATE_EXPORT
84 DBUS_PRIVATE_EXPORT
85 void* _dbus_list_get_last (DBusList **list);
86 DBUS_PRIVATE_EXPORT
87 void* _dbus_list_get_first (DBusList **list);
88 DBUS_PRIVATE_EXPORT
89 void* _dbus_list_pop_first (DBusList **list);
90 DBUS_PRIVATE_EXPORT
91 void* _dbus_list_pop_last (DBusList **list);
92 DBUS_PRIVATE_EXPORT
94 DBUS_PRIVATE_EXPORT
96  DBusList **dest);
97 DBUS_PRIVATE_EXPORT
98 int _dbus_list_get_length (DBusList **list);
99 DBUS_PRIVATE_EXPORT
100 DBusList* _dbus_list_alloc_link (void *data);
101 DBUS_PRIVATE_EXPORT
102 void _dbus_list_free_link (DBusList *link);
103 DBUS_PRIVATE_EXPORT
104 void _dbus_list_unlink (DBusList **list,
105  DBusList *link);
106 DBUS_PRIVATE_EXPORT
107 void _dbus_list_append_link (DBusList **list,
108  DBusList *link);
109 DBUS_PRIVATE_EXPORT
110 void _dbus_list_prepend_link (DBusList **list,
111  DBusList *link);
112 DBUS_PRIVATE_EXPORT
114 
115 
116 DBUS_PRIVATE_EXPORT
117 void _dbus_list_foreach (DBusList **list,
118  DBusForeachFunction function,
119  void *data);
120 
121 #define _dbus_list_get_next_link(list, link) ((link)->next == *(list) ? NULL : (link)->next)
122 #define _dbus_list_get_prev_link(list, link) ((link) == *(list) ? NULL : (link)->prev)
123 
124 /* if DBUS_ENABLE_STATS */
125 DBUS_PRIVATE_EXPORT
126 void _dbus_list_get_stats (dbus_uint32_t *in_use_p,
127  dbus_uint32_t *in_free_list_p,
128  dbus_uint32_t *allocated_p);
129 
131 
132 #endif /* DBUS_LIST_H */
unsigned int dbus_uint32_t
A 32-bit unsigned integer on all platforms.
DBUS_PRIVATE_EXPORT void * _dbus_list_get_last(DBusList **list)
Gets the last data in the list.
Definition: dbus-list.c:626
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_list_prepend(DBusList **list, void *data)
Prepends a value to the list.
Definition: dbus-list.c:295
void(* DBusFreeFunction)(void *memory)
The type of a function which frees a block of memory.
Definition: dbus-memory.h:65
DBUS_PRIVATE_EXPORT void * _dbus_list_pop_last(DBusList **list)
Removes the last value in the list and returns it.
Definition: dbus-list.c:702
DBusList * next
Next list node.
Definition: dbus-list.h:39
#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:813
DBUS_PRIVATE_EXPORT DBusList * _dbus_list_get_last_link(DBusList **list)
Gets the last link in the list.
Definition: dbus-list.c:610
DBUS_PRIVATE_EXPORT DBusList * _dbus_list_find_last(DBusList **list, void *data)
Finds a value in the list.
Definition: dbus-list.c:475
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:351
DBUS_PRIVATE_EXPORT void _dbus_list_remove_link(DBusList **list, DBusList *link)
Removes a link from the list.
Definition: dbus-list.c:530
DBUS_PRIVATE_EXPORT void _dbus_list_append_link(DBusList **list, DBusList *link)
Appends a link to the list.
Definition: dbus-list.c:318
void * data
Data stored at this element.
Definition: dbus-list.h:40
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:379
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:570
DBUS_PRIVATE_EXPORT DBusList * _dbus_list_alloc_link(void *data)
Allocates a linked list node.
Definition: dbus-list.c:245
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_list_remove(DBusList **list, void *data)
Removes a value from the list.
Definition: dbus-list.c:418
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:658
DBusList * prev
Previous list node.
Definition: dbus-list.h:38
DBUS_PRIVATE_EXPORT void * _dbus_list_get_first(DBusList **list)
Gets the first data in the list.
Definition: dbus-list.c:642
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_list_copy(DBusList **list, DBusList **dest)
Copies a list.
Definition: dbus-list.c:727
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:397
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_list_remove_last(DBusList **list, void *data)
Removes a value from the list.
Definition: dbus-list.c:449
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:37
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_list_append(DBusList **list, void *data)
Appends a value to the list.
Definition: dbus-list.c:273
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:789
DBUS_PRIVATE_EXPORT void * _dbus_list_pop_first(DBusList **list)
Removes the first value in the list and returns it.
Definition: dbus-list.c:679
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:257
A node in a linked list.
Definition: dbus-list.h:36
DBUS_PRIVATE_EXPORT void _dbus_list_unlink(DBusList **list, DBusList *link)
Removes the given link from the list, but doesn't free it.
Definition: dbus-list.c:502
DBUS_PRIVATE_EXPORT int _dbus_list_get_length(DBusList **list)
Gets the length of a list.
Definition: dbus-list.c:760
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:597
DBUS_PRIVATE_EXPORT void _dbus_list_prepend_link(DBusList **list, DBusList *link)
Prepends a link to the list.
Definition: dbus-list.c:336
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:545
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.