universe@103: /*
universe@103:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
universe@103:  *
universe@103:  * Copyright 2013 Olaf Wintermann. All rights reserved.
universe@103:  *
universe@103:  * Redistribution and use in source and binary forms, with or without
universe@103:  * modification, are permitted provided that the following conditions are met:
universe@103:  *
universe@103:  *   1. Redistributions of source code must retain the above copyright
universe@103:  *      notice, this list of conditions and the following disclaimer.
universe@103:  *
universe@103:  *   2. Redistributions in binary form must reproduce the above copyright
universe@103:  *      notice, this list of conditions and the following disclaimer in the
universe@103:  *      documentation and/or other materials provided with the distribution.
universe@103:  *
universe@103:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
universe@103:  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
universe@103:  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
universe@103:  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
universe@103:  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
universe@103:  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
universe@103:  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
universe@103:  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
universe@103:  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
universe@103:  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
universe@103:  * POSSIBILITY OF SUCH DAMAGE.
universe@4:  */
universe@4: 
universe@122: #ifndef UCX_LIST_H
universe@122: #define	UCX_LIST_H
universe@4: 
universe@7: #include "ucx.h"
universe@7: #include <stddef.h>
universe@7: 
universe@4: #ifdef	__cplusplus
universe@4: extern "C" {
universe@4: #endif
universe@4: 
universe@121: /**
universe@121:  * Loop statement for UCX lists.
universe@121:  * 
universe@121:  * The first argument is a pointer to the list. In most cases this will be the
universe@121:  * pointer to the first element of the list, but it may also be an arbitrary
universe@121:  * element of the list. The iteration will then start with that element.
universe@121:  * 
universe@121:  * The second argument is the name of the iteration variable. The scope of
universe@121:  * this variable is limited to the <code>UCX_FOREACH</code> statement.
universe@121:  * 
universe@121:  * @param list The first element of the list
universe@121:  * @param elem The variable name of the element
universe@121:  */
universe@122: #define UCX_FOREACH(elem,list) \
universe@122:         for (UcxList* elem = list ; elem != NULL ; elem = elem->next)
universe@121: 
universe@122: typedef struct UcxList UcxList;
universe@122: struct UcxList {
universe@122:     void    *data;
universe@122:     UcxList *next;
universe@122:     UcxList *prev;
universe@4: };
universe@4: 
universe@122: UcxList *ucx_list_clone(UcxList *l, copy_func fnc, void* data);
universe@122: int ucx_list_equals(const UcxList *l1, const UcxList *l2,
universe@67:         cmp_func fnc, void* data);
universe@18: 
universe@122: void ucx_list_free(UcxList *l);
universe@122: UcxList *ucx_list_append(UcxList *l, void *data);
universe@122: UcxList *ucx_list_prepend(UcxList *l, void *data);
universe@122: UcxList *ucx_list_concat(UcxList *l1, UcxList *l2);
universe@122: UcxList *ucx_list_last(const UcxList *l);
universe@122: UcxList *ucx_list_get(const UcxList *l, int index);
universe@122: size_t ucx_list_size(const UcxList *l);
universe@122: int ucx_list_contains(UcxList *l, void *elem, cmp_func fnc, void *cmpdata);
universe@4: 
universe@122: UcxList *ucx_list_sort(UcxList *l, cmp_func fnc, void *data);
universe@35: 
universe@122: UcxList *ucx_list_first(const UcxList *l);
universe@122: UcxList *ucx_list_remove(UcxList *l, UcxList *e);
universe@4: 
universe@4: #ifdef	__cplusplus
universe@4: }
universe@4: #endif
universe@4: 
universe@122: #endif	/* UCX_LIST_H */
universe@4: