Archives
/
koreader
mirror of https://github.com/koreader/koreader
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Footer: tweak auto refresh code

Browse Source 
Make it similar to how it's been done recently for CRe
alt status bar, avoiding scheduling when not needed.
reviewable/pr7226/r1
poire-z 3 years ago
parent 062bb68335
commit a192a335f1
2 changed files with 78 additions and 56 deletions
Show Stats Download Patch File Download Diff File

99
frontend/apps/reader/modules/readerfooter.lua
Unescape Escape View File

@ -563,9 +563,6 @@ function ReaderFooter:init()
else
self:applyFooterMode()
end
if self.settings.auto_refresh_time then
self:setupAutoRefreshTime()
end
self.visibility_change = nil
end
@ -644,27 +641,57 @@ function ReaderFooter:updateFooterContainer()
self[1] = self.footer_positioner
end
function ReaderFooter:setupAutoRefreshTime()
if not self.autoRefreshTime then
self.autoRefreshTime = function()
function ReaderFooter:unscheduleFooterAutoRefresh()
if not self.autoRefreshFooter then return end -- not yet set up
UIManager:unschedule(self.autoRefreshFooter)
logger.dbg("ReaderFooter.autoRefreshFooter unscheduled")
end
function ReaderFooter:rescheduleFooterAutoRefreshIfNeeded()
if not self.autoRefreshFooter then
-- Create this function the first time we're called
self.autoRefreshFooter = function()
-- Only actually repaint the footer if nothing's being shown over ReaderUI (#6616)
-- (We want to avoid the footer to be painted over a widget covering it - we would
-- be fine refreshing it if the widget is not covering it, but this is hard to
-- guess from here.)
if UIManager:getTopWidget() == "ReaderUI" then
-- And that only if it's actually visible
if self.view.footer_visible then
self:onUpdateFooter(true)
end
self:onUpdateFooter(self.view.footer_visible)
else
logger.dbg("Skipping ReaderFooter repaint, because ReaderUI is not the top-level widget")
-- NOTE: We *do* keep its content up-to-date, though
self:onUpdateFooter()
end
UIManager:scheduleIn(61 - tonumber(os.date("%S")), self.autoRefreshTime)
self:rescheduleFooterAutoRefreshIfNeeded() -- schedule (or not) next refresh
end
end
local unscheduled = UIManager:unschedule(self.autoRefreshFooter) -- unschedule if already scheduled
-- Only schedule an update if the footer has items that may change
-- As self.view.footer_visible may be temporarily toggled off by other modules,
-- we can't trust it for not scheduling auto refresh
local schedule = false
if self.settings.auto_refresh_time then
if self.settings.all_at_once then
if self.settings.time or self.settings.battery or self.settings.wifi_status or self.settings.mem_usage then
schedule = true
end
else
if self.mode == self.mode_list.time or self.mode == self.mode_list.battery
or self.mode == self.mode_list.wifi_status or self.mode == self.mode_list.mem_usage then
schedule = true
end
end
end
self.onCloseDocument = function()
UIManager:unschedule(self.autoRefreshTime)
if schedule then
UIManager:scheduleIn(61 - tonumber(os.date("%S")), self.autoRefreshFooter)
if not unscheduled then
logger.dbg("ReaderFooter.autoRefreshFooter scheduled")
else
logger.dbg("ReaderFooter.autoRefreshFooter rescheduled")
end
elseif unscheduled then
logger.dbg("ReaderFooter.autoRefreshFooter unscheduled")
end
UIManager:scheduleIn(61 - tonumber(os.date("%S")), self.autoRefreshTime)
end
function ReaderFooter:setupTouchZones()
@ -753,7 +780,6 @@ end
function ReaderFooter:disableFooter()
self.onReaderReady = function() end
self.resetLayout = function() end
self.onCloseDocument = nil
self.updateFooterPage = function() end
self.updateFooterPos = function() end
self.onUpdatePos = function() end
@ -926,6 +952,8 @@ function ReaderFooter:addToMainMenu(menu_items)
if should_update or should_signal then
self:refreshFooter(should_update, should_signal)
end
-- The absence or presence of some items may change whether auto-refresh should be ensured
self:rescheduleFooterAutoRefreshIfNeeded()
end,
}
end
@ -961,21 +989,14 @@ function ReaderFooter:addToMainMenu(menu_items)
getMinibarOption("all_at_once", self.updateFooterTextGenerator),
getMinibarOption("reclaim_height"),
{
text = _("Auto refresh time"),
text = _("Auto refresh"),
checked_func = function()
return self.settings.auto_refresh_time == true
end,
-- only enable auto refresh when time is shown
enabled_func = function() return self.settings.time end,
callback = function()
self.settings.auto_refresh_time = not self.settings.auto_refresh_time
G_reader_settings:saveSetting("footer", self.settings)
if self.settings.auto_refresh_time then
self:setupAutoRefreshTime()
else
UIManager:unschedule(self.autoRefreshTime)
self.onCloseDocument = nil
end
self:rescheduleFooterAutoRefreshIfNeeded()
end
},
{
@ -2026,6 +2047,7 @@ function ReaderFooter:onReaderReady()
self:setTocMarkers()
self.updateFooterText = self._updateFooterText
self:onUpdateFooter()
self:rescheduleFooterAutoRefreshIfNeeded()
end
function ReaderFooter:onReadSettings(config)
@ -2075,10 +2097,12 @@ end
function ReaderFooter:onEnterFlippingMode()
self.orig_mode = self.mode
self:applyFooterMode(self.mode_list.page_progress)
self:rescheduleFooterAutoRefreshIfNeeded()
end
function ReaderFooter:onExitFlippingMode()
self:applyFooterMode(self.orig_mode)
self:rescheduleFooterAutoRefreshIfNeeded()
end
function ReaderFooter:onTapFooter(ges)
@ -2123,6 +2147,7 @@ function ReaderFooter:onTapFooter(ges)
self:applyFooterMode()
G_reader_settings:saveSetting("reader_footer_mode", self.mode)
self:onUpdateFooter(true)
self:rescheduleFooterAutoRefreshIfNeeded()
return true
end
@ -2134,19 +2159,6 @@ function ReaderFooter:onHoldFooter()
end
end
function ReaderFooter:setVisible(visible)
if visible then
-- If it was off, just do as if we tap'ed on it (so we don't
-- duplicate onTapFooter() code)
if self.mode == self.mode_list.off then
self:onTapFooter(true) -- ignore tap lock
end
self.view.footer_visible = (self.mode ~= self.mode_list.off)
else
self:applyFooterMode(self.mode_list.off)
end
end
function ReaderFooter:refreshFooter(refresh, signal)
self:updateFooterContainer()
self:resetLayout(true)
@ -2167,16 +2179,15 @@ end
function ReaderFooter:onResume()
-- Force a footer repaint on resume if it was visible
self:onUpdateFooter(self.view.footer_visible)
if self.settings.auto_refresh_time then
self:setupAutoRefreshTime()
end
self:rescheduleFooterAutoRefreshIfNeeded()
end
function ReaderFooter:onSuspend()
if self.settings.auto_refresh_time then
UIManager:unschedule(self.autoRefreshTime)
self.onCloseDocument = nil
end
self:unscheduleFooterAutoRefresh()
end
function ReaderFooter:onCloseDocument()
self:unscheduleFooterAutoRefresh()
end
function ReaderFooter:onFrontlightStateChanged()

