2
0
mirror of https://github.com/koreader/koreader synced 2024-11-06 09:20:32 +00:00
koreader/plugins/japanese.koplugin
NiLuJe fadee1f5dc
Clarify our OOP semantics across the codebase (#9586)
Basically:

* Use `extend` for class definitions
* Use `new` for object instantiations

That includes some minor code cleanups along the way:

* Updated `Widget`'s docs to make the semantics clearer.
* Removed `should_restrict_JIT` (it's been dead code since https://github.com/koreader/android-luajit-launcher/pull/283)
* Minor refactoring of LuaSettings/LuaData/LuaDefaults/DocSettings to behave (mostly, they are instantiated via `open` instead of `new`) like everything else and handle inheritance properly (i.e., DocSettings is now a proper LuaSettings subclass).
* Default to `WidgetContainer` instead of `InputContainer` for stuff that doesn't actually setup key/gesture events.
* Ditto for explicit `*Listener` only classes, make sure they're based on `EventListener` instead of something uselessly fancier.
* Unless absolutely necessary, do not store references in class objects, ever; only values. Instead, always store references in instances, to avoid both sneaky inheritance issues, and sneaky GC pinning of stale references.
  * ReaderUI: Fix one such issue with its `active_widgets` array, with critical implications, as it essentially pinned *all* of ReaderUI's modules, including their reference to the `Document` instance (i.e., that was a big-ass leak).
* Terminal: Make sure the shell is killed on plugin teardown.
* InputText: Fix Home/End/Del physical keys to behave sensibly.
* InputContainer/WidgetContainer: If necessary, compute self.dimen at paintTo time (previously, only InputContainers did, which might have had something to do with random widgets unconcerned about input using it as a baseclass instead of WidgetContainer...).
* OverlapGroup: Compute self.dimen at *init* time, because for some reason it needs to do that, but do it directly in OverlapGroup instead of going through a weird WidgetContainer method that it was the sole user of.
* ReaderCropping: Under no circumstances should a Document instance member (here, self.bbox) risk being `nil`ed!
* Kobo: Minor code cleanups.
2022-10-06 02:14:48 +02:00
..
_meta.lua plugins: add Japanese Support plugin 2021-10-23 15:49:54 +02:00
deinflector.lua Minor Lua I/O cleanups (#8921) 2022-03-19 23:57:31 +01:00
main.lua Clarify our OOP semantics across the codebase (#9586) 2022-10-06 02:14:48 +02:00
README.md plugins: add Japanese Support plugin 2021-10-23 15:49:54 +02:00
yomichan-deinflect.json plugins: add Japanese Support plugin 2021-10-23 15:49:54 +02:00

Japanese Support Plugin for KOReader

This plugin is heavily based on Yomichan's design, and makes use of Yomichan's deinflection data, but was written specifically for KOReader. There are two major features implemented by this plugin:

  1. Verb deinflection (aka deconjugation) support, based on Yomichan's very elegant rule-matching suffix replacement system using Yomichan's data.

  2. Text segmentation support without needing MeCab or any other binary helper, by re-using the users' installed dictionaries to exhaustively try every length of text and select the longest match which is present in the dictionary. This is similar to how Yomichan does MeCab-less segmentation.

    On paper this plugin should also be work with Chinese text if the user has Chinese dictionaries installed, though that is not its primary intended use-case.

The backbone of this plugin is the included yomichan-deinflect.json. This file is copied verbatim from Yomichan's ext/data/deinflect.json and can be updated when necessary by simply getting a newer copy.

Note that Yomichan and KOReader use the same license (GPL-3.0-or-later) so any theoretical licensing problems are a non-issue.