Skip to content

Commit b523c2e

Browse files
NiLuJeNiLuJe
committed
InputContainer: Fall cleanup ;).
Get rid of the doc & seqtext fields, as they are not actually used (nor are they particularly useful, the event handler's name should be pretty self-explanatory). Also, tweak the key_events documentation to highlight the quirks of the API, especially as far as array nesting is involved... Random drive-by cleanup of the declarations of key_events & ges_events to re-use the existing instance object (now that we know they're sane ;p) for tables with a single member (less GC pressure).
1 parent 9b2201a commit b523c2e

73 files changed

Lines changed: 464 additions & 484 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎frontend/apps/filemanager/filemanager.lua‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -463,9 +463,9 @@ function FileManager:setupLayout()
463463
}
464464

465465
if Device:hasKeys() then
466-
self.key_events.Home = { {"Home"}, doc = "go home" }
466+
self.key_events.Home = { { "Home" } }
467467
-- Override the menu.lua way of handling the back key
468-
self.file_chooser.key_events.Back = { {Device.input.group.Back}, doc = "go back" }
468+
self.file_chooser.key_events.Back = { { Device.input.group.Back } }
469469
if not Device:hasFewKeys() then
470470
-- Also remove the handler assigned to the "Back" key by menu.lua
471471
self.file_chooser.key_events.Close = nil

‎frontend/apps/filemanager/filemanagermenu.lua‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,7 @@ function FileManagerMenu:init()
4949
self.registered_widgets = {}
5050

5151
if Device:hasKeys() then
52-
self.key_events = {
53-
ShowMenu = { { "Menu" }, doc = "show menu" },
54-
}
52+
self.key_events.ShowMenu = { { "Menu" } }
5553
end
5654
self.activation_menu = G_reader_settings:readSetting("activate_menu")
5755
if self.activation_menu == nil then

‎frontend/apps/reader/modules/readerback.lua‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ local ReaderBack = EventListener:extend{
2121

2222
function ReaderBack:init()
2323
if Device:hasKeys() then
24-
self.ui.key_events.Back = { {Device.input.group.Back}, doc = "Reader back" }
24+
self.ui.key_events.Back = { { Device.input.group.Back } }
2525
end
2626
-- Regular function wrapping our method, to avoid re-creating
2727
-- an anonymous function at each page turn

‎frontend/apps/reader/modules/readerbookmark.lua‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,7 @@ local ReaderBookmark = InputContainer:extend{
3838

3939
function ReaderBookmark:init()
4040
if Device:hasKeyboard() then
41-
self.key_events = {
42-
ShowBookmark = {
43-
{ "B" },
44-
doc = "show bookmarks" },
45-
}
41+
self.key_events.ShowBookmark = { { "B" } }
4642
end
4743

4844
if G_reader_settings:hasNot("bookmarks_items_per_page") then

‎frontend/apps/reader/modules/readerconfig.lua‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,7 @@ function ReaderConfig:init()
2020
self.configurable:loadDefaults(self.options)
2121

2222
if Device:hasKeys() then
23-
self.key_events = {
24-
ShowConfigMenu = { {{"Press","AA"}}, doc = "show config dialog" },
25-
}
23+
self.key_events.ShowConfigMenu = { { { "Press", "AA" } } }
2624
end
2725
self:initGesListener()
2826
if G_reader_settings:has("activate_menu") then

‎frontend/apps/reader/modules/readerfont.lua‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,17 @@ function ReaderFont:init()
3434
if Device:hasKeyboard() then
3535
-- add shortcut for keyboard
3636
self.key_events = {
37-
ShowFontMenu = { {"F"}, doc = "show font menu" },
37+
ShowFontMenu = { { "F" } },
3838
IncreaseSize = {
3939
{ "Shift", Input.group.PgFwd },
40-
doc = "increase font size",
41-
event = "ChangeSize", args = 0.5 },
40+
event = "ChangeSize",
41+
args = 0.5
42+
},
4243
DecreaseSize = {
4344
{ "Shift", Input.group.PgBack },
44-
doc = "decrease font size",
45-
event = "ChangeSize", args = -0.5 },
45+
event = "ChangeSize",
46+
args = -0.5
47+
},
4648
}
4749
end
4850
-- Build face_table for menu

