ucx/list.h

Mon, 22 Jul 2013 11:53:39 +0200

author
Mike Becker <universe@uap-core.de>
date
Mon, 22 Jul 2013 11:53:39 +0200
changeset 122
540d99722f1f
parent 121
ucx/dlist.h@311cac04d079
child 123
7fb0f74517c5
permissions
-rw-r--r--

removal of single linked list implemenation - step 2: renamed UcxDlist to UcxList (new single implementation)

     1 /*
     2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
     3  *
     4  * Copyright 2013 Olaf Wintermann. All rights reserved.
     5  *
     6  * Redistribution and use in source and binary forms, with or without
     7  * modification, are permitted provided that the following conditions are met:
     8  *
     9  *   1. Redistributions of source code must retain the above copyright
    10  *      notice, this list of conditions and the following disclaimer.
    11  *
    12  *   2. Redistributions in binary form must reproduce the above copyright
    13  *      notice, this list of conditions and the following disclaimer in the
    14  *      documentation and/or other materials provided with the distribution.
    15  *
    16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    17  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    19  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
    20  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    26  * POSSIBILITY OF SUCH DAMAGE.
    27  */
    29 #ifndef UCX_LIST_H
    30 #define	UCX_LIST_H
    32 #include "ucx.h"
    33 #include <stddef.h>
    35 #ifdef	__cplusplus
    36 extern "C" {
    37 #endif
    39 /**
    40  * Loop statement for UCX lists.
    41  * 
    42  * The first argument is a pointer to the list. In most cases this will be the
    43  * pointer to the first element of the list, but it may also be an arbitrary
    44  * element of the list. The iteration will then start with that element.
    45  * 
    46  * The second argument is the name of the iteration variable. The scope of
    47  * this variable is limited to the <code>UCX_FOREACH</code> statement.
    48  * 
    49  * @param list The first element of the list
    50  * @param elem The variable name of the element
    51  */
    52 #define UCX_FOREACH(elem,list) \
    53         for (UcxList* elem = list ; elem != NULL ; elem = elem->next)
    55 typedef struct UcxList UcxList;
    56 struct UcxList {
    57     void    *data;
    58     UcxList *next;
    59     UcxList *prev;
    60 };
    62 UcxList *ucx_list_clone(UcxList *l, copy_func fnc, void* data);
    63 int ucx_list_equals(const UcxList *l1, const UcxList *l2,
    64         cmp_func fnc, void* data);
    66 void ucx_list_free(UcxList *l);
    67 UcxList *ucx_list_append(UcxList *l, void *data);
    68 UcxList *ucx_list_prepend(UcxList *l, void *data);
    69 UcxList *ucx_list_concat(UcxList *l1, UcxList *l2);
    70 UcxList *ucx_list_last(const UcxList *l);
    71 UcxList *ucx_list_get(const UcxList *l, int index);
    72 size_t ucx_list_size(const UcxList *l);
    73 int ucx_list_contains(UcxList *l, void *elem, cmp_func fnc, void *cmpdata);
    75 UcxList *ucx_list_sort(UcxList *l, cmp_func fnc, void *data);
    77 UcxList *ucx_list_first(const UcxList *l);
    78 UcxList *ucx_list_remove(UcxList *l, UcxList *e);
    80 #ifdef	__cplusplus
    81 }
    82 #endif
    84 #endif	/* UCX_LIST_H */

mercurial