Blame view

Pods/Kingfisher/Sources/ImageModifier.swift 6.32 KB
f2cf74c7   yangbin   1.0.20(4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
  //
  //  ImageModifier.swift
  //  Kingfisher
  //
  //  Created by Ethan Gill on 2017/11/28.
  //
  //  Copyright (c) 2018 Ethan Gill <ethan.gill@me.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.
  
  import Foundation
  
  /// An `ImageModifier` can be used to change properties on an Image in between
  /// cache serialization and use of the image.
  public protocol ImageModifier {
      /// Modify an input `Image`.
      ///
      /// - parameter image:   Image which will be modified by `self`
      ///
      /// - returns: The modified image.
      ///
      /// - Note: The return value will be unmodified if modifying is not possible on
      ///         the current platform.
      /// - Note: Most modifiers support UIImage or NSImage, but not CGImage.
      func modify(_ image: Image) -> Image
  }
  
  extension ImageModifier {
      func modify(_ image: Image?) -> Image? {
          guard let image = image else {
              return nil
          }
          return modify(image)
      }
  }
  
  typealias ModifierImp = ((Image) -> Image)
  
  fileprivate struct GeneralModifier: ImageModifier {
      let identifier: String
      let m: ModifierImp
      func modify(_ image: Image) -> Image {
          return m(image)
      }
  }
  
  /// The default modifier.
  /// Does nothing and returns the image it was given
  public struct DefaultImageModifier: ImageModifier {
  
      /// A default `DefaultImageModifier` which can be used everywhere.
      public static let `default` = DefaultImageModifier()
  
      /// Initialize a `DefaultImageModifier`
      private init() {}
  
      /// Modify an input `Image`.
      ///
      /// - parameter image:   Image which will be modified by `self`
      ///
      /// - returns: The modified image.
      ///
      /// - Note: See documentation of `ImageModifier` protocol for more.
      public func modify(_ image: Image) -> Image {
          return image
      }
  }
  
  /// A custom modifier.
  /// Can be initialized with a block to modify images in a custom way
  public struct AnyImageModifier: ImageModifier {
  
      /// A block which modifies images, or returns the original image
      /// if modification cannot be performed.
      let block: (Image) -> Image
  
      /// Initialize an `AnyImageModifier`
      public init(modify: @escaping (Image) -> Image) {
          block = modify
      }
  
      /// Modifies an input `Image` using this `AnyImageModifier`'s `block`.
      ///
      /// - parameter image:   Image which will be modified by `self`
      ///
      /// - returns: The modified image.
      ///
      /// - Note: See documentation of `ImageModifier` protocol for more.
      public func modify(_ image: Image) -> Image {
          return block(image)
      }
  }
  
  #if os(iOS) || os(tvOS) || os(watchOS)
  import UIKit
  
  /// Modifier for setting the rendering mode of images.
  /// Only UI-based images are supported; if a non-UI image is passed in, the
  /// modifier will do nothing.
  public struct RenderingModeImageModifier: ImageModifier {
  
      /// The rendering mode to apply to the image.
      public let renderingMode: UIImage.RenderingMode
  
      /// Initialize a `RenderingModeImageModifier`
      ///
      /// - parameter renderingMode: The rendering mode to apply to the image.
      ///                            Default is .automatic
      public init(renderingMode: UIImage.RenderingMode = .automatic) {
          self.renderingMode = renderingMode
      }
  
      /// Modify an input `Image`.
      ///
      /// - parameter image:   Image which will be modified by `self`
      ///
      /// - returns: The modified image.
      ///
      /// - Note: See documentation of `ImageModifier` protocol for more.
      public func modify(_ image: Image) -> Image {
          return image.withRenderingMode(renderingMode)
      }
  }
  
  /// Modifier for setting the `flipsForRightToLeftLayoutDirection` property of images.
  /// Only UI-based images are supported; if a non-UI image is passed in, the
  /// modifier will do nothing.
  public struct FlipsForRightToLeftLayoutDirectionImageModifier: ImageModifier {
      /// Initialize a `FlipsForRightToLeftLayoutDirectionImageModifier`
      ///
      /// - Note: On versions of iOS lower than 9.0, the image will be returned
      ///         unmodified.
      public init() {}
  
      /// Modify an input `Image`.
      ///
      /// - parameter image:   Image which will be modified by `self`
      ///
      /// - returns: The modified image.
      ///
      /// - Note: See documentation of `ImageModifier` protocol for more.
      public func modify(_ image: Image) -> Image {
          if #available(iOS 9.0, *) {
              return image.imageFlippedForRightToLeftLayoutDirection()
          } else {
              return image
          }
      }
  }
  
  /// Modifier for setting the `alignmentRectInsets` property of images.
  /// Only UI-based images are supported; if a non-UI image is passed in, the
  /// modifier will do nothing.
  public struct AlignmentRectInsetsImageModifier: ImageModifier {
  
      /// The alignment insets to apply to the image
      public let alignmentInsets: UIEdgeInsets
  
      /// Initialize a `AlignmentRectInsetsImageModifier`
      public init(alignmentInsets: UIEdgeInsets) {
          self.alignmentInsets = alignmentInsets
      }
  
      /// Modify an input `Image`.
      ///
      /// - parameter image:   Image which will be modified by `self`
      ///
      /// - returns: The modified image.
      ///
      /// - Note: See documentation of `ImageModifier` protocol for more.
      public func modify(_ image: Image) -> Image {
          return image.withAlignmentRectInsets(alignmentInsets)
      }
  }
  #endif