‎frontend/apps/reader/modules/readerhighlight.lua‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -55,19 +55,19 @@ function ReaderHighlight:init()
5555
if Device:hasDPad() then
5656
-- Used for text selection with dpad/keys
5757
local QUICK_INDICTOR_MOVE = true
58-
self.key_events.StopHighlightIndicator = { {Device.input.group.Back}, doc = "Stop non-touch highlight", args = true } -- true: clear highlight selection
59-
self.key_events.UpHighlightIndicator = { {"Up"}, doc = "move indicator up", event = "MoveHighlightIndicator", args = {0, -1} }
60-
self.key_events.DownHighlightIndicator = { {"Down"}, doc = "move indicator down", event = "MoveHighlightIndicator", args = {0, 1} }
58+
self.key_events.StopHighlightIndicator = { { Device.input.group.Back }, args = true } -- true: clear highlight selection
59+
self.key_events.UpHighlightIndicator = { { "Up" }, event = "MoveHighlightIndicator", args = {0, -1} }
60+
self.key_events.DownHighlightIndicator = { { "Down" }, event = "MoveHighlightIndicator", args = {0, 1} }
6161
-- let FewKeys device can move indicator left
62-
self.key_events.LeftHighlightIndicator = { {"Left"}, doc = "move indicator left", event = "MoveHighlightIndicator", args = {-1, 0} }
63-
self.key_events.RightHighlightIndicator = { {"Right"}, doc = "move indicator right", event = "MoveHighlightIndicator", args = {1, 0} }
64-
self.key_events.HighlightPress = { {"Press"}, doc = "highlight start or end" }
62+
self.key_events.LeftHighlightIndicator = { { "Left" }, event = "MoveHighlightIndicator", args = {-1, 0} }
63+
self.key_events.RightHighlightIndicator = { { "Right" }, event = "MoveHighlightIndicator", args = {1, 0} }
64+
self.key_events.HighlightPress = { { "Press" } }
6565
if Device:hasKeys() then
66-
self.key_events.QuickUpHighlightIndicator = { {"Shift", "Up"}, doc = "quick move indicator up", event = "MoveHighlightIndicator", args = {0, -1, QUICK_INDICTOR_MOVE} }
67-
self.key_events.QuickDownHighlightIndicator = { {"Shift", "Down"}, doc = "quick move indicator down", event = "MoveHighlightIndicator", args = {0, 1, QUICK_INDICTOR_MOVE} }
68-
self.key_events.QuickLeftHighlightIndicator = { {"Shift", "Left"}, doc = "quick move indicator left", event = "MoveHighlightIndicator", args = {-1, 0, QUICK_INDICTOR_MOVE} }
69-
self.key_events.QuickRightHighlightIndicator = { {"Shift", "Right"}, doc = "quick move indicator right", event = "MoveHighlightIndicator", args = {1, 0, QUICK_INDICTOR_MOVE} }
70-
self.key_events.StartHighlightIndicator = { {"H"}, doc = "start non-touch highlight" }
66+
self.key_events.QuickUpHighlightIndicator = { { "Shift", "Up" }, event = "MoveHighlightIndicator", args = {0, -1, QUICK_INDICTOR_MOVE} }
67+
self.key_events.QuickDownHighlightIndicator = { { "Shift", "Down" }, event = "MoveHighlightIndicator", args = {0, 1, QUICK_INDICTOR_MOVE} }
68+
self.key_events.QuickLeftHighlightIndicator = { { "Shift", "Left" }, event = "MoveHighlightIndicator", args = {-1, 0, QUICK_INDICTOR_MOVE} }
69+
self.key_events.QuickRightHighlightIndicator = { { "Shift", "Right" }, event = "MoveHighlightIndicator", args = {1, 0, QUICK_INDICTOR_MOVE} }
70+
self.key_events.StartHighlightIndicator = { { "H" } }
7171
end
7272
end
7373

@@ -233,8 +233,8 @@ function ReaderHighlight:init()
233233
end
234234

