local InputContainer = require("ui/widget/container/inputcontainer") local ReaderPanning = require("apps/reader/modules/readerpanning") local Screen = require("device").screen local Device = require("device") local Geom = require("ui/geometry") local Input = require("device").input local Event = require("ui/event") local GestureRange = require("ui/gesturerange") local UIManager = require("ui/uimanager") local DEBUG = require("dbg") local _ = require("gettext") --[[ Rolling is just like paging in page-based documents except that sometimes (in scroll mode) there is no concept of page number to indicate current progress. There are three kind of progress measurements for credocuments. 1. page number (in page mode) 2. progress percentage (in scroll mode) 3. xpointer (in document dom structure) We found that the first two measurements are not suitable for keeping a record of the real progress. For example, when switching screen orientation from portrait to landscape, or switching view mode from page to scroll, the internal xpointer should not be used as the view dimen/mode is changed and crengine's pagination mechanism will find a closest xpointer for the new view. So if we change the screen orientation or view mode back, we cannot find the original place since the internal xpointer is changed, which is counter- intuitive as users didn't goto any other page. The solution is that we keep a record of the internal xpointer and only change it in explicit page turning. And use that xpointer for non-page-turning rendering. --]] local ReaderRolling = InputContainer:new{ old_doc_height = nil, old_page = nil, current_pos = 0, -- only used for page view mode current_page= nil, doc_height = nil, xpointer = nil, panning_steps = ReaderPanning.panning_steps, show_overlap_enable = nil, overlap = 20, } function ReaderRolling:init() if Device:hasKeyboard() or Device:hasKeys() then self.key_events = { GotoNextView = { { Input.group.PgFwd }, doc = "go to next view", event = "GotoViewRel", args = 1 }, GotoPrevView = { { Input.group.PgBack }, doc = "go to previous view", event = "GotoViewRel", args = -1 }, MoveUp = { { "Up" }, doc = "move view up", event = "Panning", args = {0, -1} }, MoveDown = { { "Down" }, doc = "move view down", event = "Panning", args = {0, 1} }, GotoFirst = { {"1"}, doc = "go to start", event = "GotoPercent", args = 0}, Goto11 = { {"2"}, doc = "go to 11%", event = "GotoPercent", args = 11}, Goto22 = { {"3"}, doc = "go to 22%", event = "GotoPercent", args = 22}, Goto33 = { {"4"}, doc = "go to 33%", event = "GotoPercent", args = 33}, Goto44 = { {"5"}, doc = "go to 44%", event = "GotoPercent", args = 44}, Goto55 = { {"6"}, doc = "go to 55%", event = "GotoPercent", args = 55}, Goto66 = { {"7"}, doc = "go to 66%", event = "GotoPercent", args = 66}, Goto77 = { {"8"}, doc = "go to 77%", event = "GotoPercent", args = 77}, Goto88 = { {"9"}, doc = "go to 88%", event = "GotoPercent", args = 88}, GotoLast = { {"0"}, doc = "go to end", event = "GotoPercent", args = 100}, } end table.insert(self.ui.postInitCallback, function() self.doc_height = self.ui.document.info.doc_height self.old_doc_height = self.doc_height self.old_page = self.ui.document.info.number_of_pages end) self.ui.menu:registerToMainMenu(self) end -- This method will be called in onSetDimensions handler function ReaderRolling:initGesListener() self.ges_events = { TapForward = { GestureRange:new{ ges = "tap", range = Geom:new{ x = Screen:getWidth()*DTAP_ZONE_FORWARD.x, y = Screen:getHeight()*DTAP_ZONE_FORWARD.y, w = Screen:getWidth()*DTAP_ZONE_FORWARD.w, h = Screen:getHeight()*DTAP_ZONE_FORWARD.h, } } }, TapBackward = { GestureRange:new{ ges = "tap", range = Geom:new{ x = Screen:getWidth()*DTAP_ZONE_BACKWARD.x, y = Screen:getHeight()*DTAP_ZONE_BACKWARD.y, w = Screen:getWidth()*DTAP_ZONE_BACKWARD.w, h = Screen:getHeight()*DTAP_ZONE_BACKWARD.h, } } }, Swipe = { GestureRange:new{ ges = "swipe", range = Geom:new{ x = 0, y = 0, w = Screen:getWidth(), h = Screen:getHeight(), } } }, Pan = { GestureRange:new{ ges = "pan", range = Geom:new{ x = 0, y = 0, w = Screen:getWidth(), h = Screen:getHeight(), }, rate = Screen.eink and 4.0 or 10.0, } }, DoubleTapForward = { GestureRange:new{ ges = "double_tap", range = Geom:new{ x = Screen:getWidth()*DDOUBLE_TAP_ZONE_NEXT_CHAPTER.x, y = Screen:getHeight()*DDOUBLE_TAP_ZONE_NEXT_CHAPTER.y, w = Screen:getWidth()*DDOUBLE_TAP_ZONE_NEXT_CHAPTER.w, h = Screen:getHeight()*DDOUBLE_TAP_ZONE_NEXT_CHAPTER.h, } } }, DoubleTapBackward = { GestureRange:new{ ges = "double_tap", range = Geom:new{ x = Screen:getWidth()*DDOUBLE_TAP_ZONE_PREV_CHAPTER.x, y = Screen:getHeight()*DDOUBLE_TAP_ZONE_PREV_CHAPTER.y, w = Screen:getWidth()*DDOUBLE_TAP_ZONE_PREV_CHAPTER.w, h = Screen:getHeight()*DDOUBLE_TAP_ZONE_PREV_CHAPTER.h, } } }, } end function ReaderRolling:onReadSettings(config) local last_xp = config:readSetting("last_xpointer") local last_per = config:readSetting("last_percent") if last_xp then table.insert(self.ui.postInitCallback, function() self.xpointer = last_xp self:gotoXPointer(self.xpointer) -- we have to do a real jump in self.ui.document._document to -- update status information in CREngine. self.ui.document:gotoXPointer(self.xpointer) end) -- we read last_percent just for backward compatibility elseif last_per then table.insert(self.ui.postInitCallback, function() self:gotoPercent(last_per) -- we have to do a real pos change in self.ui.document._document -- to update status information in CREngine. self.ui.document:gotoPos(self.current_pos) self.xpointer = self.ui.document:getXPointer() end) else if self.view.view_mode == "page" then self.ui:handleEvent(Event:new("PageUpdate", 1)) end self.xpointer = self.ui.document:getXPointer() end self.show_overlap_enable = config:readSetting("show_overlap_enable") if self.show_overlap_enable == nil then self.show_overlap_enable = DSHOWOVERLAP end end function ReaderRolling:onSaveSettings() -- remove last_percent config since its deprecated self.ui.doc_settings:saveSetting("last_percent", nil) self.ui.doc_settings:saveSetting("last_xpointer", self.xpointer) self.ui.doc_settings:saveSetting("percent_finished", self:getLastPercent()) self.ui.doc_settings:saveSetting("show_overlap_enable", self.show_overlap_enable) end function ReaderRolling:addToMainMenu(tab_item_table) -- FIXME: repeated code with page overlap menu for readerpaging -- needs to keep only one copy of the logic as for the DRY principle. -- The difference between the two menus is only the enabled func. local page_overlap_menu = { { text_func = function() return self.show_overlap_enable and _("Disable") or _("Enable") end, callback = function() self.show_overlap_enable = not self.show_overlap_enable if not self.show_overlap_enable then self.view:resetDimArea() end end }, } for _, menu_entry in ipairs(self.view:genOverlapStyleMenu()) do table.insert(page_overlap_menu, menu_entry) end table.insert(tab_item_table.typeset, { text = _("Page overlap"), enabled_func = function() return self.view.view_mode ~= "page" end, sub_item_table = page_overlap_menu, }) end function ReaderRolling:getLastPercent() if self.view.view_mode == "page" then return self.current_page / self.old_page else -- FIXME: the calculated percent is not accurate in "scroll" mode. return self.ui.document:getPosFromXPointer( self.ui.document:getXPointer()) / self.doc_height end end function ReaderRolling:onTapForward() self:onGotoViewRel(1) return true end function ReaderRolling:onTapBackward() self:onGotoViewRel(-1) return true end function ReaderRolling:onSwipe(arg, ges) if ges.direction == "west" or ges.direction == "north" then if DCHANGE_WEST_SWIPE_TO_EAST then self:onGotoViewRel(-1) else self:onGotoViewRel(1) end elseif ges.direction == "east" or ges.direction == "south" then if DCHANGE_EAST_SWIPE_TO_WEST then self:onGotoViewRel(1) else self:onGotoViewRel(-1) end end end function ReaderRolling:onPan(arg, ges) if self.view.view_mode == "scroll" then if ges.direction == "north" then self:gotoPos(self.current_pos + ges.distance) elseif ges.direction == "south" then self:gotoPos(self.current_pos - ges.distance) end end return true end function ReaderRolling:onPosUpdate(new_pos) self.current_pos = new_pos self:updateBatteryState() end function ReaderRolling:onPageUpdate(new_page) self.current_page = new_page self:updateBatteryState() end function ReaderRolling:onResume() self:updateBatteryState() end function ReaderRolling:onDoubleTapForward() local visible_page_count = self.ui.document:getVisiblePageCount() local pageno = self.current_page + (visible_page_count > 1 and 1 or 0) self:onGotoPage(self.ui.toc:getNextChapter(pageno, 0)) return true end function ReaderRolling:onDoubleTapBackward() local pageno = self.current_page self:onGotoPage(self.ui.toc:getPreviousChapter(pageno, 0)) return true end function ReaderRolling:onNotCharging() self:updateBatteryState() end function ReaderRolling:onGotoPercent(percent) DEBUG("goto document offset in percent:", percent) self:gotoPercent(percent) return true end function ReaderRolling:onGotoPage(number) if number then self:gotoPage(number) end self.xpointer = self.ui.document:getXPointer() return true end function ReaderRolling:onGotoXPointer(xp) self:gotoXPointer(xp) self.xpointer = xp return true end function ReaderRolling:onGotoViewRel(diff) DEBUG("goto relative screen:", diff, ", in mode: ", self.view.view_mode) if self.view.view_mode == "scroll" then local pan_diff = diff * self.ui.dimen.h if self.show_overlap_enable then if pan_diff > self.overlap then pan_diff = pan_diff - self.overlap elseif pan_diff < -self.overlap then pan_diff = pan_diff + self.overlap end end self:gotoPos(self.current_pos + pan_diff) elseif self.view.view_mode == "page" then local page_count = self.ui.document:getVisiblePageCount() self:gotoPage(self.current_page + diff*page_count) end self.xpointer = self.ui.document:getXPointer() return true end function ReaderRolling:onPanning(args, key) --@TODO disable panning in page view_mode? 22.12 2012 (houqp) local _, dy = unpack(args) DEBUG("key =", key) self:gotoPos(self.current_pos + dy * self.panning_steps.normal) self.xpointer = self.ui.document:getXPointer() return true end function ReaderRolling:onZoom() --@TODO re-read doc_height info after font or lineheight changes 05.06 2012 (houqp) self:updatePos() end --[[ remember to signal this event when the document has been zoomed, font has been changed, or line height has been changed. Note that xpointer should not be changed. --]] function ReaderRolling:onUpdatePos() UIManager:scheduleIn(0.1, function () self:updatePos() end) return true end function ReaderRolling:updatePos() -- reread document height self.ui.document:_readMetadata() -- update self.current_pos if the height of document has been changed. local new_height = self.ui.document.info.doc_height local new_page = self.ui.document.info.number_of_pages if self.old_doc_height ~= new_height or self.old_page ~= new_page then self:gotoXPointer(self.xpointer) self.old_doc_height = new_height self.old_page = new_page self.ui:handleEvent(Event:new("UpdateToc")) end UIManager.repaint_all = true end --[[ switching screen mode should not change current page number --]] function ReaderRolling:onChangeViewMode() self.ui.document:_readMetadata() self.old_doc_height = self.ui.document.info.doc_height self.old_page = self.ui.document.info.number_of_pages self.ui:handleEvent(Event:new("UpdateToc")) if self.xpointer then self:gotoXPointer(self.xpointer) else table.insert(self.ui.postInitCallback, function() self:gotoXPointer(self.xpointer) end) end return true end function ReaderRolling:onRedrawCurrentView() if self.view.view_mode == "page" then self.ui:handleEvent(Event:new("PageUpdate", self.current_page)) else self.ui:handleEvent(Event:new("PosUpdate", self.current_pos)) end return true end function ReaderRolling:onSetDimensions(dimen) -- update listening according to new screen dimen if Device:isTouchDevice() then self:initGesListener() end self.ui.document:setViewDimen(Screen:getSize()) end function ReaderRolling:onChangeScreenMode(mode) self.ui:handleEvent(Event:new("SetScreenMode", mode)) self.ui.document:setViewDimen(Screen:getSize()) self:onChangeViewMode() self:onUpdatePos() end --[[ PosUpdate event is used to signal other widgets that pos has been changed. --]] function ReaderRolling:gotoPos(new_pos) if new_pos == self.current_pos then return end if new_pos < 0 then new_pos = 0 end if new_pos > self.doc_height then new_pos = self.doc_height end -- adjust dim_area according to new_pos if self.view.view_mode ~= "page" and self.show_overlap_enable then local panned_step = new_pos - self.current_pos self.view.dim_area.x = 0 self.view.dim_area.h = self.ui.dimen.h - math.abs(panned_step) self.view.dim_area.w = self.ui.dimen.w if panned_step < 0 then self.view.dim_area.y = self.ui.dimen.h - self.view.dim_area.h elseif panned_step > 0 then self.view.dim_area.y = 0 end end self.ui:handleEvent(Event:new("PosUpdate", new_pos)) end function ReaderRolling:gotoPercent(new_percent) self:gotoPos(new_percent * self.doc_height / 10000) end function ReaderRolling:gotoPage(new_page) self.ui.document:gotoPage(new_page) self.ui:handleEvent(Event:new("PageUpdate", self.ui.document:getCurrentPage())) end function ReaderRolling:gotoXPointer(xpointer) if self.view.view_mode == "page" then self:gotoPage(self.ui.document:getPageFromXPointer(xpointer)) else self:gotoPos(self.ui.document:getPosFromXPointer(xpointer)) end end --[[ currently we don't need to get page links on each page/pos update since we can check link on the fly when tapping on the screen --]] function ReaderRolling:updatePageLink() DEBUG("update page link") local links = self.ui.document:getPageLinks() self.view.links = links end function ReaderRolling:updateBatteryState() DEBUG("update battery state") if self.view.view_mode == "page" then local powerd = Device:getPowerDevice() local state = powerd:isCharging() and -1 or powerd:getCapacity() if state then self.ui.document:setBatteryState(state) end end end return ReaderRolling