dbutils: comparison ucx/cx/linked

-:80f9d007cb52
+:0aa8cbd7912e
 #endif
 /**
 * The maximum item size that uses SBO swap instead of relinking.
 */
-extern unsigned cx_linked_list_swap_sbo_size;
+extern const unsigned cx_linked_list_swap_sbo_size;
 /**
 * Allocates a linked list for storing elements with \p elem_size bytes each.
 *
 * If \p elem_size is CX_STORE_POINTERS, the created list will be created as if
 * cxListStorePointers() was called immediately after creation and the compare
 * function will be automatically set to cx_cmp_ptr(), if none is given.
 *
 * @param allocator the allocator for allocating the list nodes
-* (if \c NULL the cxDefaultAllocator will be used)
+* (if \c NULL, a default stdlib allocator will be used)
 * @param comparator the comparator for the elements
 * (if \c NULL, and the list is not storing pointers, sort and find
 * functions will not work)
 * @param elem_size the size of each element in bytes
 * @return the created list
 */
+cx_attr_nodiscard
+cx_attr_malloc
+cx_attr_dealloc(cxListFree, 1)
 CxList *cxLinkedListCreate(
-CxAllocator const *allocator,
+const CxAllocator *allocator,
 cx_compare_func comparator,
 size_t elem_size
 );
 /**
 * @param start_index the start index
 * @param loc_advance the location of the pointer to advance
 * @param index the search index
 * @return the node found at the specified index
 */
+cx_attr_nonnull
+cx_attr_nodiscard
 void *cx_linked_list_at(
-void const *start,
+const void *start,
 size_t start_index,
 ptrdiff_t loc_advance,
 size_t index
-) __attribute__((__nonnull__));
+);
 /**
 * Finds the index of an element within a linked list.
 *
 * @param start a pointer to the start node
 * @param loc_data the location of the \c data pointer within your node struct
 * @param cmp_func a compare function to compare \p elem against the node data
 * @param elem a pointer to the element to find
 * @return the index of the element or a negative value if it could not be found
 */
+cx_attr_nonnull
 ssize_t cx_linked_list_find(
-void const *start,
+const void *start,
 ptrdiff_t loc_advance,
 ptrdiff_t loc_data,
 cx_compare_func cmp_func,
-void const *elem
+const void *elem
-) __attribute__((__nonnull__));
+);
 /**
 * Finds the node containing an element within a linked list.
 *
 * @param result a pointer to the memory where the node pointer (or \c NULL if the element
 * @param loc_data the location of the \c data pointer within your node struct
 * @param cmp_func a compare function to compare \p elem against the node data
 * @param elem a pointer to the element to find
 * @return the index of the element or a negative value if it could not be found
 */
+cx_attr_nonnull
 ssize_t cx_linked_list_find_node(
 void **result,
-void const *start,
+const void *start,
 ptrdiff_t loc_advance,
 ptrdiff_t loc_data,
 cx_compare_func cmp_func,
-void const *elem
+const void *elem
-) __attribute__((__nonnull__));
+);
 /**
 * Finds the first node in a linked list.
 *
 * The function starts with the pointer denoted by \p node and traverses the list
 *
 * @param node a pointer to a node in the list
 * @param loc_prev the location of the \c prev pointer
 * @return a pointer to the first node
 */
+cx_attr_nonnull
+cx_attr_returns_nonnull
 void *cx_linked_list_first(
-void const *node,
+const void *node,
 ptrdiff_t loc_prev
-) __attribute__((__nonnull__));
+);
 /**
 * Finds the last node in a linked list.
 *
 * The function starts with the pointer denoted by \p node and traverses the list
 *
 * @param node a pointer to a node in the list
 * @param loc_next the location of the \c next pointer
 * @return a pointer to the last node
 */
+cx_attr_nonnull
+cx_attr_returns_nonnull
 void *cx_linked_list_last(
-void const *node,
+const void *node,
 ptrdiff_t loc_next
-) __attribute__((__nonnull__));
+);
 /**
 * Finds the predecessor of a node in case it is not linked.
 *
 * \remark If \p node is not contained in the list starting with \p begin, the behavior is undefined.
 * @param begin the node where to start the search
 * @param loc_next the location of the \c next pointer
 * @param node the successor of the node to find
 * @return the node or \c NULL if \p node has no predecessor
 */
+cx_attr_nonnull
 void *cx_linked_list_prev(
-void const *begin,
+const void *begin,
 ptrdiff_t loc_next,
-void const *node
+const void *node
-) __attribute__((__nonnull__));
+);
 /**
 * Adds a new node to a linked list.
 * The node must not be part of any list already.
 *
 * @param end a pointer to the end node pointer (if your list has one)
 * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one)
 * @param loc_next the location of a \c next pointer within your node struct (required)
 * @param new_node a pointer to the node that shall be appended
 */