235235
function ReaderHighlight:setupTouchZones()
236-
-- deligate gesture listener to readerui
237-
self.ges_events = {}
236+
-- delegate gesture listener to readerui
237+
self.ges_events = nil
238238
self.onGesture = nil
239239

240240
if not Device:isTouchDevice() then return end

‎frontend/apps/reader/modules/readerlink.lua‎

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -27,24 +27,23 @@ local ReaderLink = InputContainer:extend{
2727

2828
function ReaderLink:init()
2929
if Device:hasKeys() then
30-
self.key_events.SelectNextPageLink = {
31-
{"Tab" },
32-
doc = "select next page link",
33-
event = "SelectNextPageLink",
34-
}
35-
self.key_events.SelectPrevPageLink = {
36-
{"Shift", "Tab" },
37-
{"Sym", "Tab" }, -- Right Shift + Tab
38-
doc = "select previous page link",
39-
event = "SelectPrevPageLink",
40-
}
41-
self.key_events.GotoSelectedPageLink = {
42-
{ "Press" },
43-
doc = "go to selected page link",
44-
event = "GotoSelectedPageLink",
30+
self.key_events = {
31+
SelectNextPageLink = {
32+
{ "Tab" },
33+
event = "SelectNextPageLink",
34+
},
35+
SelectPrevPageLink = {
36+
{ "Shift", "Tab" },
37+
{ "Sym", "Tab" }, -- Shift or Sym + Tab
38+
event = "SelectPrevPageLink",
39+
},
40+
GotoSelectedPageLink = {
41+
{ "Press" },
42+
event = "GotoSelectedPageLink",
43+
},
44+
-- "Back" is handled by ReaderBack, which will call our onGoBackLink()
45+
-- when G_reader_settings:readSetting("back_in_reader") == "previous_location"
4546
}
46-
-- "Back" is handled by ReaderBack, which will call our onGoBackLink()
47-
-- when G_reader_settings:readSetting("back_in_reader") == "previous_location"
4847
end
4948
if Device:isTouchDevice() then
5049
self.ui:registerTouchZones({

‎frontend/apps/reader/modules/readermenu.lua‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -58,16 +58,16 @@ function ReaderMenu:init()
5858

5959
if Device:hasKeys() then
6060
if Device:isTouchDevice() then
61-
self.key_events.TapShowMenu = { { "Menu" }, doc = "show menu", }
61+
self.key_events.TapShowMenu = { { "Menu" } }
6262
if Device:hasFewKeys() then
63-
self.key_events.TapShowMenu = { { { "Menu", "Right" } }, doc = "show menu", }
63+
self.key_events.TapShowMenu = { { { "Menu", "Right" } } }
6464
end
6565
else
6666
-- map menu key to only top menu because bottom menu is only
6767
-- designed for touch devices
68-
self.key_events.ShowMenu = { { "Menu" }, doc = "show menu", }
68+
self.key_events.ShowMenu = { { "Menu" } }
6969
if Device:hasFewKeys() then
70-
self.key_events.ShowMenu = { { { "Menu", "Right" } }, doc = "show menu", }
70+
self.key_events.ShowMenu = { { { "Menu", "Right" } } }
7171
end
7272
end
7373
end
@@ -83,8 +83,8 @@ function ReaderMenu:getPreviousFile()
8383
end
8484

8585
function ReaderMenu:onReaderReady()
86-
-- deligate gesture listener to readerui
87-
self.ges_events = {}
86+
-- delegate gesture listener to readerui
87+
self.ges_events = nil
8888
self.onGesture = nil
8989
if not Device:isTouchDevice() then return end
9090

‎frontend/apps/reader/modules/readerpaging.lua‎

Lines changed: 44 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -41,60 +41,79 @@ local ReaderPaging = InputContainer:extend{
4141
}
4242

4343
function ReaderPaging:init()
44-
self.key_events = {}
4544
if Device:hasKeys() then
4645
self.key_events.GotoNextPage = {
47-
{ {"RPgFwd", "LPgFwd", "Right" } }, doc = "go to next page",
48-
event = "GotoViewRel", args = 1,
46+
{ { "RPgFwd", "LPgFwd", not Device:hasFewKeys() and "Right" } },
47+
event = "GotoViewRel",
48+
args = 1,
4949
}
5050
self.key_events.GotoPrevPage = {
51-
{ { "RPgBack", "LPgBack", "Left" } }, doc = "go to previous page",
52-
event = "GotoViewRel", args = -1,
51+
{ { "RPgBack", "LPgBack", not Device:hasFewKeys() and "Left" } },
52+
event = "GotoViewRel",
53+
args = -1,
5354
}
54-
if Device:hasFewKeys() then
55-
table.remove(self.key_events.GotoNextPage[1][1], 3) -- right
56-
table.remove(self.key_events.GotoPrevPage[1][1], 3) -- left
57-
end
5855
self.key_events.GotoNextPos = {
59-
{ {"Down" } }, doc = "go to next position",
60-
event = "GotoPosRel", args = 1,
56+
{ "Down" },
57+
event = "GotoPosRel",
58+
args = 1,
6159
}
6260
self.key_events.GotoPrevPos = {
63-
{ { "Up" } }, doc = "go to previous position",
64-
event = "GotoPosRel", args = -1,
61+
{ "Up" },
62+
event = "GotoPosRel",
63+
args = -1,
6564
}
6665

6766
end
6867
if Device:hasKeyboard() then
6968
self.key_events.GotoFirst = {
70-
{"1"}, doc = "go to start", event = "GotoPercent", args = 0,
69+
{ "1" },
70+
event = "GotoPercent",
71+
args = 0,
7172
}
7273
self.key_events.Goto11 = {
73-
{"2"}, doc = "go to 11%", event = "GotoPercent", args = 11,
74+
{ "2" },
75+
event = "GotoPercent",
76+
args = 11,
7477
}
7578
self.key_events.Goto22 = {
76-
{"3"}, doc = "go to 22%", event = "GotoPercent", args = 22,
79+
{ "3" },
80+
event = "GotoPercent",
81+
args = 22,
7782
}
7883
self.key_events.Goto33 = {
79-
{"4"}, doc = "go to 33%", event = "GotoPercent", args = 33,
84+
{ "4" },
85+
event = "GotoPercent",
86+
args = 33,
8087
}
8188
self.key_events.Goto44 = {
82-
{"5"}, doc = "go to 44%", event = "GotoPercent", args = 44,
89+
{ "5" },
90+
event = "GotoPercent",
91+
args = 44,
8392
}
8493
self.key_events.Goto55 = {
85-
{"6"}, doc = "go to 55%", event = "GotoPercent", args = 55,
94+
{ "6" },
95+
event = "GotoPercent",
96+
args = 55,
8697
}
8798
self.key_events.Goto66 = {
88-
{"7"}, doc = "go to 66%", event = "GotoPercent", args = 66,
99+
{ "7" },
100+
event = "GotoPercent",
101+
args = 66,
89102
}
90103
self.key_events.Goto77 = {
91-
{"8"}, doc = "go to 77%", event = "GotoPercent", args = 77,
104+
{ "8" },
105+
event = "GotoPercent",
106+
args = 77,
92107
}
93108
self.key_events.Goto88 = {
94-
{"9"}, doc = "go to 88%", event = "GotoPercent", args = 88,
109+
{ "9" },
110+
event = "GotoPercent",
111+
args = 88,
95112
}
96113
self.key_events.GotoLast = {
97-
{"0"}, doc = "go to end", event = "GotoPercent", args = 100,
114+
{ "0" },
115+
event = "GotoPercent",
116+
args = 100,
98117
}
99118
end
100119
self.pan_interval = time.s(1 / self.pan_rate)
@@ -106,7 +125,8 @@ function ReaderPaging:onReaderReady()
106125
end
107126

108127
function ReaderPaging:setupTouchZones()
109-
self.ges_events = {}
128+
-- delegate gesture listener to readerui
129+
self.ges_events = nil
110130
self.onGesture = nil
111131
if not Device:isTouchDevice() then return end
112132

0 commit comments

Comments
 (0)