Skip to content

Commit

Permalink
Managed property wrapper prototype
Browse files Browse the repository at this point in the history
  • Loading branch information
@tgoyne
tgoyne committed Jul 27, 2019
1 parent b6ba922 commit 517c398
Show file tree
Hide file tree
Showing 32 changed files with 1,525 additions and 504 deletions.
30 changes: 9 additions & 21 deletions Package.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -101,31 +101,19 @@ let package = Package(
.headerSearchPath(".."),
]
),
.testTarget(
name: "RealmTests",
dependencies: ["Realm", "RealmTestSupport"],
path: "Realm/Tests",
exclude: [
"Swift",
"TestHost",
"PrimitiveArrayPropertyTests.tpl.m",
],
cxxSettings: cxxSettings + [
.headerSearchPath("Realm"),
.headerSearchPath(".."),
.headerSearchPath("../ObjectStore/src"),
]
),
.testTarget(
name: "RealmObjcSwiftTests",
dependencies: ["Realm", "RealmTestSupport"],
path: "Realm/Tests/Swift"
),
.testTarget(
name: "RealmSwiftTests",
dependencies: ["RealmSwift", "RealmTestSupport"],
path: "RealmSwift/Tests",
exclude: ["TestUtils.mm"]
exclude: [
"TestUtils.mm",
"ListTests.swift",
"ObjectTests.swift",
"PrimitiveListTests.swift",
"ObjectSchemaInitializationTests.swift",
"ObjectAccessorTests.swift",
"MigrationTests.swift",
]
)
],
cxxLanguageStandard: .cxx14
Expand Down
41 changes: 28 additions & 13 deletions Realm.xcodeproj/project.pbxproj
View file

Large diffs are not rendered by default.

192 changes: 129 additions & 63 deletions Realm/RLMAccessor.mm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,10 @@
#import "RLMRealm_Private.hpp"
#import "RLMResults_Private.hpp"
#import "RLMSchema_Private.h"
#import "RLMSwiftProperty.h"
#import "RLMUtil.hpp"
#import "results.hpp"
#import "property.hpp"
#import "results.hpp"

#import <objc/runtime.h>
#import <objc/message.h>
Expand All @@ -39,10 +40,14 @@
#pragma mark - Helper functions