35
spec/unit/readerfooter_spec.lua
Unescape Escape View File

@ -420,8 +420,9 @@ describe("Readerfooter module", function()
assert.are.same({}, UIManager._task_queue)
G_reader_settings:saveSetting("footer", {
page_progress = true,
auto_refresh_time = true,
all_at_once = true,
time = true,
})
local readerui = ReaderUI:new{
dimen = Screen:getSize(),
@ -430,7 +431,7 @@ describe("Readerfooter module", function()
local footer = readerui.view.footer
local found = 0
for _,task in ipairs(UIManager._task_queue) do
if task.action == footer.autoRefreshTime then
if task.action == footer.autoRefreshFooter then
found = found + 1
end
end
@ -439,7 +440,7 @@ describe("Readerfooter module", function()
footer:onCloseDocument()
found = 0
for _,task in ipairs(UIManager._task_queue) do
if task.action == footer.autoRefreshTime then
if task.action == footer.autoRefreshFooter then
found = found + 1
end
end
@ -457,8 +458,9 @@ describe("Readerfooter module", function()
assert.are.same({}, UIManager._task_queue)
G_reader_settings:saveSetting("footer", {
disabled = true,
page_progress = true,
auto_refresh_time = true,
all_at_once = true,
time = true,
})
local readerui = ReaderUI:new{
dimen = Screen:getSize(),
@ -467,7 +469,7 @@ describe("Readerfooter module", function()
local footer = readerui.view.footer
local found = 0
for _,task in ipairs(UIManager._task_queue) do
if task.action == footer.autoRefreshTime then
if task.action == footer.autoRefreshFooter then
found = found + 1
end
end
@ -485,8 +487,9 @@ describe("Readerfooter module", function()
assert.are.same({}, UIManager._task_queue)
G_reader_settings:saveSetting("footer", {
disabled = false,
page_progress = true,
auto_refresh_time = true,
all_at_once = true,
time = true,
})
local readerui = ReaderUI:new{
dimen = Screen:getSize(),
@ -498,27 +501,27 @@ describe("Readerfooter module", function()
local found = 0
for _,task in ipairs(UIManager._task_queue) do
if task.action == footer.autoRefreshTime then
if task.action == footer.autoRefreshFooter then
found = found + 1
end
end
assert.is.same(1, found)
-- disable auto refresh time
tapFooterMenu(fake_menu, "Auto refresh time")
tapFooterMenu(fake_menu, "Auto refresh")
found = 0
for _,task in ipairs(UIManager._task_queue) do
if task.action == footer.autoRefreshTime then
if task.action == footer.autoRefreshFooter then
found = found + 1
end
end
assert.is.same(0, found)
-- enable auto refresh time again
tapFooterMenu(fake_menu, "Auto refresh time")
tapFooterMenu(fake_menu, "Auto refresh")
found = 0
for _,task in ipairs(UIManager._task_queue) do
if task.action == footer.autoRefreshTime then
if task.action == footer.autoRefreshFooter then
found = found + 1
end
end
@ -748,8 +751,16 @@ describe("Readerfooter module", function()
local footer = readerui.view.footer
assert.falsy(readerui.view.footer_visible)
assert.truthy(footer.onCloseDocument == nil)
assert.truthy(footer.mode == 0)
local found = 0
for _,task in ipairs(UIManager._task_queue) do
if task.action == footer.autoRefreshFooter then
found = found + 1
end
end
assert.is.same(0, found)
readerui:closeDocument()
readerui:onClose()
end)

Write Preview
Loading…
Cancel
Save