UIButton+Ext.swift

//
//  UIButton+Ext.swift
//  ImageX
//
//  Created by Condy on 2023/6/29.
//

import Foundation
import Harbeth

#if canImport(UIKit) && !os(watchOS)
import UIKit

extension UIButton: AsAnimatable, UIButtonContainer, ImageXCompatible { }

extension ImageXEngine where Base: UIButton {
    
    /// Sets an image or gif to the button for a specified state with a named, And add the filters.
    /// - Parameters:
    ///   - named: Picture or gif name.
    ///   - state: The button state to which the image or gif should be set.
    ///   - options: Represents creating options used in ImageX.
    public func setImage(
        with named: String?,
        for state: UIControl.State,
        options: ImageXOptions = ImageXOptions.default
    ) {
        let other = Others(key: Others.UIButtonKey.image.rawValue, value: state)
        Driver.setImage(named: named, to: base, options: options, other: other)
    }
    
    /// Sets an image or gif to the button for a specified state with a data, And add the filters.
    /// - Parameters:
    ///   - data: Picture data.
    ///   - state: The button state to which the image or gif should be set.
    ///   - options: Represents creating options used in ImageX.
    /// - Returns: A uniform type identifier UTI.
    @discardableResult public func setImage(
        with data: Data?,
        for state: UIControl.State,
        options: ImageXOptions = ImageXOptions.default
    ) -> AssetType {
        let other = Others(key: Others.UIButtonKey.image.rawValue, value: state)
        return Driver.setImage(data: data, to: base, options: options, other: other)
    }
    
    /// Sets an image or gif to the button for a specified state with a url, And add the filters.
    /// - Parameters:
    ///   - url: Link url.
    ///   - state: The button state to which the image or gif should be set.
    ///   - options: Represents creating options used in ImageX.
    /// - Returns: Current network URLSessionDataTask.
    @discardableResult public func setImage(
        with url: URL?,
        for state: UIControl.State,
        options: ImageXOptions = ImageXOptions.default
    ) -> ImageX.Task? {
        let other = Others(key: Others.UIButtonKey.image.rawValue, value: state)
        return Driver.setImage(url: url, to: base, options: options, other: other)
    }
    
    /// Sets an image or gif to the button for a specified state with a named, And add the filters.
    /// - Parameters:
    ///   - named: Picture or gif name.
    ///   - state: The button state to which the image or gif should be set.
    ///   - options: Represents creating options used in ImageX.
    public func setBackgroundImage(
        with named: String?,
        for state: UIControl.State,
        options: ImageXOptions = ImageXOptions.default
    ) {
        let other = Others(key: Others.UIButtonKey.backgroundImage.rawValue, value: state)
        Driver.setImage(named: named, to: base, options: options, other: other)
    }
    
    /// Sets an image or gif to the button for a specified state with a data, And add the filters.
    /// - Parameters:
    ///   - data: Picture data.
    ///   - state: The button state to which the image or gif should be set.
    ///   - options: Represents creating options used in ImageX.
    /// - Returns: A uniform type identifier UTI.
    @discardableResult public func setBackgroundImage(
        with data: Data?,
        for state: UIControl.State,
        options: ImageXOptions = ImageXOptions.default
    ) -> AssetType {
        let other = Others(key: Others.UIButtonKey.backgroundImage.rawValue, value: state)
        return Driver.setImage(data: data, to: base, options: options, other: other)
    }
    
    /// Sets an image or gif to the button for a specified state with a url, And add the filters.
    /// - Parameters:
    ///   - url: Link url.
    ///   - state: The button state to which the image or gif should be set.
    ///   - options: Represents creating options used in ImageX.
    /// - Returns: Current network URLSessionDataTask.
    @discardableResult public func setBackgroundImage(
        with url: URL?,
        for state: UIControl.State,
        options: ImageXOptions = ImageXOptions.default
    ) -> ImageX.Task? {
        let other = Others(key: Others.UIButtonKey.backgroundImage.rawValue, value: state)
        return Driver.setImage(url: url, to: base, options: options, other: other)
    }
}

#endif