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

ExternalKeyboard: Use the evdev number passed along by base to avoid sweeping the full list of input devices

Browse Source 
This required some... creative thinking to avoid complexifying common
Input/UIManager codepaths ;p.
This commit is contained in:
NiLuJe
2022-10-31 02:01:54 +01:00
parent 25dce4d1b5
commit 9863a9c0bb
4 changed files with 128 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
frontend/device/input.lua
View File

@@ -183,6 +183,15 @@ local Input = {
WakeupFromSuspend = true, ReadyToSuspend = true,
UsbDevicePlugIn = true, UsbDevicePlugOut = true,
},
-- Subset of fake_event_set for events that require passing a parameter along
complex_fake_event_set = {
UsbDevicePlugIn = true, UsbDevicePlugOut = true,
},
-- Crappy FIFO to forward parameters for those events to UIManager
fake_event_args = {
UsbDevicePlugIn = {},
UsbDevicePlugOut = {},
},
-- This might be overloaded or even disabled (post-init) at instance-level, so we don't want any inheritance
rotation_map = nil, -- nil or a hash
@@ -547,6 +556,17 @@ function Input:handleKeyBoardEv(ev)
end
if self.fake_event_set[keycode] then
-- For events that pass a parameter in the input event's value field,
-- we kludge it up a bit, because we *want* a broadcastEvent *and* an argument, but...
-- * If we return an Event here, UIManager.event_handlers.__default__ will just pass it to UIManager:sendEvent(),
-- meaning it won't reach plugins (because these are not, and currently cannot be, registered as active_widgets).
-- * If we return a string here, our named UIManager.event_handlers cannot directly receive an argument...
-- So, we simply store it somewhere our handler can find and call it a day.
-- And we use an array as a FIFO because we cannot guarantee that insertions and removals will interleave nicely.
-- (This is all in the name of avoiding complexifying the common codepaths for events that should be few and far between).
if self.complex_fake_event_set[keycode] then
table.insert(self.fake_event_args[keycode], ev.value)
end
return keycode
end

13
frontend/ui/uimanager.lua
View File

@@ -56,12 +56,15 @@ function UIManager:init()
Power = function(input_event)
Device:onPowerEvent(input_event)
end,
-- This is for OTG input devices
UsbDevicePlugIn = function()
self:broadcastEvent(Event:new("UsbDevicePlugIn"))
-- This is for hotpluggable evdev input devices (e.g., USB OTG)
UsbDevicePlugIn = function(input_event)
-- Retrieve the argument set by Input:handleKeyBoardEv
local evdev = table.remove(Input.fake_event_args[input_event])
self:broadcastEvent(Event:new("EvdevInputInsert", evdev))
end,
UsbDevicePlugOut = function()
self:broadcastEvent(Event:new("UsbDevicePlugOut"))
UsbDevicePlugOut = function(input_event)
local evdev = table.remove(Input.fake_event_args[input_event])
self:broadcastEvent(Event:new("EvdevInputRemove", evdev))
end,
}
self.poweroff_action = function()

26
plugins/externalkeyboard.koplugin/find-keyboard.lua
View File

@@ -80,19 +80,27 @@ local function analyze_key_capabilities(long_bitmap_arr)
}
end
function FindKeyboard:check(event_file_name)
local capabilities_long_bitmap_arr = read_key_capabilities("/sys/class/input/" .. event_file_name)
if capabilities_long_bitmap_arr then
local keyboard_info = analyze_key_capabilities(capabilities_long_bitmap_arr)
if keyboard_info.is_keyboard then
return {
event_path = "/dev/input/" .. event_file_name,
has_dpad = keyboard_info.has_dpad
}
end
end
return nil
end
function FindKeyboard:find()
local keyboards = {}
for event_file_name in lfs.dir("/sys/class/input/") do
if event_file_name:match("event.*") then
local capabilities_long_bitmap_arr = read_key_capabilities("/sys/class/input/" .. event_file_name)
if capabilities_long_bitmap_arr then
local keyboard_info = analyze_key_capabilities(capabilities_long_bitmap_arr)
if keyboard_info.is_keyboard then
table.insert(keyboards, {
event_path = "/dev/input/" .. event_file_name,
has_dpad = keyboard_info.has_dpad
})
end
local kb = self:check(event_file_name)
if kb then
table.insert(keyboards, kb)
end
end
end

144
plugins/externalkeyboard.koplugin/main.lua
View File

