Dictionary Struct Reference

#include <Dictionary.h>

Overview

Immutable key-value stores.

Definition at line 60 of file Dictionary.h.

Inheritance diagram for Dictionary:

Properties
size_t	count
	The count of elements. More...
Object	object
	The superclass. More...
Properties inherited from Object
Class *	clazz
	Every instance of Object begins with a pointer to its Class. More...

Methods
Class *	_Dictionary (void)
	The Dictionary archetype. More...
Array *	allKeys (const Dictionary *self)
Array *	allObjects (const Dictionary *self)
_Bool	containsKey (const Dictionary *self, const ident key)
_Bool	containsKeyPath (const Dictionary *self, const char *path)
Dictionary *	dictionaryWithDictionary (const Dictionary *dictionary)
	Returns a new Dictionary containing all pairs from dictionary. More...
Dictionary *	dictionaryWithObjectsAndKeys (ident obj,...)
	Returns a new Dictionary containing pairs from the given arguments. More...
void	enumerateObjectsAndKeys (const Dictionary *self, DictionaryEnumerator enumerator, ident data)
	Enumerate the pairs of this Dictionary with the given function. More...
Dicionary *	filterObjectsAndKeys (const Dictionary *self, DictionaryPredicate predicate, ident data)
	Creates a new Dictionary with pairs that pass the filter function. More...
Dictionary *	initWithDictionary (Dictionary *self, const Dictionary *dictionary)
	Initializes this Dictionary to contain elements of dictionary. More...
Dictionary *	initWithObjectsAndKeys (Dictionary *self,...)
	Initializes this Dictionary with the NULL-terminated list of Objects and keys. More...
MutableDictionary *	mutableCopy (const Dictionary *self)
ident	objectForKey (const Dictionary *self, const ident key)
ident	objectForKeyPath (const Dictionary *self, const char *path)
Methods inherited from Object
Class *	_Object (void)
	The Object archetype. More...
Object *	copy (const Object *self)
	Creates a shallow copy of this Object. More...
void	dealloc (Object *self)
	Frees all resources held by this Object. More...
String *	description (const Object *self)
int	hash (const Object *self)
Object *	init (Object *self)
	Initializes this Object. More...
_Bool	isEqual (const Object *self, const Object *other)
	Tests equality of the other Object. More...
_Bool	isKindOfClass (const Object *self, const Class *clazz)
	Tests for Class hierarchy membership. More...

Protected Attributes
DictionaryInterface *	interface
	The interface. More...
Protected Attributes inherited from Object
ObjectInterface *	interface
	The interface. More...

Property Details

count

size_t Dictionary::count

The count of elements.

Definition at line 82 of file Dictionary.h.

interface

DictionaryInterface* Dictionary::interface

protected

The interface.

Definition at line 71 of file Dictionary.h.

object

Object Dictionary::object

The superclass.

Definition at line 65 of file Dictionary.h.

Method Details

_Dictionary()

Class * _Dictionary

(

void

)

The Dictionary archetype.

Returns

The Dictionary Class.

Definition at line 451 of file Dictionary.c.

                         {
    static Class *clazz;
    static Once once;
 
    do_once(&once, {
        clazz = _initialize(&(const ClassDef) {
            .name = "Dictionary",
            .superclass = _Object(),
            .instanceSize = sizeof(Dictionary),
            .interfaceOffset = offsetof(Dictionary, interface),
            .interfaceSize = sizeof(DictionaryInterface),
            .initialize = initialize,
        });
    });
 
    return clazz;
}

allKeys()

Array * allKeys

(

const Dictionary *

self

)

Parameters

self	The Dictionary.

Returns

An Array containing all keys in this Dictionary.

Definition at line 169 of file Dictionary.c.

                                              {
 
    MutableArray *keys = $(alloc(MutableArray), initWithCapacity, self->count);
 
    $(self, enumerateObjectsAndKeys, allKeys_enumerator, keys);
 
    return (Array *) keys;
}

