mirror of
https://github.com/firebase/firebase-ios-sdk
synced 2026-11-10 22:45:59 +05:45
Gil
39d8252300
This reimplements our comparison functions as C++ Comparators and then provides compatibility shims for interoperating with existing Objective-C usage. A few specialized comparators aren't suitable for porting but only have a single usage (e.g. CompareBytes for comparing NSData * instances). In these cases I've moved them into the caller. * Use int32_t for typeof(ID) in FSTDocumentReference * Migrate callers of FSTComparison.h to Objective-C++ * Port comparison to C++ * Migrate usages of FSTComparison.h to C++ equivalents * Remove FSTComparison
62 lines
2.1 KiB
Objective-C
62 lines
2.1 KiB
Objective-C
/*
|
|
* Copyright 2017 Google
|
|
*
|
|
* 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
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
#import <Foundation/Foundation.h>
|
|
|
|
@class FSTDocumentKey;
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
/**
|
|
* An immutable value used to keep track of an association between some referencing target or batch
|
|
* and a document key that the target or batch references.
|
|
*
|
|
* A reference can be from either listen targets (identified by their FSTTargetID) or mutation
|
|
* batches (identified by their FSTBatchID). See FSTGarbageCollector for more details.
|
|
*
|
|
* Not to be confused with FIRDocumentReference.
|
|
*/
|
|
@interface FSTDocumentReference : NSObject <NSCopying>
|
|
|
|
/** Initializes the document reference with the given key and ID. */
|
|
- (instancetype)initWithKey:(FSTDocumentKey *)key ID:(int32_t)ID NS_DESIGNATED_INITIALIZER;
|
|
|
|
- (instancetype)init NS_UNAVAILABLE;
|
|
|
|
/** The document key that's the target of this reference. */
|
|
@property(nonatomic, strong, readonly) FSTDocumentKey *key;
|
|
|
|
/**
|
|
* The targetID of a referring target or the batchID of a referring mutation batch. (Which this
|
|
* is depends upon which FSTReferenceSet this reference is a part of.)
|
|
*/
|
|
@property(nonatomic, assign, readonly) int32_t ID;
|
|
|
|
@end
|
|
|
|
#pragma mark Comparators
|
|
|
|
/** Sorts document references by key then ID. */
|
|
extern const NSComparator FSTDocumentReferenceComparatorByKey;
|
|
|
|
/** Sorts document references by ID then key. */
|
|
extern const NSComparator FSTDocumentReferenceComparatorByID;
|
|
|
|
/** A callback for use when enumerating an FSTImmutableSortedSet of FSTDocumentReferences. */
|
|
typedef void (^FSTDocumentReferenceBlock)(FSTDocumentReference *reference, BOOL *stop);
|
|
|
|
NS_ASSUME_NONNULL_END
|