@@ -89,6 +89,7 @@ local ExternalKeyboard = WidgetContainer:extend{
is_doc_only = false,
original_device_values = nil,
keyboard_fds = {},
connected_keyboards = 0,
}
function ExternalKeyboard:init()
@@ -111,7 +112,7 @@ function ExternalKeyboard:init()
role = USB_ROLE_HOST
end
if role == USB_ROLE_HOST then
self:findAndSetupKeyboard()
self:findAndSetupKeyboards()
end
end
@@ -215,30 +216,35 @@ function ExternalKeyboard:onCloseWidget()
end
end
ExternalKeyboard.onUsbDevicePlugIn = UIManager:debounce(0.5, false, function(self)
self:findAndSetupKeyboard()
end)
function ExternalKeyboard:_onEvdevInputInsert(evdev)
self:setupKeyboard("/dev/input/event" .. tostring(evdev))
end
ExternalKeyboard.onUsbDevicePlugOut = UIManager:debounce(0.5, false, function(self)
logger.dbg("ExternalKeyboard: onUsbDevicePlugOut")
local is_any_disconnected = false
-- Check that a keyboard really was disconnected. Another USB device could've been unplugged.
for event_path, fd in pairs(ExternalKeyboard.keyboard_fds) do
local event_file_attrs = lfs.attributes(event_path, "mode")
logger.dbg("ExternalKeyboard: checked if event file exists. path:", event_path, "file mode:", tostring(event_file_attrs))
if event_file_attrs == nil then
is_any_disconnected = true
end
end
function ExternalKeyboard:onEvdevInputInsert(evdev)
-- Leave time for the kernel to actually create the device
UIManager:scheduleIn(0.5, self._onEvdevInputInsert, self, evdev)
end
if not is_any_disconnected then
function ExternalKeyboard:_onEvdevInputRemove(evdev)
-- Check that a keyboard we know about really was disconnected. Another input device could've been unplugged.
local event_path = "/dev/input/event" .. tostring(evdev)
if not ExternalKeyboard.keyboard_fds[event_path] then
logger.dbg("ExternalKeyboard:onEvdevInputRemove:", event_path, "was not a keyboard we knew about")
return
end
logger.dbg("ExternalKeyboard: USB keyboard was disconnected")
-- Double-check that it's really gone.
local event_file_attrs = lfs.attributes(event_path, "mode")
if event_file_attrs ~= nil then
logger.warn("ExternalKeyboard:onEvdevInputRemove:", event_path, "is still connected?!")
return
end
ExternalKeyboard.keyboard_fds = {}
if ExternalKeyboard.original_device_values then
ExternalKeyboard.keyboard_fds[event_path] = nil
ExternalKeyboard.connected_keyboards = ExternalKeyboard.connected_keyboards - 1
logger.dbg("ExternalKeyboard: USB keyboard", event_path, "was disconnected; total:", ExternalKeyboard.connected_keyboards)
-- If that was the last keyboard we knew about, restore native input-related device caps.
if ExternalKeyboard.connected_keyboards == 0 and ExternalKeyboard.original_device_values then
Device.input.event_map = ExternalKeyboard.original_device_values.event_map
Device.keyboard_layout = ExternalKeyboard.original_device_values.keyboard_layout
Device.hasKeyboard = ExternalKeyboard.original_device_values.hasKeyboard
@@ -246,69 +252,85 @@ ExternalKeyboard.onUsbDevicePlugOut = UIManager:debounce(0.5, false, function(se
ExternalKeyboard.original_device_values = nil
end
-- Broadcasting events throught UIManager would only get to InputText if there is an active widget on the window stack.
-- So, calling a static function is the only choice.
-- InputText.setKeyboard(require("ui/widget/virtualkeyboard"))
-- Update the existing input widgets. It must be issued after the static state of InputText is updated.
-- There's a two-pronged approach here:
-- * Call a static class method to modify the class state for future instances of said class
-- * Broadcast an Event so that all currently displayed widgets update their own state.
-- This must come after, because widgets *may* rely on static class members.
InputText.initInputEvents()
UIManager:broadcastEvent(Event:new("PhysicalKeyboardDisconnected"))
end)
end
-- The keyboard events with the same key codes would override the original events.
-- That may cause embedded buttons to lose their original function and produce letters.
-- Can we tell from which device a key press comes? The koreader-base passes values of input_event which do not have file descriptors.
function ExternalKeyboard:findAndSetupKeyboard()
-- That may cause embedded buttons to lose their original function and produce letters,
-- as we cannot tell which device a key press comes from.
function ExternalKeyboard:findAndSetupKeyboards()
local keyboards = FindKeyboard:find()
local is_new_keyboard_setup = false
local has_dpad_func = Device.hasDPad
-- A USB keyboard may be recognized as several devices under a hub. And several of them may
-- have keyboard capabilities set. Yet, only one would emit the events. The solution is to open all of them.
for __, keyboard_info in ipairs(keyboards) do
logger.dbg("ExternalKeyboard:findAndSetupKeyboard found event path", keyboard_info.event_path, "has_dpad", keyboard_info.has_dpad)
-- Check if the event file already was open.
if ExternalKeyboard.keyboard_fds[keyboard_info.event_path] == nil then
local ok, fd = pcall(Device.input.open, keyboard_info.event_path)
if not ok then
UIManager:show(InfoMessage:new{
text = "Error opening the keyboard device " .. keyboard_info.event_path .. ":\n" .. tostring(fd),
})
return
end
self:setupKeyboard(keyboard_info.event_path)
end
end
is_new_keyboard_setup = true
ExternalKeyboard.keyboard_fds[keyboard_info.event_path] = fd
function ExternalKeyboard:onEvdevInputRemove(evdev)
UIManager:scheduleIn(0.5, self._onEvdevInputRemove, self, evdev)
end
if keyboard_info.has_dpad then
has_dpad_func = yes
end
function ExternalKeyboard:setupKeyboard(event_path)
local keyboard_info = FindKeyboard:check(event_path:match(".+/(.+)")) -- FindKeyboard only wants eventN, not the full path
if not keyboard_info then
logger.dbg("ExternalKeyboard:setupKeyboard:", event_path, "doesn't look like a keyboard")
return
end
local has_dpad_func = Device.hasDPad
logger.dbg("ExternalKeyboard:setupKeyboard", keyboard_info.event_path, "has_dpad", keyboard_info.has_dpad)
-- Check if we already know about this event file.
if ExternalKeyboard.keyboard_fds[keyboard_info.event_path] == nil then
local ok, fd = pcall(Device.input.open, keyboard_info.event_path)
if not ok then
UIManager:show(InfoMessage:new{
text = "Error opening keyboard:\n" .. tostring(fd),
})
logger.warn("Error opening keyboard:", fd)
return
end
ExternalKeyboard.keyboard_fds[keyboard_info.event_path] = fd
ExternalKeyboard.connected_keyboards = ExternalKeyboard.connected_keyboards + 1
logger.dbg("ExternalKeyboard: USB keyboard", keyboard_info.event_path, "was connected; total:", ExternalKeyboard.connected_keyboards)
if keyboard_info.has_dpad then
has_dpad_func = yes
end
end
if is_new_keyboard_setup then
-- The setting for input_invert_page_turn_keys wouldn't mess up the new event map. Device module applies it on initialization, not dynamically.
-- If this is our first external input device, keep a snapshot of the native input-related device caps.
-- The setting for input_invert_page_turn_keys wouldn't mess up the new event map. Device module applies it on initialization, not dynamically.
if not ExternalKeyboard.original_device_values then
ExternalKeyboard.original_device_values = {
event_map = Device.input.event_map,
keyboard_layout = Device.keyboard_layout,
hasKeyboard = Device.hasKeyboard,
hasDPad = Device.hasDPad,
}
-- Using a new table avoids mutating the original event map.
local event_map = {}
util.tableMerge(event_map, Device.input.event_map)
util.tableMerge(event_map, event_map_keyboard)
Device.input.event_map = event_map
Device.hasKeyboard = yes
Device.hasDPad = has_dpad_func
UIManager:show(InfoMessage:new{
text = _("Keyboard connected"),
timeout = 1,
})
InputText.initInputEvents()
UIManager:broadcastEvent(Event:new("PhysicalKeyboardConnected"))
end
-- Using a new table avoids mutating the original event map.
local event_map = {}
util.tableMerge(event_map, Device.input.event_map)
util.tableMerge(event_map, event_map_keyboard)
Device.input.event_map = event_map
Device.hasKeyboard = yes
Device.hasDPad = has_dpad_func
UIManager:show(InfoMessage:new{
text = _("Keyboard connected"),
timeout = 1,
})
InputText.initInputEvents()
UIManager:broadcastEvent(Event:new("PhysicalKeyboardConnected"))
end
function ExternalKeyboard:showHelp()