summaryrefslogtreecommitdiff
path: root/ext/mixed/js
diff options
context:
space:
mode:
Diffstat (limited to 'ext/mixed/js')
-rw-r--r--ext/mixed/js/display-generator.js332
-rw-r--r--ext/mixed/js/display.js87
2 files changed, 392 insertions, 27 deletions
diff --git a/ext/mixed/js/display-generator.js b/ext/mixed/js/display-generator.js
new file mode 100644
index 00000000..37be5041
--- /dev/null
+++ b/ext/mixed/js/display-generator.js
@@ -0,0 +1,332 @@
+/*
+ * Copyright (C) 2019-2020 Alex Yatskov <alex@foosoft.net>
+ * Author: Alex Yatskov <alex@foosoft.net>
+ *
+ * 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 <http://www.gnu.org/licenses/>.
+ */
+
+
+class DisplayGenerator {
+ constructor() {
+ this._termEntryTemplate = document.querySelector('#term-entry-template');
+ this._termExpressionTemplate = document.querySelector('#term-expression-template');
+ this._termDefinitionItemTemplate = document.querySelector('#term-definition-item-template');
+ this._termDefinitionOnlyTemplate = document.querySelector('#term-definition-only-template');
+ this._termGlossaryItemTemplate = document.querySelector('#term-glossary-item-template');
+ this._termReasonTemplate = document.querySelector('#term-reason-template');
+
+ this._kanjiEntryTemplate = document.querySelector('#kanji-entry-template');
+ this._kanjiInfoTableTemplate = document.querySelector('#kanji-info-table-template');
+ this._kanjiInfoTableItemTemplate = document.querySelector('#kanji-info-table-item-template');
+ this._kanjiInfoTableEmptyTemplate = document.querySelector('#kanji-info-table-empty-template');
+ this._kanjiGlossaryItemTemplate = document.querySelector('#kanji-glossary-item-template');
+ this._kanjiReadingTemplate = document.querySelector('#kanji-reading-template');
+
+ this._tagTemplate = document.querySelector('#tag-template');
+ this._tagFrequencyTemplate = document.querySelector('#tag-frequency-template');
+ }
+
+ createTermEntry(details) {
+ const node = DisplayGenerator._instantiateTemplate(this._termEntryTemplate);
+
+ const expressionsContainer = node.querySelector('.term-expression-list');
+ const reasonsContainer = node.querySelector('.reasons');
+ const frequenciesContainer = node.querySelector('.frequencies');
+ const definitionsContainer = node.querySelector('.term-definition-list');
+ const debugInfoContainer = node.querySelector('.debug-info');
+
+ const multiExpression = Array.isArray(details.expressions);
+ const multiDefinition = Array.isArray(details.definitions);
+
+ node.dataset.multiExpression = `${multiExpression}`;
+ node.dataset.multiDefinition = `${multiDefinition}`;
+
+ DisplayGenerator._appendMultiple(expressionsContainer, this.createTermExpression.bind(this), details.expressions, [details]);
+ DisplayGenerator._appendMultiple(reasonsContainer, this.createTermReason.bind(this), details.reasons);
+ DisplayGenerator._appendMultiple(frequenciesContainer, this.createFrequencyTag.bind(this), details.frequencies);
+ DisplayGenerator._appendMultiple(definitionsContainer, this.createTermDefinitionItem.bind(this), details.definitions, [details]);
+
+ if (debugInfoContainer !== null) {
+ debugInfoContainer.textContent = JSON.stringify(details, null, 4);
+ }
+
+ return node;
+ }
+
+ createTermExpression(details) {
+ const node = DisplayGenerator._instantiateTemplate(this._termExpressionTemplate);
+
+ const expressionContainer = node.querySelector('.term-expression-text');
+ const tagContainer = node.querySelector('.tags');
+ const frequencyContainer = node.querySelector('.frequencies');
+
+ if (details.termFrequency) {
+ node.dataset.frequency = details.termFrequency;
+ }
+
+ if (expressionContainer !== null) {
+ const segments = [{text: details.expression, furigana: details.reading}]; // TODO : Use proper furigana segmentation
+ DisplayGenerator._appendFurigana(expressionContainer, segments, this._appendKanjiLinks.bind(this));
+ }
+
+ DisplayGenerator._appendMultiple(tagContainer, this.createTag.bind(this), details.termTags);
+ DisplayGenerator._appendMultiple(frequencyContainer, this.createFrequencyTag.bind(this), details.frequencies);
+
+ return node;
+ }
+
+ createTermReason(reason) {
+ const node = DisplayGenerator._instantiateTemplate(this._termReasonTemplate);
+ node.textContent = reason;
+ node.dataset.reason = reason;
+ return node;
+ }
+
+ createTermDefinitionItem(details) {
+ const node = DisplayGenerator._instantiateTemplate(this._termDefinitionItemTemplate);
+
+ const tagListContainer = node.querySelector('.term-definition-tag-list');
+ const onlyListContainer = node.querySelector('.term-definition-only-list');
+ const glossaryContainer = node.querySelector('.term-glossary-list');
+
+ node.dataset.dictionary = details.dictionary;
+
+ DisplayGenerator._appendMultiple(tagListContainer, this.createTag.bind(this), details.definitionTags);
+ DisplayGenerator._appendMultiple(onlyListContainer, this.createTermOnly.bind(this), details.only);
+ DisplayGenerator._appendMultiple(glossaryContainer, this.createTermGlossaryItem.bind(this), details.glossary);
+
+ return node;
+ }
+
+ createTermGlossaryItem(glossary) {
+ const node = DisplayGenerator._instantiateTemplate(this._termGlossaryItemTemplate);
+ const container = node.querySelector('.term-glossary');
+ if (container !== null) {
+ DisplayGenerator._appendMultilineText(container, glossary);
+ }
+ return node;
+ }
+
+ createTermOnly(only) {
+ const node = DisplayGenerator._instantiateTemplate(this._termDefinitionOnlyTemplate);
+ node.dataset.only = only;
+ node.textContent = only;
+ return node;
+ }
+
+ createKanjiLink(character) {
+ const node = document.createElement('a');
+ node.href = '#';
+ node.className = 'kanji-link';
+ node.textContent = character;
+ return node;
+ }
+
+ createKanjiEntry(details) {
+ const node = DisplayGenerator._instantiateTemplate(this._kanjiEntryTemplate);
+
+ const glyphContainer = node.querySelector('.kanji-glyph');
+ const frequenciesContainer = node.querySelector('.frequencies');
+ const tagContainer = node.querySelector('.tags');
+ const glossaryContainer = node.querySelector('.kanji-glossary-list');
+ const chineseReadingsContainer = node.querySelector('.kanji-readings-chinese');
+ const japaneseReadingsContainer = node.querySelector('.kanji-readings-japanese');
+ const statisticsContainer = node.querySelector('.kanji-statistics');
+ const classificationsContainer = node.querySelector('.kanji-classifications');
+ const codepointsContainer = node.querySelector('.kanji-codepoints');
+ const dictionaryIndicesContainer = node.querySelector('.kanji-dictionary-indices');
+ const debugInfoContainer = node.querySelector('.debug-info');
+
+ if (glyphContainer !== null) {
+ glyphContainer.textContent = details.character;
+ }
+
+ DisplayGenerator._appendMultiple(frequenciesContainer, this.createFrequencyTag.bind(this), details.frequencies);
+ DisplayGenerator._appendMultiple(tagContainer, this.createTag.bind(this), details.tags);
+ DisplayGenerator._appendMultiple(glossaryContainer, this.createKanjiGlossaryItem.bind(this), details.glossary);
+ DisplayGenerator._appendMultiple(chineseReadingsContainer, this.createKanjiReading.bind(this), details.onyomi);
+ DisplayGenerator._appendMultiple(japaneseReadingsContainer, this.createKanjiReading.bind(this), details.kunyomi);
+
+ if (statisticsContainer !== null) {
+ statisticsContainer.appendChild(this.createKanjiInfoTable(details.stats.misc));
+ }
+ if (classificationsContainer !== null) {
+ classificationsContainer.appendChild(this.createKanjiInfoTable(details.stats.class));
+ }
+ if (codepointsContainer !== null) {
+ codepointsContainer.appendChild(this.createKanjiInfoTable(details.stats.code));
+ }
+ if (dictionaryIndicesContainer !== null) {
+ dictionaryIndicesContainer.appendChild(this.createKanjiInfoTable(details.stats.index));
+ }
+
+ if (debugInfoContainer !== null) {
+ debugInfoContainer.textContent = JSON.stringify(details, null, 4);
+ }
+
+ return node;
+ }
+
+ createKanjiGlossaryItem(glossary) {
+ const node = DisplayGenerator._instantiateTemplate(this._kanjiGlossaryItemTemplate);
+ const container = node.querySelector('.kanji-glossary');
+ if (container !== null) {
+ DisplayGenerator._appendMultilineText(container, glossary);
+ }
+ return node;
+ }
+
+ createKanjiReading(reading) {
+ const node = DisplayGenerator._instantiateTemplate(this._kanjiReadingTemplate);
+ node.textContent = reading;
+ return node;
+ }
+
+ createKanjiInfoTable(details) {
+ const node = DisplayGenerator._instantiateTemplate(this._kanjiInfoTableTemplate);
+
+ const container = node.querySelector('.kanji-info-table-body');
+
+ if (container !== null) {
+ const count = DisplayGenerator._appendMultiple(container, this.createKanjiInfoTableItem.bind(this), details);
+ if (count === 0) {
+ const n = this.createKanjiInfoTableItemEmpty();
+ container.appendChild(n);
+ }
+ }
+
+ return node;
+ }
+
+ createKanjiInfoTableItem(details) {
+ const node = DisplayGenerator._instantiateTemplate(this._kanjiInfoTableItemTemplate);
+ const nameNode = node.querySelector('.kanji-info-table-item-header');
+ const valueNode = node.querySelector('.kanji-info-table-item-value');
+ if (nameNode !== null) {
+ nameNode.textContent = details.notes || details.name;
+ }
+ if (valueNode !== null) {
+ valueNode.textContent = details.value;
+ }
+ return node;
+ }
+
+ createKanjiInfoTableItemEmpty() {
+ return DisplayGenerator._instantiateTemplate(this._kanjiInfoTableEmptyTemplate);
+ }
+
+ createTag(details) {
+ const node = DisplayGenerator._instantiateTemplate(this._tagTemplate);
+
+ node.title = details.notes;
+ node.textContent = details.name;
+ node.dataset.category = details.category;
+
+ return node;
+ }
+
+ createFrequencyTag(details) {
+ const node = DisplayGenerator._instantiateTemplate(this._tagFrequencyTemplate);
+
+ let n = node.querySelector('.term-frequency-dictionary-name');
+ if (n !== null) {
+ n.textContent = details.dictionary;
+ }
+
+ n = node.querySelector('.term-frequency-value');
+ if (n !== null) {
+ n.textContent = `${details.frequency}`;
+ }
+
+ node.dataset.dictionary = details.dictionary;
+ node.dataset.frequency = details.frequency;
+
+ return node;
+ }
+
+ _appendKanjiLinks(container, text) {
+ let part = '';
+ for (const c of text) {
+ if (DisplayGenerator._isCharacterKanji(c)) {
+ if (part.length > 0) {
+ container.appendChild(document.createTextNode(part));
+ part = '';
+ }
+
+ const link = this.createKanjiLink(c);
+ container.appendChild(link);
+ } else {
+ part += c;
+ }
+ }
+ if (part.length > 0) {
+ container.appendChild(document.createTextNode(part));
+ }
+ }
+
+ static _isCharacterKanji(c) {
+ const code = c.charCodeAt(0);
+ return (
+ code >= 0x4e00 && code < 0x9fb0 ||
+ code >= 0x3400 && code < 0x4dc0
+ );
+ }
+
+ static _appendMultiple(container, createItem, detailsArray, fallback=[]) {
+ if (container === null) { return 0; }
+
+ const isArray = Array.isArray(detailsArray);
+ if (!isArray) { detailsArray = fallback; }
+
+ container.dataset.multi = `${isArray}`;
+ container.dataset.count = `${detailsArray.length}`;
+
+ for (const details of detailsArray) {
+ const item = createItem(details);
+ if (item === null) { continue; }
+ container.appendChild(item);
+ }
+
+ return detailsArray.length;
+ }
+
+ static _appendFurigana(container, segments, addText) {
+ for (const {text, furigana} of segments) {
+ if (furigana) {
+ const ruby = document.createElement('ruby');
+ const rt = document.createElement('rt');
+ addText(ruby, text);
+ ruby.appendChild(rt);
+ rt.appendChild(document.createTextNode(furigana));
+ container.appendChild(ruby);
+ } else {
+ addText(container, text);
+ }
+ }
+ }
+
+ static _appendMultilineText(container, text) {
+ const parts = text.split('\n');
+ container.appendChild(document.createTextNode(parts[0]));
+ for (let i = 1, ii = parts.length; i < ii; ++i) {
+ container.appendChild(document.createElement('br'));
+ container.appendChild(document.createTextNode(parts[i]));
+ }
+ }
+
+ static _instantiateTemplate(template) {
+ const content = document.importNode(template.content, true);
+ return content.firstChild;
+ }
+}
diff --git a/ext/mixed/js/display.js b/ext/mixed/js/display.js
index e756f948..f61e76b5 100644
--- a/ext/mixed/js/display.js
+++ b/ext/mixed/js/display.js
@@ -37,6 +37,7 @@ class Display {
this.eventListenersActive = false;
this.clickScanPrevent = false;
+ this.displayGenerator = new DisplayGenerator();
this.windowScroll = new WindowScroll();
this.setInteractive(true);
@@ -240,11 +241,20 @@ class Display {
async updateOptions(options) {
this.options = options ? options : await apiOptionsGet(this.getOptionsContext());
+ this.updateDocumentOptions(this.options);
this.updateTheme(this.options.general.popupTheme);
this.setCustomCss(this.options.general.customPopupCss);
audioPrepareTextToSpeech(this.options);
}
+ updateDocumentOptions(options) {
+ const data = document.documentElement.dataset;
+ data.ankiEnabled = `${options.anki.enable}`;
+ data.audioEnabled = `${options.audio.enable}`;
+ data.compactGlossaries = `${options.general.compactGlossaries}`;
+ data.debug = `${options.general.debugInfo}`;
+ }
+
updateTheme(themeName) {
document.documentElement.dataset.yomichanTheme = themeName;
@@ -277,6 +287,9 @@ class Display {
if (interactive) {
Display.addEventListener(this.persistentEventListeners, document, 'keydown', this.onKeyDown.bind(this), false);
Display.addEventListener(this.persistentEventListeners, document, 'wheel', this.onWheel.bind(this), {passive: false});
+ Display.addEventListener(this.persistentEventListeners, document.querySelector('.action-previous'), 'click', this.onSourceTermView.bind(this));
+ Display.addEventListener(this.persistentEventListeners, document.querySelector('.action-next'), 'click', this.onNextTermView.bind(this));
+ Display.addEventListener(this.persistentEventListeners, document.querySelector('.navigation-header'), 'wheel', this.onHistoryWheel.bind(this), {passive: false});
} else {
Display.clearEventListeners(this.persistentEventListeners);
}
@@ -293,9 +306,6 @@ class Display {
this.addEventListeners('.action-view-note', 'click', this.onNoteView.bind(this));
this.addEventListeners('.action-play-audio', 'click', this.onAudioPlay.bind(this));
this.addEventListeners('.kanji-link', 'click', this.onKanjiLookup.bind(this));
- this.addEventListeners('.source-term', 'click', this.onSourceTermView.bind(this));
- this.addEventListeners('.next-term', 'click', this.onNextTermView.bind(this));
- this.addEventListeners('.term-navigation', 'wheel', this.onHistoryWheel.bind(this), {passive: false});
if (this.options.scanning.enablePopupSearch) {
this.addEventListeners('.glossary-item', 'mouseup', this.onGlossaryMouseUp.bind(this));
this.addEventListeners('.glossary-item', 'mousedown', this.onGlossaryMouseDown.bind(this));
@@ -347,25 +357,25 @@ class Display {
}
const sequence = ++this.sequence;
- const params = {
- definitions,
- source: !!this.context.previous,
- next: !!this.context.next,
- addable: options.anki.enable,
- grouped: options.general.resultOutputMode === 'group',
- merged: options.general.resultOutputMode === 'merge',
- playback: options.audio.enabled,
- compactGlossaries: options.general.compactGlossaries,
- debug: options.general.debugInfo
- };
for (const definition of definitions) {
definition.cloze = Display.clozeBuild(context.sentence, definition.source);
definition.url = context.url;
}
- const content = await apiTemplateRender('terms.html', params);
- this.container.innerHTML = content;
+ this.updateNavigation(this.context.previous, this.context.next);
+ this.setNoContentVisible(definitions.length === 0);
+
+ const fragment = document.createDocumentFragment();
+ for (const definition of definitions) {
+ fragment.appendChild(this.displayGenerator.createTermEntry(definition));
+ }
+
+ await Promise.resolve(); // Delay to help avoid forced reflow warnings in Chrome
+
+ this.container.textContent = '';
+ this.container.appendChild(fragment);
+
const {index, scroll, disableScroll} = context;
if (!disableScroll) {
this.entryScrollIntoView(index || 0, scroll);
@@ -391,8 +401,6 @@ class Display {
if (!this.isInitialized()) { return; }
try {
- const options = this.options;
-
this.setEventListenersActive(false);
if (context.focus !== false) {
@@ -408,21 +416,25 @@ class Display {
}
const sequence = ++this.sequence;
- const params = {
- definitions,
- source: !!this.context.previous,
- next: !!this.context.next,
- addable: options.anki.enable,
- debug: options.general.debugInfo
- };
for (const definition of definitions) {
definition.cloze = Display.clozeBuild(context.sentence, definition.character);
definition.url = context.url;
}
- const content = await apiTemplateRender('kanji.html', params);
- this.container.innerHTML = content;
+ this.updateNavigation(this.context.previous, this.context.next);
+ this.setNoContentVisible(definitions.length === 0);
+
+ const fragment = document.createDocumentFragment();
+ for (const definition of definitions) {
+ fragment.appendChild(this.displayGenerator.createKanjiEntry(definition));
+ }
+
+ await Promise.resolve(); // Delay to help avoid forced reflow warnings in Chrome
+
+ this.container.textContent = '';
+ this.container.appendChild(fragment);
+
const {index, scroll} = context;
this.entryScrollIntoView(index || 0, scroll);
@@ -445,6 +457,26 @@ class Display {
if (errorOrphaned !== null) {
errorOrphaned.style.setProperty('display', 'block', 'important');
}
+
+ this.updateNavigation(null, null);
+ this.setNoContentVisible(false);
+ }
+
+ setNoContentVisible(visible) {
+ const noResults = document.querySelector('#no-results');
+
+ if (noResults !== null) {
+ noResults.hidden = !visible;
+ }
+ }
+
+ updateNavigation(previous, next) {
+ const navigation = document.querySelector('#navigation-header');
+ if (navigation !== null) {
+ navigation.hidden = !(previous || next);
+ navigation.dataset.hasPrevious = `${!!previous}`;
+ navigation.dataset.hasNext = `${!!next}`;
+ }
}
autoPlayAudio() {
@@ -733,6 +765,7 @@ class Display {
}
static addEventListener(eventListeners, object, type, listener, options) {
+ if (object === null) { return; }
object.addEventListener(type, listener, options);
eventListeners.push([object, type, listener, options]);
}