averello/koreader-mirror
1
0
Fork 0
mirror of https://github.com/koreader/koreader.git synced 2025-12-13 20:36:53 +01:00
Code Issues Packages Projects Releases Wiki Activity

Highlights: page boxes cache (#12768)

Browse Source
This commit is contained in:
hius07
2024-11-23 14:05:05 +02:00
committed by GitHub
parent c124425ac3
commit 47feaaa1df
3 changed files with 161 additions and 151 deletions
Download Patch File Download Diff File Expand all files Collapse all files

90
frontend/apps/reader/modules/readerhighlight.lua
View File

@@ -1007,104 +1007,26 @@ function ReaderHighlight:onTap(_, ges)
-- ReaderHighlight:clear can only return true if self.hold_pos was set anyway.
local cleared = self.hold_pos and self:clear()
-- We only care about potential taps on existing highlights, not on taps that closed a highlight menu.
if not cleared and ges and self.ui.annotation:hasAnnotations() then
if self.ui.paging then
return self:onTapPageSavedHighlight(ges)
else
return self:onTapXPointerSavedHighlight(ges)
end
end
end
function ReaderHighlight:onTapPageSavedHighlight(ges)
local pages = self.view:getCurrentPageList()
if not cleared and ges and #self.view.highlight.visible_boxes > 0 then
local pos = self.view:screenToPageTransform(ges.pos)
local highlights_tapped = {}
for _, page in ipairs(pages) do
local items, idx_offset = self:getPageSavedHighlights(page)
for i, item in ipairs(items) do
local boxes = self.ui.document:getPageBoxesFromPositions(page, item.pos0, item.pos1)
if boxes then
for __, box in ipairs(boxes) do
if inside_box(pos, box) then
logger.dbg("Tap on highlight")
local hl_i = item.parent or (i + idx_offset) -- parent exists in multi-page highlight only
for _, box in ipairs(self.view.highlight.visible_boxes) do
if inside_box(pos, box.rect) then
if self.select_mode then
if hl_i == self.highlight_idx then
if box.index == self.highlight_idx then
-- tap on the first fragment: abort select mode, clear highlight
self.select_mode = false
self:deleteHighlight(hl_i)
self:deleteHighlight(box.index)
return true
end
else
table.insert(highlights_tapped, hl_i)
break
end
end
end
table.insert(highlights_tapped, box.index)
end
end
end
if #highlights_tapped > 0 then
return self:showChooseHighlightDialog(highlights_tapped)
end
end
function ReaderHighlight:onTapXPointerSavedHighlight(ges)
-- Getting screen boxes is done for each tap on screen (changing pages,
-- showing menu...). We might want to cache these boxes per page (and
-- clear that cache when page layout change or highlights are added
-- or removed).
local pos = self.view:screenToPageTransform(ges.pos)
-- NOTE: By now, pos.page is set, but if a highlight spans across multiple pages,
-- it's stored under the hash of its *starting* point,
-- so we can't just check the current page, hence the giant hashwalk of death...
-- We can't even limit the walk to page <= pos.page,
-- because pos.page isn't super accurate in continuous mode
-- (it's the page number for what's it the topleft corner of the screen,
-- i.e., often a bit earlier)...
-- Even in page mode, it's safer to use pos and ui.dimen.h
-- than pages' xpointers pos, even if ui.dimen.h is a bit
-- larger than pages' heights
local cur_view_top = self.document:getCurrentPos()
local cur_view_bottom
if self.view.view_mode == "page" and self.document:getVisiblePageCount() > 1 then
cur_view_bottom = cur_view_top + 2 * self.ui.dimen.h
else
cur_view_bottom = cur_view_top + self.ui.dimen.h
end
local highlights_tapped = {}
for hl_i, item in ipairs(self.ui.annotation.annotations) do
if item.drawer then
-- document:getScreenBoxesFromPositions() is expensive, so we
-- first check this item is on current page
local start_pos = self.document:getPosFromXPointer(item.pos0)
local end_pos = self.document:getPosFromXPointer(item.pos1)
if start_pos <= cur_view_bottom and end_pos >= cur_view_top then
local boxes = self.ui.document:getScreenBoxesFromPositions(item.pos0, item.pos1, true) -- get_segments=true
if boxes then
for _, box in ipairs(boxes) do
if inside_box(pos, box) then
logger.dbg("Tap on highlight")
if self.select_mode then
if hl_i == self.highlight_idx then
-- tap on the first fragment: abort select mode, clear highlight
self.select_mode = false
self:deleteHighlight(hl_i)
return true
end
else
table.insert(highlights_tapped, hl_i)
break
end
end
end
end
end
end
end
if #highlights_tapped > 0 then
return self:showChooseHighlightDialog(highlights_tapped)
end
end

131
frontend/apps/reader/modules/readerview.lua
View File

@@ -90,6 +90,8 @@ function ReaderView:init()
bbox = nil,
}
self.highlight = {
page_boxes = {}, -- hashmap; boxes in pages, used to draw visited pages in "page" view modes
visible_boxes = nil, -- array; visible boxes in the current page, used by ReaderHighlight:onTap()
lighten_factor = G_reader_settings:readSetting("highlight_lighten_factor", 0.2),
note_mark = G_reader_settings:readSetting("highlight_note_marker"),
temp_drawer = "invert",
@@ -531,33 +533,68 @@ function ReaderView:drawTempHighlight(bb, x, y)
end
function ReaderView:drawSavedHighlight(bb, x, y)
if #self.ui.annotation.annotations == 0 then return end
self.highlight.visible_boxes = {}
if #self.ui.annotation.annotations > 0 then
if self.ui.paging then
return self:drawPageSavedHighlight(bb, x, y)
else
return self:drawXPointerSavedHighlight(bb, x, y)
end
end
end
function ReaderView:drawPageSavedHighlight(bb, x, y)
local do_cache = not self.page_scroll and self.document.configurable.text_wrap == 0
local colorful
local pages = self:getCurrentPageList()
for _, page in ipairs(pages) do
local items = self.ui.highlight:getPageSavedHighlights(page)
for _, item in ipairs(items) do
if self.highlight.page_boxes[page] ~= nil then -- cached
for _, box in ipairs(self.highlight.page_boxes[page]) do
local rect = self:pageToScreenTransform(page, box.rect)
if rect then
table.insert(self.highlight.visible_boxes, box)
self:drawHighlightRect(bb, x, y, rect, box.drawer, box.color, box.draw_mark)
if box.colorful then
colorful = true
end
end
end
else -- not cached
if do_cache then
self.highlight.page_boxes[page] = {}
end
local items, idx_offset = self.ui.highlight:getPageSavedHighlights(page)
for index, item in ipairs(items) do
local boxes = self.document:getPageBoxesFromPositions(page, item.pos0, item.pos1)
if boxes then
local drawer = item.drawer
local color = item.color and Blitbuffer.colorFromName(item.color)
if not colorful and color and not Blitbuffer.isColor8(color) then
colorful = true
end
local draw_note_mark = item.note and self.highlight.note_mark
local draw_note_mark = item.note and true or nil
for _, box in ipairs(boxes) do
local rect = self:pageToScreenTransform(page, box)
if rect then
self:drawHighlightRect(bb, x, y, rect, item.drawer, color, draw_note_mark)
if draw_note_mark and self.highlight.note_mark == "sidemark" then
draw_note_mark = false -- side mark in the first line only
local hl_box = {
index = item.parent or (index + idx_offset), -- index in annotations
rect = box,
drawer = drawer,
color = color,
draw_mark = draw_note_mark,
colorful = colorful,
}
if do_cache then
table.insert(self.highlight.page_boxes[page], hl_box)
end
table.insert(self.highlight.visible_boxes, hl_box)
self:drawHighlightRect(bb, x, y, rect, drawer, color, draw_note_mark)
draw_note_mark = draw_note_mark and false -- side mark in the first line only
else
-- some boxes are not displayed in the currently visible part of the page,
-- the page boxes cannot be cached
do_cache = false
self.highlight.page_boxes[page] = nil
end
end
end
@@ -568,10 +605,21 @@ function ReaderView:drawPageSavedHighlight(bb, x, y)
end
function ReaderView:drawXPointerSavedHighlight(bb, x, y)
-- Getting screen boxes is done for each tap on screen (changing pages,
-- showing menu...). We might want to cache these boxes per page (and
-- clear that cache when page layout change or highlights are added
-- or removed).
local do_cache = self.view_mode == "page"
local colorful
local page = self.document:getCurrentPage()
if self.highlight.page_boxes[page] ~= nil then -- cached
for _, box in ipairs(self.highlight.page_boxes[page]) do
table.insert(self.highlight.visible_boxes, box)
self:drawHighlightRect(bb, x, y, box.rect, box.drawer, box.color, box.draw_mark)
if box.colorful then
colorful = true
end
end
else -- not cached
if do_cache then
self.highlight.page_boxes[page] = {}
end
-- Even in page mode, it's safer to use pos and ui.dimen.h
-- than pages' xpointers pos, even if ui.dimen.h is a bit
-- larger than pages' heights
@@ -582,27 +630,38 @@ function ReaderView:drawXPointerSavedHighlight(bb, x, y)
else
cur_view_bottom = cur_view_top + self.ui.dimen.h
end
local colorful
for _, item in ipairs(self.ui.annotation.annotations) do
for index, item in ipairs(self.ui.annotation.annotations) do
if item.drawer then
-- document:getScreenBoxesFromPositions() is expensive, so we
-- first check if this item is on current page
local start_pos = self.document:getPosFromXPointer(item.pos0)
if start_pos > cur_view_bottom then return colorful end -- this and all next highlights are after the current page
if start_pos > cur_view_bottom then break end -- this and all next highlights are after the current page
local end_pos = self.document:getPosFromXPointer(item.pos1)
if end_pos >= cur_view_top then
local boxes = self.document:getScreenBoxesFromPositions(item.pos0, item.pos1, true) -- get_segments=true
if boxes then
local drawer = item.drawer
local color = item.color and Blitbuffer.colorFromName(item.color)
if not colorful and color and not Blitbuffer.isColor8(color) then
colorful = true
end
local draw_note_mark = item.note and self.highlight.note_mark
local draw_note_mark = item.note and true or nil
for _, box in ipairs(boxes) do
if box.h ~= 0 then
self:drawHighlightRect(bb, x, y, box, item.drawer, color, draw_note_mark)
if draw_note_mark and self.highlight.note_mark == "sidemark" then
draw_note_mark = false -- side mark in the first line only
local hl_box = {
index = index,
rect = box,
drawer = drawer,
color = color,
draw_mark = draw_note_mark,
colorful = colorful,
}
if do_cache then
table.insert(self.highlight.page_boxes[page], hl_box)
end
table.insert(self.highlight.visible_boxes, hl_box)
self:drawHighlightRect(bb, x, y, box, drawer, color, draw_note_mark)
draw_note_mark = draw_note_mark and false -- side mark in the first line only
end
end
end
@@ -662,10 +721,8 @@ function ReaderView:drawHighlightRect(bb, _x, _y, rect, drawer, color, draw_note
elseif drawer == "invert" then
bb:invertRect(x, y, w, h)
end
if draw_note_mark then
if not color then
color = Blitbuffer.COLOR_BLACK
end
if self.highlight.note_mark ~= nil and draw_note_mark ~= nil then
color = color or Blitbuffer.COLOR_BLACK
if self.highlight.note_mark == "underline" then
-- With most annotation styles, we'd risk making this invisible if we used the same color,
-- so, always draw this in black.
@@ -686,10 +743,12 @@ function ReaderView:drawHighlightRect(bb, _x, _y, rect, drawer, color, draw_note
bb:paintRectRGB32(note_mark_pos_x, y, self.note_mark_line_w, rect.h, color)
end
elseif self.highlight.note_mark == "sidemark" then
if draw_note_mark then
self.note_mark_sign:paintTo(bb, note_mark_pos_x, y)
end
end
end
end
end
function ReaderView:getPageArea(page, zoom, rotation)
@@ -905,6 +964,7 @@ In combination with zoom to fit page, page height, content height, content or co
})
end
self:resetHighlightBoxesCache()
self.page_scroll = page_scroll
if not page_scroll then
self.document.configurable.page_scroll = 0
@@ -1086,6 +1146,7 @@ end
function ReaderView:onSetViewMode(new_mode)
if new_mode ~= self.view_mode then
self:resetHighlightBoxesCache()
self.view_mode = new_mode
self.document:setViewMode(new_mode)
self.ui:handleEvent(Event:new("ChangeViewMode"))
@@ -1093,6 +1154,32 @@ function ReaderView:onSetViewMode(new_mode)
end
end
function ReaderView:resetHighlightBoxesCache(items)
if items == nil then
self.highlight.page_boxes = {}
else
for _, item in ipairs(items) do
if item.drawer then
local page0, page1
if self.ui.rolling then
page0 = self.document:getPageFromXPointer(item.pos0)
page1 = self.document:getPageFromXPointer(item.pos1)
else
page0 = item.pos0.page
page1 = item.pos1.page
end
for page = page0, page1 do
self.highlight.page_boxes[page] = nil
end
end
end
end
end
ReaderView.onReflowUpdated = ReaderView.resetHighlightBoxesCache
ReaderView.onDocumentRerendered = ReaderView.resetHighlightBoxesCache
ReaderView.onAnnotationsModified = ReaderView.resetHighlightBoxesCache
function ReaderView:onPageGapUpdate(page_gap)
self.page_gap.height = Screen:scaleBySize(page_gap)
Notification:notify(T(_("Page gap set to %1."), optionsutil.formatFlexSize(page_gap)))

1
spec/unit/readerhighlight_spec.lua
View File

@@ -66,6 +66,7 @@ describe("Readerhighlight module", function()
readerui.highlight:saveHighlight()
readerui.highlight:clear()
UIManager:close(readerui.highlight.highlight_dialog)
readerui:paintTo(Screen.bb, 0, 0)
readerui.highlight:onTap(nil, { pos = pos2 })
assert.truthy(readerui.highlight.edit_highlight_dialog)
UIManager:close(readerui.highlight.edit_highlight_dialog)