1use crate::{Capslock, ResultExt as _, RunnableVariant, TaskTiming, profiler, 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 as _;
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, ModMask, 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 profiler::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 profiler::add_task_timing(timing);
338
339 runnable.run();
340 timing
341 }
342 };
343
344 let end = Instant::now();
345 timing.end = Some(end);
346 profiler::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().notify_err("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
1022 // Macros containing modifiers might result in
1023 // the modifiers missing from the event.
1024 // We therefore update the mask from the global state.
1025 update_xkb_mask_from_event_state(&mut state.xkb, event.state);
1026
1027 let keystroke = {
1028 let code = event.detail.into();
1029 let mut keystroke = crate::Keystroke::from_xkb(&state.xkb, modifiers, code);
1030 let keysym = state.xkb.key_get_one_sym(code);
1031
1032 if keysym.is_modifier_key() {
1033 return Some(());
1034 }
1035
1036 // should be called after key_get_one_sym
1037 state.xkb.update_key(code, xkbc::KeyDirection::Down);
1038
1039 if let Some(mut compose_state) = state.compose_state.take() {
1040 compose_state.feed(keysym);
1041 match compose_state.status() {
1042 xkbc::Status::Composed => {
1043 state.pre_edit_text.take();
1044 keystroke.key_char = compose_state.utf8();
1045 if let Some(keysym) = compose_state.keysym() {
1046 keystroke.key = xkbc::keysym_get_name(keysym);
1047 }
1048 }
1049 xkbc::Status::Composing => {
1050 keystroke.key_char = None;
1051 state.pre_edit_text = compose_state
1052 .utf8()
1053 .or(crate::Keystroke::underlying_dead_key(keysym));
1054 let pre_edit =
1055 state.pre_edit_text.clone().unwrap_or(String::default());
1056 drop(state);
1057 window.handle_ime_preedit(pre_edit);
1058 state = self.0.borrow_mut();
1059 }
1060 xkbc::Status::Cancelled => {
1061 let pre_edit = state.pre_edit_text.take();
1062 drop(state);
1063 if let Some(pre_edit) = pre_edit {
1064 window.handle_ime_commit(pre_edit);
1065 }
1066 if let Some(current_key) = Keystroke::underlying_dead_key(keysym) {
1067 window.handle_ime_preedit(current_key);
1068 }
1069 state = self.0.borrow_mut();
1070 compose_state.feed(keysym);
1071 }
1072 _ => {}
1073 }
1074 state.compose_state = Some(compose_state);
1075 }
1076 keystroke
1077 };
1078 drop(state);
1079 window.handle_input(PlatformInput::KeyDown(crate::KeyDownEvent {
1080 keystroke,
1081 is_held: false,
1082 prefer_character_input: false,
1083 }));
1084 }
1085 Event::KeyRelease(event) => {
1086 let window = self.get_window(event.event)?;
1087 let mut state = self.0.borrow_mut();
1088
1089 let modifiers = modifiers_from_state(event.state);
1090 state.modifiers = modifiers;
1091
1092 // Macros containing modifiers might result in
1093 // the modifiers missing from the event.
1094 // We therefore update the mask from the global state.
1095 update_xkb_mask_from_event_state(&mut state.xkb, event.state);
1096
1097 let keystroke = {
1098 let code = event.detail.into();
1099 let keystroke = crate::Keystroke::from_xkb(&state.xkb, modifiers, code);
1100 let keysym = state.xkb.key_get_one_sym(code);
1101
1102 if keysym.is_modifier_key() {
1103 return Some(());
1104 }
1105
1106 // should be called after key_get_one_sym
1107 state.xkb.update_key(code, xkbc::KeyDirection::Up);
1108
1109 keystroke
1110 };
1111 drop(state);
1112 window.handle_input(PlatformInput::KeyUp(crate::KeyUpEvent { keystroke }));
1113 }
1114 Event::XinputButtonPress(event) => {
1115 let window = self.get_window(event.event)?;
1116 let mut state = self.0.borrow_mut();
1117
1118 let modifiers = modifiers_from_xinput_info(event.mods);
1119 state.modifiers = modifiers;
1120
1121 let position = point(
1122 px(event.event_x as f32 / u16::MAX as f32 / state.scale_factor),
1123 px(event.event_y as f32 / u16::MAX as f32 / state.scale_factor),
1124 );
1125
1126 if state.composing && state.ximc.is_some() {
1127 drop(state);
1128 self.reset_ime();
1129 window.handle_ime_unmark();
1130 state = self.0.borrow_mut();
1131 } else if let Some(text) = state.pre_edit_text.take() {
1132 if let Some(compose_state) = state.compose_state.as_mut() {
1133 compose_state.reset();
1134 }
1135 drop(state);
1136 window.handle_ime_commit(text);
1137 state = self.0.borrow_mut();
1138 }
1139 match button_or_scroll_from_event_detail(event.detail) {
1140 Some(ButtonOrScroll::Button(button)) => {
1141 let click_elapsed = state.last_click.elapsed();
1142 if click_elapsed < DOUBLE_CLICK_INTERVAL
1143 && state
1144 .last_mouse_button
1145 .is_some_and(|prev_button| prev_button == button)
1146 && is_within_click_distance(state.last_location, position)
1147 {
1148 state.current_count += 1;
1149 } else {
1150 state.current_count = 1;
1151 }
1152
1153 state.last_click = Instant::now();
1154 state.last_mouse_button = Some(button);
1155 state.last_location = position;
1156 let current_count = state.current_count;
1157
1158 drop(state);
1159 window.handle_input(PlatformInput::MouseDown(crate::MouseDownEvent {
1160 button,
1161 position,
1162 modifiers,
1163 click_count: current_count,
1164 first_mouse: false,
1165 }));
1166 }
1167 Some(ButtonOrScroll::Scroll(direction)) => {
1168 drop(state);
1169 // Emulated scroll button presses are sent simultaneously with smooth scrolling XinputMotion events.
1170 // Since handling those events does the scrolling, they are skipped here.
1171 if !event
1172 .flags
1173 .contains(xinput::PointerEventFlags::POINTER_EMULATED)
1174 {
1175 let scroll_delta = match direction {
1176 ScrollDirection::Up => Point::new(0.0, SCROLL_LINES),
1177 ScrollDirection::Down => Point::new(0.0, -SCROLL_LINES),
1178 ScrollDirection::Left => Point::new(SCROLL_LINES, 0.0),
1179 ScrollDirection::Right => Point::new(-SCROLL_LINES, 0.0),
1180 };
1181 window.handle_input(PlatformInput::ScrollWheel(
1182 make_scroll_wheel_event(position, scroll_delta, modifiers),
1183 ));
1184 }
1185 }
1186 None => {
1187 log::error!("Unknown x11 button: {}", event.detail);
1188 }
1189 }
1190 }
1191 Event::XinputButtonRelease(event) => {
1192 let window = self.get_window(event.event)?;
1193 let mut state = self.0.borrow_mut();
1194 let modifiers = modifiers_from_xinput_info(event.mods);
1195 state.modifiers = modifiers;
1196
1197 let position = point(
1198 px(event.event_x as f32 / u16::MAX as f32 / state.scale_factor),
1199 px(event.event_y as f32 / u16::MAX as f32 / state.scale_factor),
1200 );
1201 match button_or_scroll_from_event_detail(event.detail) {
1202 Some(ButtonOrScroll::Button(button)) => {
1203 let click_count = state.current_count;
1204 drop(state);
1205 window.handle_input(PlatformInput::MouseUp(crate::MouseUpEvent {
1206 button,
1207 position,
1208 modifiers,
1209 click_count,
1210 }));
1211 }
1212 Some(ButtonOrScroll::Scroll(_)) => {}
1213 None => {}
1214 }
1215 }
1216 Event::XinputMotion(event) => {
1217 let window = self.get_window(event.event)?;
1218 let mut state = self.0.borrow_mut();
1219 let pressed_button = pressed_button_from_mask(event.button_mask[0]);
1220 let position = point(
1221 px(event.event_x as f32 / u16::MAX as f32 / state.scale_factor),
1222 px(event.event_y as f32 / u16::MAX as f32 / state.scale_factor),
1223 );
1224 let modifiers = modifiers_from_xinput_info(event.mods);
1225 state.modifiers = modifiers;
1226 drop(state);
1227
1228 if event.valuator_mask[0] & 3 != 0 {
1229 window.handle_input(PlatformInput::MouseMove(crate::MouseMoveEvent {
1230 position,
1231 pressed_button,
1232 modifiers,
1233 }));
1234 }
1235
1236 state = self.0.borrow_mut();
1237 if let Some(mut pointer) = state.pointer_device_states.get_mut(&event.sourceid) {
1238 let scroll_delta = get_scroll_delta_and_update_state(pointer, &event);
1239 drop(state);
1240 if let Some(scroll_delta) = scroll_delta {
1241 window.handle_input(PlatformInput::ScrollWheel(make_scroll_wheel_event(
1242 position,
1243 scroll_delta,
1244 modifiers,
1245 )));
1246 }
1247 }
1248 }
1249 Event::XinputEnter(event) if event.mode == xinput::NotifyMode::NORMAL => {
1250 let window = self.get_window(event.event)?;
1251 window.set_hovered(true);
1252 let mut state = self.0.borrow_mut();
1253 state.mouse_focused_window = Some(event.event);
1254 }
1255 Event::XinputLeave(event) if event.mode == xinput::NotifyMode::NORMAL => {
1256 let mut state = self.0.borrow_mut();
1257
1258 // 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)
1259 reset_all_pointer_device_scroll_positions(&mut state.pointer_device_states);
1260 state.mouse_focused_window = None;
1261 let pressed_button = pressed_button_from_mask(event.buttons[0]);
1262 let position = point(
1263 px(event.event_x as f32 / u16::MAX as f32 / state.scale_factor),
1264 px(event.event_y as f32 / u16::MAX as f32 / state.scale_factor),
1265 );
1266 let modifiers = modifiers_from_xinput_info(event.mods);
1267 state.modifiers = modifiers;
1268 drop(state);
1269
1270 let window = self.get_window(event.event)?;
1271 window.handle_input(PlatformInput::MouseExited(crate::MouseExitEvent {
1272 pressed_button,
1273 position,
1274 modifiers,
1275 }));
1276 window.set_hovered(false);
1277 }
1278 Event::XinputHierarchy(event) => {
1279 let mut state = self.0.borrow_mut();
1280 // Temporarily use `state.pointer_device_states` to only store pointers that still have valid scroll values.
1281 // Any change to a device invalidates its scroll values.
1282 for info in event.infos {
1283 if is_pointer_device(info.type_) {
1284 state.pointer_device_states.remove(&info.deviceid);
1285 }
1286 }
1287 if let Some(pointer_device_states) = current_pointer_device_states(
1288 &state.xcb_connection,
1289 &state.pointer_device_states,
1290 ) {
1291 state.pointer_device_states = pointer_device_states;
1292 }
1293 }
1294 Event::XinputDeviceChanged(event) => {
1295 let mut state = self.0.borrow_mut();
1296 if let Some(mut pointer) = state.pointer_device_states.get_mut(&event.sourceid) {
1297 reset_pointer_device_scroll_positions(pointer);
1298 }
1299 }
1300 _ => {}
1301 };
1302
1303 Some(())
1304 }
1305
1306 fn handle_xim_callback_event(&self, event: XimCallbackEvent) {
1307 match event {
1308 XimCallbackEvent::XimXEvent(event) => {
1309 self.handle_event(event);
1310 }
1311 XimCallbackEvent::XimCommitEvent(window, text) => {
1312 self.xim_handle_commit(window, text);
1313 }
1314 XimCallbackEvent::XimPreeditEvent(window, text) => {
1315 self.xim_handle_preedit(window, text);
1316 }
1317 };
1318 }
1319
1320 fn xim_handle_event(&self, event: Event) -> Option<()> {
1321 match event {
1322 Event::KeyPress(event) | Event::KeyRelease(event) => {
1323 let mut state = self.0.borrow_mut();
1324 state.pre_key_char_down = Some(Keystroke::from_xkb(
1325 &state.xkb,
1326 state.modifiers,
1327 event.detail.into(),
1328 ));
1329 let (mut ximc, mut xim_handler) = state.take_xim()?;
1330 drop(state);
1331 xim_handler.window = event.event;
1332 ximc.forward_event(
1333 xim_handler.im_id,
1334 xim_handler.ic_id,
1335 xim::ForwardEventFlag::empty(),
1336 &event,
1337 )
1338 .context("X11: Failed to forward XIM event")
1339 .log_err();
1340 let mut state = self.0.borrow_mut();
1341 state.restore_xim(ximc, xim_handler);
1342 drop(state);
1343 }
1344 event => {
1345 self.handle_event(event);
1346 }
1347 }
1348 Some(())
1349 }
1350
1351 fn xim_handle_commit(&self, window: xproto::Window, text: String) -> Option<()> {
1352 let Some(window) = self.get_window(window) else {
1353 log::error!("bug: Failed to get window for XIM commit");
1354 return None;
1355 };
1356 let mut state = self.0.borrow_mut();
1357 state.composing = false;
1358 drop(state);
1359 window.handle_ime_commit(text);
1360 Some(())
1361 }
1362
1363 fn xim_handle_preedit(&self, window: xproto::Window, text: String) -> Option<()> {
1364 let Some(window) = self.get_window(window) else {
1365 log::error!("bug: Failed to get window for XIM preedit");
1366 return None;
1367 };
1368
1369 let mut state = self.0.borrow_mut();
1370 let (mut ximc, mut xim_handler) = state.take_xim()?;
1371 state.composing = !text.is_empty();
1372 drop(state);
1373 window.handle_ime_preedit(text);
1374
1375 if let Some(scaled_area) = window.get_ime_area() {
1376 let ic_attributes = ximc
1377 .build_ic_attributes()
1378 .push(
1379 xim::AttributeName::InputStyle,
1380 xim::InputStyle::PREEDIT_CALLBACKS,
1381 )
1382 .push(xim::AttributeName::ClientWindow, xim_handler.window)
1383 .push(xim::AttributeName::FocusWindow, xim_handler.window)
1384 .nested_list(xim::AttributeName::PreeditAttributes, |b| {
1385 b.push(
1386 xim::AttributeName::SpotLocation,
1387 xim::Point {
1388 x: u32::from(scaled_area.origin.x + scaled_area.size.width) as i16,
1389 y: u32::from(scaled_area.origin.y + scaled_area.size.height) as i16,
1390 },
1391 );
1392 })
1393 .build();
1394 ximc.set_ic_values(xim_handler.im_id, xim_handler.ic_id, ic_attributes)
1395 .ok();
1396 }
1397 let mut state = self.0.borrow_mut();
1398 state.restore_xim(ximc, xim_handler);
1399 drop(state);
1400 Some(())
1401 }
1402
1403 fn handle_keyboard_layout_change(&self) {
1404 let mut state = self.0.borrow_mut();
1405 let layout_idx = state.xkb.serialize_layout(STATE_LAYOUT_EFFECTIVE);
1406 let keymap = state.xkb.get_keymap();
1407 let layout_name = keymap.layout_get_name(layout_idx);
1408 if layout_name != state.keyboard_layout.name() {
1409 state.keyboard_layout = LinuxKeyboardLayout::new(layout_name.to_string().into());
1410 if let Some(mut callback) = state.common.callbacks.keyboard_layout_change.take() {
1411 drop(state);
1412 callback();
1413 state = self.0.borrow_mut();
1414 state.common.callbacks.keyboard_layout_change = Some(callback);
1415 }
1416 }
1417 }
1418}
1419
1420impl LinuxClient for X11Client {
1421 fn compositor_name(&self) -> &'static str {
1422 "X11"
1423 }
1424
1425 fn with_common<R>(&self, f: impl FnOnce(&mut LinuxCommon) -> R) -> R {
1426 f(&mut self.0.borrow_mut().common)
1427 }
1428
1429 fn keyboard_layout(&self) -> Box<dyn PlatformKeyboardLayout> {
1430 let state = self.0.borrow();
1431 Box::new(state.keyboard_layout.clone())
1432 }
1433
1434 fn displays(&self) -> Vec<Rc<dyn PlatformDisplay>> {
1435 let state = self.0.borrow();
1436 let setup = state.xcb_connection.setup();
1437 setup
1438 .roots
1439 .iter()
1440 .enumerate()
1441 .filter_map(|(root_id, _)| {
1442 Some(Rc::new(
1443 X11Display::new(&state.xcb_connection, state.scale_factor, root_id).ok()?,
1444 ) as Rc<dyn PlatformDisplay>)
1445 })
1446 .collect()
1447 }
1448
1449 fn primary_display(&self) -> Option<Rc<dyn PlatformDisplay>> {
1450 let state = self.0.borrow();
1451 X11Display::new(
1452 &state.xcb_connection,
1453 state.scale_factor,
1454 state.x_root_index,
1455 )
1456 .log_err()
1457 .map(|display| Rc::new(display) as Rc<dyn PlatformDisplay>)
1458 }
1459
1460 fn display(&self, id: DisplayId) -> Option<Rc<dyn PlatformDisplay>> {
1461 let state = self.0.borrow();
1462
1463 Some(Rc::new(
1464 X11Display::new(&state.xcb_connection, state.scale_factor, id.0 as usize).ok()?,
1465 ))
1466 }
1467
1468 #[cfg(feature = "screen-capture")]
1469 fn is_screen_capture_supported(&self) -> bool {
1470 true
1471 }
1472
1473 #[cfg(feature = "screen-capture")]
1474 fn screen_capture_sources(
1475 &self,
1476 ) -> futures::channel::oneshot::Receiver<anyhow::Result<Vec<Rc<dyn crate::ScreenCaptureSource>>>>
1477 {
1478 crate::platform::scap_screen_capture::scap_screen_sources(
1479 &self.0.borrow().common.foreground_executor,
1480 )
1481 }
1482
1483 fn open_window(
1484 &self,
1485 handle: AnyWindowHandle,
1486 params: WindowParams,
1487 ) -> anyhow::Result<Box<dyn PlatformWindow>> {
1488 let mut state = self.0.borrow_mut();
1489 let parent_window = state
1490 .keyboard_focused_window
1491 .and_then(|focused_window| state.windows.get(&focused_window))
1492 .map(|window| window.window.x_window);
1493 let x_window = state
1494 .xcb_connection
1495 .generate_id()
1496 .context("X11: Failed to generate window ID")?;
1497
1498 let window = X11Window::new(
1499 handle,
1500 X11ClientStatePtr(Rc::downgrade(&self.0)),
1501 state.common.foreground_executor.clone(),
1502 &state.gpu_context,
1503 params,
1504 &state.xcb_connection,
1505 state.client_side_decorations_supported,
1506 state.x_root_index,
1507 x_window,
1508 &state.atoms,
1509 state.scale_factor,
1510 state.common.appearance,
1511 parent_window,
1512 )?;
1513 check_reply(
1514 || "Failed to set XdndAware property",
1515 state.xcb_connection.change_property32(
1516 xproto::PropMode::REPLACE,
1517 x_window,
1518 state.atoms.XdndAware,
1519 state.atoms.XA_ATOM,
1520 &[5],
1521 ),
1522 )
1523 .log_err();
1524 xcb_flush(&state.xcb_connection);
1525
1526 let window_ref = WindowRef {
1527 window: window.0.clone(),
1528 refresh_state: None,
1529 expose_event_received: false,
1530 last_visibility: Visibility::UNOBSCURED,
1531 is_mapped: false,
1532 };
1533
1534 state.windows.insert(x_window, window_ref);
1535 Ok(Box::new(window))
1536 }
1537
1538 fn set_cursor_style(&self, style: CursorStyle) {
1539 let mut state = self.0.borrow_mut();
1540 let Some(focused_window) = state.mouse_focused_window else {
1541 return;
1542 };
1543 let current_style = state
1544 .cursor_styles
1545 .get(&focused_window)
1546 .unwrap_or(&CursorStyle::Arrow);
1547 if *current_style == style {
1548 return;
1549 }
1550
1551 let Some(cursor) = state.get_cursor_icon(style) else {
1552 return;
1553 };
1554
1555 state.cursor_styles.insert(focused_window, style);
1556 check_reply(
1557 || "Failed to set cursor style",
1558 state.xcb_connection.change_window_attributes(
1559 focused_window,
1560 &ChangeWindowAttributesAux {
1561 cursor: Some(cursor),
1562 ..Default::default()
1563 },
1564 ),
1565 )
1566 .log_err();
1567 state.xcb_connection.flush().log_err();
1568 }
1569
1570 fn open_uri(&self, uri: &str) {
1571 #[cfg(any(feature = "wayland", feature = "x11"))]
1572 open_uri_internal(self.background_executor(), uri, None);
1573 }
1574
1575 fn reveal_path(&self, path: PathBuf) {
1576 #[cfg(any(feature = "x11", feature = "wayland"))]
1577 reveal_path_internal(self.background_executor(), path, None);
1578 }
1579
1580 fn write_to_primary(&self, item: crate::ClipboardItem) {
1581 let state = self.0.borrow_mut();
1582 state
1583 .clipboard
1584 .set_text(
1585 std::borrow::Cow::Owned(item.text().unwrap_or_default()),
1586 clipboard::ClipboardKind::Primary,
1587 clipboard::WaitConfig::None,
1588 )
1589 .context("X11 Failed to write to clipboard (primary)")
1590 .log_with_level(log::Level::Debug);
1591 }
1592
1593 fn write_to_clipboard(&self, item: crate::ClipboardItem) {
1594 let mut state = self.0.borrow_mut();
1595 state
1596 .clipboard
1597 .set_text(
1598 std::borrow::Cow::Owned(item.text().unwrap_or_default()),
1599 clipboard::ClipboardKind::Clipboard,
1600 clipboard::WaitConfig::None,
1601 )
1602 .context("X11: Failed to write to clipboard (clipboard)")
1603 .log_with_level(log::Level::Debug);
1604 state.clipboard_item.replace(item);
1605 }
1606
1607 fn read_from_primary(&self) -> Option<crate::ClipboardItem> {
1608 let state = self.0.borrow_mut();
1609 state
1610 .clipboard
1611 .get_any(clipboard::ClipboardKind::Primary)
1612 .context("X11: Failed to read from clipboard (primary)")
1613 .log_with_level(log::Level::Debug)
1614 }
1615
1616 fn read_from_clipboard(&self) -> Option<crate::ClipboardItem> {
1617 let state = self.0.borrow_mut();
1618 // if the last copy was from this app, return our cached item
1619 // which has metadata attached.
1620 if state
1621 .clipboard
1622 .is_owner(clipboard::ClipboardKind::Clipboard)
1623 {
1624 return state.clipboard_item.clone();
1625 }
1626 state
1627 .clipboard
1628 .get_any(clipboard::ClipboardKind::Clipboard)
1629 .context("X11: Failed to read from clipboard (clipboard)")
1630 .log_with_level(log::Level::Debug)
1631 }
1632
1633 fn run(&self) {
1634 let Some(mut event_loop) = self
1635 .0
1636 .borrow_mut()
1637 .event_loop
1638 .take()
1639 .context("X11Client::run called but it's already running")
1640 .log_err()
1641 else {
1642 return;
1643 };
1644
1645 event_loop.run(None, &mut self.clone(), |_| {}).log_err();
1646 }
1647
1648 fn active_window(&self) -> Option<AnyWindowHandle> {
1649 let state = self.0.borrow();
1650 state.keyboard_focused_window.and_then(|focused_window| {
1651 state
1652 .windows
1653 .get(&focused_window)
1654 .map(|window| window.handle())
1655 })
1656 }
1657
1658 fn window_stack(&self) -> Option<Vec<AnyWindowHandle>> {
1659 let state = self.0.borrow();
1660 let root = state.xcb_connection.setup().roots[state.x_root_index].root;
1661
1662 let reply = state
1663 .xcb_connection
1664 .get_property(
1665 false,
1666 root,
1667 state.atoms._NET_CLIENT_LIST_STACKING,
1668 xproto::AtomEnum::WINDOW,
1669 0,
1670 u32::MAX,
1671 )
1672 .ok()?
1673 .reply()
1674 .ok()?;
1675
1676 let window_ids = reply
1677 .value
1678 .chunks_exact(4)
1679 .filter_map(|chunk| chunk.try_into().ok().map(u32::from_ne_bytes))
1680 .collect::<Vec<xproto::Window>>();
1681
1682 let mut handles = Vec::new();
1683
1684 // We need to reverse, since _NET_CLIENT_LIST_STACKING has
1685 // a back-to-front order.
1686 // See: https://specifications.freedesktop.org/wm-spec/1.3/ar01s03.html
1687 for window_ref in window_ids
1688 .iter()
1689 .rev()
1690 .filter_map(|&win| state.windows.get(&win))
1691 {
1692 if !window_ref.window.state.borrow().destroyed {
1693 handles.push(window_ref.handle());
1694 }
1695 }
1696
1697 Some(handles)
1698 }
1699
1700 fn window_identifier(&self) -> impl Future<Output = Option<WindowIdentifier>> + Send + 'static {
1701 let state = self.0.borrow();
1702 state
1703 .keyboard_focused_window
1704 .and_then(|focused_window| state.windows.get(&focused_window))
1705 .map(|window| window.window.x_window as u64)
1706 .map(|x_window| std::future::ready(Some(WindowIdentifier::from_xid(x_window))))
1707 .unwrap_or(std::future::ready(None))
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 force_render: false,
1837 });
1838 }
1839 xcb_connection
1840 };
1841 client.process_x11_events(&xcb_connection).log_err();
1842
1843 // Take into account that some frames have been skipped
1844 let now = Instant::now();
1845 while instant < now {
1846 instant += refresh_rate;
1847 }
1848 calloop::timer::TimeoutAction::ToInstant(instant)
1849 }
1850 })
1851 .expect("Failed to initialize window refresh timer")
1852 }
1853
1854 fn get_cursor_icon(&mut self, style: CursorStyle) -> Option<xproto::Cursor> {
1855 if let Some(cursor) = self.cursor_cache.get(&style) {
1856 return *cursor;
1857 }
1858
1859 let mut result;
1860 match style {
1861 CursorStyle::None => match create_invisible_cursor(&self.xcb_connection) {
1862 Ok(loaded_cursor) => result = Ok(loaded_cursor),
1863 Err(err) => result = Err(err.context("X11: error while creating invisible cursor")),
1864 },
1865 _ => 'outer: {
1866 let mut errors = String::new();
1867 let cursor_icon_names = style.to_icon_names();
1868 for cursor_icon_name in cursor_icon_names {
1869 match self
1870 .cursor_handle
1871 .load_cursor(&self.xcb_connection, cursor_icon_name)
1872 {
1873 Ok(loaded_cursor) => {
1874 if loaded_cursor != x11rb::NONE {
1875 result = Ok(loaded_cursor);
1876 break 'outer;
1877 }
1878 }
1879 Err(err) => {
1880 errors.push_str(&err.to_string());
1881 errors.push('\n');
1882 }
1883 }
1884 }
1885 if errors.is_empty() {
1886 result = Err(anyhow!(
1887 "errors while loading cursor icons {:?}:\n{}",
1888 cursor_icon_names,
1889 errors
1890 ));
1891 } else {
1892 result = Err(anyhow!("did not find cursor icons {:?}", cursor_icon_names));
1893 }
1894 }
1895 };
1896
1897 let cursor = match result {
1898 Ok(cursor) => Some(cursor),
1899 Err(err) => {
1900 match self
1901 .cursor_handle
1902 .load_cursor(&self.xcb_connection, DEFAULT_CURSOR_ICON_NAME)
1903 {
1904 Ok(default) => {
1905 log_cursor_icon_warning(err.context(format!(
1906 "X11: error loading cursor icon, falling back on default icon '{}'",
1907 DEFAULT_CURSOR_ICON_NAME
1908 )));
1909 Some(default)
1910 }
1911 Err(default_err) => {
1912 log_cursor_icon_warning(err.context(default_err).context(format!(
1913 "X11: error loading default cursor fallback '{}'",
1914 DEFAULT_CURSOR_ICON_NAME
1915 )));
1916 None
1917 }
1918 }
1919 }
1920 };
1921
1922 self.cursor_cache.insert(style, cursor);
1923 cursor
1924 }
1925}
1926
1927// Adapted from:
1928// https://docs.rs/winit/0.29.11/src/winit/platform_impl/linux/x11/monitor.rs.html#103-111
1929pub fn mode_refresh_rate(mode: &randr::ModeInfo) -> Duration {
1930 if mode.dot_clock == 0 || mode.htotal == 0 || mode.vtotal == 0 {
1931 return Duration::from_millis(16);
1932 }
1933
1934 let millihertz = mode.dot_clock as u64 * 1_000 / (mode.htotal as u64 * mode.vtotal as u64);
1935 let micros = 1_000_000_000 / millihertz;
1936 log::info!("Refreshing every {}ms", micros / 1_000);
1937 Duration::from_micros(micros)
1938}
1939
1940fn fp3232_to_f32(value: xinput::Fp3232) -> f32 {
1941 value.integral as f32 + value.frac as f32 / u32::MAX as f32
1942}
1943
1944fn check_compositor_present(xcb_connection: &XCBConnection, root: u32) -> bool {
1945 // Method 1: Check for _NET_WM_CM_S{root}
1946 let atom_name = format!("_NET_WM_CM_S{}", root);
1947 let atom1 = get_reply(
1948 || format!("Failed to intern {atom_name}"),
1949 xcb_connection.intern_atom(false, atom_name.as_bytes()),
1950 );
1951 let method1 = match atom1.log_with_level(Level::Debug) {
1952 Some(reply) if reply.atom != x11rb::NONE => {
1953 let atom = reply.atom;
1954 get_reply(
1955 || format!("Failed to get {atom_name} owner"),
1956 xcb_connection.get_selection_owner(atom),
1957 )
1958 .map(|reply| reply.owner != 0)
1959 .log_with_level(Level::Debug)
1960 .unwrap_or(false)
1961 }
1962 _ => false,
1963 };
1964
1965 // Method 2: Check for _NET_WM_CM_OWNER
1966 let atom_name = "_NET_WM_CM_OWNER";
1967 let atom2 = get_reply(
1968 || format!("Failed to intern {atom_name}"),
1969 xcb_connection.intern_atom(false, atom_name.as_bytes()),
1970 );
1971 let method2 = match atom2.log_with_level(Level::Debug) {
1972 Some(reply) if reply.atom != x11rb::NONE => {
1973 let atom = reply.atom;
1974 get_reply(
1975 || format!("Failed to get {atom_name}"),
1976 xcb_connection.get_property(false, root, atom, xproto::AtomEnum::WINDOW, 0, 1),
1977 )
1978 .map(|reply| reply.value_len > 0)
1979 .unwrap_or(false)
1980 }
1981 _ => return false,
1982 };
1983
1984 // Method 3: Check for _NET_SUPPORTING_WM_CHECK
1985 let atom_name = "_NET_SUPPORTING_WM_CHECK";
1986 let atom3 = get_reply(
1987 || format!("Failed to intern {atom_name}"),
1988 xcb_connection.intern_atom(false, atom_name.as_bytes()),
1989 );
1990 let method3 = match atom3.log_with_level(Level::Debug) {
1991 Some(reply) if reply.atom != x11rb::NONE => {
1992 let atom = reply.atom;
1993 get_reply(
1994 || format!("Failed to get {atom_name}"),
1995 xcb_connection.get_property(false, root, atom, xproto::AtomEnum::WINDOW, 0, 1),
1996 )
1997 .map(|reply| reply.value_len > 0)
1998 .unwrap_or(false)
1999 }
2000 _ => return false,
2001 };
2002
2003 log::debug!(
2004 "Compositor detection: _NET_WM_CM_S?={}, _NET_WM_CM_OWNER={}, _NET_SUPPORTING_WM_CHECK={}",
2005 method1,
2006 method2,
2007 method3
2008 );
2009
2010 method1 || method2 || method3
2011}
2012
2013fn check_gtk_frame_extents_supported(
2014 xcb_connection: &XCBConnection,
2015 atoms: &XcbAtoms,
2016 root: xproto::Window,
2017) -> bool {
2018 let Some(supported_atoms) = get_reply(
2019 || "Failed to get _NET_SUPPORTED",
2020 xcb_connection.get_property(
2021 false,
2022 root,
2023 atoms._NET_SUPPORTED,
2024 xproto::AtomEnum::ATOM,
2025 0,
2026 1024,
2027 ),
2028 )
2029 .log_with_level(Level::Debug) else {
2030 return false;
2031 };
2032
2033 let supported_atom_ids: Vec<u32> = supported_atoms
2034 .value
2035 .chunks_exact(4)
2036 .filter_map(|chunk| chunk.try_into().ok().map(u32::from_ne_bytes))
2037 .collect();
2038
2039 supported_atom_ids.contains(&atoms._GTK_FRAME_EXTENTS)
2040}
2041
2042fn xdnd_is_atom_supported(atom: u32, atoms: &XcbAtoms) -> bool {
2043 atom == atoms.TEXT
2044 || atom == atoms.STRING
2045 || atom == atoms.UTF8_STRING
2046 || atom == atoms.TEXT_PLAIN
2047 || atom == atoms.TEXT_PLAIN_UTF8
2048 || atom == atoms.TextUriList
2049}
2050
2051fn xdnd_get_supported_atom(
2052 xcb_connection: &XCBConnection,
2053 supported_atoms: &XcbAtoms,
2054 target: xproto::Window,
2055) -> u32 {
2056 if let Some(reply) = get_reply(
2057 || "Failed to get XDnD supported atoms",
2058 xcb_connection.get_property(
2059 false,
2060 target,
2061 supported_atoms.XdndTypeList,
2062 AtomEnum::ANY,
2063 0,
2064 1024,
2065 ),
2066 )
2067 .log_with_level(Level::Warn)
2068 && let Some(atoms) = reply.value32()
2069 {
2070 for atom in atoms {
2071 if xdnd_is_atom_supported(atom, supported_atoms) {
2072 return atom;
2073 }
2074 }
2075 }
2076 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 .copied()
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 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 && reply.width > 0
2445 && reply.height > 0
2446 && !reply.outputs.is_empty()
2447 {
2448 crtc_infos.insert(crtc, reply.clone());
2449 valid_outputs.extend(&reply.outputs);
2450 }
2451 }
2452
2453 if valid_outputs.is_empty() {
2454 return None;
2455 }
2456
2457 let mut output_cookies = Vec::with_capacity(valid_outputs.len());
2458 for &output in &valid_outputs {
2459 if let Ok(cookie) = connection.randr_get_output_info(output, x11rb::CURRENT_TIME) {
2460 output_cookies.push((output, cookie));
2461 }
2462 }
2463 let mut output_infos: HashMap<randr::Output, randr::GetOutputInfoReply> = HashMap::default();
2464 for (output, cookie) in output_cookies {
2465 if let Ok(reply) = cookie.reply() {
2466 output_infos.insert(output, reply);
2467 }
2468 }
2469
2470 let mut fallback_scale: Option<f32> = None;
2471 for crtc_info in crtc_infos.values() {
2472 for &output in &crtc_info.outputs {
2473 if let Some(output_info) = output_infos.get(&output) {
2474 if output_info.connection != randr::Connection::CONNECTED {
2475 continue;
2476 }
2477
2478 if output_info.mm_width == 0 || output_info.mm_height == 0 {
2479 continue;
2480 }
2481
2482 let scale_factor = get_dpi_factor(
2483 (crtc_info.width as u32, crtc_info.height as u32),
2484 (output_info.mm_width as u64, output_info.mm_height as u64),
2485 );
2486
2487 if output != primary_output && fallback_scale.is_none() {
2488 fallback_scale = Some(scale_factor);
2489 }
2490 }
2491 }
2492 }
2493
2494 fallback_scale
2495}
2496
2497fn get_dpi_factor((width_px, height_px): (u32, u32), (width_mm, height_mm): (u64, u64)) -> f32 {
2498 let ppmm = ((width_px as f64 * height_px as f64) / (width_mm as f64 * height_mm as f64)).sqrt(); // pixels per mm
2499
2500 const MM_PER_INCH: f64 = 25.4;
2501 const BASE_DPI: f64 = 96.0;
2502 const QUANTIZE_STEP: f64 = 12.0; // e.g. 1.25 = 15/12, 1.5 = 18/12, 1.75 = 21/12, 2.0 = 24/12
2503 const MIN_SCALE: f64 = 1.0;
2504 const MAX_SCALE: f64 = 20.0;
2505
2506 let dpi_factor =
2507 ((ppmm * (QUANTIZE_STEP * MM_PER_INCH / BASE_DPI)).round() / QUANTIZE_STEP).max(MIN_SCALE);
2508
2509 let validated_factor = if dpi_factor <= MAX_SCALE {
2510 dpi_factor
2511 } else {
2512 MIN_SCALE
2513 };
2514
2515 if valid_scale_factor(validated_factor as f32) {
2516 validated_factor as f32
2517 } else {
2518 log::warn!(
2519 "Calculated DPI factor {} is invalid, using 1.0",
2520 validated_factor
2521 );
2522 1.0
2523 }
2524}
2525
2526#[inline]
2527fn valid_scale_factor(scale_factor: f32) -> bool {
2528 scale_factor.is_sign_positive() && scale_factor.is_normal()
2529}
2530
2531#[inline]
2532fn update_xkb_mask_from_event_state(xkb: &mut xkbc::State, event_state: xproto::KeyButMask) {
2533 let depressed_mods = event_state.remove((ModMask::LOCK | ModMask::M2).bits());
2534 let latched_mods = xkb.serialize_mods(xkbc::STATE_MODS_LATCHED);
2535 let locked_mods = xkb.serialize_mods(xkbc::STATE_MODS_LOCKED);
2536 let locked_layout = xkb.serialize_layout(xkbc::STATE_LAYOUT_LOCKED);
2537 xkb.update_mask(
2538 depressed_mods.into(),
2539 latched_mods,
2540 locked_mods,
2541 0,
2542 0,
2543 locked_layout,
2544 );
2545}