doubly-linked_list.h

Go to the documentation of this file.

/* 
 * Copyright (c) 2013 Andreas Misje
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */

#ifndef DOUBLYLINKED_LIST
#define DOUBLYLINKED_LIST

#include <stddef.h>

struct dlList_node
{
   void *data;
   struct dlList_node *prev;
   struct dlList_node *next;
};

struct dlList
{
   size_t size;
   struct dlList_node *head;
   struct dlList_node *tail;

   int ( *compare )( const void *data1, const void *data2 );
   void ( *destroy )( void *data );
   void *( *copy )( const void *data );
};

enum dlList_returnValues
{
   DLLIST_OK = 0,
   DLLIST_ERR_errArg,
   DLLIST_ERR_malloc,
   DLLIST_ERR_undefFunc,
};

void dlList_init( struct dlList *list,
      void ( *destroyFunction )( void *data ),
      int ( *compareFunction )( const void *data1, const void *data2),
      void *( *dataDeepCopyFunction )( const void *data ) );

void dlList_destroy( struct dlList *list );

int dlList_insertBefore( struct dlList *list, struct dlList_node *beforeNode,
      void *data );

int dlList_insertAfter( struct dlList *list, struct dlList_node *afterNode,
      void *data );

int dlList_insertOrdered( struct dlList *list, void *data );

int dlList_append( struct dlList *list, void *data );

int dlList_remove( struct dlList *list, struct dlList_node *node,
      void **data );

struct dlList_node *dlList_find( const struct dlList *list, const void *key );

struct dlList dlList_copy( const struct dlList *list );

int dlList_appendList( struct dlList *list1, const struct dlList *list2 );

void dlList_sort( struct dlList *list );

size_t dlList_size( const struct dlList *list );

struct dlList_node *dlList_first( const struct dlList *list );

struct dlList_node *dlList_last( const struct dlList *list );

#endif //DOUBLYLINKED_LIST