koreader · NiLuJe · Oct 29, 2022 · Oct 27, 2022 · Oct 27, 2022 · Oct 27, 2022
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -29,6 +29,7 @@ You can upload the whole `crash.log` file (zipped if necessary) on GitHub by dra
 
 If your issue doesn't directly concern a Lua crash, we'll quite likely need you to reproduce the issue with *verbose* debug logging enabled before providing the logs to us.
 To do so, from the file manager, go to [Tools] → More tools → Developer options, and tick both `Enable debug logging` and `Enable verbose debug logging`.
+You'll need to restart KOReader after toggling these on.
 
 If you instead opt to inline it, please do so behind a spoiler tag:
 <details>

diff --git a/base b/base
diff --git a/frontend/apps/filemanager/filemanager.lua b/frontend/apps/filemanager/filemanager.lua
@@ -463,9 +463,9 @@ function FileManager:setupLayout()
     }
 
     if Device:hasKeys() then
-        self.key_events.Home = { {"Home"}, doc = "go home" }
+        self.key_events.Home = { { "Home" } }
         -- Override the menu.lua way of handling the back key
-        self.file_chooser.key_events.Back = { {Device.input.group.Back}, doc = "go back" }
+        self.file_chooser.key_events.Back = { { Device.input.group.Back } }
         if not Device:hasFewKeys() then
             -- Also remove the handler assigned to the "Back" key by menu.lua
             self.file_chooser.key_events.Close = nil

diff --git a/frontend/apps/filemanager/filemanagermenu.lua b/frontend/apps/filemanager/filemanagermenu.lua
@@ -49,9 +49,7 @@ function FileManagerMenu:init()
     self.registered_widgets = {}
 
     if Device:hasKeys() then
-        self.key_events = {
-            ShowMenu = { { "Menu" }, doc = "show menu" },
-        }
+        self.key_events.ShowMenu = { { "Menu" } }
     end
     self.activation_menu = G_reader_settings:readSetting("activate_menu")
     if self.activation_menu == nil then

diff --git a/frontend/apps/reader/modules/readerback.lua b/frontend/apps/reader/modules/readerback.lua
@@ -21,7 +21,7 @@ local ReaderBack = EventListener:extend{
 
 function ReaderBack:init()
     if Device:hasKeys() then
-        self.ui.key_events.Back = { {Device.input.group.Back}, doc = "Reader back" }
+        self.ui.key_events.Back = { { Device.input.group.Back } }
     end
     -- Regular function wrapping our method, to avoid re-creating
     -- an anonymous function at each page turn

diff --git a/frontend/apps/reader/modules/readerbookmark.lua b/frontend/apps/reader/modules/readerbookmark.lua
@@ -38,11 +38,7 @@ local ReaderBookmark = InputContainer:extend{
 
 function ReaderBookmark:init()
     if Device:hasKeyboard() then
-        self.key_events = {
-            ShowBookmark = {
-                { "B" },
-                doc = "show bookmarks" },
-        }
+        self.key_events.ShowBookmark = { { "B" } }
     end
 
     if G_reader_settings:hasNot("bookmarks_items_per_page") then

diff --git a/frontend/apps/reader/modules/readerconfig.lua b/frontend/apps/reader/modules/readerconfig.lua
@@ -20,9 +20,7 @@ function ReaderConfig:init()
     self.configurable:loadDefaults(self.options)
 
     if Device:hasKeys() then
-        self.key_events = {
-            ShowConfigMenu = { {{"Press","AA"}}, doc = "show config dialog" },
-        }
+        self.key_events.ShowConfigMenu = { { { "Press", "AA" } } }
     end
     self:initGesListener()
     if G_reader_settings:has("activate_menu") then

diff --git a/frontend/apps/reader/modules/readerfont.lua b/frontend/apps/reader/modules/readerfont.lua
@@ -34,15 +34,17 @@ function ReaderFont:init()
     if Device:hasKeyboard() then
         -- add shortcut for keyboard
         self.key_events = {
-            ShowFontMenu = { {"F"}, doc = "show font menu" },
+            ShowFontMenu = { { "F" } },
             IncreaseSize = {
                 { "Shift", Input.group.PgFwd },
-                doc = "increase font size",
-                event = "ChangeSize", args = 0.5 },
+                event = "ChangeSize",
+                args = 0.5
+            },
             DecreaseSize = {
                 { "Shift", Input.group.PgBack },
-                doc = "decrease font size",
-                event = "ChangeSize", args = -0.5 },
+                event = "ChangeSize",
+                args = -0.5
+            },
         }
     end
     -- Build face_table for menu

