KEDictionary.h File Reference

Dictionary of KEValue objects. More...

#include <Coconut/Coconut.h>
#include "KEObject.h"
#include "KEForwarders.h"

Go to the source code of this file.

Data Structures
struct	KEDictionary
	Dictionary class. The key is CNString and the value is KEValue. More...

Macros
#define	KESizeOfDictionaryHashTable   64

Functions
struct KEDictionary *	KEAllocateDictionary (struct CNResource *resource)
	Allocate dictionary. More...
void	KESetValueToDictionary (struct KEDictionary *dst, struct CNString *key, struct KEValue *val)
	Set value to dictionary. More...
struct KEValue *	KEValueInDictionary (struct KEDictionary *src, struct CNString *key)
	Get value in the dictionary by the key. More...
struct CNObjectList	KEKeysInDictionary (struct KEDictionary *src, struct CNResource *resource)
	Get string keys from dictionary. More...
void	KEDumpDictionary (struct CNText *outbuf, struct KEDictionary *src)
	Dump all elements in value dictionary. More...

Detailed Description

Dictionary of KEValue objects.

Copyright

Copyright (C) 2013 Steel Wheels Project

Macro Definition Documentation

#define KESizeOfDictionaryHashTable   64

The size of hash table in the KEDictionary

Function Documentation

struct KEDictionary* KEAllocateDictionary

(

struct CNResource *

resource

)

Allocate dictionary.

Returns

Allocated dictionary

Parameters

resource

Resource to allocate the dictionary

void KEDumpDictionary	(	struct CNText *	outbuf,
		struct KEDictionary *	src
	)

Dump all elements in value dictionary.

Parameters

outbuf	Output buffer
src	Source value array

struct CNObjectList KEKeysInDictionary	(	struct KEDictionary *	src,
		struct CNResource *	resource
	)

Get string keys from dictionary.

Returns

List of CNString objects

Parameters

src	Source dictionary
resource	Resource to allocate the list

void KESetValueToDictionary	(	struct KEDictionary *	dst,
		struct CNString *	key,
		struct KEValue *	val
	)

Set value to dictionary.

Parameters

dst	Destination dictionary
key	Key of the source data
val	Value of the source data

struct KEValue* KEValueInDictionary	(	struct KEDictionary *	src,
		struct CNString *	key
	)

Get value in the dictionary by the key.

Return values

val	Value which has the key
NULL	There are no value with given key

Parameters

src	Source dictionary to be searched
key	Key to search the value