plank_DynamicArray.h

/*
 -------------------------------------------------------------------------------
 This file is part of the Plink, Plonk, Plank libraries
  by Martin Robinson
 
 http://code.google.com/p/pl-nk/
 
 Copyright University of the West of England, Bristol 2011-14
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 
 * Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
 * 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.
 * Neither the name of University of the West of England, Bristol nor 
   the names of its contributors may be used to endorse or promote products
   derived from this software without specific prior written permission.
 
 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 UNIVERSITY OF THE WEST OF ENGLAND, BRISTOL 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. 
 
 This software makes use of third party libraries. For more information see:
 doc/license.txt included in the distribution.
 -------------------------------------------------------------------------------
 */

#ifndef PLANK_DYNAMICARRAY_H
#define PLANK_DYNAMICARRAY_H

#define PLANKDYNAMICARRAY_DEFAULTGRANULARITY 8
#define PLANKDYNAMICARRAY_DEFAULTITEMSIZE 4

PLANK_BEGIN_C_LINKAGE

typedef struct PlankDynamicArray* PlankDynamicArrayRef; 

typedef PlankB (*PlankDynamicArrayCompareFunction)(PlankP, PlankP);

PlankDynamicArrayRef pl_DynamicArray_CreateAndInit();

PlankDynamicArrayRef pl_DynamicArray_Create();

PlankResult pl_DynamicArray_Init (PlankDynamicArrayRef p);

PlankResult pl_DynamicArray_InitCopy (PlankDynamicArrayRef p, PlankDynamicArrayRef original);


PlankResult pl_DynamicArray_InitWithItemSize (PlankDynamicArrayRef p, const PlankL itemSize);

PlankResult pl_DynamicArray_InitWithItemSizeAndCapacity (PlankDynamicArrayRef p, const PlankL itemSize, const PlankL initialCapacity);

PlankResult pl_DynamicArray_InitWithItemSizeAndSize (PlankDynamicArrayRef p, const PlankL itemSize, const PlankL initialCapacity, PlankB zero);

PlankResult pl_DynamicArray_DeInit (PlankDynamicArrayRef p);

PlankResult pl_DynamicArray_Destroy (PlankDynamicArrayRef p);

PlankB pl_DynamicArray_IsIndexInRange (PlankDynamicArrayRef p, const PlankL index);

PlankL pl_DynamicArray_GetSize (PlankDynamicArrayRef p);

PlankL pl_DynamicArray_GetItemSize (PlankDynamicArrayRef p);


PlankResult pl_DynamicArray_SetSize (PlankDynamicArrayRef p, const PlankL capacity);

PlankResult pl_DynamicArray_Zero (PlankDynamicArrayRef p);


PlankP pl_DynamicArray_GetArray (PlankDynamicArrayRef p);

PlankResult pl_DynamicArray_AddItem (PlankDynamicArrayRef p, const PlankP item);

PlankResult pl_DynamicArray_AddItems (PlankDynamicArrayRef p, PlankConstantP items, const PlankL numItems);

PlankResult pl_DynamicArray_SetItem (PlankDynamicArrayRef p, const PlankL index, const PlankP item);

PlankResult pl_DynamicArray_SetAsClearText (PlankDynamicArrayRef p, const PlankL length);

PlankResult pl_DynamicArray_SetAsText (PlankDynamicArrayRef p, const char* text);

PlankResult pl_DynamicArray_AppendText (PlankDynamicArrayRef p, const char* text);

PlankResult pl_DynamicArray_AppendTextLine (PlankDynamicArrayRef p, const char* text, const char* seps);
PlankResult pl_DynamicArray_AppendTextLineLF (PlankDynamicArrayRef p, const char* text);
PlankResult pl_DynamicArray_AppendTextLineCRLF (PlankDynamicArrayRef p, const char* text);



PlankResult pl_DynamicArray_InsertItem (PlankDynamicArrayRef p, const PlankL index, const PlankP item);

PlankResult pl_DynamicArray_GetItem (PlankDynamicArrayRef p, const PlankL index, PlankP item);

PlankResult pl_DynamicArray_PutItem (PlankDynamicArrayRef p, const PlankL index, PlankP item);

PlankResult pl_DynamicArray_RemoveItem (PlankDynamicArrayRef p, const PlankL index);

PlankResult pl_DynamicArray_Sort (PlankDynamicArrayRef p, PlankDynamicArrayCompareFunction comparator);

PlankResult pl_DynamicArray_EnsureSize (PlankDynamicArrayRef p, const PlankL capacity);

PlankResult pl_DynamicArray_Grow (PlankDynamicArrayRef p, const int amount);

PlankResult pl_DynamicArray_Purge (PlankDynamicArrayRef p);

PLANK_END_C_LINKAGE

#if !DOXYGEN
typedef struct PlankDynamicArray
{
    PlankL itemSize;
    PlankL allocatedItems;
    PlankL usedItems;
    PlankP data;
} PlankDynamicArray;
#endif

#endif // PLANK_DYNAMICARRAY_H