data_support/ccCArray(c 数组)

/**

 There are 2 kind of functions://前者更快 因为使用指针

 - ccArray functions that manipulates objective-c objects (retain and release are performed)

 - ccCArray functions that manipulates values like if they were standard C structures (no retain/release is performed)

 */

#ifndef CC_ARRAY_H

#define CC_ARRAY_H

#include "ccMacros.h"

#include "cocoa/CCObject.h"

#include <stdlib.h>

#include <string.h>

#include <limits.h>

NS_CC_BEGIN

#define CC_INVALID_INDEX 0xffffffff

// Easy integration（集成 综合）

#define CCARRAYDATA_FOREACH(__array__, __object__)\

__object__=__array__->arr[0]; for(unsigned int i=0, num=__array__->num; i<num; i++, __object__=__array__->arr[i])\

typedef struct _ccArray {

unsigned int num, max;

CCObject** arr;

} ccArray;

/** Allocates（分配） and initializes a new array with specified capacity（能力 容量） */

ccArray* ccArrayNew(unsigned int capacity);

/** Frees array after removing all remaining objects. Silently ignores nil arr. */

void ccArrayFree(ccArray*& arr);

/** Doubles array capacity */

void ccArrayDoubleCapacity(ccArray *arr);

/** Increases array capacity such that max >= num + extra. */

void ccArrayEnsureExtraCapacity(ccArray *arr, unsigned int extra);

/** shrinks the array so the memory footprint corresponds with the number of items */

void ccArrayShrink(ccArray *arr);

/** Returns index of first occurrence of object, NSNotFound if object not found. */

unsigned int ccArrayGetIndexOfObject(ccArray *arr, CCObject* object);

/** Returns a Boolean value that indicates whether object is present in array. */

bool ccArrayContainsObject(ccArray *arr, CCObject* object);

/** Appends an object. Behavior undefined if array doesn't have enough capacity. */

void ccArrayAppendObject(ccArray *arr, CCObject* object);

/** Appends an object. Capacity of arr is increased if needed. */

void ccArrayAppendObjectWithResize(ccArray *arr, CCObject* object);

/** Appends objects from plusArr to arr. 

 Behavior undefined if arr doesn't have enough capacity. */

void ccArrayAppendArray(ccArray *arr, ccArray *plusArr);

/** Appends objects from plusArr to arr. Capacity of arr is increased if needed. */

void ccArrayAppendArrayWithResize(ccArray *arr, ccArray *plusArr);

/** Inserts an object at index */

void ccArrayInsertObjectAtIndex(ccArray *arr, CCObject* object, unsigned int index);

/** Swaps two objects */

void ccArraySwapObjectsAtIndexes(ccArray *arr, unsigned int index1, unsigned int index2);

/** Removes all objects from arr */

void ccArrayRemoveAllObjects(ccArray *arr);

/** Removes object at specified index and pushes back all subsequent objects.

 Behavior undefined if index outside [0, num-1]. */

void ccArrayRemoveObjectAtIndex(ccArray *arr, unsigned int index, bool bReleaseObj = true);

/** Removes object at specified index and fills the gap with the last object,

 thereby avoiding the need to push back subsequent objects.

 Behavior undefined if index outside [0, num-1]. */

void ccArrayFastRemoveObjectAtIndex(ccArray *arr, unsigned int index);

void ccArrayFastRemoveObject(ccArray *arr, CCObject* object);

/** Searches for the first occurrence of object and removes it. If object is not

 found the function has no effect. */

void ccArrayRemoveObject(ccArray *arr, CCObject* object, bool bReleaseObj = true);

/** Removes from arr all objects in minusArr. For each object in minusArr, the

 first matching instance in arr will be removed. */

void ccArrayRemoveArray(ccArray *arr, ccArray *minusArr);

/** Removes from arr all objects in minusArr. For each object in minusArr, all

 matching instances in arr will be removed. */

void ccArrayFullRemoveArray(ccArray *arr, ccArray *minusArr);

// #pragma mark -

// #pragma mark ccCArray for Values (c structures)

typedef struct _ccCArray {

    unsigned int num, max;

    void** arr;

} ccCArray;

/** Allocates and initializes a new C array with specified capacity */

ccCArray* ccCArrayNew(unsigned int capacity);

/** Frees C array after removing all remaining values. Silently ignores nil arr. */

void ccCArrayFree(ccCArray *arr);

/** Doubles C array capacity */

void ccCArrayDoubleCapacity(ccCArray *arr);

/** Increases array capacity such that max >= num + extra. */

void ccCArrayEnsureExtraCapacity(ccCArray *arr, unsigned int extra);

/** Returns index of first occurrence of value, NSNotFound if value not found. */

unsigned int ccCArrayGetIndexOfValue(ccCArray *arr, void* value);

/** Returns a Boolean value that indicates whether value is present in the C array. */

bool ccCArrayContainsValue(ccCArray *arr, void* value);

/** Inserts a value at a certain position. Behavior undefined if array doesn't have enough capacity */

void ccCArrayInsertValueAtIndex( ccCArray *arr, void* value, unsigned int index);

/** Appends an value. Behavior undefined if array doesn't have enough capacity. */

void ccCArrayAppendValue(ccCArray *arr, void* value);

/** Appends an value. Capacity of arr is increased if needed. */

void ccCArrayAppendValueWithResize(ccCArray *arr, void* value);

/** Appends values from plusArr to arr. Behavior undefined if arr doesn't have

 enough capacity. */

void ccCArrayAppendArray(ccCArray *arr, ccCArray *plusArr);

/** Appends values from plusArr to arr. Capacity of arr is increased if needed. */

void ccCArrayAppendArrayWithResize(ccCArray *arr, ccCArray *plusArr);

/** Removes all values from arr */

void ccCArrayRemoveAllValues(ccCArray *arr);

/** Removes value at specified index and pushes back all subsequent values.

 Behavior undefined if index outside [0, num-1].

 @since v0.99.4

 */

void ccCArrayRemoveValueAtIndex(ccCArray *arr, unsigned int index);

/** Removes value at specified index and fills the gap with the last value,

 thereby avoiding the need to push back subsequent values.

 Behavior undefined if index outside [0, num-1].

 @since v0.99.4

 */

void ccCArrayFastRemoveValueAtIndex(ccCArray *arr, unsigned int index);

/** Searches for the first occurrence of value and removes it. If value is not found the function has no effect.

 @since v0.99.4

 */

void ccCArrayRemoveValue(ccCArray *arr, void* value);

/** Removes from arr all values in minusArr. For each Value in minusArr, the first matching instance in arr will be removed.

 @since v0.99.4

 */

void ccCArrayRemoveArray(ccCArray *arr, ccCArray *minusArr);

/** Removes from arr all values in minusArr. For each value in minusArr, all matching instances in arr will be removed.

 @since v0.99.4

 */

void ccCArrayFullRemoveArray(ccCArray *arr, ccCArray *minusArr);

NS_CC_END

#endif // CC_ARRAY_H