diff --git a/frontend/apps/reader/modules/readerhighlight.lua b/frontend/apps/reader/modules/readerhighlight.lua
@@ -55,19 +55,19 @@ function ReaderHighlight:init()
     if Device:hasDPad() then
         -- Used for text selection with dpad/keys
         local QUICK_INDICTOR_MOVE = true
-        self.key_events.StopHighlightIndicator = { {Device.input.group.Back}, doc = "Stop non-touch highlight", args = true } -- true: clear highlight selection
-        self.key_events.UpHighlightIndicator = { {"Up"}, doc = "move indicator up", event = "MoveHighlightIndicator", args = {0, -1} }
-        self.key_events.DownHighlightIndicator = { {"Down"}, doc = "move indicator down", event = "MoveHighlightIndicator", args = {0, 1} }
+        self.key_events.StopHighlightIndicator  = { { Device.input.group.Back }, args = true } -- true: clear highlight selection
+        self.key_events.UpHighlightIndicator    = { { "Up" },    event = "MoveHighlightIndicator", args = {0, -1} }
+        self.key_events.DownHighlightIndicator  = { { "Down" },  event = "MoveHighlightIndicator", args = {0, 1} }
         -- let FewKeys device can move indicator left
-        self.key_events.LeftHighlightIndicator = { {"Left"}, doc = "move indicator left", event = "MoveHighlightIndicator", args = {-1, 0} }
-        self.key_events.RightHighlightIndicator = { {"Right"}, doc = "move indicator right", event = "MoveHighlightIndicator", args = {1, 0} }
-        self.key_events.HighlightPress = { {"Press"}, doc = "highlight start or end" }
+        self.key_events.LeftHighlightIndicator  = { { "Left" },  event = "MoveHighlightIndicator", args = {-1, 0} }
+        self.key_events.RightHighlightIndicator = { { "Right" }, event = "MoveHighlightIndicator", args = {1, 0} }
+        self.key_events.HighlightPress          = { { "Press" } }
         if Device:hasKeys() then
-            self.key_events.QuickUpHighlightIndicator = { {"Shift", "Up"}, doc = "quick move indicator up", event = "MoveHighlightIndicator", args = {0, -1, QUICK_INDICTOR_MOVE} }
-            self.key_events.QuickDownHighlightIndicator = { {"Shift", "Down"}, doc = "quick move indicator down", event = "MoveHighlightIndicator", args = {0, 1, QUICK_INDICTOR_MOVE} }
-            self.key_events.QuickLeftHighlightIndicator = { {"Shift", "Left"}, doc = "quick move indicator left", event = "MoveHighlightIndicator", args = {-1, 0, QUICK_INDICTOR_MOVE} }
-            self.key_events.QuickRightHighlightIndicator = { {"Shift", "Right"}, doc = "quick move indicator right", event = "MoveHighlightIndicator", args = {1, 0, QUICK_INDICTOR_MOVE} }
-            self.key_events.StartHighlightIndicator = { {"H"}, doc = "start non-touch highlight" }
+            self.key_events.QuickUpHighlightIndicator    = { { "Shift", "Up" },    event = "MoveHighlightIndicator", args = {0, -1, QUICK_INDICTOR_MOVE} }
+            self.key_events.QuickDownHighlightIndicator  = { { "Shift", "Down" },  event = "MoveHighlightIndicator", args = {0, 1, QUICK_INDICTOR_MOVE} }
+            self.key_events.QuickLeftHighlightIndicator  = { { "Shift", "Left" },  event = "MoveHighlightIndicator", args = {-1, 0, QUICK_INDICTOR_MOVE} }
+            self.key_events.QuickRightHighlightIndicator = { { "Shift", "Right" }, event = "MoveHighlightIndicator", args = {1, 0, QUICK_INDICTOR_MOVE} }
+            self.key_events.StartHighlightIndicator      = { { "H" } }
         end
     end
 
@@ -233,8 +233,8 @@ function ReaderHighlight:init()
 end
 
 function ReaderHighlight:setupTouchZones()
