summaryrefslogtreecommitdiffstats
path: root/libdimension/dimension/list.h
blob: 9046583e484e0f3f18d38f3af35fc33c409b0c82 (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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
/*************************************************************************
 * Copyright (C) 2010 Tavian Barnes <tavianator@gmail.com>               *
 *                                                                       *
 * This file is part of The Dimension Library.                           *
 *                                                                       *
 * The Dimension Library is free software; you can redistribute it and/  *
 * or modify it under the terms of the GNU Lesser General Public License *
 * as published by the Free Software Foundation; either version 3 of the *
 * License, or (at your option) any later version.                       *
 *                                                                       *
 * The Dimension Library 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  *
 * Lesser General Public License for more details.                       *
 *                                                                       *
 * You should have received a copy of the GNU Lesser General Public      *
 * License along with this program.  If not, see                         *
 * <http://www.gnu.org/licenses/>.                                       *
 *************************************************************************/

/**
 * @file
 * Simple doubly-linked lists.
 */

#ifndef DIMENSION_LIST_H
#define DIMENSION_LIST_H

#include <stdbool.h>
#include <stdlib.h>
#include <string.h>

/**
 * A list iterator.
 */
typedef struct dmnsn_list_iterator {
  void *ptr;                        /**< @internal The stored object */
  size_t obj_size;                  /**< @internal The object size */
  struct dmnsn_list_iterator *prev; /**< @internal The previous iterator */
  struct dmnsn_list_iterator *next; /**< @internal The next iterator */
} dmnsn_list_iterator;

/**
 * @internal
 * Iterator allocation.
 * @param[in] obj       The location of the object to store in the iterator.
 * @param[in] obj_size  The size of the object to store in the iterator.
 */
DMNSN_INLINE dmnsn_list_iterator *
dmnsn_new_list_iterator(const void *obj, size_t obj_size)
{
  dmnsn_list_iterator *i
    = (dmnsn_list_iterator *)dmnsn_malloc(sizeof(dmnsn_list_iterator));
  i->obj_size = obj_size;
  i->prev = NULL;
  i->next = NULL;
  i->ptr  = dmnsn_malloc(obj_size);
  memcpy(i->ptr, obj, obj_size);
  return i;
}

/**
 * @internal
 * Iterator release.
 * @param[in,out] i  The iterator to free.
 */
DMNSN_INLINE void
dmnsn_delete_list_iterator(dmnsn_list_iterator *i)
{
  if (i) {
    dmnsn_free(i->ptr);
    dmnsn_free(i);
  }
}

/** A doubly-linked list. */
typedef struct dmnsn_list {
  dmnsn_list_iterator *first; /**< @internal The first iterator in the list */
  dmnsn_list_iterator *last;  /**< @internal The last iterator in the list */
  size_t length;              /**< @internal The size of the list */
  size_t obj_size;            /**< @internal The size of list objects */
} dmnsn_list;

/**
 * Allocate a list.
 * @param[in] obj_size  The size of the objects to be stored.
 * @return An empty list.
 */
DMNSN_INLINE dmnsn_list *
dmnsn_new_list(size_t obj_size)
{
  dmnsn_list *list = (dmnsn_list *)dmnsn_malloc(sizeof(dmnsn_list));
  list->first    = NULL;
  list->last     = NULL;
  list->obj_size = obj_size;
  list->length   = 0;
  return list;
}

/**
 * Delete a list.
 * @param[in,out] list  The list to delete.
 */
void dmnsn_delete_list(dmnsn_list *list);

/**
 * Construct a list from an array.
 * @param[in] array  The array to copy.
 * @return A list with the same contents as \p array.
 */
dmnsn_list  *dmnsn_list_from_array(const dmnsn_array *array);

/**
 * Construct an array from a list.
 * @param[in] list  The list to copy.
 * @return An array with the same contents as \p list.
 */
dmnsn_array *dmnsn_array_from_list(const dmnsn_list *list);

/**
 * First element.
 * @param[in] list  The list to index.
 * @return An iterator to the first list element, or NULL if the list is empty.
 */
DMNSN_INLINE dmnsn_list_iterator *
dmnsn_list_first(const dmnsn_list *list)
{
  return list->first;
}

/**
 * Last element.
 * @param[in] list  The list to index.
 * @return An iterator to the last list element, or NULL if the list is empty.
 */
DMNSN_INLINE dmnsn_list_iterator *
dmnsn_list_last(const dmnsn_list *list)
{
  return list->last;
}

/**
 * Previous element.
 * @param[in] i  The iterator to follow.
 * @return The iterator preceding \c i.
 */
DMNSN_INLINE dmnsn_list_iterator *
dmnsn_list_prev(const dmnsn_list_iterator *i)
{
  dmnsn_assert(i, "NULL list iterator.");
  return i->prev;
}

/**
 * Next element.
 * @param[in] i  The iterator to follow.
 * @return The iterator following \c i.
 */
DMNSN_INLINE dmnsn_list_iterator *
dmnsn_list_next(const dmnsn_list_iterator *i)
{
  dmnsn_assert(i, "NULL list iterator.");
  return i->next;
}

/**
 * Get the size of the list.
 * @param[in] list  The list in question.
 * @return The number of elements in the list.
 */
DMNSN_INLINE size_t
dmnsn_list_size(const dmnsn_list *list)
{
  return list->length;
}

/**
 * Get the i'th object.
 * @param[in]  i   The iterator to dereference.
 * @param[out] obj The location to store the object.
 */
DMNSN_INLINE void
dmnsn_list_get(const dmnsn_list_iterator *i, void *obj)
{
  dmnsn_assert(i, "NULL list iterator.");
  memcpy(obj, i->ptr, i->obj_size);
}

/**
 * Get a pointer to the i'th object.
 * @param[in] i  The iterator to dereference.
 * @return A pointer to the object stored at \c i.
 */
DMNSN_INLINE void *
dmnsn_list_at(const dmnsn_list_iterator *i)
{
  dmnsn_assert(i, "NULL list iterator.");
  return i->ptr;
}

/**
 * Set the i'th object.
 * @param[in,out] i    The iterator to dereference.
 * @param[in]     obj  The object to store at \c i.
 */
DMNSN_INLINE void
dmnsn_list_set(dmnsn_list_iterator *i, const void *obj)
{
  dmnsn_assert(i, "NULL list iterator.");
  memcpy(i->ptr, obj, i->obj_size);
}

/**
 * Swap the objects in two iterators.
 * @param[in,out] a  The first iterator.
 * @param[in,out] b  The second iterator.
 */
DMNSN_INLINE void
dmnsn_list_swap(dmnsn_list_iterator *a, dmnsn_list_iterator *b)
{
  void *temp = a->ptr;
  a->ptr = b->ptr;
  b->ptr = temp;
}

/**
 * Insert a detached iterator into a list.
 * @param[in,out] list  The list to insert into.
 * @param[in,out] i     The detached iterator to insert.
 * @param[in,out] j     The iterator before which to insert, or NULL for the end
 *                      of the list.
 */
DMNSN_INLINE void
dmnsn_list_iterator_insert(dmnsn_list *list,
                           dmnsn_list_iterator *i, dmnsn_list_iterator *j)
{
  if (list->first == i)
    list->first = j;

  if (i) {
    j->prev = i->prev;
    i->prev = j;
  } else {
    j->prev = list->last;
    list->last = j;
  }

  if (j->prev)
    j->prev->next = j;
  j->next = i;
  ++list->length;
}

/**
 * Insert an object.
 * @param[in,out] list  The list to insert into.
 * @param[in,out] i     The iterator before which to insert, or NULL for the end
 *                      of the list.
 * @param[in]     obj   The location of the object to insert.
 */
DMNSN_INLINE void
dmnsn_list_insert(dmnsn_list *list, dmnsn_list_iterator *i, const void *obj)
{
  dmnsn_list_iterator *j = dmnsn_new_list_iterator(obj, list->obj_size);
  dmnsn_list_iterator_insert(list, i, j);
}

/**
 * Detach an iterator from a list.
 * @param[in,out] list  The list to remove from.
 * @param[in,out] i     The iterator to detach.
 */
DMNSN_INLINE void
dmnsn_list_iterator_remove(dmnsn_list *list, dmnsn_list_iterator *i)
{
  dmnsn_assert(i, "NULL list iterator.");
  dmnsn_assert(list->first, "List is empty.");
  if (list->first == i)
    list->first = i->next;
  if (list->last == i)
    list->last = i->prev;
  if (i->prev)
    i->prev->next = i->next;
  if (i->next)
    i->next->prev = i->prev;
  i->prev = NULL;
  i->next = NULL;
  --list->length;
}

/**
 * Remove the specified item from a list.
 * @param[in,out] list  The list to remove from.
 * @param[in,out] i     The iterator to delete.
 */
DMNSN_INLINE void
dmnsn_list_remove(dmnsn_list *list, dmnsn_list_iterator *i)
{
  dmnsn_list_iterator_remove(list, i);
  dmnsn_delete_list_iterator(i);
}

/**
 * Push an object to the end of the list.
 * @param[in,out] list  The list to append to.
 * @param[in]     obj   The location of the object to push.
 */
DMNSN_INLINE void
dmnsn_list_push(dmnsn_list *list, const void *obj)
{
  dmnsn_list_insert(list, NULL, obj);
}

/**
 * Pop an object from the end of the list.
 * @param[in,out] list  The list to extract from.
 * @param[out]    obj   The location to store the extracted object.
 */
DMNSN_INLINE void
dmnsn_list_pop(dmnsn_list *list, void *obj)
{
  dmnsn_assert(list->last, "List is empty.");
  dmnsn_list_get(list->last, obj);
  dmnsn_list_remove(list, list->last);
}

/**
 * Split a list in half, and return the second half.
 * @param[in,out] list  The list to split.
 * @return A the second half of the list.
 */
dmnsn_list *dmnsn_list_split(dmnsn_list *list);

/** List object comparator function type */
typedef bool dmnsn_list_comparator_fn(dmnsn_list_iterator *l,
                                      dmnsn_list_iterator *r);

/**
 * Sort a list, with O(n*log(n)) comparisons.
 * @param[in,out] list       The list to sort.
 * @param[in]     comparator The comparator to use for comparisons.
 */
void dmnsn_list_sort(dmnsn_list *list, dmnsn_list_comparator_fn *comparator);

#endif /* DIMENSION_LIST_H */