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

CRe: support for case sensitive and regex search (#7883)

Browse Source 
- bump crengine: findText(): add support for regular
  expression search.
- bump base: add thirdparty/srell/srell.hpp, a C++ library
  that provides Unicode regex support, used by crengine.
- ReaderSearch: with credocuments, add checkboxes for case
  sensitive and regular expression search.
reviewable/pr7947/r1
zwim 3 years ago committed by GitHub
parent 0e60625160
commit 826a765705
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 227 additions and 30 deletions
Show Stats Download Patch File Download Diff File

2
base

@ -1 +1 @@
Subproject commit 844ef1103a2a9eb17e6a9c0d0fbbf069a6d65f76
Subproject commit 93a57fd0e0e2ad4d69f6cc019935053b1405d4fd

238
frontend/apps/reader/modules/readersearch.lua
Unescape Escape View File

@ -1,9 +1,15 @@
local BD = require("ui/bidi")
local ButtonDialog = require("ui/widget/buttondialog")
local CheckButton = require("ui/widget/checkbutton")
local Device = require("device")
local HorizontalGroup = require("ui/widget/horizontalgroup")
local HorizontalSpan = require("ui/widget/horizontalspan")
local InfoMessage = require("ui/widget/infomessage")
local InputContainer = require("ui/widget/container/inputcontainer")
local InputDialog = require("ui/widget/inputdialog")
local Notification = require("ui/widget/notification")
local UIManager = require("ui/uimanager")
local VerticalGroup = require("ui/widget/verticalgroup")
local logger = require("logger")
local _ = require("gettext")
@ -11,6 +17,16 @@ local ReaderSearch = InputContainer:new{
direction = 0, -- 0 for search forward, 1 for search backward
case_insensitive = true, -- default to case insensitive
-- For a regex like [a-z\. ] many many hits are found, maybe the number of chars on a few pages.
-- We don't try to catch them all as this is a reader and not a computer science playground. ;)
-- So if some regex gets more than max_hits a notification will be shown.
-- Increasing max_hits will slow down search for nasty regex. There is no slowdown for friendly
-- regexs like `Max|Moritz` for `One|Two|Three`
-- The speed of the search depends on the regexs. Complex ones might need some time, easy ones
-- go with the speed of light.
-- Setting max_hits higher, does not mean to require more memory. More hits means smaller single hits.
max_hits = 2048, -- maximum hits for search; timinges tested on a Tolino
-- internal: whether we expect results on previous pages
-- (can be different from self.direction, if, from a page in the
-- middle of a book, we search forward from start of book)
@ -21,6 +37,38 @@ function ReaderSearch:init()
self.ui.menu:registerToMainMenu(self)
end
local help_text = [[Regular expressions allow you to search for a matching pattern in a text. The simplest pattern is a simple sequence of characters, such as `James Bond`. There are many different varieties of regular expressions, but we support the ECMAScript syntax. The basics will be explained below.
If you want to search for all occurrences of 'Mister Moore', 'Sir Moore' or 'Alfons Moore' but not for 'Lady Moore'.
Enter 'Mister Moore|Sir Moore|Alfons Moore'.
If your search contains a special character from ^$.*+?()[]{}|\/ you have to put a \ before that character.
Examples:
Words containing 'os' -> '[^ ]+os[^ ]+'
Any single character '.' -> 'r.nge'
Any characters '.*' -> 'J.*s'
Numbers -> '[0-9]+'
Character range -> '[a-f]'
Not a space -> '[^ ]'
A word -> '[^ ]*[^ ]'
Last word in a sentence -> '[^ ]*\.'
Complex expressions may lead to an extremely long search time, in which case not all matches will be shown.
]]
local SRELL_ERROR_CODES = {}
SRELL_ERROR_CODES[102] = _("Wrong escape '\'")
SRELL_ERROR_CODES[103] = _("Back reference does not exist.")
SRELL_ERROR_CODES[104] = _("Mismatching brackets '[]'")
SRELL_ERROR_CODES[105] = _("Mismatched parens '()'")
SRELL_ERROR_CODES[106] = _("Mismatched brace '{}'")
SRELL_ERROR_CODES[107] = _("Invalid Range in '{}'")
SRELL_ERROR_CODES[108] = _("Invalid character range")
SRELL_ERROR_CODES[110] = _("No preceding expression in repetition.")
SRELL_ERROR_CODES[111] = _("Expression too complex, some hits will not be shown.")
SRELL_ERROR_CODES[666] = _("Expression may lead to an extremely long search time.")
function ReaderSearch:addToMainMenu(menu_items)
menu_items.fulltext_search = {
text = _("Fulltext search"),
@ -36,9 +84,11 @@ function ReaderSearch:onShowFulltextSearchInput()
if BD.mirroredUILayout() then
backward_text, forward_text = forward_text, backward_text
end
self.input_dialog = InputDialog:new{
title = _("Enter text to search for"),
input = self.last_search_text,
use_regex_checked = self.use_regex,
case_insensitive_checked = not self.case_insensitive,
buttons = {
{
{
@ -51,8 +101,23 @@ function ReaderSearch:onShowFulltextSearchInput()
text = backward_text,
callback = function()
if self.input_dialog:getInputText() == "" then return end
UIManager:close(self.input_dialog)
self:onShowSearchDialog(self.input_dialog:getInputText(), 1)
self.last_search_text = self.input_dialog:getInputText()
self.use_regex = self.check_button_regex.checked
self.case_insensitive = not self.check_button_case.checked
local regex_error = self.ui.document:checkRegex(self.input_dialog:getInputText())
if self.use_regex and regex_error ~= 0 then
logger.dbg("ReaderSearch: regex error", regex_error, SRELL_ERROR_CODES[regex_error])
local error_message = _("Invalid regular expression")
if SRELL_ERROR_CODES[regex_error] then
error_message = error_message .. ":\n" .. SRELL_ERROR_CODES[regex_error]
else
error_message = error_message .. "."
end
UIManager:show(InfoMessage:new{ text = error_message })
else
UIManager:close(self.input_dialog)
self:onShowSearchDialog(self.input_dialog:getInputText(), 1, self.use_regex, self.case_insensitive)
end
end,
},
{
@ -60,24 +125,90 @@ function ReaderSearch:onShowFulltextSearchInput()
is_enter_default = true,
callback = function()
if self.input_dialog:getInputText() == "" then return end
UIManager:close(self.input_dialog)
self:onShowSearchDialog(self.input_dialog:getInputText(), 0)
self.last_search_text = self.input_dialog:getInputText()
self.use_regex = self.check_button_regex.checked
self.case_insensitive = not self.check_button_case.checked
local regex_error = self.ui.document:checkRegex(self.input_dialog:getInputText())
if self.use_regex and regex_error ~= 0 then
logger.dbg("ReaderSearch: regex error", regex_error, SRELL_ERROR_CODES[regex_error])
local error_message = _("Invalid regular expression")
if SRELL_ERROR_CODES[regex_error] then
error_message = error_message .. ":\n" .. SRELL_ERROR_CODES[regex_error]
else
error_message = error_message .. "."
end
UIManager:show(InfoMessage:new{ text = error_message })
else
UIManager:close(self.input_dialog)
self:onShowSearchDialog(self.input_dialog:getInputText(), 0, self.use_regex, self.case_insensitive)
end
end,
},
},
},
}
-- checkboxes
self.check_button_case = CheckButton:new{
text = _("Case sensitive"),
checked = not self.case_insensitive,
parent = self.input_dialog,
callback = function()
if not self.check_button_case.checked then
self.check_button_case:check()
else
self.check_button_case:unCheck()
end
end,
}
self.check_button_regex = CheckButton:new{
text = _("Regular expression (hold for help)"),
checked = self.use_regex,
parent = self.input_dialog,
callback = function()
if not self.check_button_regex.checked then
self.check_button_regex:check()
else
self.check_button_regex:unCheck()
end
end,
hold_callback = function()
UIManager:show(InfoMessage:new{ text = help_text })
end,
}
local checkbox_shift = math.floor((self.input_dialog.width - self.input_dialog._input_widget.width) / 2 + 0.5)
local check_buttons = HorizontalGroup:new{
HorizontalSpan:new{width = checkbox_shift},
VerticalGroup:new{
align = "left",
self.check_button_case,
self.check_button_regex,
},
}
-- insert check buttons before the regular buttons
local nb_elements = #self.input_dialog.dialog_frame[1]
table.insert(self.input_dialog.dialog_frame[1], nb_elements-1, check_buttons)
UIManager:show(self.input_dialog)
self.input_dialog:onShowKeyboard()
end
function ReaderSearch:onShowSearchDialog(text, direction)
function ReaderSearch:onShowSearchDialog(text, direction, regex, case_insensitive)
local neglect_current_location = false
local current_page
local function isSlowRegex(pattern)
if pattern:find("%[") or pattern:find("%*") or pattern:find("%?") or pattern:find("%.") then
return true
end
return false
end
local do_search = function(search_func, _text, param)
return function()
local no_results = true -- for notification
local res = search_func(self, _text, param)
local res = search_func(self, _text, param, regex, case_insensitive)
if res then
if self.ui.document.info.has_pages then
no_results = false
@ -173,6 +304,23 @@ function ReaderSearch:onShowSearchDialog(text, direction)
-- Keep the LTR order of |< and >|:
from_start_text, from_end_text = BD.ltr(from_end_text), BD.ltr(from_start_text)
end
self.wait_button = ButtonDialog:new{
buttons = {{{ text = "⌛" }}},
}
local function search(func, pattern, param)
if regex and isSlowRegex(pattern) then
return function()
self.wait_button.alpha = 0.75
UIManager:show(self.wait_button)
UIManager:tickAfterNext(function()
do_search(func, pattern, param, regex, case_insensitive)()
UIManager:close(self.wait_button)
end)
end
else
return do_search(func, pattern, param, regex, case_insensitive)
end
end
self.search_dialog = ButtonDialog:new{
-- alpha = 0.7,
buttons = {
@ -180,22 +328,22 @@ function ReaderSearch:onShowSearchDialog(text, direction)
{
text = from_start_text,
vsync = true,
callback = do_search(self.searchFromStart, text),
callback = search(self.searchFromStart, text, nil),
},
{
text = backward_text,
vsync = true,
callback = do_search(self.searchNext, text, 1),
callback = search(self.searchNext, text, 1),
},
{
text = forward_text,
vsync = true,
callback = do_search(self.searchNext, text, 0),
callback = search(self.searchNext, text, 0),
},
{
text = from_end_text,
vsync = true,
callback = do_search(self.searchFromEnd, text),
callback = search(self.searchFromEnd, text, nil),
},
}
},
@ -205,44 +353,82 @@ function ReaderSearch:onShowSearchDialog(text, direction)
UIManager:setDirty(self.dialog, "ui")
end,
}
do_search(self.searchFromCurrent, text, direction)()
UIManager:show(self.search_dialog)
--- @todo regional
UIManager:setDirty(self.dialog, "partial")
if regex and isSlowRegex(text) then
self.wait_button.alpha = nil
UIManager:show(self.wait_button)
UIManager:tickAfterNext(function()
do_search(self.searchFromCurrent, text, direction, regex, case_insensitive)()
UIManager:close(self.wait_button)
UIManager:show(self.search_dialog)
--- @todo regional
UIManager:setDirty(self.dialog, "partial")
end)
else
do_search(self.searchFromCurrent, text, direction, regex, case_insensitive)()
UIManager:show(self.search_dialog)
--- @todo regional
UIManager:setDirty(self.dialog, "partial")
end
return true
end
function ReaderSearch:search(pattern, origin)
-- if regex == true, use regular expression in pattern
-- if case == true or nil, the search is case insensitive
function ReaderSearch:search(pattern, origin, regex, case_insensitive)
logger.dbg("search pattern", pattern)
local direction = self.direction
local case = self.case_insensitive
local page = self.view.state.page
return self.ui.document:findText(pattern, origin, direction, case, page)
if case_insensitive == nil then
case_insensitive = true
end
Device:setIgnoreInput(true)
local retval, words_found = self.ui.document:findText(pattern, origin, direction, case_insensitive, page, regex, self.max_hits)
Device:setIgnoreInput(false)
local regex_retval = self.ui.document:getAndClearRegexSearchError();
if regex_retval ~= 0 then
local error_message
if SRELL_ERROR_CODES[regex_retval] then
error_message = SRELL_ERROR_CODES[regex_retval]
else
error_message = _("Unspecified error")
end
UIManager:show(Notification:new{
text = error_message,
timeout = false,
})
elseif words_found and words_found > self.max_hits then
UIManager:show(Notification:new{
text =_("Too many hits"),
timeout = 4,
})
end
return retval
end
function ReaderSearch:searchFromStart(pattern)
function ReaderSearch:searchFromStart(pattern, _, regex, case_insensitive)
self.direction = 0
self._expect_back_results = true
return self:search(pattern, -1)
return self:search(pattern, -1, regex, case_insensitive)
end
function ReaderSearch:searchFromEnd(pattern)
function ReaderSearch:searchFromEnd(pattern, _, regex, case_insensitive)
self.direction = 1
self._expect_back_results = false
return self:search(pattern, -1)
return self:search(pattern, -1, regex, case_insensitive)
end
function ReaderSearch:searchFromCurrent(pattern, direction)
function ReaderSearch:searchFromCurrent(pattern, direction, regex, case_insensitive)
self.direction = direction
self._expect_back_results = direction == 1
return self:search(pattern, 0)
return self:search(pattern, 0, regex, case_insensitive)
end
-- ignore current page and search next occurrence
function ReaderSearch:searchNext(pattern, direction)
function ReaderSearch:searchNext(pattern, direction, regex, case_insensitive)
self.direction = direction
self._expect_back_results = direction == 1
return self:search(pattern, 1)
return self:search(pattern, 1, regex, case_insensitive)
end
return ReaderSearch

17
frontend/document/credocument.lua
Unescape Escape View File

@ -1242,10 +1242,21 @@ function CreDocument:setBackgroundImage(img_path) -- use nil to unset
self._document:setBackgroundImage(img_path)
end
function CreDocument:findText(pattern, origin, reverse, caseInsensitive)
logger.dbg("CreDocument: find text", pattern, origin, reverse, caseInsensitive)
function CreDocument:checkRegex(pattern)
logger.dbg("CreDocument: check regex ", pattern)
return self._document:checkRegex(pattern)
end
function CreDocument:getAndClearRegexSearchError()
retval = self._document:getAndClearRegexSearchError()
logger.dbg("CreDocument: getAndClearRegexSearchError", retval)
return retval
end
function CreDocument:findText(pattern, origin, reverse, caseInsensitive, page, regex, max_hits)
logger.dbg("CreDocument: find text", pattern, origin, reverse, caseInsensitive, regex, max_hits)
return self._document:findText(
pattern, origin, reverse, caseInsensitive and 1 or 0)
pattern, origin, reverse, caseInsensitive and 1 or 0, regex and 1 or 0, max_hits or 200)
end
function CreDocument:enableInternalHistory(toggle)

Write Preview
Loading…
Cancel
Save