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