allObjects()

Array * allObjects

(

const Dictionary *

self

)

Parameters

self	The Dictionary.

Returns

An Array containing all Objects in this Dictionary.

Definition at line 189 of file Dictionary.c.

                                                 {
 
    MutableArray *objects = $(alloc(MutableArray), initWithCapacity, self->count);
 
    $(self, enumerateObjectsAndKeys, allObjects_enumerator, objects);
 
    return (Array *) objects;
}

containsKey()

_Bool containsKey	(	const Dictionary *	self,
		const ident	key
	)

Parameters

self	The Dictionary.
key	The key to test.

Returns

True if this Dictionary contains the specified key, false otherwise.

Definition at line 202 of file Dictionary.c.

                                                                  {
    return $(self, objectForKey, key) != NULL;
}

containsKeyPath()

_Bool containsKeyPath	(	const Dictionary *	self,
		const char *	path
	)

Parameters

self	The Dictionary.
path	The key path to test.

Returns

True if this Dictionary contains the specified key path, false otherwise.

Definition at line 210 of file Dictionary.c.

                                                                       {
    return $(self, objectForKeyPath, path) != NULL;
}

dictionaryWithDictionary()

Dictionary * dictionaryWithDictionary

(

const Dictionary *

dictionary

)

Returns a new Dictionary containing all pairs from dictionary.

Parameters

dictionary

A Dictionary.

Returns

The new Dictionary, or NULL on error.

Definition at line 218 of file Dictionary.c.

                                                                          {
 
    return $(alloc(Dictionary), initWithDictionary, dictionary);
}

dictionaryWithObjectsAndKeys()

Dictionary * dictionaryWithObjectsAndKeys	(	ident	obj,
			...
	)

Returns a new Dictionary containing pairs from the given arguments.

Parameters

obj	The first in a NULL-terminated list of Objects and keys.

Returns

The new Dictionary, or NULL on error.

Definition at line 227 of file Dictionary.c.

                                                                {
 
    Dictionary *dict = (Dictionary *) $((Object *) alloc(Dictionary), init);
    if (dict) {
 
        va_list args;
        va_start(args, obj);
 
        while (obj) {
            ident key = va_arg(args, ident);
 
            $$(MutableDictionary, setObjectForKey, (MutableDictionary *) dict, obj, key);
 
            obj = va_arg(args, ident);
        }
 
        va_end(args);
    }
 
    return dict;
}

enumerateObjectsAndKeys()

void enumerateObjectsAndKeys	(	const Dictionary *	self,
		DictionaryEnumerator	enumerator,
		ident	data
	)

Enumerate the pairs of this Dictionary with the given function.

Parameters

self	The Dictionary.
enumerator	The enumerator function.
data	User data.

Remarks

The enumerator should return true to break the iteration.

Definition at line 253 of file Dictionary.c.

                    {
 
    assert(enumerator);
 
    for (size_t i = 0; i < self->capacity; i++) {
 
        Array *array = self->elements[i];
        if (array) {
 
            for (size_t j = 0; j < array->count; j += 2) {
 
                ident key = $(array, objectAtIndex, j);
                ident obj = $(array, objectAtIndex, j + 1);
 
                enumerator(self, obj, key, data);
            }
        }
    }
}

filterObjectsAndKeys()

Dictionary * filterObjectsAndKeys	(	const Dictionary *	self,
		DictionaryPredicate	predicate,
		ident	data
	)

Creates a new Dictionary with pairs that pass the filter function.

Parameters

self	The Dictionary.
predicate	The predicate function.
data	User data.

Returns

The new, filtered Dictionary.