+cx_attr_nonnull_arg(5)
 void cx_linked_list_add(
 void **begin,
 void **end,
 ptrdiff_t loc_prev,
 ptrdiff_t loc_next,
 void *new_node
-) __attribute__((__nonnull__(5)));
+);
 /**
 * Prepends a new node to a linked list.
 * The node must not be part of any list already.
 *
 * @param end a pointer to the end node pointer (if your list has one)
 * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one)
 * @param loc_next the location of a \c next pointer within your node struct (required)
 * @param new_node a pointer to the node that shall be prepended
 */
+cx_attr_nonnull_arg(5)
 void cx_linked_list_prepend(
 void **begin,
 void **end,
 ptrdiff_t loc_prev,
 ptrdiff_t loc_next,
 void *new_node
-) __attribute__((__nonnull__(5)));
+);
 /**
 * Links two nodes.
 *
 * @param left the new predecessor of \p right
 * @param right the new successor of \p left
 * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one)
 * @param loc_next the location of a \c next pointer within your node struct (required)
 */
+cx_attr_nonnull
 void cx_linked_list_link(
 void *left,
 void *right,
 ptrdiff_t loc_prev,
 ptrdiff_t loc_next
-) __attribute__((__nonnull__));
+);
 /**
 * Unlinks two nodes.
 *
 * If right is not the successor of left, the behavior is undefined.
 * @param left the predecessor of \p right
 * @param right the successor of \p left
 * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one)
 * @param loc_next the location of a \c next pointer within your node struct (required)
 */
+cx_attr_nonnull
 void cx_linked_list_unlink(
 void *left,
 void *right,
 ptrdiff_t loc_prev,
 ptrdiff_t loc_next
-) __attribute__((__nonnull__));
+);
 /**
 * Inserts a new node after a given node of a linked list.
 * The new node must not be part of any list already.
 *
 * @param begin a pointer to the begin node pointer (if your list has one)
 * @param end a pointer to the end node pointer (if your list has one)
 * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one)
 * @param loc_next the location of a \c next pointer within your node struct (required)
 * @param node the node after which to insert (\c NULL if you want to prepend the node to the list)
-* @param new_node a pointer to the node that shall be prepended
+* @param new_node a pointer to the node that shall be inserted
 */
+cx_attr_nonnull_arg(6)
 void cx_linked_list_insert(
 void **begin,
 void **end,
 ptrdiff_t loc_prev,
 ptrdiff_t loc_next,
 void *node,
 void *new_node
-) __attribute__((__nonnull__(6)));
+);
 /**
 * Inserts a chain of nodes after a given node of a linked list.
 * The chain must not be part of any list already.
 *
 * @param loc_next the location of a \c next pointer within your node struct (required)
 * @param node the node after which to insert (\c NULL to prepend the chain to the list)
 * @param insert_begin a pointer to the first node of the chain that shall be inserted
 * @param insert_end a pointer to the last node of the chain (or NULL if the last node shall be determined)
 */
+cx_attr_nonnull_arg(6)
 void cx_linked_list_insert_chain(
 void **begin,
 void **end,
 ptrdiff_t loc_prev,
 ptrdiff_t loc_next,
 void *node,
 void *insert_begin,
 void *insert_end
-) __attribute__((__nonnull__(6)));
+);
 /**
-* Removes a node from the linked list.
+* Inserts a node into a sorted linked list.
-*
+* The new node must not be part of any list already.
-* If the node to remove is the begin (resp. end) node of the list and if \p begin (resp. \p end)
+*
+* If the list starting with the node pointed to by \p begin is not sorted
+* already, the behavior is undefined.
+*
+* @param begin a pointer to the begin node pointer (required)
+* @param end a pointer to the end node pointer (if your list has one)
+* @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one)
+* @param loc_next the location of a \c next pointer within your node struct (required)
+* @param new_node a pointer to the node that shall be inserted
+* @param cmp_func a compare function that will receive the node pointers
+*/
+cx_attr_nonnull_arg(1, 5, 6)
+void cx_linked_list_insert_sorted(
+void **begin,
+void **end,
+ptrdiff_t loc_prev,
+ptrdiff_t loc_next,
+void *new_node,
+cx_compare_func cmp_func
+);
+/**
+* Inserts a chain of nodes into a sorted linked list.
+* The chain must not be part of any list already.
+*
+* If either the list starting with the node pointed to by \p begin or the list
+* starting with \p insert_begin is not sorted, the behavior is undefined.
+*
+* \attention In contrast to cx_linked_list_insert_chain(), the source chain
+* will be broken and inserted into the target list so that the resulting list
+* will be sorted according to \p cmp_func. That means, each node in the source
+* chain may be re-linked with nodes from the target list.
+*
+* @param begin a pointer to the begin node pointer (required)
+* @param end a pointer to the end node pointer (if your list has one)
+* @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one)
+* @param loc_next the location of a \c next pointer within your node struct (required)
+* @param insert_begin a pointer to the first node of the chain that shall be inserted
+* @param cmp_func a compare function that will receive the node pointers
+*/
+cx_attr_nonnull_arg(1, 5, 6)
+void cx_linked_list_insert_sorted_chain(
+void **begin,
+void **end,
+ptrdiff_t loc_prev,
+ptrdiff_t loc_next,
+void *insert_begin,
+cx_compare_func cmp_func
+);
+/**
+* Removes a chain of nodes from the linked list.
+*
+* If one of the nodes to remove is the begin (resp. end) node of the list and if \p begin (resp. \p end)
 * addresses are provided, the pointers are adjusted accordingly.
 *
 * The following combinations of arguments are valid (more arguments are optional):
 * \li \p loc_next and \p loc_prev (ancestor node is determined by using the prev pointer, overall O(1) performance)
 * \li \p loc_next and \p begin (ancestor node is determined by list traversal, overall O(n) performance)
 *
 * \remark The \c next and \c prev pointers of the removed node are not cleared by this function and may still be used
-* to traverse to a former adjacent node in the list.
+* to traverse to a former adjacent node in the list, or within the chain.
 *
 * @param begin a pointer to the begin node pointer (optional)
 * @param end a pointer to the end node pointer (optional)
 * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one)
 * @param loc_next the location of a \c next pointer within your node struct (required)
+* @param node the start node of the chain
+* @param num the number of nodes to remove
+* @return the actual number of nodes that were removed (may be less when the list did not have enough nodes)
+*/
+cx_attr_nonnull_arg(5)
+size_t cx_linked_list_remove_chain(
+void **begin,
+void **end,
+ptrdiff_t loc_prev,
+ptrdiff_t loc_next,
+void *node,
+size_t num
+);
+/**
+* Removes a node from the linked list.
+*
+* If the node to remove is the begin (resp. end) node of the list and if \p begin (resp. \p end)
+* addresses are provided, the pointers are adjusted accordingly.
+*
+* The following combinations of arguments are valid (more arguments are optional):
+* \li \p loc_next and \p loc_prev (ancestor node is determined by using the prev pointer, overall O(1) performance)
+* \li \p loc_next and \p begin (ancestor node is determined by list traversal, overall O(n) performance)
+*
+* \remark The \c next and \c prev pointers of the removed node are not cleared by this function and may still be used
+* to traverse to a former adjacent node in the list.
+*
+* @param begin a pointer to the begin node pointer (optional)
+* @param end a pointer to the end node pointer (optional)
+* @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one)
+* @param loc_next the location of a \c next pointer within your node struct (required)
 * @param node the node to remove
 */
