Swiftgram/Source/Private/ASRectMap.h
appleguy 131619de96
Reimplement ASRectTable using unordered_map to avoid obscure NSMapTable exception. (#719)
* Reimplement ASRectTable using unordered_map to avoid obscure NSMapTable exception.

The new class is called ASRectMap, which patterns alongside ASIntegerMap in both name and implementation.

After some pretty detailed investigation, including study of open-source reimplementations
of Foundation, the best lead I've found on the NSMapTable exception is that
some NSPointerFunction types are not fully supported. Strangely, the ones being used
do seem to work fine almost all of the time.

The main concern is the Struct memory type, which is not officially re-declared in
NSMapTable, and as such the documentation claims that there may exist some
combinations of NSPointerFunction that are not supported.

Because the exception is occurring frequently enough to be a concern (in the hundreds
to low thousands, though only 50 a day) - I decided to replace NSMapTable entirely
in order to ensure full correctness.

"*** -[NSMapTable initWithKeyPointerFunctions:valuePointerFunctions:capacity:] Requested configuration not supported."

* Fix Xcode project
2017-12-21 16:17:25 -08:00

53 lines
1.2 KiB
Objective-C

//
// ASRectMap.h
// Texture
//
// Copyright (c) 2017-present, Pinterest, Inc. All rights reserved.
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
#import <Foundation/Foundation.h>
#import <CoreGraphics/CGGeometry.h>
NS_ASSUME_NONNULL_BEGIN
/**
* A category for indexing weak pointers to CGRects. Similar to ASIntegerMap.
*/
@interface ASRectMap : NSObject
/**
* Creates a new rect map. The keys are never retained.
*/
+ (ASRectMap *)rectMapForWeakObjectPointers;
/**
* Retrieves the rect for a given key, or CGRectNull if the key is not found.
*
* @param key An object to lookup the rect for.
*/
- (CGRect)rectForKey:(id)key;
/**
* Sets the given rect for the associated key. Key *will not be retained!*
*
* @param rect The rect to store as value.
* @param key The key to use for the rect.
*/
- (void)setRect:(CGRect)rect forKey:(id)key;
/**
* Removes the rect for the given key, if one exists.
*
* @param key The key to remove.
*/
- (void)removeRectForKey:(id)key;
@end
NS_ASSUME_NONNULL_END