CNDictionary.h File Reference

Define CNDictionary data structure. More...

#include "CNForwarders.h"
#include "CNFixedString.h"
#include "CNArray.h"

Go to the source code of this file.

Classes
struct	CNDictionary
	Dictionary of pointer. More...

Macros
#define	CNHashTableSizeOfDictionary   64

Typedefs
typedef void(*	CNReleaseDictionaryItemFuncRef )(void *item, struct CNResource *resource)
typedef CNBoolean(*	CNVisitElementOfDictionaryFuncRef )(const struct CNFixedString *key, void *src, void *info)

Functions
void	CNInitDictionary (struct CNDictionary *dst, CNReleaseDictionaryItemFuncRef func, struct CNResource *resource)
	Initialize CNDictionary. More...
void	CNDestroyDictionary (struct CNDictionary *dst)
	Deallocate CNDictionary. More...
static size_t	CNCountOfDictionary (const struct CNDictionary *src)
	Number of items in dictionary. More...
static struct CNResource *	CNResourceOfDictionary (struct CNDictionary *src)
	Get resource fot the dictionary. More...
void *	CNSearchDataInDictionary (const struct CNDictionary *dict, const struct CNFixedString *key)
	Search data in data dictionary. More...
void	CNSetDataToDictionary (struct CNDictionary *dict, const struct CNFixedString *key, void *value)
	Set data for key to CNDictionary. More...
CNBoolean	CNVisitElementOfDictionary (const struct CNDictionary *src, CNVisitElementOfDictionaryFuncRef visitfunc, void *info)
	Visit all elements in the dictionary. More...

Detailed Description

Define CNDictionary data structure.

Copyright

Copyright (C) 2012 Steel Wheels Project

Macro Definition Documentation

#define CNHashTableSizeOfDictionary   64

Max hash table size of CNDictionary

Typedef Documentation

typedef void(* CNReleaseDictionaryItemFuncRef)(void *item, struct CNResource *resource)

Function to destroy the item in CNDictionary

typedef CNBoolean(* CNVisitElementOfDictionaryFuncRef)(const struct CNFixedString *key, void *src, void *info)

The function to visit the element in CNDictionary

Function Documentation

void CNInitDictionary	(	struct CNDictionary *	dst,
		CNReleaseDictionaryItemFuncRef	func,
		struct CNResource *	resource
	)

Initialize CNDictionary.

Parameters

dst	Destination dictionary
func	Function to release dictionary item
resource	Resource to allocate dictionary

void CNDestroyDictionary

(

struct CNDictionary *

dst

)

Deallocate CNDictionary.

Parameters

dst	Destination dictionary

Referenced by CNDestroyObjectDictionary().

static size_t CNCountOfDictionary ( const struct CNDictionary *  src )

inlinestatic

Number of items in dictionary.

Returns

Number of items

Parameters

src	Source dictionary

References CNDictionary::itemCount.

Referenced by CNCountOfObjectDictionary().

static struct CNResource* CNResourceOfDictionary ( struct CNDictionary *  src )

static

Get resource fot the dictionary.

Returns

Resource of this dictionary

Parameters

src	Source dictionary

References CNDictionary::resource.

Referenced by CNResourceOfObjectDictionary().

void* CNSearchDataInDictionary	(	const struct CNDictionary *	dict,
		const struct CNFixedString *	key
	)

Search data in data dictionary.

Return values

obj	Matched data
NULL	No matched data

Parameters

dict	Source dictionary
key	Key string

Referenced by CNSearchObjectInDictionary().

void CNSetDataToDictionary	(	struct CNDictionary *	dict,
		const struct CNFixedString *	key,
		void *	value
	)

Set data for key to CNDictionary.

Parameters

dict	Destination dictionary
key	Key string
value	Value

Referenced by CNSetObjectToDictionary().

CNBoolean CNVisitElementOfDictionary	(	const struct CNDictionary *	src,
		CNVisitElementOfDictionaryFuncRef	visitfunc,
		void *	info
	)

Visit all elements in the dictionary.

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

Referenced by CNVisitElementOfObjectDictionary().