Gifu/Source/GIFAnimatable.swift

/// The protocol that view classes need to conform to to enable animated GIF support.
public protocol GIFAnimatable: class, AnimatorDelegate, CALayerDelegate {

  /// Responsible for managing the animation frames.
  var animator: Animator? { get set }

  /// Used for displaying the animation frames.
  var image: UIImage? { get set }

  /// Notifies the instance that it needs display.
  var layer: CALayer { get }

  /// View frame used for resizing the frames.
  var frame: CGRect { get set }

  /// Content mode used for resizing the frames.
  var contentMode: UIViewContentMode { get set }

  /// Implement this method and call `updateImageIfNeeded` from within it in your conforming class.
  ///
  /// - parameter layer:
  func display(_ layer: CALayer)

  /// Needs to be called whenever the conforming class needs to check if it needs to update the current frame being displayed.
  func updateImageIfNeeded()
}
extension GIFAnimatable {
  /// Returns the intrinsic content size based on the size of the image.
  public var intrinsicContentSize: CGSize {
    return image?.size ?? CGSize.zero
  }

  /// Prepare for animation and start animating immediately.
  ///
  /// - parameter imageName:   The file name of the GIF in the main bundle.
  public func animate(withGIFNamed imageName: String) {
    animator?.animate(withGIFNamed: imageName, size: frame.size, contentMode: contentMode)
  }

  /// Introspect whether the instance is animating.
  public var isAnimatingGIF: Bool {
    return animator?.isAnimating ?? false
  }

  /// Prepares the animator instance for animation.
  ///
  /// - parameter imageName:   The file name of the GIF in the main bundle.
  public func prepareForAnimation(withGIFNamed imageName: String) {
    animator?.prepareForAnimation(withGIFNamed: imageName, size: frame.size, contentMode: contentMode)
  }

  /// Prepare for animation and start animating immediately.
  ///
  /// - parameter imageData:   GIF image data.
  public func prepareForAnimation(withGIFData imageData: Data) {
    image = UIImage(data: imageData)
    animator?.prepareForAnimation(withGIFData: imageData, size: frame.size, contentMode: contentMode)
  }

  /// Total frame count of the GIF.
  public var frameCount: Int {
    return animator?.frameCount ?? 0
  }

  /// Stop animating and free up GIF data from memory.
  public func prepareForReuse() {
    animator?.prepareForReuse()
  }

  /// Start animating GIF.
  public func startAnimatingGIF() {
    animator?.startAnimating()
  }

  /// Stop animating GIF.
  public func stopAnimatingGIF() {
    animator?.stopAnimating()
  }

  /// Updates the image with a new frame if necessary.
  public func updateImageIfNeeded() {
    image = animator?.imageToDisplay() ?? image
  }
}

extension GIFAnimatable {
  /// Calls setNeedsDisplay on the layer whenever the animator has a new frame. Should *not* be called directly.
  public func animatorHasNewFrame() {
    layer.setNeedsDisplay()
  }
}