D-Bus: dbus-list.h Source File

D-Bus 1.8.16

- Main Page
- Related Pages
- Modules
- Data Structures
- Files

- File List

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 };
40 dbus_bool_t _dbus_list_append (DBusList **list,
41 void *data);
42 dbus_bool_t _dbus_list_prepend (DBusList **list,
43 void *data);
44 dbus_bool_t _dbus_list_insert_before (DBusList **list,
45 DBusList *before_this_link,
46 void *data);
47 dbus_bool_t _dbus_list_insert_after (DBusList **list,
48 DBusList *after_this_link,
49 void *data);
50 void _dbus_list_insert_before_link (DBusList **list,
51 DBusList *before_this_link,
52 DBusList *link);
53 void _dbus_list_insert_after_link (DBusList **list,
54 DBusList *after_this_link,
55 DBusList *link);
56 dbus_bool_t _dbus_list_remove (DBusList **list,
57 void *data);
58 dbus_bool_t _dbus_list_remove_last (DBusList **list,
59 void *data);
60 void _dbus_list_remove_link (DBusList **list,
61 DBusList *link);
62 DBusList* _dbus_list_find_last (DBusList **list,
63 void *data);
64 void _dbus_list_clear (DBusList **list);
65 DBusList* _dbus_list_get_first_link (DBusList **list);
66 DBusList* _dbus_list_get_last_link (DBusList **list);
67 void* _dbus_list_get_last (DBusList **list);
68 void* _dbus_list_get_first (DBusList **list);
69 void* _dbus_list_pop_first (DBusList **list);
70 void* _dbus_list_pop_last (DBusList **list);
71 DBusList* _dbus_list_pop_first_link (DBusList **list);
72 dbus_bool_t _dbus_list_copy (DBusList **list,
73 DBusList **dest);
74 int _dbus_list_get_length (DBusList **list);
75 DBusList* _dbus_list_alloc_link (void *data);
76 void _dbus_list_free_link (DBusList *link);
77 void _dbus_list_unlink (DBusList **list,
78 DBusList *link);
79 void _dbus_list_append_link (DBusList **list,
80 DBusList *link);
81 void _dbus_list_prepend_link (DBusList **list,
82 DBusList *link);
83 dbus_bool_t _dbus_list_length_is_one (DBusList **list);
84
85
86 void _dbus_list_foreach (DBusList **list,
87 DBusForeachFunction function,
88 void *data);
89
90 #define _dbus_list_get_next_link(list, link) ((link)->next == *(list) ? NULL : (link)->next)
91 #define _dbus_list_get_prev_link(list, link) ((link) == *(list) ? NULL : (link)->prev)
92
93 /* if DBUS_ENABLE_STATS */
94 void _dbus_list_get_stats (dbus_uint32_t *in_use_p,
95 dbus_uint32_t *in_free_list_p,
96 dbus_uint32_t *allocated_p);
97
98 DBUS_END_DECLS
99
100 #endif /* DBUS_LIST_H */
_dbus_list_get_last
void * _dbus_list_get_last(DBusList **list)
Gets the last data in the list.
Definition: dbus-list.c:596
_dbus_list_prepend
dbus_bool_t _dbus_list_prepend(DBusList **list, void *data)
Prepends a value to the list.
Definition: dbus-list.c:292
_dbus_list_pop_last
void * _dbus_list_pop_last(DBusList **list)
Removes the last value in the list and returns it.
Definition: dbus-list.c:672
DBusList::next
DBusList * next
Next list node.
Definition: dbus-list.h:37
DBUS_BEGIN_DECLS
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
_dbus_list_length_is_one
dbus_bool_t _dbus_list_length_is_one(DBusList **list)
Check whether length is exactly one.
Definition: dbus-list.c:783
_dbus_list_get_last_link
DBusList * _dbus_list_get_last_link(DBusList **list)
Gets the last link in the list.
Definition: dbus-list.c:580
_dbus_list_find_last
DBusList * _dbus_list_find_last(DBusList **list, void *data)
Finds a value in the list.
Definition: dbus-list.c:472
_dbus_list_insert_after
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:348
_dbus_list_remove_link
void _dbus_list_remove_link(DBusList **list, DBusList *link)
Removes a link from the list.
Definition: dbus-list.c:527
_dbus_list_append_link
void _dbus_list_append_link(DBusList **list, DBusList *link)
Appends a link to the list.
Definition: dbus-list.c:315
DBusList::data
void * data
Data stored at this element.
Definition: dbus-list.h:38
_dbus_list_insert_before_link
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:376
_dbus_list_alloc_link
DBusList * _dbus_list_alloc_link(void *data)
Allocates a linked list node.
Definition: dbus-list.c:242
_dbus_list_remove
dbus_bool_t _dbus_list_remove(DBusList **list, void *data)
Removes a value from the list.
Definition: dbus-list.c:415
_dbus_list_pop_first_link
DBusList * _dbus_list_pop_first_link(DBusList **list)
Removes the first link in the list and returns it.
Definition: dbus-list.c:628
DBusList::prev
DBusList * prev
Previous list node.
Definition: dbus-list.h:36
_dbus_list_get_first
void * _dbus_list_get_first(DBusList **list)
Gets the first data in the list.
Definition: dbus-list.c:612
_dbus_list_copy
dbus_bool_t _dbus_list_copy(DBusList **list, DBusList **dest)
Copies a list.
Definition: dbus-list.c:697
_dbus_list_insert_after_link
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:394
_dbus_list_remove_last
dbus_bool_t _dbus_list_remove_last(DBusList **list, void *data)
Removes a value from the list.
Definition: dbus-list.c:446
dbus_bool_t
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
_dbus_list_append
dbus_bool_t _dbus_list_append(DBusList **list, void *data)
Appends a value to the list.
Definition: dbus-list.c:270
_dbus_list_foreach
void _dbus_list_foreach(DBusList **list, DBusForeachFunction function, void *data)
Calls the given function for each element in the list.
Definition: dbus-list.c:759
_dbus_list_pop_first
void * _dbus_list_pop_first(DBusList **list)
Removes the first value in the list and returns it.
Definition: dbus-list.c:649
_dbus_list_free_link
void _dbus_list_free_link(DBusList *link)
Frees a linked list node allocated with _dbus_list_alloc_link.
Definition: dbus-list.c:254
DBusList
A node in a linked list.
Definition: dbus-list.h:34
_dbus_list_unlink
void _dbus_list_unlink(DBusList **list, DBusList *link)
Removes the given link from the list, but doesn't free it.
Definition: dbus-list.c:499
_dbus_list_get_length
int _dbus_list_get_length(DBusList **list)
Gets the length of a list.
Definition: dbus-list.c:730
DBusForeachFunction
void(* DBusForeachFunction)(void *element, void *data)
Used to iterate over each item in a collection, such as a DBusList.
Definition: dbus-internals.h:251
_dbus_list_get_first_link
DBusList * _dbus_list_get_first_link(DBusList **list)
Gets the first link in the list.
Definition: dbus-list.c:567
_dbus_list_prepend_link
void _dbus_list_prepend_link(DBusList **list, DBusList *link)
Prepends a link to the list.
Definition: dbus-list.c:333
_dbus_list_clear
void _dbus_list_clear(DBusList **list)
Frees all links in the list and sets the list head to NULL.
Definition: dbus-list.c:542
DBUS_END_DECLS
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.