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

footer(refactor): various bug fixes and optimizations

Browse Source
pull/2317/head
Qingping Hou 8 years ago
parent 3de3fb9b14
commit 558754e9b5
4 changed files with 600 additions and 224 deletions
Show Stats Download Patch File Download Diff File

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

@ -29,18 +29,72 @@ local MODE = {
chapter_time_to_read = 7,
frontlight = 8,
}
local MODE_INDEX = {}
for k,v in pairs(MODE) do
MODE_INDEX[v] = k
end
-- functions that generates footer text for each mode
local footerTextGeneratorMap = {
empty = function() return "" end,
frontlight = function()
if not Device:hasFrontlight() then return "L: NA" end
local powerd = Device:getPowerDevice()
if powerd.is_fl_on ~= nil and powerd.is_fl_on == true then
if powerd.fl_intensity ~= nil then
return string.format("L: %d%%", powerd.fl_intensity)
end
else
return "L: Off"
end
end,
battery = function()
local powerd = Device:getPowerDevice()
return "B:" .. (powerd:isCharging() and "+" or "") .. powerd:getCapacity() .. "%"
end,
time = function()
return os.date("%H:%M")
end,
page_progress = function(footer)
if footer.pageno then
return string.format("%d / %d", footer.pageno, footer.pages)
else
return string.format("%d / %d", footer.position, footer.doc_height)
end
end,
pages_left = function(footer)
local left = footer.ui.toc:getChapterPagesLeft(
footer.pageno, footer.toc_level)
return "=> " .. (left and left or footer.pages - footer.pageno)
end,
percentage = function(footer)
return string.format("R:%1.f%%", footer.progress_bar.percentage * 100)
end,
book_time_to_read = function(footer)
local current_page
if footer.view.document.info.has_pages then
current_page = footer.ui.paging.current_page
else
current_page = footer.view.document:getCurrentPage()
end
return footer:getDataFromStatistics("TB: ", footer.pages - current_page)
end,
chapter_time_to_read = function(footer)
local left = footer.ui.toc:getChapterPagesLeft(
footer.pageno, footer.toc_level)
return footer:getDataFromStatistics(
"TC: ", (left and left or footer.pages - footer.pageno))
end,
}
local ReaderFooter = InputContainer:new{
mode = MODE.page_progress,
pageno = nil,
pages = nil,
toc_level = 0,
progress_percentage = 0.0,
progress_text = nil,
footer_text = nil,
text_font_face = "ffont",
text_font_size = DMINIBAR_FONT_SIZE,
bar_height = Screen:scaleBySize(DMINIBAR_HEIGHT),
@ -48,6 +102,8 @@ local ReaderFooter = InputContainer:new{
horizontal_margin = Screen:scaleBySize(10),
text_left_margin = Screen:scaleBySize(10),
settings = {},
-- added to expose them to unit tests
textGeneratorMap = footerTextGeneratorMap,
}
function ReaderFooter:init()
@ -56,7 +112,6 @@ function ReaderFooter:init()
self.settings = G_reader_settings:readSetting("footer") or {
disabled = false,
all_at_once = false,
progress_bar = true,
toc_markers = true,
battery = true,
time = true,
@ -67,45 +122,49 @@ function ReaderFooter:init()
chapter_time_to_read = true,
frontlight = false,
}
if self.settings.disabled then
self.resetLayout = function() end
self.onCloseDocument = function() end
self.onPageUpdate = function() end
self.onPosUpdate = function() end
self.onUpdatePos = function() end
self.onSetStatusLine = function() end
-- footer featuren disabled completely, stop initialization now
self:disableFooter()
return
end
self.progress_text = TextWidget:new{
self.has_no_mode = true
for _, m in ipairs(MODE_INDEX) do
if self.settings[m] then
self.has_no_mode = false
break
end
end
self.footer_text = TextWidget:new{
text = '',
face = Font:getFace(self.text_font_face, self.text_font_size),
}
self.text_width = self.progress_text:getSize().w + self.text_left_margin
-- all width related values will be initialized in self:resetLayout()
self.text_width = 0
self.progress_bar = ProgressWidget:new{
width = nil, -- width will be updated in self:resetLayout()
width = nil,
height = self.bar_height,
percentage = self.progress_percentage,
tick_width = DMINIBAR_TOC_MARKER_WIDTH,
ticks = nil, -- ticks will be populated in self:updateFooterText
last = nil, -- last will be initialized in self:updateFooterText
}
local margin_span = HorizontalSpan:new{width=self.horizontal_margin}
local screen_width = Screen:getWidth()
local margin_span = HorizontalSpan:new{width = self.horizontal_margin}
self.horizontal_group = HorizontalGroup:new{margin_span}
self.text_container = RightContainer:new{
dimen = Geom:new{w = self.text_width, h = self.height},
self.progress_text,
dimen = Geom:new{w = 0, h = self.height},
self.footer_text,
}
if self.settings.progress_bar then
table.insert(self.horizontal_group, self.progress_bar)
end
table.insert(self.horizontal_group, self.progress_bar)
table.insert(self.horizontal_group, self.text_container)
table.insert(self.horizontal_group, margin_span)
self[1] = BottomContainer:new{
dimen = Screen:getSize(),
dimen = Geom:new{},
BottomContainer:new{
dimen = Geom:new{w = screen_width, h = self.height*2},
dimen = Geom:new{w = 0, h = self.height*2},
FrameContainer:new{
self.horizontal_group,
background = Blitbuffer.COLOR_WHITE,
@ -115,22 +174,31 @@ function ReaderFooter:init()
}
}
self:applyFooterMode(
G_reader_settings:readSetting("reader_footer_mode") or self.mode)
self.mode = G_reader_settings:readSetting("reader_footer_mode") or self.mode
if self.settings.all_at_once then
self.view.footer_visible = (self.mode ~= MODE.off)
self:updateFooterTextGenerator()
else
self:applyFooterMode()
end
self:resetLayout()
if self.settings.auto_refresh_time then
if not self.autoRefreshTime then
self.autoRefreshTime = function()
self:updateFooter()
UIManager:scheduleIn(61 - tonumber(os.date("%S")), self.autoRefreshTime)
end
end
self.onCloseDocument = function()
UIManager:unschedule(self.autoRefreshTime)
self:setupAutoRefreshTime()
end
end
function ReaderFooter:setupAutoRefreshTime()
if not self.autoRefreshTime then
self.autoRefreshTime = function()
self:updateFooter()
UIManager:scheduleIn(61 - tonumber(os.date("%S")), self.autoRefreshTime)
end
UIManager:scheduleIn(61 - tonumber(os.date("%S")), self.autoRefreshTime)
end
self.onCloseDocument = function()
UIManager:unschedule(self.autoRefreshTime)
end
UIManager:scheduleIn(61 - tonumber(os.date("%S")), self.autoRefreshTime)
end
-- call this method whenever the screen size changed
@ -171,15 +239,57 @@ function ReaderFooter:resetLayout()
end
end
local options = {
function ReaderFooter:getHeight()
return self.footer_text:getSize().h
end
function ReaderFooter:disableFooter()
self.onReaderReady = function() end
self.resetLayout = function() end
self.onCloseDocument = nil
self.onPageUpdate = function() end
self.onPosUpdate = function() end
self.onUpdatePos = function() end
self.onSetStatusLine = function() end
self.mode = MODE.off
self.view.footer_visible = false
end
function ReaderFooter:updateFooterTextGenerator()
local footerTextGenerators = {}
for _, m in pairs(MODE_INDEX) do
if self.settings[m] then
table.insert(footerTextGenerators,
footerTextGeneratorMap[m])
if not self.settings.all_at_once then
-- if not show all at once, then one is enough
break
end
end
end
if #footerTextGenerators == 0 then
-- all modes are disabled
self.genFooterText = footerTextGeneratorMap.empty
elseif #footerTextGenerators == 1 then
-- there is only one mode enabled, simplify the generator
-- function to that one
self.genFooterText = footerTextGenerators[1]
else
self.footerTextGenerators = footerTextGenerators
self.genFooterText = self.genAllFooterText
end
-- notify caller that UI needs update
return true
end
local option_titles = {
all_at_once = _("Show all at once"),
toc_markers = _("Show table of content markers"),
auto_refresh_time = _("Auto refresh time"),
progress_bar = _("Progress bar"),
toc_markers = _("Chapter markers"),
battery = _("Battery status"),
time = _("Current time"),
page_progress = _("Current page"),
time = _("Current time"),
pages_left = _("Pages left in this chapter"),
battery = _("Battery status"),
percentage = _("Progress percentage"),
book_time_to_read = _("Book time to read"),
chapter_time_to_read = _("Chapter time to read"),
@ -187,24 +297,13 @@ local options = {
}
function ReaderFooter:addToMainMenu(tab_item_table)
local get_minibar_option = function(option)
return {
text = options[option],
checked_func = function()
return self.settings[option] == true
end,
enabled_func = function()
return not self.settings.disabled
end,
callback = function()
self.settings[option] = not self.settings[option]
G_reader_settings:saveSetting("footer", self.settings)
self:updateFooter()
UIManager:setDirty("all", "partial")
end,
}
end
local sub_items = {}
table.insert(tab_item_table.setting, {
text = _("Status bar"),
sub_item_table = sub_items,
})
-- menu item to fake footer tapping when touch area is disabled
if Geom:new{
x = DTAP_ZONE_MINIBAR.x,
y = DTAP_ZONE_MINIBAR.y,
@ -212,89 +311,124 @@ function ReaderFooter:addToMainMenu(tab_item_table)
h = DTAP_ZONE_MINIBAR.h
}:sizeof() == 0 then
table.insert(sub_items, {
text = _("Toggle"),
text = _("Toggle mode"),
enabled_func = function()
return not self.view.flipping_visible
end,
callback = function()
if not self.view.flipping_visible then
self:onTapFooter(nil, nil)
end
end,
callback = function() self:onTapFooter() end,
})
end
for i, v in ipairs({
get_minibar_option("all_at_once"),
get_minibar_option("auto_refresh_time"),
get_minibar_option("progress_bar"),
get_minibar_option("toc_markers"),
get_minibar_option("battery"),
get_minibar_option("time"),
get_minibar_option("page_progress"),
get_minibar_option("pages_left"),
get_minibar_option("percentage"),
get_minibar_option("book_time_to_read"),
get_minibar_option("chapter_time_to_read"),
get_minibar_option("frontlight"),
}) do
table.insert(sub_items, v)
-- footer is enabled, build the full status bar menu
local isEnabled = function()
return not self.settings.disabled
end
table.insert(tab_item_table.setting, {
text = _("Status bar"),
sub_item_table = sub_items,
})
end
function ReaderFooter:getFrontlightInfo()
local powerd = Device:getPowerDevice()
if powerd.is_fl_on ~= nil and powerd.is_fl_on == true then
if powerd.fl_intensity ~= nil then
return string.format("L: %d%%", powerd.fl_intensity)
end
else
return "L: Off"
local getMinibarOption = function(option, callback)
return {
text = option_titles[option],
checked_func = function()
return self.settings[option] == true
end,
enabled_func = isEnabled,
callback = function()
self.settings[option] = not self.settings[option]
G_reader_settings:saveSetting("footer", self.settings)
-- only case that we don't need a UI update is enable/disable
-- non-current mode when all_at_once is disabled.
local should_update = false
local first_enabled_mode_num
local prev_has_no_mode = self.has_no_mode
self.has_no_mode = true
for mode_num, m in pairs(MODE_INDEX) do
if self.settings[m] then
first_enabled_mode_num = mode_num
self.has_no_mode = false
break
end
end
if callback then
should_update = callback(self)
elseif self.settings.all_at_once then
should_update = self:updateFooterTextGenerator()
elseif (MODE[option] == self.mode and self.settings[option] == false)
or (prev_has_no_mode ~= self.has_no_mode) then
-- current mode got disabled, redraw footer with other
-- enabled modes. if all modes are disabled, then only show
-- progress bar
if not self.has_no_mode then
self.mode = first_enabled_mode_num
end
should_update = true
self:applyFooterMode()
end
if should_update then
self:updateFooter()
UIManager:setDirty("all", "partial")
end
end,
}
end
end
function ReaderFooter:getBatteryInfo()
local powerd = Device:getPowerDevice()
return "B:" .. (powerd:isCharging() and "+" or "") .. powerd:getCapacity() .. "%"
table.insert(sub_items,
getMinibarOption("all_at_once", self.updateFooterTextGenerator))
table.insert(sub_items, getMinibarOption("toc_markers", self.setTocMarkers))
-- TODO: only enable auto refresh when time is shown
table.insert(sub_items, getMinibarOption("auto_refresh_time", function()
if self.settings.auto_refresh_time then
self:setupAutoRefreshTime()
else
UIManager:unschedule(self.autoRefreshTime)
self.onCloseDocument = nil
end
end))
table.insert(sub_items, getMinibarOption("page_progress"))
table.insert(sub_items, getMinibarOption("time"))
table.insert(sub_items, getMinibarOption("pages_left"))
table.insert(sub_items, getMinibarOption("battery"))
table.insert(sub_items, getMinibarOption("percentage"))
table.insert(sub_items, getMinibarOption("book_time_to_read"))
table.insert(sub_items, getMinibarOption("chapter_time_to_read"))
table.insert(sub_items, getMinibarOption("frontlight"))
end
function ReaderFooter:getTimeInfo()
return os.date("%H:%M")
end
-- this method will be updated at runtime based on user setting
function ReaderFooter:genFooterText() end
function ReaderFooter:getProgressInfo()
if self.pageno then
return string.format("%d / %d", self.pageno, self.pages)
else
return string.format("%d / %d", self.position, self.doc_height)
function ReaderFooter:genAllFooterText()
local info = {}
for _, gen in ipairs(self.footerTextGenerators) do
table.insert(info, gen(self))
end
return table.concat(info, " | ")
end
function ReaderFooter:getNextChapterInfo()
local left = self.ui.toc:getChapterPagesLeft(self.pageno, self.toc_level)
return "=> " .. (left and left or self.pages - self.pageno)
end
function ReaderFooter:getProgressPercentage()
return string.format("R:%1.f%%", self.progress_bar.percentage * 100)
end
-- this function should never be called with footer is disabled
function ReaderFooter:setTocMarkers()
if self.settings.toc_markers then
if self.progress_bar.ticks ~= nil then return end
local ticks_candidates = {}
if self.ui.toc then
local max_level = self.ui.toc:getMaxDepth()
for i = 0, -max_level, -1 do
local ticks = self.ui.toc:getTocTicks(i)
table.insert(ticks_candidates, ticks)
end
-- find the finest toc ticks by sorting out the largest one
table.sort(ticks_candidates, function(a, b) return #a > #b end)
end
function ReaderFooter:getBookTimeToRead()
local current_page
if self.view.document.info.has_pages then
current_page = self.ui.paging.current_page
if #ticks_candidates > 0 then
self.progress_bar.ticks = ticks_candidates[1]
self.progress_bar.last = self.pages or self.view.document:getPageCount()
else
-- we still set ticks here so self.progress_bar.ticks will not be
-- initialized again if ticks_candidates is empty
self.progress_bar.ticks = {}
end
else
current_page = self.view.document:getCurrentPage()
self.progress_bar.ticks = nil
end
return self:getDataFromStatistics("TB: ", self.pages - current_page)
end
function ReaderFooter:getChapterTimeToRead()
local left = self.ui.toc:getChapterPagesLeft(self.pageno, self.toc_level)
return self:getDataFromStatistics("TC: ", (left and left or self.pages - self.pageno))
end
function ReaderFooter:getDataFromStatistics(title, pages)
@ -335,79 +469,12 @@ end
-- only call this function after document is fully loaded
function ReaderFooter:_updateFooterText()
if self.settings.toc_markers and self.progress_bar.ticks == nil then
local ticks_candidates = {}
if self.ui.toc then
local max_level = self.ui.toc:getMaxDepth()
for i = 0, -max_level, -1 do
local ticks = self.ui.toc:getTocTicks(i)
table.insert(ticks_candidates, ticks)
end
-- find the finest toc ticks by sorting out the largest one
table.sort(ticks_candidates, function(a, b) return #a > #b end)
end
if #ticks_candidates > 0 then
self.progress_bar.ticks = ticks_candidates[1]
self.progress_bar.last = self.pages or self.view.document:getPageCount()
else
-- we still set ticks here so self.progress_bar.ticks will not be
-- initialized again if ticks_candidates is empty
self.progress_bar.ticks = {}
end
end
if self.settings.all_at_once then
local info = {}
if self.settings.frontlight and Device:hasFrontlight() then
table.insert(info, self:getFrontlightInfo())
end
if self.settings.battery then
table.insert(info, self:getBatteryInfo())
end
if self.settings.time then
table.insert(info, self:getTimeInfo())
end
if self.settings.page_progress then
table.insert(info, self:getProgressInfo())
end
if self.settings.pages_left then
table.insert(info, self:getNextChapterInfo())
end
if self.settings.percentage then
table.insert(info, self:getProgressPercentage())
end
if self.settings.book_time_to_read then
table.insert(info, self:getBookTimeToRead())
end
if self.settings.chapter_time_to_read then
table.insert(info, self:getChapterTimeToRead())
end
self.progress_text:setText(table.concat(info, " | "))
self.footer_text:setText(self:genFooterText())
if self.has_no_mode then
self.text_width = 0
else
local info
if self.mode == MODE.page_progress then
info = self:getProgressInfo()
elseif self.mode == MODE.time then
info = self:getTimeInfo()
elseif self.mode == MODE.pages_left then
info = self:getNextChapterInfo()
elseif self.mode == MODE.battery then
info = self:getBatteryInfo()
elseif self.mode == MODE.percentage then
info = self:getProgressPercentage()
elseif self.mode == MODE.book_time_to_read then
info = self:getBookTimeToRead()
elseif self.mode == MODE.chapter_time_to_read then
info = self:getChapterTimeToRead()
elseif self.mode == MODE.frontlight and Device:hasFrontlight() then
info = self:getFrontlightInfo()
else
info = ""
end
self.progress_text:setText(info)
self.text_width = self.footer_text:getSize().w + self.text_left_margin
end
self.text_width = self.progress_text:getSize().w + self.text_left_margin
self.progress_bar.width = math.floor(
self._saved_screen_width - self.text_width - self.horizontal_margin*2)
self.text_container.dimen.w = self.text_width
@ -429,11 +496,10 @@ end
-- recalculate footer sizes when document page count is updated
-- see documentation for more info about this event.
function ReaderFooter:onUpdatePos()
self:updateFooter()
end
ReaderFooter.onUpdatePos = ReaderFooter.updateFooter
function ReaderFooter:onReaderReady()
self:setTocMarkers()
self.updateFooterText = self._updateFooterText
self:updateFooter()
end
@ -451,6 +517,14 @@ function ReaderFooter:applyFooterMode(mode)
-- 8 for front light level
if mode ~= nil then self.mode = mode end
self.view.footer_visible = (self.mode ~= MODE.off)
if not self.view.footer_visible or self.settings.all_at_once then return end
local mode_name = MODE_INDEX[self.mode]
if not self.settings[mode_name] or self.has_no_mode then
-- all modes disabled, only show progress bar
mode_name = "empty"
end
self.genFooterText = footerTextGeneratorMap[mode_name]
end
function ReaderFooter:onEnterFlippingMode()
@ -472,7 +546,7 @@ function ReaderFooter:onTapFooter(arg, ges)
self.ui:handleEvent(Event:new("GotoPercentage", percentage))
end
else
if self.settings.all_at_once then
if self.settings.all_at_once or self.has_no_mode then
if self.mode >= 1 then
self.mode = MODE.off
else

2
frontend/apps/reader/modules/readerzooming.lua
Unescape Escape View File

@ -244,7 +244,7 @@ function ReaderZooming:getZoom(pageno)
local zoom_w = self.dimen.w
local zoom_h = self.dimen.h
if self.ui.view.footer_visible then
zoom_h = zoom_h - self.ui.view.footer.progress_text:getSize().h
zoom_h = zoom_h - self.ui.view.footer:getHeight()
end
if self.rotation % 180 == 0 then
-- No rotation or rotated by 180 degrees

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

@ -2,6 +2,21 @@ describe("Readerfooter module", function()
local DocumentRegistry, ReaderUI, DocSettings, UIManager, DEBUG
local purgeDir, Screen
local function tapFooterMenu(menu_tab_items, menu_title)
for _, item in ipairs(menu_tab_items.setting) do
if item.text == "Status bar" then
for _, subitem in ipairs(item.sub_item_table) do
if subitem.text == menu_title then
subitem.callback()
return
end
end
error('Menu item not found: "' .. menu_title .. '"!')
end
end
error('Menu item not found: "Status bar"!')
end
setup(function()
require("commonrequire")
DocumentRegistry = require("document/documentregistry")
@ -17,7 +32,6 @@ describe("Readerfooter module", function()
G_reader_settings:saveSetting("footer", {
disabled = false,
all_at_once = true,
progress_bar = true,
toc_markers = true,
battery = true,
time = true,
@ -29,7 +43,32 @@ describe("Readerfooter module", function()
})
end)
it("should setup footer as visible", function()
it("should setup footer as visible in all_at_once mode", function()
G_reader_settings:saveSetting("reader_footer_mode", 1)
local sample_pdf = "spec/front/unit/data/2col.pdf"
purgeDir(DocSettings:getSidecarDir(sample_pdf))
os.remove(DocSettings:getHistoryPath(sample_pdf))
local readerui = ReaderUI:new{
document = DocumentRegistry:openDocument(sample_pdf),
}
assert.is.same(true, readerui.view.footer_visible)
G_reader_settings:delSetting("reader_footer_mode")
end)
it("should setup footer as visible not in all_at_once", function()
G_reader_settings:saveSetting("footer", {
disabled = false,
all_at_once = false,
toc_markers = true,
battery = true,
time = true,
page_progress = true,
pages_left = true,
percentage = true,
book_time_to_read = true,
chapter_time_to_read = true,
})
G_reader_settings:saveSetting("reader_footer_mode", 1)
local sample_pdf = "spec/front/unit/data/2col.pdf"
purgeDir(DocSettings:getSidecarDir(sample_pdf))
@ -39,6 +78,7 @@ describe("Readerfooter module", function()
document = DocumentRegistry:openDocument(sample_pdf),
}
assert.is.same(true, readerui.view.footer_visible)
assert.is.same(1, readerui.view.footer.mode, 1)
G_reader_settings:delSetting("reader_footer_mode")
end)
@ -101,11 +141,11 @@ describe("Readerfooter module", function()
local footer = readerui.view.footer
footer:onPageUpdate(1)
footer:updateFooter()
local timeinfo = footer:getTimeInfo()
local timeinfo = footer.textGeneratorMap.time()
local page_count = readerui.document:getPageCount()
-- stats has not been initialized here, so we get na TB and TC
assert.are.same('B:0% | '..timeinfo..' | 1 / '..page_count..' | => 1 | R:0% | TB: na | TC: na',
footer.progress_text.text)
assert.are.same('1 / '..page_count..' | '..timeinfo..' | => 1 | B:0% | R:0% | TB: na | TC: na',
footer.footer_text.text)
end)
it("should setup footer for pdf without error", function()
@ -117,9 +157,9 @@ describe("Readerfooter module", function()
document = DocumentRegistry:openDocument(sample_pdf),
}
readerui.view.footer:updateFooter()
local timeinfo = readerui.view.footer:getTimeInfo()
assert.are.same('B:0% | '..timeinfo..' | 1 / 2 | => 1 | R:50% | TB: na | TC: na',
readerui.view.footer.progress_text.text)
local timeinfo = readerui.view.footer.textGeneratorMap.time()
assert.are.same('1 / 2 | '..timeinfo..' | => 1 | B:0% | R:50% | TB: na | TC: na',
readerui.view.footer.footer_text.text)
end)
it("should switch between different modes", function()
@ -130,36 +170,50 @@ describe("Readerfooter module", function()
local readerui = ReaderUI:new{
document = DocumentRegistry:openDocument(sample_pdf),
}
local fake_menu = {setting = {}}
local footer = readerui.view.footer
footer:addToMainMenu(fake_menu)
footer:resetLayout()
footer:updateFooter()
local timeinfo = readerui.view.footer:getTimeInfo()
assert.are.same('B:0% | '..timeinfo..' | 1 / 2 | => 1 | R:50% | TB: na | TC: na',
footer.progress_text.text)
footer.mode = 1
footer.settings.all_at_once = false
footer:updateFooter()
assert.are.same('1 / 2', footer.progress_text.text)
local timeinfo = footer.textGeneratorMap.time()
assert.are.same('1 / 2 | '..timeinfo..' | => 1 | B:0% | R:50% | TB: na | TC: na',
footer.footer_text.text)
footer.mode = 3
footer:updateFooter()
assert.are.same('=> 1', footer.progress_text.text)
-- disable show all at once, page progress should be on the first
tapFooterMenu(fake_menu, "Show all at once")
assert.are.same('1 / 2', footer.footer_text.text)
footer.mode = 4
footer:updateFooter()
assert.are.same('B:0%', footer.progress_text.text)
-- disable page progress, time should follow
tapFooterMenu(fake_menu, "Current page")
assert.are.same(timeinfo, footer.footer_text.text)
footer.mode = 5
footer:updateFooter()
assert.are.same('R:50%', footer.progress_text.text)
-- disable time, page left should follow
tapFooterMenu(fake_menu, "Current time")
assert.are.same('=> 1', footer.footer_text.text)
footer.mode = 6
footer:updateFooter()
assert.are.same('TB: na', footer.progress_text.text)
-- disable page left, battery should follow
tapFooterMenu(fake_menu, "Pages left in this chapter")
assert.are.same('B:0%', footer.footer_text.text)
footer.mode = 7
footer:updateFooter()
assert.are.same('TC: na', footer.progress_text.text)
-- disable battery, percentage should follow
tapFooterMenu(fake_menu, "Battery status")
assert.are.same('R:50%', footer.footer_text.text)
-- disable percentage, book time to read should follow
tapFooterMenu(fake_menu, "Progress percentage")
assert.are.same('TB: na', footer.footer_text.text)
-- disable book time to read, chapter time to read should follow
tapFooterMenu(fake_menu, "Book time to read")
assert.are.same('TC: na', footer.footer_text.text)
-- disable chapter time to read, text should be empty
tapFooterMenu(fake_menu, "Chapter time to read")
assert.are.same('', footer.footer_text.text)
-- reenable chapter time to read, text should be chapter time to read
tapFooterMenu(fake_menu, "Chapter time to read")
assert.are.same('TC: na', footer.footer_text.text)
end)
it("should rotate through different modes", function()
@ -248,6 +302,10 @@ describe("Readerfooter module", function()
purgeDir(DocSettings:getSidecarDir(sample_epub))
os.remove(DocSettings:getHistoryPath(sample_epub))
G_reader_settings:saveSetting("footer", {
toc_markers = true,
})
local readerui = ReaderUI:new{
document = DocumentRegistry:openDocument(sample_epub),
}
@ -256,6 +314,11 @@ describe("Readerfooter module", function()
local page_count = readerui.document:getPageCount()
assert.are.same(28, #footer.progress_bar.ticks)
assert.are.same(page_count, footer.progress_bar.last)
-- test toggle TOC markers
footer.settings.toc_markers = false
footer:setTocMarkers()
assert.are.same(nil, footer.progress_bar.ticks)
end)
it("should schedule/unschedule auto refresh time task", function()
@ -316,6 +379,241 @@ describe("Readerfooter module", function()
assert.is.same(0, found)
end)
it("should toggle auto refresh time task by toggling the menu", function()
local sample_pdf = "spec/front/unit/data/2col.pdf"
purgeDir(DocSettings:getSidecarDir(sample_pdf))
os.remove(DocSettings:getHistoryPath(sample_pdf))
UIManager:quit()
assert.are.same({}, UIManager._task_queue)
G_reader_settings:saveSetting("footer", {
disabled = false,
page_progress = true,
auto_refresh_time = true,
})
local readerui = ReaderUI:new{
document = DocumentRegistry:openDocument(sample_pdf),
}
local footer = readerui.view.footer
local fake_menu = {setting = {}}
footer:addToMainMenu(fake_menu)
local found = 0
for _,task in ipairs(UIManager._task_queue) do
if task.action == footer.autoRefreshTime then
found = found + 1
end
end
assert.is.same(1, found)
-- disable auto refresh time
tapFooterMenu(fake_menu, "Auto refresh time")
found = 0
for _,task in ipairs(UIManager._task_queue) do
if task.action == footer.autoRefreshTime then
found = found + 1
end
end
assert.is.same(0, found)
-- enable auto refresh time again
tapFooterMenu(fake_menu, "Auto refresh time")
found = 0
for _,task in ipairs(UIManager._task_queue) do
if task.action == footer.autoRefreshTime then
found = found + 1
end
end
assert.is.same(1, found)
end)
it("should support toggle footer through menu if tap zone is disabled", function()
local saved_tap_zone_minibar = DTAP_ZONE_MINIBAR
DTAP_ZONE_MINIBAR.w = 0
DTAP_ZONE_MINIBAR.h = 0
local sample_pdf = "spec/front/unit/data/2col.pdf"
purgeDir(DocSettings:getSidecarDir(sample_pdf))
os.remove(DocSettings:getHistoryPath(sample_pdf))
UIManager:quit()
assert.are.same({}, UIManager._task_queue)
G_reader_settings:saveSetting("reader_footer_mode", 1)
G_reader_settings:saveSetting("footer", {
disabled = false,
page_progress = true,
time = true,
})
local readerui = ReaderUI:new{
document = DocumentRegistry:openDocument(sample_pdf),
}
local footer = readerui.view.footer
local fake_menu = {setting = {}}
footer:addToMainMenu(fake_menu)
local has_toggle_menu = false
for _, item in ipairs(fake_menu.setting) do
if item.text == "Status bar" then
for _, subitem in ipairs(item.sub_item_table) do
if subitem.text == 'Toggle mode' then
has_toggle_menu = true
break
end
end
break
end
end
assert.is.truthy(has_toggle_menu)
assert.is.same(1, footer.mode)
tapFooterMenu(fake_menu, "Toggle mode")
assert.is.same(2, footer.mode)
DTAP_ZONE_MINIBAR = saved_tap_zone_minibar
end)
it("should remove and add modes to footer text in all_at_once mode", function()
local sample_pdf = "spec/front/unit/data/2col.pdf"
purgeDir(DocSettings:getSidecarDir(sample_pdf))
os.remove(DocSettings:getHistoryPath(sample_pdf))
UIManager:quit()
assert.are.same({}, UIManager._task_queue)
G_reader_settings:saveSetting("footer", {
all_at_once = true,
page_progress = true,
pages_left = true,
})
local readerui = ReaderUI:new{
document = DocumentRegistry:openDocument(sample_pdf),
}
local footer = readerui.view.footer
local fake_menu = {setting = {}}
footer:addToMainMenu(fake_menu)
assert.are.same('1 / 2 | => 1', footer.footer_text.text)
-- remove mode from footer text
tapFooterMenu(fake_menu, "Pages left in this chapter")
assert.are.same('1 / 2', footer.footer_text.text)
-- add mode to footer text
tapFooterMenu(fake_menu, "Progress percentage")
assert.are.same('1 / 2 | R:50%', footer.footer_text.text)
end)
it("should initialize text mode in all_at_once mode", function()
local sample_pdf = "spec/front/unit/data/2col.pdf"
purgeDir(DocSettings:getSidecarDir(sample_pdf))
os.remove(DocSettings:getHistoryPath(sample_pdf))
UIManager:quit()
assert.are.same({}, UIManager._task_queue)
G_reader_settings:saveSetting("reader_footer_mode", 0)
G_reader_settings:saveSetting("footer", {
all_at_once = true,
page_progress = true,
pages_left = true,
})
local readerui = ReaderUI:new{
document = DocumentRegistry:openDocument(sample_pdf)
}
local footer = readerui.view.footer
assert.is.truthy(footer.settings.all_at_once)
assert.is.truthy(0, footer.mode)
assert.is.falsy(readerui.view.footer_visible)
end)
it("should support disabling all the modes", function()
local sample_epub = "spec/front/unit/data/juliet.epub"
purgeDir(DocSettings:getSidecarDir(sample_epub))
os.remove(DocSettings:getHistoryPath(sample_epub))
UIManager:quit()
assert.are.same({}, UIManager._task_queue)
G_reader_settings:saveSetting("footer", {})
local readerui = ReaderUI:new{
document = DocumentRegistry:openDocument(sample_epub),
}
local footer = readerui.view.footer
local fake_menu = {setting = {}}
footer:addToMainMenu(fake_menu)
assert.is.same(true, footer.has_no_mode)
assert.is.same(0, footer.text_width)
tapFooterMenu(fake_menu, "Progress percentage")
assert.are.same('R:0%', footer.footer_text.text)
assert.is.same(false, footer.has_no_mode)
assert.is.same(footer.footer_text:getSize().w + footer.text_left_margin,
footer.text_width)
tapFooterMenu(fake_menu, "Progress percentage")
assert.is.same(true, footer.has_no_mode)
-- test in all at once mode
tapFooterMenu(fake_menu, "Progress percentage")
tapFooterMenu(fake_menu, "Show all at once")
assert.is.same(false, footer.has_no_mode)
tapFooterMenu(fake_menu, "Progress percentage")
assert.is.same(true, footer.has_no_mode)
tapFooterMenu(fake_menu, "Progress percentage")
assert.is.same(false, footer.has_no_mode)
end)
it("should return correct footer height in time mode", function()
local sample_epub = "spec/front/unit/data/juliet.epub"
purgeDir(DocSettings:getSidecarDir(sample_epub))
os.remove(DocSettings:getHistoryPath(sample_epub))
UIManager:quit()
G_reader_settings:saveSetting("reader_footer_mode", 2)
G_reader_settings:saveSetting("footer", { time = true })
local readerui = ReaderUI:new{
document = DocumentRegistry:openDocument(sample_epub),
}
local footer = readerui.view.footer
assert.falsy(footer.has_no_mode)
assert.truthy(readerui.view.footer_visible)
assert.is.same(21, footer:getHeight())
end)
it("should return correct footer height when all modes are disabled", function()
local sample_epub = "spec/front/unit/data/juliet.epub"
purgeDir(DocSettings:getSidecarDir(sample_epub))
os.remove(DocSettings:getHistoryPath(sample_epub))
UIManager:quit()
G_reader_settings:saveSetting("reader_footer_mode", 1)
G_reader_settings:saveSetting("footer", {})
local readerui = ReaderUI:new{
document = DocumentRegistry:openDocument(sample_epub),
}
local footer = readerui.view.footer
assert.truthy(footer.has_no_mode)
assert.truthy(readerui.view.footer_visible)
assert.is.same(21, footer:getHeight())
end)
it("should disable footer if settings.disabled is true", function()
local sample_epub = "spec/front/unit/data/juliet.epub"
purgeDir(DocSettings:getSidecarDir(sample_epub))
os.remove(DocSettings:getHistoryPath(sample_epub))
UIManager:quit()
G_reader_settings:saveSetting("footer", { disabled = true })
local readerui = ReaderUI:new{
document = DocumentRegistry:openDocument(sample_epub),
}
local footer = readerui.view.footer
assert.falsy(readerui.view.footer_visible)
assert.truthy(footer.onCloseDocument == nil)
assert.truthy(footer.mode == 0)
end)
it("should toggle between full and min progress bar for cre documents", function()
local sample_txt = "spec/front/unit/data/sample.txt"
local readerui = ReaderUI:new{

4
spec/unit/readerlink_spec.lua
Unescape Escape View File

@ -129,12 +129,16 @@ describe("ReaderLink module", function()
local readerui = ReaderUI:new{
document = DocumentRegistry:openDocument(sample_pdf),
}
assert.is.falsy(readerui.view.footer_visible)
readerui.paging:onGotoPage(1)
assert.is.same(1, readerui.paging.current_page)
readerui.view:onSetScrollMode(true)
assert.is.same(true, readerui.view.page_scroll)
assert.is.same(1, readerui.paging.current_page)
readerui.paging:onTapForward()
assert.is.same(2, readerui.paging.current_page)
readerui.paging:onTapForward()
assert.is.same(3, readerui.paging.current_page)
readerui.paging:onTapForward()
assert.is.same(4, readerui.paging.current_page)
assert.are.same(expected_page_states, readerui.view.page_states)

Write Preview
Loading…
Cancel
Save