Definition at line 278 of file Dictionary.c.

                                                                                                           {
 
    assert(predicate);
 
    MutableDictionary *dictionary = $(alloc(MutableDictionary), init);
 
    for (size_t i = 0; i < self->capacity; i++) {
 
        Array *array = self->elements[i];
        if (array) {
 
            for (size_t j = 0; j < array->count; j += 2) {
 
                ident key = $(array, objectAtIndex, j);
                ident obj = $(array, objectAtIndex, j + 1);
 
                if (predicate(obj, key, data)) {
                    $(dictionary, setObjectForKey, obj, key);
                }
            }
        }
    }
 
    return (Dictionary *) dictionary;
}

initWithDictionary()

Dictionary * initWithDictionary	(	Dictionary *	self,
		const Dictionary *	dictionary
	)

Initializes this Dictionary to contain elements of dictionary.

Parameters

self	The Dictionary.
dictionary	A Dictionary.

Returns

The initialized Dictionary, or NULL on error.

Definition at line 308 of file Dictionary.c.

                                                                                      {
 
    self = (Dictionary *) super(Object, self, init);
    if (self) {
        if (dictionary) {
 
            self->capacity = dictionary->capacity;
 
            self->elements = calloc(self->capacity, sizeof(ident));
            assert(self->elements);
 
            for (size_t i = 0; i < dictionary->capacity; i++) {
 
                Array *array = dictionary->elements[i];
                if (array) {
                    self->elements[i] = $((Object *) array, copy);
                }
            }
 
            self->count = dictionary->count;
        }
    }
 
    return self;
}

initWithObjectsAndKeys()

Dictionary * initWithObjectsAndKeys	(	Dictionary *	self,
			...
	)

Initializes this Dictionary with the NULL-terminated list of Objects and keys.

Parameters

self	The Dictionary.

Returns

The initialized Dictionary, or NULL on error.

Definition at line 338 of file Dictionary.c.

                                                                 {
 
    self = (Dictionary *) super(Object, self, init);
    if (self) {
 
        va_list args;
        va_start(args, self);
 
        while (true) {
 
            ident obj = va_arg(args, ident);
            if (obj) {
 
                ident key = va_arg(args, ident);
                $$(MutableDictionary, setObjectForKey, (MutableDictionary *) self, obj, key);
            } else {
                break;
            }
        }
 
        va_end(args);
    }
 
    return self;
}

mutableCopy()

MutableDictionary * mutableCopy

(

const Dictionary *

self

)

Parameters

self	The Dictionary.

Returns

A MutableDictionary with the contents of this Dictionary.

Definition at line 368 of file Dictionary.c.

                                                              {
 
    MutableDictionary *copy = $(alloc(MutableDictionary), initWithCapacity, self->count);
    if (copy) {
        $(copy, addEntriesFromDictionary, self);
    }
 
    return copy;
}

objectForKey()

ident objectForKey	(	const Dictionary *	self,
		const ident	key
	)

Parameters

self	The Dictionary.
key	The key.

Returns

The Object stored at the specified key in this Dictionary.

Definition at line 382 of file Dictionary.c.

                                                                   {
 
    if (self->capacity == 0) {
        return NULL;
    }
    
    const size_t bin = HashForObject(HASH_SEED, key) % self->capacity;
 
    Array *array = self->elements[bin];
    if (array) {
 
        const ssize_t index = $(array, indexOfObject, key);
        if (index > -1 && (index & 1) == 0) {
            return $(array, objectAtIndex, index + 1);
        }
    }
 
    return NULL;
}

objectForKeyPath()

ident objectForKeyPath	(	const Dictionary *	self,
		const char *	path
	)

Parameters

self	The Dictionary.
path	The key path.

Returns

The Object stored at the specified key path in this Dictionary.

Definition at line 406 of file Dictionary.c.

                                                                        {
 
    assert(path);
 
    String *key = str(path);
 
    ident obj = $(self, objectForKey, key);
 
    release(key);
 
    return obj;
}

---

The documentation for this struct was generated from the following files:

• Sources/Objectively/Dictionary.h
• Sources/Objectively/Dictionary.c