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 let key_char = compose_state.utf8();
1076 keystroke.key_char = key_char;
1077 if let Some(keysym) = compose_state.keysym() {
1078 keystroke.key = xkbc::keysym_get_name(keysym);
1079 }
1080 }
1081 xkbc::Status::Composing => {
1082 keystroke.key_char = None;
1083 state.pre_edit_text =
1084 compose_state.utf8().or(underlying_dead_key(keysym));
1085 let pre_edit =
1086 state.pre_edit_text.clone().unwrap_or(String::default());
1087 drop(state);
1088 window.handle_ime_preedit(pre_edit);
1089 state = self.0.borrow_mut();
1090 }
1091 xkbc::Status::Cancelled => {
1092 let pre_edit = state.pre_edit_text.take();
1093 drop(state);
1094 if let Some(pre_edit) = pre_edit {
1095 window.handle_ime_commit(pre_edit);
1096 }
1097 if let Some(current_key) = underlying_dead_key(keysym) {
1098 window.handle_ime_preedit(current_key);
1099 }
1100 state = self.0.borrow_mut();
1101 compose_state.feed(keysym);
1102 }
1103 _ => {}
1104 }
1105 state.compose_state = Some(compose_state);
1106 }
1107 keystroke
1108 };
1109 drop(state);
1110 window.handle_input(PlatformInput::KeyDown(crate::KeyDownEvent {
1111 keystroke,
1112 is_held: false,
1113 }));
1114 }
1115 Event::KeyRelease(event) => {
1116 let window = self.get_window(event.event)?;
1117 let mut state = self.0.borrow_mut();
1118
1119 let modifiers = modifiers_from_state(event.state);
1120 state.modifiers = modifiers;
1121
1122 let keystroke = {
1123 let code = event.detail.into();
1124 let xkb_state = state.previous_xkb_state.clone();
1125 state.xkb.update_mask(
1126 event.state.bits() as ModMask,
1127 0,
1128 0,
1129 xkb_state.depressed_layout,
1130 xkb_state.latched_layout,
1131 xkb_state.locked_layout,
1132 );
1133 let keystroke = crate::Keystroke::from_xkb(
1134 &state.xkb,
1135 &state.keyboard_mapper,
1136 modifiers,
1137 code,
1138 );
1139 let keysym = state.xkb.key_get_one_sym(code);
1140 if keysym.is_modifier_key() {
1141 return Some(());
1142 }
1143 keystroke
1144 };
1145 drop(state);
1146 window.handle_input(PlatformInput::KeyUp(crate::KeyUpEvent { keystroke }));
1147 }
1148 Event::XinputButtonPress(event) => {
1149 let window = self.get_window(event.event)?;
1150 let mut state = self.0.borrow_mut();
1151
1152 let modifiers = modifiers_from_xinput_info(event.mods);
1153 state.modifiers = modifiers;
1154
1155 let position = point(
1156 px(event.event_x as f32 / u16::MAX as f32 / state.scale_factor),
1157 px(event.event_y as f32 / u16::MAX as f32 / state.scale_factor),
1158 );
1159
1160 if state.composing && state.ximc.is_some() {
1161 drop(state);
1162 self.reset_ime();
1163 window.handle_ime_unmark();
1164 state = self.0.borrow_mut();
1165 } else if let Some(text) = state.pre_edit_text.take() {
1166 if let Some(compose_state) = state.compose_state.as_mut() {
1167 compose_state.reset();
1168 }
1169 drop(state);
1170 window.handle_ime_commit(text);
1171 state = self.0.borrow_mut();
1172 }
1173 match button_or_scroll_from_event_detail(event.detail) {
1174 Some(ButtonOrScroll::Button(button)) => {
1175 let click_elapsed = state.last_click.elapsed();
1176 if click_elapsed < DOUBLE_CLICK_INTERVAL
1177 && state
1178 .last_mouse_button
1179 .is_some_and(|prev_button| prev_button == button)
1180 && is_within_click_distance(state.last_location, position)
1181 {
1182 state.current_count += 1;
1183 } else {
1184 state.current_count = 1;
1185 }
1186
1187 state.last_click = Instant::now();
1188 state.last_mouse_button = Some(button);
1189 state.last_location = position;
1190 let current_count = state.current_count;
1191
1192 drop(state);
1193 window.handle_input(PlatformInput::MouseDown(crate::MouseDownEvent {
1194 button,
1195 position,
1196 modifiers,
1197 click_count: current_count,
1198 first_mouse: false,
1199 }));
1200 }
1201 Some(ButtonOrScroll::Scroll(direction)) => {
1202 drop(state);
1203 // Emulated scroll button presses are sent simultaneously with smooth scrolling XinputMotion events.
1204 // Since handling those events does the scrolling, they are skipped here.
1205 if !event
1206 .flags
1207 .contains(xinput::PointerEventFlags::POINTER_EMULATED)
1208 {
1209 let scroll_delta = match direction {
1210 ScrollDirection::Up => Point::new(0.0, SCROLL_LINES),
1211 ScrollDirection::Down => Point::new(0.0, -SCROLL_LINES),
1212 ScrollDirection::Left => Point::new(SCROLL_LINES, 0.0),
1213 ScrollDirection::Right => Point::new(-SCROLL_LINES, 0.0),
1214 };
1215 window.handle_input(PlatformInput::ScrollWheel(
1216 make_scroll_wheel_event(position, scroll_delta, modifiers),
1217 ));
1218 }
1219 }
1220 None => {
1221 log::error!("Unknown x11 button: {}", event.detail);
1222 }
1223 }
1224 }
1225 Event::XinputButtonRelease(event) => {
1226 let window = self.get_window(event.event)?;
1227 let mut state = self.0.borrow_mut();
1228 let modifiers = modifiers_from_xinput_info(event.mods);
1229 state.modifiers = modifiers;
1230
1231 let position = point(
1232 px(event.event_x as f32 / u16::MAX as f32 / state.scale_factor),
1233 px(event.event_y as f32 / u16::MAX as f32 / state.scale_factor),
1234 );
1235 match button_or_scroll_from_event_detail(event.detail) {
1236 Some(ButtonOrScroll::Button(button)) => {
1237 let click_count = state.current_count;
1238 drop(state);
1239 window.handle_input(PlatformInput::MouseUp(crate::MouseUpEvent {
1240 button,
1241 position,
1242 modifiers,
1243 click_count,
1244 }));
1245 }
1246 Some(ButtonOrScroll::Scroll(_)) => {}
1247 None => {}
1248 }
1249 }
1250 Event::XinputMotion(event) => {
1251 let window = self.get_window(event.event)?;
1252 let mut state = self.0.borrow_mut();
1253 let pressed_button = pressed_button_from_mask(event.button_mask[0]);
1254 let position = point(
1255 px(event.event_x as f32 / u16::MAX as f32 / state.scale_factor),
1256 px(event.event_y as f32 / u16::MAX as f32 / state.scale_factor),
1257 );
1258 let modifiers = modifiers_from_xinput_info(event.mods);
1259 state.modifiers = modifiers;
1260 drop(state);
1261
1262 if event.valuator_mask[0] & 3 != 0 {
1263 window.handle_input(PlatformInput::MouseMove(crate::MouseMoveEvent {
1264 position,
1265 pressed_button,
1266 modifiers,
1267 }));
1268 }
1269
1270 state = self.0.borrow_mut();
1271 if let Some(mut pointer) = state.pointer_device_states.get_mut(&event.sourceid) {
1272 let scroll_delta = get_scroll_delta_and_update_state(&mut pointer, &event);
1273 drop(state);
1274 if let Some(scroll_delta) = scroll_delta {
1275 window.handle_input(PlatformInput::ScrollWheel(make_scroll_wheel_event(
1276 position,
1277 scroll_delta,
1278 modifiers,
1279 )));
1280 }
1281 }
1282 }
1283 Event::XinputEnter(event) if event.mode == xinput::NotifyMode::NORMAL => {
1284 let window = self.get_window(event.event)?;
1285 window.set_hovered(true);
1286 let mut state = self.0.borrow_mut();
1287 state.mouse_focused_window = Some(event.event);
1288 }
1289 Event::XinputLeave(event) if event.mode == xinput::NotifyMode::NORMAL => {
1290 let mut state = self.0.borrow_mut();
1291
1292 // 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)
1293 reset_all_pointer_device_scroll_positions(&mut state.pointer_device_states);
1294 state.mouse_focused_window = None;
1295 let pressed_button = pressed_button_from_mask(event.buttons[0]);
1296 let position = point(
1297 px(event.event_x as f32 / u16::MAX as f32 / state.scale_factor),
1298 px(event.event_y as f32 / u16::MAX as f32 / state.scale_factor),
1299 );
1300 let modifiers = modifiers_from_xinput_info(event.mods);
1301 state.modifiers = modifiers;
1302 drop(state);
1303
1304 let window = self.get_window(event.event)?;
1305 window.handle_input(PlatformInput::MouseExited(crate::MouseExitEvent {
1306 pressed_button,
1307 position,
1308 modifiers,
1309 }));
1310 window.set_hovered(false);
1311 }
1312 Event::XinputHierarchy(event) => {
1313 let mut state = self.0.borrow_mut();
1314 // Temporarily use `state.pointer_device_states` to only store pointers that still have valid scroll values.
1315 // Any change to a device invalidates its scroll values.
1316 for info in event.infos {
1317 if is_pointer_device(info.type_) {
1318 state.pointer_device_states.remove(&info.deviceid);
1319 }
1320 }
1321 if let Some(pointer_device_states) = current_pointer_device_states(
1322 &state.xcb_connection,
1323 &state.pointer_device_states,
1324 ) {
1325 state.pointer_device_states = pointer_device_states;
1326 }
1327 }
1328 Event::XinputDeviceChanged(event) => {
1329 let mut state = self.0.borrow_mut();
1330 if let Some(mut pointer) = state.pointer_device_states.get_mut(&event.sourceid) {
1331 reset_pointer_device_scroll_positions(&mut pointer);
1332 }
1333 }
1334 _ => {}
1335 };
1336
1337 Some(())
1338 }
1339
1340 fn handle_xim_callback_event(&self, event: XimCallbackEvent) {
1341 match event {
1342 XimCallbackEvent::XimXEvent(event) => {
1343 self.handle_event(event);
1344 }
1345 XimCallbackEvent::XimCommitEvent(window, text) => {
1346 self.xim_handle_commit(window, text);
1347 }
1348 XimCallbackEvent::XimPreeditEvent(window, text) => {
1349 self.xim_handle_preedit(window, text);
1350 }
1351 };
1352 }
1353
1354 fn xim_handle_event(&self, event: Event) -> Option<()> {
1355 match event {
1356 Event::KeyPress(event) | Event::KeyRelease(event) => {
1357 let mut state = self.0.borrow_mut();
1358 state.pre_key_char_down = Some(Keystroke::from_xkb(
1359 &state.xkb,
1360 &state.keyboard_mapper,
1361 state.modifiers,
1362 event.detail.into(),
1363 ));
1364 let (mut ximc, mut xim_handler) = state.take_xim()?;
1365 drop(state);
1366 xim_handler.window = event.event;
1367 ximc.forward_event(
1368 xim_handler.im_id,
1369 xim_handler.ic_id,
1370 xim::ForwardEventFlag::empty(),
1371 &event,
1372 )
1373 .context("X11: Failed to forward XIM event")
1374 .log_err();
1375 let mut state = self.0.borrow_mut();
1376 state.restore_xim(ximc, xim_handler);
1377 drop(state);
1378 }
1379 event => {
1380 self.handle_event(event);
1381 }
1382 }
1383 Some(())
1384 }
1385
1386 fn xim_handle_commit(&self, window: xproto::Window, text: String) -> Option<()> {
1387 let Some(window) = self.get_window(window) else {
1388 log::error!("bug: Failed to get window for XIM commit");
1389 return None;
1390 };
1391 let mut state = self.0.borrow_mut();
1392 let keystroke = state.pre_key_char_down.take();
1393 state.composing = false;
1394 drop(state);
1395 if let Some(mut keystroke) = keystroke {
1396 keystroke.key_char = Some(text.clone());
1397 window.handle_input(PlatformInput::KeyDown(crate::KeyDownEvent {
1398 keystroke,
1399 is_held: false,
1400 }));
1401 }
1402
1403 Some(())
1404 }
1405
1406 fn xim_handle_preedit(&self, window: xproto::Window, text: String) -> Option<()> {
1407 let Some(window) = self.get_window(window) else {
1408 log::error!("bug: Failed to get window for XIM preedit");
1409 return None;
1410 };
1411
1412 let mut state = self.0.borrow_mut();
1413 let (mut ximc, mut xim_handler) = state.take_xim()?;
1414 state.composing = !text.is_empty();
1415 drop(state);
1416 window.handle_ime_preedit(text);
1417
1418 if let Some(area) = window.get_ime_area() {
1419 let ic_attributes = ximc
1420 .build_ic_attributes()
1421 .push(
1422 xim::AttributeName::InputStyle,
1423 xim::InputStyle::PREEDIT_CALLBACKS,
1424 )
1425 .push(xim::AttributeName::ClientWindow, xim_handler.window)
1426 .push(xim::AttributeName::FocusWindow, xim_handler.window)
1427 .nested_list(xim::AttributeName::PreeditAttributes, |b| {
1428 b.push(
1429 xim::AttributeName::SpotLocation,
1430 xim::Point {
1431 x: u32::from(area.origin.x + area.size.width) as i16,
1432 y: u32::from(area.origin.y + area.size.height) as i16,
1433 },
1434 );
1435 })
1436 .build();
1437 ximc.set_ic_values(xim_handler.im_id, xim_handler.ic_id, ic_attributes)
1438 .ok();
1439 }
1440 let mut state = self.0.borrow_mut();
1441 state.restore_xim(ximc, xim_handler);
1442 drop(state);
1443 Some(())
1444 }
1445
1446 fn handle_keyboard_layout_change(&self) {
1447 let mut state = self.0.borrow_mut();
1448 let layout_idx = state.xkb.serialize_layout(STATE_LAYOUT_EFFECTIVE);
1449 let keymap = state.xkb.get_keymap();
1450 let layout_name = keymap.layout_get_name(layout_idx);
1451 if layout_name != state.keyboard_layout.name() {
1452 state.keyboard_layout = LinuxKeyboardLayout::new(layout_name.to_string().into());
1453 if let Some(mut callback) = state.common.callbacks.keyboard_layout_change.take() {
1454 drop(state);
1455 callback();
1456 state = self.0.borrow_mut();
1457 state.common.callbacks.keyboard_layout_change = Some(callback);
1458 }
1459 }
1460 }
1461}
1462
1463impl LinuxClient for X11Client {
1464 fn compositor_name(&self) -> &'static str {
1465 "X11"
1466 }
1467
1468 fn with_common<R>(&self, f: impl FnOnce(&mut LinuxCommon) -> R) -> R {
1469 f(&mut self.0.borrow_mut().common)
1470 }
1471
1472 fn keyboard_layout(&self) -> Box<dyn PlatformKeyboardLayout> {
1473 let state = self.0.borrow();
1474 Box::new(state.keyboard_layout.clone())
1475 }
1476
1477 fn displays(&self) -> Vec<Rc<dyn PlatformDisplay>> {
1478 let state = self.0.borrow();
1479 let setup = state.xcb_connection.setup();
1480 setup
1481 .roots
1482 .iter()
1483 .enumerate()
1484 .filter_map(|(root_id, _)| {
1485 Some(Rc::new(
1486 X11Display::new(&state.xcb_connection, state.scale_factor, root_id).ok()?,
1487 ) as Rc<dyn PlatformDisplay>)
1488 })
1489 .collect()
1490 }
1491
1492 fn primary_display(&self) -> Option<Rc<dyn PlatformDisplay>> {
1493 let state = self.0.borrow();
1494 X11Display::new(
1495 &state.xcb_connection,
1496 state.scale_factor,
1497 state.x_root_index,
1498 )
1499 .log_err()
1500 .map(|display| Rc::new(display) as Rc<dyn PlatformDisplay>)
1501 }
1502
1503 fn display(&self, id: DisplayId) -> Option<Rc<dyn PlatformDisplay>> {
1504 let state = self.0.borrow();
1505
1506 Some(Rc::new(
1507 X11Display::new(&state.xcb_connection, state.scale_factor, id.0 as usize).ok()?,
1508 ))
1509 }
1510
1511 #[cfg(feature = "screen-capture")]
1512 fn is_screen_capture_supported(&self) -> bool {
1513 true
1514 }
1515
1516 #[cfg(feature = "screen-capture")]
1517 fn screen_capture_sources(
1518 &self,
1519 ) -> futures::channel::oneshot::Receiver<anyhow::Result<Vec<Box<dyn crate::ScreenCaptureSource>>>>
1520 {
1521 crate::platform::scap_screen_capture::scap_screen_sources(
1522 &self.0.borrow().common.foreground_executor,
1523 )
1524 }
1525
1526 fn open_window(
1527 &self,
1528 handle: AnyWindowHandle,
1529 params: WindowParams,
1530 ) -> anyhow::Result<Box<dyn PlatformWindow>> {
1531 let mut state = self.0.borrow_mut();
1532 let x_window = state
1533 .xcb_connection
1534 .generate_id()
1535 .context("X11: Failed to generate window ID")?;
1536
1537 let window = X11Window::new(
1538 handle,
1539 X11ClientStatePtr(Rc::downgrade(&self.0)),
1540 state.common.foreground_executor.clone(),
1541 &state.gpu_context,
1542 params,
1543 &state.xcb_connection,
1544 state.client_side_decorations_supported,
1545 state.x_root_index,
1546 x_window,
1547 &state.atoms,
1548 state.scale_factor,
1549 state.common.appearance,
1550 )?;
1551 check_reply(
1552 || "Failed to set XdndAware property",
1553 state.xcb_connection.change_property32(
1554 xproto::PropMode::REPLACE,
1555 x_window,
1556 state.atoms.XdndAware,
1557 state.atoms.XA_ATOM,
1558 &[5],
1559 ),
1560 )
1561 .log_err();
1562 xcb_flush(&state.xcb_connection);
1563
1564 let window_ref = WindowRef {
1565 window: window.0.clone(),
1566 refresh_state: None,
1567 expose_event_received: false,
1568 last_visibility: Visibility::UNOBSCURED,
1569 is_mapped: false,
1570 };
1571
1572 state.windows.insert(x_window, window_ref);
1573 Ok(Box::new(window))
1574 }
1575
1576 fn set_cursor_style(&self, style: CursorStyle) {
1577 let mut state = self.0.borrow_mut();
1578 let Some(focused_window) = state.mouse_focused_window else {
1579 return;
1580 };
1581 let current_style = state
1582 .cursor_styles
1583 .get(&focused_window)
1584 .unwrap_or(&CursorStyle::Arrow);
1585 if *current_style == style {
1586 return;
1587 }
1588
1589 let Some(cursor) = state.get_cursor_icon(style) else {
1590 return;
1591 };
1592
1593 state.cursor_styles.insert(focused_window, style);
1594 check_reply(
1595 || "Failed to set cursor style",
1596 state.xcb_connection.change_window_attributes(
1597 focused_window,
1598 &ChangeWindowAttributesAux {
1599 cursor: Some(cursor),
1600 ..Default::default()
1601 },
1602 ),
1603 )
1604 .log_err();
1605 state.xcb_connection.flush().log_err();
1606 }
1607
1608 fn open_uri(&self, uri: &str) {
1609 #[cfg(any(feature = "wayland", feature = "x11"))]
1610 open_uri_internal(self.background_executor(), uri, None);
1611 }
1612
1613 fn reveal_path(&self, path: PathBuf) {
1614 #[cfg(any(feature = "x11", feature = "wayland"))]
1615 reveal_path_internal(self.background_executor(), path, None);
1616 }
1617
1618 fn write_to_primary(&self, item: crate::ClipboardItem) {
1619 let state = self.0.borrow_mut();
1620 state
1621 .clipboard
1622 .set_text(
1623 std::borrow::Cow::Owned(item.text().unwrap_or_default()),
1624 clipboard::ClipboardKind::Primary,
1625 clipboard::WaitConfig::None,
1626 )
1627 .context("X11 Failed to write to clipboard (primary)")
1628 .log_with_level(log::Level::Debug);
1629 }
1630
1631 fn write_to_clipboard(&self, item: crate::ClipboardItem) {
1632 let mut state = self.0.borrow_mut();
1633 state
1634 .clipboard
1635 .set_text(
1636 std::borrow::Cow::Owned(item.text().unwrap_or_default()),
1637 clipboard::ClipboardKind::Clipboard,
1638 clipboard::WaitConfig::None,
1639 )
1640 .context("X11: Failed to write to clipboard (clipboard)")
1641 .log_with_level(log::Level::Debug);
1642 state.clipboard_item.replace(item);
1643 }
1644
1645 fn read_from_primary(&self) -> Option<crate::ClipboardItem> {
1646 let state = self.0.borrow_mut();
1647 return state
1648 .clipboard
1649 .get_any(clipboard::ClipboardKind::Primary)
1650 .context("X11: Failed to read from clipboard (primary)")
1651 .log_with_level(log::Level::Debug);
1652 }
1653
1654 fn read_from_clipboard(&self) -> Option<crate::ClipboardItem> {
1655 let state = self.0.borrow_mut();
1656 // if the last copy was from this app, return our cached item
1657 // which has metadata attached.
1658 if state
1659 .clipboard
1660 .is_owner(clipboard::ClipboardKind::Clipboard)
1661 {
1662 return state.clipboard_item.clone();
1663 }
1664 return state
1665 .clipboard
1666 .get_any(clipboard::ClipboardKind::Clipboard)
1667 .context("X11: Failed to read from clipboard (clipboard)")
1668 .log_with_level(log::Level::Debug);
1669 }
1670
1671 fn run(&self) {
1672 let Some(mut event_loop) = self
1673 .0
1674 .borrow_mut()
1675 .event_loop
1676 .take()
1677 .context("X11Client::run called but it's already running")
1678 .log_err()
1679 else {
1680 return;
1681 };
1682
1683 event_loop.run(None, &mut self.clone(), |_| {}).log_err();
1684 }
1685
1686 fn active_window(&self) -> Option<AnyWindowHandle> {
1687 let state = self.0.borrow();
1688 state.keyboard_focused_window.and_then(|focused_window| {
1689 state
1690 .windows
1691 .get(&focused_window)
1692 .map(|window| window.handle())
1693 })
1694 }
1695
1696 fn window_stack(&self) -> Option<Vec<AnyWindowHandle>> {
1697 let state = self.0.borrow();
1698 let root = state.xcb_connection.setup().roots[state.x_root_index].root;
1699
1700 let reply = state
1701 .xcb_connection
1702 .get_property(
1703 false,
1704 root,
1705 state.atoms._NET_CLIENT_LIST_STACKING,
1706 xproto::AtomEnum::WINDOW,
1707 0,
1708 u32::MAX,
1709 )
1710 .ok()?
1711 .reply()
1712 .ok()?;
1713
1714 let window_ids = reply
1715 .value
1716 .chunks_exact(4)
1717 .filter_map(|chunk| chunk.try_into().ok().map(u32::from_ne_bytes))
1718 .collect::<Vec<xproto::Window>>();
1719
1720 let mut handles = Vec::new();
1721
1722 // We need to reverse, since _NET_CLIENT_LIST_STACKING has
1723 // a back-to-front order.
1724 // See: https://specifications.freedesktop.org/wm-spec/1.3/ar01s03.html
1725 for window_ref in window_ids
1726 .iter()
1727 .rev()
1728 .filter_map(|&win| state.windows.get(&win))
1729 {
1730 if !window_ref.window.state.borrow().destroyed {
1731 handles.push(window_ref.handle());
1732 }
1733 }
1734
1735 Some(handles)
1736 }
1737}
1738
1739impl X11ClientState {
1740 fn has_xim(&self) -> bool {
1741 self.ximc.is_some() && self.xim_handler.is_some()
1742 }
1743
1744 fn take_xim(&mut self) -> Option<(X11rbClient<Rc<XCBConnection>>, XimHandler)> {
1745 let ximc = self
1746 .ximc
1747 .take()
1748 .ok_or(anyhow!("bug: XIM connection not set"))
1749 .log_err()?;
1750 if let Some(xim_handler) = self.xim_handler.take() {
1751 Some((ximc, xim_handler))
1752 } else {
1753 self.ximc = Some(ximc);
1754 log::error!("bug: XIM handler not set");
1755 None
1756 }
1757 }
1758
1759 fn restore_xim(&mut self, ximc: X11rbClient<Rc<XCBConnection>>, xim_handler: XimHandler) {
1760 self.ximc = Some(ximc);
1761 self.xim_handler = Some(xim_handler);
1762 }
1763
1764 fn update_refresh_loop(&mut self, x_window: xproto::Window) {
1765 let Some(window_ref) = self.windows.get_mut(&x_window) else {
1766 return;
1767 };
1768 let is_visible = window_ref.is_mapped
1769 && !matches!(window_ref.last_visibility, Visibility::FULLY_OBSCURED);
1770 match (is_visible, window_ref.refresh_state.take()) {
1771 (false, refresh_state @ Some(RefreshState::Hidden { .. }))
1772 | (false, refresh_state @ None)
1773 | (true, refresh_state @ Some(RefreshState::PeriodicRefresh { .. })) => {
1774 window_ref.refresh_state = refresh_state;
1775 }
1776 (
1777 false,
1778 Some(RefreshState::PeriodicRefresh {
1779 refresh_rate,
1780 event_loop_token,
1781 }),
1782 ) => {
1783 self.loop_handle.remove(event_loop_token);
1784 window_ref.refresh_state = Some(RefreshState::Hidden { refresh_rate });
1785 }
1786 (true, Some(RefreshState::Hidden { refresh_rate })) => {
1787 let event_loop_token = self.start_refresh_loop(x_window, refresh_rate);
1788 let Some(window_ref) = self.windows.get_mut(&x_window) else {
1789 return;
1790 };
1791 window_ref.refresh_state = Some(RefreshState::PeriodicRefresh {
1792 refresh_rate,
1793 event_loop_token,
1794 });
1795 }
1796 (true, None) => {
1797 let Some(screen_resources) = get_reply(
1798 || "Failed to get screen resources",
1799 self.xcb_connection
1800 .randr_get_screen_resources_current(x_window),
1801 )
1802 .log_err() else {
1803 return;
1804 };
1805
1806 // Ideally this would be re-queried when the window changes screens, but there
1807 // doesn't seem to be an efficient / straightforward way to do this. Should also be
1808 // updated when screen configurations change.
1809 let mode_info = screen_resources.crtcs.iter().find_map(|crtc| {
1810 let crtc_info = self
1811 .xcb_connection
1812 .randr_get_crtc_info(*crtc, x11rb::CURRENT_TIME)
1813 .ok()?
1814 .reply()
1815 .ok()?;
1816
1817 screen_resources
1818 .modes
1819 .iter()
1820 .find(|m| m.id == crtc_info.mode)
1821 });
1822 let refresh_rate = match mode_info {
1823 Some(mode_info) => mode_refresh_rate(mode_info),
1824 None => {
1825 log::error!(
1826 "Failed to get screen mode info from xrandr, \
1827 defaulting to 60hz refresh rate."
1828 );
1829 Duration::from_micros(1_000_000 / 60)
1830 }
1831 };
1832
1833 let event_loop_token = self.start_refresh_loop(x_window, refresh_rate);
1834 let Some(window_ref) = self.windows.get_mut(&x_window) else {
1835 return;
1836 };
1837 window_ref.refresh_state = Some(RefreshState::PeriodicRefresh {
1838 refresh_rate,
1839 event_loop_token,
1840 });
1841 }
1842 }
1843 }
1844
1845 #[must_use]
1846 fn start_refresh_loop(
1847 &self,
1848 x_window: xproto::Window,
1849 refresh_rate: Duration,
1850 ) -> RegistrationToken {
1851 self.loop_handle
1852 .insert_source(calloop::timer::Timer::immediate(), {
1853 move |mut instant, (), client| {
1854 let xcb_connection = {
1855 let mut state = client.0.borrow_mut();
1856 let xcb_connection = state.xcb_connection.clone();
1857 if let Some(window) = state.windows.get_mut(&x_window) {
1858 let expose_event_received = window.expose_event_received;
1859 window.expose_event_received = false;
1860 let window = window.window.clone();
1861 drop(state);
1862 window.refresh(RequestFrameOptions {
1863 require_presentation: expose_event_received,
1864 });
1865 }
1866 xcb_connection
1867 };
1868 client.process_x11_events(&xcb_connection).log_err();
1869
1870 // Take into account that some frames have been skipped
1871 let now = Instant::now();
1872 while instant < now {
1873 instant += refresh_rate;
1874 }
1875 calloop::timer::TimeoutAction::ToInstant(instant)
1876 }
1877 })
1878 .expect("Failed to initialize window refresh timer")
1879 }
1880
1881 fn get_cursor_icon(&mut self, style: CursorStyle) -> Option<xproto::Cursor> {
1882 if let Some(cursor) = self.cursor_cache.get(&style) {
1883 return *cursor;
1884 }
1885
1886 let mut result;
1887 match style {
1888 CursorStyle::None => match create_invisible_cursor(&self.xcb_connection) {
1889 Ok(loaded_cursor) => result = Ok(loaded_cursor),
1890 Err(err) => result = Err(err.context("X11: error while creating invisible cursor")),
1891 },
1892 _ => 'outer: {
1893 let mut errors = String::new();
1894 let cursor_icon_names = style.to_icon_names();
1895 for cursor_icon_name in cursor_icon_names {
1896 match self
1897 .cursor_handle
1898 .load_cursor(&self.xcb_connection, cursor_icon_name)
1899 {
1900 Ok(loaded_cursor) => {
1901 if loaded_cursor != x11rb::NONE {
1902 result = Ok(loaded_cursor);
1903 break 'outer;
1904 }
1905 }
1906 Err(err) => {
1907 errors.push_str(&err.to_string());
1908 errors.push('\n');
1909 }
1910 }
1911 }
1912 if errors.is_empty() {
1913 result = Err(anyhow!(
1914 "errors while loading cursor icons {:?}:\n{}",
1915 cursor_icon_names,
1916 errors
1917 ));
1918 } else {
1919 result = Err(anyhow!("did not find cursor icons {:?}", cursor_icon_names));
1920 }
1921 }
1922 };
1923
1924 let cursor = match result {
1925 Ok(cursor) => Some(cursor),
1926 Err(err) => {
1927 match self
1928 .cursor_handle
1929 .load_cursor(&self.xcb_connection, DEFAULT_CURSOR_ICON_NAME)
1930 {
1931 Ok(default) => {
1932 log_cursor_icon_warning(err.context(format!(
1933 "X11: error loading cursor icon, falling back on default icon '{}'",
1934 DEFAULT_CURSOR_ICON_NAME
1935 )));
1936 Some(default)
1937 }
1938 Err(default_err) => {
1939 log_cursor_icon_warning(err.context(default_err).context(format!(
1940 "X11: error loading default cursor fallback '{}'",
1941 DEFAULT_CURSOR_ICON_NAME
1942 )));
1943 None
1944 }
1945 }
1946 }
1947 };
1948
1949 self.cursor_cache.insert(style, cursor);
1950 cursor
1951 }
1952}
1953
1954// Adapted from:
1955// https://docs.rs/winit/0.29.11/src/winit/platform_impl/linux/x11/monitor.rs.html#103-111
1956pub fn mode_refresh_rate(mode: &randr::ModeInfo) -> Duration {
1957 if mode.dot_clock == 0 || mode.htotal == 0 || mode.vtotal == 0 {
1958 return Duration::from_millis(16);
1959 }
1960
1961 let millihertz = mode.dot_clock as u64 * 1_000 / (mode.htotal as u64 * mode.vtotal as u64);
1962 let micros = 1_000_000_000 / millihertz;
1963 log::info!("Refreshing every {}ms", micros / 1_000);
1964 Duration::from_micros(micros)
1965}
1966
1967fn fp3232_to_f32(value: xinput::Fp3232) -> f32 {
1968 value.integral as f32 + value.frac as f32 / u32::MAX as f32
1969}
1970
1971fn check_compositor_present(xcb_connection: &XCBConnection, root: u32) -> bool {
1972 // Method 1: Check for _NET_WM_CM_S{root}
1973 let atom_name = format!("_NET_WM_CM_S{}", root);
1974 let atom1 = get_reply(
1975 || format!("Failed to intern {atom_name}"),
1976 xcb_connection.intern_atom(false, atom_name.as_bytes()),
1977 );
1978 let method1 = match atom1.log_with_level(Level::Debug) {
1979 Some(reply) if reply.atom != x11rb::NONE => {
1980 let atom = reply.atom;
1981 get_reply(
1982 || format!("Failed to get {atom_name} owner"),
1983 xcb_connection.get_selection_owner(atom),
1984 )
1985 .map(|reply| reply.owner != 0)
1986 .log_with_level(Level::Debug)
1987 .unwrap_or(false)
1988 }
1989 _ => false,
1990 };
1991
1992 // Method 2: Check for _NET_WM_CM_OWNER
1993 let atom_name = "_NET_WM_CM_OWNER";
1994 let atom2 = get_reply(
1995 || format!("Failed to intern {atom_name}"),
1996 xcb_connection.intern_atom(false, atom_name.as_bytes()),
1997 );
1998 let method2 = match atom2.log_with_level(Level::Debug) {
1999 Some(reply) if reply.atom != x11rb::NONE => {
2000 let atom = reply.atom;
2001 get_reply(
2002 || format!("Failed to get {atom_name}"),
2003 xcb_connection.get_property(false, root, atom, xproto::AtomEnum::WINDOW, 0, 1),
2004 )
2005 .map(|reply| reply.value_len > 0)
2006 .unwrap_or(false)
2007 }
2008 _ => return false,
2009 };
2010
2011 // Method 3: Check for _NET_SUPPORTING_WM_CHECK
2012 let atom_name = "_NET_SUPPORTING_WM_CHECK";
2013 let atom3 = get_reply(
2014 || format!("Failed to intern {atom_name}"),
2015 xcb_connection.intern_atom(false, atom_name.as_bytes()),
2016 );
2017 let method3 = match atom3.log_with_level(Level::Debug) {
2018 Some(reply) if reply.atom != x11rb::NONE => {
2019 let atom = reply.atom;
2020 get_reply(
2021 || format!("Failed to get {atom_name}"),
2022 xcb_connection.get_property(false, root, atom, xproto::AtomEnum::WINDOW, 0, 1),
2023 )
2024 .map(|reply| reply.value_len > 0)
2025 .unwrap_or(false)
2026 }
2027 _ => return false,
2028 };
2029
2030 log::debug!(
2031 "Compositor detection: _NET_WM_CM_S?={}, _NET_WM_CM_OWNER={}, _NET_SUPPORTING_WM_CHECK={}",
2032 method1,
2033 method2,
2034 method3
2035 );
2036
2037 method1 || method2 || method3
2038}
2039
2040fn check_gtk_frame_extents_supported(
2041 xcb_connection: &XCBConnection,
2042 atoms: &XcbAtoms,
2043 root: xproto::Window,
2044) -> bool {
2045 let Some(supported_atoms) = get_reply(
2046 || "Failed to get _NET_SUPPORTED",
2047 xcb_connection.get_property(
2048 false,
2049 root,
2050 atoms._NET_SUPPORTED,
2051 xproto::AtomEnum::ATOM,
2052 0,
2053 1024,
2054 ),
2055 )
2056 .log_with_level(Level::Debug) else {
2057 return false;
2058 };
2059
2060 let supported_atom_ids: Vec<u32> = supported_atoms
2061 .value
2062 .chunks_exact(4)
2063 .filter_map(|chunk| chunk.try_into().ok().map(u32::from_ne_bytes))
2064 .collect();
2065
2066 supported_atom_ids.contains(&atoms._GTK_FRAME_EXTENTS)
2067}
2068
2069fn xdnd_is_atom_supported(atom: u32, atoms: &XcbAtoms) -> bool {
2070 return atom == atoms.TEXT
2071 || atom == atoms.STRING
2072 || atom == atoms.UTF8_STRING
2073 || atom == atoms.TEXT_PLAIN
2074 || atom == atoms.TEXT_PLAIN_UTF8
2075 || atom == atoms.TextUriList;
2076}
2077
2078fn xdnd_get_supported_atom(
2079 xcb_connection: &XCBConnection,
2080 supported_atoms: &XcbAtoms,
2081 target: xproto::Window,
2082) -> u32 {
2083 if let Some(reply) = get_reply(
2084 || "Failed to get XDnD supported atoms",
2085 xcb_connection.get_property(
2086 false,
2087 target,
2088 supported_atoms.XdndTypeList,
2089 AtomEnum::ANY,
2090 0,
2091 1024,
2092 ),
2093 )
2094 .log_with_level(Level::Warn)
2095 {
2096 if let Some(atoms) = reply.value32() {
2097 for atom in atoms {
2098 if xdnd_is_atom_supported(atom, &supported_atoms) {
2099 return atom;
2100 }
2101 }
2102 }
2103 }
2104 return 0;
2105}
2106
2107fn xdnd_send_finished(
2108 xcb_connection: &XCBConnection,
2109 atoms: &XcbAtoms,
2110 source: xproto::Window,
2111 target: xproto::Window,
2112) {
2113 let message = ClientMessageEvent {
2114 format: 32,
2115 window: target,
2116 type_: atoms.XdndFinished,
2117 data: ClientMessageData::from([source, 1, atoms.XdndActionCopy, 0, 0]),
2118 sequence: 0,
2119 response_type: xproto::CLIENT_MESSAGE_EVENT,
2120 };
2121 check_reply(
2122 || "Failed to send XDnD finished event",
2123 xcb_connection.send_event(false, target, EventMask::default(), message),
2124 )
2125 .log_err();
2126 xcb_connection.flush().log_err();
2127}
2128
2129fn xdnd_send_status(
2130 xcb_connection: &XCBConnection,
2131 atoms: &XcbAtoms,
2132 source: xproto::Window,
2133 target: xproto::Window,
2134 action: u32,
2135) {
2136 let message = ClientMessageEvent {
2137 format: 32,
2138 window: target,
2139 type_: atoms.XdndStatus,
2140 data: ClientMessageData::from([source, 1, 0, 0, action]),
2141 sequence: 0,
2142 response_type: xproto::CLIENT_MESSAGE_EVENT,
2143 };
2144 check_reply(
2145 || "Failed to send XDnD status event",
2146 xcb_connection.send_event(false, target, EventMask::default(), message),
2147 )
2148 .log_err();
2149 xcb_connection.flush().log_err();
2150}
2151
2152/// Recomputes `pointer_device_states` by querying all pointer devices.
2153/// When a device is present in `scroll_values_to_preserve`, its value for `ScrollAxisState.scroll_value` is used.
2154fn current_pointer_device_states(
2155 xcb_connection: &XCBConnection,
2156 scroll_values_to_preserve: &BTreeMap<xinput::DeviceId, PointerDeviceState>,
2157) -> Option<BTreeMap<xinput::DeviceId, PointerDeviceState>> {
2158 let devices_query_result = get_reply(
2159 || "Failed to query XInput devices",
2160 xcb_connection.xinput_xi_query_device(XINPUT_ALL_DEVICES),
2161 )
2162 .log_err()?;
2163
2164 let mut pointer_device_states = BTreeMap::new();
2165 pointer_device_states.extend(
2166 devices_query_result
2167 .infos
2168 .iter()
2169 .filter(|info| is_pointer_device(info.type_))
2170 .filter_map(|info| {
2171 let scroll_data = info
2172 .classes
2173 .iter()
2174 .filter_map(|class| class.data.as_scroll())
2175 .map(|class| *class)
2176 .rev()
2177 .collect::<Vec<_>>();
2178 let old_state = scroll_values_to_preserve.get(&info.deviceid);
2179 let old_horizontal = old_state.map(|state| &state.horizontal);
2180 let old_vertical = old_state.map(|state| &state.vertical);
2181 let horizontal = scroll_data
2182 .iter()
2183 .find(|data| data.scroll_type == xinput::ScrollType::HORIZONTAL)
2184 .map(|data| scroll_data_to_axis_state(data, old_horizontal));
2185 let vertical = scroll_data
2186 .iter()
2187 .find(|data| data.scroll_type == xinput::ScrollType::VERTICAL)
2188 .map(|data| scroll_data_to_axis_state(data, old_vertical));
2189 if horizontal.is_none() && vertical.is_none() {
2190 None
2191 } else {
2192 Some((
2193 info.deviceid,
2194 PointerDeviceState {
2195 horizontal: horizontal.unwrap_or_else(Default::default),
2196 vertical: vertical.unwrap_or_else(Default::default),
2197 },
2198 ))
2199 }
2200 }),
2201 );
2202 if pointer_device_states.is_empty() {
2203 log::error!("Found no xinput mouse pointers.");
2204 }
2205 return Some(pointer_device_states);
2206}
2207
2208/// Returns true if the device is a pointer device. Does not include pointer device groups.
2209fn is_pointer_device(type_: xinput::DeviceType) -> bool {
2210 type_ == xinput::DeviceType::SLAVE_POINTER
2211}
2212
2213fn scroll_data_to_axis_state(
2214 data: &xinput::DeviceClassDataScroll,
2215 old_axis_state_with_valid_scroll_value: Option<&ScrollAxisState>,
2216) -> ScrollAxisState {
2217 ScrollAxisState {
2218 valuator_number: Some(data.number),
2219 multiplier: SCROLL_LINES / fp3232_to_f32(data.increment),
2220 scroll_value: old_axis_state_with_valid_scroll_value.and_then(|state| state.scroll_value),
2221 }
2222}
2223
2224fn reset_all_pointer_device_scroll_positions(
2225 pointer_device_states: &mut BTreeMap<xinput::DeviceId, PointerDeviceState>,
2226) {
2227 pointer_device_states
2228 .iter_mut()
2229 .for_each(|(_, device_state)| reset_pointer_device_scroll_positions(device_state));
2230}
2231
2232fn reset_pointer_device_scroll_positions(pointer: &mut PointerDeviceState) {
2233 pointer.horizontal.scroll_value = None;
2234 pointer.vertical.scroll_value = None;
2235}
2236
2237/// Returns the scroll delta for a smooth scrolling motion event, or `None` if no scroll data is present.
2238fn get_scroll_delta_and_update_state(
2239 pointer: &mut PointerDeviceState,
2240 event: &xinput::MotionEvent,
2241) -> Option<Point<f32>> {
2242 let delta_x = get_axis_scroll_delta_and_update_state(event, &mut pointer.horizontal);
2243 let delta_y = get_axis_scroll_delta_and_update_state(event, &mut pointer.vertical);
2244 if delta_x.is_some() || delta_y.is_some() {
2245 Some(Point::new(delta_x.unwrap_or(0.0), delta_y.unwrap_or(0.0)))
2246 } else {
2247 None
2248 }
2249}
2250
2251fn get_axis_scroll_delta_and_update_state(
2252 event: &xinput::MotionEvent,
2253 axis: &mut ScrollAxisState,
2254) -> Option<f32> {
2255 let axis_index = get_valuator_axis_index(&event.valuator_mask, axis.valuator_number?)?;
2256 if let Some(axis_value) = event.axisvalues.get(axis_index) {
2257 let new_scroll = fp3232_to_f32(*axis_value);
2258 let delta_scroll = axis
2259 .scroll_value
2260 .map(|old_scroll| (old_scroll - new_scroll) * axis.multiplier);
2261 axis.scroll_value = Some(new_scroll);
2262 delta_scroll
2263 } else {
2264 log::error!("Encountered invalid XInput valuator_mask, scrolling may not work properly.");
2265 None
2266 }
2267}
2268
2269fn make_scroll_wheel_event(
2270 position: Point<Pixels>,
2271 scroll_delta: Point<f32>,
2272 modifiers: Modifiers,
2273) -> crate::ScrollWheelEvent {
2274 // When shift is held down, vertical scrolling turns into horizontal scrolling.
2275 let delta = if modifiers.shift {
2276 Point {
2277 x: scroll_delta.y,
2278 y: 0.0,
2279 }
2280 } else {
2281 scroll_delta
2282 };
2283 crate::ScrollWheelEvent {
2284 position,
2285 delta: ScrollDelta::Lines(delta),
2286 modifiers,
2287 touch_phase: TouchPhase::default(),
2288 }
2289}
2290
2291fn create_invisible_cursor(
2292 connection: &XCBConnection,
2293) -> anyhow::Result<crate::platform::linux::x11::client::xproto::Cursor> {
2294 let empty_pixmap = connection.generate_id()?;
2295 let root = connection.setup().roots[0].root;
2296 connection.create_pixmap(1, empty_pixmap, root, 1, 1)?;
2297
2298 let cursor = connection.generate_id()?;
2299 connection.create_cursor(cursor, empty_pixmap, empty_pixmap, 0, 0, 0, 0, 0, 0, 0, 0)?;
2300
2301 connection.free_pixmap(empty_pixmap)?;
2302
2303 xcb_flush(connection);
2304 Ok(cursor)
2305}
2306
2307fn update_keyboard_mapper(
2308 client: &mut X11ClientState,
2309 keyboard_layout: LinuxKeyboardLayout,
2310 base_group: u32,
2311 latched_group: u32,
2312 locked_group: u32,
2313) {
2314 client.keyboard_mapper =
2315 if let Some(mapper) = client.keyboard_mapper_cache.get(keyboard_layout.id()) {
2316 Rc::clone(mapper)
2317 } else {
2318 let mapper = Rc::new(LinuxKeyboardMapper::new(
2319 base_group,
2320 latched_group,
2321 locked_group,
2322 ));
2323 client
2324 .keyboard_mapper_cache
2325 .insert(keyboard_layout.id().to_string(), Rc::clone(&mapper));
2326 mapper
2327 };
2328 client.keyboard_layout = Box::new(keyboard_layout);
2329}