dav: comparison ucx/cx/list.h

-:1f40ca07ae1b
+:839fefbdedc7
 /**
 * \file list.h
 * \brief Interface for list implementations.
 * \author Mike Becker
 * \author Olaf Wintermann
-* \version 3.0
 * \copyright 2-Clause BSD License
 */
 #ifndef UCX_LIST_H
 #define UCX_LIST_H
 /**
 * Structure for holding the base data of a list.
 */
 struct cx_list_s {
-CX_COLLECTION_MEMBERS
+CX_COLLECTION_BASE;
 /**
 * The list class definition.
 */
 cx_list_class const *cl;
 /**
 /**
 * Member function for inserting an element relative to an iterator position.
 */
 int (*insert_iter)(
-struct cx_mut_iterator_s *iter,
+struct cx_iterator_s *iter,
 void const *elem,
 int prepend
 );
 /**
 struct cx_list_s const *list,
 size_t index
 );
 /**
-* Member function for finding an element.
+* Member function for finding and optionally removing an element.
 */
-ssize_t (*find)(
+ssize_t (*find_remove)(
-struct cx_list_s const *list,
+struct cx_list_s *list,
-void const *elem
+void const *elem,
+bool remove
 );
 /**
 * Member function for sorting the list in-place.
 */
 * @return true, if this list is storing pointers
 * @see cxListStorePointers()
 */
 __attribute__((__nonnull__))
 static inline bool cxListIsStoringPointers(CxList const *list) {
-return list->store_pointer;
+return list->collection.store_pointer;
 }
 /**
 * Returns the number of elements currently stored in the list.
 *
 * @param list the list
 * @return the number of currently stored elements
 */
 __attribute__((__nonnull__))
 static inline size_t cxListSize(CxList const *list) {
-return list->size;
+return list->collection.size;
 }
 /**
 * Adds an item to the end of the list.
 *
 __attribute__((__nonnull__))
 static inline int cxListAdd(
 CxList *list,
 void const *elem
 ) {
-return list->cl->insert_element(list, list->size, elem);
+return list->cl->insert_element(list, list->collection.size, elem);
 }
 /**
 * Adds multiple items to the end of the list.
 *
 static inline size_t cxListAddArray(
 CxList *list,
 void const *array,
 size_t n
 ) {
-return list->cl->insert_array(list, list->size, array, n);
+return list->cl->insert_array(list, list->collection.size, array, n);
 }
 /**
 * Inserts an item at the specified index.
 *
 * @see cxListInsert()
 * @see cxListInsertBefore()
 */
 __attribute__((__nonnull__))
 static inline int cxListInsertAfter(
-CxMutIterator *iter,
+CxIterator *iter,
 void const *elem
 ) {
-return ((struct cx_list_s *) iter->src_handle)->cl->insert_iter(iter, elem, 0);
+return ((struct cx_list_s *) iter->src_handle.m)->cl->insert_iter(iter, elem, 0);
 }
 /**
 * Inserts an element before the current location of the specified iterator.
 *
 * @see cxListInsert()
 * @see cxListInsertAfter()
 */
 __attribute__((__nonnull__))
 static inline int cxListInsertBefore(
-CxMutIterator *iter,
+CxIterator *iter,
 void const *elem
 ) {
-return ((struct cx_list_s *) iter->src_handle)->cl->insert_iter(iter, elem, 1);
+return ((struct cx_list_s *) iter->src_handle.m)->cl->insert_iter(iter, elem, 1);
 }
 /**
 * Removes the element at the specified index.
 *
 * @param list the list
 * @param index the index where the iterator shall point at
 * @return a new iterator
 */
 __attribute__((__nonnull__, __warn_unused_result__))
-CxMutIterator cxListMutIteratorAt(
+CxIterator cxListMutIteratorAt(
 CxList *list,
 size_t index
 );
 /**
 * @param list the list
 * @param index the index where the iterator shall point at
 * @return a new iterator
 */
 __attribute__((__nonnull__, __warn_unused_result__))
-CxMutIterator cxListMutBackwardsIteratorAt(
+CxIterator cxListMutBackwardsIteratorAt(
 CxList *list,
 size_t index
 );
 /**
 *
 * @param list the list
 * @return a new iterator
 */
 __attribute__((__nonnull__, __warn_unused_result__))
-static inline CxMutIterator cxListMutIterator(CxList *list) {
+static inline CxIterator cxListMutIterator(CxList *list) {
 return cxListMutIteratorAt(list, 0);
 }
 /**
 * @param list the list
 * @return a new iterator
 */
 __attribute__((__nonnull__, __warn_unused_result__))
 static inline CxIterator cxListBackwardsIterator(CxList const *list) {
-return list->cl->iterator(list, list->size - 1, true);
+return list->cl->iterator(list, list->collection.size - 1, true);
 }
 /**
 * Returns a mutating backwards iterator pointing to the last item of the list.
 *
 *
 * @param list the list
 * @return a new iterator
 */
 __attribute__((__nonnull__, __warn_unused_result__))
-static inline CxMutIterator cxListMutBackwardsIterator(CxList *list) {
+static inline CxIterator cxListMutBackwardsIterator(CxList *list) {
-return cxListMutBackwardsIteratorAt(list, list->size - 1);
+return cxListMutBackwardsIteratorAt(list, list->collection.size - 1);
 }
 /**
 * Returns the index of the first element that equals \p elem.
 *
 __attribute__((__nonnull__))
 static inline ssize_t cxListFind(
 CxList const *list,
 void const *elem
 ) {
-return list->cl->find(list, elem);
+return list->cl->find_remove((CxList*)list, elem, false);
+}
+/**
+* Removes and returns the index of the first element that equals \p elem.
+*
+* Determining equality is performed by the list's comparator function.
+*
+* @param list the list
+* @param elem the element to find and remove
+* @return the index of the now removed element or a negative
+* value when the element is not found or could not be removed
+*/
+__attribute__((__nonnull__))
+static inline ssize_t cxListFindRemove(
+CxList *list,
+void const *elem
+) {
+return list->cl->find_remove(list, elem, true);
 }
 /**
 * Sorts the list in-place.
 *

Mercurial > hg > dav / file comparison

comparison: ucx/cx/list.h

ucx/cx/list.h