Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Re-enable IME support on Linux #5198

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

YgorSouza
Copy link
Contributor

@YgorSouza YgorSouza commented Sep 30, 2024

Reverts #5188 and adds a different fix to restore IME on Linux without breaking the backspace and arrow keys.

  • I have followed the instructions in the PR template

It means different things on X11 and Wayland, and causes us to assume
IME is active when it isn't, causing the backspace and arrow keys to be
disabled.
Copy link

Preview available at https://egui-pr-preview.github.io/pr/5198-fix-linux-ime
Note that it might take a couple seconds for the update to show up after the preview_build workflow has completed.

@YgorSouza
Copy link
Contributor Author

@rustbasic @crumblingstatue can you test this?

I've tested with Fedora 40/Gnome 46 with both the regular (Wayland) session and the XOrg session, with the compose key, the Unicode input (Ctrl+Shift+U) and the Chinese (Intelligent Pinyin) input source. Everything seems to work, and the backspace and arrow keys work on both as well.

@crumblingstatue
Copy link
Contributor

I can't test IME, because fcitx (& pals) somehow break my X11 setup (don't ask me how), but I can confirm that backspace and arrow keys work.

@rustbasic
Copy link
Contributor

Dear emilk & Dear YgorSouza

My opinion is,

@YgorSouza
Copy link
Contributor Author

I'm not sure if it will work well on some Linux + Chinese

Is there anyone who can test this? I mean, it seems fine to me, but I'm not Chinese so I don't know.

image

#5182 looks like it would require a major release? It's adding fields to structs, so I guess that's a breaking change. But if we can get the IME to work correctly on all platforms, maybe it won't be needed? And egui-winit already has an allow_ime field, so we could block IME events at this level, if needed, without involving the TextEdit or any other widgets.

let allow_ime = ime.is_some();
if self.allow_ime != allow_ime {
self.allow_ime = allow_ime;
crate::profile_scope!("set_ime_allowed");
window.set_ime_allowed(allow_ime);
}

@rustbasic
Copy link
Contributor

allow_ime turns the entire IME function of the OS ON/OFF, so it is not the way we expect.

As you may have noticed,
some Linux and some Chinese input IMEs have a problem with IME::enable that persists from the program startup,
so it is always recognized as IME input state.
It seems necessary to directly control ON/OFF.

@YgorSouza
Copy link
Contributor Author

The change in this PR ignores the Enabled event on Linux, where on X11 it seems to just mean that the window supports IME (and sometimes it can't even be turned off). That should hopefully be enough to prevent egui from going into IME mode in applications where IME isn't used at all. It is only enabled in the Preedit event, which contains a string and a cursor range, so we're definitely using IME if we get that event, since winit can't just invent this data out of nowhere.

If this still causes problems, I think we need an issue explaining what those problems are and on which systems they occur, so we can think about a solution that doesn't break anything for anyone else.

@YgorSouza YgorSouza marked this pull request as ready for review October 1, 2024 08:47
Copy link
Owner

@emilk emilk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code LGTM, but we need to test this properly:

  • X11 without IME
  • X11 with IME
  • Wayland without IME
  • Wayland with IME

Repository owner deleted a comment from rustbasic Oct 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants