summaryrefslogtreecommitdiff
path: root/dbus/dbus-list.h
blob: 49217df2d432515538942b167c5f660db1735224 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
/* dbus-list.h Generic linked list utility (internal to D-Bus implementation)
 *
 * Copyright (C) 2002, 2003 Red Hat, Inc.
 *
 * SPDX-License-Identifier: AFL-2.1 OR GPL-2.0-or-later
 *
 * Licensed under the Academic Free License version 2.1
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */

#ifndef DBUS_LIST_H
#define DBUS_LIST_H

#include <dbus/dbus-internals.h>
#include <dbus/dbus-memory.h>
#include <dbus/dbus-types.h>
#include <dbus/dbus-sysdeps.h>

DBUS_BEGIN_DECLS

struct DBusList
{
  DBusList *prev; /**< Previous list node. */
  DBusList *next; /**< Next list node. */
  void     *data; /**< Data stored at this element. */
};
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_list_append             (DBusList **list,
                                           void      *data);
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_list_prepend            (DBusList **list,
                                           void      *data);
dbus_bool_t _dbus_list_insert_before      (DBusList **list,
                                           DBusList  *before_this_link,
                                           void      *data);
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_list_insert_after       (DBusList **list,
                                           DBusList  *after_this_link,
                                           void      *data);
DBUS_PRIVATE_EXPORT
void        _dbus_list_insert_before_link (DBusList **list,
                                           DBusList  *before_this_link,
                                           DBusList  *link);
DBUS_PRIVATE_EXPORT
void        _dbus_list_insert_after_link  (DBusList **list,
                                           DBusList  *after_this_link,
                                           DBusList  *link);
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_list_remove             (DBusList **list,
                                           void      *data);
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_list_remove_last        (DBusList **list,
                                           void      *data);
DBUS_PRIVATE_EXPORT
void        _dbus_list_remove_link        (DBusList **list,
                                           DBusList  *link);
DBUS_PRIVATE_EXPORT
DBusList*   _dbus_list_find_last          (DBusList **list,
                                           void      *data);
DBUS_PRIVATE_EXPORT
void        _dbus_list_clear              (DBusList **list);
DBUS_PRIVATE_EXPORT
void        _dbus_list_clear_full         (DBusList         **list,
                                           DBusFreeFunction   function);
DBUS_PRIVATE_EXPORT
DBusList*   _dbus_list_get_first_link     (DBusList **list);
DBUS_PRIVATE_EXPORT
DBusList*   _dbus_list_get_last_link      (DBusList **list);
DBUS_PRIVATE_EXPORT
void*       _dbus_list_get_last           (DBusList **list);
DBUS_PRIVATE_EXPORT
void*       _dbus_list_get_first          (DBusList **list);
DBUS_PRIVATE_EXPORT
void*       _dbus_list_pop_first          (DBusList **list);
DBUS_PRIVATE_EXPORT
void*       _dbus_list_pop_last           (DBusList **list);
DBUS_PRIVATE_EXPORT
DBusList*   _dbus_list_pop_first_link     (DBusList **list);
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_list_copy               (DBusList **list,
                                           DBusList **dest);
DBUS_PRIVATE_EXPORT
int         _dbus_list_get_length         (DBusList **list);
DBUS_PRIVATE_EXPORT
DBusList*   _dbus_list_alloc_link         (void      *data);
DBUS_PRIVATE_EXPORT
void        _dbus_list_free_link          (DBusList  *link);
DBUS_PRIVATE_EXPORT
void        _dbus_list_unlink             (DBusList **list,
                                           DBusList  *link);
DBUS_PRIVATE_EXPORT
void        _dbus_list_append_link        (DBusList **list,
                                           DBusList  *link);
DBUS_PRIVATE_EXPORT
void        _dbus_list_prepend_link       (DBusList **list,
                                           DBusList  *link);
DBUS_PRIVATE_EXPORT
dbus_bool_t _dbus_list_length_is_one      (DBusList **list);


DBUS_PRIVATE_EXPORT
void _dbus_list_foreach (DBusList            **list,
                         DBusForeachFunction   function,
                         void                 *data);

#define _dbus_list_get_next_link(list, link) ((link)->next == *(list) ? NULL : (link)->next)
#define _dbus_list_get_prev_link(list, link) ((link) == *(list) ? NULL : (link)->prev)

/* if DBUS_ENABLE_STATS */
DBUS_PRIVATE_EXPORT
void        _dbus_list_get_stats          (dbus_uint32_t *in_use_p,
                                           dbus_uint32_t *in_free_list_p,
                                           dbus_uint32_t *allocated_p);

DBUS_END_DECLS

#endif /* DBUS_LIST_H */