-    -- deligate gesture listener to readerui
-    self.ges_events = {}
+    -- delegate gesture listener to readerui
+    self.ges_events = nil
     self.onGesture = nil
 
     if not Device:isTouchDevice() then return end

diff --git a/frontend/apps/reader/modules/readerlink.lua b/frontend/apps/reader/modules/readerlink.lua
@@ -27,24 +27,23 @@ local ReaderLink = InputContainer:extend{
 
 function ReaderLink:init()
     if Device:hasKeys() then
-        self.key_events.SelectNextPageLink = {
-            {"Tab" },
-            doc = "select next page link",
-            event = "SelectNextPageLink",
-        }
-        self.key_events.SelectPrevPageLink = {
-            {"Shift", "Tab" },
-            {"Sym", "Tab" }, -- Right Shift + Tab
-            doc = "select previous page link",
-            event = "SelectPrevPageLink",
-        }
-        self.key_events.GotoSelectedPageLink = {
-            { "Press" },
-            doc = "go to selected page link",
-            event = "GotoSelectedPageLink",
+        self.key_events = {
+            SelectNextPageLink = {
+                { "Tab" },
+                event = "SelectNextPageLink",
+            },
+            SelectPrevPageLink = {
+                { "Shift", "Tab" },
+                { "Sym", "Tab" }, -- Shift or Sym + Tab
+                event = "SelectPrevPageLink",
+            },
+            GotoSelectedPageLink = {
+                { "Press" },
+                event = "GotoSelectedPageLink",
+            },
+            -- "Back" is handled by ReaderBack, which will call our onGoBackLink()
+            -- when G_reader_settings:readSetting("back_in_reader") == "previous_location"
         }
-        -- "Back" is handled by ReaderBack, which will call our onGoBackLink()
-        -- when G_reader_settings:readSetting("back_in_reader") == "previous_location"
     end
     if Device:isTouchDevice() then
         self.ui:registerTouchZones({

diff --git a/frontend/apps/reader/modules/readermenu.lua b/frontend/apps/reader/modules/readermenu.lua
@@ -58,16 +58,16 @@ function ReaderMenu:init()
 
     if Device:hasKeys() then
         if Device:isTouchDevice() then
-            self.key_events.TapShowMenu = { { "Menu" }, doc = "show menu", }
+            self.key_events.TapShowMenu = { { "Menu" } }
             if Device:hasFewKeys() then
-                self.key_events.TapShowMenu = { { { "Menu", "Right" } }, doc = "show menu", }
+                self.key_events.TapShowMenu = { { { "Menu", "Right" } } }
             end
         else
             -- map menu key to only top menu because bottom menu is only
             -- designed for touch devices
-            self.key_events.ShowMenu = { { "Menu" }, doc = "show menu", }
+            self.key_events.ShowMenu = { { "Menu" } }
             if Device:hasFewKeys() then
-                self.key_events.ShowMenu = { { { "Menu", "Right" } }, doc = "show menu", }
+                self.key_events.ShowMenu = { { { "Menu", "Right" } } }
             end
         end
     end
@@ -83,8 +83,8 @@ function ReaderMenu:getPreviousFile()
 end
 
 function ReaderMenu:onReaderReady()
-    -- deligate gesture listener to readerui
-    self.ges_events = {}
+    -- delegate gesture listener to readerui
+    self.ges_events = nil
     self.onGesture = nil
     if not Device:isTouchDevice() then return end
 

diff --git a/frontend/apps/reader/modules/readerpaging.lua b/frontend/apps/reader/modules/readerpaging.lua
@@ -41,60 +41,79 @@ local ReaderPaging = InputContainer:extend{
 }
 
 function ReaderPaging:init()
-    self.key_events = {}
     if Device:hasKeys() then
         self.key_events.GotoNextPage = {
-            { {"RPgFwd", "LPgFwd", "Right" } }, doc = "go to next page",
-            event = "GotoViewRel", args = 1,
+            { { "RPgFwd", "LPgFwd", not Device:hasFewKeys() and "Right" } },
+            event = "GotoViewRel",
+            args = 1,
         }
         self.key_events.GotoPrevPage = {
-            { { "RPgBack", "LPgBack", "Left" } }, doc = "go to previous page",
-            event = "GotoViewRel", args = -1,
+            { { "RPgBack", "LPgBack", not Device:hasFewKeys() and "Left" } },
+            event = "GotoViewRel",
+            args = -1,
         }
-        if Device:hasFewKeys() then
-            table.remove(self.key_events.GotoNextPage[1][1], 3) -- right
-            table.remove(self.key_events.GotoPrevPage[1][1], 3) -- left
-        end
         self.key_events.GotoNextPos = {
-            { {"Down" } }, doc = "go to next position",
-            event = "GotoPosRel", args = 1,
+            { "Down" },
+            event = "GotoPosRel",
+            args = 1,
         }
         self.key_events.GotoPrevPos = {
-            { { "Up" } }, doc = "go to previous position",
-            event = "GotoPosRel", args = -1,
+            { "Up" },
+            event = "GotoPosRel",
+            args = -1,
         }
 
     end
     if Device:hasKeyboard() then
         self.key_events.GotoFirst = {
-            {"1"}, doc = "go to start", event = "GotoPercent", args = 0,
+            { "1" },
+            event = "GotoPercent",
+            args = 0,
         }
         self.key_events.Goto11 = {
-            {"2"}, doc = "go to 11%", event = "GotoPercent", args = 11,
+            { "2" },
+            event = "GotoPercent",
+            args = 11,
         }
         self.key_events.Goto22 = {
-            {"3"}, doc = "go to 22%", event = "GotoPercent", args = 22,
+            { "3" },
+            event = "GotoPercent",
+            args = 22,
         }
         self.key_events.Goto33 = {
-            {"4"}, doc = "go to 33%", event = "GotoPercent", args = 33,
+            { "4" },
+            event = "GotoPercent",
+            args = 33,
         }
         self.key_events.Goto44 = {
-            {"5"}, doc = "go to 44%", event = "GotoPercent", args = 44,
+            { "5" },
+            event = "GotoPercent",
+            args = 44,
         }
         self.key_events.Goto55 = {
-            {"6"}, doc = "go to 55%", event = "GotoPercent", args = 55,
+            { "6" },
+            event = "GotoPercent",
+            args = 55,
         }
         self.key_events.Goto66 = {
-            {"7"}, doc = "go to 66%", event = "GotoPercent", args = 66,
+            { "7" },
+            event = "GotoPercent",
+            args = 66,
         }
         self.key_events.Goto77 = {
-            {"8"}, doc = "go to 77%", event = "GotoPercent", args = 77,
+            { "8" },
+            event = "GotoPercent",
+            args = 77,
         }
         self.key_events.Goto88 = {
-            {"9"}, doc = "go to 88%", event = "GotoPercent", args = 88,
+            { "9" },
+            event = "GotoPercent",
+            args = 88,
         }
         self.key_events.GotoLast = {
-            {"0"}, doc = "go to end", event = "GotoPercent", args = 100,
+            { "0" },
+            event = "GotoPercent",
+            args = 100,
         }
     end
     self.pan_interval = time.s(1 / self.pan_rate)
@@ -106,7 +125,8 @@ function ReaderPaging:onReaderReady()
 end
 
 function ReaderPaging:setupTouchZones()
-    self.ges_events = {}
+    -- delegate gesture listener to readerui
+    self.ges_events = nil
     self.onGesture = nil
     if not Device:isTouchDevice() then return end
 

diff --git a/frontend/apps/reader/modules/readerpanning.lua b/frontend/apps/reader/modules/readerpanning.lua
@@ -17,17 +17,25 @@ function ReaderPanning:init()
         self.key_events = {
             -- these will all generate the same event, just with different arguments
             MoveUp = {
-                { "Up" }, doc = "move visible area up",
-                event = "Panning", args = {0, -1} },
+                { "Up" },
+                event = "Panning",
+                args = {0, -1}
+            },
             MoveDown = {
-                { "Down" }, doc = "move visible area down",
-                event = "Panning", args = {0,  1} },
+                { "Down" },
+                event = "Panning",
+                args = {0,  1}
+            },
             MoveLeft = {
-                { "Left" }, doc = "move visible area left",
-                event = "Panning", args = {-1, 0} },
+                { "Left" },
+                event = "Panning",
+                args = {-1, 0}
+            },
             MoveRight = {
-                { "Right" }, doc = "move visible area right",
-                event = "Panning", args = {1,  0} },
+                { "Right" },
+                event = "Panning",
+                args = {1,  0}
+            },
         }
     end
 end