renun/koreader
1
0
Fork 0
mirror of https://github.com/koreader/koreader.git synced 2025-08-10 00:52:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Text editor plugin, InputDialog enhancements (#4135)

Browse Source 
This plugin mostly sets up a "Text editor>" submenu, that allows
browsing files, creating a new file, and managing a history of
previously opened file for easier re-opening.
It restore previous scroll and cursor positions on re-opening.
Additional "Check lua" syntax button is added when editing
a .lua file, and prevent saving if errors.
The text editing is mainly provided by the enhanced InputDialog.

InputDialog: added a few more options, the main one being
'save_callback', which will add a Save and Close buttons
and manage saving/discarding/exiting.
If "fullscreen" and "add_nav_bar", will add a show/hide keyboard
button to it.
Moved the preset buttons setup code in their own InputDialog
methods for clarity of the main init code.
Buttons are now enabled/disabled depending on context for feedback
(eg: Save is disabled as long as text has not been modified).

Added util.checkLuaSyntax(lua_string), might be useful elsewhere.
This commit is contained in:
poire-z
2018-08-06 21:16:30 +02:00
committed by GitHub
parent 1d18b01cf7
commit 6e35e683dd
11 changed files with 927 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

432
frontend/ui/widget/inputdialog.lua
View File

@@ -46,6 +46,35 @@ To get a full screen text editor, use:
add_scroll_buttons = true,
add_nav_bar = true,
To add |Save|Close| buttons, use:
save_callback = function(content, closing)
...deal with the edited content...
if closing then
UIManager:nextTick( stuff to do when InputDialog closed if any )
end
return nil -- sucess, default notification shown
return true, success_notif_text
return false, error_infomsg_text
end
To additionally add a Reset button and have |Reset|Save|Close|, use:
reset_callback = function()
return original_content -- success
return original_content, success_notif_text
return nil, error_infomsg_text
end
If you don't need more buttons than these, use these options for consistency
between dialogs, and don't provide any buttons.
Text used on these buttons and their messages and notifications can be
changed by providing alternative text with these additional options:
reset_button_text
save_button_text
close_button_text
close_unsaved_confirm_text
close_cancel_button_text
close_discard_button_text
close_save_button_text
close_discarded_notif_text
If it would take the user more than half a minute to recover from a mistake,
a "Cancel" button <em>must</em> be added to the dialog. The cancellation button
should be kept on the left and the button executing the action on the right.
@@ -63,10 +92,13 @@ local Device = require("device")
local Font = require("ui/font")
local FrameContainer = require("ui/widget/container/framecontainer")
local Geom = require("ui/geometry")
local InfoMessage = require("ui/widget/infomessage")
local InputContainer = require("ui/widget/container/inputcontainer")
local InputText = require("ui/widget/inputtext")
local LineWidget = require("ui/widget/linewidget")
local MovableContainer = require("ui/widget/container/movablecontainer")
local MultiConfirmBox = require("ui/widget/multiconfirmbox")
local Notification = require("ui/widget/notification")
local RenderText = require("ui/rendertext")
local Size = require("ui/size")
local TextBoxWidget = require("ui/widget/textboxwidget")
@@ -75,6 +107,7 @@ local UIManager = require("ui/uimanager")
local VerticalGroup = require("ui/widget/verticalgroup")
local VerticalSpan = require("ui/widget/verticalspan")
local Screen = Device.screen
local _ = require("gettext")
local InputDialog = InputContainer:new{
is_always_active = true,
@@ -85,13 +118,33 @@ local InputDialog = InputContainer:new{
buttons = nil,
input_type = nil,
enter_callback = nil,
readonly = false, -- don't allow editing, will not show keyboard
allow_newline = false, -- allow entering new lines (this disables any enter_callback)
cursor_at_end = true, -- starts with cursor at end of text, ready for appending
fullscreen = false, -- adjust to full screen minus keyboard
condensed = false, -- true will prevent adding air and balance between elements
add_scroll_buttons = false, -- add scroll Up/Down buttons to first row of buttons
add_nav_bar = false, -- append a row of page navigation buttons
-- note that the text widget can be scrolled with Swipe North/South even when no button
-- note that the text widget can be scrolled with Swipe North/South even when no button
keyboard_hidden = false, -- start with keyboard hidden in full fullscreen mode
-- needs add_nav_bar to have a Show keyboard button to get it back
-- If save_callback provided, a Save and a Close buttons will be added to the first row
-- if reset_callback provided, a Reset button will be added (before Save) to the first row
save_callback = nil, -- Called with the input text content when Save (and true as 2nd arg
-- if closing, false if non-closing Save).
-- Should return nil or true on success, false on failure.
-- (This save_callback can do some syntax check before saving)
reset_callback = nil, -- Called with no arg, should return the original content on success,
-- nil on failure.
-- Both these callbacks can return a string as a 2nd return value.
-- This string is then shown:
-- - on success: as the notification text instead of the default one
-- - on failure: in an InfoMessage
-- For use by TextEditor plugin:
view_pos_callback = nil, -- Called with no arg to get initial top_line_num/charpos,
-- called with (top_line_num, charpos) to give back position on close.
-- movable = true, -- set to false if movable gestures conflicts with subwidgets gestures
-- for now, too much conflicts between InputText and MovableContainer, and
@@ -116,6 +169,15 @@ local InputDialog = InputContainer:new{
input_margin = Size.margin.default,
button_padding = Size.padding.default,
border_size = Size.border.window,
-- for internal use
_text_modified = false, -- previous known modified status
_top_line_num = nil,
_charpos = nil,
_buttons_edit_callback = nil,
_buttons_scroll_callback = nil,
_buttons_backup_done = false,
_buttons_backup = nil,
}
function InputDialog:init()
@@ -123,6 +185,7 @@ function InputDialog:init()
self.movable = false
self.border_size = 0
self.width = Screen:getWidth() - 2*self.border_size
self.covers_fullscreen = true -- hint for UIManager:_repaint()
else
self.width = self.width or Screen:getWidth() * 0.8
end
@@ -131,6 +194,9 @@ function InputDialog:init()
else
self.text_width = self.text_width or self.width * 0.9
end
if self.readonly then -- hide keyboard if we can't edit
self.keyboard_hidden = true
end
-- Title & description
local title_width = RenderText:sizeUtf8Text(0, self.width,
@@ -142,7 +208,7 @@ function InputDialog:init()
self.title = RenderText:getSubTextByWidth(self.title, self.title_face,
self.width - indicator_w, true) .. indicator
end
self.title = FrameContainer:new{
self.title_widget = FrameContainer:new{
padding = self.title_padding,
margin = self.title_margin,
bordersize = 0,
@@ -191,54 +257,19 @@ function InputDialog:init()
end
-- Buttons
if self.add_nav_bar then
if not self.buttons then
self.buttons = {}
end
local nav_bar = {}
table.insert(self.buttons, nav_bar)
table.insert(nav_bar, {
text = "⇱",
callback = function()
self._input_widget:scrollToTop()
end,
})
table.insert(nav_bar, {
text = "⇲",
callback = function()
self._input_widget:scrollToBottom()
end,
})
table.insert(nav_bar, {
text = "△",
callback = function()
self._input_widget:scrollUp()
end,
})
table.insert(nav_bar, {
text = "▽",
callback = function()
self._input_widget:scrollDown()
end,
})
elseif self.add_scroll_buttons then
if not self.buttons then
self.buttons = {{}}
end
-- Add them to the end of first row
table.insert(self.buttons[1], {
text = "△",
callback = function()
self._input_widget:scrollUp()
end,
})
table.insert(self.buttons[1], {
text = "▽",
callback = function()
self._input_widget:scrollDown()
end,
})
-- In case of re-init(), keep backup of original buttons and restore them
self:_backupRestoreButtons()
-- If requested, add predefined buttons alongside provided ones
if self.save_callback then
-- If save_callback provided, adds (Reset) / Save / Close buttons
self:_addSaveCloseButtons()
end
if self.add_nav_bar then -- Home / End / Up / Down buttons
self:_addScrollButtons(true)
elseif self.add_scroll_buttons then -- Up / Down buttons
self:_addScrollButtons(false)
end
-- Buttons Table
self.button_table = ButtonTable:new{
width = self.width - 2*self.button_padding,
button_font_face = "cfont",
@@ -269,12 +300,15 @@ function InputDialog:init()
local text_height = input_widget:getTextHeight()
local line_height = input_widget:getLineHeight()
local input_pad_height = input_widget:getSize().h - text_height
local keyboard_height = input_widget:getKeyboardDimen().h
local keyboard_height = 0
if not self.keyboard_hidden then
keyboard_height = input_widget:getKeyboardDimen().h
end
input_widget:free()
-- Find out available height
local available_height = Screen:getHeight()
- 2*self.border_size
- self.title:getSize().h
- self.title_widget:getSize().h
- self.title_bar:getSize().h
- self.description_widget:getSize().h
- vspan_before_input_text:getSize().h
@@ -297,6 +331,11 @@ function InputDialog:init()
self.text_height = text_height
end
end
if self.view_pos_callback then
-- Get initial cursor and top line num from callback
-- (will work in case of re-init as these are saved by onClose()
self._top_line_num, self._charpos = self.view_pos_callback()
end
self._input_widget = InputText:new{
text = self.input,
hint = self.input_hint,
@@ -317,9 +356,15 @@ function InputDialog:init()
end
end
end,
edit_callback = self._buttons_edit_callback, -- nil if no Save/Close buttons
scroll_callback = self._buttons_scroll_callback, -- nil if no Nav or Scroll buttons
scroll = true,
cursor_at_end = self.cursor_at_end,
readonly = self.readonly,
parent = self,
is_text_edited = self._text_modified,
top_line_num = self._top_line_num,
charpos = self._charpos,
}
if self.allow_newline then -- remove any enter_callback
self._input_widget.enter_callback = nil
@@ -328,6 +373,15 @@ function InputDialog:init()
--little hack to piggyback on the layout of the button_table to handle the new InputText
table.insert(self.button_table.layout, 1, {self._input_widget})
end
-- Complementary setup for some of our added buttons
if self.save_callback then
local save_button = self.button_table:getButtonById("save")
if self.readonly then
save_button:setText(_("Read only"), save_button.width)
elseif not self._input_widget:isTextEditable() then
save_button:setText(_("Not editable"), save_button.width)
end
end
-- Final widget
self.dialog_frame = FrameContainer:new{
@@ -338,7 +392,7 @@ function InputDialog:init()
background = Blitbuffer.COLOR_WHITE,
VerticalGroup:new{
align = "left",
self.title,
self.title_widget,
self.title_bar,
self.description_widget,
vspan_before_input_text,
@@ -359,10 +413,12 @@ function InputDialog:init()
self.dialog_frame,
}
end
local keyboard_height = self.keyboard_hidden and 0
or self._input_widget:getKeyboardDimen().h
self[1] = CenterContainer:new{
dimen = Geom:new{
w = Screen:getWidth(),
h = Screen:getHeight() - self._input_widget:getKeyboardDimen().h,
h = Screen:getHeight() - keyboard_height,
},
frame
}
@@ -407,11 +463,279 @@ function InputDialog:onCloseWidget()
end
function InputDialog:onShowKeyboard()
self._input_widget:onShowKeyboard()
if not self.readonly and not self.keyboard_hidden then
self._input_widget:onShowKeyboard()
end
end
function InputDialog:onClose()
-- Remember current view & position in case of re-init
self._top_line_num = self._input_widget.top_line_num
self._charpos = self._input_widget.charpos
if self.view_pos_callback then
-- Give back top line num and cursor position
self.view_pos_callback(self._top_line_num, self._charpos)
end
self._input_widget:onCloseKeyboard()
end
function InputDialog:refreshButtons()
-- Using what ought to be enough:
-- return "ui", self.button_table.dimen
-- causes 2 non-intersecting refreshes (because if our buttons
-- change, the text widget did) that may sometimes cause
-- the button_table to become white.
-- Safer to refresh the whole widget so the refreshes can
-- be merged into one.
UIManager:setDirty(self, function()
return "ui", self.dialog_frame.dimen
end)
end
function InputDialog:_backupRestoreButtons()
-- In case of re-init(), keep backup of original buttons and restore them
if self._buttons_backup_done then
-- Move backup and override current, and re-create backup from original,
-- to avoid duplicating the copy code)
self.buttons = self._buttons_backup -- restore (we may restore 'nil')
end
if self.buttons then -- (re-)create backup
self._buttons_backup = {} -- deep copy, except for the buttons themselves
for i, row in ipairs(self.buttons) do
if row then
local row_copy = {}
self._buttons_backup[i] = row_copy
for j, b in ipairs(row) do
row_copy[j] = b
end
end
end
end
self._buttons_backup_done = true
end
function InputDialog:_addSaveCloseButtons()
if not self.buttons then
self.buttons = {{}}
end
-- Add them to the end of first row
local row = self.buttons[1]
local button = function(id) -- shortcut for more readable code
return self.button_table:getButtonById(id)
end
-- Callback to enable/disable Reset/Save buttons, for feedback when text modified
self._buttons_edit_callback = function(edited)
if self._text_modified and not edited then
self._text_modified = false
button("save"):disable()
if button("reset") then button("reset"):disable() end
self:refreshButtons()
elseif edited and not self._text_modified then
self._text_modified = true
button("save"):enable()
if button("reset") then button("reset"):enable() end
self:refreshButtons()
end
end
if self.reset_callback then
-- if reset_callback provided, add button to restore
-- test to some previous state
table.insert(row, {
text = self.reset_button_text or _("Reset"),
id = "reset",
enabled = self._text_modified,
callback = function()
-- Wrapped via Trapper, to allow reset_callback to use Trapper
-- to show progress or ask questions while getting original content
require("ui/trapper"):wrap(function()
local content, msg = self.reset_callback()
if content then
self:setInputText(content)
self._buttons_edit_callback(false)
UIManager:show(Notification:new{
text = msg or _("Text reset"),
timeout = 2
})
else -- nil content, assume failure and show msg
if msg ~= false then -- false allows for no InfoMessage
UIManager:show(InfoMessage:new{
text = msg or _("Resetting failed."),
})
end
end
end)
end,
})
end
table.insert(row, {
text = self.save_button_text or _("Save"),
id = "save",
enabled = self._text_modified,
callback = function()
-- Wrapped via Trapper, to allow save_callback to use Trapper
-- to show progress or ask questions while saving
require("ui/trapper"):wrap(function()
if self._text_modified then
local success, msg = self.save_callback(self:getInputText())
if success == false then
if msg ~= false then -- false allows for no InfoMessage
UIManager:show(InfoMessage:new{
text = msg or _("Saving failed."),
})
end
else -- nil or true
self._buttons_edit_callback(false)
UIManager:show(Notification:new{
text = msg or _("Saved"),
timeout = 2
})
end
end
end)
end,
})
table.insert(row, {
text = self.close_button_text or _("Close"),
id = "close",
callback = function()
if self._text_modified then
UIManager:show(MultiConfirmBox:new{
text = self.close_unsaved_confirm_text or _("You have unsaved changes."),
cancel_text = self.close_cancel_button_text or _("Cancel"),
choice1_text = self.close_discard_button_text or _("Discard"),
choice1_callback = function()
UIManager:close(self)
UIManager:show(Notification:new{
text = self.close_discarded_notif_text or _("Changes discarded"),
timeout = 2
})
end,
choice2_text = self.close_save_button_text or _("Save"),
choice2_callback = function()
-- Wrapped via Trapper, to allow save_callback to use Trapper
-- to show progress or ask questions while saving
require("ui/trapper"):wrap(function()
local success, msg = self.save_callback(self:getInputText(), true)
if success == false then
if msg ~= false then -- false allows for no InfoMessage
UIManager:show(InfoMessage:new{
text = msg or _("Saving failed."),
})
end
else -- nil or true
UIManager:close(self)
UIManager:show(Notification:new{
text = msg or _("Saved"),
timeout = 2
})
end
end)
end,
})
else
-- Not modified, exit without any message
UIManager:close(self)
end
end,
})
end
function InputDialog:_addScrollButtons(nav_bar)
local row
if nav_bar then -- Add Home / End / Up / Down buttons as a last row
if not self.buttons then
self.buttons = {}
end
row = {} -- Empty additional buttons row
table.insert(self.buttons, row)
else -- Add the Up / Down buttons to the first row
if not self.buttons then
self.buttons = {{}}
end
row = self.buttons[1]
end
if nav_bar then -- Add the Home & End buttons
-- Also add Keyboard hide/show button if we can
if self.fullscreen and not self.readonly then
table.insert(row, {
text = self.keyboard_hidden and "↑⌨" or "↓⌨",
id = "keyboard",
callback = function()
self.keyboard_hidden = not self.keyboard_hidden
self.input = self:getInputText() -- re-init with up-to-date text
self:onClose() -- will close keyboard and save view position
self:free()
self:init()
if not self.keyboard_hidden then
self:onShowKeyboard()
end
end,
})
end
table.insert(row, {
text = "⇱",
id = "top",
callback = function()
self._input_widget:scrollToTop()
end,
})
table.insert(row, {
text = "⇲",
id = "bottom",
callback = function()
self._input_widget:scrollToBottom()
end,
})
end
-- Add the Up & Down buttons
table.insert(row, {
text = "△",
id = "up",
callback = function()
self._input_widget:scrollUp()
end,
})
table.insert(row, {
text = "▽",
id = "down",
callback = function()
self._input_widget:scrollDown()
end,
})
-- Callback to enable/disable buttons, for at-top/at-bottom feedback
local prev_at_top = false -- Buttons were created enabled
local prev_at_bottom = false
local button = function(id) -- shortcut for more readable code
return self.button_table:getButtonById(id)
end
self._buttons_scroll_callback = function(low, high)
local changed = false
if prev_at_top and low > 0 then
button("up"):enable()
if button("top") then button("top"):enable() end
prev_at_top = false
changed = true
elseif not prev_at_top and low <= 0 then
button("up"):disable()
if button("top") then button("top"):disable() end
prev_at_top = true
changed = true
end
if prev_at_bottom and high < 1 then
button("down"):enable()
if button("bottom") then button("bottom"):enable() end
prev_at_bottom = false
changed = true
elseif not prev_at_bottom and high >= 1 then
button("down"):disable()
if button("bottom") then button("bottom"):disable() end
prev_at_bottom = true
changed = true
end
if changed then
self:refreshButtons()
end
end
end
return InputDialog