namespace {
size_t tableColumn(__unsafe_unretained RLMObjectBase *const obj, NSUInteger propertyIndex) {
return obj->_info->objectSchema->persisted_properties[propertyIndex].table_column;
}

template<typename T>
T get(__unsafe_unretained RLMObjectBase *const obj, NSUInteger index) {
RLMVerifyAttached(obj);
return obj->_row.get<T>(obj->_info->objectSchema->persisted_properties[index].table_column);
return obj->_row.get<T>(tableColumn(obj, index));
}

template<typename T>
Expand All @@ -59,9 +64,18 @@ id getBoxed(__unsafe_unretained RLMObjectBase *const obj, NSUInteger index) {
}

template<typename T>
void setValue(__unsafe_unretained RLMObjectBase *const obj, NSUInteger colIndex, T val) {
T getOptional(__unsafe_unretained RLMObjectBase *const obj, uint16_t key, bool *gotValue) {
auto ret = get<realm::util::Optional<T>>(obj, key);
if (ret) {
*gotValue = true;
}
return ret.value_or(T{});
}

template<typename T>
void setValue(__unsafe_unretained RLMObjectBase *const obj, NSUInteger propIndex, T val) {
RLMVerifyInWriteTransaction(obj);
obj->_row.set(colIndex, val);
obj->_row.set(tableColumn(obj, propIndex), val);
}

template<typename Fn>
Expand All @@ -74,11 +88,11 @@ auto translateError(Fn&& fn) {
}
}

void setValue(__unsafe_unretained RLMObjectBase *const obj, NSUInteger colIndex,
void setValue(__unsafe_unretained RLMObjectBase *const obj, NSUInteger propIndex,
__unsafe_unretained NSString *const val) {
RLMVerifyInWriteTransaction(obj);
translateError([&] {
obj->_row.set(colIndex, RLMStringDataWithNSString(val));
obj->_row.set(tableColumn(obj, propIndex), RLMStringDataWithNSString(val));
});
}

Expand All @@ -88,8 +102,9 @@ void setNull(realm::Row& row, size_t col) {
}

void setValue(__unsafe_unretained RLMObjectBase *const obj,
NSUInteger colIndex, __unsafe_unretained NSDate *const date) {
NSUInteger propIndex, __unsafe_unretained NSDate *const date) {
RLMVerifyInWriteTransaction(obj);
auto colIndex = tableColumn(obj, propIndex);
if (date) {
obj->_row.set(colIndex, RLMTimestampForNSDate(date));
}
Expand All @@ -98,17 +113,20 @@ void setValue(__unsafe_unretained RLMObjectBase *const obj,
}
}

void setValue(__unsafe_unretained RLMObjectBase *const obj, NSUInteger colIndex,
void setValue(__unsafe_unretained RLMObjectBase *const obj, NSUInteger propIndex,
__unsafe_unretained NSData *const data) {
RLMVerifyInWriteTransaction(obj);
translateError([&] {
obj->_row.set(colIndex, RLMBinaryDataForNSData(data));
obj->_row.set(tableColumn(obj, propIndex), RLMBinaryDataForNSData(data));
});
}

void setValue(__unsafe_unretained RLMObjectBase *const obj, NSUInteger colIndex,
void setValue(__unsafe_unretained RLMObjectBase *const obj, NSUInteger propIndex,
__unsafe_unretained RLMObjectBase *const val) __asm__("_RLMSwiftSetPropertyObject");
void setValue(__unsafe_unretained RLMObjectBase *const obj, NSUInteger propIndex,
__unsafe_unretained RLMObjectBase *const val) {
RLMVerifyInWriteTransaction(obj);
auto colIndex = tableColumn(obj, propIndex);
if (!val) {
obj->_row.nullify_link(colIndex);
return;
Expand All @@ -132,13 +150,14 @@ void setValue(__unsafe_unretained RLMObjectBase *const obj, NSUInteger colIndex,
return [[RLMManagedArray alloc] initWithParent:obj property:prop];
}

void setValue(__unsafe_unretained RLMObjectBase *const obj, NSUInteger colIndex,
void setValue(__unsafe_unretained RLMObjectBase *const obj, NSUInteger propIndex,
__unsafe_unretained id<NSFastEnumeration> const value) {
RLMVerifyInWriteTransaction(obj);
auto prop = obj->_info->propertyForTableColumn(colIndex);
auto prop = obj->_info->rlmObjectSchema.properties[propIndex];
RLMValidateValueForProperty(value, obj->_info->rlmObjectSchema, prop, true);

realm::List list(obj->_realm->_realm, *obj->_row.get_table(), colIndex, obj->_row.get_index());
realm::List list(obj->_realm->_realm, *obj->_row.get_table(),
tableColumn(obj, propIndex), obj->_row.get_index());
RLMClassInfo *info = obj->_info;
if (list.get_type() == realm::PropertyType::Object) {
info = &obj->_info->linkTargetType(prop.index);
Expand All @@ -147,51 +166,51 @@ void setValue(__unsafe_unretained RLMObjectBase *const obj, NSUInteger colIndex,
translateError([&] { list.assign(ctx, value, false); });
}

void setValue(__unsafe_unretained RLMObjectBase *const obj, NSUInteger colIndex,
__unsafe_unretained NSNumber<RLMInt> *const intObject) {
template<typename Func>
void setValueOrNull(__unsafe_unretained RLMObjectBase *const obj, NSUInteger propIndex,
id value, Func&& getter) {
RLMVerifyInWriteTransaction(obj);

if (intObject) {
obj->_row.set(colIndex, intObject.longLongValue);
auto colIndex = tableColumn(obj, propIndex);
if (value) {
obj->_row.set(colIndex, getter(value));
}
else {
setNull(obj->_row, colIndex);
}
}

void setValue(__unsafe_unretained RLMObjectBase *const obj, NSUInteger colIndex,
__unsafe_unretained NSNumber<RLMFloat> *const floatObject) {
RLMVerifyInWriteTransaction(obj);
void setValue(__unsafe_unretained RLMObjectBase *const obj, NSUInteger propIndex,
__unsafe_unretained NSNumber<RLMInt> *const intObject) {
setValueOrNull(obj, propIndex, intObject, [](NSNumber *value) { return value.longLongValue; });
}

if (floatObject) {
obj->_row.set(colIndex, floatObject.floatValue);
}
else {
setNull(obj->_row, colIndex);
}
void setValue(__unsafe_unretained RLMObjectBase *const obj, NSUInteger propIndex,
__unsafe_unretained NSNumber<RLMFloat> *const floatObject) {
setValueOrNull(obj, propIndex, floatObject, [](NSNumber *value) { return value.floatValue; });
}

void setValue(__unsafe_unretained RLMObjectBase *const obj, NSUInteger colIndex,
void setValue(__unsafe_unretained RLMObjectBase *const obj, NSUInteger propIndex,
__unsafe_unretained NSNumber<RLMDouble> *const doubleObject) {
RLMVerifyInWriteTransaction(obj);

if (doubleObject) {
obj->_row.set(colIndex, doubleObject.doubleValue);
}
else {
setNull(obj->_row, colIndex);
}
setValueOrNull(obj, propIndex, doubleObject, [](NSNumber *value) { return value.doubleValue; });
}

void setValue(__unsafe_unretained RLMObjectBase *const obj, NSUInteger colIndex,
void setValue(__unsafe_unretained RLMObjectBase *const obj, NSUInteger propIndex,
__unsafe_unretained NSNumber<RLMBool> *const boolObject) {
RLMVerifyInWriteTransaction(obj);
setValueOrNull(obj, propIndex, boolObject, [](NSNumber *value) { return (bool)value.boolValue; });
}

if (boolObject) {
obj->_row.set(colIndex, (bool)boolObject.boolValue);
template<typename T>
void kvoSetValue(__unsafe_unretained RLMObjectBase *const obj, NSUInteger propIndex, T&& value) {
if (RLMObservationInfo *info = RLMGetObservationInfo(obj->_observationInfo,
obj->_row.get_index(), *obj->_info)) {
auto name = obj->_info->rlmObjectSchema.properties[propIndex].name;
info->willChange(name);
setValue(obj, propIndex, std::forward<T>(value));
info->didChange(name);
}
else {
setNull(obj->_row, colIndex);
setValue(obj, propIndex, std::forward<T>(value));
}
}

Expand Down Expand Up @@ -289,27 +308,14 @@ id managedGetter(RLMProperty *prop, const char *type) {
template<typename ArgType, typename StorageType=ArgType>
id makeSetter(__unsafe_unretained RLMProperty *const prop) {
NSUInteger index = prop.index;
NSString *name = prop.name;
if (prop.isPrimary) {
return ^(__unused RLMObjectBase *obj, __unused ArgType val) {
@throw RLMException(@"Primary key can't be changed after an object is inserted.");
};
}

return ^(__unsafe_unretained RLMObjectBase *const obj, ArgType val) {
auto set = [&] {
setValue(obj, obj->_info->objectSchema->persisted_properties[index].table_column,
static_cast<StorageType>(val));
};
if (RLMObservationInfo *info = RLMGetObservationInfo(obj->_observationInfo,
obj->_row.get_index(), *obj->_info)) {
info->willChange(name);
set();
info->didChange(name);
}
else {
set();
}
kvoSetValue(obj, index, static_cast<StorageType>(val));
};
}

Expand Down Expand Up @@ -573,6 +579,59 @@ id RLMDynamicGetByName(__unsafe_unretained RLMObjectBase *const obj,
return RLMDynamicGet(obj, prop);
}

#define REALM_SWIFT_PROPERTY_ACCESSOR(objc, swift, rlmtype) \
objc RLMGetSwiftProperty##swift(__unsafe_unretained RLMObjectBase *const obj, uint16_t key) { \
return get<objc>(obj, key); \
} \
objc RLMGetSwiftProperty##swift##Optional(__unsafe_unretained RLMObjectBase *const obj, uint16_t key, bool *gotValue) { \
return getOptional<objc>(obj, key, gotValue); \
} \
void RLMSetSwiftProperty##swift(__unsafe_unretained RLMObjectBase *const obj, uint16_t key, objc value) { \
RLMVerifyAttached(obj); \
kvoSetValue(obj, key, value); \
}
REALM_FOR_EACH_SWIFT_PRIMITIVE_TYPE(REALM_SWIFT_PROPERTY_ACCESSOR)
#undef REALM_SWIFT_PROPERTY_ACCESSOR

#define REALM_SWIFT_PROPERTY_ACCESSOR(objc, swift, rlmtype) \
void RLMSetSwiftProperty##swift(__unsafe_unretained RLMObjectBase *const obj, uint16_t key, objc *value) { \
RLMVerifyAttached(obj); \
kvoSetValue(obj, key, value); \
}
REALM_FOR_EACH_SWIFT_OBJECT_TYPE(REALM_SWIFT_PROPERTY_ACCESSOR)
#undef REALM_SWIFT_PROPERTY_ACCESSOR

NSString *RLMGetSwiftPropertyString(__unsafe_unretained RLMObjectBase *const obj, uint16_t key) {
return getBoxed<realm::StringData>(obj, key);
}

NSData *RLMGetSwiftPropertyData(__unsafe_unretained RLMObjectBase *const obj, uint16_t key) {
return getBoxed<realm::BinaryData>(obj, key);
}

NSDate *RLMGetSwiftPropertyDate(__unsafe_unretained RLMObjectBase *const obj, uint16_t key) {
return getBoxed<realm::Timestamp>(obj, key);
}

void RLMSetSwiftPropertyNil(__unsafe_unretained RLMObjectBase *const obj, uint16_t key) {
RLMVerifyInWriteTransaction(obj);
if (obj->_info->objectSchema->persisted_properties[key].type == realm::PropertyType::Object) {
kvoSetValue(obj, key, (RLMObjectBase *)nil);
}
else {
kvoSetValue(obj, key, (NSNumber<RLMInt> *)nil);
}
}

void RLMSetSwiftPropertyObject(__unsafe_unretained RLMObjectBase *const obj, uint16_t key,
__unsafe_unretained RLMObjectBase *const target) {
kvoSetValue(obj, key, target);
}

RLMObjectBase *RLMGetSwiftPropertyObject(__unsafe_unretained RLMObjectBase *const obj, uint16_t key) {
return getBoxed<realm::RowExpr>(obj, key);
}

RLMAccessorContext::RLMAccessorContext(RLMAccessorContext& parent, realm::Property const& property)
: _realm(parent._realm)
, _info(property.type == realm::PropertyType::Object ? parent._info.linkTargetType(property) : parent._info)
Expand Down Expand Up @@ -616,10 +675,14 @@ id RLMDynamicGetByName(__unsafe_unretained RLMObjectBase *const obj,
// Property value from an instance of this object type
id value;
if ([obj isKindOfClass:_info.rlmObjectSchema.objectClass] && prop.swiftIvar) {
if (prop.array) {
if (prop.swiftAccessor) {
// FIXME
return [obj valueForUndefinedKey:prop.name] ?: NSNull.null;
}
else if (prop.array) {
return static_cast<RLMListBase *>(object_getIvar(obj, prop.swiftIvar))._rlmArray;
}
else { // optional
else if (prop.optional) { // optional
value = RLMGetOptional(static_cast<RLMOptionalBase *>(object_getIvar(obj, prop.swiftIvar)));
}
}
Expand Down Expand Up @@ -777,13 +840,16 @@ static auto to_optional(__unsafe_unretained id const value, Fn&& fn) {
RLMValidateValueForProperty(value, _info.rlmObjectSchema, prop);
}

if (_promote_existing && [obj isKindOfClass:_info.rlmObjectSchema.objectClass] && !prop.swiftIvar) {
// set the ivars for object and array properties to nil as otherwise the
// accessors retain objects that are no longer accessible via the properties
// this is mainly an issue when the object graph being added has cycles,
// as it's not obvious that the user has to set the *ivars* to nil to
// avoid leaking memory
if (prop.type == RLMPropertyTypeObject) {
if (_promote_existing && [obj isKindOfClass:_info.rlmObjectSchema.objectClass] && prop.type == RLMPropertyTypeObject) {
if (auto swiftAccessor = prop.swiftAccessor) {
[swiftAccessor set:(char *)(__bridge void *)obj + ivar_getOffset(prop.swiftIvar) value:nil];
}
else if (!prop.swiftIvar) {
// set the ivars for object and array properties to nil as otherwise the
// accessors retain objects that are no longer accessible via the properties
// this is mainly an issue when the object graph being added has cycles,
// as it's not obvious that the user has to set the *ivars* to nil to
// avoid leaking memory
((void(*)(id, SEL, id))objc_msgSend)(obj, prop.setterSel, nil);
}
}
Expand Down
Loading

0 comments on commit 517c398

Please sign in to comment.