_Yomitan_ button in the browser bar to open the quick-actions popup.
-
- 
-
- - The 
_cog_ button will open the Settings page.
- - The 
_magnifying glass_ button will open the Search page.
- - The 
_question mark_ button will open the Information page.
- - The 
_profile_ button will appear when multiple profiles exist, allowing the current profile to be quickly changed.
-
-2. Import the dictionaries you wish to use for term and kanji searches. If you do not have any dictionaries installed
- or enabled, Yomitan will warn you that it is not ready for use by displaying an orange exclamation mark over its
- icon. This exclamation mark will disappear once you have installed and enabled at least one dictionary.
-
- 
-
-3. Webpage text can be scanned by moving the cursor while holding a modifier key, which is Shift
- by default. If definitions are found for the text at the cursor position, a popup window containing term definitions
- will open. This window can be dismissed by clicking anywhere outside of it.
-
- 
-
-4. Click on the 
_speaker_ button to hear the term pronounced by a native speaker. If an audio sample is
- not available, you will hear a short click instead. You can configure the sources used to retrieve audio samples in
- the options page.
-
-5. Click on individual kanji in the term definition results to view additional information about those characters,
- including stroke order diagrams, readings, meanings, as well as other useful data.
-
- 
-
-### Importing Dictionaries
-
-You can import individual dictionaries from the settings page as described above.
-
-Yomitan also supports exporting and importing your entire collection of dictionaries.
-
-#### Importing a Dictionary Collection
-
-- Go to Yomitan's Settings page (Click on the extension's icon then click on the cog icon from the popup)
-- Click `Import Dictionary Collection` and select the database file you want to import
-- Wait for the import to finish then turn all the dictionaries back on from the `Dictionaries > Configure installed and enabled dictionaries` section
-- Refresh the browser tab to see the dictionaries in effect
-
-#### Exporting the Dictionary Collection
-
-- Click `Export Dictionary Collection` from the backup section of Yomitan's settings page
-- It will show you a progress report as it exports the data then initiates a
- download for a file named something like `yomitan-dictionaries-YYYY-MM-DD-HH-mm-ss.json`
- (e.g. `yomitan-dictionaries-2023-07-05-02-42-04.json`)
-
-### Importing and Exporting Personal Configuration
-
-Note that you can also similarly export and import your Yomitan settings from the `Backup` section of the Settings page.
-
-You should be able to replicate your exact Yomitan setup across devices by exporting your settings and dictionary collection from the source device then importing those from the destination.
-
-## Custom Dictionaries
-
-Yomitan supports the use of custom dictionaries, including the esoteric but popular
-[EPWING](https://ja.wikipedia.org/wiki/EPWING) format. They were often utilized in portable electronic dictionaries
-similar to the ones pictured below. These dictionaries are often sought after by language learners for their correctness
-and excellent coverage of the Japanese language.
-
-Unfortunately, as most of the dictionaries released in this format are proprietary, they are unable to be bundled with
-Yomitan. Instead, you will need to procure these dictionaries yourself and import them using [Yomitan
-Import](https://github.com/themoeway/yomitan-import). Check the project page for additional details.
-
-
-
-## Anki Integration
-
-Yomitan features automatic flashcard creation for [Anki](https://apps.ankiweb.net/), a free application designed to help you
-retain knowledge. This feature requires the prior installation of an Anki plugin called [AnkiConnect](https://foosoft.net/projects/anki-connect).
-Check the respective project page for more information about how to set up this software.
-
-### Flashcard Configuration
-
-Before flashcards can be automatically created, you must configure the templates used to create term and/or kanji notes.
-If you are unfamiliar with Anki deck and model management, this would be a good time to reference the [Anki
-Manual](https://docs.ankiweb.net/#/). In short, you must specify what information should be included in the
-flashcards that Yomitan creates through AnkiConnect.
+1. Click the _Yomitan_ button in the browser bar to open the quick-actions popup.
-Flashcard fields can be configured with the following steps:
-
-1. Open the Yomitan options page and scroll down to the section labeled _Anki Options_.
-2. Tick the checkbox labeled _Enable Anki integration_ (Anki must be running with [AnkiConnect](https://foosoft.net/projects/anki-connect) installed).
-3. Select the type of template to configure by clicking on either the _Terms_ or _Kanji_ tabs.
-4. Select the Anki deck and model to use for new creating new flashcards of this type.
-5. Fill the model fields with markers corresponding to the information you wish to include (several can be used at
- once). Advanced users can also configure the actual [Handlebars](https://handlebarsjs.com/) templates used to create
- the flashcard contents (this is strictly optional).
-
- #### Markers for Term Cards
-
- | Marker | Description |
- | -------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
- | `{audio}` | Audio sample of a native speaker's pronunciation in MP3 format (if available). |
- | `{clipboard-image}` | An image which is stored in the system clipboard, if present. |
- | `{clipboard-text}` | Text which is stored in the system clipboard, if present. |
- | `{cloze-body}` | Raw, inflected term as it appeared before being reduced to dictionary form by Yomitan. |
- | `{cloze-prefix}` | Fragment of the containing `{sentence}` starting at the beginning of `{sentence}` until the beginning of `{cloze-body}`. |
- | `{cloze-suffix}` | Fragment of the containing `{sentence}` starting at the end of `{cloze-body}` until the end of `{sentence}`. |
- | `{conjugation}` | Conjugation path from the raw inflected term to the source term. |
- | `{dictionary}` | Name of the dictionary from which the card is being created (unavailable in _grouped_ mode). |
- | `{document-title}` | Title of the web page that the term appeared in. |
- | `{expression}` | Term expressed as kanji (will be displayed in kana if kanji is not available). |
- | `{frequencies}` | Frequency information for the term. |
- | `{furigana}` | Term expressed as kanji with furigana displayed above it (e.g. 日本語). |
- | `{furigana-plain}` | Term expressed as kanji with furigana displayed next to it in brackets (e.g. 日本語[にほんご]). |
- | `{glossary}` | List of definitions for the term (output format depends on whether running in _grouped_ mode). |
- | `{glossary-brief}` | List of definitions for the term in a more compact format. |
- | `{glossary-no-dictionary}` | List of definitions for the term, except the dictionary tag is omitted. |
- | `{part-of-speech}` | Part of speech information for the term. |
- | `{pitch-accents}` | List of pitch accent downstep notations for the term. |
- | `{pitch-accent-graphs}` | List of pitch accent graphs for the term. |
- | `{pitch-accent-positions}` | List of accent downstep positions for the term as a number. |
- | `{reading}` | Kana reading for the term (empty for terms where the expression is the reading). |
- | `{screenshot}` | Screenshot of the web page taken at the time the term was added. |
- | `{search-query}` | The full search query shown on the search page. |
- | `{selection-text}` | The selected text on the search page or popup. |
- | `{sentence}` | Sentence, quote, or phrase that the term appears in from the source content. |
- | `{sentence-furigana}` | Sentence, quote, or phrase that the term appears in from the source content, with furigana added. |
- | `{tags}` | Grammar and usage tags providing information about the term (unavailable in _grouped_ mode). |
- | `{url}` | Address of the web page in which the term appeared in. |
-
- #### Markers for Kanji Cards
-
- | Marker | Description |
- | --------------------- | ------------------------------------------------------------------------------------------------------------------------ |
- | `{character}` | Unicode glyph representing the current kanji. |
- | `{clipboard-image}` | An image which is stored in the system clipboard, if present. |
- | `{clipboard-text}` | Text which is stored in the system clipboard, if present. |
- | `{cloze-body}` | Raw, inflected parent term as it appeared before being reduced to dictionary form by Yomitan. |
- | `{cloze-prefix}` | Fragment of the containing `{sentence}` starting at the beginning of `{sentence}` until the beginning of `{cloze-body}`. |
- | `{cloze-suffix}` | Fragment of the containing `{sentence}` starting at the end of `{cloze-body}` until the end of `{sentence}`. |
- | `{dictionary}` | Name of the dictionary from which the card is being created. |
- | `{document-title}` | Title of the web page that the kanji appeared in. |
- | `{frequencies}` | Frequency information for the kanji. |
- | `{glossary}` | List of definitions for the kanji. |
- | `{kunyomi}` | Kunyomi (Japanese reading) for the kanji expressed as katakana. |
- | `{onyomi}` | Onyomi (Chinese reading) for the kanji expressed as hiragana. |
- | `{screenshot}` | Screenshot of the web page taken at the time the kanji was added. |
- | `{search-query}` | The full search query shown on the search page. |
- | `{selection-text}` | The selected text on the search page or popup. |
- | `{sentence}` | Sentence, quote, or phrase that the character appears in from the source content. |
- | `{sentence-furigana}` | Sentence, quote, or phrase that the character appears in from the source content, with furigana added. |
- | `{stroke-count}` | Number of strokes that the kanji character has. |
- | `{url}` | Address of the web page in which the kanji appeared in. |
-
-When creating your model for Yomitan, _make sure that you pick a unique field to be first_; fields that will
-contain `{expression}` or `{character}` are ideal candidates for this. Anki does not allow duplicate flashcards to be
-added to a deck by default; it uses the first field in the model to check for duplicates. For example, if you have `{reading}`
-configured to be the first field in your model and 橋 is already in your deck, you will not
-be able to create a flashcard for 箸 because they share the same reading.
-
-### Flashcard Creation
-
-Once Yomitan is configured, it becomes trivial to create new flashcards with a single click. You will see the following
-icons next to term definitions:
-
-- Clicking  adds the current expression as kanji (e.g. 食べる).
-- Clicking  adds the current expression as hiragana or katakana (e.g. たべる).
-
-Below are some troubleshooting tips you can try if you are unable to create new flashcards:
-
-- Individual icons will appear grayed out if a flashcard cannot be created for the current definition (e.g. it already exists in the deck).
-- If all of the buttons appear grayed out, then you should double-check your deck and model configuration settings.
-- If no icons appear at all, make sure that Anki is running in the background and that [AnkiConnect](https://foosoft.net/projects/anki-connect) has been installed.
-
-## Keyboard Shortcuts
-
-The following shortcuts are globally available:
-
-| Shortcut | Action |
-| ---------------------------------- | ------------------------ |
-| Alt + Insert | Open search page. |
-| Alt + Delete | Toggle extension on/off. |
-
-The following shortcuts are available on search results:
-
-| Shortcut | Action |
-| -------------------------------- | --------------------------------------- |
-| Esc | Cancel current search. |
-| Alt + PgUp | Page up through results. |
-| Alt + PgDn | Page down through results. |
-| Alt + End | Go to last result. |
-| Alt + Home | Go to first result. |
-| Alt + Up | Go to previous result. |
-| Alt + Down | Go to next result. |
-| Alt + b | Go to back to source term. |
-| Alt + e | Add current term as expression to Anki. |
-| Alt + r | Add current term as reading to Anki. |
-| Alt + p | Play audio for current term. |
-| Alt + k | Add current kanji to Anki. |
-
-## Advanced Options
-
-Click the `Advanced` toggle switch in the bottom left corner of the Settings page to enable advanced options.
-
-### Parse sentences using MeCab
-
-[MeCab](https://taku910.github.io/mecab/) is a third-party program which uses its own dictionaries and parsing algorithm to decompose sentences into individual words. MeCab may provide more accurate parsing results than Yomitan's internal parser.
-
-In order for Yomitan to use it, both MeCab and a native messaging component must be installed.
-A setup guide can be found [here](https://github.com/themoeway/yomitan-mecab-installer/blob/master/README.md).
-
-## Frequently Asked Questions
-
-**I can't scan text in Firefox!**
-
-In Firefox's Manifest V3, host permissions are treated as opt-in. For Yomitan to work properly, the recommended permissions
-must be explicitly set. In the Yomitan welcome page, go to the `Recommended Permissions (Important)` section and check `Enable recommended permissions`.
-
-**I'm having problems importing dictionaries in Firefox, what do I do?**
-
-Yomitan uses the cross-browser IndexedDB system for storing imported dictionary data into your user profile. Although
-everything "just works" in Chrome, depending on settings, Firefox users can run into problems due to browser bugs.
-Yomitan catches errors and tries to offer suggestions about how to work around Firefox issues, but in general at least
-one of the following solutions should work for you:
-
-- Make sure you have cookies enabled. It appears that disabling them also disables IndexedDB for some reason. You
- can still have cookies be disabled on other sites; just make sure to add the Yomitan extension to the whitelist of
- whatever tool you are using to restrict cookies. You can get the extension "URL" by looking at the address bar when
- you have the search page open.
-- Make sure that you have sufficient disk space available on the drive Firefox uses to store your user profile.
- Firefox limits the amount of space that can be used by IndexedDB to a small fraction of the disk space actually
- available on your computer.
-- Make sure that you have history set to "Remember history" enabled in your privacy settings. When this option is
- set to "Never remember history", IndexedDB access is once again disabled for an inexplicable reason.
-- As a last resort, try using the [Refresh Firefox](https://support.mozilla.org/en-US/kb/reset-preferences-fix-problems)
- feature to reset your user profile. It appears that the Firefox profile system can corrupt itself preventing
- IndexedDB from being accessible to Yomitan.
-
-**Will you add support for online dictionaries?**
+
-Online dictionaries will not be implemented because it is not possible to support them in a robust way. In order to
-perform Japanese deinflection, Yomitan must execute dozens of database queries for every single word. Factoring in
-network latency and the fragility of web scraping, it would not be possible to maintain a good and consistent user
-experience.
+ - The _cog_ button will open the Settings page.
+ - The _magnifying glass_ button will open the Search page.
+ - The _question mark_ button will open the Information page.
+ - The _profile_ button will appear when multiple profiles exist, allowing the current profile to be quickly changed.
-**Is it possible to use Yomitan with files saved locally on my computer with Chrome?**
+2. Import the dictionaries you wish to use for term and kanji searches, head over to the [the dictionary docs](./docs/dictionaries.md) to get set up! If you do not have any dictionaries installed or enabled, Yomitan will warn you that it is not ready for use by displaying an orange exclamation mark over its icon. This exclamation mark will disappear once you have installed and enabled at least one dictionary.
-In order to use Yomitan with local files in Chrome, you must first tick the _Allow access to file URLs_ checkbox
-for Yomitan on the extensions page. Due to the restrictions placed on browser addons in the WebExtensions model, it
-will likely never be possible to use Yomitan with PDF files.
+
-**Is it possible to delete individual dictionaries without purging the database?**
+3. Webpage text can be scanned by moving the cursor while holding a modifier key, which is Shift by default. If definitions are found for the text at the cursor position, a popup window containing term definitions will open. This window can be dismissed by clicking anywhere outside of it.
-Yomitan is able to delete individual dictionaries, but keep in mind that this process can be _very_ slow and can
-cause the browser to become unresponsive. The time it takes to delete a single dictionary can sometimes be roughly
-the same as the time it originally took to import, which can be significant for certain large dictionaries.
+
-**Why aren't EPWING dictionaries bundled with Yomitan?**
+4. Click on the _speaker_ button to hear the term pronounced by a native speaker. If an audio sample is not available, you will hear a short click instead. You can configure the sources used to retrieve audio samples in the options page.
-The vast majority of EPWING dictionaries are proprietary, so they are unfortunately not able to be included in
-this extension due to copyright reasons.
+5. Click on individual kanji in the term definition results to view additional information about those characters, including stroke order diagrams, readings, meanings, as well as other useful data.
-**When are you going to add support for $MYLANGUAGE?**
+
-Developing Yomitan requires a decent understanding of Japanese sentence structure and grammar, and other languages
-are likely to have their own unique set of rules for syntax, grammar, inflection, and so on. Supporting additional
-languages would not only require many additional changes to the codebase, it would also incur significant maintenance
-overhead and knowledge demands for the developers. Therefore, suggestions and contributions for supporting
-new languages will be declined, allowing Yomitan's focus to remain Japanese-centric.
+To further enhance your Yomitan experience, it's worth [integrating with Anki](./docs/anki-integration.md), a spaced-repetition flashcard program to help solidify the words you encounter.
## Licenses
diff --git a/dev/bin/build-libs.js b/dev/bin/build-libs.js
index 07d27188a5..a614407eab 100644
--- a/dev/bin/build-libs.js
+++ b/dev/bin/build-libs.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2020-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
diff --git a/dev/bin/build.js b/dev/bin/build.js
index 5d7e4f0dda..190964d564 100644
--- a/dev/bin/build.js
+++ b/dev/bin/build.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2020-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
diff --git a/dev/bin/dictionary-validate.js b/dev/bin/dictionary-validate.js
index dc01815ef0..e7c3562e09 100644
--- a/dev/bin/dictionary-validate.js
+++ b/dev/bin/dictionary-validate.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2020-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
diff --git a/dev/bin/generate-css-json.js b/dev/bin/generate-css-json.js
index 57419b415a..8b77016a7b 100644
--- a/dev/bin/generate-css-json.js
+++ b/dev/bin/generate-css-json.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2020-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
diff --git a/dev/bin/schema-validate.js b/dev/bin/schema-validate.js
index bbd5ad5fb1..74a42444bd 100644
--- a/dev/bin/schema-validate.js
+++ b/dev/bin/schema-validate.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2020-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
diff --git a/dev/build-libs.js b/dev/build-libs.js
index 10720010cc..15ab3c8d9d 100644
--- a/dev/build-libs.js
+++ b/dev/build-libs.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2020-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
diff --git a/dev/data-error.js b/dev/data-error.js
index 0ab2d35429..5659245b81 100644
--- a/dev/data-error.js
+++ b/dev/data-error.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan 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
diff --git a/dev/data/display-pronunciation-overrides.css b/dev/data/display-pronunciation-overrides.css
index 7bba55e54c..c0a4da805b 100644
--- a/dev/data/display-pronunciation-overrides.css
+++ b/dev/data/display-pronunciation-overrides.css
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2021-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
diff --git a/dev/data/structured-content-overrides.css b/dev/data/structured-content-overrides.css
index c0b14202e5..46859b1bfe 100644
--- a/dev/data/structured-content-overrides.css
+++ b/dev/data/structured-content-overrides.css
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2021-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
diff --git a/dev/dictionary-validate.js b/dev/dictionary-validate.js
index 51edcc50a5..18bba99ee1 100644
--- a/dev/dictionary-validate.js
+++ b/dev/dictionary-validate.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2020-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
@@ -23,6 +23,7 @@ import {performance} from 'perf_hooks';
import {fileURLToPath} from 'url';
import {parseJson} from './json.js';
import {createJsonSchema} from './schema-validate.js';
+import {toError} from './to-error.js';
const dirname = path.dirname(fileURLToPath(import.meta.url));
@@ -39,35 +40,33 @@ function readSchema(relativeFileName) {
/**
* @param {import('dev/schema-validate').ValidateMode} mode
* @param {import('jszip')} zip
- * @param {string} fileNameFormat
- * @param {import('dev/dictionary-validate').Schema} schema
+ * @param {import('dev/dictionary-validate').SchemasDetails} schemasDetails
*/
-async function validateDictionaryBanks(mode, zip, fileNameFormat, schema) {
- let jsonSchema;
- try {
- jsonSchema = createJsonSchema(mode, schema);
- } catch (e) {
- const e2 = e instanceof Error ? e : new Error(`${e}`);
- e2.message += `\n(in file ${fileNameFormat})}`;
- throw e2;
- }
- let index = 1;
- while (true) {
- const fileName = fileNameFormat.replace(/\?/, `${index}`);
+async function validateDictionaryBanks(mode, zip, schemasDetails) {
+ for (const [fileName, file] of Object.entries(zip.files)) {
+ for (const [fileNameFormat, schema] of schemasDetails) {
+ if (!fileNameFormat.test(fileName)) { continue; }
- const file = zip.files[fileName];
- if (!file) { break; }
+ let jsonSchema;
+ try {
+ jsonSchema = createJsonSchema(mode, schema);
+ } catch (e) {
+ const e2 = toError(e);
+ e2.message += `\n(in file ${fileName})}`;
+ throw e2;
+ }
- const data = parseJson(await file.async('string'));
- try {
- jsonSchema.validate(data);
- } catch (e) {
- const e2 = e instanceof Error ? e : new Error(`${e}`);
- e2.message += `\n(in file ${fileName})}`;
- throw e2;
- }
+ const data = parseJson(await file.async('string'));
- ++index;
+ try {
+ jsonSchema.validate(data);
+ } catch (e) {
+ const e2 = toError(e);
+ e2.message += `\n(in file ${fileName})}`;
+ throw e2;
+ }
+ break;
+ }
}
}
@@ -92,16 +91,21 @@ export async function validateDictionary(mode, archive, schemas) {
const jsonSchema = createJsonSchema(mode, schemas.index);
jsonSchema.validate(index);
} catch (e) {
- const e2 = e instanceof Error ? e : new Error(`${e}`);
+ const e2 = toError(e);
e2.message += `\n(in file ${indexFileName})}`;
throw e2;
}
- await validateDictionaryBanks(mode, archive, 'term_bank_?.json', version === 1 ? schemas.termBankV1 : schemas.termBankV3);
- await validateDictionaryBanks(mode, archive, 'term_meta_bank_?.json', schemas.termMetaBankV3);
- await validateDictionaryBanks(mode, archive, 'kanji_bank_?.json', version === 1 ? schemas.kanjiBankV1 : schemas.kanjiBankV3);
- await validateDictionaryBanks(mode, archive, 'kanji_meta_bank_?.json', schemas.kanjiMetaBankV3);
- await validateDictionaryBanks(mode, archive, 'tag_bank_?.json', schemas.tagBankV3);
+ /** @type {import('dev/dictionary-validate').SchemasDetails} */
+ const schemasDetails = [
+ [/^term_bank_(\d+)\.json$/, version === 1 ? schemas.termBankV1 : schemas.termBankV3],
+ [/^term_meta_bank_(\d+)\.json$/, schemas.termMetaBankV3],
+ [/^kanji_bank_(\d+)\.json$/, version === 1 ? schemas.kanjiBankV1 : schemas.kanjiBankV3],
+ [/^kanji_meta_bank_(\d+)\.json$/, schemas.kanjiMetaBankV3],
+ [/^tag_bank_(\d+)\.json$/, schemas.tagBankV3]
+ ];
+
+ await validateDictionaryBanks(mode, archive, schemasDetails);
}
/**
diff --git a/dev/generate-css-json.js b/dev/generate-css-json.js
index 1a2aaba37b..307288315b 100644
--- a/dev/generate-css-json.js
+++ b/dev/generate-css-json.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2021-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
diff --git a/dev/json.js b/dev/json.js
index a76edfcd61..550f15645f 100644
--- a/dev/json.js
+++ b/dev/json.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan 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
diff --git a/dev/lib/dexie.js b/dev/lib/dexie.js
index 81a62b28c3..834260e001 100644
--- a/dev/lib/dexie.js
+++ b/dev/lib/dexie.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan 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
diff --git a/dev/lib/handlebars.js b/dev/lib/handlebars.js
index 5b57efdd63..c99a3b13dd 100644
--- a/dev/lib/handlebars.js
+++ b/dev/lib/handlebars.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan 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
diff --git a/dev/lib/parse5.js b/dev/lib/parse5.js
index c7b2c83893..03249db475 100644
--- a/dev/lib/parse5.js
+++ b/dev/lib/parse5.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan 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
diff --git a/dev/lib/ucs2length.js b/dev/lib/ucs2length.js
index 3b370493a4..ce9027de52 100644
--- a/dev/lib/ucs2length.js
+++ b/dev/lib/ucs2length.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan 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
diff --git a/dev/lib/wanakana.js b/dev/lib/wanakana.js
index dca707296e..b2679cec2a 100644
--- a/dev/lib/wanakana.js
+++ b/dev/lib/wanakana.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan 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
diff --git a/dev/lib/z-worker.js b/dev/lib/z-worker.js
index f6a95ed3b1..142ed8fc31 100644
--- a/dev/lib/z-worker.js
+++ b/dev/lib/z-worker.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan 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
diff --git a/dev/lib/zip.js b/dev/lib/zip.js
index b6e8545191..007b4285e0 100644
--- a/dev/lib/zip.js
+++ b/dev/lib/zip.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan 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
diff --git a/dev/manifest-util.js b/dev/manifest-util.js
index 1802e1397a..6ab817909c 100644
--- a/dev/manifest-util.js
+++ b/dev/manifest-util.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2021-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
diff --git a/dev/schema-validate.js b/dev/schema-validate.js
index d4e977e122..d1ffcf8202 100644
--- a/dev/schema-validate.js
+++ b/dev/schema-validate.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2020-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
diff --git a/dev/to-error.js b/dev/to-error.js
new file mode 100644
index 0000000000..4cda477ea8
--- /dev/null
+++ b/dev/to-error.js
@@ -0,0 +1,18 @@
+/*
+ * Copyright (C) 2023-2024 Yomitan 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 -
+ {{~#each definition.phoneticTranscriptions~}}
+ {{~#each phoneticTranscriptions~}}
+
- + {{~set "any" false~}} + {{~#each tags~}} + {{~#if (get "any")}}, {{else}}({{/if~}} + {{name}} + {{~set "any" true~}} + {{~/each~}} + {{~#if (get "any")}}) {{/if~}} + {{ipa~}} + + {{~/each~}} + {{~/each~}} +
- {{/if~}}
+ {{~#each definition.inflectionRuleChainCandidates~}}
+ {{~#if (op ">" inflectionRules.length 0)~}}
+ {{~#if (get "multiple")~}}
- {{/if~}} + {{~#each inflectionRules~}} + {{~#if (op ">" @index 0)}} « {{/if~}} + {{.}} + {{~/each~}} + {{~#if (get "multiple")~}} {{/if~}} + {{~/if~}} + {{~/each~}} + {{~#if (get "multiple")~}}
- {{/if~}}
+ {{~#each definition.inflectionRuleChainCandidates~}}
+ {{~#if (op ">" inflectionRules.length 0)~}}
+ {{~#if (get "multiple")~}}
- {{/if~}} + {{~#each inflectionRules~}} + {{~#if (op ">" @index 0)}} « {{/if~}} + {{.}} + {{~/each~}} + {{~#if (get "multiple")~}} {{/if~}} + {{~/if~}} + {{~/each~}} + {{~#if (get "multiple")~}}
-
+
@@ -77,6 +77,7 @@
+
diff --git a/ext/js/accessibility/accessibility-controller.js b/ext/js/accessibility/accessibility-controller.js
index 4dced51be9..b27858931c 100644
--- a/ext/js/accessibility/accessibility-controller.js
+++ b/ext/js/accessibility/accessibility-controller.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2021-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
@@ -17,7 +17,7 @@
*/
import {isContentScriptRegistered, registerContentScript, unregisterContentScript} from '../background/script-manager.js';
-import {log} from '../core.js';
+import {log} from '../core/logger.js';
/**
* This class controls the registration of accessibility handlers.
diff --git a/ext/js/accessibility/google-docs-util.js b/ext/js/accessibility/google-docs-util.js
index cc6cbd698d..34a5dd5555 100644
--- a/ext/js/accessibility/google-docs-util.js
+++ b/ext/js/accessibility/google-docs-util.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
diff --git a/ext/js/accessibility/google-docs-xray.js b/ext/js/accessibility/google-docs-xray.js
index ef293933a7..f128c05875 100644
--- a/ext/js/accessibility/google-docs-xray.js
+++ b/ext/js/accessibility/google-docs-xray.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan 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
diff --git a/ext/js/accessibility/google-docs.js b/ext/js/accessibility/google-docs.js
index 00266bb693..4af786977d 100644
--- a/ext/js/accessibility/google-docs.js
+++ b/ext/js/accessibility/google-docs.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan 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
diff --git a/ext/js/app/content-script-main.js b/ext/js/app/content-script-main.js
index 7b76fda0e9..c0bea73cf9 100644
--- a/ext/js/app/content-script-main.js
+++ b/ext/js/app/content-script-main.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2019-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
@@ -16,7 +16,7 @@
* along with this program. If not, see |undefined>}
*/
async _invoke(open, action, params) {
- if (yomitan.isExtensionUnloaded) {
+ if (yomitan.webExtension.unloaded) {
return void 0;
}
@@ -290,7 +290,7 @@ export class PopupWindow extends EventDispatcher {
message
));
} catch (e) {
- if (yomitan.isExtensionUnloaded) {
+ if (yomitan.webExtension.unloaded) {
open = false;
}
}
diff --git a/ext/js/app/popup.js b/ext/js/app/popup.js
index 0f7fbd8701..c741e8f156 100644
--- a/ext/js/app/popup.js
+++ b/ext/js/app/popup.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2016-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
@@ -17,8 +17,11 @@
*/
import {FrameClient} from '../comm/frame-client.js';
-import {DynamicProperty, EventDispatcher, EventListenerCollection, deepEqual} from '../core.js';
+import {DynamicProperty} from '../core/dynamic-property.js';
+import {EventDispatcher} from '../core/event-dispatcher.js';
+import {EventListenerCollection} from '../core/event-listener-collection.js';
import {ExtensionError} from '../core/extension-error.js';
+import {deepEqual} from '../core/utilities.js';
import {DocumentUtil} from '../dom/document-util.js';
import {loadStyle} from '../dom/style-util.js';
import {yomitan} from '../yomitan.js';
@@ -711,7 +714,7 @@ export class Popup extends EventDispatcher {
try {
return await this._invoke(action, params);
} catch (e) {
- if (!yomitan.isExtensionUnloaded) { throw e; }
+ if (!yomitan.webExtension.unloaded) { throw e; }
return void 0;
}
}
diff --git a/ext/js/app/theme-controller.js b/ext/js/app/theme-controller.js
index 8b88c834de..559a6e57d1 100644
--- a/ext/js/app/theme-controller.js
+++ b/ext/js/app/theme-controller.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
diff --git a/ext/js/background/backend.js b/ext/js/background/backend.js
index 481567b55f..b61f27b108 100644
--- a/ext/js/background/backend.js
+++ b/ext/js/background/backend.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2016-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
@@ -22,10 +22,11 @@ import {AnkiConnect} from '../comm/anki-connect.js';
import {ClipboardMonitor} from '../comm/clipboard-monitor.js';
import {ClipboardReader} from '../comm/clipboard-reader.js';
import {Mecab} from '../comm/mecab.js';
-import {clone, deferPromise, isObject, log, promiseTimeout} from '../core.js';
import {createApiMap, invokeApiMapHandler} from '../core/api-map.js';
import {ExtensionError} from '../core/extension-error.js';
import {readResponseJson} from '../core/json.js';
+import {log} from '../core/logger.js';
+import {clone, deferPromise, isObject, promiseTimeout} from '../core/utilities.js';
import {AnkiUtil} from '../data/anki-util.js';
import {OptionsUtil} from '../data/options-util.js';
import {PermissionsUtil} from '../data/permissions-util.js';
@@ -48,9 +49,11 @@ import {injectStylesheet} from './script-manager.js';
*/
export class Backend {
/**
- * Creates a new instance.
+ * @param {import('../extension/web-extension.js').WebExtension} webExtension
*/
- constructor() {
+ constructor(webExtension) {
+ /** @type {import('../extension/web-extension.js').WebExtension} */
+ this._webExtension = webExtension;
/** @type {JapaneseUtil} */
this._japaneseUtil = new JapaneseUtil(wanakana);
/** @type {Environment} */
@@ -79,7 +82,7 @@ export class Backend {
});
} else {
/** @type {?OffscreenProxy} */
- this._offscreen = new OffscreenProxy();
+ this._offscreen = new OffscreenProxy(webExtension);
/** @type {DictionaryDatabase|DictionaryDatabaseProxy} */
this._dictionaryDatabase = new DictionaryDatabaseProxy(this._offscreen);
/** @type {Translator|TranslatorProxy} */
@@ -143,10 +146,13 @@ export class Backend {
this._permissions = null;
/** @type {PermissionsUtil} */
this._permissionsUtil = new PermissionsUtil();
+ /** @type {Map void)[]>} */
+ this._applicationReadyHandlers = new Map();
/* eslint-disable no-multi-spaces */
/** @type {import('api').ApiMap} */
this._apiMap = createApiMap([
+ ['applicationReady', this._onApiApplicationReady.bind(this)],
['requestBackendReadySignal', this._onApiRequestBackendReadySignal.bind(this)],
['optionsGet', this._onApiOptionsGet.bind(this)],
['optionsGetFull', this._onApiOptionsGetFull.bind(this)],
@@ -424,6 +430,21 @@ export class Backend {
// Message handlers
+ /** @type {import('api').ApiHandler<'applicationReady'>} */
+ _onApiApplicationReady(_params, sender) {
+ const {tab, frameId} = sender;
+ if (!tab || typeof frameId !== 'number') { return; }
+ const {id} = tab;
+ if (typeof id !== 'number') { return; }
+ const key = `${id}:${frameId}`;
+ const handlers = this._applicationReadyHandlers.get(key);
+ if (typeof handlers === 'undefined') { return; }
+ for (const handler of handlers) {
+ handler();
+ }
+ this._applicationReadyHandlers.delete(key);
+ }
+
/** @type {import('api').ApiHandler<'requestBackendReadySignal'>} */
_onApiRequestBackendReadySignal(_params, sender) {
// tab ID isn't set in background (e.g. browser_action)
@@ -1805,18 +1826,8 @@ export class Backend {
return new Promise((resolve, reject) => {
/** @type {?import('core').Timeout} */
let timer = null;
- /** @type {?import('extension').ChromeRuntimeOnMessageCallback} */
- let onMessage = (message, sender) => {
- if (
- !sender.tab ||
- sender.tab.id !== tabId ||
- sender.frameId !== frameId ||
- !(typeof message === 'object' && message !== null) ||
- message.action !== 'applicationReady'
- ) {
- return;
- }
+ const readyHandler = () => {
cleanup();
resolve();
};
@@ -1825,13 +1836,10 @@ export class Backend {
clearTimeout(timer);
timer = null;
}
- if (onMessage !== null) {
- chrome.runtime.onMessage.removeListener(onMessage);
- onMessage = null;
- }
+ this._removeApplicationReadyHandler(tabId, frameId, readyHandler);
};
- chrome.runtime.onMessage.addListener(onMessage);
+ this._addApplicationReadyHandler(tabId, frameId, readyHandler);
this._sendMessageTabPromise(tabId, {action: 'applicationIsReady'}, {frameId})
.then(
@@ -1896,8 +1904,7 @@ export class Backend {
* @param {import('application').ApiMessage} message
*/
_sendMessageIgnoreResponse(message) {
- const callback = () => this._checkLastError(chrome.runtime.lastError);
- chrome.runtime.sendMessage(message, callback);
+ this._webExtension.sendMessageIgnoreResponse(message);
}
/**
@@ -2427,7 +2434,9 @@ export class Backend {
enabledDictionaryMap.set(mainDictionary, {
index: enabledDictionaryMap.size,
priority: 0,
- allowSecondarySearches: false
+ allowSecondarySearches: false,
+ partsOfSpeechFilter: true,
+ useDeinflections: true
});
excludeDictionaryDefinitions = new Set();
excludeDictionaryDefinitions.add(mainDictionary);
@@ -2473,10 +2482,13 @@ export class Backend {
const enabledDictionaryMap = new Map();
for (const dictionary of options.dictionaries) {
if (!dictionary.enabled) { continue; }
- enabledDictionaryMap.set(dictionary.name, {
+ const {name, priority, allowSecondarySearches, partsOfSpeechFilter, useDeinflections} = dictionary;
+ enabledDictionaryMap.set(name, {
index: enabledDictionaryMap.size,
- priority: dictionary.priority,
- allowSecondarySearches: dictionary.allowSecondarySearches
+ priority,
+ allowSecondarySearches,
+ partsOfSpeechFilter,
+ useDeinflections
});
}
return enabledDictionaryMap;
@@ -2629,14 +2641,14 @@ export class Backend {
}
/**
+ * Only request this permission for Firefox versions >= 77.
+ * https://bugzilla.mozilla.org/show_bug.cgi?id=1630413
* @returns {Promise}
*/
async _requestPersistentStorage() {
try {
if (await navigator.storage.persisted()) { return; }
- // Only request this permission for Firefox versions >= 77.
- // https://bugzilla.mozilla.org/show_bug.cgi?id=1630413
const {vendor, version} = await browser.runtime.getBrowserInfo();
if (vendor !== 'Mozilla') { return; }
@@ -2680,4 +2692,38 @@ export class Backend {
return defaultValue;
}
}
+
+ /**
+ * @param {number} tabId
+ * @param {number} frameId
+ * @param {() => void} handler
+ */
+ _addApplicationReadyHandler(tabId, frameId, handler) {
+ const key = `${tabId}:${frameId}`;
+ let handlers = this._applicationReadyHandlers.get(key);
+ if (typeof handlers === 'undefined') {
+ handlers = [];
+ this._applicationReadyHandlers.set(key, handlers);
+ }
+ handlers.push(handler);
+ }
+
+ /**
+ * @param {number} tabId
+ * @param {number} frameId
+ * @param {() => void} handler
+ * @returns {boolean}
+ */
+ _removeApplicationReadyHandler(tabId, frameId, handler) {
+ const key = `${tabId}:${frameId}`;
+ const handlers = this._applicationReadyHandlers.get(key);
+ if (typeof handlers === 'undefined') { return false; }
+ const index = handlers.indexOf(handler);
+ if (index < 0) { return false; }
+ handlers.splice(index, 1);
+ if (handlers.length === 0) {
+ this._applicationReadyHandlers.delete(key);
+ }
+ return true;
+ }
}
diff --git a/ext/js/background/background-main.js b/ext/js/background/background-main.js
index 29c256d32a..f5871a1423 100644
--- a/ext/js/background/background-main.js
+++ b/ext/js/background/background-main.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2020-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
@@ -23,7 +23,7 @@ import {Backend} from './backend.js';
async function main() {
yomitan.prepare(true);
- const backend = new Backend();
+ const backend = new Backend(yomitan.webExtension);
await backend.prepare();
}
diff --git a/ext/js/background/offscreen-main.js b/ext/js/background/offscreen-main.js
index aac5b8f22b..67d5fa838a 100644
--- a/ext/js/background/offscreen-main.js
+++ b/ext/js/background/offscreen-main.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2020-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
diff --git a/ext/js/background/offscreen-proxy.js b/ext/js/background/offscreen-proxy.js
index 2335b67396..555c3abcab 100644
--- a/ext/js/background/offscreen-proxy.js
+++ b/ext/js/background/offscreen-proxy.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2016-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
@@ -16,12 +16,17 @@
* along with this program. If not, see } */
this._creatingOffscreen = null;
}
@@ -76,16 +81,9 @@ export class OffscreenProxy {
* @param {import('offscreen').ApiMessage} message
* @returns {Promise>}
*/
- sendMessagePromise(message) {
- return new Promise((resolve, reject) => {
- chrome.runtime.sendMessage(message, (response) => {
- try {
- resolve(this._getMessageResponseResult(response));
- } catch (error) {
- reject(error);
- }
- });
- });
+ async sendMessagePromise(message) {
+ const response = await this._webExtension.sendMessagePromise(message);
+ return this._getMessageResponseResult(/** @type {import('core').Response>} */ (response));
}
/**
diff --git a/ext/js/background/offscreen.js b/ext/js/background/offscreen.js
index 2320471c65..470ea0e26d 100644
--- a/ext/js/background/offscreen.js
+++ b/ext/js/background/offscreen.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2016-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
diff --git a/ext/js/background/profile-conditions-util.js b/ext/js/background/profile-conditions-util.js
index 8d477094f5..f3be226d23 100644
--- a/ext/js/background/profile-conditions-util.js
+++ b/ext/js/background/profile-conditions-util.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2020-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
diff --git a/ext/js/background/request-builder.js b/ext/js/background/request-builder.js
index 23f10ed33b..b23f16af5a 100644
--- a/ext/js/background/request-builder.js
+++ b/ext/js/background/request-builder.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2020-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
diff --git a/ext/js/background/script-manager.js b/ext/js/background/script-manager.js
index 353c50e3d2..84213452a5 100644
--- a/ext/js/background/script-manager.js
+++ b/ext/js/background/script-manager.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2021-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
diff --git a/ext/js/comm/anki-connect.js b/ext/js/comm/anki-connect.js
index fa5543d585..f16471ce8e 100644
--- a/ext/js/comm/anki-connect.js
+++ b/ext/js/comm/anki-connect.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2016-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
diff --git a/ext/js/comm/api.js b/ext/js/comm/api.js
index 423115f18c..2e1e882606 100644
--- a/ext/js/comm/api.js
+++ b/ext/js/comm/api.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2016-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
@@ -20,11 +20,11 @@ import {ExtensionError} from '../core/extension-error.js';
export class API {
/**
- * @param {import('../yomitan.js').Yomitan} yomitan
+ * @param {import('../extension/web-extension.js').WebExtension} webExtension
*/
- constructor(yomitan) {
- /** @type {import('../yomitan.js').Yomitan} */
- this._yomitan = yomitan;
+ constructor(webExtension) {
+ /** @type {import('../extension/web-extension.js').WebExtension} */
+ this._webExtension = webExtension;
}
/**
@@ -375,13 +375,15 @@ export class API {
const data = {action, params};
return new Promise((resolve, reject) => {
try {
- this._yomitan.sendMessage(data, (response) => {
- this._checkLastError(chrome.runtime.lastError);
+ this._webExtension.sendMessage(data, (response) => {
+ this._webExtension.getLastError();
if (response !== null && typeof response === 'object') {
- if (typeof response.error !== 'undefined') {
- reject(ExtensionError.deserialize(response.error));
+ const {error} = /** @type {import('core').UnknownObject} */ (response);
+ if (typeof error !== 'undefined') {
+ reject(ExtensionError.deserialize(/** @type {import('core').SerializedError} */ (error)));
} else {
- resolve(response.result);
+ const {result} = /** @type {import('core').UnknownObject} */ (response);
+ resolve(/** @type {import('api').ApiReturn} */ (result));
}
} else {
const message = response === null ? 'Unexpected null response' : `Unexpected response of type ${typeof response}`;
@@ -393,11 +395,4 @@ export class API {
}
});
}
-
- /**
- * @param {chrome.runtime.LastError|undefined} _ignore
- */
- _checkLastError(_ignore) {
- // NOP
- }
}
diff --git a/ext/js/comm/clipboard-monitor.js b/ext/js/comm/clipboard-monitor.js
index b870a7a00f..a1ea33620a 100644
--- a/ext/js/comm/clipboard-monitor.js
+++ b/ext/js/comm/clipboard-monitor.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2020-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
@@ -16,7 +16,7 @@
* along with this program. If not, see
diff --git a/ext/js/comm/clipboard-reader.js b/ext/js/comm/clipboard-reader.js
index a6d1c0688e..2ac41cb9ac 100644
--- a/ext/js/comm/clipboard-reader.js
+++ b/ext/js/comm/clipboard-reader.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2020-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
diff --git a/ext/js/comm/cross-frame-api.js b/ext/js/comm/cross-frame-api.js
index 3569c037ab..fca7c84d7f 100644
--- a/ext/js/comm/cross-frame-api.js
+++ b/ext/js/comm/cross-frame-api.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2020-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
@@ -16,10 +16,12 @@
* along with this program. If not, see } visited
- * @returns {T}
- * @throws {Error}
- */
-function cloneInternal(value, visited) {
- if (value === null) { return /** @type {T} */ (null); }
- switch (typeof value) {
- case 'boolean':
- case 'number':
- case 'string':
- case 'bigint':
- case 'symbol':
- case 'undefined':
- return value;
- case 'object':
- return /** @type {T} */ (
- Array.isArray(value) ?
- cloneArray(value, visited) :
- cloneObject(/** @type {import('core').SerializableObject} */ (value), visited)
- );
- default:
- throw new Error(`Cannot clone object of type ${typeof value}`);
- }
-}
-
-/**
- * @param {unknown[]} value
- * @param {Set} visited
- * @returns {unknown[]}
- * @throws {Error}
- */
-function cloneArray(value, visited) {
- if (visited.has(value)) { throw new Error('Circular'); }
- try {
- visited.add(value);
- const result = [];
- for (const item of value) {
- result.push(cloneInternal(item, visited));
- }
- return result;
- } finally {
- visited.delete(value);
- }
-}
-
-/**
- * @param {import('core').SerializableObject} value
- * @param {Set} visited
- * @returns {import('core').SerializableObject}
- * @throws {Error}
- */
-function cloneObject(value, visited) {
- if (visited.has(value)) { throw new Error('Circular'); }
- try {
- visited.add(value);
- /** @type {import('core').SerializableObject} */
- const result = {};
- for (const key in value) {
- if (Object.prototype.hasOwnProperty.call(value, key)) {
- result[key] = cloneInternal(value[key], visited);
- }
- }
- return result;
- } finally {
- visited.delete(value);
- }
-}
-
-/**
- * Checks if an object or value is deeply equal to another object or value.
- * @param {unknown} value1 The first value to check.
- * @param {unknown} value2 The second value to check.
- * @returns {boolean} `true` if the values are the same object, or deeply equal without cycles. `false` otherwise.
- */
-export function deepEqual(value1, value2) {
- if (value1 === value2) { return true; }
-
- const type = typeof value1;
- if (typeof value2 !== type) { return false; }
-
- switch (type) {
- case 'object':
- case 'function':
- return deepEqualInternal(value1, value2, new Set());
- default:
- return false;
- }
-}
-
-/**
- * @param {unknown} value1
- * @param {unknown} value2
- * @param {Set} visited1
- * @returns {boolean}
- */
-function deepEqualInternal(value1, value2, visited1) {
- if (value1 === value2) { return true; }
-
- const type = typeof value1;
- if (typeof value2 !== type) { return false; }
-
- switch (type) {
- case 'object':
- case 'function':
- {
- if (value1 === null || value2 === null) { return false; }
- const array = Array.isArray(value1);
- if (array !== Array.isArray(value2)) { return false; }
- if (visited1.has(value1)) { return false; }
- visited1.add(value1);
- return (
- array ?
- areArraysEqual(/** @type {unknown[]} */ (value1), /** @type {unknown[]} */ (value2), visited1) :
- areObjectsEqual(/** @type {import('core').UnknownObject} */ (value1), /** @type {import('core').UnknownObject} */ (value2), visited1)
- );
- }
- default:
- return false;
- }
-}
-
-/**
- * @param {import('core').UnknownObject} value1
- * @param {import('core').UnknownObject} value2
- * @param {Set} visited1
- * @returns {boolean}
- */
-function areObjectsEqual(value1, value2, visited1) {
- const keys1 = Object.keys(value1);
- const keys2 = Object.keys(value2);
- if (keys1.length !== keys2.length) { return false; }
-
- const keys1Set = new Set(keys1);
- for (const key of keys2) {
- if (!keys1Set.has(key) || !deepEqualInternal(value1[key], value2[key], visited1)) { return false; }
- }
-
- return true;
-}
-
-/**
- * @param {unknown[]} value1
- * @param {unknown[]} value2
- * @param {Set} visited1
- * @returns {boolean}
- */
-function areArraysEqual(value1, value2, visited1) {
- const length = value1.length;
- if (length !== value2.length) { return false; }
-
- for (let i = 0; i < length; ++i) {
- if (!deepEqualInternal(value1[i], value2[i], visited1)) { return false; }
- }
-
- return true;
-}
-
-/**
- * Creates a new base-16 (lower case) string of a sequence of random bytes of the given length.
- * @param {number} length The number of bytes the string represents. The returned string's length will be twice as long.
- * @returns {string} A string of random characters.
- */
-export function generateId(length) {
- const array = new Uint8Array(length);
- crypto.getRandomValues(array);
- let id = '';
- for (const value of array) {
- id += value.toString(16).padStart(2, '0');
- }
- return id;
-}
-
-/**
- * Creates an unresolved promise that can be resolved later, outside the promise's executor function.
- * @template [T=unknown]
- * @returns {import('core').DeferredPromiseDetails} An object `{promise, resolve, reject}`, containing the promise and the resolve/reject functions.
- */
-export function deferPromise() {
- /** @type {((value: T) => void)|undefined} */
- let resolve;
- /** @type {((reason?: import('core').RejectionReason) => void)|undefined} */
- let reject;
- const promise = new Promise((resolve2, reject2) => {
- resolve = resolve2;
- reject = reject2;
- });
- return {
- promise,
- resolve: /** @type {(value: T) => void} */ (resolve),
- reject: /** @type {(reason?: import('core').RejectionReason) => void} */ (reject)
- };
-}
-
-/**
- * Creates a promise that is resolved after a set delay.
- * @param {number} delay How many milliseconds until the promise should be resolved. If 0, the promise is immediately resolved.
- * @returns {Promise} A promise with two additional properties: `resolve` and `reject`, which can be used to complete the promise early.
- */
-export function promiseTimeout(delay) {
- return delay <= 0 ? Promise.resolve() : new Promise((resolve) => { setTimeout(resolve, delay); });
-}
-
-/**
- * Creates a promise that will resolve after the next animation frame, using `requestAnimationFrame`.
- * @param {number} [timeout] A maximum duration (in milliseconds) to wait until the promise resolves. If null or omitted, no timeout is used.
- * @returns {Promise<{time: number, timeout: boolean}>} A promise that is resolved with `{time, timeout}`, where `time` is the timestamp from `requestAnimationFrame`,
- * and `timeout` is a boolean indicating whether the cause was a timeout or not.
- * @throws The promise throws an error if animation is not supported in this context, such as in a service worker.
- */
-export function promiseAnimationFrame(timeout) {
- return new Promise((resolve, reject) => {
- if (typeof cancelAnimationFrame !== 'function' || typeof requestAnimationFrame !== 'function') {
- reject(new Error('Animation not supported in this context'));
- return;
- }
-
- /** @type {?import('core').Timeout} */
- let timer = null;
- /** @type {?number} */
- let frameRequest = null;
- /**
- * @param {number} time
- */
- const onFrame = (time) => {
- frameRequest = null;
- if (timer !== null) {
- clearTimeout(timer);
- timer = null;
- }
- resolve({time, timeout: false});
- };
- const onTimeout = () => {
- timer = null;
- if (frameRequest !== null) {
- // eslint-disable-next-line no-undef
- cancelAnimationFrame(frameRequest);
- frameRequest = null;
- }
- resolve({time: performance.now(), timeout: true});
- };
-
- // eslint-disable-next-line no-undef
- frameRequest = requestAnimationFrame(onFrame);
- if (typeof timeout === 'number') {
- timer = setTimeout(onTimeout, timeout);
- }
- });
-}
-
-/**
- * The following typedef is required because the JSDoc `implements` tag doesn't work with `import()`.
- * https://github.com/microsoft/TypeScript/issues/49905
- * @typedef {import('core').EventDispatcherOffGeneric} EventDispatcherOffGeneric
- */
-
-/**
- * Base class controls basic event dispatching.
- * @template {import('core').EventSurface} TSurface
- * @implements {EventDispatcherOffGeneric}
- */
-export class EventDispatcher {
- /**
- * Creates a new instance.
- */
- constructor() {
- /** @type {Map, import('core').EventHandlerAny[]>} */
- this._eventMap = new Map();
- }
-
- /**
- * Triggers an event with the given name and specified argument.
- * @template {import('core').EventNames} TName
- * @param {TName} eventName The string representing the event's name.
- * @param {import('core').EventArgument} details The argument passed to the callback functions.
- * @returns {boolean} `true` if any callbacks were registered, `false` otherwise.
- */
- trigger(eventName, details) {
- const callbacks = this._eventMap.get(eventName);
- if (typeof callbacks === 'undefined') { return false; }
-
- for (const callback of callbacks) {
- callback(details);
- }
- return true;
- }
-
- /**
- * Adds a single event listener to a specific event.
- * @template {import('core').EventNames} TName
- * @param {TName} eventName The string representing the event's name.
- * @param {import('core').EventHandler} callback The event listener callback to add.
- */
- on(eventName, callback) {
- let callbacks = this._eventMap.get(eventName);
- if (typeof callbacks === 'undefined') {
- callbacks = [];
- this._eventMap.set(eventName, callbacks);
- }
- callbacks.push(callback);
- }
-
- /**
- * Removes a single event listener from a specific event.
- * @template {import('core').EventNames} TName
- * @param {TName} eventName The string representing the event's name.
- * @param {import('core').EventHandler} callback The event listener callback to add.
- * @returns {boolean} `true` if the callback was removed, `false` otherwise.
- */
- off(eventName, callback) {
- const callbacks = this._eventMap.get(eventName);
- if (typeof callbacks === 'undefined') { return false; }
-
- const ii = callbacks.length;
- for (let i = 0; i < ii; ++i) {
- if (callbacks[i] === callback) {
- callbacks.splice(i, 1);
- if (callbacks.length === 0) {
- this._eventMap.delete(eventName);
- }
- return true;
- }
- }
- return false;
- }
-
- /**
- * Checks if an event has any listeners.
- * @template {import('core').EventNames} TName
- * @param {TName} eventName The string representing the event's name.
- * @returns {boolean} `true` if the event has listeners, `false` otherwise.
- */
- hasListeners(eventName) {
- const callbacks = this._eventMap.get(eventName);
- return (typeof callbacks !== 'undefined' && callbacks.length > 0);
- }
-}
-
-/**
- * Class which stores event listeners added to various objects, making it easy to remove them in bulk.
- */
-export class EventListenerCollection {
- /**
- * Creates a new instance.
- */
- constructor() {
- /** @type {import('event-listener-collection').EventListenerDetails[]} */
- this._eventListeners = [];
- }
-
- /**
- * Returns the number of event listeners that are currently in the object.
- * @type {number}
- */
- get size() {
- return this._eventListeners.length;
- }
-
- /**
- * Adds an event listener using `object.addEventListener`. The listener will later be removed using `object.removeEventListener`.
- * @param {import('event-listener-collection').EventTarget} target The object to add the event listener to.
- * @param {string} type The name of the event.
- * @param {EventListener | EventListenerObject | import('event-listener-collection').EventListenerFunction} listener The callback listener.
- * @param {AddEventListenerOptions | boolean} [options] Options for the event.
- */
- addEventListener(target, type, listener, options) {
- target.addEventListener(type, listener, options);
- this._eventListeners.push({type: 'removeEventListener', target, eventName: type, listener, options});
- }
-
- /**
- * Adds an event listener using `object.addListener`. The listener will later be removed using `object.removeListener`.
- * @template {import('event-listener-collection').EventListenerFunction} TCallback
- * @template [TArgs=unknown]
- * @param {import('event-listener-collection').ExtensionEvent} target The object to add the event listener to.
- * @param {TCallback} callback The callback.
- * @param {TArgs[]} args The extra argument array passed to the `addListener`/`removeListener` function.
- */
- addListener(target, callback, ...args) {
- target.addListener(callback, ...args);
- this._eventListeners.push({type: 'removeListener', target, callback, args});
- }
-
- /**
- * Adds an event listener using `object.on`. The listener will later be removed using `object.off`.
- * @template {import('core').EventSurface} TSurface
- * @template {import('core').EventNames} TName
- * @param {EventDispatcher} target The object to add the event listener to.
- * @param {TName} eventName The string representing the event's name.
- * @param {import('core').EventHandler} callback The event listener callback to add.
- */
- on(target, eventName, callback) {
- target.on(eventName, callback);
- this._eventListeners.push({type: 'off', eventName, target, callback});
- }
-
- /**
- * Removes all event listeners added to objects for this instance and clears the internal list of event listeners.
- */
- removeAllEventListeners() {
- if (this._eventListeners.length === 0) { return; }
- for (const item of this._eventListeners) {
- switch (item.type) {
- case 'removeEventListener':
- item.target.removeEventListener(item.eventName, item.listener, item.options);
- break;
- case 'removeListener':
- item.target.removeListener(item.callback, ...item.args);
- break;
- case 'off':
- item.target.off(item.eventName, item.callback);
- break;
- }
- }
- this._eventListeners = [];
- }
-}
-
-/**
- * Class representing a generic value with an override stack.
- * Changes can be observed by listening to the 'change' event.
- * @template [T=unknown]
- * @augments EventDispatcher>
- */
-export class DynamicProperty extends EventDispatcher {
- /**
- * Creates a new instance with the specified value.
- * @param {T} value The value to assign.
- */
- constructor(value) {
- super();
- /** @type {T} */
- this._value = value;
- /** @type {T} */
- this._defaultValue = value;
- /** @type {{value: T, priority: number, token: string}[]} */
- this._overrides = [];
- }
-
- /**
- * Gets the default value for the property, which is assigned to the
- * public value property when no overrides are present.
- * @type {T}
- */
- get defaultValue() {
- return this._defaultValue;
- }
-
- /**
- * Assigns the default value for the property. If no overrides are present
- * and if the value is different than the current default value,
- * the 'change' event will be triggered.
- * @param {T} value The value to assign.
- */
- set defaultValue(value) {
- this._defaultValue = value;
- if (this._overrides.length === 0) { this._updateValue(); }
- }
-
- /**
- * Gets the current value for the property, taking any overrides into account.
- * @type {T}
- */
- get value() {
- return this._value;
- }
-
- /**
- * Gets the number of overrides added to the property.
- * @type {number}
- */
- get overrideCount() {
- return this._overrides.length;
- }
-
- /**
- * Adds an override value with the specified priority to the override stack.
- * Values with higher priority will take precedence over those with lower.
- * For tie breaks, the override value added first will take precedence.
- * If the newly added override has the highest priority of all overrides
- * and if the override value is different from the current value,
- * the 'change' event will be fired.
- * @param {T} value The override value to assign.
- * @param {number} [priority] The priority value to use, as a number.
- * @returns {import('core').TokenString} A string token which can be passed to the clearOverride function
- * to remove the override.
- */
- setOverride(value, priority = 0) {
- const overridesCount = this._overrides.length;
- let i = 0;
- for (; i < overridesCount; ++i) {
- if (priority > this._overrides[i].priority) { break; }
- }
- const token = generateId(16);
- this._overrides.splice(i, 0, {value, priority, token});
- if (i === 0) { this._updateValue(); }
- return token;
- }
-
- /**
- * Removes a specific override value. If the removed override
- * had the highest priority, and the new value is different from
- * the previous value, the 'change' event will be fired.
- * @param {import('core').TokenString} token The token for the corresponding override which is to be removed.
- * @returns {boolean} `true` if an override was returned, `false` otherwise.
- */
- clearOverride(token) {
- for (let i = 0, ii = this._overrides.length; i < ii; ++i) {
- if (this._overrides[i].token === token) {
- this._overrides.splice(i, 1);
- if (i === 0) { this._updateValue(); }
- return true;
- }
- }
- return false;
- }
-
- /**
- * Updates the current value using the current overrides and default value.
- * If the new value differs from the previous value, the 'change' event will be fired.
- */
- _updateValue() {
- const value = this._overrides.length > 0 ? this._overrides[0].value : this._defaultValue;
- if (this._value === value) { return; }
- this._value = value;
- this.trigger('change', {value});
- }
-}
-
-/**
- * This class handles logging of messages to the console and triggering
- * an event for log calls.
- * @augments EventDispatcher
- */
-export class Logger extends EventDispatcher {
- /**
- * Creates a new instance.
- */
- constructor() {
- super();
- /** @type {string} */
- this._extensionName = 'Yomitan';
- try {
- const {name, version} = chrome.runtime.getManifest();
- this._extensionName = `${name} ${version}`;
- } catch (e) {
- // NOP
- }
- }
-
- /**
- * Logs a generic error. This will trigger the 'log' event with the same arguments as the function invocation.
- * @param {unknown} error The error to log. This is typically an `Error` or `Error`-like object.
- * @param {import('log').LogLevel} level The level to log at. Values include `'info'`, `'debug'`, `'warn'`, and `'error'`.
- * Other values will be logged at a non-error level.
- * @param {?import('log').LogContext} [context] An optional context object for the error which should typically include a `url` field.
- */
- log(error, level, context = null) {
- if (typeof context !== 'object' || context === null) {
- context = {url: location.href};
- }
-
- let errorString;
- try {
- if (typeof error === 'string') {
- errorString = error;
- } else {
- errorString = (
- typeof error === 'object' && error !== null ?
- error.toString() :
- `${error}`
- );
- if (/^\[object \w+\]$/.test(errorString)) {
- errorString = JSON.stringify(error);
- }
- }
- } catch (e) {
- errorString = `${error}`;
- }
-
- let errorStack;
- try {
- errorStack = (
- error instanceof Error ?
- (typeof error.stack === 'string' ? error.stack.trimEnd() : '') :
- ''
- );
- } catch (e) {
- errorStack = '';
- }
-
- let errorData;
- try {
- if (error instanceof ExtensionError) {
- errorData = error.data;
- }
- } catch (e) {
- // NOP
- }
-
- if (errorStack.startsWith(errorString)) {
- errorString = errorStack;
- } else if (errorStack.length > 0) {
- errorString += `\n${errorStack}`;
- }
-
- let message = `${this._extensionName} has encountered a problem.`;
- message += `\nOriginating URL: ${context.url}\n`;
- message += errorString;
- if (typeof errorData !== 'undefined') {
- message += `\nData: ${JSON.stringify(errorData, null, 4)}`;
- }
- message += '\n\nIssues can be reported at https://github.com/themoeway/yomitan/issues';
-
- /* eslint-disable no-console */
- switch (level) {
- case 'info': console.info(message); break;
- case 'debug': console.debug(message); break;
- case 'warn': console.warn(message); break;
- case 'error': console.error(message); break;
- default: console.log(message); break;
- }
- /* eslint-enable no-console */
-
- this.trigger('log', {error, level, context});
- }
-
- /**
- * Logs a warning. This function invokes `log` internally.
- * @param {unknown} error The error to log. This is typically an `Error` or `Error`-like object.
- * @param {?import('log').LogContext} context An optional context object for the error which should typically include a `url` field.
- */
- warn(error, context = null) {
- this.log(error, 'warn', context);
- }
-
- /**
- * Logs an error. This function invokes `log` internally.
- * @param {unknown} error The error to log. This is typically an `Error` or `Error`-like object.
- * @param {?import('log').LogContext} context An optional context object for the error which should typically include a `url` field.
- */
- error(error, context = null) {
- this.log(error, 'error', context);
- }
-
- /**
- * @param {import('log').LogLevel} errorLevel
- * @returns {import('log').LogErrorLevelValue}
- */
- getLogErrorLevelValue(errorLevel) {
- switch (errorLevel) {
- case 'log':
- case 'info':
- case 'debug':
- return 0;
- case 'warn': return 1;
- case 'error': return 2;
- }
- }
-}
-
-/**
- * This object is the default logger used by the runtime.
- */
-export const log = new Logger();
diff --git a/ext/js/core/api-map.js b/ext/js/core/api-map.js
index 09be80354b..727c573089 100644
--- a/ext/js/core/api-map.js
+++ b/ext/js/core/api-map.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan 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
diff --git a/ext/js/core/dynamic-property.js b/ext/js/core/dynamic-property.js
new file mode 100644
index 0000000000..5d8b4716d9
--- /dev/null
+++ b/ext/js/core/dynamic-property.js
@@ -0,0 +1,131 @@
+/*
+ * Copyright (C) 2023-2024 Yomitan Authors
+ * Copyright (C) 2019-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 >
+ */
+export class DynamicProperty extends EventDispatcher {
+ /**
+ * Creates a new instance with the specified value.
+ * @param {T} value The value to assign.
+ */
+ constructor(value) {
+ super();
+ /** @type {T} */
+ this._value = value;
+ /** @type {T} */
+ this._defaultValue = value;
+ /** @type {{value: T, priority: number, token: string}[]} */
+ this._overrides = [];
+ }
+
+ /**
+ * Gets the default value for the property, which is assigned to the
+ * public value property when no overrides are present.
+ * @type {T}
+ */
+ get defaultValue() {
+ return this._defaultValue;
+ }
+
+ /**
+ * Assigns the default value for the property. If no overrides are present
+ * and if the value is different than the current default value,
+ * the 'change' event will be triggered.
+ * @param {T} value The value to assign.
+ */
+ set defaultValue(value) {
+ this._defaultValue = value;
+ if (this._overrides.length === 0) { this._updateValue(); }
+ }
+
+ /**
+ * Gets the current value for the property, taking any overrides into account.
+ * @type {T}
+ */
+ get value() {
+ return this._value;
+ }
+
+ /**
+ * Gets the number of overrides added to the property.
+ * @type {number}
+ */
+ get overrideCount() {
+ return this._overrides.length;
+ }
+
+ /**
+ * Adds an override value with the specified priority to the override stack.
+ * Values with higher priority will take precedence over those with lower.
+ * For tie breaks, the override value added first will take precedence.
+ * If the newly added override has the highest priority of all overrides
+ * and if the override value is different from the current value,
+ * the 'change' event will be fired.
+ * @param {T} value The override value to assign.
+ * @param {number} [priority] The priority value to use, as a number.
+ * @returns {import('core').TokenString} A string token which can be passed to the clearOverride function
+ * to remove the override.
+ */
+ setOverride(value, priority = 0) {
+ const overridesCount = this._overrides.length;
+ let i = 0;
+ for (; i < overridesCount; ++i) {
+ if (priority > this._overrides[i].priority) { break; }
+ }
+ const token = generateId(16);
+ this._overrides.splice(i, 0, {value, priority, token});
+ if (i === 0) { this._updateValue(); }
+ return token;
+ }
+
+ /**
+ * Removes a specific override value. If the removed override
+ * had the highest priority, and the new value is different from
+ * the previous value, the 'change' event will be fired.
+ * @param {import('core').TokenString} token The token for the corresponding override which is to be removed.
+ * @returns {boolean} `true` if an override was returned, `false` otherwise.
+ */
+ clearOverride(token) {
+ for (let i = 0, ii = this._overrides.length; i < ii; ++i) {
+ if (this._overrides[i].token === token) {
+ this._overrides.splice(i, 1);
+ if (i === 0) { this._updateValue(); }
+ return true;
+ }
+ }
+ return false;
+ }
+
+ /**
+ * Updates the current value using the current overrides and default value.
+ * If the new value differs from the previous value, the 'change' event will be fired.
+ */
+ _updateValue() {
+ const value = this._overrides.length > 0 ? this._overrides[0].value : this._defaultValue;
+ if (this._value === value) { return; }
+ this._value = value;
+ this.trigger('change', {value});
+ }
+}
diff --git a/ext/js/core/event-dispatcher.js b/ext/js/core/event-dispatcher.js
new file mode 100644
index 0000000000..75f2fdd33f
--- /dev/null
+++ b/ext/js/core/event-dispatcher.js
@@ -0,0 +1,105 @@
+/*
+ * Copyright (C) 2023-2024 Yomitan Authors
+ * Copyright (C) 2019-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 , import('core').EventHandlerAny[]>} */
+ this._eventMap = new Map();
+ }
+
+ /**
+ * Triggers an event with the given name and specified argument.
+ * @template {import('core').EventNames} TName
+ * @param {TName} eventName The string representing the event's name.
+ * @param {import('core').EventArgument} details The argument passed to the callback functions.
+ * @returns {boolean} `true` if any callbacks were registered, `false` otherwise.
+ */
+ trigger(eventName, details) {
+ const callbacks = this._eventMap.get(eventName);
+ if (typeof callbacks === 'undefined') { return false; }
+
+ for (const callback of callbacks) {
+ callback(details);
+ }
+ return true;
+ }
+
+ /**
+ * Adds a single event listener to a specific event.
+ * @template {import('core').EventNames} TName
+ * @param {TName} eventName The string representing the event's name.
+ * @param {import('core').EventHandler} callback The event listener callback to add.
+ */
+ on(eventName, callback) {
+ let callbacks = this._eventMap.get(eventName);
+ if (typeof callbacks === 'undefined') {
+ callbacks = [];
+ this._eventMap.set(eventName, callbacks);
+ }
+ callbacks.push(callback);
+ }
+
+ /**
+ * Removes a single event listener from a specific event.
+ * @template {import('core').EventNames} TName
+ * @param {TName} eventName The string representing the event's name.
+ * @param {import('core').EventHandler} callback The event listener callback to add.
+ * @returns {boolean} `true` if the callback was removed, `false` otherwise.
+ */
+ off(eventName, callback) {
+ const callbacks = this._eventMap.get(eventName);
+ if (typeof callbacks === 'undefined') { return false; }
+
+ const ii = callbacks.length;
+ for (let i = 0; i < ii; ++i) {
+ if (callbacks[i] === callback) {
+ callbacks.splice(i, 1);
+ if (callbacks.length === 0) {
+ this._eventMap.delete(eventName);
+ }
+ return true;
+ }
+ }
+ return false;
+ }
+
+ /**
+ * Checks if an event has any listeners.
+ * @template {import('core').EventNames} TName
+ * @param {TName} eventName The string representing the event's name.
+ * @returns {boolean} `true` if the event has listeners, `false` otherwise.
+ */
+ hasListeners(eventName) {
+ const callbacks = this._eventMap.get(eventName);
+ return (typeof callbacks !== 'undefined' && callbacks.length > 0);
+ }
+}
diff --git a/ext/js/core/event-listener-collection.js b/ext/js/core/event-listener-collection.js
new file mode 100644
index 0000000000..87d18a90c6
--- /dev/null
+++ b/ext/js/core/event-listener-collection.js
@@ -0,0 +1,97 @@
+/*
+ * Copyright (C) 2023-2024 Yomitan Authors
+ * Copyright (C) 2019-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 } target The object to add the event listener to.
+ * @param {TCallback} callback The callback.
+ * @param {TArgs[]} args The extra argument array passed to the `addListener`/`removeListener` function.
+ */
+ addListener(target, callback, ...args) {
+ target.addListener(callback, ...args);
+ this._eventListeners.push({type: 'removeListener', target, callback, args});
+ }
+
+ /**
+ * Adds an event listener using `object.on`. The listener will later be removed using `object.off`.
+ * @template {import('core').EventSurface} TSurface
+ * @template {import('core').EventNames} TName
+ * @param {import('./event-dispatcher.js').EventDispatcher} target The object to add the event listener to.
+ * @param {TName} eventName The string representing the event's name.
+ * @param {import('core').EventHandler} callback The event listener callback to add.
+ */
+ on(target, eventName, callback) {
+ target.on(eventName, callback);
+ this._eventListeners.push({type: 'off', eventName, target, callback});
+ }
+
+ /**
+ * Removes all event listeners added to objects for this instance and clears the internal list of event listeners.
+ */
+ removeAllEventListeners() {
+ if (this._eventListeners.length === 0) { return; }
+ for (const item of this._eventListeners) {
+ switch (item.type) {
+ case 'removeEventListener':
+ item.target.removeEventListener(item.eventName, item.listener, item.options);
+ break;
+ case 'removeListener':
+ item.target.removeListener(item.callback, ...item.args);
+ break;
+ case 'off':
+ item.target.off(item.eventName, item.callback);
+ break;
+ }
+ }
+ this._eventListeners = [];
+ }
+}
diff --git a/ext/js/core/extension-error.js b/ext/js/core/extension-error.js
index f1485a74d6..ab1c9dd73e 100644
--- a/ext/js/core/extension-error.js
+++ b/ext/js/core/extension-error.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan 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
diff --git a/ext/js/core/json.js b/ext/js/core/json.js
index 0ebe28879f..c7d8fbfd1d 100644
--- a/ext/js/core/json.js
+++ b/ext/js/core/json.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan 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
diff --git a/ext/js/core/logger.js b/ext/js/core/logger.js
new file mode 100644
index 0000000000..165e1ae255
--- /dev/null
+++ b/ext/js/core/logger.js
@@ -0,0 +1,157 @@
+/*
+ * Copyright (C) 2023-2024 Yomitan Authors
+ * Copyright (C) 2019-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
+ */
+export class Logger extends EventDispatcher {
+ /**
+ * Creates a new instance.
+ */
+ constructor() {
+ super();
+ /** @type {string} */
+ this._extensionName = 'Yomitan';
+ try {
+ const {name, version} = chrome.runtime.getManifest();
+ this._extensionName = `${name} ${version}`;
+ } catch (e) {
+ // NOP
+ }
+ }
+
+ /**
+ * Logs a generic error. This will trigger the 'log' event with the same arguments as the function invocation.
+ * @param {unknown} error The error to log. This is typically an `Error` or `Error`-like object.
+ * @param {import('log').LogLevel} level The level to log at. Values include `'info'`, `'debug'`, `'warn'`, and `'error'`.
+ * Other values will be logged at a non-error level.
+ * @param {?import('log').LogContext} [context] An optional context object for the error which should typically include a `url` field.
+ */
+ log(error, level, context = null) {
+ if (typeof context !== 'object' || context === null) {
+ context = {url: location.href};
+ }
+
+ let errorString;
+ try {
+ if (typeof error === 'string') {
+ errorString = error;
+ } else {
+ errorString = (
+ typeof error === 'object' && error !== null ?
+ error.toString() :
+ `${error}`
+ );
+ if (/^\[object \w+\]$/.test(errorString)) {
+ errorString = JSON.stringify(error);
+ }
+ }
+ } catch (e) {
+ errorString = `${error}`;
+ }
+
+ let errorStack;
+ try {
+ errorStack = (
+ error instanceof Error ?
+ (typeof error.stack === 'string' ? error.stack.trimEnd() : '') :
+ ''
+ );
+ } catch (e) {
+ errorStack = '';
+ }
+
+ let errorData;
+ try {
+ if (error instanceof ExtensionError) {
+ errorData = error.data;
+ }
+ } catch (e) {
+ // NOP
+ }
+
+ if (errorStack.startsWith(errorString)) {
+ errorString = errorStack;
+ } else if (errorStack.length > 0) {
+ errorString += `\n${errorStack}`;
+ }
+
+ let message = `${this._extensionName} has encountered a problem.`;
+ message += `\nOriginating URL: ${context.url}\n`;
+ message += errorString;
+ if (typeof errorData !== 'undefined') {
+ message += `\nData: ${JSON.stringify(errorData, null, 4)}`;
+ }
+ message += '\n\nIssues can be reported at https://github.com/themoeway/yomitan/issues';
+
+ /* eslint-disable no-console */
+ switch (level) {
+ case 'log': console.log(message); break;
+ case 'info': console.info(message); break;
+ case 'debug': console.debug(message); break;
+ case 'warn': console.warn(message); break;
+ case 'error': console.error(message); break;
+ }
+ /* eslint-enable no-console */
+
+ this.trigger('log', {error, level, context});
+ }
+
+ /**
+ * Logs a warning. This function invokes `log` internally.
+ * @param {unknown} error The error to log. This is typically an `Error` or `Error`-like object.
+ * @param {?import('log').LogContext} context An optional context object for the error which should typically include a `url` field.
+ */
+ warn(error, context = null) {
+ this.log(error, 'warn', context);
+ }
+
+ /**
+ * Logs an error. This function invokes `log` internally.
+ * @param {unknown} error The error to log. This is typically an `Error` or `Error`-like object.
+ * @param {?import('log').LogContext} context An optional context object for the error which should typically include a `url` field.
+ */
+ error(error, context = null) {
+ this.log(error, 'error', context);
+ }
+
+ /**
+ * @param {import('log').LogLevel} errorLevel
+ * @returns {import('log').LogErrorLevelValue}
+ */
+ getLogErrorLevelValue(errorLevel) {
+ switch (errorLevel) {
+ case 'log':
+ case 'info':
+ case 'debug':
+ return 0;
+ case 'warn': return 1;
+ case 'error': return 2;
+ }
+ }
+}
+
+/**
+ * This object is the default logger used by the runtime.
+ */
+export const log = new Logger();
diff --git a/ext/js/core/to-error.js b/ext/js/core/to-error.js
new file mode 100644
index 0000000000..c662929c0d
--- /dev/null
+++ b/ext/js/core/to-error.js
@@ -0,0 +1,26 @@
+/*
+ * Copyright (C) 2023-2024 Yomitan 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 } visited
+ * @returns {T}
+ * @throws {Error}
+ */
+function cloneInternal(value, visited) {
+ if (value === null) { return /** @type {T} */ (null); }
+ switch (typeof value) {
+ case 'boolean':
+ case 'number':
+ case 'string':
+ case 'bigint':
+ case 'symbol':
+ case 'undefined':
+ return value;
+ case 'object':
+ return /** @type {T} */ (
+ Array.isArray(value) ?
+ cloneArray(value, visited) :
+ cloneObject(/** @type {import('core').SerializableObject} */ (value), visited)
+ );
+ default:
+ throw new Error(`Cannot clone object of type ${typeof value}`);
+ }
+}
+
+/**
+ * @param {unknown[]} value
+ * @param {Set} visited
+ * @returns {unknown[]}
+ * @throws {Error}
+ */
+function cloneArray(value, visited) {
+ if (visited.has(value)) { throw new Error('Circular'); }
+ try {
+ visited.add(value);
+ const result = [];
+ for (const item of value) {
+ result.push(cloneInternal(item, visited));
+ }
+ return result;
+ } finally {
+ visited.delete(value);
+ }
+}
+
+/**
+ * @param {import('core').SerializableObject} value
+ * @param {Set} visited
+ * @returns {import('core').SerializableObject}
+ * @throws {Error}
+ */
+function cloneObject(value, visited) {
+ if (visited.has(value)) { throw new Error('Circular'); }
+ try {
+ visited.add(value);
+ /** @type {import('core').SerializableObject} */
+ const result = {};
+ for (const key in value) {
+ if (Object.prototype.hasOwnProperty.call(value, key)) {
+ result[key] = cloneInternal(value[key], visited);
+ }
+ }
+ return result;
+ } finally {
+ visited.delete(value);
+ }
+}
+
+/**
+ * Checks if an object or value is deeply equal to another object or value.
+ * @param {unknown} value1 The first value to check.
+ * @param {unknown} value2 The second value to check.
+ * @returns {boolean} `true` if the values are the same object, or deeply equal without cycles. `false` otherwise.
+ */
+export function deepEqual(value1, value2) {
+ if (value1 === value2) { return true; }
+
+ const type = typeof value1;
+ if (typeof value2 !== type) { return false; }
+
+ switch (type) {
+ case 'object':
+ case 'function':
+ return deepEqualInternal(value1, value2, new Set());
+ default:
+ return false;
+ }
+}
+
+/**
+ * @param {unknown} value1
+ * @param {unknown} value2
+ * @param {Set} visited1
+ * @returns {boolean}
+ */
+function deepEqualInternal(value1, value2, visited1) {
+ if (value1 === value2) { return true; }
+
+ const type = typeof value1;
+ if (typeof value2 !== type) { return false; }
+
+ switch (type) {
+ case 'object':
+ case 'function':
+ {
+ if (value1 === null || value2 === null) { return false; }
+ const array = Array.isArray(value1);
+ if (array !== Array.isArray(value2)) { return false; }
+ if (visited1.has(value1)) { return false; }
+ visited1.add(value1);
+ return (
+ array ?
+ areArraysEqual(/** @type {unknown[]} */ (value1), /** @type {unknown[]} */ (value2), visited1) :
+ areObjectsEqual(/** @type {import('core').UnknownObject} */ (value1), /** @type {import('core').UnknownObject} */ (value2), visited1)
+ );
+ }
+ default:
+ return false;
+ }
+}
+
+/**
+ * @param {import('core').UnknownObject} value1
+ * @param {import('core').UnknownObject} value2
+ * @param {Set} visited1
+ * @returns {boolean}
+ */
+function areObjectsEqual(value1, value2, visited1) {
+ const keys1 = Object.keys(value1);
+ const keys2 = Object.keys(value2);
+ if (keys1.length !== keys2.length) { return false; }
+
+ const keys1Set = new Set(keys1);
+ for (const key of keys2) {
+ if (!keys1Set.has(key) || !deepEqualInternal(value1[key], value2[key], visited1)) { return false; }
+ }
+
+ return true;
+}
+
+/**
+ * @param {unknown[]} value1
+ * @param {unknown[]} value2
+ * @param {Set} visited1
+ * @returns {boolean}
+ */
+function areArraysEqual(value1, value2, visited1) {
+ const length = value1.length;
+ if (length !== value2.length) { return false; }
+
+ for (let i = 0; i < length; ++i) {
+ if (!deepEqualInternal(value1[i], value2[i], visited1)) { return false; }
+ }
+
+ return true;
+}
+
+/**
+ * Creates a new base-16 (lower case) string of a sequence of random bytes of the given length.
+ * @param {number} length The number of bytes the string represents. The returned string's length will be twice as long.
+ * @returns {string} A string of random characters.
+ */
+export function generateId(length) {
+ const array = new Uint8Array(length);
+ crypto.getRandomValues(array);
+ let id = '';
+ for (const value of array) {
+ id += value.toString(16).padStart(2, '0');
+ }
+ return id;
+}
+
+/**
+ * Creates an unresolved promise that can be resolved later, outside the promise's executor function.
+ * @template [T=unknown]
+ * @returns {import('core').DeferredPromiseDetails} An object `{promise, resolve, reject}`, containing the promise and the resolve/reject functions.
+ */
+export function deferPromise() {
+ /** @type {((value: T) => void)|undefined} */
+ let resolve;
+ /** @type {((reason?: import('core').RejectionReason) => void)|undefined} */
+ let reject;
+ const promise = new Promise((resolve2, reject2) => {
+ resolve = resolve2;
+ reject = reject2;
+ });
+ return {
+ promise,
+ resolve: /** @type {(value: T) => void} */ (resolve),
+ reject: /** @type {(reason?: import('core').RejectionReason) => void} */ (reject)
+ };
+}
+
+/**
+ * Creates a promise that is resolved after a set delay.
+ * @param {number} delay How many milliseconds until the promise should be resolved. If 0, the promise is immediately resolved.
+ * @returns {Promise} A promise with two additional properties: `resolve` and `reject`, which can be used to complete the promise early.
+ */
+export function promiseTimeout(delay) {
+ return delay <= 0 ? Promise.resolve() : new Promise((resolve) => { setTimeout(resolve, delay); });
+}
+
+/**
+ * Creates a promise that will resolve after the next animation frame, using `requestAnimationFrame`.
+ * @param {number} [timeout] A maximum duration (in milliseconds) to wait until the promise resolves. If null or omitted, no timeout is used.
+ * @returns {Promise<{time: number, timeout: boolean}>} A promise that is resolved with `{time, timeout}`, where `time` is the timestamp from `requestAnimationFrame`,
+ * and `timeout` is a boolean indicating whether the cause was a timeout or not.
+ * @throws The promise throws an error if animation is not supported in this context, such as in a service worker.
+ */
+export function promiseAnimationFrame(timeout) {
+ return new Promise((resolve, reject) => {
+ if (typeof cancelAnimationFrame !== 'function' || typeof requestAnimationFrame !== 'function') {
+ reject(new Error('Animation not supported in this context'));
+ return;
+ }
+
+ /** @type {?import('core').Timeout} */
+ let timer = null;
+ /** @type {?number} */
+ let frameRequest = null;
+ /**
+ * @param {number} time
+ */
+ const onFrame = (time) => {
+ frameRequest = null;
+ if (timer !== null) {
+ clearTimeout(timer);
+ timer = null;
+ }
+ resolve({time, timeout: false});
+ };
+ const onTimeout = () => {
+ timer = null;
+ if (frameRequest !== null) {
+ // eslint-disable-next-line no-undef
+ cancelAnimationFrame(frameRequest);
+ frameRequest = null;
+ }
+ resolve({time: performance.now(), timeout: true});
+ };
+
+ // eslint-disable-next-line no-undef
+ frameRequest = requestAnimationFrame(onFrame);
+ if (typeof timeout === 'number') {
+ timer = setTimeout(onTimeout, timeout);
+ }
+ });
+}
diff --git a/ext/js/data/anki-note-builder.js b/ext/js/data/anki-note-builder.js
index cdb0656468..48564d54d0 100644
--- a/ext/js/data/anki-note-builder.js
+++ b/ext/js/data/anki-note-builder.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2020-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
@@ -16,7 +16,7 @@
* along with this program. If not, see
diff --git a/ext/js/display/display-notification.js b/ext/js/display/display-notification.js
index df475adfb9..a955f3fa44 100644
--- a/ext/js/display/display-notification.js
+++ b/ext/js/display/display-notification.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2017-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
@@ -16,7 +16,7 @@
* along with this program. If not, see
diff --git a/ext/js/dom/document-focus-controller.js b/ext/js/dom/document-focus-controller.js
index fd88a35d9b..f23145b95f 100644
--- a/ext/js/dom/document-focus-controller.js
+++ b/ext/js/dom/document-focus-controller.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2020-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
diff --git a/ext/js/dom/document-util.js b/ext/js/dom/document-util.js
index df3bd35498..235a42d004 100644
--- a/ext/js/dom/document-util.js
+++ b/ext/js/dom/document-util.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2016-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
@@ -386,7 +386,7 @@ export class DocumentUtil {
/**
* Adds a fullscreen change event listener. This function handles all of the browser-specific variants.
* @param {EventListener} onFullscreenChanged The event callback.
- * @param {?import('../core.js').EventListenerCollection} eventListenerCollection An optional `EventListenerCollection` to add the registration to.
+ * @param {?import('../core/event-listener-collection.js').EventListenerCollection} eventListenerCollection An optional `EventListenerCollection` to add the registration to.
*/
static addFullscreenChangeEventListener(onFullscreenChanged, eventListenerCollection = null) {
const target = document;
diff --git a/ext/js/dom/dom-data-binder.js b/ext/js/dom/dom-data-binder.js
index e25583389d..7523e4340c 100644
--- a/ext/js/dom/dom-data-binder.js
+++ b/ext/js/dom/dom-data-binder.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2020-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
diff --git a/ext/js/dom/dom-text-scanner.js b/ext/js/dom/dom-text-scanner.js
index 21770a7005..d605aecaed 100644
--- a/ext/js/dom/dom-text-scanner.js
+++ b/ext/js/dom/dom-text-scanner.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2020-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
@@ -212,10 +212,8 @@ export class DOMTextScanner {
/**
* Gets information about how whitespace characters are treated.
- * @param {Text} textNode The text node to check.
- * @returns {{preserveNewlines: boolean, preserveWhitespace: boolean}} Information about the whitespace.
- * The value of `preserveNewlines` indicates whether or not newline characters are treated as line breaks.
- * The value of `preserveWhitespace` indicates whether or not sequences of whitespace characters are collapsed.
+ * @param {Text} textNode
+ * @returns {import('dom-text-scanner').WhitespaceSettings}
*/
_getWhitespaceSettings(textNode) {
if (this._forcePreserveWhitespace) {
@@ -412,13 +410,8 @@ export class DOMTextScanner {
}
/**
- * Gets seek information about an element.
- * @param {Element} element The element to check.
- * @returns {{enterable: boolean, newlines: number}} The seek information.
- * The `enterable` value indicates whether the content of this node should be entered.
- * The `newlines` value corresponds to the number of newline characters that should be added.
- * - 1 newline corresponds to a simple new line in the layout.
- * - 2 newlines corresponds to a significant visual distinction since the previous content.
+ * @param {Element} element
+ * @returns {import('dom-text-scanner').ElementSeekInfo}
*/
static getElementSeekInfo(element) {
let enterable = true;
diff --git a/ext/js/dom/html-template-collection.js b/ext/js/dom/html-template-collection.js
index 62d18224ab..981d5528b9 100644
--- a/ext/js/dom/html-template-collection.js
+++ b/ext/js/dom/html-template-collection.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2020-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
diff --git a/ext/js/dom/native-simple-dom-parser.js b/ext/js/dom/native-simple-dom-parser.js
index 418a4e3cca..e40e7663c9 100644
--- a/ext/js/dom/native-simple-dom-parser.js
+++ b/ext/js/dom/native-simple-dom-parser.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2020-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
diff --git a/ext/js/dom/panel-element.js b/ext/js/dom/panel-element.js
index 959ca42065..9c1289d717 100644
--- a/ext/js/dom/panel-element.js
+++ b/ext/js/dom/panel-element.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2020-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
@@ -16,7 +16,7 @@
* along with this program. If not, see
diff --git a/ext/js/dom/popup-menu.js b/ext/js/dom/popup-menu.js
index 61f20ba89f..8a8a19baad 100644
--- a/ext/js/dom/popup-menu.js
+++ b/ext/js/dom/popup-menu.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2020-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
@@ -16,7 +16,8 @@
* along with this program. If not, see
+ */
+export class WebExtension extends EventDispatcher {
+ constructor() {
+ super();
+ /** @type {boolean} */
+ this._unloaded = false;
+ }
+
+ /** @type {boolean} */
+ get unloaded() {
+ return this._unloaded;
+ }
+
+ /**
+ * @param {string} path
+ * @returns {string}
+ */
+ getUrl(path) {
+ return chrome.runtime.getURL(path);
+ }
+
+ /**
+ * @param {unknown} message
+ * @param {(response: unknown) => void} responseCallback
+ * @throws {Error}
+ */
+ sendMessage(message, responseCallback) {
+ try {
+ chrome.runtime.sendMessage(message, responseCallback);
+ } catch (error) {
+ this.triggerUnloaded();
+ throw toError(error);
+ }
+ }
+
+ /**
+ * @param {unknown} message
+ * @returns {Promise}
+ */
+ sendMessagePromise(message) {
+ return new Promise((resolve, reject) => {
+ try {
+ this.sendMessage(message, (response) => {
+ const error = this.getLastError();
+ if (error !== null) {
+ reject(error);
+ } else {
+ resolve(response);
+ }
+ });
+ } catch (error) {
+ reject(error);
+ }
+ });
+ }
+
+ /**
+ * @param {unknown} message
+ */
+ sendMessageIgnoreResponse(message) {
+ this.sendMessage(message, () => {
+ // Clear the last error
+ this.getLastError();
+ });
+ }
+
+ /**
+ * @returns {?Error}
+ */
+ getLastError() {
+ const {lastError} = chrome.runtime;
+ if (typeof lastError !== 'undefined') {
+ const {message} = lastError;
+ return new Error(typeof message === 'string' ? message : 'An unknown web extension error occured');
+ }
+ return null;
+ }
+
+ /** */
+ triggerUnloaded() {
+ if (this._unloaded) { return; }
+ this._unloaded = true;
+ this.trigger('unloaded', {});
+ }
+}
diff --git a/ext/js/general/cache-map.js b/ext/js/general/cache-map.js
index 8650d8e694..4263210e23 100644
--- a/ext/js/general/cache-map.js
+++ b/ext/js/general/cache-map.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2020-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
diff --git a/ext/js/general/object-property-accessor.js b/ext/js/general/object-property-accessor.js
index ce2417ce7e..d50948d9d3 100644
--- a/ext/js/general/object-property-accessor.js
+++ b/ext/js/general/object-property-accessor.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2016-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
diff --git a/ext/js/general/regex-util.js b/ext/js/general/regex-util.js
index 6601e46341..301b1fcf28 100644
--- a/ext/js/general/regex-util.js
+++ b/ext/js/general/regex-util.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2021-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
diff --git a/ext/js/general/task-accumulator.js b/ext/js/general/task-accumulator.js
index 86cb9e3eec..62f1286997 100644
--- a/ext/js/general/task-accumulator.js
+++ b/ext/js/general/task-accumulator.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2020-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
@@ -16,7 +16,7 @@
* along with this program. If not, see }
*/
- async _findTermsInternalWrapper(text, enabledDictionaryMap, options, tagAggregator) {
+ async _findTermsInternal(text, enabledDictionaryMap, options, tagAggregator) {
if (options.removeNonJapaneseCharacters) {
text = this._getJapaneseOnlyText(text);
}
@@ -216,18 +216,30 @@ export class Translator {
return {dictionaryEntries: [], originalTextLength: 0};
}
- const deinflections = await this._findTermsInternal(text, enabledDictionaryMap, options);
+ const deinflections = await this._getDeinflections(text, enabledDictionaryMap, options);
let originalTextLength = 0;
+ /** @type {import('dictionary').TermDictionaryEntry[]} */
const dictionaryEntries = [];
const ids = new Set();
- for (const {databaseEntries, originalText, transformedText, deinflectedText, reasons} of deinflections) {
+ for (const {databaseEntries, originalText, transformedText, deinflectedText, inflectionRuleChainCandidates} of deinflections) {
if (databaseEntries.length === 0) { continue; }
originalTextLength = Math.max(originalTextLength, originalText.length);
for (const databaseEntry of databaseEntries) {
const {id} = databaseEntry;
- if (ids.has(id)) { continue; }
- const dictionaryEntry = this._createTermDictionaryEntryFromDatabaseEntry(databaseEntry, originalText, transformedText, deinflectedText, reasons, true, enabledDictionaryMap, tagAggregator);
+ if (ids.has(id)) {
+ const existingEntry = dictionaryEntries.find((entry) => {
+ return entry.definitions.some((definition) => definition.id === id);
+ });
+
+ if (existingEntry && transformedText.length >= existingEntry.headwords[0].sources[0].transformedText.length) {
+ this._mergeInflectionRuleChains(existingEntry, inflectionRuleChainCandidates);
+ }
+
+ continue;
+ }
+
+ const dictionaryEntry = this._createTermDictionaryEntryFromDatabaseEntry(databaseEntry, originalText, transformedText, deinflectedText, inflectionRuleChainCandidates, true, enabledDictionaryMap, tagAggregator);
dictionaryEntries.push(dictionaryEntry);
ids.add(id);
}
@@ -236,49 +248,173 @@ export class Translator {
return {dictionaryEntries, originalTextLength};
}
+ /**
+ * @param {import('dictionary').TermDictionaryEntry} existingEntry
+ * @param {import('dictionary').InflectionRuleChainCandidate[]} inflectionRuleChainCandidates
+ */
+ _mergeInflectionRuleChains(existingEntry, inflectionRuleChainCandidates) {
+ const existingChains = existingEntry.inflectionRuleChainCandidates;
+
+ for (const {source, inflectionRules} of inflectionRuleChainCandidates) {
+ const duplicate = existingChains.find((existingChain) => this._areArraysEqualIgnoreOrder(existingChain.inflectionRules, inflectionRules));
+ if (!duplicate) {
+ existingEntry.inflectionRuleChainCandidates.push({source, inflectionRules});
+ } else if (duplicate.source !== source) {
+ duplicate.source = 'both';
+ }
+ }
+ }
+
+ /**
+ * @param {string[]} array1
+ * @param {string[]} array2
+ * @returns {boolean}
+ */
+ _areArraysEqualIgnoreOrder(array1, array2) {
+ if (array1.length !== array2.length) {
+ return false;
+ }
+
+ const frequencyCounter = new Map();
+
+ for (const element of array1) {
+ frequencyCounter.set(element, (frequencyCounter.get(element) || 0) + 1);
+ }
+
+ for (const element of array2) {
+ const frequency = frequencyCounter.get(element);
+ if (!frequency) {
+ return false;
+ }
+ frequencyCounter.set(element, frequency - 1);
+ }
+
+ return true;
+ }
+
+
/**
* @param {string} text
* @param {Map} enabledDictionaryMap
* @param {import('translation').FindTermsOptions} options
* @returns {Promise}
*/
- async _findTermsInternal(text, enabledDictionaryMap, options) {
- const deinflections = (
+ async _getDeinflections(text, enabledDictionaryMap, options) {
+ let deinflections = (
options.deinflect ?
- this._getAllDeinflections(text, options) :
+ this._getAlgorithmDeinflections(text, options) :
[this._createDeinflection(text, text, text, 0, [])]
);
if (deinflections.length === 0) { return []; }
- const uniqueDeinflectionTerms = [];
- const uniqueDeinflectionArrays = [];
- const uniqueDeinflectionsMap = new Map();
+ const {matchType} = options;
+
+ await this._addEntriesToDeinflections(deinflections, enabledDictionaryMap, matchType);
+
+ const dictionaryDeinflections = await this._getDictionaryDeinflections(deinflections, enabledDictionaryMap, matchType);
+ deinflections.push(...dictionaryDeinflections);
+
+ for (const deinflection of deinflections) {
+ for (const entry of deinflection.databaseEntries) {
+ entry.definitions = entry.definitions.filter((definition) => !Array.isArray(definition));
+ }
+ deinflection.databaseEntries = deinflection.databaseEntries.filter((entry) => entry.definitions.length);
+ }
+ deinflections = deinflections.filter((deinflection) => deinflection.databaseEntries.length);
+
+ return deinflections;
+ }
+
+ /**
+ * @param {import('translation-internal').DatabaseDeinflection[]} deinflections
+ * @param {Map} enabledDictionaryMap
+ * @param {import('dictionary').TermSourceMatchType} matchType
+ * @returns {Promise}
+ */
+ async _getDictionaryDeinflections(deinflections, enabledDictionaryMap, matchType) {
+ /** @type {import('translation-internal').DatabaseDeinflection[]} */
+ const dictionaryDeinflections = [];
+ for (const deinflection of deinflections) {
+ const {originalText, transformedText, inflectionRuleChainCandidates: algorithmChains, databaseEntries} = deinflection;
+ for (const entry of databaseEntries) {
+ const {dictionary, definitions} = entry;
+ const entryDictionary = enabledDictionaryMap.get(dictionary);
+ const useDeinflections = entryDictionary?.useDeinflections ?? true;
+ if (!useDeinflections) { continue; }
+ for (const definition of definitions) {
+ if (Array.isArray(definition)) {
+ const [formOf, inflectionRules] = definition;
+ if (!formOf) { continue; }
+
+ const inflectionRuleChainCandidates = algorithmChains.map(({inflectionRules: algInflections}) => {
+ return {
+ source: /** @type {import('dictionary').InflectionSource} */ (algInflections.length === 0 ? 'dictionary' : 'both'),
+ inflectionRules: [...algInflections, ...inflectionRules]
+ };
+ });
+
+ const dictionaryDeinflection = this._createDeinflection(originalText, transformedText, formOf, 0, inflectionRuleChainCandidates);
+ dictionaryDeinflections.push(dictionaryDeinflection);
+ }
+ }
+ }
+ }
+
+ await this._addEntriesToDeinflections(dictionaryDeinflections, enabledDictionaryMap, matchType);
+
+ return dictionaryDeinflections;
+ }
+
+ /**
+ * @param {import('translation-internal').DatabaseDeinflection[]} deinflections
+ * @param {Map} enabledDictionaryMap
+ * @param {import('dictionary').TermSourceMatchType} matchType
+ */
+ async _addEntriesToDeinflections(deinflections, enabledDictionaryMap, matchType) {
+ const uniqueDeinflectionsMap = this._groupDeinflectionsByTerm(deinflections);
+ const uniqueDeinflectionArrays = [...uniqueDeinflectionsMap.values()];
+ const uniqueDeinflectionTerms = [...uniqueDeinflectionsMap.keys()];
+
+ const databaseEntries = await this._database.findTermsBulk(uniqueDeinflectionTerms, enabledDictionaryMap, matchType);
+ this._matchEntriesToDeinflections(databaseEntries, uniqueDeinflectionArrays, enabledDictionaryMap);
+ }
+
+ /**
+ * @param {import('translation-internal').DatabaseDeinflection[]} deinflections
+ * @returns {Map}
+ */
+ _groupDeinflectionsByTerm(deinflections) {
+ const result = new Map();
for (const deinflection of deinflections) {
- const term = deinflection.deinflectedText;
- let deinflectionArray = uniqueDeinflectionsMap.get(term);
+ const {deinflectedText} = deinflection;
+ let deinflectionArray = result.get(deinflectedText);
if (typeof deinflectionArray === 'undefined') {
deinflectionArray = [];
- uniqueDeinflectionTerms.push(term);
- uniqueDeinflectionArrays.push(deinflectionArray);
- uniqueDeinflectionsMap.set(term, deinflectionArray);
+ result.set(deinflectedText, deinflectionArray);
}
deinflectionArray.push(deinflection);
}
+ return result;
+ }
- const {matchType} = options;
- const databaseEntries = await this._database.findTermsBulk(uniqueDeinflectionTerms, enabledDictionaryMap, matchType);
-
+ /**
+ * @param {import('dictionary-database').TermEntry[]} databaseEntries
+ * @param {import('translation-internal').DatabaseDeinflection[][]} uniqueDeinflectionArrays
+ * @param {Map} enabledDictionaryMap
+ */
+ _matchEntriesToDeinflections(databaseEntries, uniqueDeinflectionArrays, enabledDictionaryMap) {
for (const databaseEntry of databaseEntries) {
+ const entryDictionary = /** @type {import('translation').FindTermDictionary} */ (enabledDictionaryMap.get(databaseEntry.dictionary));
+ const {partsOfSpeechFilter} = entryDictionary;
+
const definitionRules = Deinflector.rulesToRuleFlags(databaseEntry.rules);
for (const deinflection of uniqueDeinflectionArrays[databaseEntry.index]) {
const deinflectionRules = deinflection.rules;
- if (deinflectionRules === 0 || (definitionRules & deinflectionRules) !== 0) {
+ if (!partsOfSpeechFilter || Deinflector.rulesMatch(deinflectionRules, definitionRules)) {
deinflection.databaseEntries.push(databaseEntry);
}
}
}
-
- return deinflections;
}
// Deinflections and text transformations
@@ -288,7 +424,7 @@ export class Translator {
* @param {import('translation').FindTermsOptions} options
* @returns {import('translation-internal').DatabaseDeinflection[]}
*/
- _getAllDeinflections(text, options) {
+ _getAlgorithmDeinflections(text, options) {
/** @type {import('translation-internal').TextDeinflectionOptionsArrays} */
const textOptionVariantArray = [
this._getTextReplacementsVariants(options),
@@ -339,7 +475,12 @@ export class Translator {
used.add(source);
const rawSource = sourceMap.source.substring(0, sourceMap.getSourceLength(i));
for (const {term, rules, reasons} of /** @type {Deinflector} */ (this._deinflector).deinflect(source)) {
- deinflections.push(this._createDeinflection(rawSource, source, term, rules, reasons));
+ /** @type {import('dictionary').InflectionRuleChainCandidate} */
+ const inflectionRuleChainCandidate = {
+ source: 'algorithm',
+ inflectionRules: reasons
+ };
+ deinflections.push(this._createDeinflection(rawSource, source, term, rules, [inflectionRuleChainCandidate]));
}
}
}
@@ -432,11 +573,11 @@ export class Translator {
* @param {string} transformedText
* @param {string} deinflectedText
* @param {import('translation-internal').DeinflectionRuleFlags} rules
- * @param {string[]} reasons
+ * @param {import('dictionary').InflectionRuleChainCandidate[]} inflectionRuleChainCandidates
* @returns {import('translation-internal').DatabaseDeinflection}
*/
- _createDeinflection(originalText, transformedText, deinflectedText, rules, reasons) {
- return {originalText, transformedText, deinflectedText, rules, reasons, databaseEntries: []};
+ _createDeinflection(originalText, transformedText, deinflectedText, rules, inflectionRuleChainCandidates) {
+ return {originalText, transformedText, deinflectedText, rules, inflectionRuleChainCandidates, databaseEntries: []};
}
// Term dictionary entry grouping
@@ -594,8 +735,8 @@ export class Translator {
_groupDictionaryEntriesByHeadword(dictionaryEntries, tagAggregator) {
const groups = new Map();
for (const dictionaryEntry of dictionaryEntries) {
- const {inflections, headwords: [{term, reading}]} = dictionaryEntry;
- const key = this._createMapKey([term, reading, ...inflections]);
+ const {inflectionRuleChainCandidates, headwords: [{term, reading}]} = dictionaryEntry;
+ const key = this._createMapKey([term, reading, ...inflectionRuleChainCandidates]);
let groupDictionaryEntries = groups.get(key);
if (typeof groupDictionaryEntries === 'undefined') {
groupDictionaryEntries = [];
@@ -1367,7 +1508,7 @@ export class Translator {
* @param {number[]} sequences
* @param {boolean} isPrimary
* @param {import('dictionary').Tag[]} tags
- * @param {import('dictionary-data').TermGlossary[]} entries
+ * @param {import('dictionary-data').TermGlossaryContent[]} entries
* @returns {import('dictionary').TermDefinition}
*/
_createTermDefinition(index, headwordIndices, dictionary, dictionaryIndex, dictionaryPriority, id, score, sequences, isPrimary, tags, entries) {
@@ -1418,7 +1559,7 @@ export class Translator {
/**
* @param {boolean} isPrimary
- * @param {string[]} inflections
+ * @param {import('dictionary').InflectionRuleChainCandidate[]} inflectionRuleChainCandidates
* @param {number} score
* @param {number} dictionaryIndex
* @param {number} dictionaryPriority
@@ -1428,11 +1569,11 @@ export class Translator {
* @param {import('dictionary').TermDefinition[]} definitions
* @returns {import('dictionary').TermDictionaryEntry}
*/
- _createTermDictionaryEntry(isPrimary, inflections, score, dictionaryIndex, dictionaryPriority, sourceTermExactMatchCount, maxTransformedTextLength, headwords, definitions) {
+ _createTermDictionaryEntry(isPrimary, inflectionRuleChainCandidates, score, dictionaryIndex, dictionaryPriority, sourceTermExactMatchCount, maxTransformedTextLength, headwords, definitions) {
return {
type: 'term',
isPrimary,
- inflections,
+ inflectionRuleChainCandidates,
score,
frequencyOrder: 0,
dictionaryIndex,
@@ -1451,14 +1592,29 @@ export class Translator {
* @param {string} originalText
* @param {string} transformedText
* @param {string} deinflectedText
- * @param {string[]} reasons
+ * @param {import('dictionary').InflectionRuleChainCandidate[]} inflectionRuleChainCandidates
* @param {boolean} isPrimary
* @param {Map} enabledDictionaryMap
* @param {TranslatorTagAggregator} tagAggregator
* @returns {import('dictionary').TermDictionaryEntry}
*/
- _createTermDictionaryEntryFromDatabaseEntry(databaseEntry, originalText, transformedText, deinflectedText, reasons, isPrimary, enabledDictionaryMap, tagAggregator) {
- const {matchType, matchSource, term, reading: rawReading, definitionTags, termTags, definitions, score, dictionary, id, sequence: rawSequence, rules} = databaseEntry;
+ _createTermDictionaryEntryFromDatabaseEntry(databaseEntry, originalText, transformedText, deinflectedText, inflectionRuleChainCandidates, isPrimary, enabledDictionaryMap, tagAggregator) {
+ const {
+ matchType,
+ matchSource,
+ term,
+ reading: rawReading,
+ definitionTags,
+ termTags,
+ definitions,
+ score,
+ dictionary,
+ id,
+ sequence: rawSequence,
+ rules
+ } = databaseEntry;
+ // cast is safe because getDeinflections filters out deinflection definitions
+ const contentDefinitions = /** @type {import('dictionary-data').TermGlossaryContent[]} */ (definitions);
const reading = (rawReading.length > 0 ? rawReading : term);
const {index: dictionaryIndex, priority: dictionaryPriority} = this._getDictionaryOrder(dictionary, enabledDictionaryMap);
const sourceTermExactMatchCount = (isPrimary && deinflectedText === term ? 1 : 0);
@@ -1476,14 +1632,14 @@ export class Translator {
return this._createTermDictionaryEntry(
isPrimary,
- reasons,
+ inflectionRuleChainCandidates,
score,
dictionaryIndex,
dictionaryPriority,
sourceTermExactMatchCount,
maxTransformedTextLength,
[this._createTermHeadword(0, term, reading, [source], headwordTagGroups, rules)],
- [this._createTermDefinition(0, [0], dictionary, dictionaryIndex, dictionaryPriority, id, score, [sequence], isPrimary, definitionTagGroups, definitions)]
+ [this._createTermDefinition(0, [0], dictionary, dictionaryIndex, dictionaryPriority, id, score, [sequence], isPrimary, definitionTagGroups, contentDefinitions)]
);
}
@@ -1527,7 +1683,7 @@ export class Translator {
if (dictionaryEntry.isPrimary) {
isPrimary = true;
maxTransformedTextLength = Math.max(maxTransformedTextLength, dictionaryEntry.maxTransformedTextLength);
- const dictionaryEntryInflections = dictionaryEntry.inflections;
+ const dictionaryEntryInflections = dictionaryEntry.inflectionRuleChainCandidates;
if (inflections === null || dictionaryEntryInflections.length < inflections.length) {
inflections = dictionaryEntryInflections;
}
@@ -1739,7 +1895,7 @@ export class Translator {
if (i !== 0) { return i; }
// Sort by the number of inflection reasons
- i = v1.inflections.length - v2.inflections.length;
+ i = v1.inflectionRuleChainCandidates.length - v2.inflectionRuleChainCandidates.length;
if (i !== 0) { return i; }
// Sort by how many terms exactly match the source (e.g. for exact kana prioritization)
diff --git a/ext/js/media/audio-downloader.js b/ext/js/media/audio-downloader.js
index 4e602f8c28..3a3b21d0b7 100644
--- a/ext/js/media/audio-downloader.js
+++ b/ext/js/media/audio-downloader.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2017-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
diff --git a/ext/js/media/audio-system.js b/ext/js/media/audio-system.js
index c311b96cde..3d861d356a 100644
--- a/ext/js/media/audio-system.js
+++ b/ext/js/media/audio-system.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2019-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
@@ -16,7 +16,7 @@
* along with this program. If not, see } */
this._storageUseFiniteNodes = null;
/** @type {?NodeListOf} */
+ this._storageUseExhaustWarnNodes = null;
+ /** @type {?NodeListOf} */
this._storageUseInfiniteNodes = null;
/** @type {?NodeListOf} */
this._storageUseValidNodes = null;
@@ -51,6 +53,7 @@ export class StorageController {
this._storageUsageNodes = /** @type {NodeListOf} */ (document.querySelectorAll('.storage-usage'));
this._storageQuotaNodes = /** @type {NodeListOf} */ (document.querySelectorAll('.storage-quota'));
this._storageUseFiniteNodes = /** @type {NodeListOf} */ (document.querySelectorAll('.storage-use-finite'));
+ this._storageUseExhaustWarnNodes = /** @type {NodeListOf} */ (document.querySelectorAll('.storage-exhaustion-alert'));
this._storageUseInfiniteNodes = /** @type {NodeListOf} */ (document.querySelectorAll('.storage-use-infinite'));
this._storageUseValidNodes = /** @type {NodeListOf} */ (document.querySelectorAll('.storage-use-valid'));
this._storageUseInvalidNodes = /** @type {NodeListOf} */ (document.querySelectorAll('.storage-use-invalid'));
@@ -84,13 +87,19 @@ export class StorageController {
const estimate = await this._storageEstimate();
const valid = (estimate !== null);
+ let storageIsLow = false;
// Firefox reports usage as 0 when persistent storage is enabled.
const finite = valid && ((typeof estimate.usage === 'number' && estimate.usage > 0) || !(await this._persistentStorageController.isStoragePeristent()));
if (finite) {
let {usage, quota} = estimate;
+
if (typeof usage !== 'number') { usage = 0; }
- if (typeof quota !== 'number') { quota = 0; }
+ if (typeof quota !== 'number') {
+ quota = 0;
+ } else {
+ storageIsLow = quota <= (3 * 1000000000);
+ }
const usageString = this._bytesToLabeledString(usage);
const quotaString = this._bytesToLabeledString(quota);
for (const node of /** @type {NodeListOf} */ (this._storageUsageNodes)) {
@@ -105,6 +114,7 @@ export class StorageController {
this._setElementsVisible(this._storageUseInfiniteNodes, valid && !finite);
this._setElementsVisible(this._storageUseValidNodes, valid);
this._setElementsVisible(this._storageUseInvalidNodes, !valid);
+ this._setElementsVisible(this._storageUseExhaustWarnNodes, storageIsLow);
} finally {
this._isUpdating = false;
}
diff --git a/ext/js/pages/settings/translation-text-replacements-controller.js b/ext/js/pages/settings/translation-text-replacements-controller.js
index 9f3fda009e..98a1602687 100644
--- a/ext/js/pages/settings/translation-text-replacements-controller.js
+++ b/ext/js/pages/settings/translation-text-replacements-controller.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2021-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
@@ -16,7 +16,7 @@
* along with this program. If not, see } */
+ /**
+ * Usage:
+ * ```{{#regexReplace regex string [flags] [content]...}}content{{/regexReplace}}```
+ * - regex: regular expression string
+ * - string: string to replace
+ * - flags: optional flags for regular expression.
+ * e.g. "i" for case-insensitive, "g" for replace all
+ * @type {import('template-renderer').HelperFunction}
+ */
_regexReplace(args, context, options) {
- // Usage:
- // {{#regexReplace regex string [flags] [content]...}}content{{/regexReplace}}
- // regex: regular expression string
- // string: string to replace
- // flags: optional flags for regular expression
- // e.g. "i" for case-insensitive, "g" for replace all
const argCount = args.length;
let value = this._computeValueString(options, context);
if (argCount > 3) {
- value = `${args.slice(3, -1).join('')}${value}`;
+ value = `${args.slice(3).join('')}${value}`;
}
if (argCount > 1) {
try {
@@ -262,17 +264,19 @@ export class AnkiTemplateRenderer {
return value;
}
- /** @type {import('template-renderer').HelperFunction} */
+ /**
+ * Usage:
+ * {{#regexMatch regex [flags] [content]...}}content{{/regexMatch}}
+ * - regex: regular expression string
+ * - flags: optional flags for regular expression
+ * e.g. "i" for case-insensitive, "g" for match all
+ * @type {import('template-renderer').HelperFunction}
+ */
_regexMatch(args, context, options) {
- // Usage:
- // {{#regexMatch regex [flags] [content]...}}content{{/regexMatch}}
- // regex: regular expression string
- // flags: optional flags for regular expression
- // e.g. "i" for case-insensitive, "g" for match all
const argCount = args.length;
let value = this._computeValueString(options, context);
if (argCount > 2) {
- value = `${args.slice(2, -1).join('')}${value}`;
+ value = `${args.slice(2).join('')}${value}`;
}
if (argCount > 0) {
try {
@@ -671,7 +675,7 @@ export class AnkiTemplateRenderer {
* @type {import('template-renderer').HelperFunction}
*/
_formatGlossary(args, _context, options) {
- const [dictionary, content] = /** @type {[dictionary: string, content: import('dictionary-data').TermGlossary]} */ (args);
+ const [dictionary, content] = /** @type {[dictionary: string, content: import('dictionary-data').TermGlossaryContent]} */ (args);
const data = options.data.root;
if (typeof content === 'string') { return this._stringToMultiLineHtml(this._escape(content)); }
if (!(typeof content === 'object' && content !== null)) { return ''; }
diff --git a/ext/js/templates/sandbox/template-renderer-frame-api.js b/ext/js/templates/sandbox/template-renderer-frame-api.js
index 28303e513c..a0017d7072 100644
--- a/ext/js/templates/sandbox/template-renderer-frame-api.js
+++ b/ext/js/templates/sandbox/template-renderer-frame-api.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2020-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
diff --git a/ext/js/templates/sandbox/template-renderer-frame-main.js b/ext/js/templates/sandbox/template-renderer-frame-main.js
index f5868aff40..4ab7d2bcbd 100644
--- a/ext/js/templates/sandbox/template-renderer-frame-main.js
+++ b/ext/js/templates/sandbox/template-renderer-frame-main.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2020-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
diff --git a/ext/js/templates/sandbox/template-renderer-media-provider.js b/ext/js/templates/sandbox/template-renderer-media-provider.js
index 0a7f5d9b15..29dd29aec5 100644
--- a/ext/js/templates/sandbox/template-renderer-media-provider.js
+++ b/ext/js/templates/sandbox/template-renderer-media-provider.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2021-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
diff --git a/ext/js/templates/sandbox/template-renderer.js b/ext/js/templates/sandbox/template-renderer.js
index 239240b6bb..90fb63f306 100644
--- a/ext/js/templates/sandbox/template-renderer.js
+++ b/ext/js/templates/sandbox/template-renderer.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2016-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
diff --git a/ext/js/templates/template-patcher.js b/ext/js/templates/template-patcher.js
index 33abb08e9e..77f55aea94 100644
--- a/ext/js/templates/template-patcher.js
+++ b/ext/js/templates/template-patcher.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2021-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
diff --git a/ext/js/templates/template-renderer-proxy.js b/ext/js/templates/template-renderer-proxy.js
index 25fe8fb1f5..e4814ec4a5 100644
--- a/ext/js/templates/template-renderer-proxy.js
+++ b/ext/js/templates/template-renderer-proxy.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2020-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
@@ -16,7 +16,7 @@
* along with this program. If not, see } */ (deferPromise());
@@ -108,6 +110,11 @@ export class Yomitan extends EventDispatcher {
/* eslint-enable no-multi-spaces */
}
+ /** @type {WebExtension} */
+ get webExtension() {
+ return this._webExtension;
+ }
+
/**
* Whether the current frame is the background page/service worker or not.
* @type {boolean}
@@ -117,14 +124,6 @@ export class Yomitan extends EventDispatcher {
return /** @type {boolean} */ (this._isBackground);
}
- /**
- * Whether or not the extension is unloaded.
- * @type {boolean}
- */
- get isExtensionUnloaded() {
- return this._isExtensionUnloaded;
- }
-
/**
* Gets the API instance for communicating with the backend.
* This value will be null on the background page/service worker.
@@ -154,9 +153,9 @@ export class Yomitan extends EventDispatcher {
chrome.runtime.onMessage.addListener(this._onMessage.bind(this));
if (!isBackground) {
- this._api = new API(this);
+ this._api = new API(this._webExtension);
- this.sendMessage({action: 'requestBackendReadySignal'});
+ await this._webExtension.sendMessagePromise({action: 'requestBackendReadySignal'});
await this._isBackendReadyPromise;
this._crossFrame = new CrossFrameAPI();
@@ -172,7 +171,7 @@ export class Yomitan extends EventDispatcher {
*/
ready() {
this._isReady = true;
- this.sendMessage({action: 'applicationReady'});
+ this._webExtension.sendMessagePromise({action: 'applicationReady'});
}
/**
@@ -184,36 +183,6 @@ export class Yomitan extends EventDispatcher {
return this._extensionUrlBase !== null && url.startsWith(this._extensionUrlBase);
}
- // TODO : this function needs type safety
- /**
- * Runs `chrome.runtime.sendMessage()` with additional exception handling events.
- * @param {import('extension').ChromeRuntimeSendMessageArgs} args The arguments to be passed to `chrome.runtime.sendMessage()`.
- * @throws {Error} Errors thrown by `chrome.runtime.sendMessage()` are re-thrown.
- */
- sendMessage(...args) {
- try {
- // @ts-expect-error - issue with type conversion, somewhat difficult to resolve in pure JS
- chrome.runtime.sendMessage(...args);
- } catch (e) {
- this.triggerExtensionUnloaded();
- throw e;
- }
- }
-
- /**
- * Triggers the extensionUnloaded event.
- */
- triggerExtensionUnloaded() {
- this._isExtensionUnloaded = true;
- if (this._isTriggeringExtensionUnloaded) { return; }
- try {
- this._isTriggeringExtensionUnloaded = true;
- this.trigger('extensionUnloaded', {});
- } finally {
- this._isTriggeringExtensionUnloaded = false;
- }
- }
-
/** */
triggerStorageChanged() {
this.trigger('storageChanged', {});
diff --git a/ext/legal.html b/ext/legal.html
index 94912c7ea8..bc58ed5a9a 100644
--- a/ext/legal.html
+++ b/ext/legal.html
@@ -35,7 +35,7 @@
+
+
@@ -366,6 +366,24 @@
+ Yomitan License
-Copyright (C) 2023 Yomitan Authors +Copyright (C) 2023-2024 Yomitan Authors Copyright (C) 2016-2022 Yomichan Authors This program is free software: you can redistribute it and/or modify diff --git a/ext/settings.html b/ext/settings.html index 8f432eb45f..38cbf6f658 100644 --- a/ext/settings.html +++ b/ext/settings.html @@ -140,6 +140,12 @@Yomitan Settings
Yomitan is using approximately ? of ?. ++Yomitan is permitted unlimited storage. @@ -2673,6 +2679,42 @@+ Your system is running low on storage space.+
+ Importing dictionaries may fail. +Yomitan Settings
+
+
+
+
+
+
+ Part of speech filtering
+ (?)
+
+
+
+
+
+ When deinflecting words, only dictionary entries whose POS matches that expected by the deinflector will be shown.
+
+
+ +
+
+
+
+
+
+
+ Use deinflections
+ (?)
+
+
+
+
+
+ Deinflections from this dictionary will be used.
+
+
+
diff --git a/ext/sw.js b/ext/sw.js
index 981fb17fc3..31acd2175c 100644
--- a/ext/sw.js
+++ b/ext/sw.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan 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
diff --git a/ext/welcome.html b/ext/welcome.html
index 406398819a..60aae31966 100644
--- a/ext/welcome.html
+++ b/ext/welcome.html
@@ -202,7 +202,7 @@
Basic customization
Basic customization
+
+
+
+
+
+
+ Part of speech filtering
+ (?)
+
+
+
+
+
+ When deinflecting words, only dictionary entries whose POS matches that expected by the deinflector will be shown.
+
+
+
diff --git a/package-lock.json b/package-lock.json
index ab97d37404..c181804797 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -5868,9 +5868,9 @@
"dev": true
},
"node_modules/vite": {
- "version": "5.0.10",
- "resolved": "https://registry.npmjs.org/vite/-/vite-5.0.10.tgz",
- "integrity": "sha512-2P8J7WWgmc355HUMlFrwofacvr98DAjoE52BfdbwQtyLH06XKwaL/FMnmKM2crF0iX4MpmMKoDlNCB1ok7zHCw==",
+ "version": "5.0.12",
+ "resolved": "https://registry.npmjs.org/vite/-/vite-5.0.12.tgz",
+ "integrity": "sha512-4hsnEkG3q0N4Tzf1+t6NdN9dg/L3BM+q8SWgbSPnJvrgH2kgdyzfVJwbR1ic69/4uMJJ/3dqDZZE5/WwqW8U1w==",
"dev": true,
"dependencies": {
"esbuild": "^0.19.3",
@@ -10364,9 +10364,9 @@
"dev": true
},
"vite": {
- "version": "5.0.10",
- "resolved": "https://registry.npmjs.org/vite/-/vite-5.0.10.tgz",
- "integrity": "sha512-2P8J7WWgmc355HUMlFrwofacvr98DAjoE52BfdbwQtyLH06XKwaL/FMnmKM2crF0iX4MpmMKoDlNCB1ok7zHCw==",
+ "version": "5.0.12",
+ "resolved": "https://registry.npmjs.org/vite/-/vite-5.0.12.tgz",
+ "integrity": "sha512-4hsnEkG3q0N4Tzf1+t6NdN9dg/L3BM+q8SWgbSPnJvrgH2kgdyzfVJwbR1ic69/4uMJJ/3dqDZZE5/WwqW8U1w==",
"dev": true,
"requires": {
"esbuild": "^0.19.3",
diff --git a/playwright.config.js b/playwright.config.js
index 6bf645c4d1..4658ceb2df 100644
--- a/playwright.config.js
+++ b/playwright.config.js
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2023 Yomitan Authors
+ * Copyright (C) 2023-2024 Yomitan 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
diff --git a/test/anki-template-renderer.test.js b/test/anki-template-renderer.test.js
new file mode 100644
index 0000000000..d8d2a3b5c0
--- /dev/null
+++ b/test/anki-template-renderer.test.js
@@ -0,0 +1,94 @@
+/*
+ * Copyright (C) 2023-2024 Yomitan 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
(v5, Test Dictionary 2) notamau definition
",
+ "glossary-brief": "notamau definition
",
+ "glossary-no-dictionary": "(v5) notamau definition
",
+ "part-of-speech": "Godan verb",
+ "pitch-accents": "No pitch accent data",
+ "pitch-accent-graphs": "No pitch accent data",
+ "pitch-accent-positions": "No pitch accent data",
+ "phonetic-transcriptions": "",
+ "reading": "のたまう",
+ "screenshot": "",
+ "search-query": "fullQuery",
+ "selection-text": "",
+ "sentence": "cloze-prefixのたもうたcloze-suffix",
+ "sentence-furigana": "cloze-prefixのたもうたcloze-suffix",
+ "tags": "v5",
+ "url": "url:"
+ }
+ ]
}
]
\ No newline at end of file
diff --git a/test/data/database-test-cases.json b/test/data/database-test-cases.json
index 02fddd4931..611903dd85 100644
--- a/test/data/database-test-cases.json
+++ b/test/data/database-test-cases.json
@@ -27,7 +27,7 @@
"ipa": 1
},
"terms": {
- "total": 23
+ "total": 25
}
}
},
@@ -36,7 +36,7 @@
{
"kanji": 2,
"kanjiMeta": 6,
- "terms": 23,
+ "terms": 25,
"termMeta": 39,
"tagMeta": 15,
"media": 6
@@ -45,7 +45,7 @@
"total": {
"kanji": 2,
"kanjiMeta": 6,
- "terms": 23,
+ "terms": 25,
"termMeta": 39,
"tagMeta": 15,
"media": 6
diff --git a/test/data/dictionaries/valid-dictionary1/term_bank_1.json b/test/data/dictionaries/valid-dictionary1/term_bank_1.json
index ce4290bdff..7f2af6ddc9 100644
--- a/test/data/dictionaries/valid-dictionary1/term_bank_1.json
+++ b/test/data/dictionaries/valid-dictionary1/term_bank_1.json
@@ -337,5 +337,7 @@
{"type": "structured-content", "content": "kouzou definition 3 (構造)"}
],
101, "P E1"
- ]
+ ],
+ ["のたまう", "のたまう", "v5", "v5", 1, ["notamau definition"], 15, ""],
+ ["のたもうた", "のたもうた", "", "", 1, [["のたまう", ["past"]]], 16, ""]
]
\ No newline at end of file
diff --git a/test/data/dictionaries/valid-dictionary1/term_bank_2.json b/test/data/dictionaries/valid-dictionary1/term_bank_2.json
index d46b4c144a..30e5418c09 100644
--- a/test/data/dictionaries/valid-dictionary1/term_bank_2.json
+++ b/test/data/dictionaries/valid-dictionary1/term_bank_2.json
@@ -103,6 +103,8 @@
{
"tag": "span",
"style": {
+ "color": "#dd2121",
+ "textShadow": "0.5px 0.5px 1px gray",
"textDecorationLine": "underline",
"textDecorationStyle": "wavy",
"textDecorationColor": "red"
diff --git a/test/data/html/dom-text-scanner.html b/test/data/html/dom-text-scanner.html
index ff4d0493fa..1f537d4e3b 100644
--- a/test/data/html/dom-text-scanner.html
+++ b/test/data/html/dom-text-scanner.html
@@ -392,4 +392,4 @@