/*
* Copyright (c) 2008-2022 Jonathan Schleifer <js@nil.im>
*
* All rights reserved.
*
* This file is part of ObjFW. It may be distributed under the terms of the
* Q Public License 1.0, which can be found in the file LICENSE.QPL included in
* the packaging of this file.
*
* Alternatively, it may be distributed under the terms of the GNU General
* Public License, either version 2 or 3, which can be found in the file
* LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this
* file.
*/
#include "config.h"
#include <stdlib.h>
#include <assert.h>
#import "OFDictionary.h"
#import "OFArray.h"
#import "OFCharacterSet.h"
#import "OFData.h"
#import "OFEnumerator.h"
#import "OFMapTableDictionary.h"
#import "OFString.h"
#import "OFXMLElement.h"
#import "OFInvalidArgumentException.h"
#import "OFOutOfRangeException.h"
#import "OFUndefinedKeyException.h"
static struct {
Class isa;
} placeholder;
static OFCharacterSet *URLQueryPartAllowedCharacterSet = nil;
@interface OFDictionary ()
- (OFString *)
of_JSONRepresentationWithOptions: (OFJSONRepresentationOptions)options
depth: (size_t)depth;
@end
@interface OFDictionaryPlaceholder: OFDictionary
@end
OF_DIRECT_MEMBERS
@interface OFDictionaryObjectEnumerator: OFEnumerator
{
OFDictionary *_dictionary;
OFEnumerator *_keyEnumerator;
}
- (instancetype)initWithDictionary: (OFDictionary *)dictionary;
@end
OF_DIRECT_MEMBERS
@interface OFURLQueryPartAllowedCharacterSet: OFCharacterSet
+ (OFCharacterSet *)URLQueryPartAllowedCharacterSet;
@end
@implementation OFDictionaryPlaceholder
- (instancetype)init
{
return (id)[[OFMapTableDictionary alloc] init];
}
- (instancetype)initWithDictionary: (OFDictionary *)dictionary
{
return (id)[[OFMapTableDictionary alloc]
initWithDictionary: dictionary];
}
- (instancetype)initWithObject: (id)object forKey: (id)key
{
return (id)[[OFMapTableDictionary alloc] initWithObject: object
forKey: key];
}
- (instancetype)initWithObjects: (OFArray *)objects forKeys: (OFArray *)keys
{
return (id)[[OFMapTableDictionary alloc] initWithObjects: objects
forKeys: keys];
}
- (instancetype)initWithObjects: (id const *)objects
forKeys: (id const *)keys
count: (size_t)count
{
return (id)[[OFMapTableDictionary alloc] initWithObjects: objects
forKeys: keys
count: count];
}
- (instancetype)initWithKeysAndObjects: (id <OFCopying>)firstKey, ...
{
id ret;
va_list arguments;
va_start(arguments, firstKey);
ret = [[OFMapTableDictionary alloc] initWithKey: firstKey
arguments: arguments];
va_end(arguments);
return ret;
}
- (instancetype)initWithKey: (id <OFCopying>)firstKey
arguments: (va_list)arguments
{
return (id)[[OFMapTableDictionary alloc] initWithKey: firstKey
arguments: arguments];
}
- (instancetype)initWithSerialization: (OFXMLElement *)element
{
return (id)[[OFMapTableDictionary alloc]
initWithSerialization: element];
}
- (instancetype)retain
{
return self;
}
- (instancetype)autorelease
{
return self;
}
- (void)release
{
}
- (void)dealloc
{
OF_DEALLOC_UNSUPPORTED
}
@end
@implementation OFURLQueryPartAllowedCharacterSet
+ (void)initialize
{
if (self != [OFURLQueryPartAllowedCharacterSet class])
return;
URLQueryPartAllowedCharacterSet =
[[OFURLQueryPartAllowedCharacterSet alloc] init];
}
+ (OFCharacterSet *)URLQueryPartAllowedCharacterSet
{
return URLQueryPartAllowedCharacterSet;
}
- (instancetype)autorelease
{
return self;
}
- (instancetype)retain
{
return self;
}
- (void)release
{
}
- (unsigned int)retainCount
{
return OFMaxRetainCount;
}
- (bool)characterIsMember: (OFUnichar)character
{
if (character < CHAR_MAX && OFASCIIIsAlnum(character))
return true;
switch (character) {
case '-':
case '.':
case '_':
case '~':
case '!':
case '$':
case '\'':
case '(':
case ')':
case '*':
case '+':
case ',':
case ';':
return true;
default:
return false;
}
}
@end
@implementation OFDictionary
+ (void)initialize
{
if (self == [OFDictionary class])
placeholder.isa = [OFDictionaryPlaceholder class];
}
+ (instancetype)alloc
{
if (self == [OFDictionary class])
return (id)&placeholder;
return [super alloc];
}
+ (instancetype)dictionary
{
return [[[self alloc] init] autorelease];
}
+ (instancetype)dictionaryWithDictionary: (OFDictionary *)dictionary
{
return [[(OFDictionary *)[self alloc]
initWithDictionary: dictionary] autorelease];
}
+ (instancetype)dictionaryWithObject: (id)object forKey: (id)key
{
return [[[self alloc] initWithObject: object forKey: key] autorelease];
}
+ (instancetype)dictionaryWithObjects: (OFArray *)objects
forKeys: (OFArray *)keys
{
return [[[self alloc] initWithObjects: objects
forKeys: keys] autorelease];
}
+ (instancetype)dictionaryWithObjects: (id const *)objects
forKeys: (id const *)keys
count: (size_t)count
{
return [[[self alloc] initWithObjects: objects
forKeys: keys
count: count] autorelease];
}
+ (instancetype)dictionaryWithKeysAndObjects: (id)firstKey, ...
{
id ret;
va_list arguments;
va_start(arguments, firstKey);
ret = [[[self alloc] initWithKey: firstKey
arguments: arguments] autorelease];
va_end(arguments);
return ret;
}
- (instancetype)init
{
if ([self isMemberOfClass: [OFDictionary class]]) {
@try {
[self doesNotRecognizeSelector: _cmd];
} @catch (id e) {
[self release];
@throw e;
}
abort();
}
return [super init];
}
- (instancetype)initWithDictionary: (OFDictionary *)dictionary
{
OF_INVALID_INIT_METHOD
}
- (instancetype)initWithObject: (id)object forKey: (id)key
{
if (key == nil || object == nil)
@throw [OFInvalidArgumentException exception];
return [self initWithKeysAndObjects: key, object, nil];
}
- (instancetype)initWithObjects: (OFArray *)objects_ forKeys: (OFArray *)keys_
{
id const *objects, *keys;
size_t count;
@try {
count = objects_.count;
if (count != keys_.count)
@throw [OFInvalidArgumentException exception];
objects = objects_.objects;
keys = keys_.objects;
} @catch (id e) {
[self release];
@throw e;
}
return [self initWithObjects: objects forKeys: keys count: count];
}
- (instancetype)initWithObjects: (id const *)objects
forKeys: (id const *)keys
count: (size_t)count
{
OF_INVALID_INIT_METHOD
}
- (instancetype)initWithKeysAndObjects: (id)firstKey, ...
{
id ret;
va_list arguments;
va_start(arguments, firstKey);
ret = [self initWithKey: firstKey arguments: arguments];
va_end(arguments);
return ret;
}
- (instancetype)initWithKey: (id)firstKey arguments: (va_list)arguments
{
OF_INVALID_INIT_METHOD
}
- (instancetype)initWithSerialization: (OFXMLElement *)element
{
OF_INVALID_INIT_METHOD
}
- (id)objectForKey: (id)key
{
OF_UNRECOGNIZED_SELECTOR
}
- (id)objectForKeyedSubscript: (id)key
{
return [self objectForKey: key];
}
- (id)valueForKey: (OFString *)key
{
if ([key isEqual: @"@count"])
return [super valueForKey: @"count"];
return [self objectForKey: key];
}
- (void)setValue: (id)value forKey: (OFString *)key
{
if (![self isKindOfClass: [OFMutableDictionary class]])
@throw [OFUndefinedKeyException exceptionWithObject: self
key: key
value: value];
[(OFMutableDictionary *)self setObject: value forKey: key];
}
- (size_t)count
{
OF_UNRECOGNIZED_SELECTOR
}
- (id)copy
{
return [self retain];
}
- (id)mutableCopy
{
return [[OFMutableDictionary alloc] initWithDictionary: self];
}
- (bool)isEqual: (id)object
{
OFDictionary *otherDictionary;
void *pool;
OFEnumerator *keyEnumerator, *objectEnumerator;
id key;
if (object == self)
return true;
if (![object isKindOfClass: [OFDictionary class]])
return false;
otherDictionary = object;
if (otherDictionary.count != self.count)
return false;
pool = objc_autoreleasePoolPush();
keyEnumerator = [self keyEnumerator];
objectEnumerator = [self objectEnumerator];
while ((key = [keyEnumerator nextObject]) != nil &&
(object = [objectEnumerator nextObject]) != nil) {
id otherObject = [otherDictionary objectForKey: key];
if (otherObject == nil || ![otherObject isEqual: object]) {
objc_autoreleasePoolPop(pool);
return false;
}
}
objc_autoreleasePoolPop(pool);
return true;
}
- (bool)containsObject: (id)object
{
void *pool;
OFEnumerator *enumerator;
id currentObject;
if (object == nil)
return false;
pool = objc_autoreleasePoolPush();
enumerator = [self objectEnumerator];
while ((currentObject = [enumerator nextObject]) != nil) {
if ([currentObject isEqual: object]) {
objc_autoreleasePoolPop(pool);
return true;
}
}
objc_autoreleasePoolPop(pool);
return false;
}
- (bool)containsObjectIdenticalTo: (id)object
{
void *pool;
OFEnumerator *enumerator;
id currentObject;
if (object == nil)
return false;
pool = objc_autoreleasePoolPush();
enumerator = [self objectEnumerator];
while ((currentObject = [enumerator nextObject]) != nil) {
if (currentObject == object) {
objc_autoreleasePoolPop(pool);
return true;
}
}
objc_autoreleasePoolPop(pool);
return false;
}
- (OFArray *)allKeys
{
OFMutableArray *ret = [OFMutableArray arrayWithCapacity: self.count];
for (id key in self)
[ret addObject: key];
[ret makeImmutable];
return ret;
}
- (OFArray *)allObjects
{
OFMutableArray *ret = [OFMutableArray arrayWithCapacity: self.count];
void *pool = objc_autoreleasePoolPush();
OFEnumerator *enumerator = [self objectEnumerator];
id object;
while ((object = [enumerator nextObject]) != nil)
[ret addObject: object];
[ret makeImmutable];
objc_autoreleasePoolPop(pool);
return ret;
}
- (OFEnumerator *)keyEnumerator
{
OF_UNRECOGNIZED_SELECTOR
}
- (OFEnumerator *)objectEnumerator
{
return [[[OFDictionaryObjectEnumerator alloc]
initWithDictionary: self] autorelease];
}
- (int)countByEnumeratingWithState: (OFFastEnumerationState *)state
objects: (id *)objects
count: (int)count
{
OFEnumerator *enumerator;
int i;
memcpy(&enumerator, state->extra, sizeof(enumerator));
if (enumerator == nil) {
enumerator = [self keyEnumerator];
memcpy(state->extra, &enumerator, sizeof(enumerator));
}
state->itemsPtr = objects;
state->mutationsPtr = (unsigned long *)self;
for (i = 0; i < count; i++) {
id object = [enumerator nextObject];
if (object == nil)
return i;
objects[i] = object;
}
return i;
}
#ifdef OF_HAVE_BLOCKS
- (void)enumerateKeysAndObjectsUsingBlock: (OFDictionaryEnumerationBlock)block
{
bool stop = false;
for (id key in self) {
block(key, [self objectForKey: key], &stop);
if (stop)
break;
}
}
- (OFDictionary *)mappedDictionaryUsingBlock: (OFDictionaryMapBlock)block
{
OFMutableDictionary *new = [OFMutableDictionary dictionary];
[self enumerateKeysAndObjectsUsingBlock: ^ (id key, id object,
bool *stop) {
[new setObject: block(key, object) forKey: key];
}];
[new makeImmutable];
return new;
}
- (OFDictionary *)filteredDictionaryUsingBlock: (OFDictionaryFilterBlock)block
{
OFMutableDictionary *new = [OFMutableDictionary dictionary];
[self enumerateKeysAndObjectsUsingBlock: ^ (id key, id object,
bool *stop) {
if (block(key, object))
[new setObject: object forKey: key];
}];
[new makeImmutable];
return new;
}
#endif
- (unsigned long)hash
{
void *pool = objc_autoreleasePoolPush();
OFEnumerator *keyEnumerator = [self keyEnumerator];
OFEnumerator *objectEnumerator = [self objectEnumerator];
id key, object;
unsigned long hash = 0;
while ((key = [keyEnumerator nextObject]) != nil &&
(object = [objectEnumerator nextObject]) != nil) {
hash ^= [key hash];
hash ^= [object hash];
}
objc_autoreleasePoolPop(pool);
return hash;
}
- (OFString *)description
{
OFMutableString *ret;
void *pool;
OFEnumerator *keyEnumerator, *objectEnumerator;
OFObject *key, *object;
size_t i, count = self.count;
if (count == 0)
return @"{}";
ret = [OFMutableString stringWithString: @"{\n"];
pool = objc_autoreleasePoolPush();
keyEnumerator = [self keyEnumerator];
objectEnumerator = [self objectEnumerator];
i = 0;
while ((key = [keyEnumerator nextObject]) != nil &&
(object = [objectEnumerator nextObject]) != nil) {
void *pool2 = objc_autoreleasePoolPush();
[ret appendString: key.description];
[ret appendString: @" = "];
[ret appendString: object.description];
if (++i < count)
[ret appendString: @";\n"];
objc_autoreleasePoolPop(pool2);
}
[ret replaceOccurrencesOfString: @"\n" withString: @"\n\t"];
[ret appendString: @";\n}"];
[ret makeImmutable];
objc_autoreleasePoolPop(pool);
return ret;
}
- (OFString *)stringByURLEncoding
{
OFMutableString *ret = [OFMutableString string];
void *pool = objc_autoreleasePoolPush();
OFEnumerator *keyEnumerator = [self keyEnumerator];
OFEnumerator *objectEnumerator = [self objectEnumerator];
OFCharacterSet *allowed = [OFURLQueryPartAllowedCharacterSet
URLQueryPartAllowedCharacterSet];
bool first = true;
OFObject *key, *object;
while ((key = [keyEnumerator nextObject]) != nil &&
(object = [objectEnumerator nextObject]) != nil) {
if OF_UNLIKELY (first)
first = false;
else
[ret appendString: @"&"];
[ret appendString: [key.description
stringByURLEncodingWithAllowedCharacters: allowed]];
[ret appendString: @"="];
[ret appendString: [object.description
stringByURLEncodingWithAllowedCharacters: allowed]];
}
[ret makeImmutable];
objc_autoreleasePoolPop(pool);
return ret;
}
- (OFXMLElement *)XMLElementBySerializing
{
void *pool = objc_autoreleasePoolPush();
OFXMLElement *element;
OFEnumerator *keyEnumerator, *objectEnumerator;
id <OFSerialization> key, object;
if ([self isKindOfClass: [OFMutableDictionary class]])
element = [OFXMLElement elementWithName: @"OFMutableDictionary"
namespace: OFSerializationNS];
else
element = [OFXMLElement elementWithName: @"OFDictionary"
namespace: OFSerializationNS];
keyEnumerator = [self keyEnumerator];
objectEnumerator = [self objectEnumerator];
while ((key = [keyEnumerator nextObject]) != nil &&
(object = [objectEnumerator nextObject]) != nil) {
void *pool2 = objc_autoreleasePoolPush();
OFXMLElement *keyElement, *objectElement;
keyElement = [OFXMLElement
elementWithName: @"key"
namespace: OFSerializationNS];
[keyElement addChild: key.XMLElementBySerializing];
objectElement = [OFXMLElement
elementWithName: @"object"
namespace: OFSerializationNS];
[objectElement addChild: object.XMLElementBySerializing];
[element addChild: keyElement];
[element addChild: objectElement];
objc_autoreleasePoolPop(pool2);
}
[element retain];
objc_autoreleasePoolPop(pool);
return [element autorelease];
}
- (OFString *)JSONRepresentation
{
return [self of_JSONRepresentationWithOptions: 0 depth: 0];
}
- (OFString *)JSONRepresentationWithOptions:
(OFJSONRepresentationOptions)options
{
return [self of_JSONRepresentationWithOptions: options depth: 0];
}
- (OFString *)
of_JSONRepresentationWithOptions: (OFJSONRepresentationOptions)options
depth: (size_t)depth
{
OFMutableString *JSON = [OFMutableString stringWithString: @"{"];
void *pool = objc_autoreleasePoolPush();
OFEnumerator *keyEnumerator = [self keyEnumerator];
OFEnumerator *objectEnumerator = [self objectEnumerator];
size_t i, count = self.count;
id key, object;
if (options & OFJSONRepresentationOptionPretty) {
OFMutableString *indentation = [OFMutableString string];
for (i = 0; i < depth; i++)
[indentation appendString: @"\t"];
[JSON appendString: @"\n"];
i = 0;
while ((key = [keyEnumerator nextObject]) != nil &&
(object = [objectEnumerator nextObject]) != nil) {
void *pool2 = objc_autoreleasePoolPush();
int identifierOptions =
options | OFJSONRepresentationOptionIsIdentifier;
if (![key isKindOfClass: [OFString class]])
@throw [OFInvalidArgumentException exception];
[JSON appendString: indentation];
[JSON appendString: @"\t"];
[JSON appendString: [key
of_JSONRepresentationWithOptions: identifierOptions
depth: depth + 1]];
[JSON appendString: @": "];
[JSON appendString: [object
of_JSONRepresentationWithOptions: options
depth: depth + 1]];
if (++i < count)
[JSON appendString: @",\n"];
else
[JSON appendString: @"\n"];
objc_autoreleasePoolPop(pool2);
}
[JSON appendString: indentation];
} else {
i = 0;
while ((key = [keyEnumerator nextObject]) != nil &&
(object = [objectEnumerator nextObject]) != nil) {
void *pool2 = objc_autoreleasePoolPush();
int identifierOptions =
options | OFJSONRepresentationOptionIsIdentifier;
if (![key isKindOfClass: [OFString class]])
@throw [OFInvalidArgumentException exception];
[JSON appendString: [key
of_JSONRepresentationWithOptions: identifierOptions
depth: depth + 1]];
[JSON appendString: @":"];
[JSON appendString: [object
of_JSONRepresentationWithOptions: options
depth: depth + 1]];
if (++i < count)
[JSON appendString: @","];
objc_autoreleasePoolPop(pool2);
}
}
[JSON appendString: @"}"];
[JSON makeImmutable];
objc_autoreleasePoolPop(pool);
return JSON;
}
- (OFData *)messagePackRepresentation
{
OFMutableData *data;
size_t i, count;
void *pool;
OFEnumerator *keyEnumerator, *objectEnumerator;
id <OFMessagePackRepresentation> key, object;
data = [OFMutableData data];
count = self.count;
if (count <= 15) {
uint8_t tmp = 0x80 | ((uint8_t)count & 0xF);
[data addItem: &tmp];
} else if (count <= UINT16_MAX) {
uint8_t type = 0xDE;
uint16_t tmp = OFToBigEndian16((uint16_t)count);
[data addItem: &type];
[data addItems: &tmp count: sizeof(tmp)];
} else if (count <= UINT32_MAX) {
uint8_t type = 0xDF;
uint32_t tmp = OFToBigEndian32((uint32_t)count);
[data addItem: &type];
[data addItems: &tmp count: sizeof(tmp)];
} else
@throw [OFOutOfRangeException exception];
pool = objc_autoreleasePoolPush();
i = 0;
keyEnumerator = [self keyEnumerator];
objectEnumerator = [self objectEnumerator];
while ((key = [keyEnumerator nextObject]) != nil &&
(object = [objectEnumerator nextObject]) != nil) {
void *pool2 = objc_autoreleasePoolPush();
OFData *child;
i++;
child = key.messagePackRepresentation;
[data addItems: child.items count: child.count];
child = object.messagePackRepresentation;
[data addItems: child.items count: child.count];
objc_autoreleasePoolPop(pool2);
}
assert(i == count);
[data makeImmutable];
objc_autoreleasePoolPop(pool);
return data;
}
@end
@implementation OFDictionaryObjectEnumerator
- (instancetype)initWithDictionary: (OFDictionary *)dictionary
{
self = [super init];
@try {
void *pool = objc_autoreleasePoolPush();
_dictionary = [dictionary retain];
_keyEnumerator = [[_dictionary keyEnumerator] retain];
objc_autoreleasePoolPop(pool);
} @catch (id e) {
[self release];
@throw e;
}
return self;
}
- (void)dealloc
{
[_dictionary release];
[_keyEnumerator release];
[super dealloc];
}
- (id)nextObject
{
id key = [_keyEnumerator nextObject];
id object;
if (key == nil)
return nil;
if ((object = [_dictionary objectForKey: key]) == nil)
@throw [OFInvalidArgumentException exception];
return object;
}
@end