mirror of
https://github.com/firebase/firebase-ios-sdk
synced 2026-11-09 22:36:01 +05:45
Ryan Wilson
563854e81e
* Move component container to GoogleUtilities. This will allow non-Firebase SDKs to take advantage of the component system. Note: Firebase Core will eventually move over to use this, but more investigation is needed about how this can be done with the least amount of churn for other SDKs. * Fix dependency on Logger. * Add CHANGELOG entry. * Fix selector name. * Move ComponentContainer subspec to new pod. * Rename to GoogleUtilitiesComponents. * Style, make public headers. * Update travis with new name. * Add project to if_changed.sh * Review comments. * Enabled static framework, changed homepage. * Fix missing quote.
91 lines
3.7 KiB
Objective-C
91 lines
3.7 KiB
Objective-C
/*
|
|
* Copyright 2019 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 GULCCComponentContainer;
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
/// Provides a system to clean up cached instances returned from the component system.
|
|
NS_SWIFT_NAME(ComponentLifecycleMaintainer)
|
|
@protocol GULCCComponentLifecycleMaintainer
|
|
/// Clean up any resources as they are about to be deallocated.
|
|
- (void)containerWillBeEmptied:(GULCCComponentContainer *)container;
|
|
@end
|
|
|
|
typedef _Nullable id (^GULCCComponentCreationBlock)(GULCCComponentContainer *container,
|
|
BOOL *isCacheable)
|
|
NS_SWIFT_NAME(ComponentCreationBlock);
|
|
|
|
@class GULCCDependency;
|
|
|
|
/// Describes the timing of instantiation. Note: new components should default to lazy unless there
|
|
/// is a strong reason to be eager.
|
|
typedef NS_ENUM(NSInteger, GULCCInstantiationTiming) {
|
|
GULCCInstantiationTimingLazy,
|
|
GULCCInstantiationTimingAlwaysEager
|
|
} NS_SWIFT_NAME(InstantiationTiming);
|
|
|
|
/// A component that can be used from other components.
|
|
NS_SWIFT_NAME(Component)
|
|
@interface GULCCComponent : NSObject
|
|
|
|
/// The protocol describing functionality provided from the Component.
|
|
@property(nonatomic, strong, readonly) Protocol *protocol;
|
|
|
|
/// The timing of instantiation.
|
|
@property(nonatomic, readonly) GULCCInstantiationTiming instantiationTiming;
|
|
|
|
/// An array of dependencies for the component.
|
|
@property(nonatomic, copy, readonly) NSArray<GULCCDependency *> *dependencies;
|
|
|
|
/// A block to instantiate an instance of the component with the appropriate dependencies.
|
|
@property(nonatomic, copy, readonly) GULCCComponentCreationBlock creationBlock;
|
|
|
|
// There's an issue with long NS_SWIFT_NAMES that causes compilation to fail, disable clang-format
|
|
// for the next two methods.
|
|
// clang-format off
|
|
|
|
/// Creates a component with no dependencies that will be lazily initialized.
|
|
+ (instancetype)componentWithProtocol:(Protocol *)protocol
|
|
creationBlock:(GULCCComponentCreationBlock)creationBlock
|
|
NS_SWIFT_NAME(init(_:creationBlock:));
|
|
|
|
/// Creates a component to be registered with the component container.
|
|
///
|
|
/// @param protocol - The protocol describing functionality provided by the component.
|
|
/// @param instantiationTiming - When the component should be initialized. Use .lazy unless there's
|
|
/// a good reason to be instantiated earlier.
|
|
/// @param dependencies - Any dependencies the `implementingClass` has, optional or required.
|
|
/// @param creationBlock - A block to instantiate the component with a container and a flag to cache
|
|
/// the instance created or not.
|
|
/// @return A component that can be registered with the component container.
|
|
+ (instancetype)componentWithProtocol:(Protocol *)protocol
|
|
instantiationTiming:(GULCCInstantiationTiming)instantiationTiming
|
|
dependencies:(NSArray<GULCCDependency *> *)dependencies
|
|
creationBlock:(GULCCComponentCreationBlock)creationBlock
|
|
NS_SWIFT_NAME(init(_:instantiationTiming:dependencies:creationBlock:));
|
|
|
|
// clang-format on
|
|
|
|
/// Unavailable.
|
|
- (instancetype)init NS_UNAVAILABLE;
|
|
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|