-void cx_linked_list_remove(
+cx_attr_nonnull_arg(5)
+static inline void cx_linked_list_remove(
 void **begin,
 void **end,
 ptrdiff_t loc_prev,
 ptrdiff_t loc_next,
 void *node
-) __attribute__((__nonnull__(5)));
+) {
+cx_linked_list_remove_chain(begin, end, loc_prev, loc_next, node, 1);
+}
 /**
 * Determines the size of a linked list starting with \p node.
 * @param node the first node
 * @param loc_next the location of the \c next pointer within the node struct
 * @return the size of the list or zero if \p node is \c NULL
 */
 size_t cx_linked_list_size(
-void const *node,
+const void *node,
 ptrdiff_t loc_next
 );
 /**
 * Sorts a linked list based on a comparison function.
 * @param loc_prev the location of a \c prev pointer within your node struct (negative if not present)
 * @param loc_next the location of a \c next pointer within your node struct (required)
 * @param loc_data the location of the \c data pointer within your node struct
 * @param cmp_func the compare function defining the sort order
 */
+cx_attr_nonnull_arg(1, 6)
 void cx_linked_list_sort(
 void **begin,
 void **end,
 ptrdiff_t loc_prev,
 ptrdiff_t loc_next,
 ptrdiff_t loc_data,
 cx_compare_func cmp_func
-) __attribute__((__nonnull__(1, 6)));
+);
 /**
 * Compares two lists element wise.
 *
 * @param loc_data the location of the \c data pointer within your node struct
 * @param cmp_func the function to compare the elements
 * @return the first non-zero result of invoking \p cmp_func or: negative if the left list is smaller than the
 * right list, positive if the left list is larger than the right list, zero if both lists are equal.
 */
+cx_attr_nonnull_arg(5)
 int cx_linked_list_compare(
-void const *begin_left,
+const void *begin_left,
-void const *begin_right,
+const void *begin_right,
 ptrdiff_t loc_advance,
 ptrdiff_t loc_data,
 cx_compare_func cmp_func
-) __attribute__((__nonnull__(5)));
+);
 /**
 * Reverses the order of the nodes in a linked list.
 *
 * @param begin a pointer to the begin node pointer (required)
 * @param end a pointer to the end node pointer (optional)
 * @param loc_prev the location of a \c prev pointer within your node struct (negative if your struct does not have one)
 * @param loc_next the location of a \c next pointer within your node struct (required)
 */
+cx_attr_nonnull_arg(1)
 void cx_linked_list_reverse(
 void **begin,
 void **end,
 ptrdiff_t loc_prev,
 ptrdiff_t loc_next
-) __attribute__((__nonnull__(1)));
+);
 #ifdef __cplusplus
 } // extern "C"
 #endif

comparison: ucx/cx/linked_list.h

ucx/cx/linked_list.h

Mercurial > hg > dbutils / file comparison

comparison: ucx/cx/linked_list.h

ucx/cx/linked_list.h