toolkit: comparison ucx/cx/linked

-:6691e007cef7
+:473d8cb58a6c
 #ifndef UCX_LINKED_LIST_H
 #define UCX_LINKED_LIST_H
 #include "common.h"
 #include "list.h"
-#ifdef __cplusplus
-extern "C" {
-#endif
 /**
 * Metadata for a linked list.
 */
 typedef struct cx_linked_list_s {
 * @param allocator the allocator for allocating the list nodes
 * (if @c NULL, the cxDefaultAllocator will be used)
 * @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)
+CX_EXTERN CX_NODISCARD CX_MALLOC CX_DEALLOC(cxListFree, 1)
-CX_EXPORT CxList *cxLinkedListCreate(const CxAllocator *allocator,
+CxList *cxLinkedListCreate(const CxAllocator *allocator,
 size_t elem_size);
 /**
 * Instructs the linked list to reserve extra data in each node.
 *
 * needs to store extra data in each node.
 *
 * @param list the list (must be a linked list)
 * @param len the length of the extra data
 */
-cx_attr_nonnull
+CX_EXTERN CX_NONNULL
-CX_EXPORT void cx_linked_list_extra_data(cx_linked_list *list, size_t len);
+void cx_linked_list_extra_data(cx_linked_list *list, size_t len);
 /**
 * Finds the node at a certain index.
 *
 * This function can be used to start at an arbitrary position within the list.
 * @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
+CX_EXTERN CX_NONNULL CX_NODISCARD
-CX_EXPORT void *cx_linked_list_at(const void *start,size_t start_index,
+void *cx_linked_list_at(const void *start,size_t start_index,
 ptrdiff_t loc_advance, size_t index);
 /**
 * Finds the node containing an element within a linked list.
 *
 * @param found_index an optional pointer where the index of the found node
 * (given that @p start has index 0) is stored
 * @param cmp_func a compare function to compare @p elem against the node data
 * @return a pointer to the found node or @c NULL if no matching node was found
 */
-cx_attr_nonnull_arg(1, 4, 6)
+CX_EXTERN CX_NONNULL_ARG(1, 4, 6)
-CX_EXPORT void *cx_linked_list_find(const void *start, ptrdiff_t loc_advance,
+void *cx_linked_list_find(const void *start, ptrdiff_t loc_advance,
 ptrdiff_t loc_data, const void *elem, size_t *found_index,
 cx_compare_func cmp_func);
 /**
 * Finds the node containing an element within a linked list.
 * (given that @p start has index 0) is stored
 * @param cmp_func a compare function to compare @p elem against the node data
 * @param context additional context for the compare function
 * @return a pointer to the found node or @c NULL if no matching node was found
 */
-cx_attr_nonnull_arg(1, 4, 6)
+CX_EXTERN CX_NONNULL_ARG(1, 4, 6)
-CX_EXPORT void *cx_linked_list_find_c(const void *start, ptrdiff_t loc_advance,
+void *cx_linked_list_find_c(const void *start, ptrdiff_t loc_advance,
 ptrdiff_t loc_data, const void *elem, size_t *found_index,
 cx_compare_func2 cmp_func, void *context);
 /**
 * Finds the first node in a linked 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
+CX_EXTERN CX_NONNULL CX_RETURNS_NONNULL
-CX_EXPORT void *cx_linked_list_first(const void *node, ptrdiff_t loc_prev);
+void *cx_linked_list_first(const void *node, ptrdiff_t loc_prev);
 /**
 * 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
+CX_EXTERN CX_NONNULL CX_RETURNS_NONNULL
-CX_EXPORT void *cx_linked_list_last(const void *node, ptrdiff_t loc_next);
+void *cx_linked_list_last(const void *node, ptrdiff_t loc_next);
 /**
 * 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
+CX_EXTERN CX_NONNULL
-CX_EXPORT void *cx_linked_list_prev(const void *begin, ptrdiff_t loc_next, const void *node);
+void *cx_linked_list_prev(const void *begin, ptrdiff_t loc_next, const void *node);
 /**
 * Adds a new node to a linked list.
 * The node must not be part of any list yet.
 *
 * @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)
+CX_EXTERN CX_NONNULL_ARG(5)
-CX_EXPORT void cx_linked_list_add(void **begin, void **end, ptrdiff_t loc_prev, ptrdiff_t loc_next, void *new_node);
+void cx_linked_list_add(void **begin, void **end, ptrdiff_t loc_prev, ptrdiff_t loc_next, void *new_node);
 /**
 * Prepends a new node to a linked list.
 * The node must not be part of any list yet.
 *
 * @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)
+CX_EXTERN CX_NONNULL_ARG(5)
-CX_EXPORT void cx_linked_list_prepend(void **begin, void **end, ptrdiff_t loc_prev, ptrdiff_t loc_next, void *new_node);
+void cx_linked_list_prepend(void **begin, void **end, ptrdiff_t loc_prev, ptrdiff_t loc_next, void *new_node);
 /**
 * 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
+CX_EXTERN CX_NONNULL
-CX_EXPORT void cx_linked_list_link(void *left, void *right, ptrdiff_t loc_prev, ptrdiff_t loc_next);
+void cx_linked_list_link(void *left, void *right, ptrdiff_t loc_prev, ptrdiff_t loc_next);
 /**
 * 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
+CX_EXTERN CX_NONNULL
-CX_EXPORT void cx_linked_list_unlink(void *left, void *right, ptrdiff_t loc_prev, ptrdiff_t loc_next);
+void cx_linked_list_unlink(void *left, void *right, ptrdiff_t loc_prev, ptrdiff_t loc_next);
 /**
 * Inserts a new node after a given node of a linked list.
 * The new node must not be part of any list yet.
 *
 * @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 inserted
 */
-cx_attr_nonnull_arg(6)
+CX_EXTERN CX_NONNULL_ARG(6)
-CX_EXPORT void cx_linked_list_insert(void **begin, void **end,
+void cx_linked_list_insert(void **begin, void **end,
 ptrdiff_t loc_prev, ptrdiff_t loc_next, void *node, void *new_node);
 /**
 * Inserts a chain of nodes after a given node of a linked list.
 * The chain must not be part of any list yet.
 * @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)
+CX_EXTERN CX_NONNULL_ARG(6)
-CX_EXPORT void cx_linked_list_insert_chain(void **begin, void **end,
+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);
 /**
 * Inserts a node into a sorted linked list.
 * The new node must not be part of any list yet.
 * @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)
+CX_EXTERN CX_NONNULL_ARG(1, 5, 6)
-CX_EXPORT void cx_linked_list_insert_sorted(void **begin, void **end,
+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 yet.
 * @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)
+CX_EXTERN CX_NONNULL_ARG(1, 5, 6)
-CX_EXPORT void cx_linked_list_insert_sorted_chain(void **begin, void **end,
+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);
 /**
 * Inserts a node into a sorted linked list if no other node with the same value already exists.
 * The new node must not be part of any list yet.
 * @param new_node a pointer to the node that shall be inserted
 * @param cmp_func a compare function that will receive the node pointers
 * @retval zero when the node was inserted
 * @retval non-zero when a node with the same value already exists
 */
-cx_attr_nonnull_arg(1, 5, 6)
+CX_EXTERN CX_NONNULL_ARG(1, 5, 6)
-CX_EXPORT int cx_linked_list_insert_unique(void **begin, void **end,
+int cx_linked_list_insert_unique(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, avoiding duplicates.
 * The chain must not be part of any list yet.
 * @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
 * @return a pointer to a new chain with all duplicates that were not inserted (or @c NULL when there were no duplicates)
 */
-cx_attr_nonnull_arg(1, 5, 6) cx_attr_nodiscard
+CX_EXTERN CX_NONNULL_ARG(1, 5, 6) CX_NODISCARD
-CX_EXPORT void *cx_linked_list_insert_unique_chain(void **begin, void **end,
+void *cx_linked_list_insert_unique_chain(void **begin, void **end,
 ptrdiff_t loc_prev, ptrdiff_t loc_next, void *insert_begin, cx_compare_func cmp_func);
+/**
+* Inserts a node into a sorted linked list.
+* The new node must not be part of any list yet.
+*
+* 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 beginning 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
+* @param context context for the compare function
+*/
+CX_EXTERN CX_NONNULL_ARG(1, 5, 6)
+void cx_linked_list_insert_sorted_c(void **begin, void **end,
+ptrdiff_t loc_prev, ptrdiff_t loc_next, void *new_node, cx_compare_func2 cmp_func, void *context);
+/**
+* Inserts a chain of nodes into a sorted linked list.
+* The chain must not be part of any list yet.
+*
+* 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 beginning 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
+* @param context context for the compare function
+*/
+CX_EXTERN CX_NONNULL_ARG(1, 5, 6)
+void cx_linked_list_insert_sorted_chain_c(void **begin, void **end,
+ptrdiff_t loc_prev, ptrdiff_t loc_next, void *insert_begin, cx_compare_func2 cmp_func, void *context);
+/**
+* Inserts a node into a sorted linked list if no other node with the same value already exists.
+* The new node must not be part of any list yet.
+*
+* 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 beginning 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
+* @param context the context for the compare function
+* @retval zero when the node was inserted
+* @retval non-zero when a node with the same value already exists
+*/
+CX_EXTERN CX_NONNULL_ARG(1, 5, 6)
+int cx_linked_list_insert_unique_c(void **begin, void **end,
+ptrdiff_t loc_prev, ptrdiff_t loc_next, void *new_node, cx_compare_func2 cmp_func, void *context);
+/**
+* Inserts a chain of nodes into a sorted linked list, avoiding duplicates.
+* The chain must not be part of any list yet.
+*
+* 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_sorted(), not all nodes of the
+* chain might be added. This function returns a new chain consisting of all the duplicates.
+*
+* @param begin a pointer to the beginning 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
+* @param context context for the compare function
+* @return a pointer to a new chain with all duplicates that were not inserted (or @c NULL when there were no duplicates)
+*/
+CX_EXTERN CX_NONNULL_ARG(1, 5, 6) CX_NODISCARD
+void *cx_linked_list_insert_unique_chain_c(void **begin, void **end,
+ptrdiff_t loc_prev, ptrdiff_t loc_next, void *insert_begin, cx_compare_func2 cmp_func, void *context);
 /**
 * Removes a chain of nodes from the linked list.
 *
 * If one of the nodes to remove is the beginning (resp. end) node of the list, and if @p begin (resp. @p end)
 * @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 (can be less when the list did not have enough nodes)
 */
-cx_attr_nonnull_arg(5)
+CX_EXTERN CX_NONNULL_ARG(5)
-CX_EXPORT size_t cx_linked_list_remove_chain(void **begin, void **end,
+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.
 *
 * @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
 */
-cx_attr_nonnull_arg(5)
+CX_EXTERN CX_NONNULL_ARG(5)
-CX_EXPORT void cx_linked_list_remove(void **begin, void **end,
+void cx_linked_list_remove(void **begin, void **end,
 ptrdiff_t loc_prev, ptrdiff_t loc_next, void *node);
 /**
 * 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
 */
-cx_attr_nodiscard
+CX_EXTERN CX_NODISCARD
-CX_EXPORT size_t cx_linked_list_size(const void *node, ptrdiff_t loc_next);
+size_t cx_linked_list_size(const void *node, ptrdiff_t loc_next);
 /**
 * Sorts a linked list based on a comparison function.
 *
 * @note This is a recursive function with at most logarithmic recursion depth.
 * @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)
+CX_EXTERN CX_NONNULL_ARG(1, 6)
-CX_EXPORT void cx_linked_list_sort(void **begin, void **end,
+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);
 /**
 * Sorts a linked list based on a comparison function.
 *
 * @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
 * @param context additional context for the compare function
 */
-cx_attr_nonnull_arg(1, 6)
+CX_EXTERN CX_NONNULL_ARG(1, 6)
-CX_EXPORT void cx_linked_list_sort_c(void **begin, void **end,
+void cx_linked_list_sort_c(void **begin, void **end,
 ptrdiff_t loc_prev, ptrdiff_t loc_next, ptrdiff_t loc_data, cx_compare_func2 cmp_func, void *context);
 /**
 * Compares two lists element wise.
 *
 * @attention Both lists must have the same structure.
 * @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)
+CX_EXTERN CX_NONNULL_ARG(5)
-CX_EXPORT int cx_linked_list_compare(const void *begin_left, const void *begin_right,
+int cx_linked_list_compare(const void *begin_left, const void *begin_right,
 ptrdiff_t loc_advance, ptrdiff_t loc_data, cx_compare_func cmp_func);
 /**
 * Compares two lists element wise.
 *
 * @param begin_left the beginning of the left list (@c NULL denotes an empty list)
 * @param begin_right the beginning of the right list  (@c NULL denotes an empty list)
 * @param loc_advance the location of the pointer to advance
 * @param loc_data the location of the @c data pointer within your node struct
 * @param cmp_func the function to compare the elements
+* @param context the context for the compare function
 * @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)
+CX_EXTERN CX_NONNULL_ARG(5)
-CX_EXPORT int cx_linked_list_compare_c(const void *begin_left, const void *begin_right,
+int cx_linked_list_compare_c(const void *begin_left, const void *begin_right,
 ptrdiff_t loc_advance, ptrdiff_t loc_data, cx_compare_func2 cmp_func, void *context);
 /**
 * Reverses the order of the nodes in a linked list.
 *
 * @param begin a pointer to the beginning 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)
+CX_EXTERN CX_NONNULL_ARG(1)
-CX_EXPORT void cx_linked_list_reverse(void **begin, void **end, ptrdiff_t loc_prev, ptrdiff_t loc_next);
+void cx_linked_list_reverse(void **begin, void **end, ptrdiff_t loc_prev, ptrdiff_t loc_next);
-#ifdef __cplusplus
-} // extern "C"
-#endif
 #endif // UCX_LINKED_LIST_H

comparison: ucx/cx/linked_list.h

ucx/cx/linked_list.h

Mercurial > hg > toolkit / file comparison

comparison: ucx/cx/linked_list.h

ucx/cx/linked_list.h