linked_list.h

00001 /*
00002  * Copyright (C) 2009 by Matthias Ringwald
00003  *
00004  * Redistribution and use in source and binary forms, with or without
00005  * modification, are permitted provided that the following conditions
00006  * are met:
00007  *
00008  * 1. Redistributions of source code must retain the above copyright
00009  *    notice, this list of conditions and the following disclaimer.
00010  * 2. Redistributions in binary form must reproduce the above copyright
00011  *    notice, this list of conditions and the following disclaimer in the
00012  *    documentation and/or other materials provided with the distribution.
00013  * 3. Neither the name of the copyright holders nor the names of
00014  *    contributors may be used to endorse or promote products derived
00015  *    from this software without specific prior written permission.
00016  *
00017  * THIS SOFTWARE IS PROVIDED BY MATTHIAS RINGWALD AND CONTRIBUTORS
00018  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00019  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00020  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS
00021  * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00022  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00023  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
00024  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
00025  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00026  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
00027  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00028  * SUCH DAMAGE.
00029  *
00030  */
00031 
00032 /*
00033  *  linked_list.h
00034  *
00035  *  Created by Matthias Ringwald on 7/13/09.
00036  */
00037 
00038 #pragma once
00039 
00040 #if defined __cplusplus
00041 extern "C" {
00042 #endif
00043     
00044 typedef struct linked_item {
00045     struct linked_item *next; // <-- next element in list, or NULL
00046     void *user_data;          // <-- pointer to struct base
00047 } linked_item_t;
00048 
00049 typedef linked_item_t * linked_list_t;
00050 
00051 void linked_item_set_user(linked_item_t *item, void *user_data);        // <-- set user data
00052 void * linked_item_get_user(linked_item_t *item);                       // <-- get user data
00053 int  linked_list_empty(linked_list_t * list);
00054 void linked_list_add(linked_list_t * list, linked_item_t *item);        // <-- add item to list as first element
00055 void linked_list_add_tail(linked_list_t * list, linked_item_t *item);   // <-- add item to list as last element
00056 int  linked_list_remove(linked_list_t * list, linked_item_t *item);     // <-- remove item from list
00057 linked_item_t * linked_list_get_last_item(linked_list_t * list);        // <-- find the last item in the list
00058 
00059 void test_linked_list(void);
00060 
00061 #if defined __cplusplus
00062 }
00063 #endif