-
-
Notifications
You must be signed in to change notification settings - Fork 2.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1571 from MarvinNazari/master
Adding support for TVMonogramView
- Loading branch information
Showing
3 changed files
with
212 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,200 @@ | ||
| // | ||
| // TVMonogramView+Kingfisher.swift | ||
| // Kingfisher | ||
| // | ||
| // Created by Marvin Nazari on 2020-12-07. | ||
| // | ||
| // Copyright (c) 2020 Wei Wang <[email protected]> | ||
| // | ||
| // 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. | ||
|
|
||
| import Foundation | ||
|
|
||
| #if canImport(TVUIKit) | ||
|
|
||
| import TVUIKit | ||
|
|
||
| @available(tvOS 12.0, *) | ||
| extension KingfisherWrapper where Base: TVMonogramView { | ||
|
|
||
| // MARK: Setting Image | ||
|
|
||
| /// Sets an image to the image view with a source. | ||
| /// | ||
| /// - Parameters: | ||
| /// - source: The `Source` object contains information about 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? | ||
| { | ||
| var mutatingSelf = self | ||
| guard let source = source else { | ||
| base.image = placeholder | ||
| mutatingSelf.taskIdentifier = nil | ||
| completionHandler?(.failure(KingfisherError.imageSettingError(reason: .emptySource))) | ||
| return nil | ||
| } | ||
|
|
||
| var options = KingfisherParsedOptionsInfo(KingfisherManager.shared.defaultOptions + (options ?? .empty)) | ||
| if !options.keepCurrentImageWhileLoading { | ||
| base.image = placeholder | ||
| } | ||
|
|
||
| let issuedIdentifier = Source.Identifier.next() | ||
| mutatingSelf.taskIdentifier = issuedIdentifier | ||
|
|
||
| if let block = progressBlock { | ||
| options.onDataReceived = (options.onDataReceived ?? []) + [ImageLoadingProgressSideEffect(block)] | ||
| } | ||
|
|
||
| if let provider = ImageProgressiveProvider(options, refresh: { image in | ||
| base.image = image | ||
| }) { | ||
| options.onDataReceived = (options.onDataReceived ?? []) + [provider] | ||
| } | ||
|
|
||
| options.onDataReceived?.forEach { | ||
| $0.onShouldApply = { issuedIdentifier == self.taskIdentifier } | ||
| } | ||
|
|
||
| let task = KingfisherManager.shared.retrieveImage( | ||
| with: source, | ||
| options: options, | ||
| downloadTaskUpdated: { mutatingSelf.imageTask = $0 }, | ||
| 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 .success(let 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 | ||
| } | ||
|
|
||
| /// Sets an image to the image view with a requested resource. | ||
| /// | ||
| /// - Parameters: | ||
| /// - resource: The `Resource` object contains information about 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 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) | ||
| } | ||
|
|
||
| // MARK: Cancelling Image | ||
|
|
||
| /// Cancel the image download task bounded to the image view if it is running. | ||
| /// Nothing will happen if the downloading has already finished. | ||
| public func cancelDownloadTask() { | ||
| imageTask?.cancel() | ||
| } | ||
| } | ||
|
|
||
| private var taskIdentifierKey: Void? | ||
| private var imageTaskKey: Void? | ||
|
|
||
| // MARK: Properties | ||
| @available(tvOS 12.0, *) | ||
| extension KingfisherWrapper where Base: TVMonogramView { | ||
|
|
||
| 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)} | ||
| } | ||
| } | ||
|
|
||
| #endif |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters