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