diff options
author | toasted-nutbread <toasted-nutbread@users.noreply.github.com> | 2021-02-13 22:52:28 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-02-13 22:52:28 -0500 |
commit | 6a271e067fa917614f4c81f473533e24c6d04404 (patch) | |
tree | 0d81658b1c03aecfbba133425aefc0ea7612338c /ext/js/general/cache-map.js | |
parent | deed5027cd18bcdb9cb9d13cb7831be0ec5384e8 (diff) |
Move mixed/js (#1383)
* Move mixed/js/core.js to js/core.js
* Move mixed/js/yomichan.js to js/yomichan.js
* Move mixed/js/timer.js to js/debug/timer.js
* Move mixed/js/hotkey-handler.js to js/input/hotkey-handler.js
* Move mixed/js/hotkey-help-controller.js to js/input/hotkey-help-controller.js
* Move mixed/js/hotkey-util.js to js/input/hotkey-util.js
* Move mixed/js/audio-system.js to js/input/audio-system.js
* Move mixed/js/media-loader.js to js/input/media-loader.js
* Move mixed/js/text-to-speech-audio.js to js/input/text-to-speech-audio.js
* Move mixed/js/comm.js to js/comm/cross-frame-api.js
* Move mixed/js/api.js to js/comm/api.js
* Move mixed/js/frame-client.js to js/comm/frame-client.js
* Move mixed/js/frame-endpoint.js to js/comm/frame-endpoint.js
* Move mixed/js/display.js to js/display/display.js
* Move mixed/js/display-audio.js to js/display/display-audio.js
* Move mixed/js/display-generator.js to js/display/display-generator.js
* Move mixed/js/display-history.js to js/display/display-history.js
* Move mixed/js/display-notification.js to js/display/display-notification.js
* Move mixed/js/display-profile-selection.js to js/display/display-profile-selection.js
* Move mixed/js/japanese.js to js/language/japanese-util.js
* Move mixed/js/dictionary-data-util.js to js/language/dictionary-data-util.js
* Move mixed/js/document-focus-controller.js to js/dom/document-focus-controller.js
* Move mixed/js/document-util.js to js/dom/document-util.js
* Move mixed/js/dom-data-binder.js to js/dom/dom-data-binder.js
* Move mixed/js/html-template-collection.js to js/dom/html-template-collection.js
* Move mixed/js/panel-element.js to js/dom/panel-element.js
* Move mixed/js/popup-menu.js to js/dom/popup-menu.js
* Move mixed/js/selector-observer.js to js/dom/selector-observer.js
* Move mixed/js/scroll.js to js/dom/window-scroll.js
* Move mixed/js/text-scanner.js to js/language/text-scanner.js
* Move mixed/js/cache-map.js to js/general/cache-map.js
* Move mixed/js/object-property-accessor.js to js/general/object-property-accessor.js
* Move mixed/js/task-accumulator.js to js/general/task-accumulator.js
* Move mixed/js/environment.js to js/background/environment.js
* Move mixed/js/dynamic-loader.js to js/scripting/dynamic-loader.js
* Move mixed/js/dynamic-loader-sentinel.js to js/scripting/dynamic-loader-sentinel.js
Diffstat (limited to 'ext/js/general/cache-map.js')
-rw-r--r-- | ext/js/general/cache-map.js | 140 |
1 files changed, 140 insertions, 0 deletions
diff --git a/ext/js/general/cache-map.js b/ext/js/general/cache-map.js new file mode 100644 index 00000000..c7d72e6b --- /dev/null +++ b/ext/js/general/cache-map.js @@ -0,0 +1,140 @@ +/* + * Copyright (C) 2020-2021 Yomichan Authors + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see <https://www.gnu.org/licenses/>. + */ + +/** + * Class which caches a map of values, keeping the most recently accessed values. + */ +class CacheMap { + /** + * Creates a new CacheMap. + * @param maxSize The maximum number of entries able to be stored in the cache. + */ + constructor(maxSize) { + if (!( + typeof maxSize === 'number' && + Number.isFinite(maxSize) && + maxSize >= 0 && + Math.floor(maxSize) === maxSize + )) { + throw new Error('Invalid maxCount'); + } + + this._maxSize = maxSize; + this._map = new Map(); + this._listFirst = this._createNode(null, null); + this._listLast = this._createNode(null, null); + this._resetEndNodes(); + } + + /** + * Returns the number of items in the cache. + */ + get size() { + return this._map.size; + } + + /** + * Returns the maximum number of items that can be added to the cache. + */ + get maxSize() { + return this._maxSize; + } + + /** + * Returns whether or not an element exists at the given key. + * @param key The key of the element. + * @returns `true` if an element with the specified key exists, `false` otherwise. + */ + has(key) { + return this._map.has(key); + } + + /** + * Gets an element at the given key, if it exists. Otherwise, returns undefined. + * @param key The key of the element. + * @returns The existing value at the key, if any; `undefined` otherwise. + */ + get(key) { + const node = this._map.get(key); + if (typeof node === 'undefined') { return void 0; } + this._updateRecency(node); + return node.value; + } + + /** + * Sets a value at a given key. + * @param key The key of the element. + * @param value The value to store in the cache. + */ + set(key, value) { + let node = this._map.get(key); + if (typeof node !== 'undefined') { + this._updateRecency(node); + node.value = value; + } else { + if (this._maxSize <= 0) { return; } + + node = this._createNode(key, value); + this._addNode(node, this._listFirst); + this._map.set(key, node); + + // Remove + for (let removeCount = this._map.size - this._maxSize; removeCount > 0; --removeCount) { + node = this._listLast.previous; + this._removeNode(node); + this._map.delete(node.key); + } + } + } + + /** + * Clears the cache. + */ + clear() { + this._map.clear(); + this._resetEndNodes(); + } + + // Private + + _updateRecency(node) { + this._removeNode(node); + this._addNode(node, this._listFirst); + } + + _createNode(key, value) { + return {key, value, previous: null, next: null}; + } + + _addNode(node, previous) { + const next = previous.next; + node.next = next; + node.previous = previous; + previous.next = node; + next.previous = node; + } + + _removeNode(node) { + node.next.previous = node.previous; + node.previous.next = node.next; + } + + _resetEndNodes() { + this._listFirst.next = this._listLast; + this._listLast.previous = this._listFirst; + } +} |