Mon, 22 Jul 2013 13:45:49 +0200
changed signature of sstrncat + some documentation for UcxList + new features for UcxList
universe@103 | 1 | /* |
universe@103 | 2 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. |
universe@103 | 3 | * |
universe@103 | 4 | * Copyright 2013 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@123 | 29 | * Double 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@7 | 40 | #include <stddef.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@121 | 49 | * The first argument is a pointer to the list. In most cases this will be the |
universe@121 | 50 | * pointer to the first element of the list, but it may also be an arbitrary |
universe@121 | 51 | * element of the list. The iteration will then start with that element. |
universe@121 | 52 | * |
universe@121 | 53 | * The second argument is the name of the iteration variable. The scope of |
universe@121 | 54 | * this variable is limited to the <code>UCX_FOREACH</code> statement. |
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@123 | 63 | * UCX list type |
universe@123 | 64 | * @see UcxList |
universe@123 | 65 | */ |
universe@122 | 66 | typedef struct UcxList UcxList; |
universe@122 | 67 | struct UcxList { |
universe@123 | 68 | /** |
universe@123 | 69 | * List element payload. |
universe@123 | 70 | */ |
universe@122 | 71 | void *data; |
universe@123 | 72 | /** |
universe@123 | 73 | * Pointer to the next list element or <code>NULL</code>, if this is the |
universe@123 | 74 | * last element. |
universe@123 | 75 | */ |
universe@122 | 76 | UcxList *next; |
universe@123 | 77 | /** |
universe@123 | 78 | * Pointer to the previous list element or <code>NULL</code>, if this is |
universe@123 | 79 | * the first element. |
universe@123 | 80 | */ |
universe@122 | 81 | UcxList *prev; |
universe@4 | 82 | }; |
universe@4 | 83 | |
universe@122 | 84 | UcxList *ucx_list_clone(UcxList *l, copy_func fnc, void* data); |
universe@18 | 85 | |
universe@123 | 86 | /** |
universe@123 | 87 | * Compares two UCX lists element-wise by using a compare function. |
universe@123 | 88 | * |
universe@123 | 89 | * Each element of the two specified lists are compared by using the specified |
universe@123 | 90 | * compare function and the additional data. The type and content of this |
universe@123 | 91 | * additional data depends on the cmp_func() used. |
universe@123 | 92 | * |
universe@123 | 93 | * If the list pointers denote elements within a list, the lists are compared |
universe@123 | 94 | * starting with the denoted elements. Thus any previous elements are not taken |
universe@123 | 95 | * into account. This might be useful to check, if certain list tails match |
universe@123 | 96 | * each other. |
universe@123 | 97 | * |
universe@123 | 98 | * @param list1 the first list |
universe@123 | 99 | * @param list2 the second list |
universe@123 | 100 | * @param cmpfnc the compare function |
universe@123 | 101 | * @param data additional data for the compare function |
universe@123 | 102 | * @return 1, if and only if the two lists equal element-wise, 0 otherwise |
universe@123 | 103 | */ |
universe@123 | 104 | int ucx_list_equals(const UcxList *list1, const UcxList *list2, |
universe@123 | 105 | cmp_func cmpfnc, void* data); |
universe@4 | 106 | |
universe@123 | 107 | /** |
universe@123 | 108 | * Destroys the entire list. |
universe@123 | 109 | * |
universe@123 | 110 | * The members of the list are not automatically freed, so ensure they are |
universe@123 | 111 | * otherwise referenced or a memory leak will occur. |
universe@123 | 112 | * |
universe@123 | 113 | * <b>Caution:</b> the argument <b>MUST</b> denote an entire list (i.e. a call |
universe@123 | 114 | * to ucx_list_first() on the argument must return the argument itself) |
universe@123 | 115 | * |
universe@123 | 116 | * @param list The list to free. |
universe@123 | 117 | */ |
universe@123 | 118 | void ucx_list_free(UcxList *list); |
universe@123 | 119 | UcxList *ucx_list_append(UcxList *list, void *data); |
universe@123 | 120 | UcxList *ucx_list_prepend(UcxList *list, void *data); |
universe@123 | 121 | UcxList *ucx_list_concat(UcxList *list1, UcxList *list2); |
universe@123 | 122 | UcxList *ucx_list_last(const UcxList *list); |
universe@123 | 123 | UcxList *ucx_list_get(const UcxList *list, int index); |
universe@123 | 124 | ssize_t ucx_list_indexof(const UcxList *list, const UcxList *elem); |
universe@123 | 125 | size_t ucx_list_size(const UcxList *list); |
universe@123 | 126 | ssize_t ucx_list_find(UcxList *list, void *elem, cmp_func fnc, void *cmpdata); |
universe@123 | 127 | int ucx_list_contains(UcxList *list, void *elem, cmp_func fnc, void *cmpdata); |
universe@35 | 128 | |
universe@123 | 129 | UcxList *ucx_list_sort(UcxList *list, cmp_func cmpfnc, void *data); |
universe@123 | 130 | |
universe@123 | 131 | UcxList *ucx_list_first(const UcxList *list); |
universe@123 | 132 | UcxList *ucx_list_remove(UcxList *list, UcxList *element); |
universe@4 | 133 | |
universe@4 | 134 | #ifdef __cplusplus |
universe@4 | 135 | } |
universe@4 | 136 | #endif |
universe@4 | 137 | |
universe@122 | 138 | #endif /* UCX_LIST_H */ |
universe@4 | 139 |