 |
pl-nk v0.4.5
Plonk|Plink|Plank are a set of cross-platform C/C++ frameworks for audio software development
|
plank_SimpleLinkedList.h
00001 /* 00002 ------------------------------------------------------------------------------- 00003 This file is part of the Plink, Plonk, Plank libraries 00004 by Martin Robinson 00005 00006 http://code.google.com/p/pl-nk/ 00007 00008 Copyright University of the West of England, Bristol 2011-14 00009 All rights reserved. 00010 00011 Redistribution and use in source and binary forms, with or without 00012 modification, are permitted provided that the following conditions are met: 00013 00014 * Redistributions of source code must retain the above copyright 00015 notice, this list of conditions and the following disclaimer. 00016 * Redistributions in binary form must reproduce the above copyright 00017 notice, this list of conditions and the following disclaimer in the 00018 documentation and/or other materials provided with the distribution. 00019 * Neither the name of University of the West of England, Bristol nor 00020 the names of its contributors may be used to endorse or promote products 00021 derived from this software without specific prior written permission. 00022 00023 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 00024 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 00025 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 00026 DISCLAIMED. IN NO EVENT SHALL UNIVERSITY OF THE WEST OF ENGLAND, BRISTOL BE 00027 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 00028 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE 00029 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 00030 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 00031 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 00032 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 00033 00034 This software makes use of third party libraries. For more information see: 00035 doc/license.txt included in the distribution. 00036 ------------------------------------------------------------------------------- 00037 */ 00038 00039 #ifndef PLANK_SIMPLELINKEDLIST_H 00040 #define PLANK_SIMPLELINKEDLIST_H 00041 00042 #include "plank_SimpleLinkedListElement.h" 00043 00044 PLANK_BEGIN_C_LINKAGE 00045 00053 typedef struct PlankSimpleLinkedList* PlankSimpleLinkedListRef; 00054 00055 typedef PlankResult (*PlankSimpleLinkedListFreeElementDataFunction)(PlankP); 00056 00057 00058 PlankSimpleLinkedListRef pl_SimpleLinkedList_CreateAndInit(); 00059 PlankSimpleLinkedListRef pl_SimpleLinkedList_Create(); 00060 PlankResult pl_SimpleLinkedList_Init (PlankSimpleLinkedListRef p); 00061 PlankResult pl_SimpleLinkedList_DeInit (PlankSimpleLinkedListRef p); 00062 PlankResult pl_SimpleLinkedList_Destroy (PlankSimpleLinkedListRef p); 00063 PlankResult pl_SimpleLinkedList_Clear (PlankSimpleLinkedListRef p); 00064 PlankResult pl_SimpleLinkedList_SetFreeElementDataFunction (PlankSimpleLinkedListRef p, PlankSimpleLinkedListFreeElementDataFunction freeFunction); 00065 PlankResult pl_SimpleLinkedList_Add (PlankSimpleLinkedListRef p, const PlankSimpleLinkedListElementRef element); 00066 PlankResult pl_SimpleLinkedList_InsertAtIndex (PlankSimpleLinkedListRef p, const PlankLL index, const PlankSimpleLinkedListElementRef element); 00067 PlankResult pl_SimpleLinkedList_AtIndex (PlankSimpleLinkedListRef p, const PlankLL index, PlankSimpleLinkedListElementRef* element); 00068 PlankResult pl_SimpleLinkedList_GetFirst (PlankSimpleLinkedListRef p, PlankSimpleLinkedListElementRef* element); 00069 PlankResult pl_SimpleLinkedList_GetLast (PlankSimpleLinkedListRef p, PlankSimpleLinkedListElementRef* element); 00070 PlankResult pl_SimpleLinkedList_RemoveAtIndex (PlankSimpleLinkedListRef p, const PlankLL index, PlankSimpleLinkedListElementRef* element); 00071 PlankResult pl_SimpleLinkedList_RemoveFirst (PlankSimpleLinkedListRef p, PlankSimpleLinkedListElementRef* element); 00072 PlankResult pl_SimpleLinkedList_RemoveLast (PlankSimpleLinkedListRef p, PlankSimpleLinkedListElementRef* element); 00073 PlankResult pl_SimpleLinkedList_IndexOf (PlankSimpleLinkedListRef p, const PlankSimpleLinkedListElementRef element, PlankLL* index); 00074 PlankLL pl_SimpleLinkedList_GetSize (PlankSimpleLinkedListRef p); 00075 00078 PLANK_END_C_LINKAGE 00079 00080 #if !DOXYGEN 00081 typedef struct PlankSimpleLinkedList 00082 { 00083 PlankSimpleLinkedListElementRef first; 00084 PlankSimpleLinkedListFreeElementDataFunction freeFunction; 00085 } PlankSimpleLinkedList; 00086 #endif 00087 00088 #endif // PLANK_SIMPLELINKEDLIST_H
