mirror of
https://github.com/firebase/firebase-ios-sdk
synced 2026-11-10 22:45:59 +05:45
Gil
4fbc96904f
This simplifies the import process back into google3 and allows us to add additional directories to the project without needing to update the project files for each directory we add. This shows up most clearly in the change to Firestore/Example/Firestore.xcodeproj/project.pbxproj: this no longer needs to list essentially every directory in the project as a header search path. * Clang-format configuration for C++ files * Add support C++-only sources to the podspec * Podspec support for fully qualified imports * xcodeproj changes for fully-qualified imports * Use fully-qualified imports in Firestore sources
72 lines
2.7 KiB
Objective-C
72 lines
2.7 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>
|
|
|
|
#import "Firestore/Source/Core/FSTTypes.h"
|
|
#import "Firestore/Source/Local/FSTGarbageCollector.h"
|
|
#import "Firestore/Source/Model/FSTDocumentKeySet.h"
|
|
|
|
@class FSTDocumentKey;
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
/**
|
|
* A collection of references to a document from some kind of numbered entity (either a targetID or
|
|
* batchID). As references are added to or removed from the set corresponding events are emitted to
|
|
* a registered garbage collector.
|
|
*
|
|
* Each reference is represented by a FSTDocumentReference object. Each of them contains enough
|
|
* information to uniquely identify the reference. They are all stored primarily in a set sorted
|
|
* by key. A document is considered garbage if there's no references in that set (this can be
|
|
* efficiently checked thanks to sorting by key).
|
|
*
|
|
* FSTReferenceSet also keeps a secondary set that contains references sorted by IDs. This one is
|
|
* used to efficiently implement removal of all references by some target ID.
|
|
*/
|
|
@interface FSTReferenceSet : NSObject <FSTGarbageSource>
|
|
|
|
/** Keeps track of keys that have references. */
|
|
@property(nonatomic, weak, readwrite, nullable) id<FSTGarbageCollector> garbageCollector;
|
|
|
|
/** Returns YES if the reference set contains no references. */
|
|
- (BOOL)isEmpty;
|
|
|
|
/** Adds a reference to the given document key for the given ID. */
|
|
- (void)addReferenceToKey:(FSTDocumentKey *)key forID:(int)ID;
|
|
|
|
/** Add references to the given document keys for the given ID. */
|
|
- (void)addReferencesToKeys:(FSTDocumentKeySet *)keys forID:(int)ID;
|
|
|
|
/** Removes a reference to the given document key for the given ID. */
|
|
- (void)removeReferenceToKey:(FSTDocumentKey *)key forID:(int)ID;
|
|
|
|
/** Removes references to the given document keys for the given ID. */
|
|
- (void)removeReferencesToKeys:(FSTDocumentKeySet *)keys forID:(int)ID;
|
|
|
|
/** Clears all references with a given ID. Calls -removeReferenceToKey: for each key removed. */
|
|
- (void)removeReferencesForID:(int)ID;
|
|
|
|
/** Clears all references for all IDs. */
|
|
- (void)removeAllReferences;
|
|
|
|
/** Returns all of the document keys that have had references added for the given ID. */
|
|
- (FSTDocumentKeySet *)referencedKeysForID:(int)ID;
|
|
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|