D-Bus: dbus-list.h Source File

D-Bus 1.14.6

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
32 DBUS_BEGIN_DECLS
33
34 struct DBusList
35{
36 DBusList *prev;
37 DBusList *next;
38 void *data;
39};
40DBUS_PRIVATE_EXPORT
41 dbus_bool_t _dbus_list_append (DBusList **list,
42 void *data);
43DBUS_PRIVATE_EXPORT
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);
49DBUS_PRIVATE_EXPORT
50 dbus_bool_t _dbus_list_insert_after (DBusList **list,
51 DBusList *after_this_link,
52 void *data);
53DBUS_PRIVATE_EXPORT
54void _dbus_list_insert_before_link (DBusList **list,
55 DBusList *before_this_link,
56 DBusList *link);
57DBUS_PRIVATE_EXPORT
58void _dbus_list_insert_after_link (DBusList **list,
59 DBusList *after_this_link,
60 DBusList *link);
61DBUS_PRIVATE_EXPORT
62 dbus_bool_t _dbus_list_remove (DBusList **list,
63 void *data);
64DBUS_PRIVATE_EXPORT
65 dbus_bool_t _dbus_list_remove_last (DBusList **list,
66 void *data);
67DBUS_PRIVATE_EXPORT
68void _dbus_list_remove_link (DBusList **list,
69 DBusList *link);
70DBUS_PRIVATE_EXPORT
71 DBusList* _dbus_list_find_last (DBusList **list,
72 void *data);
73DBUS_PRIVATE_EXPORT
74void _dbus_list_clear (DBusList **list);
75DBUS_PRIVATE_EXPORT
76void _dbus_list_clear_full (DBusList **list,
77 DBusFreeFunction function);
78DBUS_PRIVATE_EXPORT
79 DBusList* _dbus_list_get_first_link (DBusList **list);
80DBUS_PRIVATE_EXPORT
81 DBusList* _dbus_list_get_last_link (DBusList **list);
82DBUS_PRIVATE_EXPORT
83void* _dbus_list_get_last (DBusList **list);
84DBUS_PRIVATE_EXPORT
85void* _dbus_list_get_first (DBusList **list);
86DBUS_PRIVATE_EXPORT
87void* _dbus_list_pop_first (DBusList **list);
88DBUS_PRIVATE_EXPORT
89void* _dbus_list_pop_last (DBusList **list);
90DBUS_PRIVATE_EXPORT
91 DBusList* _dbus_list_pop_first_link (DBusList **list);
92DBUS_PRIVATE_EXPORT
93 dbus_bool_t _dbus_list_copy (DBusList **list,
94 DBusList **dest);
95DBUS_PRIVATE_EXPORT
96int _dbus_list_get_length (DBusList **list);
97DBUS_PRIVATE_EXPORT
98 DBusList* _dbus_list_alloc_link (void *data);
99DBUS_PRIVATE_EXPORT
100void _dbus_list_free_link (DBusList *link);
101DBUS_PRIVATE_EXPORT
102void _dbus_list_unlink (DBusList **list,
103 DBusList *link);
104DBUS_PRIVATE_EXPORT
105void _dbus_list_append_link (DBusList **list,
106 DBusList *link);
107DBUS_PRIVATE_EXPORT
108void _dbus_list_prepend_link (DBusList **list,
109 DBusList *link);
110DBUS_PRIVATE_EXPORT
111 dbus_bool_t _dbus_list_length_is_one (DBusList **list);
112
113
114DBUS_PRIVATE_EXPORT
115void _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 */
123DBUS_PRIVATE_EXPORT
124void _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
128 DBUS_END_DECLS
129
130#endif /* DBUS_LIST_H */
DBusForeachFunction
void(* DBusForeachFunction)(void *element, void *data)
Used to iterate over each item in a collection, such as a DBusList.
Definition: dbus-internals.h:331
_dbus_list_get_first_link
DBUS_PRIVATE_EXPORT DBusList * _dbus_list_get_first_link(DBusList **list)
Gets the first link in the list.
Definition: dbus-list.c:595
_dbus_list_insert_before_link
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_list_copy
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_list_copy(DBusList **list, DBusList **dest)
Copies a list.
Definition: dbus-list.c:725
_dbus_list_pop_first_link
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
_dbus_list_length_is_one
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_list_get_last
DBUS_PRIVATE_EXPORT void * _dbus_list_get_last(DBusList **list)
Gets the last data in the list.
Definition: dbus-list.c:624
_dbus_list_remove
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_list_append_link
DBUS_PRIVATE_EXPORT void _dbus_list_append_link(DBusList **list, DBusList *link)
Appends a link to the list.
Definition: dbus-list.c:316
_dbus_list_insert_after_link
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_list_clear_full
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_list_insert_after
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_list_remove_link
DBUS_PRIVATE_EXPORT void _dbus_list_remove_link(DBusList **list, DBusList *link)
Removes a link from the list.
Definition: dbus-list.c:528
_dbus_list_get_first
DBUS_PRIVATE_EXPORT void * _dbus_list_get_first(DBusList **list)
Gets the first data in the list.
Definition: dbus-list.c:640
_dbus_list_get_last_link
DBUS_PRIVATE_EXPORT DBusList * _dbus_list_get_last_link(DBusList **list)
Gets the last link in the list.
Definition: dbus-list.c:608
_dbus_list_unlink
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:500
_dbus_list_find_last
DBUS_PRIVATE_EXPORT DBusList * _dbus_list_find_last(DBusList **list, void *data)
Finds a value in the list.
Definition: dbus-list.c:473
_dbus_list_pop_last
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
_dbus_list_free_link
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
_dbus_list_pop_first
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_list_foreach
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_list_get_length
DBUS_PRIVATE_EXPORT int _dbus_list_get_length(DBusList **list)
Gets the length of a list.
Definition: dbus-list.c:758
_dbus_list_clear
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
_dbus_list_prepend_link
DBUS_PRIVATE_EXPORT void _dbus_list_prepend_link(DBusList **list, DBusList *link)
Prepends a link to the list.
Definition: dbus-list.c:334
_dbus_list_prepend
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_list_prepend(DBusList **list, void *data)
Prepends a value to the list.
Definition: dbus-list.c:293
_dbus_list_alloc_link
DBUS_PRIVATE_EXPORT DBusList * _dbus_list_alloc_link(void *data)
Allocates a linked list node.
Definition: dbus-list.c:243
_dbus_list_remove_last
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_list_append
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_BEGIN_DECLS
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
DBUS_END_DECLS
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.
DBusFreeFunction
void(* DBusFreeFunction)(void *memory)
The type of a function which frees a block of memory.
Definition: dbus-memory.h:63
dbus_bool_t
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
dbus_uint32_t
unsigned int dbus_uint32_t
A 32-bit unsigned integer on all platforms.
Definition: dbus-arch-deps.h:43
DBusList
A node in a linked list.
Definition: dbus-list.h:35
DBusList::data
void * data
Data stored at this element.
Definition: dbus-list.h:38
DBusList::next
DBusList * next
Next list node.
Definition: dbus-list.h:37
DBusList::prev
DBusList * prev
Previous list node.
Definition: dbus-list.h:36