renun/koreader
1
0
Fork 0
mirror of https://github.com/koreader/koreader.git synced 2025-08-10 00:52:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Clarify our OOP semantics across the codebase (#9586)

Browse Source 
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.
This commit is contained in:
NiLuJe
2022-10-06 02:14:48 +02:00
committed by GitHub
parent 7b9f02e1ac
commit fadee1f5dc
223 changed files with 849 additions and 985 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
frontend/ui/widget/focusmanager.lua
View File

@@ -26,13 +26,17 @@ to not get stuck in an invalid position.
but notice that this does _not_ do the layout for you,
it rather defines an abstract layout.
]]
local FocusManager = InputContainer:new{
local FocusManager = InputContainer:extend{
selected = nil, -- defaults to x=1, y=1
layout = nil, -- mandatory
movement_allowed = { x = true, y = true },
}
function FocusManager:init()
-- Only build the default mappings once, we'll make copies during instantiation.
local KEY_EVENTS = {}
local BUILTIN_KEY_EVENTS = {}
local EXTRA_KEY_EVENTS = {}
do
if Device:hasDPad() then
local event_keys = {}
-- these will all generate the same event, just with different arguments
@@ -57,19 +61,16 @@ function FocusManager:init()
table.insert(event_keys, {"FocusNext", { {"Tab"}, doc = "move focus to next widget", event="FocusNext"} })
table.insert(event_keys, {"FocusPrevious", { {"Shift", "Tab"}, doc = "move focus to previous widget", event="FocusPrevious"} })
self.key_events = {}
self.builtin_key_events = {}
self.extra_key_events = {}
for i = 1, FEW_KEYS_END_INDEX do
local key_name = event_keys[i][1]
self.key_events[key_name] = event_keys[i][2]
self.builtin_key_events[key_name] = event_keys[i][2]
KEY_EVENTS[key_name] = event_keys[i][2]
BUILTIN_KEY_EVENTS[key_name] = event_keys[i][2]
end
if not Device:hasFewKeys() then
for i = FEW_KEYS_END_INDEX+1, NORMAL_KEYS_END_INDEX do
local key_name = event_keys[i][1]
self.key_events[key_name] = event_keys[i][2]
self.builtin_key_events[key_name] = event_keys[i][2]
KEY_EVENTS[key_name] = event_keys[i][2]
BUILTIN_KEY_EVENTS[key_name] = event_keys[i][2]
end
local focus_manager_setting = G_reader_settings:child("focus_manager")
-- Enable advanced feature, like Hold, FocusNext, FocusPrevious
@@ -83,8 +84,8 @@ function FocusManager:init()
local handler_defition = util.tableDeepCopy(event_keys[i][2])
handler_defition[1] = alternative_keymap -- replace sample key combinations
local new_event_key = "Alternative" .. key_name
self.key_events[new_event_key] = handler_defition
self.extra_key_events[new_event_key] = handler_defition
KEY_EVENTS[new_event_key] = handler_defition
EXTRA_KEY_EVENTS[new_event_key] = handler_defition
end
end
end
@@ -92,21 +93,21 @@ function FocusManager:init()
end
end
function FocusManager:_init()
InputContainer._init(self)
-- Make sure each FocusManager instance has its own selection field.
-- Take ButtonTable = FocusManager:new{} for example.
-- FocusManager:init method called once and all ButtonTable instances share same selected field.
-- It has problem when
-- 1. ButtonTable A (layout 1 row, 4 columns) shown, and move focus, make selected to (4, 1)
-- 2. ButtonTable A closed and ButtonTable B (layout 2 rows, 2 columns) shown
-- 3. selected (4, 1) is invalid(overflow) for ButtonTable B, and FocusManager ignore all focus move events.
-- These *need* to be instance-specific, hence the copy
if not self.selected then
self.selected = { x = 1, y = 1 }
else
self.selected = {x = self.selected.x, y = self.selected.y }
end
-- Ditto, as each widget may choose their own custom key bindings
self.key_events = util.tableDeepCopy(KEY_EVENTS)
-- We should be fine with a simple ref for those, though
self.builtin_key_events = BUILTIN_KEY_EVENTS
self.extra_key_events = EXTRA_KEY_EVENTS
end
function FocusManager:isAlternativeKey(key)