Class: Fusuma::Plugin::Remap::KeyboardRemapper

Inherits:
Object
  • Object
show all
Includes:
Revdev
Defined in:
lib/fusuma/plugin/remap/keyboard_remapper.rb

Defined Under Namespace

Classes: KeyboardSelector, TouchpadSelector

Constant Summary collapse

VIRTUAL_KEYBOARD_NAME =
"fusuma_virtual_keyboard"
DEFAULT_EMERGENCY_KEYBIND =
"RIGHTCTRL+LEFTCTRL".freeze
KEYMAP =

Key conversion tables for better performance and readability

Revdev.constants.select { |c| c.start_with?("KEY_", "BTN_") }
.map { |c| [Revdev.const_get(c), c.to_s.delete_prefix("KEY_")] }
.to_h.freeze
CODEMAP =
Revdev.constants.select { |c| c.start_with?("KEY_", "BTN_") }
.map { |c| [c, Revdev.const_get(c)] }
.to_h.freeze

Instance Method Summary collapse

Constructor Details

#initialize(layer_manager:, fusuma_writer:, config: {}) ⇒ KeyboardRemapper

Returns a new instance of KeyboardRemapper.

Parameters:



28
29
30
31
32
# File 'lib/fusuma/plugin/remap/keyboard_remapper.rb', line 28

def initialize(layer_manager:, fusuma_writer:, config: {})
  @layer_manager = layer_manager # request to change layer
  @fusuma_writer = fusuma_writer # write event to original keyboard
  @config = config
end

Instance Method Details

#runObject



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
# File 'lib/fusuma/plugin/remap/keyboard_remapper.rb', line 34

def run
  create_virtual_keyboard
  @source_keyboards = reload_keyboards

  old_ie = nil
  layer = nil
  next_mapping = nil
  current_mapping = {}

  loop do
    ios = IO.select([*@source_keyboards.map(&:file), @layer_manager.reader])
    io = ios.first.first

    if io == @layer_manager.reader
      layer = @layer_manager.receive_layer # update @current_layer
      if layer.nil?
        next
      end

      next_mapping = @layer_manager.find_mapping(layer)
      next
    end

    if next_mapping && virtual_keyboard_all_key_released?
      if current_mapping != next_mapping
        current_mapping = next_mapping
      end
      next_mapping = nil
    end

    input_event = @source_keyboards.find { |kbd| kbd.file == io }.read_input_event
    input_key = code_to_key(input_event.code)

    if input_event.type == EV_KEY
      @emergency_stop.call(old_ie, input_event)

      old_ie = input_event
      if input_event.value != 2 # repeat
        data = {key: input_key, status: input_event.value, layer: layer}
        begin
          @fusuma_writer.write(data.to_msgpack)
        rescue IOError => e
          MultiLogger.error("Failed to write to fusuma_writer: #{e.message}")
          @destroy&.call(1)
          return
        end
      end
    end

    remapped = current_mapping.fetch(input_key.to_sym, nil)
    case remapped
    when String, Symbol
      # Remapped to another key - continue processing below
    when Hash
      # Command execution (e.g., {:SENDKEY=>"LEFTCTRL+BTN_LEFT", :CLEARMODIFIERS=>true})
      # Skip input event processing and let Fusuma's Executor handle this
      next
    when nil
      # Not remapped - write original key event as-is
      uinput_keyboard.write_input_event(input_event)
      next
    else
      # Invalid remapping configuration
      MultiLogger.warn("Invalid remapped value - type: #{remapped.class}, key: #{input_key}")
      next
    end

    remapped_code = key_to_code(remapped)
    if remapped_code.nil?
      MultiLogger.warn("Invalid remapped value - unknown key: #{remapped}, input: #{input_key}")
      uinput_keyboard.write_input_event(input_event)
      next
    end

    remapped_event = InputEvent.new(nil, input_event.type, remapped_code, input_event.value)

    # Workaround: If a key was pressed before remapping started and is being released,
    # use the original key code to ensure proper key release
    if should_use_original_key?(remapped, remapped_event.value)
      remapped_event.code = input_event.code
    else
      # Only update virtual key state if we're using the remapped key
      update_virtual_key_state(remapped, remapped_event.value)
    end

    # remap to command will be nil
    # e.g) remap: { X: { command: echo 'foo' } }
    # this is because the command will be executed by fusuma process
    next if remapped_event.code.nil?

    uinput_keyboard.write_input_event(remapped_event)
  rescue Errno::ENODEV => e # device is removed
    MultiLogger.error "Device is removed: #{e.message}"
    @source_keyboards = reload_keyboards
  end
rescue EOFError => e # device is closed
  MultiLogger.error "Device is closed: #{e.message}"
ensure
  @destroy&.call
end