2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
4 * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
30 * \brief Interface for list implementations.
32 * \author Olaf Wintermann
34 * \copyright 2-Clause BSD License
41 #include "collection.h"
50 typedef struct cx_list_class_s cx_list_class;
53 * Structure for holding the base data of a list.
58 * The list class definition.
60 cx_list_class const *cl;
62 * The actual implementation in case the list class is delegating.
64 cx_list_class const *climpl;
68 * The class definition for arbitrary lists.
70 struct cx_list_class_s {
72 * Destructor function.
74 * Implementations SHALL invoke the content destructor functions if provided
75 * and SHALL deallocate the list memory, if an allocator is provided.
77 void (*destructor)(struct cx_list_s *list);
80 * Member function for inserting a single element.
81 * Implementors SHOULD see to performant implementations for corner cases.
83 int (*insert_element)(
84 struct cx_list_s *list,
90 * Member function for inserting multiple elements.
91 * Implementors SHOULD see to performant implementations for corner cases.
93 size_t (*insert_array)(
94 struct cx_list_s *list,
101 * Member function for inserting an element relative to an iterator position.
104 struct cx_mut_iterator_s *iter,
110 * Member function for removing an element.
113 struct cx_list_s *list,
118 * Member function for removing all elements.
120 void (*clear)(struct cx_list_s *list);
123 * Member function for swapping two elements.
126 struct cx_list_s *list,
132 * Member function for element lookup.
135 struct cx_list_s const *list,
140 * Member function for finding an element.
143 struct cx_list_s const *list,
148 * Member function for sorting the list in-place.
150 void (*sort)(struct cx_list_s *list);
153 * Member function for comparing this list to another list of the same type.
156 struct cx_list_s const *list,
157 struct cx_list_s const *other
161 * Member function for reversing the order of the items.
163 void (*reverse)(struct cx_list_s *list);
166 * Member function for returning an iterator pointing to the specified index.
168 struct cx_iterator_s (*iterator)(
169 struct cx_list_s const *list,
176 * Common type for all list implementations.
178 typedef struct cx_list_s CxList;
181 * Advises the list to store copies of the objects (default mode of operation).
183 * Retrieving objects from this list will yield pointers to the copies stored
186 * @param list the list
187 * @see cxListStorePointers()
189 __attribute__((__nonnull__))
190 void cxListStoreObjects(CxList *list);
193 * Advises the list to only store pointers to the objects.
195 * Retrieving objects from this list will yield the original pointers stored.
197 * @note This function forcibly sets the element size to the size of a pointer.
198 * Invoking this function on a non-empty list that already stores copies of
199 * objects is undefined.
201 * @param list the list
202 * @see cxListStoreObjects()
204 __attribute__((__nonnull__))
205 void cxListStorePointers(CxList *list);
208 * Returns true, if this list is storing pointers instead of the actual data.
211 * @return true, if this list is storing pointers
212 * @see cxListStorePointers()
214 __attribute__((__nonnull__))
215 static inline bool cxListIsStoringPointers(CxList const *list) {
216 return list->store_pointer;
220 * Returns the number of elements currently stored in the list.
222 * @param list the list
223 * @return the number of currently stored elements
225 __attribute__((__nonnull__))
226 static inline size_t cxListSize(CxList const *list) {
231 * Adds an item to the end of the list.
233 * @param list the list
234 * @param elem a pointer to the element to add
235 * @return zero on success, non-zero on memory allocation failure
236 * @see cxListAddArray()
238 __attribute__((__nonnull__))
239 static inline int cxListAdd(
243 return list->cl->insert_element(list, list->size, elem);
247 * Adds multiple items to the end of the list.
249 * This method is more efficient than invoking cxListAdd() multiple times.
251 * If there is not enough memory to add all elements, the returned value is
254 * If this list is storing pointers instead of objects \p array is expected to
255 * be an array of pointers.
257 * @param list the list
258 * @param array a pointer to the elements to add
259 * @param n the number of elements to add
260 * @return the number of added elements
262 __attribute__((__nonnull__))
263 static inline size_t cxListAddArray(
268 return list->cl->insert_array(list, list->size, array, n);
272 * Inserts an item at the specified index.
274 * If \p index equals the list \c size, this is effectively cxListAdd().
276 * @param list the list
277 * @param index the index the element shall have
278 * @param elem a pointer to the element to add
279 * @return zero on success, non-zero on memory allocation failure
280 * or when the index is out of bounds
281 * @see cxListInsertAfter()
282 * @see cxListInsertBefore()
284 __attribute__((__nonnull__))
285 static inline int cxListInsert(
290 return list->cl->insert_element(list, index, elem);
294 * Inserts multiple items to the list at the specified index.
295 * If \p index equals the list size, this is effectively cxListAddArray().
297 * This method is usually more efficient than invoking cxListInsert()
300 * If there is not enough memory to add all elements, the returned value is
303 * If this list is storing pointers instead of objects \p array is expected to
304 * be an array of pointers.
306 * @param list the list
307 * @param index the index where to add the elements
308 * @param array a pointer to the elements to add
309 * @param n the number of elements to add
310 * @return the number of added elements
312 __attribute__((__nonnull__))
313 static inline size_t cxListInsertArray(
319 return list->cl->insert_array(list, index, array, n);
323 * Inserts an element after the current location of the specified iterator.
325 * The used iterator remains operational, but all other active iterators should
326 * be considered invalidated.
328 * If \p iter is not a list iterator, the behavior is undefined.
329 * If \p iter is a past-the-end iterator, the new element gets appended to the list.
331 * @param iter an iterator
332 * @param elem the element to insert
333 * @return zero on success, non-zero on memory allocation failure
334 * @see cxListInsert()
335 * @see cxListInsertBefore()
337 __attribute__((__nonnull__))
338 static inline int cxListInsertAfter(
342 return ((struct cx_list_s *) iter->src_handle)->cl->insert_iter(iter, elem, 0);
346 * Inserts an element before the current location of the specified iterator.
348 * The used iterator remains operational, but all other active iterators should
349 * be considered invalidated.
351 * If \p iter is not a list iterator, the behavior is undefined.
352 * If \p iter is a past-the-end iterator, the new element gets appended to the list.
354 * @param iter an iterator
355 * @param elem the element to insert
356 * @return zero on success, non-zero on memory allocation failure
357 * @see cxListInsert()
358 * @see cxListInsertAfter()
360 __attribute__((__nonnull__))
361 static inline int cxListInsertBefore(
365 return ((struct cx_list_s *) iter->src_handle)->cl->insert_iter(iter, elem, 1);
369 * Removes the element at the specified index.
371 * If an element destructor function is specified, it is called before
372 * removing the element.
374 * @param list the list
375 * @param index the index of the element
376 * @return zero on success, non-zero if the index is out of bounds
378 __attribute__((__nonnull__))
379 static inline int cxListRemove(
383 return list->cl->remove(list, index);
387 * Removes all elements from this list.
389 * If an element destructor function is specified, it is called for each
390 * element before removing them.
392 * @param list the list
394 __attribute__((__nonnull__))
395 static inline void cxListClear(CxList *list) {
396 list->cl->clear(list);
400 * Swaps two items in the list.
402 * Implementations should only allocate temporary memory for the swap, if
405 * @param list the list
406 * @param i the index of the first element
407 * @param j the index of the second element
408 * @return zero on success, non-zero if one of the indices is out of bounds
410 __attribute__((__nonnull__))
411 static inline int cxListSwap(
416 return list->cl->swap(list, i, j);
420 * Returns a pointer to the element at the specified index.
422 * @param list the list
423 * @param index the index of the element
424 * @return a pointer to the element or \c NULL if the index is out of bounds
426 __attribute__((__nonnull__))
427 static inline void *cxListAt(
431 return list->cl->at(list, index);
435 * Returns an iterator pointing to the item at the specified index.
437 * The returned iterator is position-aware.
439 * If the index is out of range, a past-the-end iterator will be returned.
441 * @param list the list
442 * @param index the index where the iterator shall point at
443 * @return a new iterator
445 __attribute__((__nonnull__, __warn_unused_result__))
446 static inline CxIterator cxListIteratorAt(
450 return list->cl->iterator(list, index, false);
454 * Returns a backwards iterator pointing to the item at the specified index.
456 * The returned iterator is position-aware.
458 * If the index is out of range, a past-the-end iterator will be returned.
460 * @param list the list
461 * @param index the index where the iterator shall point at
462 * @return a new iterator
464 __attribute__((__nonnull__, __warn_unused_result__))
465 static inline CxIterator cxListBackwardsIteratorAt(
469 return list->cl->iterator(list, index, true);
473 * Returns a mutating iterator pointing to the item at the specified index.
475 * The returned iterator is position-aware.
477 * If the index is out of range, a past-the-end iterator will be returned.
479 * @param list the list
480 * @param index the index where the iterator shall point at
481 * @return a new iterator
483 __attribute__((__nonnull__, __warn_unused_result__))
484 CxMutIterator cxListMutIteratorAt(
490 * Returns a mutating backwards iterator pointing to the item at the
493 * The returned iterator is position-aware.
495 * If the index is out of range, a past-the-end iterator will be returned.
497 * @param list the list
498 * @param index the index where the iterator shall point at
499 * @return a new iterator
501 __attribute__((__nonnull__, __warn_unused_result__))
502 CxMutIterator cxListMutBackwardsIteratorAt(
508 * Returns an iterator pointing to the first item of the list.
510 * The returned iterator is position-aware.
512 * If the list is empty, a past-the-end iterator will be returned.
514 * @param list the list
515 * @return a new iterator
517 __attribute__((__nonnull__, __warn_unused_result__))
518 static inline CxIterator cxListIterator(CxList const *list) {
519 return list->cl->iterator(list, 0, false);
523 * Returns a mutating iterator pointing to the first item of the list.
525 * The returned iterator is position-aware.
527 * If the list is empty, a past-the-end iterator will be returned.
529 * @param list the list
530 * @return a new iterator
532 __attribute__((__nonnull__, __warn_unused_result__))
533 static inline CxMutIterator cxListMutIterator(CxList *list) {
534 return cxListMutIteratorAt(list, 0);
539 * Returns a backwards iterator pointing to the last item of the list.
541 * The returned iterator is position-aware.
543 * If the list is empty, a past-the-end iterator will be returned.
545 * @param list the list
546 * @return a new iterator
548 __attribute__((__nonnull__, __warn_unused_result__))
549 static inline CxIterator cxListBackwardsIterator(CxList const *list) {
550 return list->cl->iterator(list, list->size - 1, true);
554 * Returns a mutating backwards iterator pointing to the last item of the list.
556 * The returned iterator is position-aware.
558 * If the list is empty, a past-the-end iterator will be returned.
560 * @param list the list
561 * @return a new iterator
563 __attribute__((__nonnull__, __warn_unused_result__))
564 static inline CxMutIterator cxListMutBackwardsIterator(CxList *list) {
565 return cxListMutBackwardsIteratorAt(list, list->size - 1);
569 * Returns the index of the first element that equals \p elem.
571 * Determining equality is performed by the list's comparator function.
573 * @param list the list
574 * @param elem the element to find
575 * @return the index of the element or a negative
576 * value when the element is not found
578 __attribute__((__nonnull__))
579 static inline ssize_t cxListFind(
583 return list->cl->find(list, elem);
587 * Sorts the list in-place.
589 * \remark The underlying sort algorithm is implementation defined.
591 * @param list the list
593 __attribute__((__nonnull__))
594 static inline void cxListSort(CxList *list) {
595 list->cl->sort(list);
599 * Reverses the order of the items.
601 * @param list the list
603 __attribute__((__nonnull__))
604 static inline void cxListReverse(CxList *list) {
605 list->cl->reverse(list);
609 * Compares a list to another list of the same type.
611 * First, the list sizes are compared.
612 * If they match, the lists are compared element-wise.
614 * @param list the list
615 * @param other the list to compare to
616 * @return zero, if both lists are equal element wise,
617 * negative if the first list is smaller, positive if the first list is larger
619 __attribute__((__nonnull__))
626 * Deallocates the memory of the specified list structure.
628 * Also calls content a destructor function, depending on the configuration
629 * in CxList.content_destructor_type.
631 * This function itself is a destructor function for the CxList.
633 * @param list the list which shall be destroyed
635 __attribute__((__nonnull__))
636 void cxListDestroy(CxList *list);
639 * A shared instance of an empty list.
641 * Writing to that list is undefined.
643 extern CxList * const cxEmptyList;