MutableDictionary Struct Reference

#include <MutableDictionary.h>

Overview

Mutable key-value stores.

Definition at line 40 of file MutableDictionary.h.

Inheritance diagram for MutableDictionary:

Properties
Dictionary	dictionary
	The superclass. More...
Properties inherited from Dictionary
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 *	_MutableDictionary (void)
	The MutableDictionary archetype. More...
void	addEntriesFromDictionary (MutableDictionary *self, const Dictionary *dictionary)
	Adds the key-value entries from dictionary to this MutableDictionary. More...
MutableDictionary *	dictionary (void)
	Returns a new MutableDictionary. More...
MutableDictionary *	dictionaryWithCapacity (size_t capacity)
	Returns a new MutableDictionary with the given capacity. More...
MutableDictionary *	init (MutableDictionary *self)
	Initializes this MutableDictionary. More...
MutableDictionary *	initWithCapacity (MutableDictionary *self, size_t capacity)
	Initializes this MutableDictionary with the specified capacity. More...
void	removeAllObjects (MutableDictionary *self)
	Removes all Objects from this MutableDictionary. More...
void	removeAllObjectsWithEnumerator (MutableDictionary *self, DictionaryEnumerator enumerator, ident data)
void	removeObjectForKey (MutableDictionary *self, const ident key)
	Removes the Object with the specified key from this MutableDictionary. More...
void	removeObjectForKeyPath (MutableDictionary *self, const char *path)
	Removes the Object with the specified key path from this MutableDictionary. More...
void	setObjectForKey (MutableDictionary *self, const ident obj, const ident key)
	Sets a pair in this MutableDictionary. More...
void	setObjectForKeyPath (MutableDictionary *self, const ident obj, const char *path)
	Sets a pair in this MutableDictionary. More...
void	setObjectsForKeyPaths (MutableDictionary *self,...)
	Sets pairs in this MutableDictionary from the NULL-terminated list. More...
void	setObjectsForKeys (MutableDictionary *self,...)
	Sets pairs in this MutableDictionary from the NULL-terminated list. More...
Methods inherited from Dictionary
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
MutableDictionaryInterface *	interface
	The interface. More...
Protected Attributes inherited from Dictionary
DictionaryInterface *	interface
	The interface. More...
Protected Attributes inherited from Object
ObjectInterface *	interface
	The interface. More...

Property Details

dictionary

MutableDictionary * dictionary

(

void

)

The superclass.

Definition at line 45 of file MutableDictionary.h.

interface

MutableDictionaryInterface* MutableDictionary::interface

protected

The interface.

Definition at line 51 of file MutableDictionary.h.

Method Details

_MutableDictionary()

Class * _MutableDictionary

(

void

)

The MutableDictionary archetype.

Returns

The MutableDictionary Class.

Definition at line 371 of file MutableDictionary.c.

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

addEntriesFromDictionary()

void addEntriesFromDictionary	(	MutableDictionary *	self,
		const Dictionary *	dictionary
	)

Adds the key-value entries from dictionary to this MutableDictionary.

Parameters

self	The MutableDictionary.
dictionary	A Dictionary.

Definition at line 68 of file MutableDictionary.c.

                                                                                            {
 
    assert(dictionary);
 
    $(dictionary, enumerateObjectsAndKeys, addEntriesFromDictionary_enumerator, self);
}

dictionary()

MutableDictionary * dictionary

(

void

)

Returns a new MutableDictionary.

Returns

The new MutableDictionary, or NULL on error.

Definition at line 79 of file MutableDictionary.c.

                                           {
 
    return $(alloc(MutableDictionary), init);
}

dictionaryWithCapacity()

MutableDictionary * dictionaryWithCapacity

(

size_t

capacity

)

Returns a new MutableDictionary with the given capacity.

Parameters

capacity

The desired initial capacity.

Returns

The new MutableDictionary, or NULL on error.

Definition at line 88 of file MutableDictionary.c.

                                                                  {
 
    return $(alloc(MutableDictionary), initWithCapacity, capacity);
}

init()

MutableDictionary * init

(

MutableDictionary *

self

)

Initializes this MutableDictionary.

Parameters

self	The MutableDictionary.

Returns

The initialized MutableDictionary, or NULL on error.

Definition at line 97 of file MutableDictionary.c.

                                                        {
 
    return $(self, initWithCapacity, MUTABLEDICTIONARY_DEFAULT_CAPACITY);
}

initWithCapacity()

MutableDictionary * initWithCapacity	(	MutableDictionary *	self,
		size_t	capacity
	)

Initializes this MutableDictionary with the specified capacity.

Parameters

self	The MutableDictionary.
capacity	The initial capacity.

Returns

The initialized MutableDictionary, or NULL on error.

Definition at line 106 of file MutableDictionary.c.

                                                                                     {
 
    self = (MutableDictionary *) super(Object, self, init);
    if (self) {
 
        self->dictionary.capacity = capacity;
        if (self->dictionary.capacity) {
 
            self->dictionary.elements = calloc(self->dictionary.capacity, sizeof(ident));
            assert(self->dictionary.elements);
        }
    }
 
    return self;
}

