FIRComponentContainer.h 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. /*
  2. * Copyright 2018 Google
  3. *
  4. * Licensed under the Apache License, Version 2.0 (the "License");
  5. * you may not use this file except in compliance with the License.
  6. * You may obtain a copy of the License at
  7. *
  8. * http://www.apache.org/licenses/LICENSE-2.0
  9. *
  10. * Unless required by applicable law or agreed to in writing, software
  11. * distributed under the License is distributed on an "AS IS" BASIS,
  12. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. * See the License for the specific language governing permissions and
  14. * limitations under the License.
  15. */
  16. #import <Foundation/Foundation.h>
  17. NS_ASSUME_NONNULL_BEGIN
  18. /// A type-safe macro to retrieve a component from a container. This should be used to retrieve
  19. /// components instead of using the container directly.
  20. #define FIR_COMPONENT(type, container) \
  21. [FIRComponentType<id<type>> instanceForProtocol:@protocol(type) inContainer:container]
  22. @class FIRApp;
  23. /// A container that holds different components that are registered via the
  24. /// `registerAsComponentRegistrant` call. These classes should conform to `ComponentRegistrant`
  25. /// in order to properly register components for Core.
  26. NS_SWIFT_NAME(FirebaseComponentContainer)
  27. @interface FIRComponentContainer : NSObject
  28. /// A weak reference to the app that an instance of the container belongs to.
  29. @property(nonatomic, weak, readonly) FIRApp *app;
  30. // TODO: See if we can get improved type safety here.
  31. /// A Swift only API for fetching an instance since the top macro isn't available.
  32. - (nullable id)__instanceForProtocol:(Protocol *)protocol NS_SWIFT_NAME(instance(for:));
  33. /// Unavailable. Use the `container` property on `FirebaseApp`.
  34. - (instancetype)init NS_UNAVAILABLE;
  35. @end
  36. NS_ASSUME_NONNULL_END