|
|
@@ -0,0 +1,246 @@
|
|
|
+//
|
|
|
+// KingfisherHasImageComponent+Kingfisher.swift
|
|
|
+// Kingfisher
|
|
|
+//
|
|
|
+// Created by JH on 2023/12/5.
|
|
|
+//
|
|
|
+// Copyright (c) 2023 Wei Wang <onevcat@gmail.com>
|
|
|
+//
|
|
|
+// Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
|
+// of this software and associated documentation files (the "Software"), to deal
|
|
|
+// in the Software without restriction, including without limitation the rights
|
|
|
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
|
+// copies of the Software, and to permit persons to whom the Software is
|
|
|
+// furnished to do so, subject to the following conditions:
|
|
|
+//
|
|
|
+// The above copyright notice and this permission notice shall be included in
|
|
|
+// all copies or substantial portions of the Software.
|
|
|
+//
|
|
|
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
|
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
|
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
|
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
|
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
|
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
|
+// THE SOFTWARE.
|
|
|
+
|
|
|
+public protocol KingfisherHasImageComponent: KingfisherCompatible {
|
|
|
+ var image: KFCrossPlatformImage? { set get }
|
|
|
+}
|
|
|
+
|
|
|
+#if canImport(AppKit) && !targetEnvironment(macCatalyst)
|
|
|
+import AppKit
|
|
|
+
|
|
|
+@available(macOS 13.0, *)
|
|
|
+extension NSComboButton: KingfisherHasImageComponent {}
|
|
|
+
|
|
|
+@available(macOS 13.0, *)
|
|
|
+extension NSColorWell: KingfisherHasImageComponent {}
|
|
|
+
|
|
|
+extension NSImageView: KingfisherHasImageComponent {}
|
|
|
+
|
|
|
+extension NSTableViewRowAction: KingfisherHasImageComponent {}
|
|
|
+
|
|
|
+extension NSMenuItem: KingfisherHasImageComponent {}
|
|
|
+
|
|
|
+extension NSPathControlItem: KingfisherHasImageComponent {}
|
|
|
+
|
|
|
+extension NSToolbarItem: KingfisherHasImageComponent {}
|
|
|
+
|
|
|
+extension NSTabViewItem: KingfisherHasImageComponent {}
|
|
|
+
|
|
|
+extension NSStatusItem: KingfisherHasImageComponent {}
|
|
|
+
|
|
|
+extension NSCell: KingfisherHasImageComponent {}
|
|
|
+
|
|
|
+#endif
|
|
|
+
|
|
|
+#if canImport(UIKit) && !os(watchOS)
|
|
|
+import UIKit
|
|
|
+
|
|
|
+@available(iOS 13.0, tvOS 13.0, *)
|
|
|
+extension UIAction: KingfisherHasImageComponent {}
|
|
|
+
|
|
|
+@available(iOS 13.0, tvOS 13.0, *)
|
|
|
+extension UICommand: KingfisherHasImageComponent {}
|
|
|
+
|
|
|
+extension UIBarItem: KingfisherHasImageComponent {}
|
|
|
+
|
|
|
+#endif
|
|
|
+
|
|
|
+extension KingfisherWrapper where Base: KingfisherHasImageComponent {
|
|
|
+ // MARK: Setting Image
|
|
|
+
|
|
|
+ /// Sets an image to the component with a source.
|
|
|
+ ///
|
|
|
+ /// - Parameters:
|
|
|
+ /// - source: The `Source` object contains information about how to get the image.
|
|
|
+ /// - placeholder: A placeholder to show while retrieving the image from the given `resource`.
|
|
|
+ /// - options: An options set to define image setting behaviors. See `KingfisherOptionsInfo` for more.
|
|
|
+ /// - progressBlock: Called when the image downloading progress gets updated. If the response does not contain an
|
|
|
+ /// `expectedContentLength`, this block will not be called.
|
|
|
+ /// - completionHandler: Called when the image retrieved and set finished.
|
|
|
+ /// - Returns: A task represents the image downloading.
|
|
|
+ ///
|
|
|
+ /// - Note:
|
|
|
+ /// Internally, this method will use `KingfisherManager` to get the requested source.
|
|
|
+ /// Since this method will perform UI changes, you must call it from the main thread.
|
|
|
+ /// Both `progressBlock` and `completionHandler` will be also executed in the main thread.
|
|
|
+ ///
|
|
|
+ @discardableResult
|
|
|
+ public func setImage(
|
|
|
+ with source: Source?,
|
|
|
+ placeholder: KFCrossPlatformImage? = nil,
|
|
|
+ options: KingfisherOptionsInfo? = nil,
|
|
|
+ progressBlock: DownloadProgressBlock? = nil,
|
|
|
+ completionHandler: ((Result<RetrieveImageResult, KingfisherError>) -> Void)? = nil
|
|
|
+ ) -> DownloadTask? {
|
|
|
+ let options = KingfisherParsedOptionsInfo(KingfisherManager.shared.defaultOptions + (options ?? .empty))
|
|
|
+ return setImage(
|
|
|
+ with: source,
|
|
|
+ placeholder: placeholder,
|
|
|
+ parsedOptions: options,
|
|
|
+ progressBlock: progressBlock,
|
|
|
+ completionHandler: completionHandler
|
|
|
+ )
|
|
|
+ }
|
|
|
+
|
|
|
+ /// Sets an image to the component with a requested resource.
|
|
|
+ ///
|
|
|
+ /// - Parameters:
|
|
|
+ /// - resource: The `Resource` object contains information about the resource.
|
|
|
+ /// - placeholder: A placeholder to show while retrieving the image from the given `resource`.
|
|
|
+ /// - options: An options set to define image setting behaviors. See `KingfisherOptionsInfo` for more.
|
|
|
+ /// - progressBlock: Called when the image downloading progress gets updated. If the response does not contain an
|
|
|
+ /// `expectedContentLength`, this block will not be called.
|
|
|
+ /// - completionHandler: Called when the image retrieved and set finished.
|
|
|
+ /// - Returns: A task represents the image downloading.
|
|
|
+ ///
|
|
|
+ /// - Note:
|
|
|
+ /// Internally, this method will use `KingfisherManager` to get the requested resource, from either cache
|
|
|
+ /// or network. Since this method will perform UI changes, you must call it from the main thread.
|
|
|
+ /// Both `progressBlock` and `completionHandler` will be also executed in the main thread.
|
|
|
+ ///
|
|
|
+ @discardableResult
|
|
|
+ public func setImage(
|
|
|
+ with resource: Resource?,
|
|
|
+ placeholder: KFCrossPlatformImage? = nil,
|
|
|
+ options: KingfisherOptionsInfo? = nil,
|
|
|
+ progressBlock: DownloadProgressBlock? = nil,
|
|
|
+ completionHandler: ((Result<RetrieveImageResult, KingfisherError>) -> Void)? = nil
|
|
|
+ ) -> DownloadTask? {
|
|
|
+ return setImage(
|
|
|
+ with: resource?.convertToSource(),
|
|
|
+ placeholder: placeholder,
|
|
|
+ options: options,
|
|
|
+ progressBlock: progressBlock,
|
|
|
+ completionHandler: completionHandler
|
|
|
+ )
|
|
|
+ }
|
|
|
+
|
|
|
+ func setImage(
|
|
|
+ with source: Source?,
|
|
|
+ placeholder: KFCrossPlatformImage? = nil,
|
|
|
+ parsedOptions: KingfisherParsedOptionsInfo,
|
|
|
+ progressBlock: DownloadProgressBlock? = nil,
|
|
|
+ completionHandler: ((Result<RetrieveImageResult, KingfisherError>) -> Void)? = nil
|
|
|
+ ) -> DownloadTask? {
|
|
|
+ var mutatingSelf = self
|
|
|
+ guard let source else {
|
|
|
+ base.image = placeholder
|
|
|
+ mutatingSelf.taskIdentifier = nil
|
|
|
+ completionHandler?(.failure(KingfisherError.imageSettingError(reason: .emptySource)))
|
|
|
+ return nil
|
|
|
+ }
|
|
|
+
|
|
|
+ var options = parsedOptions
|
|
|
+ if !options.keepCurrentImageWhileLoading {
|
|
|
+ base.image = placeholder
|
|
|
+ }
|
|
|
+
|
|
|
+ let issuedIdentifier = Source.Identifier.next()
|
|
|
+ mutatingSelf.taskIdentifier = issuedIdentifier
|
|
|
+
|
|
|
+ if let block = progressBlock {
|
|
|
+ options.onDataReceived = (options.onDataReceived ?? []) + [ImageLoadingProgressSideEffect(block)]
|
|
|
+ }
|
|
|
+
|
|
|
+ let task = KingfisherManager.shared.retrieveImage(
|
|
|
+ with: source,
|
|
|
+ options: options,
|
|
|
+ downloadTaskUpdated: { mutatingSelf.imageTask = $0 },
|
|
|
+ progressiveImageSetter: { self.base.image = $0 },
|
|
|
+ referenceTaskIdentifierChecker: { issuedIdentifier == self.taskIdentifier },
|
|
|
+ completionHandler: { result in
|
|
|
+ CallbackQueue.mainCurrentOrAsync.execute {
|
|
|
+ guard issuedIdentifier == self.taskIdentifier else {
|
|
|
+ let reason: KingfisherError.ImageSettingErrorReason
|
|
|
+ do {
|
|
|
+ let value = try result.get()
|
|
|
+ reason = .notCurrentSourceTask(result: value, error: nil, source: source)
|
|
|
+ } catch {
|
|
|
+ reason = .notCurrentSourceTask(result: nil, error: error, source: source)
|
|
|
+ }
|
|
|
+ let error = KingfisherError.imageSettingError(reason: reason)
|
|
|
+ completionHandler?(.failure(error))
|
|
|
+ return
|
|
|
+ }
|
|
|
+
|
|
|
+ mutatingSelf.imageTask = nil
|
|
|
+ mutatingSelf.taskIdentifier = nil
|
|
|
+
|
|
|
+ switch result {
|
|
|
+ case let .success(value):
|
|
|
+ self.base.image = value.image
|
|
|
+ completionHandler?(result)
|
|
|
+
|
|
|
+ case .failure:
|
|
|
+ if let image = options.onFailureImage {
|
|
|
+ self.base.image = image
|
|
|
+ }
|
|
|
+ completionHandler?(result)
|
|
|
+ }
|
|
|
+ }
|
|
|
+ }
|
|
|
+ )
|
|
|
+
|
|
|
+ mutatingSelf.imageTask = task
|
|
|
+ return task
|
|
|
+ }
|
|
|
+
|
|
|
+ // MARK: Cancelling Downloading Task
|
|
|
+
|
|
|
+ /// Cancels the image download task of the component if it is running.
|
|
|
+ /// Nothing will happen if the downloading has already finished.
|
|
|
+ public func cancelImageDownloadTask() {
|
|
|
+ imageTask?.cancel()
|
|
|
+ }
|
|
|
+}
|
|
|
+
|
|
|
+// MARK: - Associated Object
|
|
|
+
|
|
|
+private var taskIdentifierKey: Void?
|
|
|
+private var imageTaskKey: Void?
|
|
|
+
|
|
|
+private var alternateTaskIdentifierKey: Void?
|
|
|
+private var alternateImageTaskKey: Void?
|
|
|
+
|
|
|
+extension KingfisherWrapper where Base: KingfisherHasImageComponent {
|
|
|
+ // MARK: Properties
|
|
|
+
|
|
|
+ public private(set) var taskIdentifier: Source.Identifier.Value? {
|
|
|
+ get {
|
|
|
+ let box: Box<Source.Identifier.Value>? = getAssociatedObject(base, &taskIdentifierKey)
|
|
|
+ return box?.value
|
|
|
+ }
|
|
|
+ set {
|
|
|
+ let box = newValue.map { Box($0) }
|
|
|
+ setRetainedAssociatedObject(base, &taskIdentifierKey, box)
|
|
|
+ }
|
|
|
+ }
|
|
|
+
|
|
|
+ private var imageTask: DownloadTask? {
|
|
|
+ get { return getAssociatedObject(base, &imageTaskKey) }
|
|
|
+ set { setRetainedAssociatedObject(base, &imageTaskKey, newValue) }
|
|
|
+ }
|
|
|
+}
|
onevcat