Mercurial > hg > ucx / changeset

--- a/docs/Writerside/topics/list.h.md	Sun Mar 02 18:30:38 2025 +0100
+++ b/docs/Writerside/topics/list.h.md	Mon Mar 03 21:41:59 2025 +0100
@@ -4,29 +4,85 @@
 Outdated Section - will be updated soon!
 </warning>
 
-This header defines a common interface for all list implementations.
+The `list.h` header defines a common interface for all list implementations.
+
+UCX already comes with two common list implementations ([linked list](linked_list.h.md) and [array list](array_list.h.md))
+that should cover most use cases.
+But if you feel the need to implement an own list, you will find instructions [below](#implementing-own-list-structures).
+
+## Overview
+
+```C
+size_t cxListSize(const CxList *list);
+
+int cxListAdd(CxList *list, const void *elem);
+
+size_t cxListAddArray(CxList *list, const void *array, size_t n);
+
+int cxListInsert(CxList *list, size_t index, const void *elem);
+
+int cxListInsertSorted(CxList *list, const void *elem);
 
-UCX already comes with two common list implementations (linked list and array list) that should cover most use cases.
-But if you feel the need to implement an own list, the only thing you need to do is to define a struct with a
-`struct cx_list_s` as first member, and set an appropriate list class that implements the functionality.
-It is strongly recommended that this class is shared among all instances of the same list type, because otherwise
-the `cxListCompare` function cannot use the optimized implementation of your class and will instead fall back to
-using iterators to compare the contents element-wise.
+size_t cxListInsertArray(CxList *list, size_t index,
+        const void *array, size_t n);
+
+size_t cxListInsertSortedArray(CxList *list,
+        const void *array, size_t n);
+
+int cxListInsertAfter(CxIterator *iter, const void *elem);
+
+int cxListInsertBefore(CxIterator *iter, const void *elem);
+
+int cxListRemove(CxList *list, size_t index);
+
+int cxListRemoveAndGet(CxList *list, size_t index, void *targetbuf);
+
+size_t cxListRemoveArray(CxList *list, size_t index, size_t num);
+
+size_t cxListRemoveArrayAndGet(CxList *list, size_t index, size_t num,
+        void *targetbuf);
+
+void cxListClear(CxList *list);
 
-<!--
-## Undocumented Symbols (TODO)
-### cx_empty_list
-### cxEmptyList
-### cxListCompare
-### cx_list_default_insert_array
-### cx_list_default_insert_sorted
-### cx_list_default_sort
-### cx_list_default_swap
-### cxListFree
-### cx_list_init
-### cxListMutBackwardsIteratorAt
-### cxListMutIteratorAt
--->
+int cxListSwap(CxList *list, size_t i, size_t j);
+
+void *cxListAt(const CxList *list, size_t index);
+
+CxIterator cxListIteratorAt(const CxList *list, size_t index);
+
+CxIterator cxListBackwardsIteratorAt(const CxList *list, size_t index);
+
+CxIterator cxListMutIteratorAt(CxList *list, size_t index);
+
+CxIterator cxListMutBackwardsIteratorAt(CxList *list, size_t index);
+
+CxIterator cxListIterator(const CxList *list);
+
+CxIterator cxListMutIterator(CxList *list);
+
+CxIterator cxListBackwardsIterator(const CxList *list);
+
+CxIterator cxListMutBackwardsIterator(CxList *list);
+
+size_t cxListFind(const CxList *list, const void *elem);
+
+bool cxListIndexValid(const CxList *list, size_t index);
+
+size_t cxListFindRemove(CxList *list, const void *elem);
+
+void cxListSort(CxList *list);
+
+void cxListReverse(CxList *list);
+
+int cxListCompare(const CxList *list, const CxList *other);
+
+void cxListFree(CxList *list);
+
+extern CxList *const cxEmptyList;
+```
+
+
+## Implementing own List Structures
 
 <seealso>
 <category ref="apidoc">