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.

Sign up for GitHub

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

text-input: fix active instance tracking #1648

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+85 −25
Open

text-input: fix active instance tracking #1648

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions src/wayland/input_method/input_method_handle.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ where
) {
match request {
zwp_input_method_v2::Request::CommitString { text } => {
data.text_input_handle.with_focused_text_input(|ti, _surface| {
data.text_input_handle.with_active_text_input(|ti, _surface| {
ti.commit_string(Some(text.clone()));
});
}
Expand All @@ -220,15 +220,15 @@ where
cursor_begin,
cursor_end,
} => {
data.text_input_handle.with_focused_text_input(|ti, _surface| {
data.text_input_handle.with_active_text_input(|ti, _surface| {
ti.preedit_string(Some(text.clone()), cursor_begin, cursor_end);
});
}
zwp_input_method_v2::Request::DeleteSurroundingText {
before_length,
after_length,
} => {
data.text_input_handle.with_focused_text_input(|ti, _surface| {
data.text_input_handle.with_active_text_input(|ti, _surface| {
ti.delete_surrounding_text(before_length, after_length);
});
}
Expand Down Expand Up @@ -332,8 +332,6 @@ where
data: &InputMethodUserData<D>,
) {
data.handle.inner.lock().unwrap().instance = None;
data.text_input_handle.with_focused_text_input(|ti, surface| {
ti.leave(surface);
});
data.text_input_handle.leave();
}
}
2 changes: 1 addition & 1 deletion src/wayland/input_method/input_method_keyboard_grab.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ where
let keyboard = inner.grab.as_ref().unwrap();
inner
.text_input_handle
.focused_text_input_serial_or_default(serial.0, |serial| {
.active_text_input_serial_or_default(serial.0, |serial| {
keyboard.key(serial, time, keycode.raw() - 8, key_state.into());
if let Some(serialized) = modifiers.map(|m| m.serialized) {
keyboard.modifiers(
Expand Down
98 changes: 80 additions & 18 deletions src/wayland/text_input/text_input_handle.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,10 @@ use std::sync::{Arc, Mutex};

use tracing::debug;
use wayland_protocols::wp::text_input::zv3::server::zwp_text_input_v3::{self, ZwpTextInputV3};
use wayland_server::backend::ClientId;
use wayland_server::backend::{ClientId, ObjectId};
use wayland_server::{protocol::wl_surface::WlSurface, Dispatch, Resource};

use crate::input::SeatHandler;
use crate::utils::IsAlive;
use crate::wayland::input_method::InputMethodHandle;

use super::TextInputManagerState;
Expand All @@ -21,22 +20,47 @@ struct Instance {
pub(crate) struct TextInput {
instances: Vec<Instance>,
focus: Option<WlSurface>,
active_text_input_id: Option<ObjectId>,
}

impl TextInput {
fn with_focused_text_input<F>(&mut self, mut f: F)
fn with_focused_client_all_text_inputs<F>(&mut self, mut f: F)
where
F: FnMut(&ZwpTextInputV3, &WlSurface, u32),
{
if let Some(ref surface) = self.focus {
if !surface.alive() {
return;
}
for ti in self.instances.iter_mut() {
if ti.instance.id().same_client_as(&surface.id()) {
f(&ti.instance, surface, ti.serial);
if let Some(surface) = self.focus.as_ref().filter(|surface| surface.is_alive()) {
for text_input in self.instances.iter() {
let instance_id = text_input.instance.id();
if instance_id.same_client_as(&surface.id()) {
f(&text_input.instance, surface, text_input.serial);
break;
}
}
};
}

fn with_active_text_input<F>(&mut self, mut f: F)
where
F: FnMut(&ZwpTextInputV3, &WlSurface, u32),
{
let active_id = match &self.active_text_input_id {
Some(active_text_input_id) => active_text_input_id,
None => return,
};

let surface = match self.focus.as_ref().filter(|surface| surface.is_alive()) {
Some(surface) => surface,
None => return,
};

let surface_id = surface.id();
if let Some(text_input) = self
.instances
.iter()
.filter(|instance| instance.instance.id().same_client_as(&surface_id))
.find(|instance| &instance.instance.id() == active_id)
{
f(&text_input.instance, surface, text_input.serial);
}
}
}
Expand Down Expand Up @@ -81,7 +105,10 @@ impl TextInputHandle {
/// surface.
pub fn leave(&self) {
let mut inner = self.inner.lock().unwrap();
inner.with_focused_text_input(|text_input, focus, _| {
// Leaving clears the active text input.
inner.active_text_input_id = None;
// NOTE: we implement it in a symmetrical way with `enter`.
inner.with_focused_client_all_text_inputs(|text_input, focus, _| {
text_input.leave(focus);
});
}
Expand All @@ -90,7 +117,9 @@ impl TextInputHandle {
/// surface.
pub fn enter(&self) {
let mut inner = self.inner.lock().unwrap();
inner.with_focused_text_input(|text_input, focus, _| {
// NOTE: protocol states that if we have multiple text inputs enabled, `enter` must
// be send for each of them.
inner.with_focused_client_all_text_inputs(|text_input, focus, _| {
text_input.enter(focus);
});
}
Expand All @@ -99,7 +128,7 @@ impl TextInputHandle {
/// the state should be discarded and wrong serial sent.
pub fn done(&self, discard_state: bool) {
let mut inner = self.inner.lock().unwrap();
inner.with_focused_text_input(|text_input, _, serial| {
inner.with_active_text_input(|text_input, _, serial| {
if discard_state {
debug!("discarding text-input state due to serial");
// Discarding is done by sending non-matching serial.
Expand All @@ -116,27 +145,51 @@ impl TextInputHandle {
F: FnMut(&ZwpTextInputV3, &WlSurface),
{
let mut inner = self.inner.lock().unwrap();
inner.with_focused_text_input(|ti, surface, _| {
inner.with_focused_client_all_text_inputs(|ti, surface, _| {
f(ti, surface);
});
}

/// Call the callback with the serial of the focused text_input or with the passed
/// Access the active text-input instance for the currently focused surface.
pub fn with_active_text_input<F>(&self, mut f: F)
where
F: FnMut(&ZwpTextInputV3, &WlSurface),
{
let mut inner = self.inner.lock().unwrap();
inner.with_active_text_input(|ti, surface, _| {
f(ti, surface);
});
}

/// Call the callback with the serial of the active text_input or with the passed
/// `default` one when empty.
pub(crate) fn focused_text_input_serial_or_default<F>(&self, default: u32, mut callback: F)
pub(crate) fn active_text_input_serial_or_default<F>(&self, default: u32, mut callback: F)
where
F: FnMut(u32),
{
let mut inner = self.inner.lock().unwrap();
let mut should_default = true;
inner.with_focused_text_input(|_, _, serial| {
inner.with_active_text_input(|_, _, serial| {
should_default = false;
callback(serial);
});
if should_default {
callback(default)
}
}

fn set_active_text_input_id(&self, id: Option<ObjectId>) {
self.inner.lock().unwrap().active_text_input_id = id;
}

fn is_active_text_input_or_new(&self, id: &ObjectId) -> bool {
self.inner
.lock()
.unwrap()
.active_text_input_id
.as_ref()
.map_or(true, |active_id| active_id == id)
}
}

/// User data of ZwpTextInputV3 object
Expand Down Expand Up @@ -180,11 +233,20 @@ where
}
};

// text-input-v3 states that only one text_input must be enabled at the time
// and receive the events.
if !data.handle.is_active_text_input_or_new(&resource.id()) {
debug!("discarding text_input request since we already have an active one");
return;
}

match request {
zwp_text_input_v3::Request::Enable => {
data.input_method_handle.activate_input_method(state, &focus)
data.handle.set_active_text_input_id(Some(resource.id()));
data.input_method_handle.activate_input_method(state, &focus);
}
zwp_text_input_v3::Request::Disable => {
data.handle.set_active_text_input_id(None);
data.input_method_handle.deactivate_input_method(state, false);
}
zwp_text_input_v3::Request::SetSurroundingText { text, cursor, anchor } => {
Expand Down
Loading