1 /* Sequential list data type implemented by an array.
2 Copyright (C) 2006 Free Software Foundation, Inc.
3 Written by Bruno Haible <bruno@clisp.org>, 2006.
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2, or (at your option)
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software Foundation,
17 Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
22 #include "gl_array_list.h"
30 /* Checked size_t computations. */
34 # define uintptr_t unsigned long
37 /* -------------------------- gl_list_t Data Type -------------------------- */
39 /* Concrete gl_list_impl type, valid for this file only. */
42 struct gl_list_impl_base base;
43 /* An array of ALLOCATED elements, of which the first COUNT are used.
44 0 <= COUNT <= ALLOCATED. */
45 const void **elements;
50 /* struct gl_list_node_impl doesn't exist here. The pointers are actually
52 #define INDEX_TO_NODE(index) (gl_list_node_t)(uintptr_t)(size_t)((index) + 1)
53 #define NODE_TO_INDEX(node) ((uintptr_t)(node) - 1)
56 gl_array_create_empty (gl_list_implementation_t implementation,
57 gl_listelement_equals_fn equals_fn,
58 gl_listelement_hashcode_fn hashcode_fn,
59 bool allow_duplicates)
61 struct gl_list_impl *list =
62 (struct gl_list_impl *) xmalloc (sizeof (struct gl_list_impl));
64 list->base.vtable = implementation;
65 list->base.equals_fn = equals_fn;
66 list->base.hashcode_fn = hashcode_fn;
67 list->base.allow_duplicates = allow_duplicates;
68 list->elements = NULL;
76 gl_array_create (gl_list_implementation_t implementation,
77 gl_listelement_equals_fn equals_fn,
78 gl_listelement_hashcode_fn hashcode_fn,
79 bool allow_duplicates,
80 size_t count, const void **contents)
82 struct gl_list_impl *list =
83 (struct gl_list_impl *) xmalloc (sizeof (struct gl_list_impl));
85 list->base.vtable = implementation;
86 list->base.equals_fn = equals_fn;
87 list->base.hashcode_fn = hashcode_fn;
88 list->base.allow_duplicates = allow_duplicates;
92 (const void **) xmalloc (count * sizeof (const void *));
93 memcpy (list->elements, contents, count * sizeof (const void *));
96 list->elements = NULL;
98 list->allocated = count;
104 gl_array_size (gl_list_t list)
110 gl_array_node_value (gl_list_t list, gl_list_node_t node)
112 uintptr_t index = NODE_TO_INDEX (node);
113 if (!(index < list->count))
114 /* Invalid argument. */
116 return list->elements[index];
119 static gl_list_node_t
120 gl_array_next_node (gl_list_t list, gl_list_node_t node)
122 uintptr_t index = NODE_TO_INDEX (node);
123 if (!(index < list->count))
124 /* Invalid argument. */
127 if (index < list->count)
128 return INDEX_TO_NODE (index);
133 static gl_list_node_t
134 gl_array_previous_node (gl_list_t list, gl_list_node_t node)
136 uintptr_t index = NODE_TO_INDEX (node);
137 if (!(index < list->count))
138 /* Invalid argument. */
141 return INDEX_TO_NODE (index - 1);
147 gl_array_get_at (gl_list_t list, size_t position)
149 size_t count = list->count;
151 if (!(position < count))
152 /* Invalid argument. */
154 return list->elements[position];
157 static gl_list_node_t
158 gl_array_set_at (gl_list_t list, size_t position, const void *elt)
160 size_t count = list->count;
162 if (!(position < count))
163 /* Invalid argument. */
165 list->elements[position] = elt;
166 return INDEX_TO_NODE (position);
170 gl_array_indexof (gl_list_t list, const void *elt)
172 size_t count = list->count;
175 gl_listelement_equals_fn equals = list->base.equals_fn;
182 if (equals (elt, list->elements[i]))
195 if (elt == list->elements[i])
206 static gl_list_node_t
207 gl_array_search (gl_list_t list, const void *elt)
209 size_t index = gl_array_indexof (list, elt);
210 return INDEX_TO_NODE (index);
213 /* Ensure that list->allocated > list->count. */
215 grow (gl_list_t list)
217 size_t new_allocated;
221 new_allocated = xtimes (list->allocated, 2);
222 new_allocated = xsum (new_allocated, 1);
223 memory_size = xtimes (new_allocated, sizeof (const void *));
224 if (size_overflow_p (memory_size))
225 /* Overflow, would lead to out of memory. */
227 memory = (const void **) xrealloc (list->elements, memory_size);
231 list->elements = memory;
232 list->allocated = new_allocated;
235 static gl_list_node_t
236 gl_array_add_first (gl_list_t list, const void *elt)
238 size_t count = list->count;
239 const void **elements;
242 if (count == list->allocated)
244 elements = list->elements;
245 for (i = count; i > 0; i--)
246 elements[i] = elements[i - 1];
248 list->count = count + 1;
249 return INDEX_TO_NODE (0);
252 static gl_list_node_t
253 gl_array_add_last (gl_list_t list, const void *elt)
255 size_t count = list->count;
257 if (count == list->allocated)
259 list->elements[count] = elt;
260 list->count = count + 1;
261 return INDEX_TO_NODE (count);
264 static gl_list_node_t
265 gl_array_add_before (gl_list_t list, gl_list_node_t node, const void *elt)
267 size_t count = list->count;
268 uintptr_t index = NODE_TO_INDEX (node);
270 const void **elements;
273 if (!(index < count))
274 /* Invalid argument. */
277 if (count == list->allocated)
279 elements = list->elements;
280 for (i = count; i > position; i--)
281 elements[i] = elements[i - 1];
282 elements[position] = elt;
283 list->count = count + 1;
284 return INDEX_TO_NODE (position);
287 static gl_list_node_t
288 gl_array_add_after (gl_list_t list, gl_list_node_t node, const void *elt)
290 size_t count = list->count;
291 uintptr_t index = NODE_TO_INDEX (node);
293 const void **elements;
296 if (!(index < count))
297 /* Invalid argument. */
299 position = index + 1;
300 if (count == list->allocated)
302 elements = list->elements;
303 for (i = count; i > position; i--)
304 elements[i] = elements[i - 1];
305 elements[position] = elt;
306 list->count = count + 1;
307 return INDEX_TO_NODE (position);
310 static gl_list_node_t
311 gl_array_add_at (gl_list_t list, size_t position, const void *elt)
313 size_t count = list->count;
314 const void **elements;
317 if (!(position <= count))
318 /* Invalid argument. */
320 if (count == list->allocated)
322 elements = list->elements;
323 for (i = count; i > position; i--)
324 elements[i] = elements[i - 1];
325 elements[position] = elt;
326 list->count = count + 1;
327 return INDEX_TO_NODE (position);
331 gl_array_remove_node (gl_list_t list, gl_list_node_t node)
333 size_t count = list->count;
334 uintptr_t index = NODE_TO_INDEX (node);
336 const void **elements;
339 if (!(index < count))
340 /* Invalid argument. */
343 elements = list->elements;
344 for (i = position + 1; i < count; i++)
345 elements[i - 1] = elements[i];
346 list->count = count - 1;
351 gl_array_remove_at (gl_list_t list, size_t position)
353 size_t count = list->count;
354 const void **elements;
357 if (!(position < count))
358 /* Invalid argument. */
360 elements = list->elements;
361 for (i = position + 1; i < count; i++)
362 elements[i - 1] = elements[i];
363 list->count = count - 1;
368 gl_array_remove (gl_list_t list, const void *elt)
370 size_t position = gl_array_indexof (list, elt);
371 if (position == (size_t)(-1))
374 return gl_array_remove_at (list, position);
378 gl_array_list_free (gl_list_t list)
380 if (list->elements != NULL)
381 free (list->elements);
385 /* --------------------- gl_list_iterator_t Data Type --------------------- */
387 static gl_list_iterator_t
388 gl_array_iterator (gl_list_t list)
390 gl_list_iterator_t result;
392 result.vtable = list->base.vtable;
394 result.count = list->count;
395 result.p = list->elements + 0;
396 result.q = list->elements + list->count;
405 static gl_list_iterator_t
406 gl_array_iterator_from_to (gl_list_t list, size_t start_index, size_t end_index)
408 gl_list_iterator_t result;
410 if (!(start_index <= end_index && end_index <= list->count))
411 /* Invalid arguments. */
413 result.vtable = list->base.vtable;
415 result.count = list->count;
416 result.p = list->elements + start_index;
417 result.q = list->elements + end_index;
427 gl_array_iterator_next (gl_list_iterator_t *iterator,
428 const void **eltp, gl_list_node_t *nodep)
430 gl_list_t list = iterator->list;
431 if (iterator->count != list->count)
433 if (iterator->count != list->count + 1)
434 /* Concurrent modifications were done on the list. */
436 /* The last returned element was removed. */
441 if (iterator->p < iterator->q)
443 const void **p = (const void **) iterator->p;
446 *nodep = INDEX_TO_NODE (p - list->elements);
455 gl_array_iterator_free (gl_list_iterator_t *iterator)
459 /* ---------------------- Sorted gl_list_t Data Type ---------------------- */
462 gl_array_sortedlist_indexof (gl_list_t list, gl_listelement_compar_fn compar,
465 size_t count = list->count;
472 /* At each loop iteration, low < high; for indices < low the values
473 are smaller than ELT; for indices >= high the values are greater
474 than ELT. So, if the element occurs in the list, it is at
475 low <= position < high. */
478 size_t mid = low + (high - low) / 2; /* low <= mid < high */
479 int cmp = compar (list->elements[mid], elt);
487 /* We have an element equal to ELT at index MID. But we need
488 the minimal such index. */
490 /* At each loop iteration, low <= high and
491 compar (list->elements[high], elt) == 0,
492 and we know that the first occurrence of the element is at
493 low <= position <= high. */
496 size_t mid2 = low + (high - low) / 2; /* low <= mid2 < high */
497 int cmp2 = compar (list->elements[mid2], elt);
502 /* The list was not sorted. */
515 /* Here low == high. */
520 static gl_list_node_t
521 gl_array_sortedlist_search (gl_list_t list, gl_listelement_compar_fn compar,
524 size_t index = gl_array_sortedlist_indexof (list, compar, elt);
525 return INDEX_TO_NODE (index);
528 static gl_list_node_t
529 gl_array_sortedlist_add (gl_list_t list, gl_listelement_compar_fn compar,
532 size_t count = list->count;
536 /* At each loop iteration, low <= high; for indices < low the values are
537 smaller than ELT; for indices >= high the values are greater than ELT. */
540 size_t mid = low + (high - low) / 2; /* low <= mid < high */
541 int cmp = compar (list->elements[mid], elt);
553 return gl_array_add_at (list, low, elt);
557 gl_array_sortedlist_remove (gl_list_t list, gl_listelement_compar_fn compar,
560 size_t index = gl_array_sortedlist_indexof (list, compar, elt);
561 if (index == (size_t)(-1))
564 return gl_array_remove_at (list, index);
568 const struct gl_list_implementation gl_array_list_implementation =
570 gl_array_create_empty,
575 gl_array_previous_node,
585 gl_array_remove_node,
590 gl_array_iterator_from_to,
591 gl_array_iterator_next,
592 gl_array_iterator_free,
593 gl_array_sortedlist_search,
594 gl_array_sortedlist_indexof,
595 gl_array_sortedlist_add,
596 gl_array_sortedlist_remove