ucx/dlist.h

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2013 Olaf Wintermann. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   1. Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *
 *   2. Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in the
 *      documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef DLIST_H
#define	DLIST_H

#include "ucx.h"
#include <stddef.h>

#ifdef	__cplusplus
extern "C" {
#endif

typedef struct UcxDlist UcxDlist;
struct UcxDlist {
    void     *data;
    UcxDlist *next;
    UcxDlist *prev;
};

UcxDlist *ucx_dlist_clone(UcxDlist *l, copy_func fnc, void* data);
int ucx_dlist_equals(const UcxDlist *l1, const UcxDlist *l2,
        cmp_func fnc, void* data);

void ucx_dlist_free(UcxDlist *l);
UcxDlist *ucx_dlist_append(UcxDlist *l, void *data);
UcxDlist *ucx_dlist_prepend(UcxDlist *l, void *data);
UcxDlist *ucx_dlist_concat(UcxDlist *l1, UcxDlist *l2);
UcxDlist *ucx_dlist_last(const UcxDlist *l);
UcxDlist *ucx_dlist_get(const UcxDlist *l, int index);
size_t ucx_dlist_size(const UcxDlist *l);
int ucx_dlist_contains(UcxDlist *l, void *elem, cmp_func fnc, void *cmpdata);

UcxDlist *ucx_dlist_sort(UcxDlist *l, cmp_func fnc, void *data);

/* dlist specific functions */
UcxDlist *ucx_dlist_first(const UcxDlist *l);
UcxDlist *ucx_dlist_remove(UcxDlist *l, UcxDlist *e);

#ifdef	__cplusplus
}
#endif

#endif	/* DLIST_H */