1use crate::{
2
3 LinuxKeyboardMapper, platform::{xcb_flush, Capslock},
4 scap_screen_capture::scap_screen_sources,
5 underlying_dead_key,
6,
7};
8use core::str;
9use std::{
10 cell::RefCell,
11 collections::{BTreeMap, HashSet},
12 ops::Deref,
13 path::PathBuf,
14 rc::{Rc, Weak},
15 time::{Duration, Instant},
16};
17
18use anyhow::{anyhow, Context as _};
19use calloop::{
20 generic::{FdWrapper, Generic},
21 EventLoop, LoopHandle, RegistrationToken,
22};
23use collections::HashMap;
24use http_client::Url;
25use log::Level;
26use smallvec::SmallVec;
27use util::ResultExt;
28
29use x11rb::{
30 connection::{Connection, RequestConnection},
31 cursor,
32 errors::ConnectionError,
33 protocol::randr::ConnectionExt as _,
34 protocol::xinput::ConnectionExt,
35 protocol::xkb::ConnectionExt as _,
36 protocol::xproto::{
37 AtomEnum, ChangeWindowAttributesAux, ClientMessageData, ClientMessageEvent,
38 ConnectionExt as _, EventMask, KeyPressEvent, Visibility,
39 },
40 protocol::{randr, render, xinput, xkb, xproto, Event},
41 resource_manager::Database,
42 wrapper::ConnectionExt as _,
43 xcb_ffi::XCBConnection,
44};
45use xim::{x11rb::X11rbClient, AttributeName, Client, InputStyle};
46use xkbc::x11::ffi::{XKB_X11_MIN_MAJOR_XKB_VERSION, XKB_X11_MIN_MINOR_XKB_VERSION};
47use xkbcommon::xkb::{self as xkbc, LayoutIndex, ModMask, State, STATE_LAYOUT_EFFECTIVE};
48
49use super::{
50 button_or_scroll_from_event_detail, check_reply,
51 clipboard::{self, Clipboard},
52 get_reply, get_valuator_axis_index, handle_connection_error, modifiers_from_state,
53 pressed_button_from_mask, ButtonOrScroll, ScrollDirection, X11Display, X11WindowStatePtr,
54 XcbAtoms, XimCallbackEvent, XimHandler,
55};
56
57use crate::platform::{
58 blade::BladeContext,
59 linux::{
60 get_xkb_compose_state, is_within_click_distance, log_cursor_icon_warning,
61 open_uri_internal,
62 platform::{DOUBLE_CLICK_INTERVAL, SCROLL_LINES},
63 reveal_path_internal,
64 xdg_desktop_portal::{Event as XDPEvent, XDPEventSource},
65 LinuxClient, DEFAULT_CURSOR_ICON_NAME,
66 },
67 LinuxCommon, PlatformWindow,
68};
69use crate::{
70 modifiers_from_xinput_info, point, px, AnyWindowHandle, Bounds, ClipboardItem, CursorStyle,
71 DisplayId, FileDropEvent, Keystroke, LinuxKeyboardLayout, Modifiers, ModifiersChangedEvent,
72 MouseButton, Pixels, Platform, PlatformDisplay, PlatformInput, PlatformKeyboardLayout, Point,
73 RequestFrameOptions, ScaledPixels, ScrollDelta, Size, TouchPhase, WindowParams, X11Window,
74};
75
76/// Value for DeviceId parameters which selects all devices.
77pub(crate) const XINPUT_ALL_DEVICES: xinput::DeviceId = 0;
78
79/// Value for DeviceId parameters which selects all device groups. Events that
80/// occur within the group are emitted by the group itself.
81///
82/// In XInput 2's interface, these are referred to as "master devices", but that
83/// terminology is both archaic and unclear.
84pub(crate) const XINPUT_ALL_DEVICE_GROUPS: xinput::DeviceId = 1;
85
86pub(crate) struct WindowRef {
87 window: X11WindowStatePtr,
88 refresh_state: Option<RefreshState>,
89 expose_event_received: bool,
90 last_visibility: Visibility,
91 is_mapped: bool,
92}
93
94impl WindowRef {
95 pub fn handle(&self) -> AnyWindowHandle {
96 self.window.state.borrow().handle
97 }
98}
99
100impl Deref for WindowRef {
101 type Target = X11WindowStatePtr;
102
103 fn deref(&self) -> &Self::Target {
104 &self.window
105 }
106}
107
108enum RefreshState {
109 Hidden {
110 refresh_rate: Duration,
111 },
112 PeriodicRefresh {
113 refresh_rate: Duration,
114 event_loop_token: RegistrationToken,
115 },
116}
117
118#[derive(Debug)]
119#[non_exhaustive]
120pub enum EventHandlerError {
121 XCBConnectionError(ConnectionError),
122 XIMClientError(xim::ClientError),
123}
124
125impl std::error::Error for EventHandlerError {}
126
127impl std::fmt::Display for EventHandlerError {
128 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
129 match self {
130 EventHandlerError::XCBConnectionError(err) => err.fmt(f),
131 EventHandlerError::XIMClientError(err) => err.fmt(f),
132 }
133 }
134}
135
136impl From<ConnectionError> for EventHandlerError {
137 fn from(err: ConnectionError) -> Self {
138 EventHandlerError::XCBConnectionError(err)
139 }
140}
141
142impl From<xim::ClientError> for EventHandlerError {
143 fn from(err: xim::ClientError) -> Self {
144 EventHandlerError::XIMClientError(err)
145 }
146}
147
148#[derive(Debug, Default, Clone)]
149struct XKBStateNotiy {
150 depressed_layout: LayoutIndex,
151 latched_layout: LayoutIndex,
152 locked_layout: LayoutIndex,
153}
154
155#[derive(Debug, Default)]
156pub struct Xdnd {
157 other_window: xproto::Window,
158 drag_type: u32,
159 retrieved: bool,
160 position: Point<Pixels>,
161}
162
163#[derive(Debug)]
164struct PointerDeviceState {
165 horizontal: ScrollAxisState,
166 vertical: ScrollAxisState,
167}
168
169#[derive(Debug, Default)]
170struct ScrollAxisState {
171 /// Valuator number for looking up this axis's scroll value.
172 valuator_number: Option<u16>,
173 /// Conversion factor from scroll units to lines.
174 multiplier: f32,
175 /// Last scroll value for calculating scroll delta.
176 ///
177 /// This gets set to `None` whenever it might be invalid - when devices change or when window focus changes.
178 /// The logic errs on the side of invalidating this, since the consequence is just skipping the delta of one scroll event.
179 /// The consequence of not invalidating it can be large invalid deltas, which are much more user visible.
180 scroll_value: Option<f32>,
181}
182
183pub struct X11ClientState {
184 pub(crate) loop_handle: LoopHandle<'static, X11Client>,
185 pub(crate) event_loop: Option<calloop::EventLoop<'static, X11Client>>,
186
187 pub(crate) last_click: Instant,
188 pub(crate) last_mouse_button: Option<MouseButton>,
189 pub(crate) last_location: Point<Pixels>,
190 pub(crate) current_count: usize,
191
192 gpu_context: BladeContext,
193
194 pub(crate) scale_factor: f32,
195
196 xkb_context: xkbc::Context,
197 pub(crate) xcb_connection: Rc<XCBConnection>,
198 xkb_device_id: i32,
199 client_side_decorations_supported: bool,
200 pub(crate) x_root_index: usize,
201 pub(crate) _resource_database: Database,
202 pub(crate) atoms: XcbAtoms,
203 pub(crate) windows: HashMap<xproto::Window, WindowRef>,
204 pub(crate) mouse_focused_window: Option<xproto::Window>,
205 pub(crate) keyboard_focused_window: Option<xproto::Window>,
206 pub(crate) xkb: State,
207 previous_xkb_state: XKBStateNotiy,
208 keyboard_layout: LinuxKeyboardLayout,
209 pub(crate) keyboard_layout: Box<LinuxKeyboardLayout>,
210 pub(crate) keyboard_mapper: Rc<LinuxKeyboardMapper>,
211 pub(crate) keyboard_mapper_cache: HashMap<String, Rc<LinuxKeyboardMapper>>,
212 pub(crate) ximc: Option<X11rbClient<Rc<XCBConnection>>>,
213 pub(crate) xim_handler: Option<XimHandler>,
214 pub modifiers: Modifiers,
215 pub capslock: Capslock,
216 // TODO: Can the other updates to `modifiers` be removed so that this is unnecessary?
217 // capslock logic was done analog to modifiers
218 pub last_modifiers_changed_event: Modifiers,
219 pub last_capslock_changed_event: Capslock,
220
221 pub(crate) compose_state: Option<xkbc::compose::State>,
222 pub(crate) pre_edit_text: Option<String>,
223 pub(crate) composing: bool,
224 pub(crate) pre_key_char_down: Option<Keystroke>,
225 pub(crate) cursor_handle: cursor::Handle,
226 pub(crate) cursor_styles: HashMap<xproto::Window, CursorStyle>,
227 pub(crate) cursor_cache: HashMap<CursorStyle, Option<xproto::Cursor>>,
228
229 pointer_device_states: BTreeMap<xinput::DeviceId, PointerDeviceState>,
230
231 pub(crate) common: LinuxCommon,
232 pub(crate) clipboard: Clipboard,
233 pub(crate) clipboard_item: Option<ClipboardItem>,
234 pub(crate) xdnd_state: Xdnd,
235}
236
237#[derive(Clone)]
238pub struct X11ClientStatePtr(pub Weak<RefCell<X11ClientState>>);
239
240impl X11ClientStatePtr {
241 fn get_client(&self) -> Option<X11Client> {
242 self.0.upgrade().map(X11Client)
243 }
244
245 pub fn drop_window(&self, x_window: u32) {
246 let Some(client) = self.get_client() else {
247 return;
248 };
249 let mut state = client.0.borrow_mut();
250
251 if let Some(window_ref) = state.windows.remove(&x_window) {
252 match window_ref.refresh_state {
253 Some(RefreshState::PeriodicRefresh {
254 event_loop_token, ..
255 }) => {
256 state.loop_handle.remove(event_loop_token);
257 }
258 _ => {}
259 }
260 }
261 if state.mouse_focused_window == Some(x_window) {
262 state.mouse_focused_window = None;
263 }
264 if state.keyboard_focused_window == Some(x_window) {
265 state.keyboard_focused_window = None;
266 }
267 state.cursor_styles.remove(&x_window);
268
269 if state.windows.is_empty() {
270 state.common.signal.stop();
271 }
272 }
273
274 pub fn update_ime_position(&self, bounds: Bounds<ScaledPixels>) {
275 let Some(client) = self.get_client() else {
276 return;
277 };
278 let mut state = client.0.borrow_mut();
279 if state.composing || state.ximc.is_none() {
280 return;
281 }
282
283 let Some(mut ximc) = state.ximc.take() else {
284 log::error!("bug: xim connection not set");
285 return;
286 };
287 let Some(xim_handler) = state.xim_handler.take() else {
288 log::error!("bug: xim handler not set");
289 state.ximc = Some(ximc);
290 return;
291 };
292 let ic_attributes = ximc
293 .build_ic_attributes()
294 .push(
295 xim::AttributeName::InputStyle,
296 xim::InputStyle::PREEDIT_CALLBACKS,
297 )
298 .push(xim::AttributeName::ClientWindow, xim_handler.window)
299 .push(xim::AttributeName::FocusWindow, xim_handler.window)
300 .nested_list(xim::AttributeName::PreeditAttributes, |b| {
301 b.push(
302 xim::AttributeName::SpotLocation,
303 xim::Point {
304 x: u32::from(bounds.origin.x + bounds.size.width) as i16,
305 y: u32::from(bounds.origin.y + bounds.size.height) as i16,
306 },
307 );
308 })
309 .build();
310 let _ = ximc
311 .set_ic_values(xim_handler.im_id, xim_handler.ic_id, ic_attributes)
312 .log_err();
313 state.ximc = Some(ximc);
314 state.xim_handler = Some(xim_handler);
315 }
316}
317
318#[derive(Clone)]
319pub(crate) struct X11Client(Rc<RefCell<X11ClientState>>);
320
321impl X11Client {
322 pub(crate) fn new() -> anyhow::Result<Self> {
323 let event_loop = EventLoop::try_new()?;
324
325 let (common, main_receiver) = LinuxCommon::new(event_loop.get_signal());
326
327 let handle = event_loop.handle();
328
329 handle
330 .insert_source(main_receiver, {
331 let handle = handle.clone();
332 move |event, _, _: &mut X11Client| {
333 if let calloop::channel::Event::Msg(runnable) = event {
334 // Insert the runnables as idle callbacks, so we make sure that user-input and X11
335 // events have higher priority and runnables are only worked off after the event
336 // callbacks.
337 handle.insert_idle(|_| {
338 runnable.run();
339 });
340 }
341 }
342 })
343 .map_err(|err| {
344 anyhow!("Failed to initialize event loop handling of foreground tasks: {err:?}")
345 })?;
346
347 let (xcb_connection, x_root_index) = XCBConnection::connect(None)?;
348 xcb_connection.prefetch_extension_information(xkb::X11_EXTENSION_NAME)?;
349 xcb_connection.prefetch_extension_information(randr::X11_EXTENSION_NAME)?;
350 xcb_connection.prefetch_extension_information(render::X11_EXTENSION_NAME)?;
351 xcb_connection.prefetch_extension_information(xinput::X11_EXTENSION_NAME)?;
352
353 // Announce to X server that XInput up to 2.1 is supported. To increase this to 2.2 and
354 // beyond, support for touch events would need to be added.
355 let xinput_version = get_reply(
356 || "XInput XiQueryVersion failed",
357 xcb_connection.xinput_xi_query_version(2, 1),
358 )?;
359 assert!(
360 xinput_version.major_version >= 2,
361 "XInput version >= 2 required."
362 );
363
364 let pointer_device_states =
365 current_pointer_device_states(&xcb_connection, &BTreeMap::new()).unwrap_or_default();
366
367 let atoms = XcbAtoms::new(&xcb_connection)
368 .context("Failed to get XCB atoms")?
369 .reply()
370 .context("Failed to get XCB atoms")?;
371
372 let root = xcb_connection.setup().roots[0].root;
373 let compositor_present = check_compositor_present(&xcb_connection, root);
374 let gtk_frame_extents_supported =
375 check_gtk_frame_extents_supported(&xcb_connection, &atoms, root);
376 let client_side_decorations_supported = compositor_present && gtk_frame_extents_supported;
377 log::info!(
378 "x11: compositor present: {}, gtk_frame_extents_supported: {}",
379 compositor_present,
380 gtk_frame_extents_supported
381 );
382
383 let xkb = get_reply(
384 || "Failed to initialize XKB extension",
385 xcb_connection
386 .xkb_use_extension(XKB_X11_MIN_MAJOR_XKB_VERSION, XKB_X11_MIN_MINOR_XKB_VERSION),
387 )?;
388 assert!(xkb.supported);
389
390 let events = xkb::EventType::STATE_NOTIFY
391 | xkb::EventType::MAP_NOTIFY
392 | xkb::EventType::NEW_KEYBOARD_NOTIFY;
393 let map_notify_parts = xkb::MapPart::KEY_TYPES
394 | xkb::MapPart::KEY_SYMS
395 | xkb::MapPart::MODIFIER_MAP
396 | xkb::MapPart::EXPLICIT_COMPONENTS
397 | xkb::MapPart::KEY_ACTIONS
398 | xkb::MapPart::KEY_BEHAVIORS
399 | xkb::MapPart::VIRTUAL_MODS
400 | xkb::MapPart::VIRTUAL_MOD_MAP;
401 check_reply(
402 || "Failed to select XKB events",
403 xcb_connection.xkb_select_events(
404 xkb::ID::USE_CORE_KBD.into(),
405 0u8.into(),
406 events,
407 map_notify_parts,
408 map_notify_parts,
409 &xkb::SelectEventsAux::new(),
410 ),
411 )?;
412
413 let xkb_context = xkbc::Context::new(xkbc::CONTEXT_NO_FLAGS);
414 let xkb_device_id = xkbc::x11::get_core_keyboard_device_id(&xcb_connection);
415 let xkb_state = {
416 let xkb_keymap = xkbc::x11::keymap_new_from_device(
417 &xkb_context,
418 &xcb_connection,
419 xkb_device_id,
420 xkbc::KEYMAP_COMPILE_NO_FLAGS,
421 );
422 xkbc::x11::state_new_from_device(&xkb_keymap, &xcb_connection, xkb_device_id)
423 };
424 let compose_state = get_xkb_compose_state(&xkb_context);
425 let layout_idx = xkb_state.serialize_layout(STATE_LAYOUT_EFFECTIVE);
426 let layout_name = xkb_state
427 .get_keymap()
428 .layout_get_name(layout_idx)
429 .to_string();
430 let keyboard_layout = LinuxKeyboardLayout::new(layout_name.into());
431 let keyboard_layout = Box::new(LinuxKeyboardLayout::new(&xkb_state));
432 let keyboard_mapper = Rc::new(LinuxKeyboardMapper::new(0, 0, 0));
433 let mut keyboard_mapper_cache = HashMap::default();
434 keyboard_mapper_cache.insert(keyboard_layout.id().to_string(), keyboard_mapper.clone());
435
436 let gpu_context = BladeContext::new().context("Unable to init GPU context")?;
437
438 let resource_database = x11rb::resource_manager::new_from_default(&xcb_connection)
439 .context("Failed to create resource database")?;
440 let scale_factor = resource_database
441 .get_value("Xft.dpi", "Xft.dpi")
442 .ok()
443 .flatten()
444 .map(|dpi: f32| dpi / 96.0)
445 .unwrap_or(1.0);
446 let cursor_handle = cursor::Handle::new(&xcb_connection, x_root_index, &resource_database)
447 .context("Failed to initialize cursor theme handler")?
448 .reply()
449 .context("Failed to initialize cursor theme handler")?;
450
451 let clipboard = Clipboard::new().context("Failed to initialize clipboard")?;
452
453 let xcb_connection = Rc::new(xcb_connection);
454
455 let ximc = X11rbClient::init(Rc::clone(&xcb_connection), x_root_index, None).ok();
456 let xim_handler = if ximc.is_some() {
457 Some(XimHandler::new())
458 } else {
459 None
460 };
461
462 // Safety: Safe if xcb::Connection always returns a valid fd
463 let fd = unsafe { FdWrapper::new(Rc::clone(&xcb_connection)) };
464
465 handle
466 .insert_source(
467 Generic::new_with_error::<EventHandlerError>(
468 fd,
469 calloop::Interest::READ,
470 calloop::Mode::Level,
471 ),
472 {
473 let xcb_connection = xcb_connection.clone();
474 move |_readiness, _, client| {
475 client.process_x11_events(&xcb_connection)?;
476 Ok(calloop::PostAction::Continue)
477 }
478 },
479 )
480 .map_err(|err| anyhow!("Failed to initialize X11 event source: {err:?}"))?;
481
482 handle
483 .insert_source(XDPEventSource::new(&common.background_executor), {
484 move |event, _, client| match event {
485 XDPEvent::WindowAppearance(appearance) => {
486 client.with_common(|common| common.appearance = appearance);
487 for (_, window) in &mut client.0.borrow_mut().windows {
488 window.window.set_appearance(appearance);
489 }
490 }
491 XDPEvent::CursorTheme(_) | XDPEvent::CursorSize(_) => {
492 // noop, X11 manages this for us.
493 }
494 }
495 })
496 .map_err(|err| anyhow!("Failed to initialize XDP event source: {err:?}"))?;
497
498 xcb_flush(&xcb_connection);
499
500 Ok(X11Client(Rc::new(RefCell::new(X11ClientState {
501 modifiers: Modifiers::default(),
502 capslock: Capslock::default(),
503 last_modifiers_changed_event: Modifiers::default(),
504 last_capslock_changed_event: Capslock::default(),
505 event_loop: Some(event_loop),
506 loop_handle: handle,
507 common,
508 last_click: Instant::now(),
509 last_mouse_button: None,
510 last_location: Point::new(px(0.0), px(0.0)),
511 current_count: 0,
512 gpu_context,
513 scale_factor,
514
515 xkb_context,
516 xcb_connection,
517 xkb_device_id,
518 client_side_decorations_supported,
519 x_root_index,
520 _resource_database: resource_database,
521 atoms,
522 windows: HashMap::default(),
523 mouse_focused_window: None,
524 keyboard_focused_window: None,
525 xkb: xkb_state,
526 previous_xkb_state: XKBStateNotiy::default(),
527 keyboard_layout,
528 keyboard_mapper,
529 keyboard_mapper_cache,
530 ximc,
531 xim_handler,
532
533 compose_state,
534 pre_edit_text: None,
535 pre_key_char_down: None,
536 composing: false,
537
538 cursor_handle,
539 cursor_styles: HashMap::default(),
540 cursor_cache: HashMap::default(),
541
542 pointer_device_states,
543
544 clipboard,
545 clipboard_item: None,
546 xdnd_state: Xdnd::default(),
547 }))))
548 }
549
550 pub fn process_x11_events(
551 &self,
552 xcb_connection: &XCBConnection,
553 ) -> Result<(), EventHandlerError> {
554 loop {
555 let mut events = Vec::new();
556 let mut windows_to_refresh = HashSet::new();
557
558 let mut last_key_release = None;
559 let mut last_key_press: Option<KeyPressEvent> = None;
560
561 // event handlers for new keyboard / remapping refresh the state without using event
562 // details, this deduplicates them.
563 let mut last_keymap_change_event: Option<Event> = None;
564
565 loop {
566 match xcb_connection.poll_for_event() {
567 Ok(Some(event)) => {
568 match event {
569 Event::Expose(expose_event) => {
570 windows_to_refresh.insert(expose_event.window);
571 }
572 Event::KeyRelease(_) => {
573 if let Some(last_keymap_change_event) =
574 last_keymap_change_event.take()
575 {
576 if let Some(last_key_release) = last_key_release.take() {
577 events.push(last_key_release);
578 }
579 last_key_press = None;
580 events.push(last_keymap_change_event);
581 }
582
583 last_key_release = Some(event);
584 }
585 Event::KeyPress(key_press) => {
586 if let Some(last_keymap_change_event) =
587 last_keymap_change_event.take()
588 {
589 if let Some(last_key_release) = last_key_release.take() {
590 events.push(last_key_release);
591 }
592 last_key_press = None;
593 events.push(last_keymap_change_event);
594 }
595
596 if let Some(last_press) = last_key_press.as_ref() {
597 if last_press.detail == key_press.detail {
598 continue;
599 }
600 }
601
602 if let Some(Event::KeyRelease(key_release)) =
603 last_key_release.take()
604 {
605 // We ignore that last KeyRelease if it's too close to this KeyPress,
606 // suggesting that it's auto-generated by X11 as a key-repeat event.
607 if key_release.detail != key_press.detail
608 || key_press.time.saturating_sub(key_release.time) > 20
609 {
610 events.push(Event::KeyRelease(key_release));
611 }
612 }
613 events.push(Event::KeyPress(key_press));
614 last_key_press = Some(key_press);
615 }
616 Event::XkbNewKeyboardNotify(_) | Event::XkbMapNotify(_) => {
617 if let Some(release_event) = last_key_release.take() {
618 events.push(release_event);
619 }
620 last_keymap_change_event = Some(event);
621 }
622 _ => {
623 if let Some(release_event) = last_key_release.take() {
624 events.push(release_event);
625 }
626 events.push(event);
627 }
628 }
629 }
630 Ok(None) => {
631 break;
632 }
633 Err(err) => {
634 let err = handle_connection_error(err);
635 log::warn!("error while polling for X11 events: {err:?}");
636 break;
637 }
638 }
639 }
640
641 if let Some(release_event) = last_key_release.take() {
642 events.push(release_event);
643 }
644 if let Some(keymap_change_event) = last_keymap_change_event.take() {
645 events.push(keymap_change_event);
646 }
647
648 if events.is_empty() && windows_to_refresh.is_empty() {
649 break;
650 }
651
652 for window in windows_to_refresh.into_iter() {
653 let mut state = self.0.borrow_mut();
654 if let Some(window) = state.windows.get_mut(&window) {
655 window.expose_event_received = true;
656 }
657 }
658
659 for event in events.into_iter() {
660 let mut state = self.0.borrow_mut();
661 if !state.has_xim() {
662 drop(state);
663 self.handle_event(event);
664 continue;
665 }
666
667 let Some((mut ximc, mut xim_handler)) = state.take_xim() else {
668 continue;
669 };
670 let xim_connected = xim_handler.connected;
671 drop(state);
672
673 let xim_filtered = match ximc.filter_event(&event, &mut xim_handler) {
674 Ok(handled) => handled,
675 Err(err) => {
676 log::error!("XIMClientError: {}", err);
677 false
678 }
679 };
680 let xim_callback_event = xim_handler.last_callback_event.take();
681
682 let mut state = self.0.borrow_mut();
683 state.restore_xim(ximc, xim_handler);
684 drop(state);
685
686 if let Some(event) = xim_callback_event {
687 self.handle_xim_callback_event(event);
688 }
689
690 if xim_filtered {
691 continue;
692 }
693
694 if xim_connected {
695 self.xim_handle_event(event);
696 } else {
697 self.handle_event(event);
698 }
699 }
700 }
701 Ok(())
702 }
703
704 pub fn enable_ime(&self) {
705 let mut state = self.0.borrow_mut();
706 if !state.has_xim() {
707 return;
708 }
709
710 let Some((mut ximc, mut xim_handler)) = state.take_xim() else {
711 return;
712 };
713 let mut ic_attributes = ximc
714 .build_ic_attributes()
715 .push(AttributeName::InputStyle, InputStyle::PREEDIT_CALLBACKS)
716 .push(AttributeName::ClientWindow, xim_handler.window)
717 .push(AttributeName::FocusWindow, xim_handler.window);
718
719 let window_id = state.keyboard_focused_window;
720 drop(state);
721 if let Some(window_id) = window_id {
722 let Some(window) = self.get_window(window_id) else {
723 log::error!("Failed to get window for IME positioning");
724 let mut state = self.0.borrow_mut();
725 state.ximc = Some(ximc);
726 state.xim_handler = Some(xim_handler);
727 return;
728 };
729 if let Some(area) = window.get_ime_area() {
730 ic_attributes =
731 ic_attributes.nested_list(xim::AttributeName::PreeditAttributes, |b| {
732 b.push(
733 xim::AttributeName::SpotLocation,
734 xim::Point {
735 x: u32::from(area.origin.x + area.size.width) as i16,
736 y: u32::from(area.origin.y + area.size.height) as i16,
737 },
738 );
739 });
740 }
741 }
742 ximc.create_ic(xim_handler.im_id, ic_attributes.build())
743 .ok();
744 let mut state = self.0.borrow_mut();
745 state.restore_xim(ximc, xim_handler);
746 }
747
748 pub fn reset_ime(&self) {
749 let mut state = self.0.borrow_mut();
750 state.composing = false;
751 if let Some(mut ximc) = state.ximc.take() {
752 if let Some(xim_handler) = state.xim_handler.as_ref() {
753 ximc.reset_ic(xim_handler.im_id, xim_handler.ic_id).ok();
754 } else {
755 log::error!("bug: xim handler not set in reset_ime");
756 }
757 state.ximc = Some(ximc);
758 }
759 }
760
761 fn get_window(&self, win: xproto::Window) -> Option<X11WindowStatePtr> {
762 let state = self.0.borrow();
763 state
764 .windows
765 .get(&win)
766 .filter(|window_reference| !window_reference.window.state.borrow().destroyed)
767 .map(|window_reference| window_reference.window.clone())
768 }
769
770 fn handle_event(&self, event: Event) -> Option<()> {
771 match event {
772 Event::UnmapNotify(event) => {
773 let mut state = self.0.borrow_mut();
774 if let Some(window_ref) = state.windows.get_mut(&event.window) {
775 window_ref.is_mapped = false;
776 }
777 state.update_refresh_loop(event.window);
778 }
779 Event::MapNotify(event) => {
780 let mut state = self.0.borrow_mut();
781 if let Some(window_ref) = state.windows.get_mut(&event.window) {
782 window_ref.is_mapped = true;
783 }
784 state.update_refresh_loop(event.window);
785 }
786 Event::VisibilityNotify(event) => {
787 let mut state = self.0.borrow_mut();
788 if let Some(window_ref) = state.windows.get_mut(&event.window) {
789 window_ref.last_visibility = event.state;
790 }
791 state.update_refresh_loop(event.window);
792 }
793 Event::ClientMessage(event) => {
794 let window = self.get_window(event.window)?;
795 let [atom, arg1, arg2, arg3, arg4] = event.data.as_data32();
796 let mut state = self.0.borrow_mut();
797
798 if atom == state.atoms.WM_DELETE_WINDOW {
799 // window "x" button clicked by user
800 if window.should_close() {
801 // Rest of the close logic is handled in drop_window()
802 window.close();
803 }
804 } else if atom == state.atoms._NET_WM_SYNC_REQUEST {
805 window.state.borrow_mut().last_sync_counter =
806 Some(x11rb::protocol::sync::Int64 {
807 lo: arg2,
808 hi: arg3 as i32,
809 })
810 }
811
812 if event.type_ == state.atoms.XdndEnter {
813 state.xdnd_state.other_window = atom;
814 if (arg1 & 0x1) == 0x1 {
815 state.xdnd_state.drag_type = xdnd_get_supported_atom(
816 &state.xcb_connection,
817 &state.atoms,
818 state.xdnd_state.other_window,
819 );
820 } else {
821 if let Some(atom) = [arg2, arg3, arg4]
822 .into_iter()
823 .find(|atom| xdnd_is_atom_supported(*atom, &state.atoms))
824 {
825 state.xdnd_state.drag_type = atom;
826 }
827 }
828 } else if event.type_ == state.atoms.XdndLeave {
829 let position = state.xdnd_state.position;
830 drop(state);
831 window
832 .handle_input(PlatformInput::FileDrop(FileDropEvent::Pending { position }));
833 window.handle_input(PlatformInput::FileDrop(FileDropEvent::Exited {}));
834 self.0.borrow_mut().xdnd_state = Xdnd::default();
835 } else if event.type_ == state.atoms.XdndPosition {
836 if let Ok(pos) = get_reply(
837 || "Failed to query pointer position",
838 state.xcb_connection.query_pointer(event.window),
839 ) {
840 state.xdnd_state.position =
841 Point::new(Pixels(pos.win_x as f32), Pixels(pos.win_y as f32));
842 }
843 if !state.xdnd_state.retrieved {
844 check_reply(
845 || "Failed to convert selection for drag and drop",
846 state.xcb_connection.convert_selection(
847 event.window,
848 state.atoms.XdndSelection,
849 state.xdnd_state.drag_type,
850 state.atoms.XDND_DATA,
851 arg3,
852 ),
853 )
854 .log_err();
855 }
856 xdnd_send_status(
857 &state.xcb_connection,
858 &state.atoms,
859 event.window,
860 state.xdnd_state.other_window,
861 arg4,
862 );
863 let position = state.xdnd_state.position;
864 drop(state);
865 window
866 .handle_input(PlatformInput::FileDrop(FileDropEvent::Pending { position }));
867 } else if event.type_ == state.atoms.XdndDrop {
868 xdnd_send_finished(
869 &state.xcb_connection,
870 &state.atoms,
871 event.window,
872 state.xdnd_state.other_window,
873 );
874 let position = state.xdnd_state.position;
875 drop(state);
876 window
877 .handle_input(PlatformInput::FileDrop(FileDropEvent::Submit { position }));
878 self.0.borrow_mut().xdnd_state = Xdnd::default();
879 }
880 }
881 Event::SelectionNotify(event) => {
882 let window = self.get_window(event.requestor)?;
883 let mut state = self.0.borrow_mut();
884 let reply = get_reply(
885 || "Failed to get XDND_DATA",
886 state.xcb_connection.get_property(
887 false,
888 event.requestor,
889 state.atoms.XDND_DATA,
890 AtomEnum::ANY,
891 0,
892 1024,
893 ),
894 )
895 .log_err();
896 let Some(reply) = reply else {
897 return Some(());
898 };
899 match str::from_utf8(&reply.value) {
900 Ok(file_list) => {
901 let paths: SmallVec<[_; 2]> = file_list
902 .lines()
903 .filter_map(|path| Url::parse(path).log_err())
904 .filter_map(|url| url.to_file_path().log_err())
905 .collect();
906 let input = PlatformInput::FileDrop(FileDropEvent::Entered {
907 position: state.xdnd_state.position,
908 paths: crate::ExternalPaths(paths),
909 });
910 drop(state);
911 window.handle_input(input);
912 self.0.borrow_mut().xdnd_state.retrieved = true;
913 }
914 Err(_) => {}
915 }
916 }
917 Event::ConfigureNotify(event) => {
918 let bounds = Bounds {
919 origin: Point {
920 x: event.x.into(),
921 y: event.y.into(),
922 },
923 size: Size {
924 width: event.width.into(),
925 height: event.height.into(),
926 },
927 };
928 let window = self.get_window(event.window)?;
929 window
930 .set_bounds(bounds)
931 .context("X11: Failed to set window bounds")
932 .log_err();
933 }
934 Event::PropertyNotify(event) => {
935 let window = self.get_window(event.window)?;
936 window
937 .property_notify(event)
938 .context("X11: Failed to handle property notify")
939 .log_err();
940 }
941 Event::FocusIn(event) => {
942 let window = self.get_window(event.event)?;
943 window.set_active(true);
944 let mut state = self.0.borrow_mut();
945 state.keyboard_focused_window = Some(event.event);
946 if let Some(handler) = state.xim_handler.as_mut() {
947 handler.window = event.event;
948 }
949 drop(state);
950 self.enable_ime();
951 }
952 Event::FocusOut(event) => {
953 let window = self.get_window(event.event)?;
954 window.set_active(false);
955 let mut state = self.0.borrow_mut();
956 state.keyboard_focused_window = None;
957 if let Some(compose_state) = state.compose_state.as_mut() {
958 compose_state.reset();
959 }
960 state.pre_edit_text.take();
961 drop(state);
962 self.reset_ime();
963 window.handle_ime_delete();
964 }
965 Event::XkbNewKeyboardNotify(_) | Event::XkbMapNotify(_) => {
966 let mut state = self.0.borrow_mut();
967 let xkb_state = {
968 let xkb_keymap = xkbc::x11::keymap_new_from_device(
969 &state.xkb_context,
970 &state.xcb_connection,
971 state.xkb_device_id,
972 xkbc::KEYMAP_COMPILE_NO_FLAGS,
973 );
974 xkbc::x11::state_new_from_device(
975 &xkb_keymap,
976 &state.xcb_connection,
977 state.xkb_device_id,
978 )
979 };
980 let depressed_layout = xkb_state.serialize_layout(xkbc::STATE_LAYOUT_DEPRESSED);
981 let latched_layout = xkb_state.serialize_layout(xkbc::STATE_LAYOUT_LATCHED);
982 let locked_layout = xkb_state.serialize_layout(xkbc::ffi::XKB_STATE_LAYOUT_LOCKED);
983 state.previous_xkb_state = XKBStateNotiy {
984 depressed_layout,
985 latched_layout,
986 locked_layout,
987 };
988 let keyboard_layout = LinuxKeyboardLayout::new(&xkb_state);
989 state.xkb = xkb_state;
990 drop(state);
991 self.handle_keyboard_layout_change();
992 update_keyboard_mapper(&mut state, keyboard_layout, 0, 0, 0);
993 }
994 Event::XkbStateNotify(event) => {
995 let mut state = self.0.borrow_mut();
996 let old_layout = state.xkb.serialize_layout(STATE_LAYOUT_EFFECTIVE);
997 let new_layout = u32::from(event.group);
998 let base_group = event.base_group as u32;
999 let latched_group = event.latched_group as u32;
1000 let locked_group = event.locked_group.into();
1001 state.xkb.update_mask(
1002 event.base_mods.into(),
1003 event.latched_mods.into(),
1004 event.locked_mods.into(),
1005 base_group,
1006 latched_group,
1007 locked_group,
1008 );
1009 state.previous_xkb_state = XKBStateNotiy {
1010 depressed_layout: base_group,
1011 latched_layout: latched_group,
1012 locked_layout: locked_group,
1013 };
1014
1015 let modifiers = Modifiers::from_xkb(&state.keyboard_state.state);
1016 let capslock = Capslock::from_xkb(&state.keyboard_state.state);
1017 if state.last_modifiers_changed_event == modifiers
1018 && state.last_capslock_changed_event == capslock
1019 {
1020 drop(state);
1021 } else {
1022 let focused_window_id = state.keyboard_focused_window?;
1023 state.modifiers = modifiers;
1024 state.last_modifiers_changed_event = modifiers;
1025 state.capslock = capslock;
1026 state.last_capslock_changed_event = capslock;
1027 drop(state);
1028
1029 let focused_window = self.get_window(focused_window_id)?;
1030 focused_window.handle_input(PlatformInput::ModifiersChanged(
1031 ModifiersChangedEvent {
1032 modifiers,
1033 capslock,
1034 },
1035 ));
1036 }
1037
1038 if new_layout != old_layout {
1039 self.handle_keyboard_layout_change();
1040 }
1041 }
1042 Event::KeyPress(event) => {
1043 let window = self.get_window(event.event)?;
1044 let mut state = self.0.borrow_mut();
1045
1046 let modifiers = modifiers_from_state(event.state);
1047 state.modifiers = modifiers;
1048 state.pre_key_char_down.take();
1049 let keystroke = {
1050 let code = event.detail.into();
1051 let xkb_state = state.previous_xkb_state.clone();
1052 state.xkb.update_mask(
1053 event.state.bits() as ModMask,
1054 0,
1055 0,
1056 xkb_state.depressed_layout,
1057 xkb_state.latched_layout,
1058 xkb_state.locked_layout,
1059 );
1060 let mut keystroke = crate::Keystroke::from_xkb(
1061 &state.xkb,
1062 &state.keyboard_mapper,
1063 modifiers,
1064 code,
1065 );
1066 let keysym = state.xkb.key_get_one_sym(code);
1067 if keysym.is_modifier_key() {
1068 return Some(());
1069 }
1070 if let Some(mut compose_state) = state.compose_state.take() {
1071 compose_state.feed(keysym);
1072 match compose_state.status() {
1073 xkbc::Status::Composed => {
1074 state.pre_edit_text.take();
1075 keystroke.key_char = compose_state.utf8();
1076 if let Some(keysym) = compose_state.keysym() {
1077 keystroke.key = xkbc::keysym_get_name(keysym);
1078 }
1079 }
1080 xkbc::Status::Composing => {
1081 keystroke.key_char = None;
1082 state.pre_edit_text =
1083 compose_state.utf8().or(underlying_dead_key(keysym));
1084 let pre_edit =
1085 state.pre_edit_text.clone().unwrap_or(String::default());
1086 drop(state);
1087 window.handle_ime_preedit(pre_edit);
1088 state = self.0.borrow_mut();
1089 }
1090 xkbc::Status::Cancelled => {
1091 let pre_edit = state.pre_edit_text.take();
1092 drop(state);
1093 if let Some(pre_edit) = pre_edit {
1094 window.handle_ime_commit(pre_edit);
1095 }
1096 if let Some(current_key) = underlying_dead_key(keysym) {
1097 window.handle_ime_preedit(current_key);
1098 }
1099 state = self.0.borrow_mut();
1100 compose_state.feed(keysym);
1101 }
1102 _ => {}
1103 }
1104 state.compose_state = Some(compose_state);
1105 }
1106 keystroke
1107 };
1108 drop(state);
1109 window.handle_input(PlatformInput::KeyDown(crate::KeyDownEvent {
1110 keystroke,
1111 is_held: false,
1112 }));
1113 }
1114 Event::KeyRelease(event) => {
1115 let window = self.get_window(event.event)?;
1116 let mut state = self.0.borrow_mut();
1117
1118 let modifiers = modifiers_from_state(event.state);
1119 state.modifiers = modifiers;
1120
1121 let keystroke = {
1122 let code = event.detail.into();
1123 let xkb_state = state.previous_xkb_state.clone();
1124 state.xkb.update_mask(
1125 event.state.bits() as ModMask,
1126 0,
1127 0,
1128 xkb_state.depressed_layout,
1129 xkb_state.latched_layout,
1130 xkb_state.locked_layout,
1131 );
1132 let keystroke = crate::Keystroke::from_xkb(
1133 &state.xkb,
1134 &state.keyboard_mapper,
1135 modifiers,
1136 code,
1137 );
1138 let keysym = state.xkb.key_get_one_sym(code);
1139 if keysym.is_modifier_key() {
1140 return Some(());
1141 }
1142 keystroke
1143 };
1144 drop(state);
1145 window.handle_input(PlatformInput::KeyUp(crate::KeyUpEvent { keystroke }));
1146 }
1147 Event::XinputButtonPress(event) => {
1148 let window = self.get_window(event.event)?;
1149 let mut state = self.0.borrow_mut();
1150
1151 let modifiers = modifiers_from_xinput_info(event.mods);
1152 state.modifiers = modifiers;
1153
1154 let position = point(
1155 px(event.event_x as f32 / u16::MAX as f32 / state.scale_factor),
1156 px(event.event_y as f32 / u16::MAX as f32 / state.scale_factor),
1157 );
1158
1159 if state.composing && state.ximc.is_some() {
1160 drop(state);
1161 self.reset_ime();
1162 window.handle_ime_unmark();
1163 state = self.0.borrow_mut();
1164 } else if let Some(text) = state.pre_edit_text.take() {
1165 if let Some(compose_state) = state.compose_state.as_mut() {
1166 compose_state.reset();
1167 }
1168 drop(state);
1169 window.handle_ime_commit(text);
1170 state = self.0.borrow_mut();
1171 }
1172 match button_or_scroll_from_event_detail(event.detail) {
1173 Some(ButtonOrScroll::Button(button)) => {
1174 let click_elapsed = state.last_click.elapsed();
1175 if click_elapsed < DOUBLE_CLICK_INTERVAL
1176 && state
1177 .last_mouse_button
1178 .is_some_and(|prev_button| prev_button == button)
1179 && is_within_click_distance(state.last_location, position)
1180 {
1181 state.current_count += 1;
1182 } else {
1183 state.current_count = 1;
1184 }
1185
1186 state.last_click = Instant::now();
1187 state.last_mouse_button = Some(button);
1188 state.last_location = position;
1189 let current_count = state.current_count;
1190
1191 drop(state);
1192 window.handle_input(PlatformInput::MouseDown(crate::MouseDownEvent {
1193 button,
1194 position,
1195 modifiers,
1196 click_count: current_count,
1197 first_mouse: false,
1198 }));
1199 }
1200 Some(ButtonOrScroll::Scroll(direction)) => {
1201 drop(state);
1202 // Emulated scroll button presses are sent simultaneously with smooth scrolling XinputMotion events.
1203 // Since handling those events does the scrolling, they are skipped here.
1204 if !event
1205 .flags
1206 .contains(xinput::PointerEventFlags::POINTER_EMULATED)
1207 {
1208 let scroll_delta = match direction {
1209 ScrollDirection::Up => Point::new(0.0, SCROLL_LINES),
1210 ScrollDirection::Down => Point::new(0.0, -SCROLL_LINES),
1211 ScrollDirection::Left => Point::new(SCROLL_LINES, 0.0),
1212 ScrollDirection::Right => Point::new(-SCROLL_LINES, 0.0),
1213 };
1214 window.handle_input(PlatformInput::ScrollWheel(
1215 make_scroll_wheel_event(position, scroll_delta, modifiers),
1216 ));
1217 }
1218 }
1219 None => {
1220 log::error!("Unknown x11 button: {}", event.detail);
1221 }
1222 }
1223 }
1224 Event::XinputButtonRelease(event) => {
1225 let window = self.get_window(event.event)?;
1226 let mut state = self.0.borrow_mut();
1227 let modifiers = modifiers_from_xinput_info(event.mods);
1228 state.modifiers = modifiers;
1229
1230 let position = point(
1231 px(event.event_x as f32 / u16::MAX as f32 / state.scale_factor),
1232 px(event.event_y as f32 / u16::MAX as f32 / state.scale_factor),
1233 );
1234 match button_or_scroll_from_event_detail(event.detail) {
1235 Some(ButtonOrScroll::Button(button)) => {
1236 let click_count = state.current_count;
1237 drop(state);
1238 window.handle_input(PlatformInput::MouseUp(crate::MouseUpEvent {
1239 button,
1240 position,
1241 modifiers,
1242 click_count,
1243 }));
1244 }
1245 Some(ButtonOrScroll::Scroll(_)) => {}
1246 None => {}
1247 }
1248 }
1249 Event::XinputMotion(event) => {
1250 let window = self.get_window(event.event)?;
1251 let mut state = self.0.borrow_mut();
1252 let pressed_button = pressed_button_from_mask(event.button_mask[0]);
1253 let position = point(
1254 px(event.event_x as f32 / u16::MAX as f32 / state.scale_factor),
1255 px(event.event_y as f32 / u16::MAX as f32 / state.scale_factor),
1256 );
1257 let modifiers = modifiers_from_xinput_info(event.mods);
1258 state.modifiers = modifiers;
1259 drop(state);
1260
1261 if event.valuator_mask[0] & 3 != 0 {
1262 window.handle_input(PlatformInput::MouseMove(crate::MouseMoveEvent {
1263 position,
1264 pressed_button,
1265 modifiers,
1266 }));
1267 }
1268
1269 state = self.0.borrow_mut();
1270 if let Some(mut pointer) = state.pointer_device_states.get_mut(&event.sourceid) {
1271 let scroll_delta = get_scroll_delta_and_update_state(&mut pointer, &event);
1272 drop(state);
1273 if let Some(scroll_delta) = scroll_delta {
1274 window.handle_input(PlatformInput::ScrollWheel(make_scroll_wheel_event(
1275 position,
1276 scroll_delta,
1277 modifiers,
1278 )));
1279 }
1280 }
1281 }
1282 Event::XinputEnter(event) if event.mode == xinput::NotifyMode::NORMAL => {
1283 let window = self.get_window(event.event)?;
1284 window.set_hovered(true);
1285 let mut state = self.0.borrow_mut();
1286 state.mouse_focused_window = Some(event.event);
1287 }
1288 Event::XinputLeave(event) if event.mode == xinput::NotifyMode::NORMAL => {
1289 let mut state = self.0.borrow_mut();
1290
1291 // Set last scroll values to `None` so that a large delta isn't created if scrolling is done outside the window (the valuator is global)
1292 reset_all_pointer_device_scroll_positions(&mut state.pointer_device_states);
1293 state.mouse_focused_window = None;
1294 let pressed_button = pressed_button_from_mask(event.buttons[0]);
1295 let position = point(
1296 px(event.event_x as f32 / u16::MAX as f32 / state.scale_factor),
1297 px(event.event_y as f32 / u16::MAX as f32 / state.scale_factor),
1298 );
1299 let modifiers = modifiers_from_xinput_info(event.mods);
1300 state.modifiers = modifiers;
1301 drop(state);
1302
1303 let window = self.get_window(event.event)?;
1304 window.handle_input(PlatformInput::MouseExited(crate::MouseExitEvent {
1305 pressed_button,
1306 position,
1307 modifiers,
1308 }));
1309 window.set_hovered(false);
1310 }
1311 Event::XinputHierarchy(event) => {
1312 let mut state = self.0.borrow_mut();
1313 // Temporarily use `state.pointer_device_states` to only store pointers that still have valid scroll values.
1314 // Any change to a device invalidates its scroll values.
1315 for info in event.infos {
1316 if is_pointer_device(info.type_) {
1317 state.pointer_device_states.remove(&info.deviceid);
1318 }
1319 }
1320 if let Some(pointer_device_states) = current_pointer_device_states(
1321 &state.xcb_connection,
1322 &state.pointer_device_states,
1323 ) {
1324 state.pointer_device_states = pointer_device_states;
1325 }
1326 }
1327 Event::XinputDeviceChanged(event) => {
1328 let mut state = self.0.borrow_mut();
1329 if let Some(mut pointer) = state.pointer_device_states.get_mut(&event.sourceid) {
1330 reset_pointer_device_scroll_positions(&mut pointer);
1331 }
1332 }
1333 _ => {}
1334 };
1335
1336 Some(())
1337 }
1338
1339 fn handle_xim_callback_event(&self, event: XimCallbackEvent) {
1340 match event {
1341 XimCallbackEvent::XimXEvent(event) => {
1342 self.handle_event(event);
1343 }
1344 XimCallbackEvent::XimCommitEvent(window, text) => {
1345 self.xim_handle_commit(window, text);
1346 }
1347 XimCallbackEvent::XimPreeditEvent(window, text) => {
1348 self.xim_handle_preedit(window, text);
1349 }
1350 };
1351 }
1352
1353 fn xim_handle_event(&self, event: Event) -> Option<()> {
1354 match event {
1355 Event::KeyPress(event) | Event::KeyRelease(event) => {
1356 let mut state = self.0.borrow_mut();
1357 state.pre_key_char_down = Some(Keystroke::from_xkb(
1358 &state.xkb,
1359 &state.keyboard_mapper,
1360 state.modifiers,
1361 event.detail.into(),
1362 ));
1363 let (mut ximc, mut xim_handler) = state.take_xim()?;
1364 drop(state);
1365 xim_handler.window = event.event;
1366 ximc.forward_event(
1367 xim_handler.im_id,
1368 xim_handler.ic_id,
1369 xim::ForwardEventFlag::empty(),
1370 &event,
1371 )
1372 .context("X11: Failed to forward XIM event")
1373 .log_err();
1374 let mut state = self.0.borrow_mut();
1375 state.restore_xim(ximc, xim_handler);
1376 drop(state);
1377 }
1378 event => {
1379 self.handle_event(event);
1380 }
1381 }
1382 Some(())
1383 }
1384
1385 fn xim_handle_commit(&self, window: xproto::Window, text: String) -> Option<()> {
1386 let Some(window) = self.get_window(window) else {
1387 log::error!("bug: Failed to get window for XIM commit");
1388 return None;
1389 };
1390 let mut state = self.0.borrow_mut();
1391 let keystroke = state.pre_key_char_down.take();
1392 state.composing = false;
1393 drop(state);
1394 if let Some(mut keystroke) = keystroke {
1395 keystroke.key_char = Some(text.clone());
1396 window.handle_input(PlatformInput::KeyDown(crate::KeyDownEvent {
1397 keystroke,
1398 is_held: false,
1399 }));
1400 }
1401
1402 Some(())
1403 }
1404
1405 fn xim_handle_preedit(&self, window: xproto::Window, text: String) -> Option<()> {
1406 let Some(window) = self.get_window(window) else {
1407 log::error!("bug: Failed to get window for XIM preedit");
1408 return None;
1409 };
1410
1411 let mut state = self.0.borrow_mut();
1412 let (mut ximc, mut xim_handler) = state.take_xim()?;
1413 state.composing = !text.is_empty();
1414 drop(state);
1415 window.handle_ime_preedit(text);
1416
1417 if let Some(area) = window.get_ime_area() {
1418 let ic_attributes = ximc
1419 .build_ic_attributes()
1420 .push(
1421 xim::AttributeName::InputStyle,
1422 xim::InputStyle::PREEDIT_CALLBACKS,
1423 )
1424 .push(xim::AttributeName::ClientWindow, xim_handler.window)
1425 .push(xim::AttributeName::FocusWindow, xim_handler.window)
1426 .nested_list(xim::AttributeName::PreeditAttributes, |b| {
1427 b.push(
1428 xim::AttributeName::SpotLocation,
1429 xim::Point {
1430 x: u32::from(area.origin.x + area.size.width) as i16,
1431 y: u32::from(area.origin.y + area.size.height) as i16,
1432 },
1433 );
1434 })
1435 .build();
1436 ximc.set_ic_values(xim_handler.im_id, xim_handler.ic_id, ic_attributes)
1437 .ok();
1438 }
1439 let mut state = self.0.borrow_mut();
1440 state.restore_xim(ximc, xim_handler);
1441 drop(state);
1442 Some(())
1443 }
1444
1445 fn handle_keyboard_layout_change(&self) {
1446 let mut state = self.0.borrow_mut();
1447 let layout_idx = state.xkb.serialize_layout(STATE_LAYOUT_EFFECTIVE);
1448 let keymap = state.xkb.get_keymap();
1449 let layout_name = keymap.layout_get_name(layout_idx);
1450 if layout_name != state.keyboard_layout.name() {
1451 state.keyboard_layout = LinuxKeyboardLayout::new(layout_name.to_string().into());
1452 if let Some(mut callback) = state.common.callbacks.keyboard_layout_change.take() {
1453 drop(state);
1454 callback();
1455 state = self.0.borrow_mut();
1456 state.common.callbacks.keyboard_layout_change = Some(callback);
1457 }
1458 }
1459 }
1460}
1461
1462impl LinuxClient for X11Client {
1463 fn compositor_name(&self) -> &'static str {
1464 "X11"
1465 }
1466
1467 fn with_common<R>(&self, f: impl FnOnce(&mut LinuxCommon) -> R) -> R {
1468 f(&mut self.0.borrow_mut().common)
1469 }
1470
1471 fn keyboard_layout(&self) -> Box<dyn PlatformKeyboardLayout> {
1472 let state = self.0.borrow();
1473 Box::new(state.keyboard_layout.clone())
1474 }
1475
1476 fn displays(&self) -> Vec<Rc<dyn PlatformDisplay>> {
1477 let state = self.0.borrow();
1478 let setup = state.xcb_connection.setup();
1479 setup
1480 .roots
1481 .iter()
1482 .enumerate()
1483 .filter_map(|(root_id, _)| {
1484 Some(Rc::new(
1485 X11Display::new(&state.xcb_connection, state.scale_factor, root_id).ok()?,
1486 ) as Rc<dyn PlatformDisplay>)
1487 })
1488 .collect()
1489 }
1490
1491 fn primary_display(&self) -> Option<Rc<dyn PlatformDisplay>> {
1492 let state = self.0.borrow();
1493 X11Display::new(
1494 &state.xcb_connection,
1495 state.scale_factor,
1496 state.x_root_index,
1497 )
1498 .log_err()
1499 .map(|display| Rc::new(display) as Rc<dyn PlatformDisplay>)
1500 }
1501
1502 fn display(&self, id: DisplayId) -> Option<Rc<dyn PlatformDisplay>> {
1503 let state = self.0.borrow();
1504
1505 Some(Rc::new(
1506 X11Display::new(&state.xcb_connection, state.scale_factor, id.0 as usize).ok()?,
1507 ))
1508 }
1509
1510 #[cfg(feature = "screen-capture")]
1511 fn is_screen_capture_supported(&self) -> bool {
1512 true
1513 }
1514
1515 #[cfg(feature = "screen-capture")]
1516 fn screen_capture_sources(
1517 &self,
1518 ) -> futures::channel::oneshot::Receiver<anyhow::Result<Vec<Box<dyn crate::ScreenCaptureSource>>>>
1519 {
1520 crate::platform::scap_screen_capture::scap_screen_sources(
1521 &self.0.borrow().common.foreground_executor,
1522 )
1523 }
1524
1525 fn open_window(
1526 &self,
1527 handle: AnyWindowHandle,
1528 params: WindowParams,
1529 ) -> anyhow::Result<Box<dyn PlatformWindow>> {
1530 let mut state = self.0.borrow_mut();
1531 let x_window = state
1532 .xcb_connection
1533 .generate_id()
1534 .context("X11: Failed to generate window ID")?;
1535
1536 let window = X11Window::new(
1537 handle,
1538 X11ClientStatePtr(Rc::downgrade(&self.0)),
1539 state.common.foreground_executor.clone(),
1540 &state.gpu_context,
1541 params,
1542 &state.xcb_connection,
1543 state.client_side_decorations_supported,
1544 state.x_root_index,
1545 x_window,
1546 &state.atoms,
1547 state.scale_factor,
1548 state.common.appearance,
1549 )?;
1550 check_reply(
1551 || "Failed to set XdndAware property",
1552 state.xcb_connection.change_property32(
1553 xproto::PropMode::REPLACE,
1554 x_window,
1555 state.atoms.XdndAware,
1556 state.atoms.XA_ATOM,
1557 &[5],
1558 ),
1559 )
1560 .log_err();
1561 xcb_flush(&state.xcb_connection);
1562
1563 let window_ref = WindowRef {
1564 window: window.0.clone(),
1565 refresh_state: None,
1566 expose_event_received: false,
1567 last_visibility: Visibility::UNOBSCURED,
1568 is_mapped: false,
1569 };
1570
1571 state.windows.insert(x_window, window_ref);
1572 Ok(Box::new(window))
1573 }
1574
1575 fn set_cursor_style(&self, style: CursorStyle) {
1576 let mut state = self.0.borrow_mut();
1577 let Some(focused_window) = state.mouse_focused_window else {
1578 return;
1579 };
1580 let current_style = state
1581 .cursor_styles
1582 .get(&focused_window)
1583 .unwrap_or(&CursorStyle::Arrow);
1584 if *current_style == style {
1585 return;
1586 }
1587
1588 let Some(cursor) = state.get_cursor_icon(style) else {
1589 return;
1590 };
1591
1592 state.cursor_styles.insert(focused_window, style);
1593 check_reply(
1594 || "Failed to set cursor style",
1595 state.xcb_connection.change_window_attributes(
1596 focused_window,
1597 &ChangeWindowAttributesAux {
1598 cursor: Some(cursor),
1599 ..Default::default()
1600 },
1601 ),
1602 )
1603 .log_err();
1604 state.xcb_connection.flush().log_err();
1605 }
1606
1607 fn open_uri(&self, uri: &str) {
1608 #[cfg(any(feature = "wayland", feature = "x11"))]
1609 open_uri_internal(self.background_executor(), uri, None);
1610 }
1611
1612 fn reveal_path(&self, path: PathBuf) {
1613 #[cfg(any(feature = "x11", feature = "wayland"))]
1614 reveal_path_internal(self.background_executor(), path, None);
1615 }
1616
1617 fn write_to_primary(&self, item: crate::ClipboardItem) {
1618 let state = self.0.borrow_mut();
1619 state
1620 .clipboard
1621 .set_text(
1622 std::borrow::Cow::Owned(item.text().unwrap_or_default()),
1623 clipboard::ClipboardKind::Primary,
1624 clipboard::WaitConfig::None,
1625 )
1626 .context("X11 Failed to write to clipboard (primary)")
1627 .log_with_level(log::Level::Debug);
1628 }
1629
1630 fn write_to_clipboard(&self, item: crate::ClipboardItem) {
1631 let mut state = self.0.borrow_mut();
1632 state
1633 .clipboard
1634 .set_text(
1635 std::borrow::Cow::Owned(item.text().unwrap_or_default()),
1636 clipboard::ClipboardKind::Clipboard,
1637 clipboard::WaitConfig::None,
1638 )
1639 .context("X11: Failed to write to clipboard (clipboard)")
1640 .log_with_level(log::Level::Debug);
1641 state.clipboard_item.replace(item);
1642 }
1643
1644 fn read_from_primary(&self) -> Option<crate::ClipboardItem> {
1645 let state = self.0.borrow_mut();
1646 return state
1647 .clipboard
1648 .get_any(clipboard::ClipboardKind::Primary)
1649 .context("X11: Failed to read from clipboard (primary)")
1650 .log_with_level(log::Level::Debug);
1651 }
1652
1653 fn read_from_clipboard(&self) -> Option<crate::ClipboardItem> {
1654 let state = self.0.borrow_mut();
1655 // if the last copy was from this app, return our cached item
1656 // which has metadata attached.
1657 if state
1658 .clipboard
1659 .is_owner(clipboard::ClipboardKind::Clipboard)
1660 {
1661 return state.clipboard_item.clone();
1662 }
1663 return state
1664 .clipboard
1665 .get_any(clipboard::ClipboardKind::Clipboard)
1666 .context("X11: Failed to read from clipboard (clipboard)")
1667 .log_with_level(log::Level::Debug);
1668 }
1669
1670 fn run(&self) {
1671 let Some(mut event_loop) = self
1672 .0
1673 .borrow_mut()
1674 .event_loop
1675 .take()
1676 .context("X11Client::run called but it's already running")
1677 .log_err()
1678 else {
1679 return;
1680 };
1681
1682 event_loop.run(None, &mut self.clone(), |_| {}).log_err();
1683 }
1684
1685 fn active_window(&self) -> Option<AnyWindowHandle> {
1686 let state = self.0.borrow();
1687 state.keyboard_focused_window.and_then(|focused_window| {
1688 state
1689 .windows
1690 .get(&focused_window)
1691 .map(|window| window.handle())
1692 })
1693 }
1694
1695 fn window_stack(&self) -> Option<Vec<AnyWindowHandle>> {
1696 let state = self.0.borrow();
1697 let root = state.xcb_connection.setup().roots[state.x_root_index].root;
1698
1699 let reply = state
1700 .xcb_connection
1701 .get_property(
1702 false,
1703 root,
1704 state.atoms._NET_CLIENT_LIST_STACKING,
1705 xproto::AtomEnum::WINDOW,
1706 0,
1707 u32::MAX,
1708 )
1709 .ok()?
1710 .reply()
1711 .ok()?;
1712
1713 let window_ids = reply
1714 .value
1715 .chunks_exact(4)
1716 .filter_map(|chunk| chunk.try_into().ok().map(u32::from_ne_bytes))
1717 .collect::<Vec<xproto::Window>>();
1718
1719 let mut handles = Vec::new();
1720
1721 // We need to reverse, since _NET_CLIENT_LIST_STACKING has
1722 // a back-to-front order.
1723 // See: https://specifications.freedesktop.org/wm-spec/1.3/ar01s03.html
1724 for window_ref in window_ids
1725 .iter()
1726 .rev()
1727 .filter_map(|&win| state.windows.get(&win))
1728 {
1729 if !window_ref.window.state.borrow().destroyed {
1730 handles.push(window_ref.handle());
1731 }
1732 }
1733
1734 Some(handles)
1735 }
1736}
1737
1738impl X11ClientState {
1739 fn has_xim(&self) -> bool {
1740 self.ximc.is_some() && self.xim_handler.is_some()
1741 }
1742
1743 fn take_xim(&mut self) -> Option<(X11rbClient<Rc<XCBConnection>>, XimHandler)> {
1744 let ximc = self
1745 .ximc
1746 .take()
1747 .ok_or(anyhow!("bug: XIM connection not set"))
1748 .log_err()?;
1749 if let Some(xim_handler) = self.xim_handler.take() {
1750 Some((ximc, xim_handler))
1751 } else {
1752 self.ximc = Some(ximc);
1753 log::error!("bug: XIM handler not set");
1754 None
1755 }
1756 }
1757
1758 fn restore_xim(&mut self, ximc: X11rbClient<Rc<XCBConnection>>, xim_handler: XimHandler) {
1759 self.ximc = Some(ximc);
1760 self.xim_handler = Some(xim_handler);
1761 }
1762
1763 fn update_refresh_loop(&mut self, x_window: xproto::Window) {
1764 let Some(window_ref) = self.windows.get_mut(&x_window) else {
1765 return;
1766 };
1767 let is_visible = window_ref.is_mapped
1768 && !matches!(window_ref.last_visibility, Visibility::FULLY_OBSCURED);
1769 match (is_visible, window_ref.refresh_state.take()) {
1770 (false, refresh_state @ Some(RefreshState::Hidden { .. }))
1771 | (false, refresh_state @ None)
1772 | (true, refresh_state @ Some(RefreshState::PeriodicRefresh { .. })) => {
1773 window_ref.refresh_state = refresh_state;
1774 }
1775 (
1776 false,
1777 Some(RefreshState::PeriodicRefresh {
1778 refresh_rate,
1779 event_loop_token,
1780 }),
1781 ) => {
1782 self.loop_handle.remove(event_loop_token);
1783 window_ref.refresh_state = Some(RefreshState::Hidden { refresh_rate });
1784 }
1785 (true, Some(RefreshState::Hidden { refresh_rate })) => {
1786 let event_loop_token = self.start_refresh_loop(x_window, refresh_rate);
1787 let Some(window_ref) = self.windows.get_mut(&x_window) else {
1788 return;
1789 };
1790 window_ref.refresh_state = Some(RefreshState::PeriodicRefresh {
1791 refresh_rate,
1792 event_loop_token,
1793 });
1794 }
1795 (true, None) => {
1796 let Some(screen_resources) = get_reply(
1797 || "Failed to get screen resources",
1798 self.xcb_connection
1799 .randr_get_screen_resources_current(x_window),
1800 )
1801 .log_err() else {
1802 return;
1803 };
1804
1805 // Ideally this would be re-queried when the window changes screens, but there
1806 // doesn't seem to be an efficient / straightforward way to do this. Should also be
1807 // updated when screen configurations change.
1808 let mode_info = screen_resources.crtcs.iter().find_map(|crtc| {
1809 let crtc_info = self
1810 .xcb_connection
1811 .randr_get_crtc_info(*crtc, x11rb::CURRENT_TIME)
1812 .ok()?
1813 .reply()
1814 .ok()?;
1815
1816 screen_resources
1817 .modes
1818 .iter()
1819 .find(|m| m.id == crtc_info.mode)
1820 });
1821 let refresh_rate = match mode_info {
1822 Some(mode_info) => mode_refresh_rate(mode_info),
1823 None => {
1824 log::error!(
1825 "Failed to get screen mode info from xrandr, \
1826 defaulting to 60hz refresh rate."
1827 );
1828 Duration::from_micros(1_000_000 / 60)
1829 }
1830 };
1831
1832 let event_loop_token = self.start_refresh_loop(x_window, refresh_rate);
1833 let Some(window_ref) = self.windows.get_mut(&x_window) else {
1834 return;
1835 };
1836 window_ref.refresh_state = Some(RefreshState::PeriodicRefresh {
1837 refresh_rate,
1838 event_loop_token,
1839 });
1840 }
1841 }
1842 }
1843
1844 #[must_use]
1845 fn start_refresh_loop(
1846 &self,
1847 x_window: xproto::Window,
1848 refresh_rate: Duration,
1849 ) -> RegistrationToken {
1850 self.loop_handle
1851 .insert_source(calloop::timer::Timer::immediate(), {
1852 move |mut instant, (), client| {
1853 let xcb_connection = {
1854 let mut state = client.0.borrow_mut();
1855 let xcb_connection = state.xcb_connection.clone();
1856 if let Some(window) = state.windows.get_mut(&x_window) {
1857 let expose_event_received = window.expose_event_received;
1858 window.expose_event_received = false;
1859 let window = window.window.clone();
1860 drop(state);
1861 window.refresh(RequestFrameOptions {
1862 require_presentation: expose_event_received,
1863 });
1864 }
1865 xcb_connection
1866 };
1867 client.process_x11_events(&xcb_connection).log_err();
1868
1869 // Take into account that some frames have been skipped
1870 let now = Instant::now();
1871 while instant < now {
1872 instant += refresh_rate;
1873 }
1874 calloop::timer::TimeoutAction::ToInstant(instant)
1875 }
1876 })
1877 .expect("Failed to initialize window refresh timer")
1878 }
1879
1880 fn get_cursor_icon(&mut self, style: CursorStyle) -> Option<xproto::Cursor> {
1881 if let Some(cursor) = self.cursor_cache.get(&style) {
1882 return *cursor;
1883 }
1884
1885 let mut result;
1886 match style {
1887 CursorStyle::None => match create_invisible_cursor(&self.xcb_connection) {
1888 Ok(loaded_cursor) => result = Ok(loaded_cursor),
1889 Err(err) => result = Err(err.context("X11: error while creating invisible cursor")),
1890 },
1891 _ => 'outer: {
1892 let mut errors = String::new();
1893 let cursor_icon_names = style.to_icon_names();
1894 for cursor_icon_name in cursor_icon_names {
1895 match self
1896 .cursor_handle
1897 .load_cursor(&self.xcb_connection, cursor_icon_name)
1898 {
1899 Ok(loaded_cursor) => {
1900 if loaded_cursor != x11rb::NONE {
1901 result = Ok(loaded_cursor);
1902 break 'outer;
1903 }
1904 }
1905 Err(err) => {
1906 errors.push_str(&err.to_string());
1907 errors.push('\n');
1908 }
1909 }
1910 }
1911 if errors.is_empty() {
1912 result = Err(anyhow!(
1913 "errors while loading cursor icons {:?}:\n{}",
1914 cursor_icon_names,
1915 errors
1916 ));
1917 } else {
1918 result = Err(anyhow!("did not find cursor icons {:?}", cursor_icon_names));
1919 }
1920 }
1921 };
1922
1923 let cursor = match result {
1924 Ok(cursor) => Some(cursor),
1925 Err(err) => {
1926 match self
1927 .cursor_handle
1928 .load_cursor(&self.xcb_connection, DEFAULT_CURSOR_ICON_NAME)
1929 {
1930 Ok(default) => {
1931 log_cursor_icon_warning(err.context(format!(
1932 "X11: error loading cursor icon, falling back on default icon '{}'",
1933 DEFAULT_CURSOR_ICON_NAME
1934 )));
1935 Some(default)
1936 }
1937 Err(default_err) => {
1938 log_cursor_icon_warning(err.context(default_err).context(format!(
1939 "X11: error loading default cursor fallback '{}'",
1940 DEFAULT_CURSOR_ICON_NAME
1941 )));
1942 None
1943 }
1944 }
1945 }
1946 };
1947
1948 self.cursor_cache.insert(style, cursor);
1949 cursor
1950 }
1951}
1952
1953// Adapted from:
1954// https://docs.rs/winit/0.29.11/src/winit/platform_impl/linux/x11/monitor.rs.html#103-111
1955pub fn mode_refresh_rate(mode: &randr::ModeInfo) -> Duration {
1956 if mode.dot_clock == 0 || mode.htotal == 0 || mode.vtotal == 0 {
1957 return Duration::from_millis(16);
1958 }
1959
1960 let millihertz = mode.dot_clock as u64 * 1_000 / (mode.htotal as u64 * mode.vtotal as u64);
1961 let micros = 1_000_000_000 / millihertz;
1962 log::info!("Refreshing every {}ms", micros / 1_000);
1963 Duration::from_micros(micros)
1964}
1965
1966fn fp3232_to_f32(value: xinput::Fp3232) -> f32 {
1967 value.integral as f32 + value.frac as f32 / u32::MAX as f32
1968}
1969
1970fn check_compositor_present(xcb_connection: &XCBConnection, root: u32) -> bool {
1971 // Method 1: Check for _NET_WM_CM_S{root}
1972 let atom_name = format!("_NET_WM_CM_S{}", root);
1973 let atom1 = get_reply(
1974 || format!("Failed to intern {atom_name}"),
1975 xcb_connection.intern_atom(false, atom_name.as_bytes()),
1976 );
1977 let method1 = match atom1.log_with_level(Level::Debug) {
1978 Some(reply) if reply.atom != x11rb::NONE => {
1979 let atom = reply.atom;
1980 get_reply(
1981 || format!("Failed to get {atom_name} owner"),
1982 xcb_connection.get_selection_owner(atom),
1983 )
1984 .map(|reply| reply.owner != 0)
1985 .log_with_level(Level::Debug)
1986 .unwrap_or(false)
1987 }
1988 _ => false,
1989 };
1990
1991 // Method 2: Check for _NET_WM_CM_OWNER
1992 let atom_name = "_NET_WM_CM_OWNER";
1993 let atom2 = get_reply(
1994 || format!("Failed to intern {atom_name}"),
1995 xcb_connection.intern_atom(false, atom_name.as_bytes()),
1996 );
1997 let method2 = match atom2.log_with_level(Level::Debug) {
1998 Some(reply) if reply.atom != x11rb::NONE => {
1999 let atom = reply.atom;
2000 get_reply(
2001 || format!("Failed to get {atom_name}"),
2002 xcb_connection.get_property(false, root, atom, xproto::AtomEnum::WINDOW, 0, 1),
2003 )
2004 .map(|reply| reply.value_len > 0)
2005 .unwrap_or(false)
2006 }
2007 _ => return false,
2008 };
2009
2010 // Method 3: Check for _NET_SUPPORTING_WM_CHECK
2011 let atom_name = "_NET_SUPPORTING_WM_CHECK";
2012 let atom3 = get_reply(
2013 || format!("Failed to intern {atom_name}"),
2014 xcb_connection.intern_atom(false, atom_name.as_bytes()),
2015 );
2016 let method3 = match atom3.log_with_level(Level::Debug) {
2017 Some(reply) if reply.atom != x11rb::NONE => {
2018 let atom = reply.atom;
2019 get_reply(
2020 || format!("Failed to get {atom_name}"),
2021 xcb_connection.get_property(false, root, atom, xproto::AtomEnum::WINDOW, 0, 1),
2022 )
2023 .map(|reply| reply.value_len > 0)
2024 .unwrap_or(false)
2025 }
2026 _ => return false,
2027 };
2028
2029 log::debug!(
2030 "Compositor detection: _NET_WM_CM_S?={}, _NET_WM_CM_OWNER={}, _NET_SUPPORTING_WM_CHECK={}",
2031 method1,
2032 method2,
2033 method3
2034 );
2035
2036 method1 || method2 || method3
2037}
2038
2039fn check_gtk_frame_extents_supported(
2040 xcb_connection: &XCBConnection,
2041 atoms: &XcbAtoms,
2042 root: xproto::Window,
2043) -> bool {
2044 let Some(supported_atoms) = get_reply(
2045 || "Failed to get _NET_SUPPORTED",
2046 xcb_connection.get_property(
2047 false,
2048 root,
2049 atoms._NET_SUPPORTED,
2050 xproto::AtomEnum::ATOM,
2051 0,
2052 1024,
2053 ),
2054 )
2055 .log_with_level(Level::Debug) else {
2056 return false;
2057 };
2058
2059 let supported_atom_ids: Vec<u32> = supported_atoms
2060 .value
2061 .chunks_exact(4)
2062 .filter_map(|chunk| chunk.try_into().ok().map(u32::from_ne_bytes))
2063 .collect();
2064
2065 supported_atom_ids.contains(&atoms._GTK_FRAME_EXTENTS)
2066}
2067
2068fn xdnd_is_atom_supported(atom: u32, atoms: &XcbAtoms) -> bool {
2069 return atom == atoms.TEXT
2070 || atom == atoms.STRING
2071 || atom == atoms.UTF8_STRING
2072 || atom == atoms.TEXT_PLAIN
2073 || atom == atoms.TEXT_PLAIN_UTF8
2074 || atom == atoms.TextUriList;
2075}
2076
2077fn xdnd_get_supported_atom(
2078 xcb_connection: &XCBConnection,
2079 supported_atoms: &XcbAtoms,
2080 target: xproto::Window,
2081) -> u32 {
2082 if let Some(reply) = get_reply(
2083 || "Failed to get XDnD supported atoms",
2084 xcb_connection.get_property(
2085 false,
2086 target,
2087 supported_atoms.XdndTypeList,
2088 AtomEnum::ANY,
2089 0,
2090 1024,
2091 ),
2092 )
2093 .log_with_level(Level::Warn)
2094 {
2095 if let Some(atoms) = reply.value32() {
2096 for atom in atoms {
2097 if xdnd_is_atom_supported(atom, &supported_atoms) {
2098 return atom;
2099 }
2100 }
2101 }
2102 }
2103 return 0;
2104}
2105
2106fn xdnd_send_finished(
2107 xcb_connection: &XCBConnection,
2108 atoms: &XcbAtoms,
2109 source: xproto::Window,
2110 target: xproto::Window,
2111) {
2112 let message = ClientMessageEvent {
2113 format: 32,
2114 window: target,
2115 type_: atoms.XdndFinished,
2116 data: ClientMessageData::from([source, 1, atoms.XdndActionCopy, 0, 0]),
2117 sequence: 0,
2118 response_type: xproto::CLIENT_MESSAGE_EVENT,
2119 };
2120 check_reply(
2121 || "Failed to send XDnD finished event",
2122 xcb_connection.send_event(false, target, EventMask::default(), message),
2123 )
2124 .log_err();
2125 xcb_connection.flush().log_err();
2126}
2127
2128fn xdnd_send_status(
2129 xcb_connection: &XCBConnection,
2130 atoms: &XcbAtoms,
2131 source: xproto::Window,
2132 target: xproto::Window,
2133 action: u32,
2134) {
2135 let message = ClientMessageEvent {
2136 format: 32,
2137 window: target,
2138 type_: atoms.XdndStatus,
2139 data: ClientMessageData::from([source, 1, 0, 0, action]),
2140 sequence: 0,
2141 response_type: xproto::CLIENT_MESSAGE_EVENT,
2142 };
2143 check_reply(
2144 || "Failed to send XDnD status event",
2145 xcb_connection.send_event(false, target, EventMask::default(), message),
2146 )
2147 .log_err();
2148 xcb_connection.flush().log_err();
2149}
2150
2151/// Recomputes `pointer_device_states` by querying all pointer devices.
2152/// When a device is present in `scroll_values_to_preserve`, its value for `ScrollAxisState.scroll_value` is used.
2153fn current_pointer_device_states(
2154 xcb_connection: &XCBConnection,
2155 scroll_values_to_preserve: &BTreeMap<xinput::DeviceId, PointerDeviceState>,
2156) -> Option<BTreeMap<xinput::DeviceId, PointerDeviceState>> {
2157 let devices_query_result = get_reply(
2158 || "Failed to query XInput devices",
2159 xcb_connection.xinput_xi_query_device(XINPUT_ALL_DEVICES),
2160 )
2161 .log_err()?;
2162
2163 let mut pointer_device_states = BTreeMap::new();
2164 pointer_device_states.extend(
2165 devices_query_result
2166 .infos
2167 .iter()
2168 .filter(|info| is_pointer_device(info.type_))
2169 .filter_map(|info| {
2170 let scroll_data = info
2171 .classes
2172 .iter()
2173 .filter_map(|class| class.data.as_scroll())
2174 .map(|class| *class)
2175 .rev()
2176 .collect::<Vec<_>>();
2177 let old_state = scroll_values_to_preserve.get(&info.deviceid);
2178 let old_horizontal = old_state.map(|state| &state.horizontal);
2179 let old_vertical = old_state.map(|state| &state.vertical);
2180 let horizontal = scroll_data
2181 .iter()
2182 .find(|data| data.scroll_type == xinput::ScrollType::HORIZONTAL)
2183 .map(|data| scroll_data_to_axis_state(data, old_horizontal));
2184 let vertical = scroll_data
2185 .iter()
2186 .find(|data| data.scroll_type == xinput::ScrollType::VERTICAL)
2187 .map(|data| scroll_data_to_axis_state(data, old_vertical));
2188 if horizontal.is_none() && vertical.is_none() {
2189 None
2190 } else {
2191 Some((
2192 info.deviceid,
2193 PointerDeviceState {
2194 horizontal: horizontal.unwrap_or_else(Default::default),
2195 vertical: vertical.unwrap_or_else(Default::default),
2196 },
2197 ))
2198 }
2199 }),
2200 );
2201 if pointer_device_states.is_empty() {
2202 log::error!("Found no xinput mouse pointers.");
2203 }
2204 return Some(pointer_device_states);
2205}
2206
2207/// Returns true if the device is a pointer device. Does not include pointer device groups.
2208fn is_pointer_device(type_: xinput::DeviceType) -> bool {
2209 type_ == xinput::DeviceType::SLAVE_POINTER
2210}
2211
2212fn scroll_data_to_axis_state(
2213 data: &xinput::DeviceClassDataScroll,
2214 old_axis_state_with_valid_scroll_value: Option<&ScrollAxisState>,
2215) -> ScrollAxisState {
2216 ScrollAxisState {
2217 valuator_number: Some(data.number),
2218 multiplier: SCROLL_LINES / fp3232_to_f32(data.increment),
2219 scroll_value: old_axis_state_with_valid_scroll_value.and_then(|state| state.scroll_value),
2220 }
2221}
2222
2223fn reset_all_pointer_device_scroll_positions(
2224 pointer_device_states: &mut BTreeMap<xinput::DeviceId, PointerDeviceState>,
2225) {
2226 pointer_device_states
2227 .iter_mut()
2228 .for_each(|(_, device_state)| reset_pointer_device_scroll_positions(device_state));
2229}
2230
2231fn reset_pointer_device_scroll_positions(pointer: &mut PointerDeviceState) {
2232 pointer.horizontal.scroll_value = None;
2233 pointer.vertical.scroll_value = None;
2234}
2235
2236/// Returns the scroll delta for a smooth scrolling motion event, or `None` if no scroll data is present.
2237fn get_scroll_delta_and_update_state(
2238 pointer: &mut PointerDeviceState,
2239 event: &xinput::MotionEvent,
2240) -> Option<Point<f32>> {
2241 let delta_x = get_axis_scroll_delta_and_update_state(event, &mut pointer.horizontal);
2242 let delta_y = get_axis_scroll_delta_and_update_state(event, &mut pointer.vertical);
2243 if delta_x.is_some() || delta_y.is_some() {
2244 Some(Point::new(delta_x.unwrap_or(0.0), delta_y.unwrap_or(0.0)))
2245 } else {
2246 None
2247 }
2248}
2249
2250fn get_axis_scroll_delta_and_update_state(
2251 event: &xinput::MotionEvent,
2252 axis: &mut ScrollAxisState,
2253) -> Option<f32> {
2254 let axis_index = get_valuator_axis_index(&event.valuator_mask, axis.valuator_number?)?;
2255 if let Some(axis_value) = event.axisvalues.get(axis_index) {
2256 let new_scroll = fp3232_to_f32(*axis_value);
2257 let delta_scroll = axis
2258 .scroll_value
2259 .map(|old_scroll| (old_scroll - new_scroll) * axis.multiplier);
2260 axis.scroll_value = Some(new_scroll);
2261 delta_scroll
2262 } else {
2263 log::error!("Encountered invalid XInput valuator_mask, scrolling may not work properly.");
2264 None
2265 }
2266}
2267
2268fn make_scroll_wheel_event(
2269 position: Point<Pixels>,
2270 scroll_delta: Point<f32>,
2271 modifiers: Modifiers,
2272) -> crate::ScrollWheelEvent {
2273 // When shift is held down, vertical scrolling turns into horizontal scrolling.
2274 let delta = if modifiers.shift {
2275 Point {
2276 x: scroll_delta.y,
2277 y: 0.0,
2278 }
2279 } else {
2280 scroll_delta
2281 };
2282 crate::ScrollWheelEvent {
2283 position,
2284 delta: ScrollDelta::Lines(delta),
2285 modifiers,
2286 touch_phase: TouchPhase::default(),
2287 }
2288}
2289
2290fn create_invisible_cursor(
2291 connection: &XCBConnection,
2292) -> anyhow::Result<crate::platform::linux::x11::client::xproto::Cursor> {
2293 let empty_pixmap = connection.generate_id()?;
2294 let root = connection.setup().roots[0].root;
2295 connection.create_pixmap(1, empty_pixmap, root, 1, 1)?;
2296
2297 let cursor = connection.generate_id()?;
2298 connection.create_cursor(cursor, empty_pixmap, empty_pixmap, 0, 0, 0, 0, 0, 0, 0, 0)?;
2299
2300 connection.free_pixmap(empty_pixmap)?;
2301
2302 xcb_flush(connection);
2303 Ok(cursor)
2304}
2305
2306fn update_keyboard_mapper(
2307 client: &mut X11ClientState,
2308 keyboard_layout: LinuxKeyboardLayout,
2309 base_group: u32,
2310 latched_group: u32,
2311 locked_group: u32,
2312) {
2313 let id = keyboard_layout.id().to_string();
2314 let mapper = client
2315 .keyboard_mapper_cache
2316 .entry(id)
2317 .or_insert(Rc::new(LinuxKeyboardMapper::new(
2318 base_group,
2319 latched_group,
2320 locked_group,
2321 )))
2322 .clone();
2323
2324 client.keyboard_mapper = mapper;
2325 client.keyboard_layout = Box::new(keyboard_layout);
2326}