AnkiTemplateRendererContentManager (#2088)

* Make function private

* Update comments

* Refactor the content manager that is provided to StructuredContentGenerator in AnkiTemplateRenderer

* Update function to not be async, for API parity
This commit is contained in:
toasted-nutbread 2022-03-14 22:32:08 -04:00 committed by GitHub
parent 4e15f92329
commit 8aa060337c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 124 additions and 22 deletions

View File

@ -19,26 +19,46 @@
* StringUtil * StringUtil
*/ */
/**
* A callback used when a media file has been loaded.
* @callback DisplayContentManager.OnLoadCallback
* @param {string} url The URL of the media that was loaded.
*/
/**
* A callback used when a media file should be unloaded.
* @callback DisplayContentManager.OnUnloadCallback
* @param {boolean} fullyLoaded Whether or not the media was fully loaded.
*/
/**
* The content manager which is used when generating HTML display content.
*/
class DisplayContentManager { class DisplayContentManager {
/**
* Creates a new instance of the class.
*/
constructor() { constructor() {
this._token = {}; this._token = {};
this._mediaCache = new Map(); this._mediaCache = new Map();
this._loadMediaData = []; this._loadMediaData = [];
} }
async loadMedia(path, dictionary, onLoad, onUnload) { /**
const token = this._token; * Attempts to load the media file from a given dictionary.
const data = {onUnload, loaded: false}; * @param {string} path The path to the media file in the dictionary.
* @param {string} dictionary The name of the dictionary.
this._loadMediaData.push(data); * @param {DisplayContentManager.OnLoadCallback} onLoad The callback that is executed if the media was loaded successfully.
* No assumptions should be made about the synchronicity of this callback.
const media = await this.getMedia(path, dictionary); * @param {DisplayContentManager.OnUnloadCallback} onUnload The callback that is executed when the media should be unloaded.
if (token !== this._token) { return; } */
loadMedia(path, dictionary, onLoad, onUnload) {
onLoad(media.url); this._loadMedia(path, dictionary, onLoad, onUnload);
data.loaded = true;
} }
/**
* Unloads all media that has been loaded.
*/
unloadAll() { unloadAll() {
for (const {onUnload, loaded} of this._loadMediaData) { for (const {onUnload, loaded} of this._loadMediaData) {
if (typeof onUnload === 'function') { if (typeof onUnload === 'function') {
@ -59,7 +79,20 @@ class DisplayContentManager {
this._token = {}; this._token = {};
} }
async getMedia(path, dictionary) { async _loadMedia(path, dictionary, onLoad, onUnload) {
const token = this._token;
const data = {onUnload, loaded: false};
this._loadMediaData.push(data);
const media = await this._getMedia(path, dictionary);
if (token !== this._token) { return; }
onLoad(media.url);
data.loaded = true;
}
async _getMedia(path, dictionary) {
let cachedData; let cachedData;
let dictionaryCache = this._mediaCache.get(dictionary); let dictionaryCache = this._mediaCache.get(dictionary);
if (typeof dictionaryCache !== 'undefined') { if (typeof dictionaryCache !== 'undefined') {

View File

@ -0,0 +1,72 @@
/*
* Copyright (C) 2022 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/>.
*/
/**
* A callback used when a media file has been loaded.
* @callback AnkiTemplateRendererContentManager.OnLoadCallback
* @param {string} url The URL of the media that was loaded.
*/
/**
* A callback used when a media file should be unloaded.
* @callback AnkiTemplateRendererContentManager.OnUnloadCallback
* @param {boolean} fullyLoaded Whether or not the media was fully loaded.
*/
/**
* The content manager which is used when generating content for Anki.
*/
class AnkiTemplateRendererContentManager {
/**
* Creates a new instance of the class.
* @param {TemplateRendererMediaProvider} mediaProvider The media provider for the object.
* @param {object} data The data object passed to the Handlebars template renderer.
* See {@link AnkiNoteDataCreator.create}'s return value for structure information.
*/
constructor(mediaProvider, data) {
this._mediaProvider = mediaProvider;
this._data = data;
this._onUnloadCallbacks = [];
}
/**
* Attempts to load the media file from a given dictionary.
* @param {string} path The path to the media file in the dictionary.
* @param {string} dictionary The name of the dictionary.
* @param {AnkiTemplateRendererContentManager.OnLoadCallback} onLoad The callback that is executed if the media was loaded successfully.
* No assumptions should be made about the synchronicity of this callback.
* @param {AnkiTemplateRendererContentManager.OnUnloadCallback} onUnload The callback that is executed when the media should be unloaded.
*/
loadMedia(path, dictionary, onLoad, onUnload) {
const imageUrl = this._mediaProvider.getMedia(this._data, ['dictionaryMedia', path], {dictionary, format: 'fileName', default: null});
if (imageUrl === null) { return; }
onLoad(imageUrl);
if (typeof onUnload === 'function') {
this._onUnloadCallbacks.push(onUnload);
}
}
/**
* Unloads all media that has been loaded.
*/
unloadAll() {
for (const onUnload of this._onUnloadCallbacks) {
onUnload(true);
}
this._onUnloadCallbacks = [];
}
}

View File

@ -17,6 +17,7 @@
/* global /* global
* AnkiNoteDataCreator * AnkiNoteDataCreator
* AnkiTemplateRendererContentManager
* CssStyleApplier * CssStyleApplier
* DictionaryDataUtil * DictionaryDataUtil
* Handlebars * Handlebars
@ -534,16 +535,10 @@ class AnkiTemplateRenderer {
} }
_createStructuredContentGenerator(data) { _createStructuredContentGenerator(data) {
const mediaLoader = { const contentManager = new AnkiTemplateRendererContentManager(this._mediaProvider, data);
loadMedia: async (path, dictionary, onLoad, onUnload) => { const instance = new StructuredContentGenerator(contentManager, document);
const imageUrl = this._mediaProvider.getMedia(data, ['dictionaryMedia', path], {dictionary, format: 'fileName', default: null}); this._cleanupCallbacks.push(() => contentManager.unloadAll());
if (imageUrl !== null) { return instance;
onLoad(imageUrl);
this._cleanupCallbacks.push(() => onUnload(true));
}
}
};
return new StructuredContentGenerator(mediaLoader, document);
} }
_formatGlossary(context, dictionary, options) { _formatGlossary(context, dictionary, options) {

View File

@ -24,6 +24,7 @@
<script src="/js/language/sandbox/dictionary-data-util.js"></script> <script src="/js/language/sandbox/dictionary-data-util.js"></script>
<script src="/js/language/sandbox/japanese-util.js"></script> <script src="/js/language/sandbox/japanese-util.js"></script>
<script src="/js/templates/sandbox/anki-template-renderer.js"></script> <script src="/js/templates/sandbox/anki-template-renderer.js"></script>
<script src="/js/templates/sandbox/anki-template-renderer-content-manager.js"></script>
<script src="/js/templates/sandbox/template-renderer.js"></script> <script src="/js/templates/sandbox/template-renderer.js"></script>
<script src="/js/templates/sandbox/template-renderer-frame-api.js"></script> <script src="/js/templates/sandbox/template-renderer-frame-api.js"></script>
<script src="/js/templates/sandbox/template-renderer-media-provider.js"></script> <script src="/js/templates/sandbox/template-renderer-media-provider.js"></script>

View File

@ -47,6 +47,7 @@ async function createVM() {
'js/display/sandbox/pronunciation-generator.js', 'js/display/sandbox/pronunciation-generator.js',
'js/display/sandbox/structured-content-generator.js', 'js/display/sandbox/structured-content-generator.js',
'js/templates/sandbox/anki-template-renderer.js', 'js/templates/sandbox/anki-template-renderer.js',
'js/templates/sandbox/anki-template-renderer-content-manager.js',
'js/templates/sandbox/template-renderer.js', 'js/templates/sandbox/template-renderer.js',
'js/templates/sandbox/template-renderer-media-provider.js', 'js/templates/sandbox/template-renderer-media-provider.js',
'lib/handlebars.min.js' 'lib/handlebars.min.js'