update
This commit is contained in:
DDIsFriend
362
Pods/Kingfisher/Sources/Extensions/NSButton+Kingfisher.swift
generated
Normal file
362
Pods/Kingfisher/Sources/Extensions/NSButton+Kingfisher.swift
generated
Normal file
@@ -0,0 +1,362 @@
|
||||
//
|
||||
// NSButton+Kingfisher.swift
|
||||
// Kingfisher
|
||||
//
|
||||
// Created by Jie Zhang on 14/04/2016.
|
||||
//
|
||||
// Copyright (c) 2019 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.
|
||||
|
||||
#if canImport(AppKit) && !targetEnvironment(macCatalyst)
|
||||
|
||||
import AppKit
|
||||
|
||||
extension KingfisherWrapper where Base: NSButton {
|
||||
|
||||
// MARK: Setting Image
|
||||
|
||||
/// Sets an image to the button 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 button 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 = 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 .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
|
||||
}
|
||||
|
||||
// MARK: Cancelling Downloading Task
|
||||
|
||||
/// Cancels the image download task of the button if it is running.
|
||||
/// Nothing will happen if the downloading has already finished.
|
||||
public func cancelImageDownloadTask() {
|
||||
imageTask?.cancel()
|
||||
}
|
||||
|
||||
// MARK: Setting Alternate Image
|
||||
|
||||
@discardableResult
|
||||
public func setAlternateImage(
|
||||
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 setAlternateImage(
|
||||
with: source,
|
||||
placeholder: placeholder,
|
||||
parsedOptions: options,
|
||||
progressBlock: progressBlock,
|
||||
completionHandler: completionHandler
|
||||
)
|
||||
}
|
||||
|
||||
/// Sets an alternate image to the button 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 setAlternateImage(
|
||||
with resource: Resource?,
|
||||
placeholder: KFCrossPlatformImage? = nil,
|
||||
options: KingfisherOptionsInfo? = nil,
|
||||
progressBlock: DownloadProgressBlock? = nil,
|
||||
completionHandler: ((Result<RetrieveImageResult, KingfisherError>) -> Void)? = nil) -> DownloadTask?
|
||||
{
|
||||
return setAlternateImage(
|
||||
with: resource?.convertToSource(),
|
||||
placeholder: placeholder,
|
||||
options: options,
|
||||
progressBlock: progressBlock,
|
||||
completionHandler: completionHandler)
|
||||
}
|
||||
|
||||
func setAlternateImage(
|
||||
with source: Source?,
|
||||
placeholder: KFCrossPlatformImage? = nil,
|
||||
parsedOptions: KingfisherParsedOptionsInfo,
|
||||
progressBlock: DownloadProgressBlock? = nil,
|
||||
completionHandler: ((Result<RetrieveImageResult, KingfisherError>) -> Void)? = nil) -> DownloadTask?
|
||||
{
|
||||
var mutatingSelf = self
|
||||
guard let source = source else {
|
||||
base.alternateImage = placeholder
|
||||
mutatingSelf.alternateTaskIdentifier = nil
|
||||
completionHandler?(.failure(KingfisherError.imageSettingError(reason: .emptySource)))
|
||||
return nil
|
||||
}
|
||||
|
||||
var options = parsedOptions
|
||||
if !options.keepCurrentImageWhileLoading {
|
||||
base.alternateImage = placeholder
|
||||
}
|
||||
|
||||
let issuedIdentifier = Source.Identifier.next()
|
||||
mutatingSelf.alternateTaskIdentifier = issuedIdentifier
|
||||
|
||||
if let block = progressBlock {
|
||||
options.onDataReceived = (options.onDataReceived ?? []) + [ImageLoadingProgressSideEffect(block)]
|
||||
}
|
||||
|
||||
if let provider = ImageProgressiveProvider(options, refresh: { image in
|
||||
self.base.alternateImage = image
|
||||
}) {
|
||||
options.onDataReceived = (options.onDataReceived ?? []) + [provider]
|
||||
}
|
||||
|
||||
options.onDataReceived?.forEach {
|
||||
$0.onShouldApply = { issuedIdentifier == self.alternateTaskIdentifier }
|
||||
}
|
||||
|
||||
let task = KingfisherManager.shared.retrieveImage(
|
||||
with: source,
|
||||
options: options,
|
||||
downloadTaskUpdated: { mutatingSelf.alternateImageTask = $0 },
|
||||
completionHandler: { result in
|
||||
CallbackQueue.mainCurrentOrAsync.execute {
|
||||
guard issuedIdentifier == self.alternateTaskIdentifier 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.alternateImageTask = nil
|
||||
mutatingSelf.alternateTaskIdentifier = nil
|
||||
|
||||
switch result {
|
||||
case .success(let value):
|
||||
self.base.alternateImage = value.image
|
||||
completionHandler?(result)
|
||||
|
||||
case .failure:
|
||||
if let image = options.onFailureImage {
|
||||
self.base.alternateImage = image
|
||||
}
|
||||
completionHandler?(result)
|
||||
}
|
||||
}
|
||||
}
|
||||
)
|
||||
|
||||
mutatingSelf.alternateImageTask = task
|
||||
return task
|
||||
}
|
||||
|
||||
// MARK: Cancelling Alternate Image Downloading Task
|
||||
|
||||
/// Cancels the alternate image download task of the button if it is running.
|
||||
/// Nothing will happen if the downloading has already finished.
|
||||
public func cancelAlternateImageDownloadTask() {
|
||||
alternateImageTask?.cancel()
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
// MARK: - Associated Object
|
||||
private var taskIdentifierKey: Void?
|
||||
private var imageTaskKey: Void?
|
||||
|
||||
private var alternateTaskIdentifierKey: Void?
|
||||
private var alternateImageTaskKey: Void?
|
||||
|
||||
extension KingfisherWrapper where Base: NSButton {
|
||||
|
||||
// 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)}
|
||||
}
|
||||
|
||||
public private(set) var alternateTaskIdentifier: Source.Identifier.Value? {
|
||||
get {
|
||||
let box: Box<Source.Identifier.Value>? = getAssociatedObject(base, &alternateTaskIdentifierKey)
|
||||
return box?.value
|
||||
}
|
||||
set {
|
||||
let box = newValue.map { Box($0) }
|
||||
setRetainedAssociatedObject(base, &alternateTaskIdentifierKey, box)
|
||||
}
|
||||
}
|
||||
|
||||
private var alternateImageTask: DownloadTask? {
|
||||
get { return getAssociatedObject(base, &alternateImageTaskKey) }
|
||||
set { setRetainedAssociatedObject(base, &alternateImageTaskKey, newValue)}
|
||||
}
|
||||
}
|
||||
#endif
|
||||
Reference in New Issue
Block a user