annotate DynArray.h @ 14:9de0a9369134

added eol handling and .brch__default to indicate brch (and reason for it)
author Me@portablequad
date Sat, 11 Feb 2012 17:43:20 -0800
parents f9776626259b
children 62b3a4793b6e
rev   line source
Me@3 1 /*
Me@3 2 * File: Vector.h
Me@3 3 * Author: Me
Me@3 4 *
Me@3 5 * Created on May 14, 2010, 3:08 PM
Me@3 6 */
Me@3 7
Me@4 8 #ifndef _DYNARRAY_H
Me@4 9 #define _DYNARRAY_H
Me@3 10
Me@4 11
Me@4 12 //A dynamic array is same as any other array, but add a DynArrayInfo next
Me@4 13 // to it. Accesses and updates of array indexes are done normally, it's
Me@4 14 // only when add a new element into array that use the extra info.
Me@4 15 // An add can cause the pointer to the normal array to change.. so must
Me@4 16 // be protected to single VP at a time.
Me@3 17 typedef struct
Me@3 18 {
Me@4 19 void ***addrOfPtrToArray; //addr of array of ptrs == triple *
Me@4 20 int32 numInArray;
Me@4 21 int32 sizeOfArray;
Me@3 22 }
Me@14 23 PrivDynArrayInfo;
Me@3 24
Me@14 25 PrivDynArrayInfo *
Me@14 26 makePrivDynArrayInfoFrom( void ***addrOfPtrToArray, int32 sizeOfArray );
Me@3 27
Me@14 28 PrivDynArrayInfo *
Me@14 29 makePrivDynArrayOfSize( void ***addrOfPtrToArray, int32 sizeOfArray );
Me@14 30
Me@14 31 PrivDynArrayInfo *
Me@14 32 makePrivDynArrayOfSize_Ext( void ***addrOfPtrToArray, int32 sizeOfArray );
Me@3 33
Me@4 34 int32
Me@14 35 addToDynArray( void *value, PrivDynArrayInfo *info );
Me@3 36
Me@4 37 void
Me@14 38 makeHighestDynArrayIndexBe( PrivDynArrayInfo *info, int32 highestIndex );
Me@4 39
Me@4 40 void
Me@14 41 makeHighestDynArrayIndexBeAtLeast(PrivDynArrayInfo *info,int32 highestIndex);
Me@14 42
Me@14 43 void
Me@14 44 increaseSizeOfDynArrayTo( PrivDynArrayInfo *info, int32 newSize );
Me@4 45
Me@4 46 typedef void (*FreeFnPtr) ( void * ); //fn has to cast void * to whatever
Me@4 47
Me@4 48 void
Me@14 49 freeDynArrayDeep( PrivDynArrayInfo *info, FreeFnPtr freeFnPtr );
Me@4 50
Me@4 51 void
Me@14 52 freeDynArrayFlat( PrivDynArrayInfo *info );
Me@4 53
Me@4 54
Me@4 55 typedef void (*DynArrayFnPtr) ( void * ); //fn has to cast void *
Me@4 56
Me@4 57 void
Me@14 58 forAllInDynArrayDo( PrivDynArrayInfo *info, DynArrayFnPtr fnPtr );
Me@4 59
Me@4 60 #endif /* _DYNARRAY_H */
Me@4 61