removeAllObjects()

void removeAllObjects

(

MutableDictionary *

self

)

Removes all Objects from this MutableDictionary.

Parameters

self	The MutableDictionary.

Definition at line 126 of file MutableDictionary.c.

                                                      {
 
    for (size_t i = 0; i < self->dictionary.capacity; i++) {
 
        Array *array = self->dictionary.elements[i];
        if (array) {
            self->dictionary.elements[i] = release(array);
        }
    }
 
    self->dictionary.count = 0;
}

removeAllObjectsWithEnumerator()

void removeAllObjectsWithEnumerator	(	MutableDictionary *	self,
		DictionaryEnumerator	enumerator,
		ident	data
	)

Definition at line 143 of file MutableDictionary.c.

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

removeObjectForKey()

void removeObjectForKey	(	MutableDictionary *	self,
		const ident	key
	)

Removes the Object with the specified key from this MutableDictionary.

Parameters

self	The MutableDictionary.
key	The key of the Object to remove.

Definition at line 173 of file MutableDictionary.c.

                                                                         {
 
    if (self->dictionary.capacity == 0) {
        return;
    }
    
    const size_t bin = HashForObject(HASH_SEED, key) % self->dictionary.capacity;
 
    MutableArray *array = self->dictionary.elements[bin];
    if (array) {
 
        const ssize_t index = $((Array *) array, indexOfObject, key);
        if (index > -1) {
 
            $(array, removeObjectAtIndex, index);
            $(array, removeObjectAtIndex, index);
 
            if (((Array *) array)->count == 0) {
                self->dictionary.elements[bin] = release(array);
            }
 
            self->dictionary.count--;
        }
    }
}

removeObjectForKeyPath()

void removeObjectForKeyPath	(	MutableDictionary *	self,
		const char *	path
	)

Removes the Object with the specified key path from this MutableDictionary.

Parameters

self	The MutableDictionary.
path	The key path of the Object to remove.

Definition at line 203 of file MutableDictionary.c.

                                                                              {
 
    String *key = $$(String, stringWithCharacters, path);
 
    $(self, removeObjectForKey, key);
 
    release(key);
}

setObjectForKey()

void setObjectForKey	(	MutableDictionary *	self,
		const ident	obj,
		const ident	key
	)

Sets a pair in this MutableDictionary.

Parameters

self	The MutableDictionary.
obj	The Object to set.
key	The key of the Object to set.

Definition at line 260 of file MutableDictionary.c.

                                                                                       {
 
    Dictionary *dict = (Dictionary *) self;
 
    setObjectForKey_resize(dict);
 
    const size_t bin = HashForObject(HASH_SEED, key) % dict->capacity;
 
    MutableArray *array = dict->elements[bin];
    if (array == NULL) {
        array = dict->elements[bin] = $$(MutableArray, arrayWithCapacity, (dict->capacity >> 2) + 1);
    }
 
    const ssize_t index = $((Array *) array, indexOfObject, key);
    if (index > -1) {
        $(array, setObjectAtIndex, obj, index + 1);
    } else {
        $(array, addObject, key);
        $(array, addObject, obj);
 
        dict->count++;
    }
}

setObjectForKeyPath()

void setObjectForKeyPath	(	MutableDictionary *	self,
		const ident	obj,
		const char *	path
	)

Sets a pair in this MutableDictionary.

Parameters

self	The MutableDictionary.
obj	The Object to set.
path	The key path of the Object to set.

Definition at line 288 of file MutableDictionary.c.

                                                                                            {
 
    String *key = $$(String, stringWithCharacters, path);
 
    $(self, setObjectForKey, obj, key);
 
    release(key);
}

setObjectsForKeyPaths()

void setObjectsForKeyPaths	(	MutableDictionary *	self,
			...
	)

Sets pairs in this MutableDictionary from the NULL-terminated list.

Parameters

self	The MutableDictionary.

Definition at line 301 of file MutableDictionary.c.

                                                                {
 
    va_list args;
    va_start(args, self);
 
    while (true) {
 
        ident obj = va_arg(args, ident);
        if (obj) {
            const char *path = va_arg(args, const char *);
            $(self, setObjectForKeyPath, obj, path);
        } else {
            break;
        }
    }
 
    va_end(args);
}

setObjectsForKeys()

void setObjectsForKeys	(	MutableDictionary *	self,
			...
	)

Sets pairs in this MutableDictionary from the NULL-terminated list.

Parameters

self	The MutableDictionary.

Definition at line 324 of file MutableDictionary.c.

                                                            {
 
    va_list args;
    va_start(args, self);
 
    while (true) {
 
        ident obj = va_arg(args, ident);
        if (obj) {
            ident key = va_arg(args, ident);
            $(self, setObjectForKey, obj, key);
        } else {
            break;
        }
    }
 
    va_end(args);
}

---

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

• Sources/Objectively/MutableDictionary.h
• Sources/Objectively/MutableDictionary.c