ucx: ucx/list.h@8b44653541ef (annotated)

ucx/list.h@8b44653541ef (annotated)

ucx/list.h

Mon, 22 Jul 2013 14:51:52 +0200

author: Mike Becker <universe@uap-core.de>
date: Mon, 22 Jul 2013 14:51:52 +0200
changeset 124: 8b44653541ef
parent 123: 7fb0f74517c5
child 125: fca8efb122de
permissions: -rw-r--r--

 /*
  * 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.
  */
 /**
  * Double linked list implementation.
  *
  * @file   list.h
  * @author Mike Becker
  * @author Olaf Wintermann
  */
 #ifndef UCX_LIST_H
 #define	UCX_LIST_H
 #include "ucx.h"
 #include <stddef.h>
 #ifdef	__cplusplus
 extern "C" {
 #endif
 /**
  * Loop statement for UCX lists.
  *
  * The first argument is a pointer to the list. In most cases this will be the
  * pointer to the first element of the list, but it may also be an arbitrary
  * element of the list. The iteration will then start with that element.
  *
  * The second argument is the name of the iteration variable. The scope of
  * this variable is limited to the <code>UCX_FOREACH</code> statement.
  *
  * @param list The first element of the list
  * @param elem The variable name of the element
  */
 #define UCX_FOREACH(elem,list) \
         for (UcxList* elem = list ; elem != NULL ; elem = elem->next)
 /**
  * UCX list type
  * @see UcxList
  */
 typedef struct UcxList UcxList;
 struct UcxList {
     /**
      * List element payload.
      */
     void    *data;
     /**
      * Pointer to the next list element or <code>NULL</code>, if this is the
      * last element.
      */
     UcxList *next;
     /**
      * Pointer to the previous list element or <code>NULL</code>, if this is
      * the first element.
      */
     UcxList *prev;
 };
 UcxList *ucx_list_clone(UcxList *l, copy_func fnc, void* data);
 /**
  * Compares two UCX lists element-wise by using a compare function.
  *
  * Each element of the two specified lists are compared by using the specified
  * compare function and the additional data. The type and content of this
  * additional data depends on the cmp_func() used.
  *
  * If the list pointers denote elements within a list, the lists are compared
  * starting with the denoted elements. Thus any previous elements are not taken
  * into account. This might be useful to check, if certain list tails match
  * each other.
  *
  * @param list1 the first list
  * @param list2 the second list
  * @param cmpfnc the compare function
  * @param data additional data for the compare function
  * @return 1, if and only if the two lists equal element-wise, 0 otherwise
  */
 int ucx_list_equals(const UcxList *list1, const UcxList *list2,
         cmp_func cmpfnc, void* data);
 /**
  * Destroys the entire list.
  *
  * The members of the list are not automatically freed, so ensure they are
  * otherwise referenced or a memory leak will occur.
  *
  * <b>Caution:</b> the argument <b>MUST</b> denote an entire list (i.e. a call
  * to ucx_list_first() on the argument must return the argument itself)
  *
  * @param list The list to free.
  */
 void ucx_list_free(UcxList *list);
 UcxList *ucx_list_append(UcxList *list, void *data);
 UcxList *ucx_list_prepend(UcxList *list, void *data);
 UcxList *ucx_list_concat(UcxList *list1, UcxList *list2);
 /**
  * Returns the first element of a list.
  *
  * If the argument is the list pointer, it is directly returned. Otherwise
  * this function traverses to the first element of the list and returns the
  * list pointer.
  *
  * @param elem one element of the list
  * @return the first element of the list, the specified element is a member of
  */
 UcxList *ucx_list_first(const UcxList *elem);
 /**
  * Returns the last element of a list.
  *
  * If the argument has no successor, it is the last element and therefore
  * directly returned. Otherwise this function traverses to the last element of
  * the list and returns it.
  *
  * @param elem one element of the list
  * @return the last element of the list, the specified element is a member of
  */
 UcxList *ucx_list_last(const UcxList *elem);
 UcxList *ucx_list_get(const UcxList *list, int index);
 ssize_t ucx_list_indexof(const UcxList *list, const UcxList *elem);
 size_t ucx_list_size(const UcxList *list);
 ssize_t ucx_list_find(UcxList *list, void *elem, cmp_func cmpfnc, void *data);
 int ucx_list_contains(UcxList *list, void *elem, cmp_func cmpfnc, void *data);
 UcxList *ucx_list_sort(UcxList *list, cmp_func cmpfnc, void *data);
 /**
  * Removes an element from the list.
  *
  * If the first element is removed, the list pointer changes. So it is
  * <i>highly recommended</i> to <i>always</i> update the pointer by calling
  * <code>mylist = ucx_list_remove(mylist, myelem);</code>.
  *
  * @param list the list from which the element shall be removed
  * @param element the element to removed
  * @return returns the updated list pointer or <code>NULL</code>, if the list
  * is now empty
  */
 UcxList *ucx_list_remove(UcxList *list, UcxList *element);
 #ifdef	__cplusplus
 }
 #endif
 #endif	/* UCX_LIST_H */

Mercurial > hg > ucx / annotate

ucx/list.h@8b44653541ef (annotated)

ucx/list.h