ObjCObjectGraph.mm [plain text]
/*
* Copyright (C) 2012 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#import "config.h"
#import "ObjCObjectGraph.h"
#import "ArgumentCodersMac.h"
#import "Decoder.h"
#import "Encoder.h"
#import <wtf/Optional.h>
#if WK_API_ENABLED
#import "UserData.h"
#import "WKAPICast.h"
#import "WKBrowsingContextHandleInternal.h"
#import "WKTypeRefWrapper.h"
#endif
namespace WebKit {
static bool shouldTransformGraph(id object, const ObjCObjectGraph::Transformer& transformer)
{
if (NSArray *array = dynamic_objc_cast<NSArray>(object)) {
for (id element in array) {
if (shouldTransformGraph(element, transformer))
return true;
}
}
if (NSDictionary *dictionary = dynamic_objc_cast<NSDictionary>(object)) {
bool result = false;
[dictionary enumerateKeysAndObjectsUsingBlock:[&transformer, &result](id key, id object, BOOL* stop) {
if (shouldTransformGraph(object, transformer)) {
result = true;
*stop = YES;
}
}];
return result;
}
return transformer.shouldTransformObject(object);
}
static RetainPtr<id> transformGraph(id object, const ObjCObjectGraph::Transformer& transformer)
{
if (NSArray *array = dynamic_objc_cast<NSArray>(object)) {
auto result = adoptNS([[NSMutableArray alloc] initWithCapacity:array.count]);
for (id element in array)
[result addObject:transformGraph(element, transformer).get()];
return result;
}
if (NSDictionary *dictionary = dynamic_objc_cast<NSDictionary>(object)) {
auto result = adoptNS([[NSMutableDictionary alloc] initWithCapacity:dictionary.count]);
[dictionary enumerateKeysAndObjectsUsingBlock:[&result, &transformer](id key, id object, BOOL*) {
[result setObject:transformGraph(object, transformer).get() forKey:key];
}];
return result;
}
return transformer.transformObject(object);
}
RetainPtr<id> ObjCObjectGraph::transform(id object, const Transformer& transformer)
{
if (!object)
return nullptr;
if (!shouldTransformGraph(object, transformer))
return object;
return transformGraph(object, transformer);
}
enum class ObjCType {
Null,
NSArray,
NSData,
NSDate,
NSDictionary,
NSNumber,
NSString,
#if WK_API_ENABLED
WKBrowsingContextHandle,
WKTypeRefWrapper,
#endif
};
static std::optional<ObjCType> typeFromObject(id object)
{
ASSERT(object);
if (dynamic_objc_cast<NSArray>(object))
return ObjCType::NSArray;
if (dynamic_objc_cast<NSData>(object))
return ObjCType::NSData;
if (dynamic_objc_cast<NSDate>(object))
return ObjCType::NSDate;
if (dynamic_objc_cast<NSDictionary>(object))
return ObjCType::NSDictionary;
if (dynamic_objc_cast<NSNumber>(object))
return ObjCType::NSNumber;
if (dynamic_objc_cast<NSString>(object))
return ObjCType::NSString;
#if WK_API_ENABLED
if (dynamic_objc_cast<WKBrowsingContextHandle>(object))
return ObjCType::WKBrowsingContextHandle;
if (dynamic_objc_cast<WKTypeRefWrapper>(object))
return ObjCType::WKTypeRefWrapper;
#endif
return std::nullopt;
}
void ObjCObjectGraph::encode(IPC::Encoder& encoder, id object)
{
if (!object) {
encoder << static_cast<uint32_t>(ObjCType::Null);
return;
}
auto type = typeFromObject(object);
if (!type)
[NSException raise:NSInvalidArgumentException format:@"Can not encode objects of class type '%@'", static_cast<NSString *>(NSStringFromClass([object class]))];
encoder << static_cast<uint32_t>(type.value());
switch (type.value()) {
case ObjCType::NSArray: {
NSArray *array = object;
encoder << static_cast<uint64_t>(array.count);
for (id element in array)
encode(encoder, element);
break;
}
case ObjCType::NSData:
IPC::encode(encoder, static_cast<NSData *>(object));
break;
case ObjCType::NSDate:
IPC::encode(encoder, static_cast<NSDate *>(object));
break;
case ObjCType::NSDictionary: {
NSDictionary *dictionary = object;
encoder << static_cast<uint64_t>(dictionary.count);
[dictionary enumerateKeysAndObjectsUsingBlock:[&encoder](id key, id object, BOOL *stop) {
encode(encoder, key);
encode(encoder, object);
}];
break;
}
case ObjCType::NSNumber:
IPC::encode(encoder, static_cast<NSNumber *>(object));
break;
case ObjCType::NSString:
IPC::encode(encoder, static_cast<NSString *>(object));
break;
#if WK_API_ENABLED
case ObjCType::WKBrowsingContextHandle:
encoder << static_cast<WKBrowsingContextHandle *>(object).pageID;
break;
case ObjCType::WKTypeRefWrapper:
UserData::encode(encoder, toImpl(static_cast<WKTypeRefWrapper *>(object).object));
break;
#endif
default:
ASSERT_NOT_REACHED();
}
}
void ObjCObjectGraph::encode(IPC::Encoder& encoder) const
{
encode(encoder, m_rootObject.get());
}
bool ObjCObjectGraph::decode(IPC::Decoder& decoder, RetainPtr<id>& result)
{
uint32_t typeAsUInt32;
if (!decoder.decode(typeAsUInt32))
return false;
auto type = static_cast<ObjCType>(typeAsUInt32);
switch (type) {
case ObjCType::Null:
result = nullptr;
break;
case ObjCType::NSArray: {
uint64_t size;
if (!decoder.decode(size))
return false;
auto array = adoptNS([[NSMutableArray alloc] init]);
for (uint64_t i = 0; i < size; ++i) {
RetainPtr<id> element;
if (!decode(decoder, element))
return false;
[array addObject:element.get()];
}
result = WTFMove(array);
break;
}
case ObjCType::NSData: {
RetainPtr<NSData> data;
if (!IPC::decode(decoder, data))
return false;
result = WTFMove(data);
break;
}
case ObjCType::NSDate: {
RetainPtr<NSDate> date;
if (!IPC::decode(decoder, date))
return false;
result = WTFMove(date);
break;
}
case ObjCType::NSDictionary: {
uint64_t size;
if (!decoder.decode(size))
return false;
auto dictionary = adoptNS([[NSMutableDictionary alloc] init]);
for (uint64_t i = 0; i < size; ++i) {
RetainPtr<id> key;
if (!decode(decoder, key))
return false;
RetainPtr<id> object;
if (!decode(decoder, object))
return false;
@try {
[dictionary setObject:object.get() forKey:key.get()];
} @catch (id) {
return false;
}
}
result = WTFMove(dictionary);
break;
}
case ObjCType::NSNumber: {
RetainPtr<NSNumber> number;
if (!IPC::decode(decoder, number))
return false;
result = WTFMove(number);
break;
}
case ObjCType::NSString: {
RetainPtr<NSString> string;
if (!IPC::decode(decoder, string))
return false;
result = WTFMove(string);
break;
}
#if WK_API_ENABLED
case ObjCType::WKBrowsingContextHandle: {
uint64_t pageID;
if (!decoder.decode(pageID))
return false;
result = adoptNS([[WKBrowsingContextHandle alloc] _initWithPageID:pageID]);
break;
}
case ObjCType::WKTypeRefWrapper: {
RefPtr<API::Object> object;
if (!UserData::decode(decoder, object))
return false;
result = adoptNS([[WKTypeRefWrapper alloc] initWithObject:toAPI(object.get())]);
break;
}
#endif
default:
return false;
}
return true;
}
bool ObjCObjectGraph::decode(IPC::Decoder& decoder, RefPtr<API::Object>& result)
{
RetainPtr<id> rootObject;
if (!decode(decoder, rootObject))
return false;
result = ObjCObjectGraph::create(rootObject.get());
return true;
}
}