ucx/list.h

changeset 122
540d99722f1f
parent 121
311cac04d079
child 123
7fb0f74517c5
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/ucx/list.h	Mon Jul 22 11:53:39 2013 +0200
     1.3 @@ -0,0 +1,85 @@
     1.4 +/*
     1.5 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
     1.6 + *
     1.7 + * Copyright 2013 Olaf Wintermann. All rights reserved.
     1.8 + *
     1.9 + * Redistribution and use in source and binary forms, with or without
    1.10 + * modification, are permitted provided that the following conditions are met:
    1.11 + *
    1.12 + *   1. Redistributions of source code must retain the above copyright
    1.13 + *      notice, this list of conditions and the following disclaimer.
    1.14 + *
    1.15 + *   2. Redistributions in binary form must reproduce the above copyright
    1.16 + *      notice, this list of conditions and the following disclaimer in the
    1.17 + *      documentation and/or other materials provided with the distribution.
    1.18 + *
    1.19 + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    1.20 + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    1.21 + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    1.22 + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
    1.23 + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    1.24 + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    1.25 + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    1.26 + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    1.27 + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    1.28 + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    1.29 + * POSSIBILITY OF SUCH DAMAGE.
    1.30 + */
    1.31 +
    1.32 +#ifndef UCX_LIST_H
    1.33 +#define	UCX_LIST_H
    1.34 +
    1.35 +#include "ucx.h"
    1.36 +#include <stddef.h>
    1.37 +
    1.38 +#ifdef	__cplusplus
    1.39 +extern "C" {
    1.40 +#endif
    1.41 +
    1.42 +/**
    1.43 + * Loop statement for UCX lists.
    1.44 + * 
    1.45 + * The first argument is a pointer to the list. In most cases this will be the
    1.46 + * pointer to the first element of the list, but it may also be an arbitrary
    1.47 + * element of the list. The iteration will then start with that element.
    1.48 + * 
    1.49 + * The second argument is the name of the iteration variable. The scope of
    1.50 + * this variable is limited to the <code>UCX_FOREACH</code> statement.
    1.51 + * 
    1.52 + * @param list The first element of the list
    1.53 + * @param elem The variable name of the element
    1.54 + */
    1.55 +#define UCX_FOREACH(elem,list) \
    1.56 +        for (UcxList* elem = list ; elem != NULL ; elem = elem->next)
    1.57 +
    1.58 +typedef struct UcxList UcxList;
    1.59 +struct UcxList {
    1.60 +    void    *data;
    1.61 +    UcxList *next;
    1.62 +    UcxList *prev;
    1.63 +};
    1.64 +
    1.65 +UcxList *ucx_list_clone(UcxList *l, copy_func fnc, void* data);
    1.66 +int ucx_list_equals(const UcxList *l1, const UcxList *l2,
    1.67 +        cmp_func fnc, void* data);
    1.68 +
    1.69 +void ucx_list_free(UcxList *l);
    1.70 +UcxList *ucx_list_append(UcxList *l, void *data);
    1.71 +UcxList *ucx_list_prepend(UcxList *l, void *data);
    1.72 +UcxList *ucx_list_concat(UcxList *l1, UcxList *l2);
    1.73 +UcxList *ucx_list_last(const UcxList *l);
    1.74 +UcxList *ucx_list_get(const UcxList *l, int index);
    1.75 +size_t ucx_list_size(const UcxList *l);
    1.76 +int ucx_list_contains(UcxList *l, void *elem, cmp_func fnc, void *cmpdata);
    1.77 +
    1.78 +UcxList *ucx_list_sort(UcxList *l, cmp_func fnc, void *data);
    1.79 +
    1.80 +UcxList *ucx_list_first(const UcxList *l);
    1.81 +UcxList *ucx_list_remove(UcxList *l, UcxList *e);
    1.82 +
    1.83 +#ifdef	__cplusplus
    1.84 +}
    1.85 +#endif
    1.86 +
    1.87 +#endif	/* UCX_LIST_H */
    1.88 +

mercurial