forked from themeetgroup/lottie-ios
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix issue where LottieView animation would restart from beginning aft…
…er backgrounding app (airbnb#2237)
- Loading branch information
Showing
8 changed files
with
344 additions
and
15 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
256 changes: 256 additions & 0 deletions
256
Sources/Private/EmbeddedLibraries/LRUCache/LRUCache.swift
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,256 @@ | ||
| // | ||
| // LRUCache.swift | ||
| // LRUCache | ||
| // | ||
| // Version 1.0.2 | ||
| // | ||
| // Created by Nick Lockwood on 05/08/2021. | ||
| // Copyright © 2021 Nick Lockwood. All rights reserved. | ||
| // | ||
| // Distributed under the permissive MIT license | ||
| // Get the latest version from here: | ||
| // | ||
| // https://github.com/nicklockwood/LRUCache | ||
| // | ||
| // 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 os(iOS) || os(tvOS) | ||
| import UIKit | ||
|
|
||
| /// Notification that cache should be cleared | ||
| let LRUCacheMemoryWarningNotification: NSNotification.Name = | ||
| UIApplication.didReceiveMemoryWarningNotification | ||
|
|
||
| #else | ||
|
|
||
| /// Notification that cache should be cleared | ||
| let LRUCacheMemoryWarningNotification: NSNotification.Name = | ||
| .init("LRUCacheMemoryWarningNotification") | ||
|
|
||
| #endif | ||
|
|
||
| // MARK: - LRUCache | ||
|
|
||
| final class LRUCache<Key: Hashable, Value> { | ||
|
|
||
| // MARK: Lifecycle | ||
|
|
||
| /// Initialize the cache with the specified `totalCostLimit` and `countLimit` | ||
| init( | ||
| totalCostLimit: Int = .max, | ||
| countLimit: Int = .max, | ||
| notificationCenter: NotificationCenter = .default) | ||
| { | ||
| self.totalCostLimit = totalCostLimit | ||
| self.countLimit = countLimit | ||
| self.notificationCenter = notificationCenter | ||
|
|
||
| token = notificationCenter.addObserver( | ||
| forName: LRUCacheMemoryWarningNotification, | ||
| object: nil, | ||
| queue: nil) | ||
| { [weak self] _ in | ||
| self?.removeAllValues() | ||
| } | ||
| } | ||
|
|
||
| deinit { | ||
| if let token = token { | ||
| notificationCenter.removeObserver(token) | ||
| } | ||
| } | ||
|
|
||
| // MARK: Internal | ||
|
|
||
| /// The current total cost of values in the cache | ||
| private(set) var totalCost = 0 | ||
|
|
||
| /// The maximum total cost permitted | ||
| var totalCostLimit: Int { | ||
| didSet { clean() } | ||
| } | ||
|
|
||
| /// The maximum number of values permitted | ||
| var countLimit: Int { | ||
| didSet { clean() } | ||
| } | ||
|
|
||
| // MARK: Private | ||
|
|
||
| private var values: [Key: Container] = [:] | ||
| private unowned(unsafe) var head: Container? | ||
| private unowned(unsafe) var tail: Container? | ||
| private let lock: NSLock = .init() | ||
| private var token: AnyObject? | ||
| private let notificationCenter: NotificationCenter | ||
|
|
||
| } | ||
|
|
||
| extension LRUCache { | ||
| /// The number of values currently stored in the cache | ||
| var count: Int { | ||
| values.count | ||
| } | ||
|
|
||
| /// Is the cache empty? | ||
| var isEmpty: Bool { | ||
| values.isEmpty | ||
| } | ||
|
|
||
| /// Returns all values in the cache from oldest to newest | ||
| var allValues: [Value] { | ||
| lock.lock() | ||
| defer { lock.unlock() } | ||
| var values = [Value]() | ||
| var next = head | ||
| while let container = next { | ||
| values.append(container.value) | ||
| next = container.next | ||
| } | ||
| return values | ||
| } | ||
|
|
||
| /// Insert a value into the cache with optional `cost` | ||
| func setValue(_ value: Value?, forKey key: Key, cost: Int = 0) { | ||
| guard let value = value else { | ||
| removeValue(forKey: key) | ||
| return | ||
| } | ||
| lock.lock() | ||
| if let container = values[key] { | ||
| container.value = value | ||
| totalCost -= container.cost | ||
| container.cost = cost | ||
| remove(container) | ||
| append(container) | ||
| } else { | ||
| let container = Container( | ||
| value: value, | ||
| cost: cost, | ||
| key: key) | ||
| values[key] = container | ||
| append(container) | ||
| } | ||
| totalCost += cost | ||
| lock.unlock() | ||
| clean() | ||
| } | ||
|
|
||
| /// Remove a value from the cache and return it | ||
| @discardableResult | ||
| func removeValue(forKey key: Key) -> Value? { | ||
| lock.lock() | ||
| defer { lock.unlock() } | ||
| guard let container = values.removeValue(forKey: key) else { | ||
| return nil | ||
| } | ||
| remove(container) | ||
| totalCost -= container.cost | ||
| return container.value | ||
| } | ||
|
|
||
| /// Fetch a value from the cache | ||
| func value(forKey key: Key) -> Value? { | ||
| lock.lock() | ||
| defer { lock.unlock() } | ||
| if let container = values[key] { | ||
| remove(container) | ||
| append(container) | ||
| return container.value | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| /// Remove all values from the cache | ||
| func removeAllValues() { | ||
| lock.lock() | ||
| values.removeAll() | ||
| head = nil | ||
| tail = nil | ||
| lock.unlock() | ||
| } | ||
| } | ||
|
|
||
| extension LRUCache { | ||
|
|
||
| // MARK: Fileprivate | ||
|
|
||
| fileprivate final class Container { | ||
|
|
||
| // MARK: Lifecycle | ||
|
|
||
| init(value: Value, cost: Int, key: Key) { | ||
| self.value = value | ||
| self.cost = cost | ||
| self.key = key | ||
| } | ||
|
|
||
| // MARK: Internal | ||
|
|
||
| var value: Value | ||
| var cost: Int | ||
| let key: Key | ||
| unowned(unsafe) var prev: Container? | ||
| unowned(unsafe) var next: Container? | ||
|
|
||
| } | ||
|
|
||
| // MARK: Private | ||
|
|
||
| // Remove container from list (must be called inside lock) | ||
| private func remove(_ container: Container) { | ||
| if head === container { | ||
| head = container.next | ||
| } | ||
| if tail === container { | ||
| tail = container.prev | ||
| } | ||
| container.next?.prev = container.prev | ||
| container.prev?.next = container.next | ||
| container.next = nil | ||
| } | ||
|
|
||
| // Append container to list (must be called inside lock) | ||
| private func append(_ container: Container) { | ||
| assert(container.next == nil) | ||
| if head == nil { | ||
| head = container | ||
| } | ||
| container.prev = tail | ||
| tail?.next = container | ||
| tail = container | ||
| } | ||
|
|
||
| // Remove expired values (must be called outside lock) | ||
| private func clean() { | ||
| lock.lock() | ||
| defer { lock.unlock() } | ||
| while | ||
| totalCost > totalCostLimit || count > countLimit, | ||
| let container = head | ||
| { | ||
| remove(container) | ||
| values.removeValue(forKey: container.key) | ||
| totalCost -= container.cost | ||
| } | ||
| } | ||
| } |
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,24 @@ | ||
| ## LRUCache | ||
|
|
||
| This directory includes the source code of the LRUCache library, from the following release: | ||
| https://github.com/nicklockwood/LRUCache/releases/tag/1.0.4 | ||
|
|
||
| Lottie is distributed via multiple package managers (SPM, Cocoapods, Carthage, and NPM), | ||
| each with different packaging and compilation requirements. | ||
|
|
||
| Due to limitations of these package managers, we can't depend on / import | ||
| a separate LRUCache module / library. Instead, we include the source | ||
| directly within the Lottie library and compile everything as a single unit. | ||
|
|
||
| ### Update instructions | ||
|
|
||
| From time to time we may need to update to a more recent version of LRUCache. | ||
| When doing this, follow these steps: | ||
|
|
||
| 1. Download the latest release from https://github.com/nicklockwood/LRUCache | ||
| and replace the source code in this directory with the updated code. | ||
|
|
||
| 2. Update the URL at the top of this file to indicate what release is being used. | ||
|
|
||
| 3. Change all of the `public` symbols defined in this module to instead be `internal` | ||
| to prevent Lottie from exposing any EpoxyCore APIs. |
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
Oops, something went wrong.