Tue, 23 Aug 2016 12:41:04 +0200
fixes UCX_FOREACH documentation
universe@103 | 1 | /* |
universe@103 | 2 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. |
universe@103 | 3 | * |
universe@192 | 4 | * Copyright 2015 Olaf Wintermann. All rights reserved. |
universe@103 | 5 | * |
universe@103 | 6 | * Redistribution and use in source and binary forms, with or without |
universe@103 | 7 | * modification, are permitted provided that the following conditions are met: |
universe@103 | 8 | * |
universe@103 | 9 | * 1. Redistributions of source code must retain the above copyright |
universe@103 | 10 | * notice, this list of conditions and the following disclaimer. |
universe@103 | 11 | * |
universe@103 | 12 | * 2. Redistributions in binary form must reproduce the above copyright |
universe@103 | 13 | * notice, this list of conditions and the following disclaimer in the |
universe@103 | 14 | * documentation and/or other materials provided with the distribution. |
universe@103 | 15 | * |
universe@103 | 16 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
universe@103 | 17 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
universe@103 | 18 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
universe@103 | 19 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
universe@103 | 20 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
universe@103 | 21 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
universe@103 | 22 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
universe@103 | 23 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
universe@103 | 24 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
universe@103 | 25 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
universe@103 | 26 | * POSSIBILITY OF SUCH DAMAGE. |
universe@4 | 27 | */ |
universe@123 | 28 | /** |
universe@128 | 29 | * Doubly linked list implementation. |
universe@123 | 30 | * |
universe@123 | 31 | * @file list.h |
universe@123 | 32 | * @author Mike Becker |
universe@123 | 33 | * @author Olaf Wintermann |
universe@123 | 34 | */ |
universe@4 | 35 | |
universe@122 | 36 | #ifndef UCX_LIST_H |
universe@122 | 37 | #define UCX_LIST_H |
universe@4 | 38 | |
universe@7 | 39 | #include "ucx.h" |
universe@125 | 40 | #include "allocator.h" |
universe@7 | 41 | |
universe@4 | 42 | #ifdef __cplusplus |
universe@4 | 43 | extern "C" { |
universe@4 | 44 | #endif |
universe@4 | 45 | |
universe@121 | 46 | /** |
universe@121 | 47 | * Loop statement for UCX lists. |
universe@121 | 48 | * |
universe@220 | 49 | * The first argument is the name of the iteration variable. The scope of |
universe@220 | 50 | * this variable is limited to the <code>UCX_FOREACH</code> statement. |
universe@220 | 51 | * |
universe@220 | 52 | * The second argument is a pointer to the list. In most cases this will be the |
universe@121 | 53 | * pointer to the first element of the list, but it may also be an arbitrary |
universe@121 | 54 | * element of the list. The iteration will then start with that element. |
universe@121 | 55 | * |
universe@121 | 56 | * @param list The first element of the list |
universe@121 | 57 | * @param elem The variable name of the element |
universe@121 | 58 | */ |
universe@122 | 59 | #define UCX_FOREACH(elem,list) \ |
universe@122 | 60 | for (UcxList* elem = list ; elem != NULL ; elem = elem->next) |
universe@121 | 61 | |
universe@123 | 62 | /** |
universe@129 | 63 | * UCX list type. |
universe@123 | 64 | * @see UcxList |
universe@123 | 65 | */ |
universe@122 | 66 | typedef struct UcxList UcxList; |
universe@146 | 67 | |
universe@129 | 68 | /** |
universe@129 | 69 | * UCX list structure. |
universe@129 | 70 | */ |
universe@122 | 71 | struct UcxList { |
universe@123 | 72 | /** |
universe@123 | 73 | * List element payload. |
universe@123 | 74 | */ |
universe@122 | 75 | void *data; |
universe@123 | 76 | /** |
universe@123 | 77 | * Pointer to the next list element or <code>NULL</code>, if this is the |
universe@123 | 78 | * last element. |
universe@123 | 79 | */ |
universe@122 | 80 | UcxList *next; |
universe@123 | 81 | /** |
universe@123 | 82 | * Pointer to the previous list element or <code>NULL</code>, if this is |
universe@123 | 83 | * the first element. |
universe@123 | 84 | */ |
universe@122 | 85 | UcxList *prev; |
universe@4 | 86 | }; |
universe@4 | 87 | |
universe@128 | 88 | /** |
universe@128 | 89 | * Creates an element-wise copy of a list. |
universe@128 | 90 | * |
universe@128 | 91 | * This function clones the specified list by creating new list elements and |
universe@128 | 92 | * copying the data with the specified copy_func(). If no copy_func() is |
universe@128 | 93 | * specified, a shallow copy is created and the new list will reference the |
universe@128 | 94 | * same data as the source list. |
universe@128 | 95 | * |
universe@128 | 96 | * @param list the list to copy |
universe@128 | 97 | * @param cpyfnc a pointer to the function that shall copy an element (may be |
universe@128 | 98 | * <code>NULL</code>) |
universe@128 | 99 | * @param data additional data for the copy_func() |
universe@128 | 100 | * @return a pointer to the copy |
universe@128 | 101 | */ |
universe@125 | 102 | UcxList *ucx_list_clone(UcxList *list, copy_func cpyfnc, void* data); |
universe@146 | 103 | |
universe@128 | 104 | /** |
universe@128 | 105 | * Creates an element-wise copy of a list using an UcxAllocator. |
universe@128 | 106 | * |
universe@128 | 107 | * See ucx_list_clone() for details. |
universe@128 | 108 | * |
universe@128 | 109 | * Keep in mind, that you might want to pass the allocator as an (part of the) |
universe@128 | 110 | * argument for the <code>data</code> parameter, if you want the copy_func() to |
universe@128 | 111 | * make use of the allocator. |
universe@128 | 112 | * |
universe@129 | 113 | * @param allocator the allocator to use |
universe@128 | 114 | * @param list the list to copy |
universe@128 | 115 | * @param cpyfnc a pointer to the function that shall copy an element (may be |
universe@128 | 116 | * <code>NULL</code>) |
universe@128 | 117 | * @param data additional data for the copy_func() |
universe@128 | 118 | * @return a pointer to the copy |
universe@128 | 119 | * @see ucx_list_clone() |
universe@128 | 120 | */ |
universe@125 | 121 | UcxList *ucx_list_clone_a(UcxAllocator *allocator, UcxList *list, |
universe@125 | 122 | copy_func cpyfnc, void* data); |
universe@18 | 123 | |
universe@123 | 124 | /** |
universe@123 | 125 | * Compares two UCX lists element-wise by using a compare function. |
universe@123 | 126 | * |
universe@123 | 127 | * Each element of the two specified lists are compared by using the specified |
universe@123 | 128 | * compare function and the additional data. The type and content of this |
universe@123 | 129 | * additional data depends on the cmp_func() used. |
universe@123 | 130 | * |
universe@123 | 131 | * If the list pointers denote elements within a list, the lists are compared |
universe@123 | 132 | * starting with the denoted elements. Thus any previous elements are not taken |
universe@123 | 133 | * into account. This might be useful to check, if certain list tails match |
universe@123 | 134 | * each other. |
universe@123 | 135 | * |
universe@123 | 136 | * @param list1 the first list |
universe@123 | 137 | * @param list2 the second list |
universe@123 | 138 | * @param cmpfnc the compare function |
universe@123 | 139 | * @param data additional data for the compare function |
universe@123 | 140 | * @return 1, if and only if the two lists equal element-wise, 0 otherwise |
universe@123 | 141 | */ |
universe@123 | 142 | int ucx_list_equals(const UcxList *list1, const UcxList *list2, |
universe@123 | 143 | cmp_func cmpfnc, void* data); |
universe@4 | 144 | |
universe@123 | 145 | /** |
universe@123 | 146 | * Destroys the entire list. |
universe@123 | 147 | * |
universe@123 | 148 | * The members of the list are not automatically freed, so ensure they are |
universe@211 | 149 | * otherwise referenced or destroyed by ucx_list_free_contents(). |
universe@211 | 150 | * Otherwise, a memory leak is likely to occur. |
universe@123 | 151 | * |
universe@123 | 152 | * <b>Caution:</b> the argument <b>MUST</b> denote an entire list (i.e. a call |
universe@123 | 153 | * to ucx_list_first() on the argument must return the argument itself) |
universe@123 | 154 | * |
universe@128 | 155 | * @param list the list to free |
universe@211 | 156 | * @see ucx_list_free_contents() |
universe@123 | 157 | */ |
universe@123 | 158 | void ucx_list_free(UcxList *list); |
universe@146 | 159 | |
universe@128 | 160 | /** |
universe@128 | 161 | * Destroys the entire list using an UcxAllocator. |
universe@128 | 162 | * |
universe@128 | 163 | * See ucx_list_free() for details. |
universe@128 | 164 | * |
universe@128 | 165 | * @param allocator the allocator to use |
universe@128 | 166 | * @param list the list to free |
universe@128 | 167 | * @see ucx_list_free() |
universe@128 | 168 | */ |
universe@125 | 169 | void ucx_list_free_a(UcxAllocator *allocator, UcxList *list); |
universe@146 | 170 | |
universe@128 | 171 | /** |
universe@211 | 172 | * Destroys the contents of the specified list by calling the specified |
universe@211 | 173 | * destructor on each of them. |
universe@211 | 174 | * |
universe@211 | 175 | * Note, that the contents are not usable afterwards and the list should be |
universe@211 | 176 | * destroyed with ucx_list_free(). |
universe@211 | 177 | * |
universe@211 | 178 | * @param list the list for which the contents shall be freed |
universe@211 | 179 | * @param destr the destructor function (e.g. stdlib free()) |
universe@211 | 180 | * @see ucx_list_free() |
universe@211 | 181 | */ |
universe@212 | 182 | void ucx_list_free_content(UcxList* list, ucx_destructor destr); |
universe@211 | 183 | |
universe@211 | 184 | |
universe@211 | 185 | /** |
universe@128 | 186 | * Inserts an element at the end of the list. |
universe@128 | 187 | * |
universe@172 | 188 | * This is generally an O(n) operation, as the end of the list is retrieved with |
universe@128 | 189 | * ucx_list_last(). |
universe@128 | 190 | * |
universe@128 | 191 | * @param list the list where to append the data, or <code>NULL</code> to |
universe@128 | 192 | * create a new list |
universe@128 | 193 | * @param data the data to insert |
universe@128 | 194 | * @return <code>list</code>, if it is not <code>NULL</code> or a pointer to |
universe@128 | 195 | * the newly created list otherwise |
universe@128 | 196 | */ |
universe@123 | 197 | UcxList *ucx_list_append(UcxList *list, void *data); |
universe@146 | 198 | |
universe@128 | 199 | /** |
universe@128 | 200 | * Inserts an element at the end of the list using an UcxAllocator. |
universe@128 | 201 | * |
universe@128 | 202 | * See ucx_list_append() for details. |
universe@128 | 203 | * |
universe@128 | 204 | * @param allocator the allocator to use |
universe@128 | 205 | * @param list the list where to append the data, or <code>NULL</code> to |
universe@128 | 206 | * create a new list |
universe@128 | 207 | * @param data the data to insert |
universe@128 | 208 | * @return <code>list</code>, if it is not <code>NULL</code> or a pointer to |
universe@128 | 209 | * the newly created list otherwise |
universe@128 | 210 | * @see ucx_list_append() |
universe@128 | 211 | */ |
universe@125 | 212 | UcxList *ucx_list_append_a(UcxAllocator *allocator, UcxList *list, void *data); |
universe@146 | 213 | |
universe@128 | 214 | /** |
universe@128 | 215 | * Inserts an element at the beginning of the list. |
universe@128 | 216 | * |
universe@128 | 217 | * You <i>should</i> overwrite the old list pointer by calling |
universe@128 | 218 | * <code>mylist = ucx_list_prepend(mylist, mydata);</code>. However, you may |
universe@128 | 219 | * also perform successive calls of ucx_list_prepend() on the same list pointer, |
universe@128 | 220 | * as this function always searchs for the head of the list with |
universe@128 | 221 | * ucx_list_first(). |
universe@128 | 222 | * |
universe@128 | 223 | * @param list the list where to insert the data or <code>NULL</code> to create |
universe@128 | 224 | * a new list |
universe@128 | 225 | * @param data the data to insert |
universe@128 | 226 | * @return a pointer to the new list head |
universe@128 | 227 | */ |
universe@123 | 228 | UcxList *ucx_list_prepend(UcxList *list, void *data); |
universe@146 | 229 | |
universe@128 | 230 | /** |
universe@128 | 231 | * Inserts an element at the beginning of the list using an UcxAllocator. |
universe@128 | 232 | * |
universe@128 | 233 | * See ucx_list_prepend() for details. |
universe@128 | 234 | * |
universe@128 | 235 | * @param allocator the allocator to use |
universe@128 | 236 | * @param list the list where to insert the data or <code>NULL</code> to create |
universe@128 | 237 | * a new list |
universe@128 | 238 | * @param data the data to insert |
universe@128 | 239 | * @return a pointer to the new list head |
universe@128 | 240 | * @see ucx_list_prepend() |
universe@128 | 241 | */ |
universe@125 | 242 | UcxList *ucx_list_prepend_a(UcxAllocator *allocator, UcxList *list, void *data); |
universe@146 | 243 | |
universe@128 | 244 | /** |
universe@128 | 245 | * Concatenates two lists. |
universe@128 | 246 | * |
universe@128 | 247 | * Either of the two arguments may be <code>NULL</code>. |
universe@128 | 248 | * |
universe@128 | 249 | * This function modifies the references to the next/previous element of |
universe@128 | 250 | * the last/first element of <code>list1</code>/<code> |
universe@128 | 251 | * list2</code>. |
universe@128 | 252 | * |
universe@128 | 253 | * @param list1 first list |
universe@128 | 254 | * @param list2 second list |
universe@128 | 255 | * @return if <code>list1</code> is <code>NULL</code>, <code>list2</code> is |
universe@128 | 256 | * returned, otherwise <code>list1</code> is returned |
universe@128 | 257 | */ |
universe@123 | 258 | UcxList *ucx_list_concat(UcxList *list1, UcxList *list2); |
universe@146 | 259 | |
universe@124 | 260 | /** |
universe@124 | 261 | * Returns the first element of a list. |
universe@124 | 262 | * |
universe@124 | 263 | * If the argument is the list pointer, it is directly returned. Otherwise |
universe@124 | 264 | * this function traverses to the first element of the list and returns the |
universe@124 | 265 | * list pointer. |
universe@124 | 266 | * |
universe@124 | 267 | * @param elem one element of the list |
universe@124 | 268 | * @return the first element of the list, the specified element is a member of |
universe@124 | 269 | */ |
universe@124 | 270 | UcxList *ucx_list_first(const UcxList *elem); |
universe@146 | 271 | |
universe@124 | 272 | /** |
universe@124 | 273 | * Returns the last element of a list. |
universe@124 | 274 | * |
universe@124 | 275 | * If the argument has no successor, it is the last element and therefore |
universe@124 | 276 | * directly returned. Otherwise this function traverses to the last element of |
universe@124 | 277 | * the list and returns it. |
universe@124 | 278 | * |
universe@124 | 279 | * @param elem one element of the list |
universe@124 | 280 | * @return the last element of the list, the specified element is a member of |
universe@124 | 281 | */ |
universe@124 | 282 | UcxList *ucx_list_last(const UcxList *elem); |
universe@146 | 283 | |
universe@128 | 284 | /** |
universe@128 | 285 | * Returns the list element at the specified index. |
universe@128 | 286 | * |
universe@128 | 287 | * @param list the list to retrieve the element from |
universe@128 | 288 | * @param index index of the element to return |
universe@128 | 289 | * @return the element at the specified index or <code>NULL</code>, if the |
universe@128 | 290 | * index is greater than the list size |
universe@128 | 291 | */ |
universe@172 | 292 | UcxList *ucx_list_get(const UcxList *list, size_t index); |
universe@146 | 293 | |
universe@128 | 294 | /** |
universe@128 | 295 | * Returns the index of an element. |
universe@128 | 296 | * |
universe@128 | 297 | * @param list the list where to search for the element |
universe@128 | 298 | * @param elem the element to find |
universe@128 | 299 | * @return the index of the element or -1 if the list does not contain the |
universe@128 | 300 | * element |
universe@128 | 301 | */ |
universe@123 | 302 | ssize_t ucx_list_indexof(const UcxList *list, const UcxList *elem); |
universe@146 | 303 | |
universe@128 | 304 | /** |
universe@128 | 305 | * Returns the element count of the list. |
universe@128 | 306 | * |
universe@128 | 307 | * @param list the list whose elements are counted |
universe@128 | 308 | * @return the element count |
universe@128 | 309 | */ |
universe@123 | 310 | size_t ucx_list_size(const UcxList *list); |
universe@146 | 311 | |
universe@128 | 312 | /** |
universe@128 | 313 | * Returns the index of an element containing the specified data. |
universe@128 | 314 | * |
universe@128 | 315 | * This function uses a cmp_func() to compare the data of each list element |
universe@128 | 316 | * with the specified data. If no cmp_func is provided, the pointers are |
universe@128 | 317 | * compared. |
universe@128 | 318 | * |
universe@128 | 319 | * If the list contains the data more than once, the index of the first |
universe@128 | 320 | * occurrence is returned. |
universe@128 | 321 | * |
universe@128 | 322 | * @param list the list where to search for the data |
universe@128 | 323 | * @param elem the element data |
universe@128 | 324 | * @param cmpfnc the compare function |
universe@128 | 325 | * @param data additional data for the compare function |
universe@128 | 326 | * @return the index of the element containing the specified data or -1 if the |
universe@128 | 327 | * data is not found in this list |
universe@128 | 328 | */ |
universe@124 | 329 | ssize_t ucx_list_find(UcxList *list, void *elem, cmp_func cmpfnc, void *data); |
universe@146 | 330 | |
universe@128 | 331 | /** |
universe@128 | 332 | * Checks, if a list contains a specific element. |
universe@128 | 333 | * |
universe@128 | 334 | * An element is found, if ucx_list_find() returns a value greater than -1. |
universe@128 | 335 | * |
universe@128 | 336 | * @param list the list where to search for the data |
universe@128 | 337 | * @param elem the element data |
universe@128 | 338 | * @param cmpfnc the compare function |
universe@128 | 339 | * @param data additional data for the compare function |
universe@128 | 340 | * @return 1, if and only if the list contains the specified element data |
universe@128 | 341 | * @see ucx_list_find() |
universe@128 | 342 | */ |
universe@124 | 343 | int ucx_list_contains(UcxList *list, void *elem, cmp_func cmpfnc, void *data); |
universe@35 | 344 | |
universe@128 | 345 | /** |
universe@128 | 346 | * Sorts an UcxList with natural merge sort. |
universe@128 | 347 | * |
universe@128 | 348 | * This function uses O(n) additional temporary memory for merge operations |
universe@128 | 349 | * that is automatically freed after each merge. |
universe@128 | 350 | * |
universe@128 | 351 | * As the head of the list might change, you <b>MUST</b> call this function |
universe@128 | 352 | * as follows: <code>mylist = ucx_list_sort(mylist, mycmpfnc, mydata);</code>. |
universe@128 | 353 | * |
universe@128 | 354 | * @param list the list to sort |
universe@128 | 355 | * @param cmpfnc the function that shall be used to compare the element data |
universe@128 | 356 | * @param data additional data for the cmp_func() |
universe@128 | 357 | * @return the sorted list |
universe@128 | 358 | */ |
universe@123 | 359 | UcxList *ucx_list_sort(UcxList *list, cmp_func cmpfnc, void *data); |
universe@123 | 360 | |
universe@124 | 361 | /** |
universe@124 | 362 | * Removes an element from the list. |
universe@124 | 363 | * |
universe@124 | 364 | * If the first element is removed, the list pointer changes. So it is |
universe@124 | 365 | * <i>highly recommended</i> to <i>always</i> update the pointer by calling |
universe@124 | 366 | * <code>mylist = ucx_list_remove(mylist, myelem);</code>. |
universe@124 | 367 | * |
universe@124 | 368 | * @param list the list from which the element shall be removed |
universe@172 | 369 | * @param element the element to remove |
universe@124 | 370 | * @return returns the updated list pointer or <code>NULL</code>, if the list |
universe@124 | 371 | * is now empty |
universe@124 | 372 | */ |
universe@123 | 373 | UcxList *ucx_list_remove(UcxList *list, UcxList *element); |
universe@146 | 374 | |
universe@128 | 375 | /** |
universe@128 | 376 | * Removes an element from the list using an UcxAllocator. |
universe@128 | 377 | * |
universe@128 | 378 | * See ucx_list_remove() for details. |
universe@128 | 379 | * |
universe@128 | 380 | * @param allocator the allocator to use |
universe@128 | 381 | * @param list the list from which the element shall be removed |
universe@172 | 382 | * @param element the element to remove |
universe@128 | 383 | * @return returns the updated list pointer or <code>NULL</code>, if the list |
universe@128 | 384 | * @see ucx_list_remove() |
universe@128 | 385 | */ |
universe@125 | 386 | UcxList *ucx_list_remove_a(UcxAllocator *allocator, UcxList *list, |
universe@125 | 387 | UcxList *element); |
universe@4 | 388 | |
universe@4 | 389 | #ifdef __cplusplus |
universe@4 | 390 | } |
universe@4 | 391 | #endif |
universe@4 | 392 | |
universe@122 | 393 | #endif /* UCX_LIST_H */ |
universe@4 | 394 |