Make key repeat and delay configurable #3730

tarek-y-ismail · 2025-01-28T14:19:23Z

How to test:

Create a file at ~/.config/mir_demo_server.input with the following content:

repeat_rate=25
repeat_delay=600

Run mir demo server
Run a wayland compatible text editor or terminal (kgx), or and X application (xterm)
press and hold any key
Change repeat_rate to a higher or lower value and watch as the repeat rate speeds or slows down
Change repeat_delay to a higher or lower value and watch as the duration you need to hold the key down increases or decreases.

src/server/report/default_server_configuration.cpp

AlanGriffiths

No tests for the new code?

A few things need shuffling around.

Also, it would be nice to split the ConfigFile changes into a separate, precursor, PR. (They should be uncontentious and quick to land)

include/miral/miral/config_file.h

src/include/server/mir/frontend/keyboard_helper.h

src/include/server/mir/shell/accessibility_manager.h

src/server/frontend_wayland/CMakeLists.txt

src/server/report/default_server_configuration.cpp

mattkae

This looks pretty reasonable! I've got a few points for improvement

src/include/server/mir/frontend/keyboard_helper.h

src/include/server/mir/shell/accessibility_manager.h

src/server/report/default_server_configuration.cpp

src/include/server/mir/shell/accessibility_manager.h

src/server/shell/accessibility_manager.cpp

Shells can now set the repeat rate and delay based on their config file format.

mattkae

A few more questions, but looking good!

mattkae · 2025-01-30T21:23:56Z

src/miral/input_configuration.cpp

