CNObjectArray.h File Reference

Define CNObjectArray data structure. More...

#include "CNArray.h"
#include "CNObject.h"

Go to the source code of this file.

Classes
struct	CNObjectArray
	Array of instances. More...

Functions
static void	CNInitObjectArray (struct CNObjectArray *dst, struct CNResource *resource)
	Initialize instance array. More...
void	CNDestroyObjectArray (struct CNObjectArray *dst)
	Destroy instance array. More...
static struct CNResource *	CNResourceOfObjectArray (struct CNObjectArray *src)
	Get resource of object array. More...
static uint64_t	CNCountOfObjectArray (const struct CNObjectArray *src)
	Get the count of elements in the array. More...
static void	CNSetObjectToArray (struct CNObjectArray *dst, uint64_t index, struct CNObject *src)
	Set objectto the array at the given index. More...
static void	CNAddObjectToArray (struct CNObjectArray *dst, struct CNObject *src)
	Add object as the last element of the array. More...
static struct CNObject *	CNObjectInArray (const struct CNObjectArray *src, uint64_t index)
	Get object in the array. More...
struct CNObjectList	CNElementListOfObjectArray (const struct CNObjectArray *src, struct CNResource *resource)
	Make object list of array. More...
static CNBoolean	CNVisitElementOfObjectArray (const struct CNObjectArray *src, CNVisitElementOfArrayFuncRef visitfunc, void *info)
	Visit all elements in the array. More...

Detailed Description

Define CNObjectArray data structure.

Copyright

Copyright (C) 2011 Steel Wheels Project

Function Documentation

static void CNInitObjectArray ( struct CNObjectArray *  dst, struct CNResource *  resource  )

inlinestatic

Initialize instance array.

Parameters

dst	Destination array
resource	Resource to allocate the array

References CNInitArray(), and CNObjectArray::coreArray.

void CNDestroyObjectArray

(

struct CNObjectArray *

dst

)

Destroy instance array.

Parameters

dst	Destination array

static struct CNResource* CNResourceOfObjectArray ( struct CNObjectArray *  src )

static

Get resource of object array.

Returns

Resource of object array

Parameters

src	Source object array

References CNResourceOfArray(), and CNObjectArray::coreArray.

static uint64_t CNCountOfObjectArray ( const struct CNObjectArray *  src )

inlinestatic

Get the count of elements in the array.

Returns

Count of elements

Parameters

src	Source array

References CNCountOfArray(), and CNObjectArray::coreArray.

Referenced by CNAddObjectToArray().

static void CNSetObjectToArray ( struct CNObjectArray *  dst, uint64_t  index, struct CNObject *  src  )

inlinestatic

Set objectto the array at the given index.

Parameters

dst	Destination array
index	Index of the array to set
src	Souce object to be set

Note

The source object is retained in this function

References CNReleaseObject(), CNRetainObject(), CNSetPointerToArray(), and CNObjectArray::coreArray.

static void CNAddObjectToArray ( struct CNObjectArray *  dst, struct CNObject *  src  )

inlinestatic

Add object as the last element of the array.

Parameters

dst	Destination array
src	Source pointer

References CNCountOfObjectArray(), CNRetainObject(), CNSetPointerToArray(), and CNObjectArray::coreArray.

static struct CNObject* CNObjectInArray ( const struct CNObjectArray *  src, uint64_t  index  )

static

Get object in the array.

Return values

insance	Instance in the array
null	No instance at the given index

Parameters

src	Source instance array
index	Index to choose element

References CNPointerInArray(), and CNObjectArray::coreArray.

struct CNObjectList CNElementListOfObjectArray	(	const struct CNObjectArray *	src,
		struct CNResource *	resource
	)

Make object list of array.

Returns

List of elements

Parameters

src	Source object array
resource	Resource to allocate the list

static CNBoolean CNVisitElementOfObjectArray ( const struct CNObjectArray *  src, CNVisitElementOfArrayFuncRef  visitfunc, void *  info  )

inlinestatic

Visit all elements in the array.

Return values

TRUE	All elements are visited
FALSE	All elements are NOT visited

Parameters

src	Source array
visitfunc	Function which is called foreach elements
info	Additiona parameter for visit function

References CNVisitElementOfArray(), and CNObjectArray::coreArray.