+
+auto miral::InputConfiguration::Keyboard::operator=(Keyboard that) -> Keyboard&
+{
+    std::swap(self, that.self);


Why would operator= be a swap? Shouldn't there be an overrided operator= on self so that we copy all of its values?

Hmm, I copied and pasted the touchpad code to keep everything consistent, so they also do the same thing...

I'm not sure why that is

That's the canonical way to write an assignment operator in c++: copy into the parameter and swap with *this.

src/include/server/mir/shell/accessibility_manager.h

src/server/report/default_server_configuration.cpp

mattkae · 2025-01-30T21:30:55Z

src/server/shell/accessibility_manager.cpp

+    for(auto const& helper: keyboard_helpers)
+        helper->repeat_info_changed(repeat_rate_, repeat_delay_);


If enable_key_repeat is false, should repeat_rate_ be std::nullopt?

According to: https://wayland.app/protocols/wayland#wl_keyboard:event:repeat_info, "rate of zero will disable any repeating (regardless of the value of delay).". My interpretation was that we can just deliver the rate as an optional and the delay can be a normal value. It's then up to the user to interpret it. Which reminds me that I should use repeat_rate() here as well

tarek-y-ismail · 2025-01-31T11:49:37Z

Note to self: Just came across this while working on something else, might be a good idea to check out

mir/src/server/input/default_configuration.cpp

Lines 144 to 164 in 5e15fde

    
           return input_dispatcher( 
        
               [this]() 
        
               { 
        
                   std::chrono::milliseconds const key_repeat_timeout{500}; 
        
                   std::chrono::milliseconds const key_repeat_delay{50}; 
        
                   auto const options = the_options(); 
        
                   // lp:1675357: Disable generation of key repeat events on nested servers 
        
                   auto enable_repeat = options->get<bool>(options::enable_key_repeat_opt); 
        
                   auto const idle_poking_dispatcher = std::make_shared<mi::IdlePokingDispatcher>( 
        
                       the_event_filter_chain_dispatcher(), 
        
                       the_idle_hub()); 
        
                   auto const keyboard_resync_dispatcher = 
        
                       std::make_shared<mi::KeyboardResyncDispatcher>(idle_poking_dispatcher); 
        
                   return std::make_shared<mi::KeyRepeatDispatcher>( 
        
                       keyboard_resync_dispatcher, the_main_loop(), 
        
                       enable_repeat, key_repeat_timeout, key_repeat_delay, false); 
        
               });

Co-authored-by: Matthew Kosarek <matt.kosarek@canonical.com>

tarek-y-ismail · 2025-01-31T14:21:55Z

Note to self: Just came across this while working on something else, might be a good idea to check out

Very confused what this does since repeat on both wayland and X seem to work without any modification to it.

Edit: From a quick skim, this seems to implement key repeat on the server. For wayland and X(wayland), the code changes here suffice.

Initially, the config file is loaded before the server starts. The changes need some server components to be applied, so they aren't applied at that stage. The few lines added store the changes and apply them once the server starts.

AlanGriffiths · 2025-01-31T18:04:59Z

examples/mir_demo_server/server_example.cpp

    miral::InputConfiguration input_configuration;
+    auto mouse = input_configuration.mouse();
+    auto touchpad = input_configuration.touchpad();
+    auto keyboard = input_configuration.keyboard();


I think we could grow a utility class that combines these and the repeated "apply" logic?

Also, we need to be careful: we're now accessing mouse, touchpad and keyboard on multiple threads.

Having said that, I like the revised approach

tarek-y-ismail self-assigned this Jan 28, 2025

tarek-y-ismail marked this pull request as ready for review January 28, 2025 17:03

tarek-y-ismail requested a review from a team as a code owner January 28, 2025 17:03

tarek-y-ismail marked this pull request as draft January 28, 2025 17:09

tarek-y-ismail added 2 commits January 29, 2025 10:23

Make make_keyboard_helper the only way to make KeyboardHelpers

1ba82fe

Swap KeyboardHelper instances to shared_ptr

61c9e2c

tarek-y-ismail force-pushed the MIRENG-892/configurable-key-repeat branch from 4712763 to 9299fb6 Compare January 29, 2025 08:34

tarek-y-ismail marked this pull request as ready for review January 29, 2025 09:08

tarek-y-ismail requested a review from mattkae January 29, 2025 09:08

tarek-y-ismail commented Jan 29, 2025

View reviewed changes

src/server/report/default_server_configuration.cpp Outdated Show resolved Hide resolved

AlanGriffiths requested changes Jan 29, 2025

View reviewed changes

mattkae requested changes Jan 29, 2025

View reviewed changes

tarek-y-ismail force-pushed the MIRENG-892/configurable-key-repeat branch from 9299fb6 to a6b1793 Compare January 30, 2025 12:43

tarek-y-ismail changed the base branch from main to config-file-load-after-server-init January 30, 2025 12:43

tarek-y-ismail force-pushed the MIRENG-892/configurable-key-repeat branch from a6b1793 to 55c6cb7 Compare January 30, 2025 13:01

tarek-y-ismail added 6 commits January 30, 2025 16:28

Add mir::shell::KeyboardHelper

b21446e

Add mir::shell::AccessibilityManager

771f19c

Expose the_accessibility_manager in mir::Server

5393235

Pass the accessibility manager down to WlSeat

2ee2f64

Hook up input config (re)loading to the accessibility manager

ca56673

Shells can now set the repeat rate and delay based on their config file format.

Make AccessibilityManager aware of "enable-key-repeat"

384afb6

tarek-y-ismail force-pushed the MIRENG-892/configurable-key-repeat branch from 55c6cb7 to 384afb6 Compare January 30, 2025 15:00

tarek-y-ismail force-pushed the config-file-load-after-server-init branch 2 times, most recently from f6f04ce to 6a0f1b9 Compare January 30, 2025 15:10

tarek-y-ismail requested review from mattkae and AlanGriffiths January 30, 2025 16:56

mattkae requested changes Jan 30, 2025

View reviewed changes

tarek-y-ismail and others added 2 commits January 31, 2025 15:58

Pass keyboard helper by const& instead of copying

0cc08c3

Co-authored-by: Matthew Kosarek <matt.kosarek@canonical.com>

Revert newline deletion

4f16caf

Make repeat_rate optional in {frontend,shell}::KeyboardHelper

d484803

tarek-y-ismail force-pushed the MIRENG-892/configurable-key-repeat branch from f66af7f to d484803 Compare January 31, 2025 13:59

tarek-y-ismail requested a review from mattkae January 31, 2025 14:19

Apply input config changes on server start

d64852c

Initially, the config file is loaded before the server starts. The changes need some server components to be applied, so they aren't applied at that stage. The few lines added store the changes and apply them once the server starts.

tarek-y-ismail changed the base branch from config-file-load-after-server-init to main January 31, 2025 16:04

AlanGriffiths reviewed Jan 31, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make key repeat and delay configurable #3730

Make key repeat and delay configurable #3730

tarek-y-ismail commented Jan 28, 2025 •

edited

Loading

AlanGriffiths left a comment

mattkae left a comment

mattkae left a comment

mattkae Jan 30, 2025

tarek-y-ismail Jan 31, 2025

AlanGriffiths Jan 31, 2025

mattkae Jan 30, 2025

tarek-y-ismail Jan 31, 2025

tarek-y-ismail commented Jan 31, 2025

tarek-y-ismail commented Jan 31, 2025 •

edited

Loading

AlanGriffiths Jan 31, 2025

AlanGriffiths Jan 31, 2025

		for(auto const& helper: keyboard_helpers)
		helper->repeat_info_changed(repeat_rate_, repeat_delay_);

Make key repeat and delay configurable #3730

Are you sure you want to change the base?

Make key repeat and delay configurable #3730

Conversation

tarek-y-ismail commented Jan 28, 2025 • edited Loading

AlanGriffiths left a comment

Choose a reason for hiding this comment

mattkae left a comment

Choose a reason for hiding this comment

mattkae left a comment

Choose a reason for hiding this comment

mattkae Jan 30, 2025

Choose a reason for hiding this comment

tarek-y-ismail Jan 31, 2025

Choose a reason for hiding this comment

AlanGriffiths Jan 31, 2025

Choose a reason for hiding this comment

mattkae Jan 30, 2025

Choose a reason for hiding this comment

tarek-y-ismail Jan 31, 2025

Choose a reason for hiding this comment

tarek-y-ismail commented Jan 31, 2025

tarek-y-ismail commented Jan 31, 2025 • edited Loading

AlanGriffiths Jan 31, 2025

Choose a reason for hiding this comment

AlanGriffiths Jan 31, 2025

Choose a reason for hiding this comment

tarek-y-ismail commented Jan 28, 2025 •

edited

Loading

tarek-y-ismail commented Jan 31, 2025 •

edited

Loading